scriptingmanager.h

Go to the documentation of this file.

/*
 * This file is part of the Code::Blocks IDE and licensed under the GNU Lesser General Public License, version 3
 * http://www.gnu.org/licenses/lgpl-3.0.html
 */

#ifndef SCRIPTING_H
#define SCRIPTING_H

#include <map>
#include <set>

#ifndef CB_PRECOMP
    #include "cbexception.h" // cbThrow
    #include "globals.h" // cbC2U
#endif

#include "settings.h"
#include "manager.h"
#include "menuitemsmanager.h"
#include <wx/intl.h>

struct SquirrelError;

class DLLIMPORT ScriptingManager : public Mgr<ScriptingManager>, public wxEvtHandler
{
        friend class Mgr<ScriptingManager>;
        wxCriticalSection cs;
    public:
        struct TrustedScriptProps
        {
            bool permanent; // store trust in config (permanent trust)
            wxUint32 crc; // script's contents crc32
        };

        // script filename -> props
        typedef std::map<wxString, TrustedScriptProps> TrustedScripts;

        bool LoadScript(const wxString& filename);

        bool LoadBuffer(const wxString& buffer, const wxString& debugName = _T("CommandLine"));

        wxString LoadBufferRedirectOutput(const wxString& buffer);

        wxString GetErrorString(SquirrelError* exception = nullptr, bool clearErrors = true);

        void DisplayErrors(SquirrelError* exception = nullptr, bool clearErrors = true);

        void InjectScriptOutput(const wxString& output);

        int Configure();

        bool RegisterScriptPlugin(const wxString& name, const wxArrayInt& ids);

        bool RegisterScriptMenu(const wxString& menuPath, const wxString& scriptOrFunc, bool isFunction);

        bool UnRegisterScriptMenu(const wxString& menuPath);

        bool UnRegisterAllScriptMenus();

        bool IsScriptTrusted(const wxString& script);

        bool IsCurrentlyRunningScriptTrusted();

        void TrustScript(const wxString& script, bool permanently);

        void TrustCurrentlyRunningScript(bool permanently);

        bool RemoveTrust(const wxString& script);

        void RefreshTrusts();

        const TrustedScripts& GetTrustedScripts();

        // needed for SqPlus bindings
        ScriptingManager& operator=(cb_unused const ScriptingManager& rhs) // prevent assignment operator
        {
            cbThrow(_T("Can't assign a ScriptingManager* !!!"));
            return *this;
        }
    private:
        // needed for SqPlus bindings
        ScriptingManager(cb_unused const ScriptingManager& rhs); // prevent copy construction

        void OnScriptMenu(wxCommandEvent& event);
        void OnScriptPluginMenu(wxCommandEvent& event);
        void RegisterScriptFunctions();

        ScriptingManager();
        ~ScriptingManager() override;

        TrustedScripts m_TrustedScripts;

        // container for script menus
        // script menuitem_ID -> script_filename
        struct MenuBoundScript
        {
            wxString scriptOrFunc;
            bool isFunc;
        };
        typedef std::map<int, MenuBoundScript> MenuIDToScript;
        MenuIDToScript m_MenuIDToScript;

        bool m_AttachedToMainWindow;
        wxString m_CurrentlyRunningScriptFile;

        typedef std::set<wxString> IncludeSet;
        IncludeSet m_IncludeSet;

        MenuItemsManager m_MenuItemsManager;

        DECLARE_EVENT_TABLE()
};

typedef char SQChar; // HACK, MUST match with the type as defined for the dedicated platform in squirrel.h
void PrintSquirrelToWxString(wxString& msg, const SQChar* s, va_list& vl);

#endif // SCRIPTING_H