GH-1141 Introduce StringPtr for static initialization

Author: Naros

src/core/godot/string/string.cpp

@@ -0,0 +1,47 @@
+// This file is part of the Godot Orchestrator project.
+//
+// Copyright (c) 2023-present Crater Crash Studios LLC and its contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//		http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+#include "core/godot/string/string.h"
+
+using namespace godot;
+
+StringPtr& StringPtr::operator=(const String& p_value) {
+    if (!_data) {
+        _data = memnew(String);
+    }
+    *_data = p_value;
+    return *this;
+}
+
+StringPtr& StringPtr::operator=(const char* p_value) {
+    if (!_data) {
+        _data = memnew(String);
+    }
+    *_data = p_value;
+    return *this;
+}
+
+const String& StringPtr::get() const {
+    static String empty;
+    return _data ? *_data : empty;
+}
+
+StringPtr::~StringPtr() {
+    if (_data) {
+        memdelete(_data);
+        _data = nullptr;
+    }
+}

src/core/godot/string/string.h

@@ -0,0 +1,39 @@
+// This file is part of the Godot Orchestrator project.
+//
+// Copyright (c) 2023-present Crater Crash Studios LLC and its contributors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//		http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+#ifndef ORCHESTRATOR_CORE_GODOT_STRING_H
+#define ORCHESTRATOR_CORE_GODOT_STRING_H
+
+#include <godot_cpp/variant/string.hpp>
+
+namespace godot {
+
+    /// Provides a dynamic allocation wrapper for a String.
+    /// This is useful when placing a Godot String in static initialization in GDExtension.
+    class StringPtr {
+        String* _data = nullptr;
+
+    public:
+        StringPtr& operator=(const String& p_value);
+        StringPtr& operator=(const char* p_value);
+
+        const String& get() const;
+
+        ~StringPtr();
+    };
+
+}
+#endif // ORCHESTRATOR_CORE_GODOT_STRING_H

src/script/language.cpp

@@ -46,9 +46,9 @@ OScriptLanguage* OScriptLanguage::_singleton = nullptr;
 
 thread_local OScriptLanguage::CallLevel* OScriptLanguage::_call_stack = nullptr;
 thread_local uint32_t OScriptLanguage::_call_stack_size = 0;
-thread_local String OScriptLanguage::_debug_parse_err_file = "";
+thread_local StringPtr OScriptLanguage::_debug_parse_err_file = StringPtr();
 thread_local int OScriptLanguage::_debug_parse_err_line = 0;
-thread_local String OScriptLanguage::_debug_error = "";
+thread_local StringPtr OScriptLanguage::_debug_error = StringPtr();
 
 struct OScriptDepSort {
     //must support sorting so inheritance works properly (parent must be reloaded first)
@@ -304,7 +304,7 @@ void OScriptLanguage::_remove_named_global_constant(const StringName& p_name) {
 }
 
 String OScriptLanguage::_debug_get_error() const {
-    return _debug_error;
+    return _debug_error.get();
 }
 
 int32_t OScriptLanguage::_debug_get_stack_level_count() const {
@@ -347,7 +347,7 @@ String OScriptLanguage::_debug_get_stack_level_function(int32_t p_level) const {
 String OScriptLanguage::_debug_get_stack_level_source(int32_t p_level) const {
     #if GODOT_VERSION >= 0x040300
     if (_debug_parse_err_line >= 0) {
-        return _debug_parse_err_file;
+        return _debug_parse_err_file.get();
     }
 
     ERR_FAIL_INDEX_V(p_level, _call_stack_size, {});

src/script/language.h

@@ -17,6 +17,7 @@
 #ifndef ORCHESTRATOR_SCRIPT_LANGUAGE_H
 #define ORCHESTRATOR_SCRIPT_LANGUAGE_H
 
+#include "core/godot/string/string.h"
 #include "common/version.h"
 #include "script/compiler/compiled_function.h"
 #include "script/serialization/format_defs.h"
@@ -73,8 +74,8 @@ class OScriptLanguage : public ScriptLanguageExtension {
     #endif
 
     static thread_local int _debug_parse_err_line;
-    static thread_local String _debug_parse_err_file;
-    static thread_local String _debug_error;
+    static thread_local StringPtr _debug_parse_err_file;
+    static thread_local StringPtr _debug_error;
     static thread_local CallLevel* _call_stack;
     static thread_local uint32_t _call_stack_size;
     uint32_t _debug_max_call_stack = 0;