Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

asn_bapitypes.pl File Reference

Looks at asn files and stores information about enumerations so that it can be merged with with bapitypes.h. More...

Go to the source code of this file.

Functions

Variables


Detailed Description

Looks at asn files and stores information about enumerations so that it can be merged with with bapitypes.h.

A platform-independent definition of enumerations et al are defined in asn files. Comments have been added to these files but the normal asn tools do not pass them through to the h files.

This tool parses the asn files and stores information. Then it parses the generated bapitypes.h file. It merges information stored with information from bapitypes.h and outputs a file with the merged information.

Author:
Glenn C. Maxey

Definition in file asn_bapitypes.pl.


Function Documentation

int create_file_list  
 

Creates a temporary file that lists all of the files which should be processed.

Returns:
The file is created in the directory given by the first input parameter to the program.
Limitations and Caveats:

Definition at line 192 of file asn_bapitypes.pl.

int fix_enum_list  
 

Resolves enumeration items that were built from other components.

Duplicates entries in the hash table for the equivalent of the component. Removes place-holder entries in the hash that say component.

Limitations and Caveats:
This is called several times so that it can resolve things as new things are learned.

Definition at line 442 of file asn_bapitypes.pl.

if  
 

Definition at line 397 of file asn_bapitypes.pl.

if   file_errors
 

Definition at line 165 of file asn_bapitypes.pl.

int process_file_list  
 

Gathers information from all files given in the list.

Opens the file that contains the list of files that are of interest. Then it opens each of those files one at a time.

Returns:
This creates two hash tables. One is for the code top item and the other is for enumeration values (of a code top item). A "code top item" is some code element definition. Top means that it is not part of an enumeration.
In both cases, what the hash stores is the doxygen comment associated with it.

The key into ct_item is the name of the item fixed up to what will be seen later in bapitypes.

The key into enum_item is the name of the enumeration plus the enumeration item fixed up to what will be seen later in bapitypes.

Limitations and Caveats:
None.

Definition at line 232 of file asn_bapitypes.pl.

int read_manipulate_master  
 

Reads in the file generated by development tools and appends any dox comments that those tools may have stripped from the source files.

Returns:
$bapitypes contains the original information along with comments.

Definition at line 494 of file asn_bapitypes.pl.

return  
 

int using_asn_bapi  
 

What to do when no arguments are given.

Parameters:
None 
Returns:
None
Limitations and Caveats:
None

Definition at line 665 of file asn_bapitypes.pl.

int write_output_file  
 

Uses the second argument of the input (master file) and appends ".gen" to the name and outputs the enhanced data.

Returns:
A new file named similar to the input file but with a ".gen" extension.

Definition at line 626 of file asn_bapitypes.pl.

& write_output_file   out_file
 


Variable Documentation

out_file = "$bapitypes_file.gen"
 

Definition at line 159 of file asn_bapitypes.pl.



 "Perl Program Reference" 
 < Previous 
 Next > 



Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-perl-hcr-02