00001 /**************************************************************************/ 00023 #ifndef CONFIG_H 00024 #define CONFIG_H 00025 00026 #include <wx/string.h> 00027 00030 class DoxyBlocksConfig 00031 { 00032 public: 00034 DoxyBlocksConfig(); 00035 00036 // Setters and getters. 00037 // Comments. 00041 wxInt8 GetBlockComment() const { return m_iBlockComment; } 00042 00046 void SetBlockComment(wxInt8 val) { m_iBlockComment = val; } 00047 00051 wxInt8 GetLineComment() const { return m_iLineComment; } 00052 00056 void SetLineComment(wxInt8 val) { m_iLineComment = val; } 00057 00058 // == Doxyfile defaults. == 00059 // Project. 00063 wxString GetProjectNumber() const { return m_sProjectNumber; } 00064 00068 void SetProjectNumber(const wxString& val) { m_sProjectNumber = val; } 00069 00073 wxString GetOutputDirectory() const { return m_sOutputDirectory; } 00074 00078 void SetOutputDirectory(const wxString& val) { m_sOutputDirectory = val; } 00079 00083 wxString GetOutputLanguage() const { return m_sOutputLanguage; } 00084 00088 void SetOutputLanguage(const wxString& val) { m_sOutputLanguage = val; } 00089 00093 bool GetUseAutoVersion() const { return m_bUseAutoVersion; } 00094 00098 void SetUseAutoVersion(bool val) { m_bUseAutoVersion = val; } 00099 00100 // Build. 00104 bool GetExtractAll() const { return m_bExtractAll; } 00105 00109 void SetExtractAll(bool val) { m_bExtractAll = val; } 00110 00114 bool GetExtractPrivate() const { return m_bExtractPrivate; } 00115 00119 void SetExtractPrivate(bool val) { m_bExtractPrivate = val; } 00120 00124 bool GetExtractStatic() const { return m_bExtractStatic; } 00125 00129 void SetExtractStatic(bool val) { m_bExtractStatic = val; } 00130 00131 // Warnings. 00135 bool GetWarnings() const { return m_bWarnings; } 00136 00140 void SetWarnings(bool val) { m_bWarnings = val; } 00141 00145 bool GetWarnIfDocError() const { return m_bWarnIfDocError; } 00146 00150 void SetWarnIfDocError(bool val) { m_bWarnIfDocError = val; } 00151 00155 bool GetWarnIfUndocumented() const { return m_bWarnIfUndocumented; } 00156 00160 void SetWarnIfUndocumented(bool val) { m_bWarnIfUndocumented = val; } 00161 00165 bool GetWarnNoParamdoc() const { return m_bWarnNoParamdoc; } 00166 00170 void SetWarnNoParamdoc(bool val) { m_bWarnNoParamdoc = val; } 00171 00172 // Alphabetical Class Index. 00176 bool GetAlphabeticalIndex() const { return m_bAlphabeticalIndex; } 00177 00181 void SetAlphabeticalIndex(bool val) { m_bAlphabeticalIndex = val; } 00182 00183 // Output. 00187 bool GetGenerateHTML() const { return m_bGenerateHTML; } 00188 00192 void SetGenerateHTML(bool val) { m_bGenerateHTML = val; } 00193 00197 bool GetGenerateHTMLHelp() const { return m_bGenerateHTMLHelp; } 00198 00202 void SetGenerateHTMLHelp(bool val) { m_bGenerateHTMLHelp = val; } 00203 00207 bool GetGenerateCHI() const { return m_bGenerateCHI; } 00208 00212 void SetGenerateCHI(bool val) { m_bGenerateCHI = val; } 00213 00217 bool GetBinaryTOC() const { return m_bBinaryTOC; } 00218 00222 void SetBinaryTOC(bool val) { m_bBinaryTOC = val; } 00223 00227 bool GetGenerateLatex() const { return m_bGenerateLatex; } 00228 00232 void SetGenerateLatex(bool val) { m_bGenerateLatex = val; } 00233 00237 bool GetGenerateRTF() const { return m_bGenerateRTF; } 00238 00242 void SetGenerateRTF(bool val) { m_bGenerateRTF = val; } 00243 00247 bool GetGenerateMan() const { return m_bGenerateMan; } 00248 00252 void SetGenerateMan(bool val) { m_bGenerateMan = val; } 00253 00257 bool GetGenerateXML() const { return m_bGenerateXML; } 00258 00262 void SetGenerateXML(bool val) { m_bGenerateXML = val; } 00263 00267 bool GetGenerateAutogenDef() const { return m_bGenerateAutogenDef; } 00268 00272 void SetGenerateAutogenDef(bool val) { m_bGenerateAutogenDef = val; } 00273 00277 bool GetGeneratePerlMod() const { return m_bGeneratePerlMod; } 00278 00282 void SetGeneratePerlMod(bool val) { m_bGeneratePerlMod = val; } 00283 00284 // Pre-processor. 00288 bool GetEnablePreprocessing() const { return m_bEnablePreprocessing; } 00289 00293 void SetEnablePreprocessing(bool val) { m_bEnablePreprocessing = val; } 00294 00295 // Dot. 00299 bool GetClassDiagrams() const { return m_bClassDiagrams; } 00300 00304 void SetClassDiagrams(bool val) { m_bClassDiagrams = val; } 00305 00309 bool GetHaveDot() const { return m_bHaveDot; } 00310 00314 void SetHaveDot(bool val) { m_bHaveDot = val; } 00315 00316 // Paths. 00320 wxString GetPathDoxygen() const { return m_sPathDoxygen; } 00321 00325 void SetPathDoxygen(const wxString& val) { m_sPathDoxygen = val; } 00326 00330 wxString GetPathDoxywizard() const { return m_sPathDoxywizard; } 00331 00335 void SetPathDoxywizard(const wxString& val) { m_sPathDoxywizard = val; } 00336 00340 wxString GetPathHHC() const { return m_sPathHHC; } 00341 00345 void SetPathHHC(const wxString& val) { m_sPathHHC = val; } 00346 00350 wxString GetPathDot() const { return m_sPathDot; } 00351 00355 void SetPathDot(const wxString& val) { m_sPathDot = val; } 00356 00360 wxString GetPathCHMViewer() const { return m_sPathCHMViewer; } 00361 00365 void SetPathCHMViewer(const wxString& val) { m_sPathCHMViewer = val; } 00366 00367 // General Options 00371 bool GetOverwriteDoxyfile() const { return m_bOverwriteDoxyfile; } 00372 00376 void SetOverwriteDoxyfile(bool val) { m_bOverwriteDoxyfile = val; } 00377 00381 bool GetPromptBeforeOverwriting() const { return m_bPromptBeforeOverwriting; } 00382 00386 void SetPromptBeforeOverwriting(bool val) { m_bPromptBeforeOverwriting = val; } 00387 00391 bool GetUseAtInTags() const { return m_bUseAtInTags; } 00392 00396 void SetUseAtInTags(bool val) { m_bUseAtInTags = val; } 00397 00401 bool GetUseInternalViewer() const { return m_bUseInternalViewer; } 00402 00406 void SetLoadTemplate(bool val) { m_bLoadTemplate = val; } 00407 00411 bool GetLoadTemplate() const { return m_bLoadTemplate; } 00412 00416 void SetUseInternalViewer(bool val) { m_bUseInternalViewer = val; } 00417 00421 bool GetRunHTML() const { return m_bRunHTML; } 00422 00426 void SetRunHTML(bool val) { m_bRunHTML = val; } 00427 00431 bool GetRunCHM() const { return m_bRunCHM; } 00432 00436 void SetRunCHM(bool val) { m_bRunCHM = val; } 00437 00438 // Config. template. 00439 bool ReadPrefsTemplate(); 00440 bool WritePrefsTemplate(); 00441 00442 private: 00443 // Comment style. 00444 wxInt8 m_iBlockComment; 00445 wxInt8 m_iLineComment; 00446 // Doxyfile defaults. 00447 wxString m_sProjectNumber; 00448 wxString m_sOutputDirectory; 00449 wxString m_sOutputLanguage; 00450 bool m_bUseAutoVersion; 00451 bool m_bExtractAll; 00452 bool m_bExtractPrivate; 00453 bool m_bExtractStatic; 00454 bool m_bWarnings; 00455 bool m_bWarnIfDocError; 00456 bool m_bWarnIfUndocumented; 00457 bool m_bWarnNoParamdoc; 00458 bool m_bAlphabeticalIndex; 00459 bool m_bGenerateHTML; 00460 bool m_bGenerateHTMLHelp; 00461 bool m_bGenerateCHI; 00462 bool m_bBinaryTOC; 00463 bool m_bGenerateLatex; 00464 bool m_bGenerateRTF; 00465 bool m_bGenerateMan; 00466 bool m_bGenerateXML; 00467 bool m_bGenerateAutogenDef; 00468 bool m_bGeneratePerlMod; 00469 bool m_bEnablePreprocessing; 00470 bool m_bClassDiagrams; 00471 bool m_bHaveDot; 00472 // General. 00473 wxString m_sPathDoxygen; 00474 wxString m_sPathDoxywizard; 00475 wxString m_sPathHHC; 00476 wxString m_sPathDot; 00477 wxString m_sPathCHMViewer; 00478 bool m_bOverwriteDoxyfile; 00479 bool m_bPromptBeforeOverwriting; 00480 bool m_bUseAtInTags; 00481 bool m_bLoadTemplate; 00482 bool m_bUseInternalViewer; 00483 bool m_bRunHTML; 00484 bool m_bRunCHM; 00485 00486 // Config. defaults. 00487 //------------------------- 00488 // Comment style. 00492 int GetDefaultBlockComment() const { return 0; } 00493 00497 int GetDefaultLineComment() const { return 0; } 00498 00499 // Doxyfile defaults. 00503 wxString GetDefaultProjectNumber() const { return wxEmptyString; } 00504 00508 bool GetDefaultUseAutoVersion() const { return false; } 00509 00513 wxString GetDefaultOutputDirectory() const { return wxEmptyString; } 00514 00518 wxString GetDefaultOutputLanguage() const { return wxT("English"); } 00519 00523 bool GetDefaultExtractAll() const { return false; } 00524 00528 bool GetDefaultExtractPrivate() const { return false; } 00529 00533 bool GetDefaultExtractStatic() const { return false; } 00534 00538 bool GetDefaultWarnings() const { return true; } 00539 00543 bool GetDefaultWarnIfDocError() const { return true; } 00544 00548 bool GetDefaultWarnIfUndocumented() const { return false; } 00549 00553 bool GetDefaultWarnNoParamdoc() const { return true; } 00554 00558 bool GetDefaultAlphabeticalIndex() const { return true; } 00559 00563 bool GetDefaultGenerateHTML() const { return true; } 00564 00568 bool GetDefaultGenerateHTMLHelp() const { return false; } 00569 00573 bool GetDefaultGenerateCHI() const { return false; } 00574 00578 bool GetDefaultBinaryTOC() const { return false; } 00579 00583 bool GetDefaultGenerateLatex() const { return false; } 00584 00588 bool GetDefaultGenerateRTF() const { return false; } 00589 00593 bool GetDefaultGenerateMan() const { return false; } 00594 00598 bool GetDefaultGenerateXML() const { return false; } 00599 00603 bool GetDefaultGenerateAutogenDef() const { return false; } 00604 00608 bool GetDefaultGeneratePerlMod() const { return false; } 00609 00613 bool GetDefaultEnablePreprocessing() const { return true; } 00614 00618 bool GetDefaultClassDiagrams() const { return false; } 00619 00623 bool GetDefaultHaveDot() const { return false; } 00624 00625 // General. 00629 wxString GetDefaultPathDoxygen() const { return wxEmptyString; } 00630 00634 wxString GetDefaultPathDoxywizard() const { return wxEmptyString; } 00635 00639 wxString GetDefaultPathHHC() const { return wxEmptyString; } 00640 00644 wxString GetDefaultPathDot() const { return wxEmptyString; } 00645 00649 wxString GetDefaultPathCHMViewer() const { return wxEmptyString; } 00650 00654 bool GetDefaultOverwriteDoxyfile() const { return false; } 00655 00659 bool GetDefaultPromptBeforeOverwriting() const { return false; } 00660 00664 bool GetDefaultUseAtInTags() const { return false; } 00665 00669 bool GetDefaultLoadTemplate() const { return false; } 00670 00674 bool GetDefaultUseInternalViewer() const { return false; } 00675 00679 bool GetDefaultRunHTML() const { return false; } 00680 00684 bool GetDefaultRunCHM() const { return false; } 00685 public: 00686 // Config. template. 00687 wxString GetCBConfigDir(); 00688 00689 }; 00690 00691 #endif // CONFIG_H
1.7.1