1
0
Fork 0
elinks/src
Jonas Fonseca 87c8a5cee4 Merge with 5ef041c051
Which mysteriously didn't get auto-merged when updating.
2005-12-13 20:26:06 +01:00
..
bfu Remove empty lines in start of header files 2005-11-15 11:33:27 +01:00
bookmarks Fix non-ANSI function declaration 2005-11-25 18:51:21 +01:00
cache Fix dump_frags() compilation (cache debug only). 2005-12-05 09:33:11 +01:00
config Fix various sparse warnings 2005-11-24 15:38:47 +01:00
cookies Prevent successive calls to time(), since it doesn't have much impact. 2005-12-12 17:00:08 +01:00
dialogs get_resource_info(): fix memory cache size display. 2005-12-05 09:37:29 +01:00
document Redo the assertm() message to just show the type of the node and parent 2005-12-13 20:08:58 +01:00
ecmascript Remove indentation from option description 2005-11-27 07:29:36 +01:00
encoding Remove empty lines in start of header files 2005-11-15 11:33:27 +01:00
formhist Remove empty lines in start of header files 2005-11-15 11:33:27 +01:00
globhist Remove empty lines in start of header files 2005-11-15 11:33:27 +01:00
intl Remove empty lines in start of header files 2005-11-15 11:33:27 +01:00
main Fix various sparse warnings 2005-11-24 15:38:47 +01:00
mime Remove empty lines in start of header files 2005-11-15 11:33:27 +01:00
network sort_queue(): make @swp variable local to the loop. 2005-12-13 16:50:04 +01:00
osdep Merge with git+ssh://pasky.or.cz/srv/git/elinks.git 2005-11-27 19:40:49 +00:00
protocol sort_bittorrent_peer_connections(): make @resort variable local to 2005-12-13 16:52:08 +01:00
scripting Fix trailing whitespaces. 2005-11-25 09:38:32 +01:00
session process_file_requests(): move @more, @ftl and @doc_view variables to 2005-12-13 16:57:17 +01:00
terminal Complete enum border_char using codes borrowed from TWIN project. 2005-11-29 11:20:10 +01:00
util Fix various sparse warnings 2005-11-24 15:38:47 +01:00
viewer Merge with git+ssh://pasky.or.cz/srv/git/elinks.git 2005-12-13 18:03:55 +00:00
.vimrc Initial commit of the HEAD branch of the ELinks CVS repository, as of 2005-09-15 15:58:31 +02:00
Makefile Make the build id thing work for out of tree builds 2005-11-01 23:19:50 +01:00
README Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
elinks.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
setup.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02: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

README

				  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 |
                 `----------'