aniani/elinks
1
0
Fork 0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
Code

doc: Added src/bfu/README.

Browse Source 
src/bfu/README: This new file currently contains a diagram of how the
various struct types of src/bfu/ and src/terminal/ relate to each
other.  More documentation may be added later, although if it is
specific to a particular structure, then it should probably go in the
corresponding header file so that people will remember to update it.
This commit is contained in:
Kalle Olavi Niemitalo 2006-05-13 17:01:20 +03:00 committed by Kalle Olavi Niemitalo
parent 5c2dfc72cf
commit eae626a981
1 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
src/bfu/README Normal file
View File

@ -0,0 +1,51 @@
OVERVIEW OF BFU
===============
BFU is the text-mode user interface used by ELinks. It builds dialogs,
widgets and menus on top of the window system implemented at src/terminal/.
=====================
| struct widget_ops |
| bfu/widget.h |
=====================
1^
|
*|
==================== ====================== =================
| struct menu_item | | struct widget_data | * 1 | struct widget |
| bfu/menu.h | | bfu/widget.h | ---> | bfu/widget.h |
==================== ====================== =================
+^ +^ +^
| | |
?| 1| 1|
=============== ====================== =================
| struct menu | | struct dialog_data | * 1 | struct dialog |
| bfu/menu.h | | bfu/dialog.h | ----> | bfu/dialog.h |
=============== ====================== =================
?^ ?^ ?^ ?| 1| 1|
| | | | | |
| | | 1v | 1v
| 1v 1v ====================== | ========================
| ===================== | struct memory_list | | | struct dialog_layout |
| | struct window | | util/memlist.h | | | bfu/dialog.h |
| | terminal/window.h | ====================== | ========================
| ===================== ?v
| *^ =========================
| | | struct dialog_refresh |
| 1v | bfu/dialog.h |
| ======================= =========================
| ? | struct terminal |
---------- | terminal/terminal.h |
main_menu =======================
?| ?|
| |
1v ?v
========================== =============================
| struct terminal_screen | | struct terminal_interlink |
| terminal/screen.h | | terminal/event.c |
========================== =============================
Legend: ---> can be followed like a pointer
? zero or one 1 exactly one
* zero or more + one or more
There may be errors in the quantifiers.