1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-07-16 15:04:37 -04:00
elinks/src
2007-01-18 17:05:16 +01:00
..
bfu Explicitly compare to COLOR_MODE_MONO where appropriate. 2006-12-25 10:27:23 +02:00
bookmarks Make u2cp and u2cp_no_nbsp return a pointer to const. 2007-01-02 20:08:59 +02:00
cache Comment fix: s/stricktest/strictest/ 2006-11-26 12:43:45 +00:00
config Merge with master 2007-01-07 16:03:24 +01:00
cookies Bug 923: Added comments about potential time_t truncation. 2007-01-13 15:26:21 +02:00
dialogs Use document->cached in document_info_dialog and l_current_document 2006-12-10 03:14:36 +00:00
document set_hline: Add a FIXME comment about invalid UTF-8. 2006-12-26 14:59:16 +02:00
dom DOM: rename init_dom_node_ to init_dom_node_at and cleanup the declaration 2006-12-11 21:21:30 +01:00
ecmascript Set ecmascript.enable = 0 by default. 2006-12-29 23:24:42 +02:00
encoding bzip2: buf must be the last. 2007-01-07 21:48:34 +01:00
formhist BFU: Mark format strings in struct listbox_ops_messages. 2006-06-02 19:08:09 +00:00
globhist Route time_t-to-string conversions via time_print_T and TIME_PRINT_FORMAT. 2007-01-12 23:47:45 +02:00
intl Revise comments in struct codepage_desc and struct conv_table. 2007-01-03 07:32:00 +02:00
main Added macro foreach_module_builtin. Killed some warnings of gcc-4.2. 2007-01-18 17:05:16 +01:00
mime Added macro foreach_module_builtin. Killed some warnings of gcc-4.2. 2007-01-18 17:05:16 +01:00
network Document how timer callbacks erase timer IDs; add some assertions. 2006-12-02 18:35:03 +02:00
osdep Bug 899: Fix size handling in FTP directory listings 2006-12-18 18:51:57 +01:00
protocol dup2 closes given descriptors, so no need for the explicit close. 2007-01-18 16:41:57 +01:00
scripting Bug 923: Added comments about potential time_t truncation. 2007-01-13 15:26:21 +02:00
session Document how timer callbacks erase timer IDs; add some assertions. 2006-12-02 18:35:03 +02:00
terminal Removed the buggy code. 2007-01-08 11:38:34 +01:00
util Merge with master 2007-01-18 16:23:38 +01:00
viewer Missing include. 2007-01-07 21:41:46 +01:00
elinks.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
Makefile Clean vernum.o 2006-07-10 14:28:21 +02:00
README Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
setup.h Added ELINKS_EPOLL_SIZE to the setup.h. 128 is enough for most uses. 2007-01-03 12:54:05 +01: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 |
                 `----------'