Gathers runtime information for C-Menu Menu, Form, Pick, and View components, used for passing common data and state during initialization and processing of these componentsi. More...

#include <common.h>

Collaboration diagram for Init:

[legend]

Data Fields
SIO *	sio
int	lines
int	cols
int	begy
int	begx
char	provider_cmd [MAXLEN]
char	receiver_cmd [MAXLEN]
char	cmd [MAXLEN]
char	cmd_all [MAXLEN]
char	parent_cmd [MAXLEN]
char	prompt_str [MAXLEN]
int	prompt_type
char	chyron_s [MAXLEN]
char	title [MAXLEN]
int	argc
char **	argv
int	optind
bool	f_ignore_case
bool	f_at_end_remove
bool	f_strip_ansi
bool	f_squeeze
bool	f_multiple_cmd_args
bool	f_erase_remainder
bool	f_ln
char	brackets [3]
char	fill_char [2]
char	mapp_home [MAXLEN]
char	mapp_data [MAXLEN]
char	mapp_help [MAXLEN]
char	mapp_msrc [MAXLEN]
char	mapp_user [MAXLEN]
bool	f_mapp_home
bool	f_mapp_data
bool	f_mapp_spec
bool	f_mapp_help
bool	f_mapp_msrc
bool	f_mapp_user
bool	f_mapp_desc
bool	f_provider_cmd
bool	f_receiver_cmd
bool	f_cmd
bool	f_cmd_all
bool	f_title
bool	f_help_spec
char	in_spec [MAXLEN]
char	out_spec [MAXLEN]
bool	f_in_spec
bool	f_out_spec
char	editor [MAXLEN]
char	menuapp [MAXLEN]
char	minitrc [MAXLEN]
char	about_fn [MAXLEN]
char	mapp_spec [MAXLEN]
char	help_spec [MAXLEN]
int	select_max
int	tab_stop
Menu *	menu
int	menu_cnt
Form *	form
int	form_cnt
Pick *	pick
int	pick_cnt
View *	view
int	view_cnt

Detailed Description

Gathers runtime information for C-Menu Menu, Form, Pick, and View components, used for passing common data and state during initialization and processing of these componentsi.

Definition at line 107 of file common.h.

Field Documentation

◆ about_fn

char Init::about_fn[MAXLEN]

about information file, e.g. cmenu/.about

Definition at line 165 of file common.h.

◆ argc

int Init::argc

command line arguments count

Definition at line 124 of file common.h.

Referenced by destroy_init(), main(), mapp_initialization(), new_init(), new_view(), parse_opt_args(), popup_form(), popup_menu(), and popup_pick().

◆ argv

char** Init::argv

command line arguments vector

Definition at line 125 of file common.h.

Referenced by destroy_init(), main(), new_init(), new_view(), popup_form(), popup_menu(), and popup_pick().

◆ begx

int Init::begx

screen column upper left corner of window

Definition at line 112 of file common.h.

Referenced by display_pick_help(), dump_config(), exec_objects(), form_engine(), menu_cmd_processor(), mview(), parse_config(), popup_view(), view_display_help(), and write_config().

◆ begy

int Init::begy

screen line upper left corner of window

Definition at line 111 of file common.h.

Referenced by display_pick_help(), dump_config(), exec_objects(), form_engine(), menu_cmd_processor(), mview(), parse_config(), popup_view(), view_display_help(), and write_config().

◆ brackets

char Init::brackets[3]

Form - left and right enclosing characters

Definition at line 136 of file common.h.

Referenced by dump_config(), mapp_initialization(), new_form(), parse_config(), and write_config().

◆ chyron_s

char Init::chyron_s[MAXLEN]

chyron string

Definition at line 122 of file common.h.

◆ cmd

char Init::cmd[MAXLEN]

command to execute in foreground, e.g. an editor

Definition at line 116 of file common.h.

Referenced by dump_config(), init_form_files(), init_pick_files(), parse_config(), write_config(), and zero_opt_args().

◆ cmd_all

char Init::cmd_all[MAXLEN]

View - command to execute at start of program

Definition at line 117 of file common.h.

Referenced by dump_config(), init_view_files(), parse_config(), write_config(), and zero_opt_args().

