DoxyBlocks.h

Go to the documentation of this file.

/**************************************************************************/
#ifndef DOXYBLOCKS_H_INCLUDED
#define DOXYBLOCKS_H_INCLUDED

#include "cbplugin.h"
#include <cbstyledtextctrl.h>
#include <tinyxml/tinyxml.h>
#include "Config.h"

enum eControlIds
{
    ID_TB_WIZARD = wxID_HIGHEST + 9000,
    ID_TB_EXTRACTPROJECT,
    ID_TB_BLOCKCOMMENT,
    ID_TB_LINECOMMENT,
    ID_TB_RUNHTML,
    ID_TB_RUNCHM,
    ID_TB_CONFIG,

    ID_MENU_DOXYBLOCKS,
    ID_MENU_DOXYWIZARD,
    ID_MENU_EXTRACTPROJECT,
    ID_MENU_BLOCKCOMMENT,
    ID_MENU_LINECOMMENT,
    ID_MENU_RUNHTML,
    ID_MENU_RUNCHM,
    ID_MENU_CONFIG,
    ID_MENU_SAVE_TEMPLATE,
    ID_MENU_LOAD_TEMPLATE
};

enum eLogStatusIds
{
    LOG_NORMAL = wxID_HIGHEST + 9050,           
    LOG_WARNING,                                                                                        
    LOG_ERROR                                                                                           
};

// Forward declarations.
class ConfigPanel;
class DoxyBlocksLogger;

class DoxyBlocks : public cbPlugin
{
    public:
        DoxyBlocks();
        virtual ~DoxyBlocks();

        virtual int Configure();

        virtual int GetConfigurationPriority() const { return 50; }

        virtual int GetConfigurationGroup() const { return cgEditor; }

        virtual cbConfigurationPanel* GetConfigurationPanel(wxWindow* parent);

        virtual cbConfigurationPanel* GetProjectConfigurationPanel(wxWindow* parent, cbProject* project);

        virtual void BuildMenu(wxMenuBar* menuBar);

        virtual void BuildModuleMenu(const ModuleType type, wxMenu* menu, const FileTreeData* data = 0);

        virtual bool BuildToolBar(wxToolBar* toolBar);
                void OnDialogueDone(ConfigPanel* pDlg);

    protected:
        virtual void OnAttach();

        virtual void OnRelease(bool appShutDown);


    private:
                bool RunDoxywizard(void);
                void BlockComment(void);
                void LineComment(void);
                // Extract docs.
                void ExtractProject();
                void WriteConfigFiles(cbProject *prj, wxString sPrjName, wxString sPrjPath, wxString sDoxygenDir, wxFileName fnDoxyfile, wxFileName fnDoxygenLog);
                int GenerateDocuments(cbProject *prj);
                void AppendToLog(const wxString& sText, int flag = LOG_NORMAL, bool bReturnFocus = true) const;
                bool IsProjectOpen() const;
                wxString GetInputList(cbProject *prj, wxFileName fnDoxyfile);
                void RunHTML();
                void RunCHM();
                void RunCompiledHelp(wxString sDocPath, wxString sPrjName);
                wxString GetDocPath() const;
                wxString GetProjectName();
                // Autodoc.
                void GetBlockCommentStrings(int iBlockComment, wxString &sStartComment, wxString &sMidComment, wxString &sEndComment);
                void StartComment(cbStyledTextCtrl *control, int &iPos, int iBlockComment, wxString sStartComment, wxString sMidComment, wxString sTagBrief, wxString sIndent);
                void CommentFunction(cbStyledTextCtrl *control, int &iPos, wxString sMidComment, wxString sTagParam, wxString sTagReturn, wxString sIndent, wxString sParams, wxString sReturn,  wxString sFunction);
                void AddCommentLine(cbStyledTextCtrl *control, int &iPos, wxString sText);
                wxString ProcessReturnString(wxString sReturn, wxString sFunction);
                // Autoversioning.
                void CheckForAutoVersioning();
                wxString GetAutoVersion();
                // System events.
                void OnProjectActivate(CodeBlocksEvent& event);
                void OnEditorOpen(CodeBlocksEvent& event);
                void OnEditorClose(CodeBlocksEvent& event);
                void OnUpdateUI(wxUpdateUIEvent& event);
                void OnTextURL(wxTextUrlEvent& event);
                // Configuration.
                void LoadSettings();
                void SaveSettings();
                wxString ValidateRelativePath(wxString path);
                void ReadPrefsTemplate();
                void WritePrefsTemplate();

                wxToolBar                                               *m_pToolbar;                                    
                DoxyBlocksLogger                *m_DoxyBlocksLog;               
                int                                                             m_LogPageIndex;                 
                bool                                                            m_bAutoVersioning;              
                wxString                                                m_sAutoVersion;                 
                wxString                                                m_sVersionHeader;               
                DoxyBlocksConfig                *m_pConfig;                                             

        DECLARE_EVENT_TABLE();
};


//##########################################################################
//                                                                      Main page for doxygen docs.
//##########################################################################

#endif // DOXYBLOCKS_H_INCLUDED