Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

globe.pm File Reference

Defines global variables that can be used by other programs. More...

Go to the source code of this file.

Defines

Functions


Detailed Description

Defines global variables that can be used by other programs.

Most of the variables refer to tags that we expect to find in the HTML files. Others define variables that we want to use in a global way.

Tag names that are used in the master template files, all HTML files of the system, Mif2Go mif2htm.ini files, and Doxgyen header/footer files are defined here for all programs. They are in one place to facilitate their editing and maintenance.

Author:
Glenn C. Maxey

Definition in file globe.pm.


Define Documentation

#define after   ""
 

#define after   ""
 

#define before   ""
 

#define before   ""
 

#define chunk_to_parse   $_[0]
 

#define chunk_to_parse   $_[0]
 

#define data   ""
 

#define data   0
 

#define debug_pbt   0
 

#define debug_pcff   0
 

#define debug_v_n_f   0
 

#define debug_xims   0
 

#define debug_xtt   0
 

#define f_name   $_[0]
 

#define file_name   $_[2]
 

#define lm_label   ""
 

#define name   0
 

#define rcnc_debug   0
 

#define separate_comments   $_[1]
 

#define src_file   $_[0]
 

#define src_file   $_[0]
 

#define src_file   $_[0]
 

#define src_file_name   $_[1]
 

#define tag_name   $_[3]
 

#define tag_name   $_[2]
 

#define tag_name   $_[1]
 

#define tag_param   $_[1]
 

#define tag_param   "target"
 

#define tag_xml   $_[1]
 

#define tag_xml   $_[1]
 

#define targ_f_name   0
 

#define targ_xml_tag   $_[2]
 

#define temp_return   ""
 


Function Documentation

int BEGIN  
 

Definition at line 109 of file globe.pm.

if  
 

Definition at line 990 of file globe.pm.

int process_comments_from_file  
 

Processes the comment lines from the file that may have tags in them.

Parameters:
src_file  is the file associated with the comments.
tag_name  defines the tag identifier to look for.
This calls another routine that puts $tag_name name tags into a data structure. When this routine is done, we no longer need globe::comment_file.
Limitations and Caveats:
Does not test the tag_name is valid or has been defined.

Definition at line 972 of file globe.pm.

int read_code_n_comment  
 

Reads in the entire file but separates code from comments in two different structures.

Parameters:
src_file  The file to open and read in.
separate_comments  0 puts it all into $entire_file; 1 puts all of the comments into $comment_file and everything else into $entire_file.
Limitations and Caveats:

Definition at line 896 of file globe.pm.

int xml_tag_target  
 

Gets the data associated with a target in the chunk and passes the chunk back.

Parameters:
chunk_to_parse  A chunk with a target inside of it.
src_file_name  The file associated with the target.
Returns:
The chunk with the target expanded into what it is after hunting it down. The $tag_name tag with the target in it is removed whether or not any associated data could be hunted down.
This calls the validate_and_fetch routine, which in turn calls the globe::read_code_n_comment and process_..._file that were called earlier at a higher level. They are reused in hunting down targets and the targets' data.
Limitations and Caveats:
This does no error checking if the the chunk has the the target in it or if the $tag_name (xml identifier) is defined in the globe.pm file under
globe:
:m_define{
tag_name}.

Definition at line 1117 of file globe.pm.

int xtag_into_mess_structure  
 

Creates a data structure from each line in the message file. This builds a data structure:.

globe:
:tag_mess{file}{
file_name}{$name} = $data;
globe:
:tag_mess{name}{
name}[$i] = $file_name;

$hname = created name for hash made from actual names of parents and children

globe:
:xtag_struct{
hname}{name} = actual item name
globe:
:xtag_struct{
hname}{parent} = owning section
globe:
:xtag_struct{
hname}{child}[] = array of associated children
globe:
:xtag_struct{
hname}{comment} = comment flag
globe:
:xtag_struct{
hname}{desc_html} = description in html
globe:
:xtag_struct{
hname}{desc_man} = description in man

$name = name associated with number $msg_struct{$name}{severity} = severity associated with number $msg_struct{$name}{message} = message associated with number $msg_struct{$name}{comment} = comment associated with number

Limitations and Caveats:

Definition at line 1068 of file globe.pm.



 "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