Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

html_look_integrate.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: html_look_integrate.pm,v 1.2 2002/04/10 00:35:28 gmaxe Exp $
00033 //#
00034 //# Copyright 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00035 //#
00036 //# Revision Information:
00037 //#
00038 //# $Log: html_look_integrate.pm,v $
00039 //# Revision 1.2  2002/04/10 00:35:28  gmaxe
00040 //# Tracing tool now works;
00041 //# indexer ignores more special characters;
00042 //# pm file is the first version; contains the proper data structures
00043 //# to handle bsp/vxworks
00044 //#
00045 //# Revision 1.1  2002/04/06 01:55:12  gmaxe
00046 //# New files and new general constructs for handling tags. Uses globals better.
00047 //# The html_look* files are designed to handle spider tracing of html systems.
00048 //#
00049 //#
00050 //#############################################################################
00051 
00052 
00053 //#############################################################################
00054 /** @fn int BEGIN
00055  ** @brief Code to execute when first entered.
00056  **
00057  ** @param None. 
00058  **
00059  ** @return None.
00060  **
00061  ** @lim None
00062  ** @ingroup tp_xhelp
00063  **/
00064 // #############################################################################
00065 int BEGIN  ( ) {
00066    if (0) {
00067 //       print "xhelp_all.pm BEGIN routine.\n";
00068    }
00069 } //  BEGIN
00070 
00071 //#############################################################################
00072 /** @fn int main
00073  ** @brief Main routine.
00074  **
00075  ** @param None. 
00076  **
00077  ** @return None.
00078  **
00079  ** @lim None
00080  ** @ingroup tp_xhelp
00081  **/
00082 // #############################################################################
00083 // sub main {
00084 {
00085    // #####
00086    // # Main Subroutine doesn't do anything
00087    // #####
00088    if (0) {
00089 //       print "xhelp_all.pm main routine.\n";
00090    }
00091   
00092    //  Needed in order for the package to work correctly from other perl programs.
00093    return(1);
00094 }
00095 
00096 //#############################################################################
00097 /** @fn int declare_variables
00098  ** @brief Allocates memory for all globally used variables.
00099  **
00100  ** @param None. 
00101  **
00102  ** @return None.
00103  **
00104  ** @lim None
00105  ** @ingroup tp_xhelp
00106  **/
00107 // #############################################################################
00108 int declare_variables  ( ) {
00109 
00110    // #############################################################################
00111    // # Declarations: all variables are global.
00112    // #############################################################################
00113 
00114    //  Assume that the starting point is the first element of the top files.
00115    @top_files = ("/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/BSP_Developers_Kit.html",
00116                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/BSP_Reference.html",
00117                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/gnu/gdb/index.html",
00118                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/gnu/make/make_toc.html",
00119                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/gnu/toolkit/index.html",
00120                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/pcmcia/relsupp/index.html",
00121                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado/api/index.html",
00122                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/GUI_Tcl_Library__UNIX_.html",
00123                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/GUI_Tcl_Library__WINODWS_.html",
00124                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Project_Database_Library.html",
00125                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Project_Scripting_Library.html",
00126                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Target_Server_Back_End_Interface.html",
00127                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Target_Server_Internal_Routines.html",
00128                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WDB_Protocol.html",
00129                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_C_Library.html",
00130                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_Prototcol.html",
00131                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_Tcl_Library.html",
00132                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/Tornado_Reference.html",
00133                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado/unixguide/index.html",
00134                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/trueffs/guide/index.html",
00135                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/index.html",
00136                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/index.html",
00137                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/VxWorks_Reference_Manual.html",
00138                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/snmp/supplement/index.html",
00139                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/streams/supplement/index.html",
00140                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/windview/guide/index.html"
00141    );  //  @top_files
00142    @top_files = ("/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/BSP_Developers_Kit.html",
00143                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/BSP_Reference.html",
00144                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/gnu/gdb/index.html",
00145                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/gnu/make/make_toc.html",
00146                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/gnu/toolkit/index.html",
00147                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado/api/index.html",
00148                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/GUI_Tcl_Library__UNIX_.html",
00149                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/GUI_Tcl_Library__WINDOWS_.html",
00150                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Project_Database_Library.html",
00151                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Project_Scripting_Library.html",
00152                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Target_Server_Back_End_Interface.html",
00153                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Target_Server_Internal_Routines.html",
00154                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WDB_Protocol.html",
00155                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_C_Library.html",
00156                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_Protocol.html",
00157                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_Tcl_Library.html",
00158                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/Tornado_Reference.html",
00159                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado/unixguide/index.html",
00160                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/trueffs/guide/index.html",
00161                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/index.html",
00162                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/index.html",
00163                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/VxWorks_Reference_Manual.html",
00164                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/snmp/supplement/index.html",
00165                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/streams/supplement/index.html",
00166                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/windview/guide/index.html"
00167    );  //  @top_files
00168 
00169    $globe::path = "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/";
00170    $globe::nav_purge_path{#define}  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/"
00171    $globe::nav_purge_path{master} = "/rtfm/techpubs/cms_drivers/doc_publish/";
00172    
00173    $globe::top_most_level{title} = "Bridge Support Package (BSP)/VxWorks";
00174    $globe::top_most_level{url} = "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/books.html";
00175 
00176    @ex_as_child = ("/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/books.html",
00177                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/BSP_Developers_Kit.html",
00178                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/BSP_Reference.html",
00179                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/BSP_VTS.html",
00180                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/Tornado_API_Reference.html",
00181                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/GUI_Tcl_Library__UNIX_.html",
00182                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/GUI_Tcl_Library__WINDOWS_.html",
00183                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Project_Database_Library.html",
00184                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Project_Scripting_Library.html",
00185                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Target_Server_Back_End_Interface.html",
00186                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/Target_Server_Internal_Routines.html",
00187                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WDB_Protocol.html",
00188                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_C_Library.html",
00189                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_Protocol.html",
00190                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/WTX_Tcl_Library.html",
00191                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/Tornado_Reference.html",
00192                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/VxWorks_Reference_Manual.html",
00193                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/libIndex.html",
00194                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/rtnIndex.html",
00195                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/bspkit/libIndex.html",
00196                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/gnu/libIndex.html",
00197                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/pcmcia/libIndex.html",
00198                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/snmp/libIndex.html",
00199                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/streams/libIndex.html",
00200                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado/rtnIndex.html",
00201                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado/libIndex.html",
00202                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/tornado-api/libIndex.html",
00203                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/trueffs/libIndex.html",
00204                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/windview/libIndex.html",
00205                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX.html",
00206                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX1.html",
00207                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX2.html",
00208                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX3.html",
00209                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX4.html",
00210                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX5.html",
00211                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX6.html",
00212                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX7.html",
00213                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX8.html",
00214                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX9.html",
00215                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX10.html",
00216                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX11.html",
00217                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX12.html",
00218                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX13.html",
00219                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX14.html",
00220                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX15.html",
00221                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX16.html",
00222                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX17.html",
00223                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX18.html",
00224                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX19.html",
00225                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX20.html",
00226                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX21.html",
00227                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX22.html",
00228                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX23.html",
00229                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX24.html",
00230                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIX25.html",
00231                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/GuideIXTOC.html",
00232                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX.html",
00233                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX1.html",
00234                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX2.html",
00235                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX3.html",
00236                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX4.html",
00237                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX5.html",
00238                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX6.html",
00239                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX7.html",
00240                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX8.html",
00241                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX9.html",
00242                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX10.html",
00243                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX11.html",
00244                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX12.html",
00245                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX13.html",
00246                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX14.html",
00247                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX15.html",
00248                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX16.html",
00249                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX17.html",
00250                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX18.html",
00251                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX19.html",
00252                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX20.html",
00253                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX21.html",
00254                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIX22.html",
00255                  "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/netguide/netguideIXTOC.html"
00256    );  //  @ex_as_child
00257    @gen_ex_child = ("libIndex.html",
00258                     "rtnIndex.html");
00259                  
00260 if (0) {
00261    //  When testing, this reduces the list and the number of greps.
00262    //  @x_names = ("bogus");
00263                
00264    @top_files = ( "/rtfm/techpubs/cms_drivers/doc_publish/book_vxworks/vxworks/guide/index.html");
00265    
00266 }
00267    
00268    if (0) {
00269 //       print "=== Definitions 2 \n";
00270    }
00271 
00272    return (1);
00273 
00274 } //  declare_variables
00275 
00276 //#############################################################################
00277 /** @fn int memory_clean_up
00278  ** @brief Cleans up after all variables that were defined.
00279  **
00280  ** @param None. 
00281  **
00282  ** @return None.
00283  **
00284  ** @lim None
00285  ** @ingroup tp_xhelp
00286  **/
00287 // #############################################################################
00288 int memory_clean_up  ( ) {
00289    // undef (@exclude_f_type);
00290                       
00291    // undef (@exclude_file);
00292    // undef (@exclude_dir);
00293    
00294    // undef (@x_names);
00295                
00296    // undef (@return_types);
00297    
00298    return (1);
00299 }
00300 
00301 //#############################################################################
00302 /** @fn int END
00303  ** @brief Code to run at the end of this routine.
00304  **
00305  ** @param None. 
00306  **
00307  ** @return None.
00308  **
00309  ** @lim None
00310  ** @ingroup tp_tools
00311  **/
00312 // #############################################################################
00313 int END  ( ) {
00314    if (0) {
00315 //       print "xhelp_all.pm END routine.\n";
00316    }
00317 }
00318 
00319 


 "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