◆ cols

int Init::cols

number of columns for window size

Definition at line 110 of file common.h.

Referenced by display_pick_help(), dump_config(), exec_objects(), form_engine(), init_view_files(), main(), menu_cmd_processor(), mview(), parse_config(), popup_view(), view_display_help(), and write_config().

◆ editor

char Init::editor[MAXLEN]

default editor

Definition at line 162 of file common.h.

Referenced by dump_config(), mapp_initialization(), parse_config(), view_cmd_processor(), and write_config().

◆ f_at_end_remove

bool Init::f_at_end_remove

obsolete, unneeded

Definition at line 128 of file common.h.

Referenced by init_view_files(), and parse_config().

◆ f_cmd

bool Init::f_cmd

flag - cmd verified

Definition at line 154 of file common.h.

◆ f_cmd_all

bool Init::f_cmd_all

flag - cmd_all verified

Definition at line 155 of file common.h.

◆ f_erase_remainder

bool Init::f_erase_remainder

Form - erase remainder of field on enter

Definition at line 134 of file common.h.

Referenced by dump_config(), init_form_files(), mapp_initialization(), parse_config(), and write_config().

◆ f_help_spec

bool Init::f_help_spec

flag - help_spec verified

Definition at line 157 of file common.h.

Referenced by zero_opt_args().

◆ f_ignore_case

bool Init::f_ignore_case

View - ignore case in search

Definition at line 127 of file common.h.

Referenced by dump_config(), init_view_files(), parse_config(), and write_config().

◆ f_in_spec

bool Init::f_in_spec

in_spec verified

Definition at line 160 of file common.h.

Referenced by zero_opt_args().

◆ f_ln

bool Init::f_ln

View - show line numbers

Definition at line 135 of file common.h.

Referenced by dump_config(), init_view_files(), parse_config(), and write_config().

◆ f_mapp_data

bool Init::f_mapp_data

flag - mapp_data verified

Definition at line 145 of file common.h.

◆ f_mapp_desc

bool Init::f_mapp_desc

flag - mapp_desc verified

Definition at line 151 of file common.h.

Referenced by zero_opt_args().

◆ f_mapp_help

bool Init::f_mapp_help

flag - mapp_help verified

Definition at line 147 of file common.h.

◆ f_mapp_home

bool Init::f_mapp_home

flag - mapp_home verified

Definition at line 144 of file common.h.

◆ f_mapp_msrc

bool Init::f_mapp_msrc

flag - mapp_msrc verified

Definition at line 148 of file common.h.

◆ f_mapp_spec

bool Init::f_mapp_spec

flag - mapp_spec verified

Definition at line 146 of file common.h.

Referenced by init_menu_files(), and zero_opt_args().

◆ f_mapp_user

bool Init::f_mapp_user

flag - mapp_user verified

Definition at line 149 of file common.h.

◆ f_multiple_cmd_args

bool Init::f_multiple_cmd_args

View - put multiple arguments in a single string

Definition at line 132 of file common.h.

Referenced by init_pick_files().

◆ f_out_spec

bool Init::f_out_spec

out_spec verified

Definition at line 161 of file common.h.

Referenced by zero_opt_args().

◆ f_provider_cmd

bool Init::f_provider_cmd

flag - provider_cmd verified

Definition at line 152 of file common.h.

Referenced by zero_opt_args().

◆ f_receiver_cmd

bool Init::f_receiver_cmd

flag - receiver_cmd verified

Definition at line 153 of file common.h.

Referenced by zero_opt_args().

◆ f_squeeze

bool Init::f_squeeze

View - print one line for each group of blank lines

Definition at line 130 of file common.h.

Referenced by dump_config(), init_view_files(), parse_config(), and write_config().

◆ f_strip_ansi

bool Init::f_strip_ansi

strip ansi escape sequences when writing buffer

Definition at line 129 of file common.h.

Referenced by dump_config(), parse_config(), and write_config().

◆ f_title

bool Init::f_title

flag - title verified

Definition at line 156 of file common.h.

Referenced by zero_opt_args().

◆ fill_char

char Init::fill_char[2]

Form - fill character for fields

