1
0
Fork 0
elinks/src
Witold Filipczyk 846a6a7187 [.config] Add trailing / to xdg_config_home. Refs #202 2022-12-27 11:49:54 +01:00
..
bfu [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
bookmarks [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
cache [cpp] All files suspected for any C++ relation renamed to cpp 2022-07-31 16:44:11 +02:00
config [.config] Add trailing / to xdg_config_home. Refs #202 2022-12-27 11:49:54 +01:00
cookies [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
dialogs [download] refresh_dialog in display_download 2022-12-15 19:40:12 +01:00
document [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
dom [meson] Do not build test programs by default 2022-11-30 10:17:49 +01:00
ecmascript [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
encoding [brotli] Initialize 2022-05-29 19:02:58 +02:00
formhist [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
globhist [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
intl [headers] Check for sys/kd.h 2022-11-21 16:51:40 +01:00
main [select] Start redrawing terminal also without libevent. Refs #201 2022-12-26 19:02:36 +01:00
mime [meson] Do not build test programs by default 2022-11-30 10:17:49 +01:00
network [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
osdep [xterm] If TERM environment variable starts with "xterm", then it is xterm. 2022-12-17 10:31:42 +01:00
protocol [meson] Do not build test programs by default 2022-11-30 10:17:49 +01:00
scripting [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
session [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
terminal [.config] Read/write configuration from ~/.config/elinks . Refs #199 2022-12-26 17:48:55 +01:00
util Remove "user torturation" code 2022-11-15 13:55:16 -06:00
viewer [dump] goto next_iteration instead of continue. 2022-11-28 09:13:48 +01:00
.gitignore Ignore tags file 2007-08-08 14:25:38 +02: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
elinks.h [dos] Very experimental DOS port based on links-2.26 code 2022-05-09 18:53:36 +02:00
meson.build [meson] Do not pass -Wc++-compat for C++ 2022-09-02 17:46:53 +02:00
setup.h [terminal] Periodically refresh screen 2022-12-11 16:22:41 +01:00
vernum.c [meson] added options: reproducible and source-date-epoch for reproducible builds 2022-03-25 14:13:03 +01:00
vernum.h [vernum] const char * 2021-12-05 16:01:12 +01: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 |
                 `----------'