- scripting: Add system for registring typetags from plugins, rebind LibFinder

> There is new call in ScriptingManager which makes it possible to register
  dynamic typetags if you have classes you have to bind and unbind to
  squirrel. Ideally this is done at plugin attach/release and it should be
  a rare thing. If the class is re-registered all old instances would be
  different class, but this is still really bad if it happens.
> Register the lib finder class LibFinder.
> Change the Wiz class to have a dynamic typetag and to be almost properly
  unregistered (if there are alive instances of this class and they are
  used after the class is unregistered there would be crashes).
> Make the UI class/namespace to be private, so other binding code doesn't
  have access to it.

git-svn-id: https://svn.code.sf.net/p/codeblocks/code/trunk@12415 2a5c6006-c6dd-42ca-98ab-0921f2732cef

Author: fuscated

src/include/scripting/bindings/sc_typeinfo_all.h

@@ -38,6 +38,7 @@ namespace ScriptBindings
 
 enum class TypeTag : uint32_t
 {
+    Unassigned = 0,
     wxString = 0x8000,
     wxColour,
     wxPoint,
@@ -66,11 +67,10 @@ enum class TypeTag : uint32_t
     ProjectFile,
     ProjectManager,
     ScriptingManager,
-    UserVariableManager
-};
+    UserVariableManager,
 
-// Dummy type
-struct IONamespace{};
+    Last
+};
 
 template<>
 struct TypeInfo<wxString> {
@@ -177,13 +177,6 @@ struct TypeInfo<FileTreeData> {
     using baseClass = void;
 };
 
-template<>
-struct TypeInfo<IONamespace> {
-    static const uint32_t typetag = uint32_t(TypeTag::IONamespace);
-    static constexpr const SQChar *className = _SC("IO");
-    using baseClass = void;
-};
-
 template<>
 struct TypeInfo<PluginInfo> {
     static const uint32_t typetag = uint32_t(TypeTag::PluginInfo);

src/include/scripting/bindings/sc_utils.h

@@ -121,7 +121,7 @@ UserDataForType<UserType>* SetupUserPointer(HSQUIRRELVM vm, SQInteger idx)
 {
     SQUserPointer ptr = nullptr;
     if (SQ_FAILED(sq_getinstanceup(vm, idx, &ptr,
-                                   SQUserPointer(TypeInfo<UserType>::typetag))))
+                                   SQUserPointer(uint64_t(TypeInfo<UserType>::typetag)))))
     {
         sq_throwerror(vm, _SC("SetupUserPointer: Invalid type tag!"));
         cbAssert(false);
@@ -599,7 +599,7 @@ inline SQInteger CreateClassDecl(HSQUIRRELVM v, const SQChar *className,
     }
 
     sq_newclass(v, ((baseClassName != nullptr) ? SQTrue : SQFalse));
-    sq_settypetag(v, -1, SQUserPointer(TypeInfo<UserType>::typetag));
+    sq_settypetag(v, -1, SQUserPointer(uint64_t(TypeInfo<UserType>::typetag)));
     // Add some memory to the class. We over-allocate in cases where we store only a pointer.
     sq_setclassudsize(v, -1, sizeof(UserDataForType<UserType>));
 

src/include/scriptingmanager.h

@@ -214,6 +214,11 @@ class DLLIMPORT ScriptingManager : public Mgr<ScriptingManager>
           */
         const TrustedScripts& GetTrustedScripts();
 
+        /// Return a type tag which can be used to register a class to squirrel.
+        /// This is not infinite resource, so you have to call this rarely.
+        /// Use TypeTag::Unassigned if you want to reset your type tag.
+        uint32_t RequestClassTypeTag();
+
         ScriptingManager(const ScriptingManager& rhs) = delete;
         ScriptingManager& operator=(const ScriptingManager& rhs) = delete;
 

src/plugins/contrib/lib_finder/lib_finder.cpp

@@ -38,8 +38,9 @@
 #include <projectloader_hooks.h>
 #include <compiler.h>
 #include <compilerfactory.h>
-#include <sqplus.h>
-#include <sc_base_types.h>
+#include <sc_utils.h>
+#include <sc_typeinfo_all.h>
+#include <scriptingmanager.h>
 #include <logmanager.h>
 
 #include "resultmap.h"
@@ -55,11 +56,6 @@ namespace
     // Register the plugin
     PluginRegistrant<lib_finder> reg(_T("lib_finder"));
 
-    // Some class required for scripting
-    class LibFinder
-    {
-    };
-
     static const bool ExtraEventPresent = true;
 };
 
