csope/documentation/dev_man.md
2023-09-26 09:29:23 +02:00

1.1 KiB

Control flow

...

Project structure /probably move to documentation/

Component Purpose
main.c generic init functions, main() and primary event loops (and junk)
display.c all functions directly dealing with NCurses
input.c top layer of functions dealing with user input; migth dispatch to readline
find.c searching functions
globals.h an inherited curse; global var/prototype hell
readline.c all functions directly dealing with GNU Readline; responsible for line editing in input mode
help.c all functions dealing with help messages

Key Symbols

Global Role
int input_mode Responsible of keeping track how current input should be handled. Not only does the readline handler depend on it, its also used to determine what types of inputs all legal (e.g. swapping to another window). Takes up on of the values of the INPUT_* macros.
int window_change Bit mask type of the CH_* macros. Keeps track of the windows to be refresed on the next run of display(). Could be better utalized.