1
0
Fork 0
elinks/src
Jonas Fonseca f9d3824c65 Make get_fragment_content_type static 2006-11-06 18:09:11 +01:00
..
bfu Bug 821: Document the charsets of buffers for BFU and form input fields. 2006-10-25 19:46:01 +03:00
bookmarks Trim trailing whitespaces. 2006-07-27 09:51:10 +02:00
cache Support for document.cache.interval (set it to -1) and rename it 2006-11-03 19:56:55 +01:00
config Add a missing parenthesis in option description. 2006-11-06 16:59:13 +01:00
cookies cookies: New function init_cookie has a monopoly. 2006-06-05 20:22:55 +00:00
dialogs ECMAScript: added writeonly property window.status 2006-10-24 20:41:25 +02:00
document Fix spurious gcc warning 2006-11-03 19:22:14 +01:00
dom Trim trailing whitespaces. 2006-05-31 19:34:49 +02:00
ecmascript setTimeout: Fix da assert 2006-11-05 01:13:29 +01:00
encoding gzip_read: always call gzclearerr 2006-11-05 04:53:42 +00:00
formhist BFU: Mark format strings in struct listbox_ops_messages. 2006-06-02 19:08:09 +00:00
globhist BFU: Mark format strings in struct listbox_ops_messages. 2006-06-02 19:08:09 +00:00
intl Fix linker warning on Mac OS X by prefixing locale_charset with "elinks_" 2006-11-04 08:46:45 +01:00
main Always terminate ELinks when using -remote. 2006-10-27 18:59:36 +02:00
mime Make get_fragment_content_type static 2006-11-06 18:09:11 +01:00
network Fix crashes with various bogus BitTorrent URLs 2006-11-06 16:24:07 +01:00
osdep sig_tstp: Use _exit() rather than exit(). 2006-09-10 23:38:02 +03:00
protocol Fix crashes with various bogus BitTorrent URLs 2006-11-06 16:24:07 +01:00
scripting Fix perl pre_format_html hook wrt. binary files 2006-11-03 19:22:58 +01:00
session Never show empty filename in the what-to-do dialog 2006-11-06 04:55:26 +01:00
terminal draw_char_data: Document the dubious unicode_to_cell call. 2006-11-02 09:23:59 +02:00
util Secure file saving: restore umask after _all_ failure conditions 2006-10-01 14:57:47 +00:00
viewer Bug 821: Document the charsets of buffers for BFU and form input fields. 2006-10-25 19:46:01 +03: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
elinks.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
setup.h Revert bad stuff in a3fb98f499 2006-02-19 07:31:39 +00: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 |
                 `----------'