ref2html.cpp File Reference
#include <string>
#include <cctype>
#include <ctime>
#include <iostream>
#include <fstream>
#include "corefaudes.h"

Go to the source code of this file.

Classes

class  PageRecord
 
class  LiteratureRecord
 

Functions

void usage_exit (const std::string &rMessage="")
 
void ChaptersPrefix (const std::string &prefix)
 
std::string TimeStamp (void)
 
std::string PrettyPage (const std::string page)
 
void BottomLineHtml (std::ostream *pStream)
 
void HeaderHtml (std::ostream *pStream)
 
void FooterHtml (std::ostream *pStream)
 
void ImageHtml (std::ostream *pStream, const std::string &rFileName)
 
void ListItemHtml (std::ostream *pStream, const std::string &rLink, const std::string &rText)
 
void TypeHtml (std::ostream *pStream, const std::string &rTypeName)
 
void FunctionHtml (std::ostream *pStream, const std::string &rFunctionName)
 
void TextHtml (std::ostream *pStream, const std::string &rText)
 
std::string TexMacroSubstitute1 (const std::string &rTexString, const std::string &rMacro, const std::string &rSubst)
 
std::string TexSpacing (const std::string &rTexString)
 
std::string TexScripts (const std::string &rTexString)
 
void MathHtml (std::ostream *pStream, const std::string &rMathString)
 
void RecordPages (TokenReader &rTr)
 
void DumpPages (TokenWriter &rTw)
 
void ListTypesHtml (std::ostream *pIndexFile, const std::string &key="")
 
void ListFunctionsHtml (std::ostream *pIndexFile, const std::string &key="")
 
void ListSectionsHtml (std::ostream *pIndexFile, const std::string &key="")
 
void TypeIndexHtml (std::ostream *pIndexFile, const std::string &key="")
 
void FunctionIndexHtml (std::ostream *pIndexFile, const std::string &key="")
 
void ReferenceIndexHtml (std::ostream *pIndexFile, const std::string &key="")
 
void SectionIndexHtml (std::ostream *pIndexFile, const std::string &key)
 
void SignatureHtml (std::ostream *pOutFile, std::string function)
 
void ShortdocHtml (std::ostream *pOutFile, std::string fname)
 
void RecordLiterature (TokenReader &rTr)
 
void DumpLiterature (TokenWriter &rTw)
 
void LiteratureHtml (std::ostream *pStream, const std::string &rLabel="")
 
void CiteHtml (std::ostream *pStream, const std::string &rLabel)
 
void XtractPages (TokenReader &src, const std::string &rDstDir)
 
void XtractFiles (TokenReader &src, const std::string &rDstDir)
 
void LuafaudesIndexHtml (std::ostream *pIndexFile)
 
void ProcessSection (TokenWriter &rTw, TokenReader &rTr)
 
void RefpageHtml (std::ostream *pOutFile, std::string inputfile)
 
void DoxygenHeader (std::ostream *pOutFile)
 
void DoxygenFooter (std::ostream *pOutFile)
 
int main (int argc, char *argv[])
 

Variables

bool mStandaloneReference = false
 
std::string mFrefTitle =""
 
std::string mFrefChapter =""
 
std::string mFrefSection =""
 
std::string mFrefPage =""
 
std::string mFrefLink =""
 
std::string mFrefSummary =""
 
std::string mRtiFile =""
 
std::string mFlxFile =""
 
std::string mDstFile =""
 
std::set< std::string > mSrcFiles
 
std::string mChapterFile =""
 
std::string mIncludeFile =""
 
std::string mBooksPrefix ="../"
 
std::string mChaptersPrefix ="./"
 
std::string mImagePrefix ="./images/"
 
std::string mReferencePrefix ="./reference/"
 
std::string mCsourcePrefix ="./csource/"
 
std::string mLuafaudesPrefix ="./luafaudes/"
 
