StRoot: macros/html/makedoc.C Source File

00001 // $Id: makedoc.C,v 1.60 2006/08/15 21:43:19 jeromel Exp $
00002 //=======================================================================
00003 // owner: Valery Fine
00004 // what it does: 
00005 //=======================================================================
00006   {
00007  //*-- Author :    Valery Fine   25/12/98
00008  gROOT.Reset();
00009   Char_t *libs[] = { "libTable", "Star2Root","St_base","xdf2root","St_Tables"                    
00010                     , "StChain","StUtilities","StBFChain"};
00011 
00012  TString AFS; // STAR root directory
00013 
00014   Char_t *suffix=0;
00015   Int_t nlist = sizeof(libs)/sizeof(Char_t *);;
00016   Bool_t NT=kFALSE;
00017   if (strcmp(gSystem.GetName(),"WinNT") == 0 )
00018   {
00019      NT=kTRUE;
00020      gSystem.Load("Root_html");
00021      AFS = "//sol/afs_rhic";
00022   }
00023   else
00024      AFS = "/afs/rhic";
00025 
00026    Char_t buffer[256];
00027    if (NT) {
00028     for(Int_t i=0;i<nlist;i++) {
00029        strcpy(buffer,libs[i]);
00030        if (gSystem.Load(buffer))  printf(" Loading DLL \"%s\" failed \n",buffer);
00031     }
00032     
00033    }
00034    else {
00035      gSystem->Load("libTable");
00036      gSystem->Load("Star2Root");
00037      gSystem->Load("St_base");
00038      gSystem->Load("St_baseTest");
00039      gSystem->Load("xdf2root");
00040      gSystem->Load("St_Tables");
00041    
00042 //     gSystem->Load("global.sl");
00043 //     gSystem->Load("St_global");
00044      gSystem->Load("StChain");
00045      gSystem->Load("StUtilities");
00046      gSystem->Load("StBFChain");
00047    
00048      gSystem->Load("St_TLA_Maker.so");
00049      gSystem->Load("St_io_Maker.so");
00050      gSystem->Load("St_xdfin_Maker");
00051      gSystem->Load("StarClassLibrary");
00052      gSystem->Load("StEvent");
00053      //-- gSystem->Load("StPadDisplayMaker");
00054      gSystem->Load("St_geom_Maker");
00055      gSystem->Load("StEventDisplayMaker");
00056 
00057 //     gSystem->Load("St_ebye_Maker");
00058 //     gSystem->Load("St_laser_Maker");
00059 //     gSystem->Load("St_run_Maker");
00060 //     gSystem->Load("St_tpctest_Maker");
00061 
00062 //     gSystem->Load("St_calib_Maker");
00063    }
00064    
00065    
00066   //Create the object of the THtml class
00067   THtml *html = new THtml();
00068 
00069   TString STAR = "$STAR/.$STAR_SYS/obj";  
00070   TString ROOTSYS = "$ROOTSYS/.$STAR_SYS/obj";
00071 
00072   TString sourcedir;
00073   sourcedir =  "$STAR";
00074   if (!NT) { 
00075     sourcedir += ":";
00076     sourcedir += "$STAR/include:";
00077     sourcedir += "$STAR/include/tables:";
00078     sourcedir += "$ROOTSYS/ROOT/root/STAR:";
00079     sourcedir = STAR;
00080     sourcedir += "/StRoot/St_base:";
00081     sourcedir += STAR;
00082     sourcedir += "/StRoot/St_baseTest:";
00083     sourcedir += "$STAR";
00084     sourcedir += "/.share/tables:";
00085     sourcedir += "$STAR";
00086     sourcedir += "/include:";
00087     sourcedir += "$STAR";
00088     sourcedir += "/include/tables:";
00089     sourcedir += STAR;
00090     sourcedir += "/StRoot/StEvent:";
00091     sourcedir += STAR;
00092     sourcedir += "/StRoot/StBFChain:";
00093     sourcedir += STAR;
00094     sourcedir += "/StRoot/StChain:";
00095     sourcedir += STAR;
00096     sourcedir += "/StRoot/St_TLA_Maker:";
00097     sourcedir += STAR;
00098     sourcedir += "/StRoot/StPadDisplay:";
00099     sourcedir += STAR;
00100     sourcedir += "/StRoot/StarClassLibrary:";
00101     sourcedir += "$ROOTSYS";
00102     sourcedir += "/src:";
00103     sourcedir += STAR;
00104     sourcedir += "/StRoot/St_geom_Maker:";
00105     sourcedir += STAR;
00106     sourcedir += "/StRoot/StEventDisplayMaker";  }
00107 
00108   TString lookup ;
00109   if (NT) {
00110     lookup = STAR;
00111     lookup += "/.share/tables;../St_base;";
00112     lookup += STAR;
00113     lookup += ".share/St_base";
00114   }
00115   else {
00116     lookup = "$STAR";
00117     lookup += ":";
00118     lookup += "$ROOTSYS/ROOT/root/STAR:";
00119     lookup += "$ROOTSYS/include:";
00120     lookup += "$STAR";
00121     lookup += "/StRoot/StChain:";
00122     lookup += "$STAR";
00123     lookup += "/include:";
00124     lookup += "$STAR";
00125     lookup += "/include/tables:";
00126     lookup += STAR;
00127     lookup += "/StRoot/xdf2root:";
00128     lookup += STAR;
00129     lookup += "/.share/tables:";
00130     lookup += STAR;
00131     lookup += "/StRoot/St_base:";
00132     lookup += STAR;
00133     lookup += "/StRoot/StChain:";
00134     lookup += STAR;
00135     lookup += "/StRoot/StBFChain:";
00136     lookup += STAR;
00137     lookup += "/StRoot/St_baseTest:";
00138     lookup += STAR;
00139     lookup += "/StRoot/St_TLA_Maker:";
00140     lookup += STAR;
00141     lookup += "/StRoot/St_io_Maker:"; 
00142     lookup += STAR;
00143     lookup += "/StRoot/St_geom_Maker:";
00144     lookup += STAR;
00145     lookup += "/StRoot/StPadDisplayMaker:";
00146     lookup += STAR;
00147     lookup += "/StRoot/StEventDisplayMaker:";
00148     lookup += STAR;
00149     lookup += "/StRoot/StEvent:";
00150     lookup += "$ROOTSYS";
00151     lookup += "/src:";
00152     lookup += STAR;
00153     lookup += "/StRoot/StarClassLibrary";
00154   }
00155 
00156     
00157   html->SetSourceDir(lookup.Data());
00158 
00159   if (NT) 
00160      html->SetOutputDir("J:/Public/STAF/draft/base/html");
00161   else
00162      html->SetOutputDir("$STAR/StRoot/html");
00163 
00164   // Create the list of the classes defined with the loaded DLL's to be documented
00165 
00166   Char_t *classes[] = { "TTableSorter",  "TCL", "StMicky",  "TTableDescriptor"
00167                        ,"St_XDFFile",    "St_Module",       "TTable"
00168                        ,"TDataSet",      "TDataSetIter",    "TFileSet"
00169                        ,"StParticleView","TObjectSet",      "TVolume",      "TVolumePosition"
00170                        ,"StMaker",       "StChain",         "TVolumeView"
00171                        ,"table_head_st", "TVolumeViewIter", "TPolyLineShape"
00172                        ,"TPoints3D",     "St_PolyLine3D",   "TPointsArray3D"
00173                        ,"TTable3Points", "TTablePoints",    "StDefaultFilter"
00174                        ,"St_io_Maker",   "StHelix3DPoints", "StHits3DPoints"
00175                        ,"StObjArray",    "StHit",            "StHelixD"
00176                        ,"StTrack",       
00177                        ,"St_geom_Maker", "StPadDisplayMaker", "St_TLA_Maker"
00178                        ,"StBFChain",     "StEventDisplayMaker",
00179                        ,"StVirtualEventFilter", "TTableIter"
00180                        ,"St_srs_Maker",  "St_xdfin_Maker"
00181                       };
00182   Int_t nclass = 40;
00183   html.MakeIndex();
00184 
00185   // Creat the definitions of the classes not derived from TObjects
00186   if (NT) {
00187      gROOT->LoadMacro("$STAF/inc/table_header.h");
00188   }
00189   else
00190      gROOT->LoadMacro("$STAF/inc/table_header.h");
00191 
00192   TClass header1("table_head_st",1,"table_header.h","table_header.h");
00193   // Create HTML subdirectory tree
00194    const Char_t* htmlTree = "$STAR/StRoot/html";
00195   if (gSystem->AccessPathName(htmlTree) && !NT) {
00196      gSystem->MakeDirectory(htmlTree);
00197   }
00198 
00199   // Make class descriptions
00200   Int_t i=0;
00201   for (i=0;i<nclass;i++)  html.MakeClass(classes[i],kTRUE);
00202 
00203   // Make tables descriptions
00204   St_FileSet tableDir("$STAR/include/tables");
00205   St_DataSetIter nextTable(&tableDir);
00206   St_DataSet *table = 0;
00207   while (table = nextTable()) {
00208     TString tabName = table.GetName();
00209     tabName.ReplaceAll("St_","");
00210     tabName.ReplaceAll("_Table.h","");
00211     tabName += "_st";
00212     html.MakeClass(tabName.Data());
00213 
00214     tabName = table.GetName();    
00215     tabName.ReplaceAll("_Table.h","");
00216     html.MakeClass(tabName.Data());
00217   } 
00218    
00219   TString giffile = STAR;
00220   giffile += "/StRoot/html/src/gif";
00221   if (!NT) {
00222     if (gSystem->AccessPathName(giffile.Data()) && !NT) {
00223     // Create "gif" subdirectory for the first time
00224       printf(" Image directiry is created: <%s>\n", giffile.Data());
00225       gSystem->MakeDirectory(giffile.Data());
00226       gSystem->Exec("cp /afs/rhic.bnl.gov/star/packages/pro/StRoot/html/src/gif/*.* /afs/rhic.bnl.gov/star/packages/adev/StRoot/html/src/gif");
00227     }
00228       // Create links 
00229     gSystem->Symlink("../src/gif","/afs/rhic.bnl.gov/star/packages/adev/StRoot/html/examples/gif");
00230     gSystem->Symlink("src/gif","/afs/rhic.bnl.gov/star/packages/adev/StRoot/html/gif");
00231       // Copy the old images into a new directrory
00232 //      gSystem->Exec("cp /afs/rhic.bnl.gov/star/packages/new/StRoot/html/src/gif/*.* /afs/rhic.bnl.gov/star/packages/adev/StRoot/html/src/gif")
00233   }
00234 
00235   // Make HTML docs for the "plain" text files those are not in the dictionaries
00236   cout << " Making HTML's for macros" << endl;
00237   const Char_t *macros[] = {
00238        "/test/micky.C" ,               "\"Micky\" to test the <matrix> and <triangilar matrix> methods"
00239      , "/test/test10.C",               "How to use the dataset iterator class"
00240      , "/test/test9.C",                "How to read the event from XDF file and build some histograms with ROOT"
00241      , "/test/XDFcopy.C",              "How to read/write XDF file"
00242      , "/test/XDFtest.C",              "How to read/write XDF and ROOT files"
00243      , "/graphics/TurnDisplay.C",      "Macro to plug StEventDisplayMaker into chain and turn it on."
00244      , "/graphics/SetObjectFilter.C",  "Macro to adjust the parameters of the current \"event filter\"."
00245      , "/graphics/TrackFilters/StTrackFilter.cxx", "an example of the implementation of the \"advanced\"  event filter."
00246      , "/graphics/TrackFilters/StTrackFilter.h",   "an example of the definition of the \"advanced\"  event filter."
00247      , "/graphics/boldStyle.C",        "Style file for making presentation histograms."
00248      , "/graphics/videoStyle.C",       "Style file for video presentation histograms."
00249      , "/graphics/PadBrowser.C",       "How to use St_geom_Maker and StPadDisplayMaker"
00250      , "/graphics/basic3dPrimitives.C","An example of the basic 3D STAR object"
00251      , "/graphics/EventPanel.C",       "An example of the ToolBar to control an applications"
00252      , "/graphics/DrawTpcHits.C",      "How to draw 3D view for hits and"
00253      , "/graphics/DrawTrackTpcHits.C", "How to draw 3D view for hits and tracks"
00254      , "/graphics/PadControlPanel.C",  "How to manipulate with 3D pad images"
00255      , "/graphics/HitsDraw.C",         "3D drawing of the STAR Geometry and the hits from the STAF table"
00256      , "/graphics/SubDetectorView.C",  "How to create sub-detector view"
00257      , "/graphics/StarFromWeb.C",      "Access to ROOT/GEANT geometry database"
00258      , "/graphics/STAR_shapes.C",      "Test for the basic STAR GEOMETRY classes"
00259      , "/graphics/StarView.C",         "How to Draw the local STAR 3D geometry"
00260      , "/graphics/StarWebView.C",      "How to Draw the remote STAR 3D geometry"
00261      , "/graphics/StarGeom.C",         "An example of the ROOT/STAR/GEANT interface"
00262 
00263      , "/html/GetEvent.C",             "An example of the reading MDC2 dst events"
00264      , "/html/makedoc.C",              "How to create the HTML documentation"
00265 
00266      , "/QA_Hist_Draw.C",              "An example of the plotting postscript file of the MDC2 histograms"
00267 
00268      , "/examples/TestSorter.C",       "An example of the STAF table sort utility"
00269      , "/examples/XDFBrowser.C",       "XDF file interactive ROOT browser"
00270 
00271      , "/tss.C" ,                      "\"TPC slow simulator\" chain"
00272      , "/bfc.C",                       "An example of the \"Big Full Chain\" production chain"
00273      , "/bfcx.C",                      "An example of the \"Big Full Chain\" production chain"
00274      , "/ebye.C",                      "An example of\"Event by Event\" production chain"
00275      , "/STAR_Demos.C",                "The source of the STAR_demos macro"
00276 };
00277 
00278  if (NT) {
00279     html.Convert("//hepburn/common/p32/root/star/macros/CallMevSaveXDF.cxx","How to call STAF module");
00280     html.Convert("//hepburn/common/p32/root/star/macros/par_anal.cxx","How to pick the XDF file up with ROOT");
00281     html.Convert("//hepburn/common/p32/root/star/macros/MakeHists.cxx","How to read the event from XDF file and build some histograms with ROOT");
00282   }
00283   else {
00284     html.Convert("./CallMevSaveXDF.cxx","How to call STAF module");
00285     html.Convert("./par_anal.cxx","How to pick the XDF file up with ROOT");
00286     html.Convert("./MakeHists.cxx","How to read the event from XDF file and build some histograms with ROOT");
00287   }
00288 
00289 //  html.Convert("./par_anal.cxx","How to create several histrograms from XDF file");
00290 
00291 //  html.Convert("./laser.C","An example of the analysis of laser events equivalent to Iwona's old tst.kumac");
00292 //  html.Convert("./tst.kumac","An example of  Iwona's old tst.kumac of the analysis of laser events");
00293 //  html.Convert("./tpctest.C","ROOT based TPC test analysis");
00294 
00295  Int_t lmacros = sizeof(macros)/sizeof(Char_t *);
00296  for (int i = 0; i < lmacros; i+=2) {
00297       TString starRoot = "$STAR/StRoot/macros";
00298       starRoot += macros[i];
00299       html.Convert(starRoot.Data(),macros[i+1]); 
00300       //  cout << starRoot.Data() << macros[i+1] << ";" << endl;
00301  }
00302 
00303  html.MakeClass("EModuleTypes");
00304  html.MakeIndex();
00305 }
00306 
00307 //___________________________________________________________________________
00308 //___________________________________________________________________________
00309 // $Log: makedoc.C,v $
00310 // Revision 1.60  2006/08/15 21:43:19  jeromel
00311 // Fix rhic -> rhic.bnl.gov
00312 //
00313 // Revision 1.59  2003/04/30 20:40:17  perev
00314 // Warnings cleanup. Modified lines marked VP
00315 //
00316 // Revision 1.58  2001/09/10 13:48:00  jeromel
00317 // Modif by Valeri but not commited
00318 //
00319 // Revision 1.57  2001/09/10 01:37:55  jeromel
00320 // dev -> adev
00321 //
00322 // Revision 1.56  2000/08/27 19:01:19  fine
00323 // StDefaultFilter docs added
00324 //
00325 // Revision 1.55  2000/05/30 00:00:37  fine
00326 // Correction to create STAR/ROOT classes html docs
00327 //
00328 // Revision 1.54  2000/04/18 23:31:16  fine
00329 // adjusted to ROOT 2.24
00330 //
00331 // Revision 1.53  2000/02/24 02:23:47  fine
00332 // St_Table html docs generationn added
00333 //
00334 // Revision 1.52  1999/12/15 23:55:14  fine
00335 // St_TableIter doc included
00336 //
00337 // Revision 1.51  1999/12/15 22:41:24  fine
00338 // clean up
00339 //
00340 // Revision 1.50  1999/12/15 22:33:30  fine
00341 // new class StVirtualEventFilter doc  added
00342 //
00343 // Revision 1.49  1999/12/15 22:29:55  fine
00344 // new macros added
00345 //
00346 // Revision 1.48  1999/12/13 17:05:42  fine
00347 // new marcos TurnDisplay.C SetObjectFilter included
00348 //
00349 // Revision 1.47  1999/12/11 00:27:14  fine
00350 // StBFChain has been added
00351 //
00352 // Revision 1.46  1999/11/18 13:21:45  fine
00353 // Adjusted to the new source tree
00354 //
00355 // Revision 1.45  1999/10/29 16:45:06  fine
00356 // new macro videoStyle and bolStyle have been introduced
00357 //
00358 // Revision 1.44  1999/10/03 00:09:53  fine
00359 // New classes docs StMicky and StCL have been introduced
00360 //
00361 // Revision 1.43  1999/09/26 02:59:54  fine
00362 // html for RMath has been introduced
00363 //
00364 // Revision 1.42  1999/09/14 15:30:40  fine
00365 // makedocs adjusted to the new source tree
00366 //
00367 // Revision 1.41  1999/09/12 01:09:57  fine
00368 // Adjusted to the new source tree
00369 //
00370 // Revision 1.40  1999/08/07 18:36:33  fine
00371 // StDisplayMaker has been included into makedoc
00372 //
00373 // Revision 1.39  1999/07/10 22:59:55  fine
00374 //   St_TLA_Maker docs was introduced
00375 //
00376 // Revision 1.38  1999/06/30 16:29:04  fine
00377 // New scheme to create gif directories. St_geom_Maker introduced
00378 //
00379 // Revision 1.37  1999/06/11 21:41:19  fine
00380 // StarClassLibary share lib is to be loaded
00381 //
00382 // Revision 1.36  1999/06/07 22:56:45  fisyak
00383 // Add EventRead
00384 //
00385 // Revision 1.35  1999/06/04 01:46:09  fine
00386 // New examples have been included
00387 //
00388 // Revision 1.34  1999/06/02 16:32:46  fine
00389 // PadControlPanel macro html has been introduced
00390 //
00391 // Revision 1.33  1999/06/01 01:46:41  fine
00392 // New classes have been added StTrack, StHit, StHelixD StObjArray
00393 //
00394 // Revision 1.32  1999/05/23 21:36:40  fine
00395 // New class have been introduce for html
00396 //
00397 // Revision 1.31  1999/05/21 15:33:59  kathy
00398 // made sure Log & Id are in each file and also put in standard comment line with name of owner
00399 //
00400 //___________________________________________________________________________