AliGeant4/config/doc_g4c++2html.pl

   1 #!/usr/bin/perl
   2 # $Id$
   3 # Ivana Hrivnacova 12.2.99
   4 #
   5 # HTML documentation is created for all
   6 # source code files: *.hh *.cc *.icc
   7 # generic makefiles: *.gmk
   8 # and configuration setup scripts
   9
  10 # file extensions
  11 #$INCEXT = ".hh"
  12 #$SRCEXT = ".cc"
  13 #$MKFEXT = ".gmk"
  14
  15 # create doc directory if it does not exist
  16 $CURDIR = `pwd`;
  17 chdir $ENV{'G4INSTALL'};
  18 if (! grep(/doc/, `ls`)) {
  19   `mkdir doc` ;
  20   print "Directory doc has been created." . "\n";
  21 };
  22 # move doc/HTML directory to doc/HTML.old
  23 chdir doc;
  24 if (grep(/HTML.old/, `ls`)) {
  25   print "Cleaning HTML.old" . "\n";
  26   `rm -fr HTML.old`;
  27 }
  28 if (grep(/HTML/, `ls`)) {
  29   `mkdir HTML.old`;
  30   `mv HTML HTML.old`;
  31   print "Old HTML directory has been saved." . "\n";
  32 }
  33 chdir $ENV{'G4INSTALL'};
  34
  35 # create tmpdoc directory is it does not exist
  36 # or clean it
  37 if (! grep(/tmpdoc/, `ls`)) {
  38   `mkdir tmpdoc` ;
  39   print "Directory tmpdoc has been created." . "\n";
  40 } else {
  41   print "Cleaning tmpdoc" . "\n";
  42   `rm -fr tmpdoc/*`;
  43 }
  44
  45 # copy everything for documentation to tmpdoc
  46 @FILELIST = `find . -name "*.ddl"`;
  47 #@FILELIST = (@FILELIST, `find . -name "*.h"`);
  48 @FILELIST = (@FILELIST, `find . -name "*.hh"`);
  49 @FILELIST = (@FILELIST, `find . -name "*.cc"`);
  50 @FILELIST = (@FILELIST, `find . -name "*.icc"`);
  51 @FILELIST = (@FILELIST, `find config -name "*.gmk"`);
  52 @FILELIST = (@FILELIST, `find config -name "setup*"`);
  53 @FILELIST = (@FILELIST, `find config -name "*boot"`);
  54
  55 print "Copying files to tmpdoc" . "\n";
  56 foreach $FILE (@FILELIST) {
  57   chop $FILE;
  58   # exclude dictionary classes
  59   if (!grep(/Dict/,$FILE)) {
  60     `cp $FILE tmpdoc`;
  61   }
  62   #print "$FILE has been copied to tmpdoc" . "\n";
  63 }
  64
  65 # mv *.cc to *.C
  66 # what is recquired by ddl2html.pl
  67 chdir tmpdoc;
  68 print "Renaming files" . "\n";
  69 @CXXLIST = `ls *.cc`;
  70 foreach $CXXFILE (@CXXLIST) {
  71   chop $CXXFILE;
  72   $CFILE = `echo $CXXFILE | sed s/.cc/.C/g`;
  73   `mv $CXXFILE $CFILE`;
  74 }
  75
  76 # mv *.hh to *.h
  77 @HHLIST = `ls *.hh`;
  78 foreach $HHFILE (@HHLIST) {
  79   chop $HHFILE;
  80   $HFILE = `echo $HHFILE | sed s/.hh/.h/g`;
  81   `mv $HHFILE $HFILE`;
  82 }
  83
  84 # execute the modified P.Binko's script
  85 system $ENV{'AG4_INSTALL'} . "/config/doc_g4ddl2html.pl GEANT4 Project";
  86
  87 # move HTML to doc and remove tmpdoc
  88 $DOCDIR = $ENV{'G4INSTALL'} . "/doc";
  89 `mv HTML $DOCDIR`;
  90 print "Removing tmpdoc" . "\n";
  91 chdir $ENV{'G4INSTALL'};
  92 `rm -fr tmpdoc`;
  93
  94 # generate the category pages
  95 system $ENV{'AG4_INSTALL'} . "/config/doc_g4sorthtml.pl";
  96
  97 chdir $CURDIR;