std::string mDownloadLink ="http://www.rt.techfak.fau.de/FGdes/download.html"
 
std::string mFaudesLink ="http://www.rt.techfak.fau.de/FGdes/faudes"
 
std::string mDestoolLink ="http://www.rt.techfak.fau.de/FGdes/destool"
 
std::string mLuafaudesLink ="http://www.rt.techfak.fau.de/FGdes/faudes/luafaudes/"
 
std::string mCsourceLink ="http://www.rt.techfak.fau.de/FGdes/faudes/csource/"
 
std::string mCssFile ="faudes.css"
 
std::string mThisChapterClass ="chapter_this"
 
std::string mOtherChapterClass ="chapter_other"
 
std::string mExitChapterClass ="chapter_exit"
 
std::set< std::string > mExclLuaSections
 
std::set< std::string > mInclLuaSections
 
std::vector< PageRecordmAllPages
 
std::map< std::string, std::map< std::string, PageRecord > > mRefSectPages
 
std::map< std::string, LiteratureRecordmLiterature
 

Function Documentation

◆ BottomLineHtml()

void BottomLineHtml ( std::ostream *  pStream)

Definition at line 196 of file ref2html.cpp.

◆ ChaptersPrefix()

void ChaptersPrefix ( const std::string &  prefix)

Definition at line 140 of file ref2html.cpp.

◆ CiteHtml()

void CiteHtml ( std::ostream *  pStream,
const std::string &  rLabel 
)

Definition at line 1400 of file ref2html.cpp.

◆ DoxygenFooter()

void DoxygenFooter ( std::ostream *  pOutFile)

Definition at line 2013 of file ref2html.cpp.

◆ DoxygenHeader()

void DoxygenHeader ( std::ostream *  pOutFile)

Definition at line 1969 of file ref2html.cpp.

◆ DumpLiterature()

void DumpLiterature ( TokenWriter rTw)

Definition at line 1334 of file ref2html.cpp.

◆ DumpPages()

void DumpPages ( TokenWriter rTw)

Definition at line 730 of file ref2html.cpp.

◆ FooterHtml()

void FooterHtml ( std::ostream *  pStream)

Definition at line 249 of file ref2html.cpp.

◆ FunctionHtml()

void FunctionHtml ( std::ostream *  pStream,
const std::string &  rFunctionName 
)

Definition at line 306 of file ref2html.cpp.

◆ FunctionIndexHtml()

void FunctionIndexHtml ( std::ostream *  pIndexFile,
const std::string &  key = "" 
)

Definition at line 949 of file ref2html.cpp.

◆ HeaderHtml()

void HeaderHtml ( std::ostream *  pStream)

Definition at line 230 of file ref2html.cpp.

◆ ImageHtml()

void ImageHtml ( std::ostream *  pStream,
const std::string &  rFileName 
)

Definition at line 260 of file ref2html.cpp.

◆ ListFunctionsHtml()

void ListFunctionsHtml ( std::ostream *  pIndexFile,
const std::string &  key = "" 
)

Definition at line 796 of file ref2html.cpp.

◆ ListItemHtml()

void ListItemHtml ( std::ostream *  pStream,
const std::string &  rLink,
const std::string &  rText 
)

Definition at line 271 of file ref2html.cpp.

◆ ListSectionsHtml()

void ListSectionsHtml ( std::ostream *  pIndexFile,
const std::string &  key = "" 
)

Definition at line 831 of file ref2html.cpp.

◆ ListTypesHtml()

void ListTypesHtml ( std::ostream *  pIndexFile,
const std::string &  key = "" 
)

Definition at line 761 of file ref2html.cpp.

◆ LiteratureHtml()

void LiteratureHtml ( std::ostream *  pStream,
const std::string &  rLabel = "" 
)

Definition at line 1379 of file ref2html.cpp.

◆ LuafaudesIndexHtml()

