KDevelop API Documentation

messages.cpp

Go to the documentation of this file.
00001 #include <qmap.h>
00002 
00003 
00004 #include <kdebug.h>
00005 #include <klocale.h>
00006 
00007 
00008 static QMap<QCString,QString> messages;
00009 
00010 
00011 // Note: this function seems to be completely unnecessary, but messages.insert
00012 // is a template function, so doing the template expansion just once reduced
00013 // the compile time of this trivial file from >5m to <30s on my machine. mhk.
00014 static void addMessage(const QCString key, const QString &message)
00015 {
00016   messages.insert(key, message);
00017 }
00018 
00019 
00020 QString message(const QCString &key)
00021 {
00022   static bool initialized = false;
00023 
00024   if (!initialized)
00025   {
00026     //---------------------------------------------------------------------------
00027     // Project related configuration options
00028     //---------------------------------------------------------------------------
00029     addMessage("Project", i18n("Project"));
00030     addMessage("PROJECT_NAME", i18n("Project name"));
00031     addMessage("PROJECT_NUMBER", i18n("Project version"));
00032     addMessage("OUTPUT_DIRECTORY", i18n("Output path"));
00033     addMessage("CREATE_SUBDIRS", i18n("Distribute the generated docs in 10 subdirectories"));
00034     addMessage("OUTPUT_LANGUAGE", i18n("Output language"));
00035     addMessage("USE_WINDOWS_ENCODING", i18n("Use MS Windows(tm) font encoding"));
00036     addMessage("BRIEF_MEMBER_DESC", i18n("Include brief member descriptions"));
00037     addMessage("REPEAT_BRIEF", i18n("Repeat brief member descriptions"));
00038     addMessage("ABBREVIATE_BRIEF", i18n("Strip words in brief description"));
00039     addMessage("ALWAYS_DETAILED_SEC", i18n("Always include detailed section"));
00040     addMessage("INLINE_INHERITED_MEMB", i18n("Inline inherited members"));
00041     addMessage("FULL_PATH_NAMES", i18n("Always use full path names"));
00042     addMessage("STRIP_FROM_PATH", i18n("Prefix to strip from path names"));
00043     addMessage("STRIP_FROM_INC_PATH", i18n("Strip from include path"));
00044     addMessage("SHORT_NAMES", i18n("Generate short file names"));
00045     addMessage("JAVADOC_AUTOBRIEF", i18n("Use JavaDoc-style brief descriptions"));
00046     addMessage("MULTILINE_CPP_IS_BRIEF", i18n("Multiline cpp is brief"));
00047     addMessage("DETAILS_AT_TOP", i18n("Details at top"));
00048     addMessage("INHERIT_DOCS", i18n("Inherit documentation"));
00049     addMessage("DISTRIBUTE_GROUP_DOC", i18n("Use group documentation on undocumented members"));
00050     addMessage("TAB_SIZE", i18n("Tab size"));
00051     addMessage("ALIASES", i18n("Aliases"));
00052     addMessage("OPTIMIZE_OUTPUT_FOR_C", i18n("Optimize output for C"));
00053     addMessage("OPTIMIZE_OUTPUT_JAVA", i18n("Optimize output for Java"));
00054     addMessage("SUBGROUPING", i18n("Class members type subgrouping"));
00055 
00056     //---------------------------------------------------------------------------
00057     // Build related configuration options
00058     //---------------------------------------------------------------------------
00059     addMessage("Build", i18n("Build"));
00060     addMessage("EXTRACT_ALL", i18n("Extract undocumented entities"));
00061     addMessage("EXTRACT_PRIVATE", i18n("Extract private entities"));
00062     addMessage("EXTRACT_STATIC", i18n("Extract static entities"));
00063     addMessage("EXTRACT_LOCAL_CLASSES", i18n("Extract local classes"));
00064     addMessage("EXTRACT_LOCAL_METHODS", i18n("Extract local methods"));
00065     addMessage("HIDE_UNDOC_MEMBERS", i18n("Hide undocumented members"));
00066     addMessage("HIDE_UNDOC_CLASSES", i18n("Hide undocumented classes"));
00067     addMessage("HIDE_FRIEND_COMPOUNDS", i18n("Hide friend compounds"));
00068     addMessage("HIDE_IN_BODY_DOCS", i18n("Hide in body docs"));
00069     addMessage("INTERNAL_DOCS", i18n("Document internal entities"));
00070     addMessage("CASE_SENSE_NAMES", i18n("Use case-sensitive file names"));
00071     addMessage("HIDE_SCOPE_NAMES", i18n("Hide name scopes"));
00072     addMessage("SHOW_INCLUDE_FILES", i18n("Show included files"));
00073     addMessage("INLINE_INFO", i18n("Make inline functions"));
00074     addMessage("SORT_MEMBER_DOCS", i18n("Sort member documentation alphabetically"));
00075     addMessage("SORT_BY_SCOPE_NAME", i18n("Sort the class list by fully-qualified names"));
00076     addMessage("SORT_BRIEF_DOCS", i18n("Sort brief documentation alphabetically"));
00077     addMessage("ENABLED_SECTIONS", i18n("Enable conditional sections"));
00078     addMessage("GENERATE_TODOLIST", i18n("Generate TODO-list"));
00079     addMessage("GENERATE_TESTLIST", i18n("Generate Test-list"));
00080     addMessage("GENERATE_BUGLIST", i18n("Generate Bug-list"));
00081     addMessage("GENERATE_DEPRECATEDLIST", i18n("Generate Deprecated-list"));
00082     addMessage("MAX_INITIALIZER_LINES", i18n("Maximum lines shown for initializers"));
00083     addMessage("SHOW_USED_FILES", i18n("Show used files"));
00084 
00085     //---------------------------------------------------------------------------
00086     // configuration options related to warning and progress messages
00087     //---------------------------------------------------------------------------
00088     addMessage("Messages", i18n("Messages"));
00089     addMessage("QUIET", i18n("Suppress output"));
00090     addMessage("WARNINGS", i18n("Show warnings"));
00091     addMessage("WARN_IF_UNDOCUMENTED", i18n("Warn about undocumented entities"));
00092     addMessage("WARN_IF_DOC_ERROR", i18n("Warn if error in documents"));
00093     addMessage("WARN_FORMAT", i18n("Warnings format"));
00094     addMessage("WARN_LOGFILE", i18n("Write warnings to"));
00095 
00096     //---------------------------------------------------------------------------
00097     // configuration options related to the input files
00098     //---------------------------------------------------------------------------
00099     addMessage("Input", i18n("Input"));
00100     addMessage("INPUT", i18n("Input files and directories"));
00101     addMessage("FILE_PATTERNS", i18n("Input patterns"));
00102     addMessage("RECURSIVE", i18n("Recurse into subdirectories"));
00103     addMessage("EXCLUDE", i18n("Exclude from input"));
00104     addMessage("EXCLUDE_SYMLINKS", i18n("Exclude symlinks"));
00105     addMessage("EXCLUDE_PATTERNS", i18n("Exclude patterns"));
00106     addMessage("EXAMPLE_PATH", i18n("Path to examples"));
00107     addMessage("EXAMPLE_PATTERNS", i18n("Example patterns"));
00108     addMessage("EXAMPLE_RECURSIVE", i18n("Example recursive"));
00109     addMessage("IMAGE_PATH", i18n("Path to images"));
00110     addMessage("INPUT_FILTER", i18n("Input filter"));
00111     addMessage("FILTER_SOURCE_FILES", i18n("Filter input files"));
00112 
00113     //---------------------------------------------------------------------------
00114     // configuration options related to source browsing
00115     //---------------------------------------------------------------------------
00116     addMessage("Source Browser", i18n("Source Browser"));
00117     addMessage("SOURCE_BROWSER", i18n("Cross-reference with source files"));
00118     addMessage("INLINE_SOURCES", i18n("Inline sources"));
00119     addMessage("STRIP_CODE_COMMENTS", i18n("Hide special comment blocks"));
00120     addMessage("REFERENCED_BY_RELATION", i18n("Referenced by relation"));
00121     addMessage("REFERENCES_RELATION", i18n("References relation"));
00122     addMessage("VERBATIM_HEADERS", i18n("Include headers verbatim"));
00123 
00124     //---------------------------------------------------------------------------
00125     // configuration options related to the alphabetical class index
00126     //---------------------------------------------------------------------------
00127     addMessage("Index", i18n("Index"));
00128     addMessage("ALPHABETICAL_INDEX", i18n("Generate alphabetical index"));
00129     addMessage("COLS_IN_ALPHA_INDEX", i18n("Columns in index"));
00130     addMessage("IGNORE_PREFIX", i18n("Prefix to ignore"));
00131 
00132     //---------------------------------------------------------------------------
00133     // configuration options related to the HTML output
00134     //---------------------------------------------------------------------------
00135     addMessage("HTML", i18n("HTML"));
00136     addMessage("GENERATE_HTML", i18n("Generate HTML"));
00137     addMessage("HTML_OUTPUT", i18n("HTML output directory"));
00138     addMessage("HTML_FILE_EXTENSION", i18n("HTML file extension"));
00139     addMessage("HTML_HEADER", i18n("Header file"));
00140     addMessage("HTML_FOOTER", i18n("Footer file"));
00141     addMessage("HTML_STYLESHEET", i18n("Stylesheet"));
00142     addMessage("HTML_ALIGN_MEMBERS", i18n("Align members"));
00143     addMessage("GENERATE_HTMLHELP", i18n("Generate HTML-help"));
00144     addMessage("CHM_FILE", i18n("CHM file"));
00145     addMessage("HHC_LOCATION", i18n("HHC location"));
00146     addMessage("GENERATE_CHI", i18n("Generate .chi file"));
00147     addMessage("BINARY_TOC", i18n("Generate binary TOC"));
00148     addMessage("TOC_EXPAND", i18n("Expand TOC"));
00149     addMessage("DISABLE_INDEX", i18n("Disable index"));
00150     addMessage("ENUM_VALUES_PER_LINE", i18n("Number of enum values per line"));
00151     addMessage("GENERATE_TREEVIEW", i18n("Generate treeview"));
00152     addMessage("TREEVIEW_WIDTH", i18n("Treeview width"));
00153 
00154     //---------------------------------------------------------------------------
00155     // configuration options related to the LaTeX output
00156     //---------------------------------------------------------------------------
00157     addMessage("LaTeX", i18n("LaTeX"));
00158     addMessage("GENERATE_LATEX", i18n("Generate LaTeX"));
00159     addMessage("LATEX_OUTPUT", i18n("LaTeX output directory"));
00160     addMessage("LATEX_CMD_NAME", i18n("LaTeX command name"));
00161     addMessage("MAKEINDEX_CMD_NAME", i18n("MakeIndex command name"));
00162     addMessage("COMPACT_LATEX", i18n("Generate compact output"));
00163     addMessage("PAPER_TYPE", i18n("Paper type"));
00164     addMessage("EXTRA_PACKAGES", i18n("Include extra packages"));
00165     addMessage("LATEX_HEADER", i18n("LaTeX Header file"));
00166     addMessage("PDF_HYPERLINKS", i18n("Generate PDF hyperlinks"));
00167     addMessage("USE_PDFLATEX", i18n("Use pdflatex"));
00168     addMessage("LATEX_BATCHMODE", i18n("Use batch mode"));
00169     addMessage("LATEX_HIDE_INDICES", i18n("Do not include index chapters"));
00170 
00171     //---------------------------------------------------------------------------
00172     // configuration options related to the RTF output
00173     //---------------------------------------------------------------------------
00174     addMessage("RTF", i18n("RTF"));
00175     addMessage("GENERATE_RTF", i18n("Generate RTF"));
00176     addMessage("RTF_OUTPUT", i18n("RTF output directory"));
00177     addMessage("COMPACT_RTF", i18n("Generate compact output"));
00178     addMessage("RTF_HYPERLINKS", i18n("Generate hyperlinks"));
00179     addMessage("RTF_STYLESHEET_FILE", i18n("Stylesheet"));
00180     addMessage("RTF_EXTENSIONS_FILE", i18n("Extensions file"));
00181 
00182     //---------------------------------------------------------------------------
00183     // configuration options related to the man page output
00184     //---------------------------------------------------------------------------
00185     addMessage("Man", i18n("Man"));
00186     addMessage("GENERATE_MAN", i18n("Generate man pages"));
00187     addMessage("MAN_OUTPUT", i18n("Man output directory"));
00188     addMessage("MAN_EXTENSION", i18n("Man extension"));
00189     addMessage("MAN_LINKS", i18n("Generate links"));
00190 
00191     //---------------------------------------------------------------------------
00192     // configuration options related to the XML output
00193     //---------------------------------------------------------------------------
00194     addMessage("XML", i18n("XML"));
00195     addMessage("GENERATE_XML", i18n("Generate XML"));
00196     addMessage("XML_OUTPUT", i18n("XML output directory"));
00197     addMessage("XML_SCHEMA", i18n("XML schema"));
00198     addMessage("XML_DTD", i18n("XML DTD file"));
00199     addMessage("XML_PROGRAMLISTING", i18n("Dump program listings to the XML output"));
00200 
00201     //---------------------------------------------------------------------------
00202     // configuration options for the AutoGen Definitions output
00203     //---------------------------------------------------------------------------
00204     addMessage("DEF", i18n("DEF"));
00205     addMessage("GENERATE_AUTOGEN_DEF", i18n("Generate Autogen DEF"));
00206 
00207     //---------------------------------------------------------------------------
00208     // configuration options related to the Perl module output
00209     //---------------------------------------------------------------------------
00210     addMessage("PerlMod", i18n("Perl"));
00211     addMessage("GENERATE_PERLMOD", i18n("Generate Perl module"));
00212     addMessage("PERLMOD_LATEX", i18n("Generate PDF and DVI using LaTeX"));
00213     addMessage("PERLMOD_PRETTY", i18n("Make the Perl module output human readable"));
00214     addMessage("PERLMOD_MAKEVAR_PREFIX", i18n("Perl module variable prefix in the makefiles"));
00215 
00216     //---------------------------------------------------------------------------
00217     // Configuration options related to the preprocessor
00218     //---------------------------------------------------------------------------
00219     addMessage("Preprocessor", i18n("Preprocessor"));
00220     addMessage("ENABLE_PREPROCESSING", i18n("Enable preprocessing"));
00221     addMessage("MACRO_EXPANSION", i18n("Expand macros"));
00222     addMessage("EXPAND_ONLY_PREDEF", i18n("Expand only predefined macros"));
00223     addMessage("SEARCH_INCLUDES", i18n("Search for includes"));
00224     addMessage("INCLUDE_PATH", i18n("Include path"));
00225     addMessage("INCLUDE_FILE_PATTERNS", i18n("Include file patterns"));
00226     addMessage("PREDEFINED", i18n("Predefined macros"));
00227     addMessage("EXPAND_AS_DEFINED", i18n("Expand as defined"));
00228     addMessage("SKIP_FUNCTION_MACROS", i18n("Skip function macros"));
00229 
00230     //---------------------------------------------------------------------------
00231     // Configuration::addtions related to external references
00232     //---------------------------------------------------------------------------
00233     addMessage("External", i18n("External"));
00234     addMessage("TAGFILES", i18n("Tagfiles"));
00235     addMessage("GENERATE_TAGFILE", i18n("Generate tagfile"));
00236     addMessage("ALLEXTERNALS", i18n("List all externals"));
00237     addMessage("EXTERNAL_GROUPS", i18n("External groups"));
00238     addMessage("PERL_PATH", i18n("Path to Perl"));
00239 
00240     //---------------------------------------------------------------------------
00241     // Configuration options related to the dot tool
00242     //---------------------------------------------------------------------------
00243     addMessage("Dot", i18n("Dot"));
00244     addMessage("CLASS_DIAGRAMS", i18n("Generate class diagrams"));
00245     addMessage("HIDE_UNDOC_RELATIONS", i18n("Hide undocumented relations"));
00246     addMessage("HAVE_DOT", i18n("Use dot"));
00247     addMessage("CLASS_GRAPH", i18n("Generate class graphs"));
00248     addMessage("COLLABORATION_GRAPH", i18n("Generate collaboration graphs"));
00249     addMessage("UML_LOOK", i18n("Generate UML looking inheritance and colloboration diagrams"));
00250     addMessage("TEMPLATE_RELATIONS", i18n("Show relations between templates and their instances"));
00251     addMessage("INCLUDE_GRAPH", i18n("Generate include graphs"));
00252     addMessage("INCLUDED_BY_GRAPH", i18n("Generate included-by graphs"));
00253     addMessage("CALL_GRAPH", i18n("Generate a call dependency graph for every global function or class method"));
00254     addMessage("GRAPHICAL_HIERARCHY", i18n("Generate graphical hierarchy"));
00255     addMessage("DOT_IMAGE_FORMAT", i18n("Dot image format"));
00256     addMessage("DOT_PATH", i18n("Path to dot"));
00257     addMessage("DOTFILE_DIRS", i18n("Directories with extra dot files"));
00258     addMessage("MAX_DOT_GRAPH_WIDTH", i18n("Maximum graph width"));
00259     addMessage("MAX_DOT_GRAPH_HEIGHT", i18n("Maximum graph height"));
00260     addMessage("MAX_DOT_GRAPH_DEPTH", i18n("Maximum graph depth"));
00261     addMessage("GENERATE_LEGEND", i18n("Generate legend"));
00262     addMessage("DOT_CLEANUP", i18n("Remove intermediate files"));
00263     addMessage("Search", i18n("Search"));
00264 
00265     //---------------------------------------------------------------------------
00266     // Configuration::addtions related to the search engine
00267     //---------------------------------------------------------------------------
00268     addMessage("SEARCHENGINE", i18n("Search engine"));
00269     addMessage("CGI_NAME", i18n("CGI name"));
00270     addMessage("CGI_URL", i18n("CGI URL"));
00271     addMessage("DOC_URL", i18n("Documentation URL"));
00272     addMessage("DOC_ABSPATH", i18n("Absolute path to documentation"));
00273     addMessage("BIN_ABSPATH", i18n("Absolute path to doxysearch binary"));
00274     addMessage("EXT_DOC_PATHS", i18n("Paths to external documentation"));
00275 
00276     initialized = true;
00277   }
00278 
00279   if (!messages.contains(key))
00280   {
00281     kdDebug() << "Unhandled message: " << key << endl;
00282 
00283     return key;
00284   }
00285 
00286   return messages[key];
00287 }
00288 
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:03:56 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003