1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
elinks/src
Witold Filipczyk 236f600148 More headers.
There was a compilation error on OpenBSD, so I guess more includes are required.
2010-09-17 16:13:22 +02:00
..
bfu Show IP of the document in the status bar. 2010-03-30 14:45:19 +02:00
bookmarks Merge branch 'elinks-0.12' into elinks-0.13 2009-03-12 08:46:02 +02:00
cache Cache manager: Add 'Search contents' button 2009-06-18 18:09:19 +00:00
config Add document.browse.scrolling.vertical_overlap 2010-09-14 20:42:32 +00:00
cookies Merge branch 'elinks-0.12' into elinks-0.13 2009-03-12 08:46:02 +02:00
dialogs Add support for ECMA-48 SGR italic 2009-05-22 19:48:59 +00:00
document More headers. 2010-09-17 16:13:22 +02:00
dom Added $(EXEEXT) for executables. 2010-03-22 09:35:15 +01:00
ecmascript Add missing include and declarations 2010-08-07 20:44:02 +00:00
encoding lzma code requires xz-4.999beta or later. 2010-07-23 14:12:05 +02:00
formhist Rewrap lines in option documentation. 2009-03-08 15:18:10 +02:00
globhist Merge branch 'elinks-0.12' into elinks-0.13 2009-04-26 17:16:00 +03:00
intl More charsets. 2010-07-24 12:37:29 +02:00
main Merge branch 'elinks-0.12' into elinks-0.13 2008-09-27 16:28:28 +03:00
mime One of mailcap tests failed because of changed implementation 2010-08-08 09:44:37 +02:00
network Merge branch 'elinks-0.12' 2009-07-24 18:32:25 +03:00
osdep Do not #define NO_FG_EXEC for Windows. 2010-03-21 22:36:01 +01:00
protocol strtoll instead of strtol to show the filesize of big files in FTP 2010-09-08 22:52:59 +02:00
scripting Introduce set_kbd_repeat_count 2010-09-16 01:33:45 +00:00
session Move screen update code into set_kbd_repeat_count 2010-09-16 01:40:10 +00:00
terminal Decode ESC color sequences in the plain renderer. 2010-07-31 20:51:24 +02:00
util SMB directory listing looks like normal directory listing. 2010-09-06 18:38:36 +02:00
viewer fixup_typeahead_match: improve comment 2010-09-16 02:00:01 +00:00
.gitignore Ignore tags file 2007-08-08 14:25:38 +02:00
elinks.h TRE: Check for 32-bit wchar_t at configure time 2009-05-21 17:22:12 +03:00
Makefile Added $(EXEEXT) for executables. 2010-03-22 09:35:15 +01:00
README Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
setup.h Make copyright info independent from translations. 2007-10-03 11:53:09 +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

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