void LuafaudesIndexHtml ( std::ostream *  pIndexFile)

Definition at line 1521 of file ref2html.cpp.

◆ main()

int main ( int  argc,
char *  argv[] 
)

Definition at line 2059 of file ref2html.cpp.

◆ MathHtml()

void MathHtml ( std::ostream *  pStream,
const std::string &  rMathString 
)

Definition at line 501 of file ref2html.cpp.

◆ PrettyPage()

std::string PrettyPage ( const std::string  page)

Definition at line 169 of file ref2html.cpp.

◆ ProcessSection()

void ProcessSection ( TokenWriter rTw,
TokenReader rTr 
)

Definition at line 1555 of file ref2html.cpp.

◆ RecordLiterature()

void RecordLiterature ( TokenReader rTr)

Definition at line 1242 of file ref2html.cpp.

◆ RecordPages()

void RecordPages ( TokenReader rTr)

Definition at line 624 of file ref2html.cpp.

◆ ReferenceIndexHtml()

void ReferenceIndexHtml ( std::ostream *  pIndexFile,
const std::string &  key = "" 
)

Definition at line 995 of file ref2html.cpp.

◆ RefpageHtml()

void RefpageHtml ( std::ostream *  pOutFile,
std::string  inputfile 
)

Definition at line 1819 of file ref2html.cpp.

◆ SectionIndexHtml()

void SectionIndexHtml ( std::ostream *  pIndexFile,
const std::string &  key 
)

Definition at line 1098 of file ref2html.cpp.

◆ ShortdocHtml()

void ShortdocHtml ( std::ostream *  pOutFile,
std::string  fname 
)

Definition at line 1187 of file ref2html.cpp.

◆ SignatureHtml()

void SignatureHtml ( std::ostream *  pOutFile,
std::string  function 
)

Definition at line 1148 of file ref2html.cpp.

◆ TexMacroSubstitute1()

std::string TexMacroSubstitute1 ( const std::string &  rTexString,
const std::string &  rMacro,
const std::string &  rSubst 
)

Definition at line 343 of file ref2html.cpp.

◆ TexScripts()

std::string TexScripts ( const std::string &  rTexString)

Definition at line 416 of file ref2html.cpp.

◆ TexSpacing()

std::string TexSpacing ( const std::string &  rTexString)

Definition at line 372 of file ref2html.cpp.

◆ TextHtml()

void TextHtml ( std::ostream *  pStream,
const std::string &  rText 
)

Definition at line 329 of file ref2html.cpp.

◆ TimeStamp()

std::string TimeStamp ( void  )

Definition at line 154 of file ref2html.cpp.

◆ TypeHtml()

void TypeHtml ( std::ostream *  pStream,
const std::string &  rTypeName 
)

Definition at line 282 of file ref2html.cpp.

◆ TypeIndexHtml()

void TypeIndexHtml ( std::ostream *  pIndexFile,
const std::string &  key = "" 
)

Definition at line 914 of file ref2html.cpp.

◆ usage_exit()

void usage_exit ( const std::string &  rMessage = "")

Definition at line 51 of file ref2html.cpp.

◆ XtractFiles()

void XtractFiles ( TokenReader src,
const std::string &  rDstDir 
)

Definition at line 1470 of file ref2html.cpp.

◆ XtractPages()

void XtractPages ( TokenReader src,
const std::string &  rDstDir 
)

Definition at line 1416 of file ref2html.cpp.

Variable Documentation

◆ mAllPages

std::vector<PageRecord> mAllPages

Definition at line 618 of file ref2html.cpp.

◆ mBooksPrefix

std::string mBooksPrefix ="../"

Definition at line 109 of file ref2html.cpp.

◆ mChapterFile

std::string mChapterFile =""

Definition at line 106 of file ref2html.cpp.

◆ mChaptersPrefix

std::string mChaptersPrefix ="./"

Definition at line 110 of file ref2html.cpp.