Definition at line 137 of file common.h.

Referenced by dump_config(), mapp_initialization(), new_form(), parse_config(), and write_config().

◆ form

Form* Init::form

form data structure

Definition at line 174 of file common.h.

Referenced by destroy_form(), destroy_init(), form_display_screen(), form_engine(), form_post(), form_process(), init_form(), new_form(), and popup_form().

◆ form_cnt

int Init::form_cnt

number of form data structures allocated

Definition at line 175 of file common.h.

Referenced by destroy_form(), and new_form().

◆ help_spec

char Init::help_spec[MAXLEN]

help file

Definition at line 167 of file common.h.

Referenced by dump_config(), init_form_files(), init_pick_files(), write_config(), and zero_opt_args().

◆ in_spec

char Init::in_spec[MAXLEN]

input file spec

Definition at line 158 of file common.h.

Referenced by dump_config(), init_form_files(), init_pick_files(), write_config(), and zero_opt_args().

◆ lines

int Init::lines

number of lines for window size

Definition at line 109 of file common.h.

Referenced by display_pick_help(), dump_config(), exec_objects(), form_engine(), init_view_files(), main(), menu_cmd_processor(), mview(), parse_config(), popup_view(), view_display_help(), and write_config().

◆ mapp_data

char Init::mapp_data[MAXLEN]

data directory

Definition at line 139 of file common.h.

Referenced by dump_config(), init_form_files(), init_pick_files(), mapp_initialization(), parse_config(), and write_config().

◆ mapp_help

char Init::mapp_help[MAXLEN]

help directory

Definition at line 140 of file common.h.

Referenced by display_pick_help(), dump_config(), form_engine(), init_form_files(), init_menu_files(), init_pick_files(), init_view_files(), mapp_initialization(), menu_cmd_processor(), parse_config(), view_display_help(), and write_config().

◆ mapp_home

char Init::mapp_home[MAXLEN]

home directory

Definition at line 138 of file common.h.

Referenced by dump_config(), enter_file_spec(), init_view_files(), mapp_initialization(), parse_config(), and write_config().

◆ mapp_msrc

char Init::mapp_msrc[MAXLEN]

source directory

Definition at line 141 of file common.h.

Referenced by dump_config(), init_form_files(), init_menu_files(), mapp_initialization(), parse_config(), and write_config().

◆ mapp_spec

char Init::mapp_spec[MAXLEN]

description file

Definition at line 166 of file common.h.

Referenced by dump_config(), init_form_files(), mapp_initialization(), parse_config(), write_config(), and zero_opt_args().

◆ mapp_user

char Init::mapp_user[MAXLEN]

user directory

Definition at line 142 of file common.h.

Referenced by dump_config(), mapp_initialization(), parse_config(), and write_config().

◆ menu

Menu* Init::menu

menu data structure

Definition at line 172 of file common.h.

Referenced by destroy_init(), destroy_menu(), main(), menu_cmd_processor(), menu_engine(), new_menu(), parse_menu_description(), and popup_menu().

◆ menu_cnt

int Init::menu_cnt

number of menu data structures allocated

Definition at line 173 of file common.h.

Referenced by destroy_menu(), and new_menu().

◆ menuapp

char Init::menuapp[MAXLEN]

main configuration file, e.g. cmenu/.minitrc

Definition at line 163 of file common.h.

◆ minitrc

char Init::minitrc[MAXLEN]

main configuration file, e.g. cmenu/.minitrc

Definition at line 164 of file common.h.

Referenced by dump_config(), mapp_initialization(), and parse_config().

◆ optind

int Init::optind

getopt pointer to non-option arguments in argv

Definition at line 126 of file common.h.

◆ out_spec

char Init::out_spec[MAXLEN]

output file spec

Definition at line 159 of file common.h.

Referenced by dump_config(), init_form_files(), init_pick_files(), write_config(), and zero_opt_args().

◆ parent_cmd

char Init::parent_cmd[MAXLEN]

command to be executed by parent

Definition at line 118 of file common.h.

Referenced by dump_config(), parse_config(), write_config(), and zero_opt_args().

◆ pick

Pick* Init::pick

pick data structure

