1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
#pragma once
#if defined(WITH_ANGELSCRIPT) || defined(DOXYGEN_GENERATING_OUTPUT)
#include "../../Main.h"
#include "../../nCine/Base/HashMap.h"
#include <angelscript.h>
#include <Containers/SmallVector.h>
#include <Containers/String.h>
#include <Containers/StringView.h>
using namespace Death::Containers;
using namespace Death::Containers::Literals;
using namespace nCine;
namespace Jazz2::Scripting
{
class CScriptArray;
/** @brief Script context type */
enum class ScriptContextType {
/** @brief Unknown/unsupported script part */
Unknown,
/** @brief Already included script part */
AlreadyIncluded,
/** @brief Legacy (JJ2+ compatible) script part */
Legacy,
/** @brief Standard (Jazz² Resurrection compatible) script part */
Standard
};
/** @brief Result of @ref ScriptLoader::Build() */
enum class ScriptBuildResult {
/** @brief The engine succeeded */
Success = asSUCCESS,
/** @brief The engine configuration is invalid */
InvalidConfiguration = asINVALID_CONFIGURATION,
/** @brief The script failed to build */
BuildFailed = asERROR,
/** @brief Another thread is currently building */
BuildInProgress = asBUILD_IN_PROGRESS,
/** @brief It was not possible to initialize at least one of the global variables */
InitGlobalVarsFailed = asINIT_GLOBAL_VARS_FAILED,
/** @brief Compiler support is disabled in the engine */
NotSupported = asNOT_SUPPORTED,
/** @brief The code in the module is still being used and and cannot be removed */
ModuleIsInUse = asMODULE_IS_IN_USE
};
/**
@brief Generic **AngelScript** script loader with `#include` and `#pragma` directive support
@experimental
*/
class ScriptLoader
{
public:
/** @brief Returns @ref ScriptLoader instance from active **AngelScript** context if exists */
template<typename T = ScriptLoader, class = typename std::enable_if<std::is_base_of<ScriptLoader, T>::value>::type>
static T* FromActiveContext() {
auto* ctx = asGetActiveContext();
DEATH_ASSERT(ctx != nullptr, "Active context is not set", nullptr);
return static_cast<T*>(ctx->GetEngine()->GetUserData(EngineToOwner));
}
ScriptLoader();
virtual ~ScriptLoader();
/** @brief Returns **AngelScript** engine */
asIScriptEngine* GetEngine() const {
return _engine;
}
/** @brief Returns **AngelScript** main module */
asIScriptModule* GetMainModule() const {
return _module;
}
/** @brief Returns context type */
ScriptContextType GetContextType() const {
return _scriptContextType;
}
protected:
/** @brief Adds a script path from file to the main module */
ScriptContextType AddScriptFromFile(StringView path, const HashMap<String, bool>& definedSymbols);
/** @brief Builds the main module and extracts metadata */
ScriptBuildResult Build();
/** @brief Sets context type */
void SetContextType(ScriptContextType value);
/** @brief Returns metadata for specified type */
ArrayView<String> GetMetadataForType(std::int32_t typeId);
/** @brief Returns metadata for specified function */
ArrayView<String> GetMetadataForFunction(asIScriptFunction* func);
/** @brief Returns metadata for specified variable */
ArrayView<String> GetMetadataForVariable(std::int32_t varIdx);
/** @brief Returns metadata for specified property */
ArrayView<String> GetMetadataForTypeProperty(std::int32_t typeId, std::int32_t varIdx);
/** @brief Returns metadata for specified method */
ArrayView<String> GetMetadataForTypeMethod(std::int32_t typeId, asIScriptFunction* method);
/** @brief Called when `#include` directive is encountered in a script file */
virtual String OnProcessInclude(StringView includePath, StringView scriptPath) = 0;
/** @brief Called when `#pragma` directive is encountered in a script file */
virtual void OnProcessPragma(StringView content, ScriptContextType& contextType) = 0;
/** @brief Creates a relative path */
static String MakeRelativePath(StringView path, StringView relativeToFile);
private:
enum class MetadataType {
Unknown,
Type,
Function,
Variable,
VirtualProperty,
FunctionOrVariable
};
#ifndef DOXYGEN_GENERATING_OUTPUT
// Doxygen 1.12.0 outputs also private structs/unions even if it shouldn't
struct RawMetadataDeclaration {
RawMetadataDeclaration(SmallVectorImpl<String>&& m, String n, String d, MetadataType t, String c, String ns)
: Metadata(std::move(m)), Name(std::move(n)), Declaration(std::move(d)),
Type(t), ParentClass(std::move(c)), Namespace(std::move(ns)) {}
SmallVector<String, 0> Metadata;
String Name;
String Declaration;
MetadataType Type;
String ParentClass;
String Namespace;
};
struct ClassMetadata {
HashMap<std::int32_t, Array<String>> FuncMetadataMap;
HashMap<std::int32_t, Array<String>> VarMetadataMap;
};
#endif
static constexpr asPWORD EngineToOwner = 0;
asIScriptEngine* _engine;
asIScriptModule* _module;
ScriptContextType _scriptContextType;
SmallVector<asIScriptContext*, 4> _contextPool;
HashMap<String, bool> _includedFiles;
SmallVector<RawMetadataDeclaration, 0> _foundDeclarations;
HashMap<std::int32_t, Array<String>> _typeMetadataMap;
HashMap<std::int32_t, Array<String>> _funcMetadataMap;
HashMap<std::int32_t, Array<String>> _varMetadataMap;
HashMap<std::int32_t, ClassMetadata> _classMetadataMap;
std::int32_t ExcludeCode(String& scriptContent, std::int32_t pos);
std::int32_t SkipStatement(String& scriptContent, std::int32_t pos);
std::int32_t ExtractMetadata(MutableStringView scriptContent, std::int32_t pos, SmallVectorImpl<String>& metadata);
std::int32_t ExtractDeclaration(StringView scriptContent, std::int32_t pos, String& name, String& declaration, MetadataType& type);
static asIScriptContext* RequestContextCallback(asIScriptEngine* engine, void* param);
static void ReturnContextCallback(asIScriptEngine* engine, asIScriptContext* ctx, void* param);
void Message(const asSMessageInfo& msg);
};
}
#endif
|
