doc_autodoc.cpp File Reference

#include <iostream>
#include <string>
#include <set>
#include <map>
#include <cstdlib>
#include "doc_autodoc.hh"
#include "tlib.hh"
#include "boxes.hh"
#include "doc.hh"

Include dependency graph for doc_autodoc.cpp:

Go to the source code of this file.

Functions
static void	initDocAutodocKeySet ()
	Initialize gDocAutodocKeySet, a set containing all the keywords.
void	declareAutoDoc ()
	Declare an automatic documentation.
void	initDocAutodoc ()
	Dispatch initialization of autodoc container.
static void	printDocAutodocStringMapContent ()
	Simple trace function.
Variables
SourceReader	gReader
map< string, string >	gDocAutodocStringMap
set< string >	gDocAutodocKeySet

---

Function Documentation

void declareAutoDoc

(

)

Declare an automatic documentation.

This function simulates a default documentation : if no <mdoc> tag was found in the input faust file, and yet the '-math' option was called, then print a complete 'process' doc.

Definition at line 58 of file doc_autodoc.cpp.

References boxIdent(), cons(), declareDoc(), docDgm(), docEqn(), docLst(), docNtc(), docTxt(), gDocAutodocStringMap, SourceReader::listSrcFiles(), and nil.

Referenced by printDoc().

{
    Tree autodoc = nil;
    Tree process = boxIdent("process");
    
    string autoEquationTxt = "\n" + gDocAutodocStringMap["autoeqntitle"] + "\n\n";
    autoEquationTxt += gDocAutodocStringMap["autoeqntext"] + "\n";
    autodoc = cons(docTxt(autoEquationTxt.c_str()), autodoc);
    autodoc = cons(docEqn(process), autodoc);
    
    string autoDiagramTxt = "\n" + gDocAutodocStringMap["autodgmtitle"] + "\n\n";
    autoDiagramTxt += gDocAutodocStringMap["autodgmtext"] + "\n";
    autodoc = cons(docTxt(autoDiagramTxt.c_str()), autodoc);
    autodoc = cons(docDgm(process), autodoc);   
    
    string autoNoticeTxt = "\n" + gDocAutodocStringMap["autontctitle"] + "\n\n";
    autoNoticeTxt += gDocAutodocStringMap["autontctext"] + "\n";
    autodoc = cons(docTxt(autoNoticeTxt.c_str()), autodoc);
    autodoc = cons(docNtc(), autodoc);
    
    string autoListingTxt;
    vector<string> pathnames = gReader.listSrcFiles();
    if(pathnames.size() > 1) {
        autoListingTxt = "\n" + gDocAutodocStringMap["autolsttitle2"] + "\n\n";
        autoListingTxt += gDocAutodocStringMap["autolsttext2"] + "\n";
    } else {
        autoListingTxt = "\n" + gDocAutodocStringMap["autolsttitle1"] + "\n\n";
        autoListingTxt += gDocAutodocStringMap["autolsttext1"] + "\n";
    }
    autodoc = cons(docTxt(autoListingTxt.c_str()), autodoc);
    autodoc = cons(docLst(), autodoc);
    
    declareDoc(autodoc);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void initDocAutodoc

(

)

Dispatch initialization of autodoc container.

Definition at line 97 of file doc_autodoc.cpp.

References initDocAutodocKeySet().

Referenced by loadTranslationFile().

{
    initDocAutodocKeySet();
}

Here is the call graph for this function:

Here is the caller graph for this function:

static void initDocAutodocKeySet

(

)

[static]

Initialize gDocAutodocKeySet, a set containing all the keywords.

Definition at line 112 of file doc_autodoc.cpp.

References gDocAutodocKeySet.

Referenced by initDocAutodoc().

                                   {
    
    gDocAutodocKeySet.insert("autoeqntitle");
    gDocAutodocKeySet.insert("autoeqntext");
    
    gDocAutodocKeySet.insert("autodgmtitle");
    gDocAutodocKeySet.insert("autodgmtext");
    
    gDocAutodocKeySet.insert("autontctitle");
    gDocAutodocKeySet.insert("autontctext");
    
    gDocAutodocKeySet.insert("autolsttitle1");  
    gDocAutodocKeySet.insert("autolsttext1");
    
    gDocAutodocKeySet.insert("autolsttitle2");
    gDocAutodocKeySet.insert("autolsttext2");
}

Here is the caller graph for this function:

static void printDocAutodocStringMapContent

(

)

[static]

Simple trace function.

Definition at line 134 of file doc_autodoc.cpp.

References gDocAutodocStringMap.

                                              {
    bool trace = false;
    if(trace) {
        cout << "gDocAutodocStringMap.size() = " << gDocAutodocStringMap.size() << endl;
        map<string,string>::iterator it;
        int i = 1;
        for(it = gDocAutodocStringMap.begin(); it!=gDocAutodocStringMap.end(); ++it)
            cout << i++ << ".\tgDocNoticeStringMap[" << it->first << "] \t= '" << it->second << "'" << endl;
    }
}

---

Variable Documentation

set<string> gDocAutodocKeySet

Definition at line 38 of file doc_autodoc.cpp.

Referenced by initDocAutodocKeySet(), and storePair().

map<string, string> gDocAutodocStringMap

Definition at line 37 of file doc_autodoc.cpp.

Referenced by declareAutoDoc(), importDocStrings(), printDocAutodocStringMapContent(), and storePair().

SourceReader gReader

Definition at line 85 of file main.cpp.