@@ -384,27 +380,105 @@ bool lib_finder::TryAddLibrary(CompileTargetBase* Target,LibraryResult* Result)
     return true;
 }
 
+namespace ScriptBindings
+{
+
+// Dummy type
+struct LibFinder{};
+
+template<>
+struct TypeInfo<LibFinder> {
+    static uint32_t typetag;
+    static constexpr const SQChar *className = _SC("LibFinder");
+    using baseClass = void;
+};
+
+uint32_t TypeInfo<LibFinder>::typetag = uint32_t(TypeTag::Unassigned);
+
+template<bool (*func)(const wxString &, cbProject *, const wxString &)>
+SQInteger LibFinder_LibraryToProject(HSQUIRRELVM v)
+{
+    // env table, LibName, Project, TargetName
+    ExtractParams4<SkipParam, const wxString *, cbProject *, const wxString *> extractor(v);
+    if (!extractor.Process("LibFinder::LibraryToProject"))
+        return extractor.ErrorMessage();
+    const bool result = func(*extractor.p1, extractor.p2, *extractor.p3);
+    sq_pushbool(v, result);
+    return 1;
+}
+
+SQInteger LibFinder_SetupTargetManually(HSQUIRRELVM v)
+{
+    // env table, Target
+    ExtractParams2<SkipParam, CompileTargetBase *> extractor(v);
+    if (!extractor.Process("LibFinder::SetupTargetManually"))
+        return extractor.ErrorMessage();
+    const bool result = lib_finder::SetupTargetManually(extractor.p1);
+    sq_pushbool(v, result);
+    return 1;
+}
+
+SQInteger LibFinder_EnsureIsDefined(HSQUIRRELVM v)
+{
+    // env table, ShortCode
+    ExtractParams2<SkipParam, const wxString *> extractor(v);
+    if (!extractor.Process("LibFinder::EnsureIsDefined"))
+        return extractor.ErrorMessage();
+    const bool result = lib_finder::EnsureIsDefined(*extractor.p1);
+    sq_pushbool(v, result);
+    return 1;
+}
+
+} // namespace ScriptBindings
+
 void lib_finder::RegisterScripting()
 {
-    SqPlus::SQClassDef<LibFinder>("LibFinder")
-        .staticFunc(&lib_finder::AddLibraryToProject,"AddLibraryToProject")
-        .staticFunc(&lib_finder::IsLibraryInProject,"IsLibraryInProject")
-        .staticFunc(&lib_finder::RemoveLibraryFromProject,"RemoveLibraryFromProject")
-        .staticFunc(&lib_finder::SetupTargetManually,"SetupTarget")
-        .staticFunc(&lib_finder::EnsureIsDefined,"EnsureLibraryDefined")
-    ;
+    ScriptingManager *scriptMgr = Manager::Get()->GetScriptingManager();
+    HSQUIRRELVM v = scriptMgr->GetVM();
+    if (v)
+    {
+        using namespace ScriptBindings;
+
+        TypeInfo<LibFinder>::typetag = scriptMgr->RequestClassTypeTag();
+
+        PreserveTop preserveTop(v);
+
+        sq_pushroottable(v);
+        const SQInteger classDecl = CreateClassDecl<LibFinder>(v, _SC("LibFinder"));
+        BindStaticMethod(v, _SC("AddLibraryToProject"),
+                         LibFinder_LibraryToProject<lib_finder::AddLibraryToProject>,
+                         _SC("LibFinder::AddLibraryToProject"));
+        BindStaticMethod(v, _SC("IsLibraryInProject"),
+                         LibFinder_LibraryToProject<lib_finder::IsLibraryInProject>,
+                         _SC("LibFinder::IsLibraryInProject"));
+        BindStaticMethod(v, _SC("RemoveLibraryFromProject"),
+                         LibFinder_LibraryToProject<lib_finder::RemoveLibraryFromProject>,
+                         _SC("LibFinder::RemoveLibraryFromProject"));
+        BindStaticMethod(v, _SC("SetupTargetManually"), LibFinder_SetupTargetManually,
+                         _SC("LibFinder::SetupTargetManually"));
+        BindStaticMethod(v, _SC("EnsureIsDefined"), LibFinder_EnsureIsDefined,
+                         _SC("LibFinder::EnsureIsDefined"));
+
+        // Put the class in the root table. This must be last!
+        sq_newslot(v, classDecl, SQFalse);
+
+        sq_poptop(v); // Pop root table.
+    }
 }
 
 void lib_finder::UnregisterScripting()
 {
-    Manager::Get()->GetScriptingManager();
-    HSQUIRRELVM v = SquirrelVM::GetVMPtr();
-    if ( v )
+    HSQUIRRELVM v = Manager::Get()->GetScriptingManager()->GetVM();
+    if (v)
     {
+        using namespace ScriptBindings;
+        PreserveTop preserveTop(v);
         sq_pushroottable(v);
-        sq_pushstring(v,"LibFinder",-1);
-        sq_deleteslot(v,-2,false);
+        sq_pushstring(v, _SC("LibFinder"), -1);
+        sq_deleteslot(v, -2, false);
         sq_poptop(v);
+
+        TypeInfo<LibFinder>::typetag = uint32_t(TypeTag::Unassigned);
     }
 }
 

