CSTM_RPT module routines

CSTM_RPT module routines - WIN32

CSTM_RPT.C - CuSToM RePorT

A program to easily run multiple indicators and systems in parallel against a data set and then generate a custom report for the user.

The basic program logic is that the user gives us a report template file and 1 (or more) data ticker strings. We first process the template file into process records. The template lines consist of file constant verbs or action verbs. The concept is that process records process data items into output values. Once the template file is parsed, each of the user requested data files are loaded in turn and run against the report template. This program uses the Indicator Engine in the TDF_lib dll.

Function	WinMain
Include file	CSTM_RPT.H
Prototype	int WINAPI WinMain( HINSTANCE hInstance , HINSTANCE hPrevInstance , LPSTR lpCmdLine , int nCmdShow )
Remarks	Program entry point: expected command line input - CSTM_RPT report_template_file ticker_str [ ticker_str ... ]

Function	app_exit_cleanup
Include file	CSTM_RPT.H
Prototype	void app_exit_cleanup( int exit_code )
Remarks	Master program exit catcher. All fatal library errors will also come here.

Function	dspy_debug_hook_vars
Include file	CSTM_RPT.H
Prototype	void dspy_debug_hook_vars( int exit_code )
Remarks	Display program defined debug vars at image-rundown if debug_flag == TRUE.

Function	final_exit_cleanup
Include file	CSTM_RPT.H
Prototype	void final_exit_cleanup( int exit_code )
Remarks	Do final image-rundown cleanup here. Also force debug_flag to TRUE if exit_code != SS_NORMAL.

Function	chk_config_args
Include file	CSTM_RPT.H
Prototype	void chk_config_args( void )
Remarks	Do a check that necessary run-time stuff has been defined and that the user command line arguments make sense.

Function	process_ticker_list_file
Include file	CSTM_RPT.H
Prototype	void process_ticker_list_file( char *ticker_file_name )
Remarks	Process a file of ticker_strs and run the defined report template against each of them.

Function	process_1_ticker
Include file	CSTM_RPT.H
Prototype	void process_1_ticker( char *ticker_str )
Remarks	Run the defined report for one ticker.

Function	init_global_vars
Include file	CSTM_RPT.H
Prototype	void init_global_vars( void )
Remarks	Initialize the program global and permanent variables.

Function	free_global_vars
Include file	CSTM_RPT.H
Prototype	void free_global_vars( void )
Remarks	A nice hook to free global vars. Not really needed in this application.

Function	init_process_vars
Include file	CSTM_RPT.H
Prototype	void init_process_vars( void )
Remarks	Called on each pass through process_1_ticker. Init all vars needed for defined report's process records and zero the output buckets.

Function	free_process_vars
Include file	CSTM_RPT.H
Prototype	void free_process_vars( void )
Remarks	Called at the end of each pass through process_1_ticker to free the ticker's DATA_RECs.

Function	update_library_global_vars
Include file	CSTM_RPT.H
Prototype	void update_library_global_vars( void )
Remarks	Update the TDF_lib global vars with data from the user's command line.

Function	print_usage_cstm_rpt
Include file	CSTM_RPT.H
Prototype	void print_usage_cstm_rpt( void )
Remarks	Print a usage message for CSTM_RPT to the user.

Function	process_cmd_line_4_arguments
Include file	CSTM_RPT.H
Prototype	void process_cmd_line_4_arguments( void )
Remarks	Process the user's command line arguments into a argv array which then is processed by the normal getargs() procedure to store the data into the programs switch flags.

Function	control_c_handler
Include file	CSTM_RPT.H
Prototype	BOOL WINAPI control_c_handler( DWORD dwCtrlType )
Remarks	Catch Cntl C so we can exit via exit() and get a full file flush and close on any open files as well as any local rundown.

Table of Contents Function Index