doc_notice.hh File Reference

#include <iostream>
#include <fstream>
#include <sstream>
#include <map>
#include <string>

Include dependency graph for doc_notice.hh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	initDocNotice ()
	Dispatch initialization of notice containers, after default notice file loading. More...
void	printDocNotice (const string &faustversion, ostream &docout)
	Print the content of the notice (a string map), as LaTeX items inside an itemize environment. More...

Variables
map< string, bool >	gDocNoticeFlagMap
	gDocNoticeFlagMap is public to let others turn to "true" flags that one want to print. More...

Function Documentation

void initDocNotice

(

)

Dispatch initialization of notice containers, after default notice file loading.

Remarks

The default (english) notice is already loaded at this stage to ensure that all keywords will receive a definition.

Definition at line 134 of file doc_notice.cpp.

References initDocNoticeFlagMap(), and initDocNoticeKeySet().

Referenced by loadTranslationFile().

{
    initDocNoticeKeySet();
    initDocNoticeFlagMap();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void printDocNotice	(	const string &	faustversion,
		ostream &	docout
	)

Print the content of the notice (a string map), as LaTeX items inside an itemize environment.

Remarks

This function is meant to make it easier to reorder the notice printing by gathering all the items.

Parameters

[in]	notice	The set containing the strings to print as items.
[in]	faustversion	The current version of this Faust compiler.
[out]	docout	The LaTeX output file to print into.

Definition at line 66 of file doc_notice.cpp.

References gDocAutodocStringMap, gDocNoticeFlagMap, and gDocNoticeStringMap.

Referenced by printdoccontent().

                                                                 {
    
    if (! gDocNoticeStringMap.empty() ) {
        
        //cerr << "Documentator : printDocNotice : printing..." << endl;
        
        docout << endl << "\\begin{itemize}" << endl;
        
        /* Presentations. */
        docout << "\t\\item " << gDocAutodocStringMap["autontctext"]    << endl;
        if(gDocNoticeFlagMap["faustapply"])         docout << "\t\\item " << gDocNoticeStringMap["faustapply"]  << endl;
        if(gDocNoticeFlagMap["faustpresentation"])  docout << "\t\\item " << gDocNoticeStringMap["faustpresentation"]   << endl;
        if(gDocNoticeFlagMap["causality"])          docout << "\t\\item " << gDocNoticeStringMap["causality"]   << endl;
        if(gDocNoticeFlagMap["blockdiagrams"])      docout << "\t\\item " << gDocNoticeStringMap["blockdiagrams"]   << endl;
        
        /* Naming conventions of variables and functions. */
        if(gDocNoticeFlagMap["foreignfun"])     docout << "\t\\item " << gDocNoticeStringMap["foreignfun"]  << endl;
        if(gDocNoticeFlagMap["intcast"])        docout << "\t\\item " << gDocNoticeStringMap["intcast"] << endl;
        
        /* Integer arithmetic into a tabular environment. */
        if(gDocNoticeFlagMap["intplus"] || 
           gDocNoticeFlagMap["intminus"] || 
           gDocNoticeFlagMap["intmult"] || 
           gDocNoticeFlagMap["intdiv"] || 
           gDocNoticeFlagMap["intand"] || 
           gDocNoticeFlagMap["intor"] || 
           gDocNoticeFlagMap["intxor"])
        {
            gDocNoticeFlagMap["operators"]      = true;
            gDocNoticeFlagMap["optabtitle"]     = true;
            gDocNoticeFlagMap["integerops"]     = true;
            
            docout << "\t\\item " << endl;
            docout << "\t\t" << gDocNoticeStringMap["operators"] << endl;
            docout << "\t\\begin{center}" << endl;
            docout << "\t\\begin{tabular}{|c|l|l|} " << endl;
            docout << "\t\t\\hline " << endl;
            docout << "\t\t" << gDocNoticeStringMap["optabtitle"]   << endl;
            docout << "\t\t\\hline " << endl;
            if(gDocNoticeFlagMap["intplus"])    docout << "\t\t" << gDocNoticeStringMap["intplus"]  << endl;
            if(gDocNoticeFlagMap["intminus"])   docout << "\t\t" << gDocNoticeStringMap["intminus"] << endl;
            if(gDocNoticeFlagMap["intmult"])    docout << "\t\t" << gDocNoticeStringMap["intmult"]  << endl;
            if(gDocNoticeFlagMap["intdiv"])     docout << "\t\t" << gDocNoticeStringMap["intdiv"]   << endl;
            if(gDocNoticeFlagMap["intand"])     docout << "\t\t" << gDocNoticeStringMap["intand"]   << endl;
            if(gDocNoticeFlagMap["intor"])      docout << "\t\t" << gDocNoticeStringMap["intor"]    << endl;
            if(gDocNoticeFlagMap["intxor"])     docout << "\t\t" << gDocNoticeStringMap["intxor"]   << endl;
            docout << "\t\t\\hline " << endl;
            docout << "\t\\end{tabular} " << endl;
            docout << "\t\\end{center}" << endl;
            docout << "\t\t" << gDocNoticeStringMap["integerops"]   << endl;
        }

        if(gDocNoticeFlagMap["faustdocdir"])        docout << "\t\\item " << gDocNoticeStringMap["faustdocdir"] << endl;

        docout << "\\end{itemize}" << endl << endl;
    }
    //cerr << "  ... Documentator : printDocNotice : end of printing." << endl;
}

Here is the caller graph for this function:

Variable Documentation

map<string, bool> gDocNoticeFlagMap

gDocNoticeFlagMap is public to let others turn to "true" flags that one want to print.

Definition at line 36 of file doc_notice.cpp.

Referenced by DocCompiler::compileLateq(), DocCompiler::generateBinOp(), DocCompiler::generateButton(), DocCompiler::generateCacheCode(), DocCompiler::generateCheckbox(), DocCompiler::generateDocConstantTbl(), DocCompiler::generateDocWriteTbl(), DocCompiler::generateFConst(), DocCompiler::generateFFun(), DocCompiler::generateFVar(), DocCompiler::generateHSlider(), DocCompiler::generateInput(), DocCompiler::generateIntCast(), DocCompiler::generateNumber(), DocCompiler::generateNumEntry(), DocCompiler::generateOutput(), DocCompiler::generatePrefix(), DocCompiler::generateRec(), DocCompiler::generateSelect2(), DocCompiler::generateSelect3(), DocCompiler::generateVariableStore(), DocCompiler::generateVSlider(), initDocNoticeFlagMap(), printDocDgm(), and printDocNotice().