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.
void printDocNotice (const string &faustversion, ostream &docout)
 Print the content of the notice (a string map), as LaTeX items inside an itemize environment.

Variables

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

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 140 of file doc_notice.cpp.

References initDocNoticeFlagMap(), and initDocNoticeKeySet().

Referenced by loadTranslationFile().

00141 {
00142     initDocNoticeKeySet();
00143     initDocNoticeFlagMap();
00144 }

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 68 of file doc_notice.cpp.

References gDocNoticeFlagMap, gDocNoticeStringMap, and getCompilationDate().

Referenced by printdoccontent().

00068                                                                  {
00069     
00070     if (! gDocNoticeStringMap.empty() ) {
00071         
00072         //cerr << "Documentator : printDocNotice : printing..." << endl;
00073         
00074         docout << endl << "\\begin{itemize}" << endl;
00075         
00076         /* Faust "compilation stamp" : version and date. */
00077         if(gDocNoticeFlagMap["compilstamp1"] && gDocNoticeFlagMap["compilstamp2"] && gDocNoticeFlagMap["compilstamp3"]) {
00078             char datebuf [150];
00079             strftime (datebuf, 150, "%B %d, %Y", getCompilationDate());
00080             docout << "\t\\item " << gDocNoticeStringMap["compilstamp1"] << faustversion;
00081             docout << gDocNoticeStringMap["compilstamp2"] << datebuf;
00082             docout << gDocNoticeStringMap["compilstamp3"] << endl;
00083         }
00084         
00085         /* Various warnings and remarks. */
00086         if(gDocNoticeFlagMap["svgdir"])         docout << "\t\\item " << gDocNoticeStringMap["svgdir"]  << endl;
00087         if(gDocNoticeFlagMap["nameconflicts"])  docout << "\t\\item " << gDocNoticeStringMap["nameconflicts"]   << endl;
00088         if(gDocNoticeFlagMap["causality"])      docout << "\t\\item " << gDocNoticeStringMap["causality"]   << endl;
00089         
00090         /* Naming conventions of variables and functions. */
00091         if(gDocNoticeFlagMap["fsamp"])          docout << "\t\\item " << gDocNoticeStringMap["fsamp"]   << endl;
00092         if(gDocNoticeFlagMap["foreignfun"])     docout << "\t\\item " << gDocNoticeStringMap["foreignfun"]  << endl;
00093         if(gDocNoticeFlagMap["intcast"])        docout << "\t\\item " << gDocNoticeStringMap["intcast"] << endl;
00094         if(gDocNoticeFlagMap["cdot"])           docout << "\t\\item " << gDocNoticeStringMap["cdot"]    << endl;
00095         
00096         /* Integer arithmetic. */
00097         if(gDocNoticeFlagMap["intplus"] || 
00098            gDocNoticeFlagMap["intminus"] || 
00099            gDocNoticeFlagMap["intmult"] || 
00100            gDocNoticeFlagMap["intdiv"]) 
00101         {
00102             if(gDocNoticeFlagMap["intplus"])    docout << "\t\\item " << gDocNoticeStringMap["intplus"] << endl;
00103             if(gDocNoticeFlagMap["intminus"])   docout << "\t\\item " << gDocNoticeStringMap["intminus"]    << endl;
00104             if(gDocNoticeFlagMap["intmult"])    docout << "\t\\item " << gDocNoticeStringMap["intmult"] << endl;
00105             if(gDocNoticeFlagMap["intdiv"])     docout << "\t\\item " << gDocNoticeStringMap["intdiv"]  << endl;
00106         }
00107         
00108         /* Signals naming conventions. */
00109         if(gDocNoticeFlagMap["inputsig"])       docout << "\t\\item " << gDocNoticeStringMap["inputsig"]    << endl;
00110         if(gDocNoticeFlagMap["inputsigs"])      docout << "\t\\item " << gDocNoticeStringMap["inputsigs"]   << endl;
00111         if(gDocNoticeFlagMap["outputsig"])      docout << "\t\\item " << gDocNoticeStringMap["outputsig"]   << endl;
00112         if(gDocNoticeFlagMap["outputsigs"])     docout << "\t\\item " << gDocNoticeStringMap["outputsigs"]  << endl;
00113         if(gDocNoticeFlagMap["constsigs"])      docout << "\t\\item " << gDocNoticeStringMap["constsigs"]   << endl;
00114         if(gDocNoticeFlagMap["paramsigs"])      docout << "\t\\item " << gDocNoticeStringMap["paramsigs"]   << endl;
00115         if(gDocNoticeFlagMap["storedsigs"])     docout << "\t\\item " << gDocNoticeStringMap["storedsigs"]  << endl;
00116         if(gDocNoticeFlagMap["buttonsigs"])     docout << "\t\\item " << gDocNoticeStringMap["buttonsigs"]  << endl;
00117         if(gDocNoticeFlagMap["checkboxsigs"])   docout << "\t\\item " << gDocNoticeStringMap["checkboxsigs"]    << endl;
00118         if(gDocNoticeFlagMap["slidersigs"])     docout << "\t\\item " << gDocNoticeStringMap["slidersigs"]  << endl;
00119         if(gDocNoticeFlagMap["nentrysigs"])     docout << "\t\\item " << gDocNoticeStringMap["nentrysigs"]  << endl;
00120         if(gDocNoticeFlagMap["tablesigs"])      docout << "\t\\item " << gDocNoticeStringMap["tablesigs"]   << endl;
00121         if(gDocNoticeFlagMap["recursigs"])      docout << "\t\\item " << gDocNoticeStringMap["recursigs"]   << endl;
00122         if(gDocNoticeFlagMap["prefixsigs"])     docout << "\t\\item " << gDocNoticeStringMap["prefixsigs"]  << endl;
00123         if(gDocNoticeFlagMap["selectionsig"])   docout << "\t\\item " << gDocNoticeStringMap["selectionsig"]    << endl;
00124         if(gDocNoticeFlagMap["selectionsigs"])  docout << "\t\\item " << gDocNoticeStringMap["selectionsigs"]   << endl;
00125         
00126         docout << "\\end{itemize}" << endl << endl;
00127     }
00128     //cerr << "  ... Documentator : printDocNotice : end of printing." << endl;
00129 }

Here is the call graph for this function:

Here is the caller graph for this function:


Variable Documentation

map<string, bool> gDocNoticeFlagMap
Generated on Thu Apr 29 00:00:04 2010 for FAUST compiler by  doxygen 1.6.3