1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-06-28 01:35:32 +00:00
elinks/src
2008-06-17 00:12:21 +03:00
..
bfu Strings corrections from Malcolm Parsons 2008-01-27 04:17:47 +00:00
bookmarks do_move_bookmark: Update comment to match reality. 2007-04-01 14:59:28 +03:00
cache Use internal OFF_T_FORMAT instead of PRId64 2006-08-05 00:39:14 +02:00
config Minor fixes and improvements to option strings 2008-03-03 03:03:11 +01:00
cookies Strings corrections from Malcolm Parsons 2008-01-27 04:17:47 +00:00
dialogs elinks-0.11.4rc0 2008-02-04 23:36:56 +01:00
document Strings corrections from Malcolm Parsons 2008-01-27 04:17:47 +00:00
dom Ignore test files 2006-11-27 17:36:29 +01:00
ecmascript Bug 1016: Avoid JSFunctionSpec. 2008-06-17 00:12:21 +03:00
encoding Remove .vimrc files; use the Vim ftplugin instead 2006-01-29 10:45:22 +01:00
formhist Remove .vimrc files; use the Vim ftplugin instead 2006-01-29 10:45:22 +01:00
globhist Remove .vimrc files; use the Vim ftplugin instead 2006-01-29 10:45:22 +01:00
intl Strings corrections from Malcolm Parsons 2008-01-27 04:17:47 +00:00
main Reapply 644908c1, "Garbage-collect SMJS objects before flushing caches." 2007-07-02 22:34:11 +03:00
mime Mark option changed in "File extensions -> Add". 2008-03-04 23:46:17 +02:00
network Strings corrections from Malcolm Parsons 2008-01-27 04:17:47 +00:00
osdep Bug 54: Don't disable XON/XOFF flow control. 2008-02-08 00:34:11 +02:00
protocol Bug 939: Documented the fix. 2008-04-28 10:59:20 +03:00
scripting Bug 1016: Avoid JSFunctionSpec. 2008-06-17 00:12:21 +03:00
session Strings corrections from Malcolm Parsons 2008-01-27 04:17:47 +00:00
terminal Recognize Insert key on cons25 (FreeBSD console) 2008-05-31 21:30:40 +03:00
util Secure file saving: restore umask after _all_ failure conditions 2007-04-06 15:18:49 +03:00
viewer save_textarea_file: don't return a dangling pointer if open fails 2008-05-21 20:30:33 +00:00
.gitignore Ignore src/ID and src/TAGS. 2007-06-17 19:41:14 +03:00
elinks.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
Makefile Clean vernum.o 2008-02-09 13:52:33 +02:00
README Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
setup.h Link to gitweb at repo.or.cz, rather than pasky.or.cz. 2007-07-02 22:41:42 +03:00
vernum.c Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
vernum.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00

				  The Big View

The whole dependency tree is supposed (in ideal world) to look somewhat like
the following. Please note that this deals only with the core parts of ELinks,
not extensions like bookmarks, cookies, globhist, mime etc. Those act like
modules and are generally self-contained - the main visible difference is that
they don't have their UI stuff in dialogs/foo.c but in foo/dialogs.c.

Note also that it isn't all that clean-cut as it looks. Some parts of e.g.
lowlevel/ or osdep/ are omnipresent as well and it's meant to be so (at least
for now). Also some other exceptions are possible; the exception to this is
util/, where no exceptions are permitted - it must have no dependencies to the
rest of the code whatsoever, not even compile-time ones. The other way around,
the gettext part of intl/ is generally omnipresent but the charset part is
pretty isolated - it could be probably drawn as connected to document and
terminal (actually, it is used when encoding forms in viewer too, but that
stuff should be probably moved to document).

viewer/ contains code concerning that big rectangle between bars at the top
and bars at the bottom, documents usually being shown inside. Logically, it
is in fact kind of a BFU widget, but in practice it has little in common with
the bfu/ widgets, it is special in many ways and deeply woven to the fabric
of session/ (e.g. session history is basically a chain of viewer widget
descriptors).

dialogs/ is special too. It in fact means to say "global and unique BFU
instances belonging to the ELinks core"/ but that's a rather long and boring
name, besides the nightmares associated with maintaining files and directories
containing spaces in GIT. The "global and unique BFU instances" part can be
represented by exmode, menus and leds (were they there). The "ELinks core"
part can be represented by options, document and downloads. The reason those
aren't in their respective directories (while bookmarks or formhist have their
dialogs.c) is that it's important to keep the dependencies sorted out
reasonably. Had there been e.g. terminal/dialogs.c, it would mean libterminal
has to depend on libbfu.a and so. (There are two 'managerial' exceptions
to this; don't dig into them, please. ;-)

scripting/ (== browser scripting) is also expected to hook all around, perhaps
it should be better in the omnipresent box.

The edges are directed and represent the "using" relation. Therefore,
"bfu -> terminal" means "bfu/ is using terminal/ services (but not
the other way around)".

.---------.
| util/   | <-- This is omnipresent :)
| config/ |
| intl/   |
`---------'

                   .-------.         .---------.
                   |  bfu  |<------- | dialogs |
                   `-------' \       `---------'
                       v      `---.       |
                 .----------.      \ .--------.
                 | terminal | <----- | viewer | <-----------------.
               / `----------'     .> `--------'                   |
           .--'        v         /        v                       v
.-------. /      .----------.   |    .----------.       .----/ecmascript/----.
| osdep |<------ | lowlevel |   |    | document | ----> | document scripting |
`-------' \      `----------'   |    `----------'       `--------------------'
           `---.       ^         \        ^
                \ .---------.     `> .---------.        .----/scripting/----.
                  | network | <----- | session | -----> | browser scripting |
                  `---------'      / `---------'        `-------------------'
                       ^       .--'
                 .----------. <
                 | protocol |
                 `----------'