// @(#)root/html:$Name: not supported by cvs2svn $:$Id: MHtml.h,v 1.3 2001-10-31 13:46:12 tbretz Exp $ // Author: Nenad Buncic 18/10/95 /************************************************************************* * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. * * All rights reserved. * * * * For the licensing terms see $ROOTSYS/LICENSE. * * For the list of contributors see $ROOTSYS/README/CREDITS. * *************************************************************************/ #ifndef MARS_MHtml #define MARS_MHtml //////////////////////////////////////////////////////////////////////////// // // // THtml // // // // Html makes a documentation for all ROOT classes // // using Hypertext Markup Language 2.0 // // // //////////////////////////////////////////////////////////////////////////// class TClass; class TVirtualPad; class MHtml : public TObject { private: TString fXwho; // by default http://xwho.cern.ch/WHO/people? const char *fSourcePrefix; // prefix to relative source path const char *fSourceDir; // source path const char *fOutputDir; // output directory char *fLine; // current line Int_t fLen; // maximum line length char *fCounter; // counter string Bool_t fEscFlag; // Flag to mark the symbol must be written "as is" char fEsc; // The special symbol ("backslash" by default) to mark "the next symbol should not be converted void Class2Html(TClass *classPtr, Bool_t force=kFALSE); void ClassDescription(ofstream &out, TClass *classPtr, Bool_t &flag); void ClassTree(TVirtualPad *canvas, TClass *classPtr, Bool_t force=kFALSE); Bool_t CopyHtmlFile(const char *sourceName, const char *destName=""); void CreateIndex(const char **classNames, Int_t numberOfClasses); void CreateIndexByTopic(char **filenames, Int_t numberOfNames, Int_t maxLen); void CreateListOfTypes(); void DerivedClasses(ofstream &out, TClass *classPtr); void ExpandKeywords(ofstream &out, char *text, TClass *ptr2class, Bool_t &flag, const char *dir=""); void ExpandPpLine(ofstream &out, char *line); TClass *GetClass(const char *name, Bool_t load=kTRUE); const char *GetFileName(const char *filename); char *GetSourceFileName(const char *filename); char *GetHtmlFileName(TClass *classPtr); Bool_t IsModified(TClass *classPtr, const Int_t type); Bool_t IsName(Int_t c); Bool_t IsWord(Int_t c); void ReplaceSpecialChars(ofstream &out, const char c); void ReplaceSpecialChars(ofstream &out, const char *string); void SortNames(const char **strings, Int_t num, Bool_t type=0); char *StrDup(const char *s1, Int_t n = 1); friend Int_t CaseSensitiveSort(const void *name1, const void *name2); friend Int_t CaseInsensitiveSort(const void *name1, const void *name2); public: MHtml(); virtual ~MHtml(); void Convert(const char *filename, const char *title, const char *dirname = ""); const char *GetSourceDir() { return fSourceDir; } const char *GetOutputDir() { return fOutputDir; } const char *GetXwho() const { return fXwho.Data(); } void MakeAll(Bool_t force=kFALSE); void MakeClass(const char *className, Bool_t force=kFALSE); void MakeIndex(); void MakeTree(const char *className, Bool_t force=kFALSE); void SetEscape(char esc='\\') { fEsc = esc; } void SetSourcePrefix(const char *prefix) { fSourcePrefix = prefix; } void SetSourceDir(const char *dir) { fSourceDir = dir; } void SetOutputDir(const char *dir) { fOutputDir = dir; } void SetXwho(const char *xwho) { fXwho = xwho; } virtual void WriteHtmlHeader(ofstream &out, const char *title); virtual void WriteHtmlFooter(ofstream &out, const char *dir="", const char *lastUpdate="", const char *author="", const char *copyright=""); ClassDef(MHtml,0) //Convert class(es) into HTML file(s) }; #endif