Definition at line 176 of file common.h.

Referenced by destroy_init(), destroy_pick(), init_pick(), new_pick(), open_pick_win(), picker(), popup_pick(), and read_pick_input().

◆ pick_cnt

int Init::pick_cnt

number of pick data structures allocated

Definition at line 177 of file common.h.

Referenced by destroy_pick(), and new_pick().

◆ prompt_str

char Init::prompt_str[MAXLEN]

prompt string for chyron

Definition at line 119 of file common.h.

◆ prompt_type

int Init::prompt_type

View - prompt type for chyron, e.g. 0=short, 1=long, 2=none

Definition at line 120 of file common.h.

◆ provider_cmd

char Init::provider_cmd[MAXLEN]

command provides input

Definition at line 114 of file common.h.

Referenced by dump_config(), init_form_files(), init_pick_files(), init_view_files(), parse_config(), write_config(), and zero_opt_args().

◆ receiver_cmd

char Init::receiver_cmd[MAXLEN]

command receives output

Definition at line 115 of file common.h.

Referenced by dump_config(), init_form_files(), init_pick_files(), init_view_files(), parse_config(), write_config(), and zero_opt_args().

◆ select_max

int Init::select_max

Pick maximum number of selections

Definition at line 169 of file common.h.

Referenced by dump_config(), init_pick_files(), parse_config(), and write_config().

◆ sio

SIO* Init::sio

Definition at line 108 of file common.h.

Referenced by destroy_init(), dump_config(), init_pick(), main(), mapp_initialization(), new_init(), parse_config(), and write_config().

◆ tab_stop

int Init::tab_stop

View - number of spapaces per tab

Definition at line 171 of file common.h.

Referenced by dump_config(), parse_config(), and write_config().

◆ title

char Init::title[MAXLEN]

display on top line of box window

Definition at line 123 of file common.h.

Referenced by display_pick_help(), dump_config(), exec_objects(), form_engine(), init_form_files(), init_pick_files(), init_view_files(), menu_cmd_processor(), mview(), parse_config(), popup_view(), view_display_help(), write_config(), and zero_opt_args().

◆ view

View* Init::view

view data structure

Definition at line 178 of file common.h.

Referenced by destroy_init(), destroy_view(), enter_file_spec(), init_view_boxwin(), init_view_files(), init_view_full_screen(), mview(), new_view(), popup_view(), resize_page(), view_cmd_processor(), view_display_help(), view_file(), and write_view_buffer().

◆ view_cnt

int Init::view_cnt

number of view data structures allocated

Definition at line 179 of file common.h.

Referenced by destroy_view(), and new_view().

The documentation for this struct was generated from the following file:

include/common.h

Data Fields

Detailed Description

Field Documentation

◆ about_fn

◆ argc

◆ argv

◆ begx

◆ begy

◆ brackets

◆ chyron_s

◆ cmd

◆ cmd_all

◆ cols

◆ editor

◆ f_at_end_remove

◆ f_cmd

◆ f_cmd_all

◆ f_erase_remainder

◆ f_help_spec

◆ f_ignore_case

◆ f_in_spec

◆ f_ln

◆ f_mapp_data

◆ f_mapp_desc

◆ f_mapp_help

◆ f_mapp_home

◆ f_mapp_msrc

◆ f_mapp_spec

◆ f_mapp_user

◆ f_multiple_cmd_args

◆ f_out_spec

◆ f_provider_cmd

◆ f_receiver_cmd

◆ f_squeeze

◆ f_strip_ansi

◆ f_title

◆ fill_char

◆ form

◆ form_cnt

◆ help_spec

◆ in_spec

◆ lines

◆ mapp_data

◆ mapp_help

◆ mapp_home

◆ mapp_msrc

◆ mapp_spec

◆ mapp_user

◆ menu

◆ menu_cnt

◆ menuapp

◆ minitrc

◆ optind

◆ out_spec

◆ parent_cmd

◆ pick

◆ pick_cnt

◆ prompt_str

◆ prompt_type

◆ provider_cmd

◆ receiver_cmd

◆ select_max

◆ sio

◆ tab_stop

◆ title

◆ view

◆ view_cnt