Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

xhelp_all.pm

Go to the documentation of this file.
00001 // This file has been modified on-the-fly with an input filter
00002 // to change it from Perl syntax to C++ strictly for the purposes
00003 // of faking out Doxygen. Modifications include:
00004 
00005 // - changing local() definitions to C++ #define statements.
00006 // - commenting out undef statements.
00007 // - changing $globe'... variable names to $globe_...
00008 // - changing sub statements to look like C++ functions.
00009 // - changing # comments to C++ comments.
00010 // - ...
00011 
00012 // If you see other strangeness in the HTML version of the Perl file,
00013 // it comes from getting it to look more C++ like.
00014 
00015 
00016 // #!/usr/#define/bin/perl
00017 package xscope;
00018 
00019 
00020 //#############################################################################
00021 /** @file
00022  ** @brief Defines global variables that can be used by other programs.
00023  ** 
00024  ** Most of the variables refer to tags that we expect to find in the 
00025  ** HTML files. Others define variables that we want to use in a global way.
00026  **
00027  ** @ingroup tp_tools tp_xhelp
00028  **
00029  ** @author Glenn C. Maxey
00030  **/
00031 // #
00032 //#    $Id: xhelp_all.pm,v 1.3 2002/03/28 21:20:50 gmaxe Exp $
00033 //#
00034 //# Copyright 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00035 //#
00036 //# Revision Information:
00037 //#
00038 //# $Log: xhelp_all.pm,v $
00039 //# Revision 1.3  2002/03/28 21:20:50  gmaxe
00040 //# Added support for ingroup extraction.
00041 //#
00042 //# Revision 1.2  2002/02/21 01:38:59  gmaxe
00043 //# Working version of xhelp command extractor and prototype generator.
00044 //#
00045 //# Revision 1.1  2002/02/12 01:50:31  gmaxe
00046 //# Added support for more level chunking;
00047 //# added files to support xhelp;
00048 //# added file to support generating TOC, index from lists.
00049 //# PTR#:
00050 //#
00051 //#
00052 //#############################################################################
00053 
00054 
00055 //#############################################################################
00056 /** @fn int BEGIN
00057  ** @brief Code to execute when first entered.
00058  **
00059  ** @param None. 
00060  **
00061  ** @return None.
00062  **
00063  ** @lim None
00064  ** @ingroup tp_xhelp
00065  **/
00066 // #############################################################################
00067 int BEGIN  ( ) {
00068    if (0) {
00069 //       print "xhelp_all.pm BEGIN routine.\n";
00070    }
00071 } //  BEGIN
00072 
00073 //#############################################################################
00074 /** @fn int main
00075  ** @brief Main routine.
00076  **
00077  ** @param None. 
00078  **
00079  ** @return None.
00080  **
00081  ** @lim None
00082  ** @ingroup tp_xhelp
00083  **/
00084 // #############################################################################
00085 // sub main {
00086 {
00087    // #####
00088    // # Main Subroutine doesn't do anything
00089    // #####
00090    if (0) {
00091 //       print "xhelp_all.pm main routine.\n";
00092    }
00093   
00094    //  Needed in order for the package to work correctly from other perl programs.
00095    return(1);
00096 }
00097 
00098 //#############################################################################
00099 /** @fn int declare_variables
00100  ** @brief Allocates memory for all globally used variables.
00101  **
00102  ** @param None. 
00103  **
00104  ** @return None.
00105  **
00106  ** @lim None
00107  ** @ingroup tp_xhelp
00108  **/
00109 // #############################################################################
00110 int declare_variables  ( ) {
00111 
00112    // #############################################################################
00113    // # Declarations: all variables are global.
00114    // #############################################################################
00115    @include_f_type = ("h", "cpp", "c");
00116    
00117    //  Exclude file types, files, and dir aren't used
00118    if (0) {
00119       @exclude_f_type = ("ben", "ini", "asn", "pl", "awk", 
00120                       "txt", "so", "tcl", "inc", "020", 
00121                       "s4", "sun", "vxworks-ppc860");
00122                       
00123       @exclude_file = ("Entries", "Repository", "Root", "Makefile", "CVS");
00124       @exclude_dir = ("CVS", "cvs");
00125    }
00126    
00127    @x_names = ("xCtrlp", "xdspi", "xmake", "xdump", "xshow", "xset", 
00128                "xget", "xload", "xclear", "xcache", "xupdate", "xmaint", 
00129                "xflush", "xenable", "xdisable", "xfree", "xscript", "xsnd", 
00130                "xstart", "xstop", "xresrcld", "xgo", "xnetm", "xrun", "xptr", 
00131 //                "xturn", "xvoip", "xgrow", "xprint", "xconnect", "xrcv", 
00132                "xshell", "xquery", "xclass", "xshutdown", "xpkt");
00133                
00134    @needed_in = ("xw", "wst", "wcs", "ctiCacheStats", "setMsg", "clearMsg", 
00135                  "resetMsgDefaults", "showMsgs", "setLocalMsg", "clearLocalMsg", 
00136                  "showLocalMsgs", "resetLocalMsgDefaults", "setConsoleOutputFlag", 
00137                  "log_dump", "startPktTrace", "sysxLogDump", "sysCardType", 
00138                  "showMasterClocks", "showBackupClocks", "removeAllProcesses", 
00139                  "xiveChangeExceptionMap", "xping", "xkillHeartbeat", "xuptime");
00140                  
00141    @ingroup = ("xhelp");
00142                  
00143    if (0) {
00144       //  When testing, this reduces the list and the number of greps.
00145       //  @x_names = ("bogus");
00146       // undef (@x_names);
00147                
00148       @needed_in = ("xfreeBPTS", "xdspiChngConfState", "xdspiChngTkrMode", "xdspiCtrlPlay",
00149                     "xdspiPlayDate", "xfreePktTrack");
00150       @needed_in = ("xfreeBPTS", "xshowDspResrc", "xshellSndDiag", "xshowChip");
00151       @ingroup = ("xhelp");
00152    }
00153                  
00154 
00155 
00156    @needed_out = ("bogus");
00157                
00158    @return_types = ("VOID", "XSTAT", "RESRCHNDL", "XBOOL");
00159    
00160    if (0) {
00161 //       print "=== Definitions 2 \n";
00162    }
00163 
00164    return (1);
00165 
00166 } //  declare_variables
00167 
00168 //#############################################################################
00169 /** @fn int memory_clean_up
00170  ** @brief Cleans up after all variables that were defined.
00171  **
00172  ** @param None. 
00173  **
00174  ** @return None.
00175  **
00176  ** @lim None
00177  ** @ingroup tp_xhelp
00178  **/
00179 // #############################################################################
00180 int memory_clean_up  ( ) {
00181    // undef (@exclude_f_type);
00182                       
00183    // undef (@exclude_file);
00184    // undef (@exclude_dir);
00185    
00186    // undef (@x_names);
00187                
00188    // undef (@return_types);
00189    
00190    return (1);
00191 }
00192 
00193 //#############################################################################
00194 /** @fn int END
00195  ** @brief Code to run at the end of this routine.
00196  **
00197  ** @param None. 
00198  **
00199  ** @return None.
00200  **
00201  ** @lim None
00202  ** @ingroup tp_tools
00203  **/
00204 // #############################################################################
00205 int END  ( ) {
00206    if (0) {
00207 //       print "xhelp_all.pm END routine.\n";
00208    }
00209 }
00210 
00211 


 "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