◆ mCsourceLink

std::string mCsourceLink ="http://www.rt.techfak.fau.de/FGdes/faudes/csource/"

Definition at line 129 of file ref2html.cpp.

◆ mCsourcePrefix

std::string mCsourcePrefix ="./csource/"

Definition at line 113 of file ref2html.cpp.

◆ mCssFile

std::string mCssFile ="faudes.css"

Definition at line 130 of file ref2html.cpp.

◆ mDestoolLink

std::string mDestoolLink ="http://www.rt.techfak.fau.de/FGdes/destool"

Definition at line 127 of file ref2html.cpp.

◆ mDownloadLink

std::string mDownloadLink ="http://www.rt.techfak.fau.de/FGdes/download.html"

Definition at line 125 of file ref2html.cpp.

◆ mDstFile

std::string mDstFile =""

Definition at line 104 of file ref2html.cpp.

◆ mExclLuaSections

std::set< std::string > mExclLuaSections

Definition at line 602 of file ref2html.cpp.

◆ mExitChapterClass

std::string mExitChapterClass ="chapter_exit"

Definition at line 134 of file ref2html.cpp.

◆ mFaudesLink

std::string mFaudesLink ="http://www.rt.techfak.fau.de/FGdes/faudes"

Definition at line 126 of file ref2html.cpp.

◆ mFlxFile

std::string mFlxFile =""

Definition at line 103 of file ref2html.cpp.

◆ mFrefChapter

std::string mFrefChapter =""

Definition at line 96 of file ref2html.cpp.

◆ mFrefLink

std::string mFrefLink =""

Definition at line 99 of file ref2html.cpp.

◆ mFrefPage

std::string mFrefPage =""

Definition at line 98 of file ref2html.cpp.

◆ mFrefSection

std::string mFrefSection =""

Definition at line 97 of file ref2html.cpp.

◆ mFrefSummary

std::string mFrefSummary =""

Definition at line 100 of file ref2html.cpp.

◆ mFrefTitle

std::string mFrefTitle =""

Definition at line 95 of file ref2html.cpp.

◆ mImagePrefix

std::string mImagePrefix ="./images/"

Definition at line 111 of file ref2html.cpp.

◆ mInclLuaSections

std::set< std::string > mInclLuaSections

Definition at line 603 of file ref2html.cpp.

◆ mIncludeFile

std::string mIncludeFile =""

Definition at line 107 of file ref2html.cpp.

◆ mLiterature

std::map<std::string,LiteratureRecord> mLiterature

Definition at line 1239 of file ref2html.cpp.

◆ mLuafaudesLink

std::string mLuafaudesLink ="http://www.rt.techfak.fau.de/FGdes/faudes/luafaudes/"

Definition at line 128 of file ref2html.cpp.

◆ mLuafaudesPrefix

std::string mLuafaudesPrefix ="./luafaudes/"

Definition at line 114 of file ref2html.cpp.

◆ mOtherChapterClass

std::string mOtherChapterClass ="chapter_other"

Definition at line 133 of file ref2html.cpp.

◆ mReferencePrefix

std::string mReferencePrefix ="./reference/"

Definition at line 112 of file ref2html.cpp.

◆ mRefSectPages

std::map< std::string , std::map< std::string , PageRecord > > mRefSectPages

Definition at line 621 of file ref2html.cpp.

◆ mRtiFile

std::string mRtiFile =""

Definition at line 102 of file ref2html.cpp.

◆ mSrcFiles

std::set< std::string > mSrcFiles

Definition at line 105 of file ref2html.cpp.

◆ mStandaloneReference

bool mStandaloneReference = false

Definition at line 93 of file ref2html.cpp.

◆ mThisChapterClass

std::string mThisChapterClass ="chapter_this"

Definition at line 132 of file ref2html.cpp.

libFAUDES 2.32b --- 2024.03.01 --- c++ api documentaion by doxygen