src/plugins/contrib/lib_finder/lib_finder.h

@@ -65,13 +65,15 @@ class lib_finder: public cbToolPlugin
         void UnregisterScripting();
         bool TryDownload(const wxString& ShortCode,const wxString& FileName);
 
+    public:
         // These functions are used in scripting bindings
 		static bool AddLibraryToProject(const wxString& LibName,cbProject* Project,const wxString& TargetName);
 		static bool RemoveLibraryFromProject(const wxString& LibName,cbProject* Project,const wxString& TargetName);
 		static bool IsLibraryInProject(const wxString& LibName,cbProject* Project,const wxString& TargetName);
 		static bool SetupTargetManually(CompileTargetBase* Target);
 		static bool EnsureIsDefined(const wxString& ShortCode);
 
+    private:
         ProjectConfiguration* GetProject(cbProject* Project);
 
         WX_DECLARE_HASH_MAP(cbProject*,ProjectConfiguration*,wxPointerHash,wxPointerEqual,ProjectMapT);

src/plugins/scriptedwizard/wiz.cpp

@@ -62,11 +62,13 @@ namespace ScriptBindings
 
 template<>
 struct TypeInfo<Wiz> {
-    // FIXME (squirrel) Add a system for this
-    static const uint32_t typetag = uint32_t(TypeTag::UserVariableManager) + 100;
+    static uint32_t typetag;
     static constexpr const SQChar *className = _SC("Wiz");
     using baseClass = void;
 };
+
+uint32_t TypeInfo<Wiz>::typetag = uint32_t(TypeTag::Unassigned);
+
 } // namespace ScriptBindings
 
 Wiz::Wiz()
@@ -98,7 +100,7 @@ void Wiz::OnAttach()
     }
 
     // read configuration
-    RegisterWizard(vm);
+    RegisterWizard();
 
     // run main wizard script
     // this registers all available wizard scripts with us
@@ -140,6 +142,28 @@ void Wiz::OnAttach()
     m_ReleaseObjOutputDir = _T("obj") + sep + _T("Release") + sep;
 }
 
