1
0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
elinks/src
Kalle Olavi Niemitalo 5d22006f93 do_move_bookmark: Update comment to match reality.
[ From commit 22d051925e in ELinks
  0.11.2.GIT.  --KON ]
2007-04-01 15:02:47 +03:00
..
bfu The real fix for the bug 935. 2007-03-11 17:00:29 +02:00
bookmarks do_move_bookmark: Update comment to match reality. 2007-04-01 15:02:47 +03:00
cache Make instances of struct listbox_ops const. 2007-02-04 15:17:49 +02:00
config Don't mark undisplayed names of modules for translation. 2007-03-23 00:51:56 +02:00
cookies Cast the NULL argument of straconcat to unsigned char *. 2007-03-11 12:59:11 +02:00
dialogs intl: Fork get_cp_config_name off get_cp_mime_name. 2007-03-20 20:41:05 +02:00
document Don't mark undisplayed names of modules for translation. 2007-03-23 00:51:56 +02:00
dom Fix compiler errors without HAVE_VARIADIC_MACROS. 2007-03-11 12:22:02 +02:00
ecmascript Mark all module names for translation and include needed header files. 2007-03-21 11:01:06 +01:00
encoding Various comments and tweaks in bzip2 decoding. 2007-02-24 23:03:47 +02:00
formhist Cast the NULL argument of straconcat to unsigned char *. 2007-03-11 12:59:11 +02:00
globhist Cast the NULL argument of straconcat to unsigned char *. 2007-03-11 12:59:11 +02:00
intl intl: Fork get_cp_config_name off get_cp_mime_name. 2007-03-20 20:41:05 +02:00
main Cast the NULL argument of string_concat to unsigned char *. 2007-03-11 13:01:50 +02:00
mime Cast the NULL argument of straconcat to unsigned char *. 2007-03-11 12:59:11 +02:00
network Fix compiler errors without HAVE_VARIADIC_MACROS. 2007-03-11 12:22:02 +02:00
osdep Cast the NULL argument of straconcat to unsigned char *. 2007-03-11 12:59:11 +02:00
protocol do_smb: URI-encode the username and password. 2007-03-25 12:13:46 +03:00
scripting report_scripting_error: Look up module names with gettext. 2007-03-22 07:55:59 +02:00
session Used add_shell_quoted_to_string instead of enclosing the text with '"'. 2007-03-12 19:22:41 +02:00
terminal Don't mark undisplayed names of modules for translation. 2007-03-23 00:51:56 +02:00
util add_cp_html_to_string: New function. 2007-03-20 21:32:14 +02:00
viewer Mark all module names for translation and include needed header files. 2007-03-21 11:01:06 +01:00
elinks.h Remove now useless $Id: lines. 2005-10-21 09:14:07 +02:00
Makefile TAGS: Doh, don't forget to scan the *.[ch] files. 2007-03-23 09:47:28 +02:00
README 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

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