+void Wiz::OnRelease(bool appShutDown)
+{
+    if (appShutDown)
+        return;
+    HSQUIRRELVM v = Manager::Get()->GetScriptingManager()->GetVM();
+    if (v)
+    {
+        using namespace ScriptBindings;
+
+        PreserveTop preserveTop(v);
+        sq_pushroottable(v);
+        sq_pushstring(v, _SC("Wizard"), -1);
+        sq_deleteslot(v, -2, false);
+
+        sq_pushstring(v, _SC("Wiz"), -1);
+        sq_deleteslot(v, -2, false);
+        sq_poptop(v);
+
+        TypeInfo<Wiz>::typetag = uint32_t(TypeTag::Unassigned);
+    }
+}
+
 int Wiz::GetCount() const
 {
     // return the number of template wizards contained in this plugin
@@ -2058,15 +2082,19 @@ SQInteger Wiz_ContainerWithChoices(HSQUIRRELVM v)
 
 } // namespace ScriptBindings
 
-void Wiz::RegisterWizard(HSQUIRRELVM v)
+void Wiz::RegisterWizard()
 {
     using namespace ScriptBindings;
 
+    ScriptingManager *scriptMgr = Manager::Get()->GetScriptingManager();
+    HSQUIRRELVM v = scriptMgr->GetVM();
+
     PreserveTop preserveTop(v);
 
     sq_pushroottable(v);
 
     {
+        TypeInfo<Wiz>::typetag = scriptMgr->RequestClassTypeTag();
         // Register Wiz
         const SQInteger classDecl = CreateClassDecl<Wiz>(v, _SC("Wiz"));
 

src/plugins/scriptedwizard/wiz.h

@@ -10,7 +10,6 @@
 #include <settings.h> // needed to use the Code::Blocks SDK
 #include <cbexception.h>
 #include <wx/bitmap.h>
-#include <squirrel.h>
 
 class wxWizard;
 class wxWizardPageSimple;
@@ -169,10 +168,11 @@ class Wiz : public cbWizardPlugin
         void AddPage(const wxString& panelName);
 
         void Finalize();
-        void RegisterWizard(HSQUIRRELVM v);
+        void RegisterWizard();
         wxString FindTemplateFile(const wxString& filename);
 	protected:
         void OnAttach() override;
+        void OnRelease(bool appShutDown) override;
         void Clear();
         void CopyFiles(cbProject* theproject, const wxString&  prjdir, const wxString& srcdir);
         wxString GenerateFile(const wxString& basePath, const wxString& filename, const wxString& contents);

src/sdk/scripting/bindings/sc_io.cpp

@@ -362,6 +362,16 @@ namespace ScriptBindings
 namespace ScriptBindings
 {
 
+// Dummy type
+struct IONamespace{};
+
+template<>
+struct TypeInfo<IONamespace> {
+    static const uint32_t typetag = uint32_t(TypeTag::IONamespace);
+    static constexpr const SQChar *className = _SC("IO");
+    using baseClass = void;
+};
+
 void Register_IO(HSQUIRRELVM v, ScriptingManager *manager)
 {
     PreserveTop preserve(v);

src/sdk/scriptingmanager.cpp

@@ -57,7 +57,8 @@ struct ScriptingManager::Data : wxEvtHandler
     Data(ScriptingManager *scriptingManager) :
         m_ScriptingManager(scriptingManager),
         m_AttachedToMainWindow(false),
-        m_MenuItemsManager(false) // not auto-clear
+        m_MenuItemsManager(false), // not auto-clear
+        m_lastTypeTag(uint32_t(ScriptBindings::TypeTag::Last))
     {}
 
     void OnScriptMenu(wxCommandEvent& event);
@@ -117,6 +118,9 @@ struct ScriptingManager::Data : wxEvtHandler
     using ConstantsMap = std::unordered_map<std::string, ConstantData>;
     ConstantsMap m_mapConstants;
 
+    uint32_t m_lastTypeTag;
+
+
     friend SQInteger ConstantsGet(HSQUIRRELVM v);
     friend SQInteger ConstantsSet(HSQUIRRELVM v);
 
@@ -718,3 +722,8 @@ void ScriptingManager::Data::OnScriptPluginMenu(wxCommandEvent& event)
 {
     ScriptBindings::ScriptPluginWrapper::OnScriptMenu(event.GetId());
 }
+
+uint32_t ScriptingManager::RequestClassTypeTag()
+{
+    return m_data->m_lastTypeTag++;
+}