/* AngelCode Scripting Library Copyright (c) 2003-2015 Andreas Jonsson This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. The original version of this library can be located at: http://www.angelcode.com/angelscript/ Andreas Jonsson andreas@angelcode.com */ // // as_module.cpp // // A class that holds a script module // #include "as_config.h" #include "as_module.h" #include "as_builder.h" #include "as_context.h" #include "as_texts.h" #include "as_debug.h" #include "as_restore.h" BEGIN_AS_NAMESPACE // TODO: 2.30.0: redesign: Improved method for discarding modules (faster clean-up, less abuse of garbage collector) // // I need to separate the reference counter for internal references and outside references: // // - Internal references are for example, when the module refers to a function or object since it is declared in the module, or when // a function refers to another function since it is being called in the code. // - Outside references are for example object instances holding a reference to the object type, or a context currently // executing a function. // // If no object instances are alive or no contexts are alive it is known that functions from a discarded module // can be called, so they can be destroyed without any need to execute the complex garbage collection routines. // // If there are live objects, the entire module should be kept for safe keeping, though no longer visible. // // TODO: It may not be necessary to keep track of internal references. Without keeping track of internal references, can I still // handle RemoveFunction and RemoveGlobalVariable correctly? // // TODO: How to avoid global variables keeping code alive? For example a script object, or a funcdef? // Can I do a quick check of the object types and functions to count number of outside references, and then do another // check over the global variables to subtract the outside references coming from these? What if the outside reference // is added by an application type in a global variable that the engine doesn't know about? Example, a global dictionary // holding object instances. Should discarding a module immediately destroy the content of the global variables? What if // a live object tries to access the global variable after it has been discarded? Throwing a script exception is acceptable? // Perhaps I need to allow the user to provide a clean-up routine that will be executed before destroying the objects. // Or I might just put that responsibility on the application. // internal asCModule::asCModule(const char *name, asCScriptEngine *engine) { this->name = name; this->engine = engine; userData = 0; builder = 0; isGlobalVarInitialized = false; accessMask = 1; defaultNamespace = engine->nameSpaces[0]; } // internal asCModule::~asCModule() { InternalReset(); // The builder is not removed by InternalReset because it holds the script // sections that will be built, so we need to explictly remove it now if it exists if( builder ) { asDELETE(builder,asCBuilder); builder = 0; } if( engine ) { // Clean the user data for( asUINT n = 0; n < userData.GetLength(); n += 2 ) { if( userData[n+1] ) { for( asUINT c = 0; c < engine->cleanModuleFuncs.GetLength(); c++ ) if( engine->cleanModuleFuncs[c].type == userData[n] ) engine->cleanModuleFuncs[c].cleanFunc(this); } } // Remove the module from the engine ACQUIREEXCLUSIVE(engine->engineRWLock); // The module must have been discarded before it is deleted asASSERT( !engine->scriptModules.Exists(this) ); engine->discardedModules.RemoveValue(this); RELEASEEXCLUSIVE(engine->engineRWLock); } } // interface void asCModule::Discard() { // Reset the global variables already so that no object in the global variables keep the module alive forever. // If any live object tries to access the global variables during clean up they will fail with a script exception, // so the application must keep that in mind before discarding a module. CallExit(); // Keep a local copy of the engine pointer, because once the module is moved do the discarded // pile, it is possible that another thread might discard it while we are still in here. So no // further access to members may be done after that asCScriptEngine *lEngine = engine; // Instead of deleting the module immediately, move it to the discarded pile // This will turn it invisible to the application, yet keep it alive until all // external references to its entities have been released. ACQUIREEXCLUSIVE(engine->engineRWLock); if( lEngine->lastModule == this ) lEngine->lastModule = 0; lEngine->scriptModules.RemoveValue(this); lEngine->discardedModules.PushLast(this); RELEASEEXCLUSIVE(lEngine->engineRWLock); // Allow the engine to go over the list of discarded modules to see what can be cleaned up at this moment. // Don't do this if the engine is already shutting down, as it will be done explicitly by the engine itself with error reporting if( !lEngine->shuttingDown ) { if( lEngine->ep.autoGarbageCollect ) lEngine->GarbageCollect(); else { // GarbageCollect calls DeleteDiscardedModules, so no need // to call it again if we already called GarbageCollect lEngine->DeleteDiscardedModules(); } } } // interface void *asCModule::SetUserData(void *data, asPWORD type) { // As a thread might add a new new user data at the same time as another // it is necessary to protect both read and write access to the userData member ACQUIREEXCLUSIVE(engine->engineRWLock); // It is not intended to store a lot of different types of userdata, // so a more complex structure like a associative map would just have // more overhead than a simple array. for( asUINT n = 0; n < userData.GetLength(); n += 2 ) { if( userData[n] == type ) { void *oldData = reinterpret_cast(userData[n+1]); userData[n+1] = reinterpret_cast(data); RELEASEEXCLUSIVE(engine->engineRWLock); return oldData; } } userData.PushLast(type); userData.PushLast(reinterpret_cast(data)); RELEASEEXCLUSIVE(engine->engineRWLock); return 0; } // interface void *asCModule::GetUserData(asPWORD type) const { // There may be multiple threads reading, but when // setting the user data nobody must be reading. ACQUIRESHARED(engine->engineRWLock); for( asUINT n = 0; n < userData.GetLength(); n += 2 ) { if( userData[n] == type ) { void *ud = reinterpret_cast(userData[n+1]); RELEASESHARED(engine->engineRWLock); return ud; } } RELEASESHARED(engine->engineRWLock); return 0; } // interface asIScriptEngine *asCModule::GetEngine() const { return engine; } // interface void asCModule::SetName(const char *name) { this->name = name; } // interface const char *asCModule::GetName() const { return name.AddressOf(); } // interface const char *asCModule::GetDefaultNamespace() const { return defaultNamespace->name.AddressOf(); } // interface int asCModule::SetDefaultNamespace(const char *nameSpace) { // TODO: cleanup: This function is similar to asCScriptEngine::SetDefaultNamespace. Can we reuse the code? if( nameSpace == 0 ) return asINVALID_ARG; asCString ns = nameSpace; if( ns != "" ) { // Make sure the namespace is composed of alternating identifier and :: size_t pos = 0; bool expectIdentifier = true; size_t len; eTokenType t = ttIdentifier; for( ; pos < ns.GetLength(); pos += len ) { t = engine->tok.GetToken(ns.AddressOf() + pos, ns.GetLength() - pos, &len); if( (expectIdentifier && t != ttIdentifier) || (!expectIdentifier && t != ttScope) ) return asINVALID_DECLARATION; expectIdentifier = !expectIdentifier; } // If the namespace ends with :: then strip it off if( t == ttScope ) ns.SetLength(ns.GetLength()-2); } defaultNamespace = engine->AddNameSpace(ns.AddressOf()); return 0; } // interface int asCModule::AddScriptSection(const char *name, const char *code, size_t codeLength, int lineOffset) { #ifdef AS_NO_COMPILER UNUSED_VAR(name); UNUSED_VAR(code); UNUSED_VAR(codeLength); UNUSED_VAR(lineOffset); return asNOT_SUPPORTED; #else if( !builder ) { builder = asNEW(asCBuilder)(engine, this); if( builder == 0 ) return asOUT_OF_MEMORY; } return builder->AddCode(name, code, (int)codeLength, lineOffset, (int)engine->GetScriptSectionNameIndex(name ? name : ""), engine->ep.copyScriptSections); #endif } // internal void asCModule::JITCompile() { asIJITCompiler *jit = engine->GetJITCompiler(); if( !jit ) return; for (unsigned int i = 0; i < scriptFunctions.GetLength(); i++) scriptFunctions[i]->JITCompile(); } // interface int asCModule::Build() { #ifdef AS_NO_COMPILER return asNOT_SUPPORTED; #else TimeIt("asCModule::Build"); // Don't allow the module to be rebuilt if there are still // external references that will need the previous code // TODO: 2.30.0: interface: The asIScriptModule must have a method for querying if the module is used if( HasExternalReferences(false) ) { engine->WriteMessage("", 0, 0, asMSGTYPE_ERROR, TXT_MODULE_IS_IN_USE); return asMODULE_IS_IN_USE; } // Only one thread may build at one time // TODO: It should be possible to have multiple threads perform compilations int r = engine->RequestBuild(); if( r < 0 ) return r; engine->PrepareEngine(); if( engine->configFailed ) { engine->WriteMessage("", 0, 0, asMSGTYPE_ERROR, TXT_INVALID_CONFIGURATION); engine->BuildCompleted(); return asINVALID_CONFIGURATION; } InternalReset(); if( !builder ) { engine->BuildCompleted(); return asSUCCESS; } // Compile the script r = builder->Build(); asDELETE(builder,asCBuilder); builder = 0; if( r < 0 ) { // Reset module again InternalReset(); engine->BuildCompleted(); return r; } JITCompile(); engine->PrepareEngine(); #ifdef AS_DEBUG // Verify that there are no unwanted gaps in the scriptFunctions array. for( asUINT n = 1; n < engine->scriptFunctions.GetLength(); n++ ) { int id = n; if( engine->scriptFunctions[n] == 0 && !engine->freeScriptFunctionIds.Exists(id) ) asASSERT( false ); } #endif engine->BuildCompleted(); // Initialize global variables if( r >= 0 && engine->ep.initGlobalVarsAfterBuild ) r = ResetGlobalVars(0); return r; #endif } // interface int asCModule::ResetGlobalVars(asIScriptContext *ctx) { if( isGlobalVarInitialized ) CallExit(); return CallInit(ctx); } // interface asIScriptFunction *asCModule::GetFunctionByIndex(asUINT index) const { return const_cast(globalFunctions.Get(index)); } // internal int asCModule::CallInit(asIScriptContext *myCtx) { if( isGlobalVarInitialized ) return asERROR; // Each global variable needs to be cleared individually asCSymbolTableIterator it = scriptGlobals.List(); while( it ) { asCGlobalProperty *desc = *it; memset(desc->GetAddressOfValue(), 0, sizeof(asDWORD)*desc->type.GetSizeOnStackDWords()); it++; } // Call the init function for each of the global variables asIScriptContext *ctx = myCtx; int r = asEXECUTION_FINISHED; it = scriptGlobals.List(); while( it && r == asEXECUTION_FINISHED ) { asCGlobalProperty *desc = *it; it++; if( desc->GetInitFunc() ) { if( ctx == 0 ) { ctx = engine->RequestContext(); if( ctx == 0 ) break; } r = ctx->Prepare(desc->GetInitFunc()); if( r >= 0 ) { r = ctx->Execute(); if( r != asEXECUTION_FINISHED ) { asCString msg; msg.Format(TXT_FAILED_TO_INITIALIZE_s, desc->name.AddressOf()); asCScriptFunction *func = desc->GetInitFunc(); engine->WriteMessage(func->scriptData->scriptSectionIdx >= 0 ? engine->scriptSectionNames[func->scriptData->scriptSectionIdx]->AddressOf() : "", func->GetLineNumber(0, 0) & 0xFFFFF, func->GetLineNumber(0, 0) >> 20, asMSGTYPE_ERROR, msg.AddressOf()); if( r == asEXECUTION_EXCEPTION ) { const asIScriptFunction *function = ctx->GetExceptionFunction(); msg.Format(TXT_EXCEPTION_s_IN_s, ctx->GetExceptionString(), function->GetDeclaration()); engine->WriteMessage(function->GetScriptSectionName(), ctx->GetExceptionLineNumber(), 0, asMSGTYPE_INFORMATION, msg.AddressOf()); } } } } } if( ctx && !myCtx ) { engine->ReturnContext(ctx); ctx = 0; } // Even if the initialization failed we need to set the // flag that the variables have been initialized, otherwise // the module won't free those variables that really were // initialized. isGlobalVarInitialized = true; if( r != asEXECUTION_FINISHED ) return asINIT_GLOBAL_VARS_FAILED; return asSUCCESS; } // internal void asCModule::CallExit() { if( !isGlobalVarInitialized ) return; asCSymbolTableIterator it = scriptGlobals.List(); while( it ) { if( (*it)->type.IsObject() ) { void **obj = (void**)(*it)->GetAddressOfValue(); if( *obj ) { asCObjectType *ot = (*it)->type.GetObjectType(); if( ot->flags & asOBJ_REF ) { asASSERT( (ot->flags & asOBJ_NOCOUNT) || ot->beh.release ); if( ot->beh.release ) engine->CallObjectMethod(*obj, ot->beh.release); } else { if( ot->beh.destruct ) engine->CallObjectMethod(*obj, ot->beh.destruct); engine->CallFree(*obj); } // Set the address to 0 as someone might try to access the variable afterwards *obj = 0; } } it++; } isGlobalVarInitialized = false; } // internal bool asCModule::HasExternalReferences(bool shuttingDown) { // Check all entiteis in the module for any external references. // If there are any external references the module cannot be deleted yet. for( asUINT n = 0; n < scriptFunctions.GetLength(); n++ ) if( scriptFunctions[n] && scriptFunctions[n]->externalRefCount.get() ) { if( !shuttingDown ) return true; else { asCString msg; msg.Format(TXT_EXTRNL_REF_TO_MODULE_s, name.AddressOf()); engine->WriteMessage("", 0, 0, asMSGTYPE_WARNING, msg.AddressOf()); msg.Format(TXT_PREV_FUNC_IS_NAMED_s_TYPE_IS_d, scriptFunctions[n]->GetName(), scriptFunctions[n]->GetFuncType()); engine->WriteMessage("", 0, 0, asMSGTYPE_INFORMATION, msg.AddressOf()); } } for( asUINT n = 0; n < classTypes.GetLength(); n++ ) if( classTypes[n] && classTypes[n]->externalRefCount.get() ) { if( !shuttingDown ) return true; else { asCString msg; msg.Format(TXT_EXTRNL_REF_TO_MODULE_s, name.AddressOf()); engine->WriteMessage("", 0, 0, asMSGTYPE_WARNING, msg.AddressOf()); msg.Format(TXT_PREV_TYPE_IS_NAMED_s, classTypes[n]->GetName()); engine->WriteMessage("", 0, 0, asMSGTYPE_INFORMATION, msg.AddressOf()); } } for( asUINT n = 0; n < funcDefs.GetLength(); n++ ) if( funcDefs[n] && funcDefs[n]->externalRefCount.get() ) { if( !shuttingDown ) return true; else { asCString msg; msg.Format(TXT_EXTRNL_REF_TO_MODULE_s, name.AddressOf()); engine->WriteMessage("", 0, 0, asMSGTYPE_WARNING, msg.AddressOf()); msg.Format(TXT_PREV_FUNC_IS_NAMED_s_TYPE_IS_d, funcDefs[n]->GetName(), funcDefs[n]->GetFuncType()); engine->WriteMessage("", 0, 0, asMSGTYPE_INFORMATION, msg.AddressOf()); } } for( asUINT n = 0; n < templateInstances.GetLength(); n++ ) if( templateInstances[n] && templateInstances[n]->externalRefCount.get() ) { if( !shuttingDown ) return true; else { asCString msg; msg.Format(TXT_EXTRNL_REF_TO_MODULE_s, name.AddressOf()); engine->WriteMessage("", 0, 0, asMSGTYPE_WARNING, msg.AddressOf()); msg.Format(TXT_PREV_TYPE_IS_NAMED_s, templateInstances[n]->GetName()); engine->WriteMessage("", 0, 0, asMSGTYPE_INFORMATION, msg.AddressOf()); } } return false; } // internal void asCModule::InternalReset() { CallExit(); asUINT n; // Remove all global functions globalFunctions.Clear(); // Destroy the internals of the global properties here, but do not yet remove them from the // engine, because functions need the engine's varAddressMap to get to the property. If the // property is removed already, it may leak as the refCount doesn't reach 0. asCSymbolTableIterator globIt = scriptGlobals.List(); while( globIt ) { (*globIt)->DestroyInternal(); globIt++; } UnbindAllImportedFunctions(); // Free bind information for( n = 0; n < bindInformations.GetLength(); n++ ) { if( bindInformations[n] ) { bindInformations[n]->importedFunctionSignature->ReleaseInternal(); asDELETE(bindInformations[n], sBindInfo); } } bindInformations.SetLength(0); // Free declared types, including classes, typedefs, and enums for( n = 0; n < templateInstances.GetLength(); n++ ) { asCObjectType *type = templateInstances[n]; if( engine->FindNewOwnerForSharedType(type, this) != this ) { // The type is owned by another module, just release our reference type->ReleaseInternal(); continue; } // Orphan the template instance type->module = 0; // No other module is holding the template type engine->RemoveTemplateInstanceType(type); type->ReleaseInternal(); } templateInstances.SetLength(0); for( n = 0; n < classTypes.GetLength(); n++ ) { asCObjectType *type = classTypes[n]; if( type->IsShared() ) { // The type is shared, so transfer ownership to another module that also uses it if( engine->FindNewOwnerForSharedType(type, this) != this ) { // The type is owned by another module, just release our reference type->ReleaseInternal(); continue; } } // The type should be destroyed now type->DestroyInternal(); // Remove the type from the engine if( type->IsShared() ) { engine->sharedScriptTypes.RemoveValue(type); type->ReleaseInternal(); } // Release it from the module type->module = 0; type->ReleaseInternal(); } classTypes.SetLength(0); for( n = 0; n < enumTypes.GetLength(); n++ ) { asCObjectType *type = enumTypes[n]; if( type->IsShared() ) { // The type is shared, so transfer ownership to another module that also uses it if( engine->FindNewOwnerForSharedType(type, this) != this ) { // The type is owned by another module, just release our reference type->ReleaseInternal(); continue; } } // The type should be destroyed now type->DestroyInternal(); // Remove the type from the engine if( type->IsShared() ) { engine->sharedScriptTypes.RemoveValue(type); type->ReleaseInternal(); } // Release it from the module type->module = 0; type->ReleaseInternal(); } enumTypes.SetLength(0); for( n = 0; n < typeDefs.GetLength(); n++ ) { asCObjectType *type = typeDefs[n]; // The type should be destroyed now type->DestroyInternal(); // Release it from the module type->module = 0; type->ReleaseInternal(); } typeDefs.SetLength(0); // Free funcdefs for( n = 0; n < funcDefs.GetLength(); n++ ) { asCScriptFunction *func = funcDefs[n]; if( func->IsShared() ) { // The func is shared, so transfer ownership to another module that also uses it if( engine->FindNewOwnerForSharedFunc(func, this) != this ) { // The func is owned by another module, just release our reference func->ReleaseInternal(); continue; } } func->DestroyInternal(); engine->RemoveFuncdef(func); func->module = 0; func->ReleaseInternal(); } funcDefs.SetLength(0); // Then release the functions for( n = 0; n < scriptFunctions.GetLength(); n++ ) { asCScriptFunction *func = scriptFunctions[n]; if( func->IsShared() ) { // The func is shared, so transfer ownership to another module that also uses it if( engine->FindNewOwnerForSharedFunc(func, this) != this ) { // The func is owned by another module, just release our reference func->ReleaseInternal(); continue; } } func->DestroyInternal(); func->module = 0; func->ReleaseInternal(); } scriptFunctions.SetLength(0); // Now remove and release the global properties as there are no more references to them globIt = scriptGlobals.List(); while( globIt ) { engine->RemoveGlobalProperty(*globIt); asASSERT( (*globIt)->refCount.get() == 1 ); (*globIt)->Release(); globIt++; } scriptGlobals.Clear(); asASSERT( IsEmpty() ); } // interface asIScriptFunction *asCModule::GetFunctionByName(const char *name) const { asSNameSpace *ns = defaultNamespace; while( ns ) { const asCArray &idxs = globalFunctions.GetIndexes(ns, name); if( idxs.GetLength() != 1 ) return 0; const asIScriptFunction *func = globalFunctions.Get(idxs[0]); if( func ) return const_cast(func); // Recursively search parent namespaces ns = engine->GetParentNameSpace(ns); } return 0; } // interface asUINT asCModule::GetImportedFunctionCount() const { return (asUINT)bindInformations.GetLength(); } // interface int asCModule::GetImportedFunctionIndexByDecl(const char *decl) const { asCBuilder bld(engine, const_cast(this)); // Don't write parser errors to the message callback bld.silent = true; asCScriptFunction func(engine, const_cast(this), asFUNC_DUMMY); bld.ParseFunctionDeclaration(0, decl, &func, false, 0, 0, defaultNamespace); // TODO: optimize: Improve linear search // Search script functions for matching interface int id = -1; for( asUINT n = 0; n < bindInformations.GetLength(); ++n ) { if( func.name == bindInformations[n]->importedFunctionSignature->name && func.returnType == bindInformations[n]->importedFunctionSignature->returnType && func.parameterTypes.GetLength() == bindInformations[n]->importedFunctionSignature->parameterTypes.GetLength() ) { bool match = true; for( asUINT p = 0; p < func.parameterTypes.GetLength(); ++p ) { if( func.parameterTypes[p] != bindInformations[n]->importedFunctionSignature->parameterTypes[p] ) { match = false; break; } } if( match ) { if( id == -1 ) id = n; else return asMULTIPLE_FUNCTIONS; } } } if( id == -1 ) return asNO_FUNCTION; return id; } // interface asUINT asCModule::GetFunctionCount() const { return (asUINT)globalFunctions.GetSize(); } // interface asIScriptFunction *asCModule::GetFunctionByDecl(const char *decl) const { asCBuilder bld(engine, const_cast(this)); // Don't write parser errors to the message callback bld.silent = true; asCScriptFunction func(engine, const_cast(this), asFUNC_DUMMY); int r = bld.ParseFunctionDeclaration(0, decl, &func, false, 0, 0, defaultNamespace); if( r < 0 ) { // Invalid declaration // TODO: Write error to message stream return 0; } // Use the defaultNamespace implicitly unless an explicit namespace has been provided asSNameSpace *ns = func.nameSpace == engine->nameSpaces[0] ? defaultNamespace : func.nameSpace; // Search script functions for matching interface while( ns ) { asIScriptFunction *f = 0; const asCArray &idxs = globalFunctions.GetIndexes(ns, func.name); for( unsigned int n = 0; n < idxs.GetLength(); n++ ) { const asCScriptFunction *funcPtr = globalFunctions.Get(idxs[n]); if( funcPtr->objectType == 0 && func.returnType == funcPtr->returnType && func.parameterTypes.GetLength() == funcPtr->parameterTypes.GetLength() ) { bool match = true; for( asUINT p = 0; p < func.parameterTypes.GetLength(); ++p ) { if( func.parameterTypes[p] != funcPtr->parameterTypes[p] ) { match = false; break; } } if( match ) { if( f == 0 ) f = const_cast(funcPtr); else // Multiple functions return 0; } } } if( f ) return f; else { // Search for matching functions in the parent namespace ns = engine->GetParentNameSpace(ns); } } return 0; } // interface asUINT asCModule::GetGlobalVarCount() const { return (asUINT)scriptGlobals.GetSize(); } // interface int asCModule::GetGlobalVarIndexByName(const char *name) const { asSNameSpace *ns = defaultNamespace; // Find the global var id while( ns ) { int id = scriptGlobals.GetFirstIndex(ns, name); if( id >= 0 ) return id; // Recursively search parent namespaces ns = engine->GetParentNameSpace(ns); } return asNO_GLOBAL_VAR; } // interface int asCModule::RemoveGlobalVar(asUINT index) { // TODO: 2.30.0: redesign: Before removing the variable, clear it to free the object // The property shouldn't be orphaned. asCGlobalProperty *prop = scriptGlobals.Get(index); if( !prop ) return asINVALID_ARG; // Destroy the internal of the global variable (removes the initialization function) prop->DestroyInternal(); // Check if the module is the only one referring to the module, if so remove it from the engine too // If the property is not removed now, it will be removed later when the module is discarded if( prop->refCount.get() == 2 ) engine->RemoveGlobalProperty(prop); // Remove the global variable from the module prop->Release(); scriptGlobals.Erase(index); return 0; } // interface int asCModule::GetGlobalVarIndexByDecl(const char *decl) const { asCBuilder bld(engine, const_cast(this)); // Don't write parser errors to the message callback bld.silent = true; asCString name; asSNameSpace *nameSpace; asCDataType dt; int r = bld.ParseVariableDeclaration(decl, defaultNamespace, name, nameSpace, dt); if( r < 0 ) return r; // Search global variables for a match while( nameSpace ) { int id = scriptGlobals.GetFirstIndex(nameSpace, name, asCCompGlobPropType(dt)); if( id != -1 ) return id; // Recursively search parent namespace nameSpace = engine->GetParentNameSpace(nameSpace); } return asNO_GLOBAL_VAR; } // interface void *asCModule::GetAddressOfGlobalVar(asUINT index) { asCGlobalProperty *prop = scriptGlobals.Get(index); if( !prop ) return 0; // For object variables it's necessary to dereference the pointer to get the address of the value if( prop->type.IsObject() && !prop->type.IsObjectHandle() ) return *(void**)(prop->GetAddressOfValue()); return (void*)(prop->GetAddressOfValue()); } // interface const char *asCModule::GetGlobalVarDeclaration(asUINT index, bool includeNamespace) const { const asCGlobalProperty *prop = scriptGlobals.Get(index); if (!prop) return 0; asCString *tempString = &asCThreadManager::GetLocalData()->string; *tempString = prop->type.Format(defaultNamespace); *tempString += " "; if( includeNamespace && prop->nameSpace->name != "" ) *tempString += prop->nameSpace->name + "::"; *tempString += prop->name; return tempString->AddressOf(); } // interface int asCModule::GetGlobalVar(asUINT index, const char **name, const char **nameSpace, int *typeId, bool *isConst) const { const asCGlobalProperty *prop = scriptGlobals.Get(index); if (!prop) return 0; if( name ) *name = prop->name.AddressOf(); if( nameSpace ) *nameSpace = prop->nameSpace->name.AddressOf(); if( typeId ) *typeId = engine->GetTypeIdFromDataType(prop->type); if( isConst ) *isConst = prop->type.IsReadOnly(); return asSUCCESS; } // interface asUINT asCModule::GetObjectTypeCount() const { return (asUINT)classTypes.GetLength(); } // interface asIObjectType *asCModule::GetObjectTypeByIndex(asUINT index) const { if( index >= classTypes.GetLength() ) return 0; return classTypes[index]; } // interface asIObjectType *asCModule::GetObjectTypeByName(const char *name) const { asSNameSpace *ns = defaultNamespace; while( ns ) { for( asUINT n = 0; n < classTypes.GetLength(); n++ ) { if( classTypes[n] && classTypes[n]->name == name && classTypes[n]->nameSpace == ns ) return classTypes[n]; } // Recursively search parent namespace ns = engine->GetParentNameSpace(ns); } return 0; } // interface int asCModule::GetTypeIdByDecl(const char *decl) const { asCDataType dt; // This const cast is safe since we know the engine won't be modified asCBuilder bld(engine, const_cast(this)); // Don't write parser errors to the message callback bld.silent = true; int r = bld.ParseDataType(decl, &dt, defaultNamespace); if( r < 0 ) return asINVALID_TYPE; return engine->GetTypeIdFromDataType(dt); } // interface asIObjectType *asCModule::GetObjectTypeByDecl(const char *decl) const { asCDataType dt; // This const cast is safe since we know the engine won't be modified asCBuilder bld(engine, const_cast(this)); // Don't write parser errors to the message callback bld.silent = true; int r = bld.ParseDataType(decl, &dt, defaultNamespace); if( r < 0 ) return 0; return dt.GetObjectType(); } // interface asUINT asCModule::GetEnumCount() const { return (asUINT)enumTypes.GetLength(); } // interface const char *asCModule::GetEnumByIndex(asUINT index, int *enumTypeId, const char **nameSpace) const { if( index >= enumTypes.GetLength() ) return 0; if( enumTypeId ) *enumTypeId = engine->GetTypeIdFromDataType(asCDataType::CreateObject(enumTypes[index], false)); if( nameSpace ) *nameSpace = enumTypes[index]->nameSpace->name.AddressOf(); return enumTypes[index]->name.AddressOf(); } // interface int asCModule::GetEnumValueCount(int enumTypeId) const { asCDataType dt = engine->GetDataTypeFromTypeId(enumTypeId); asCObjectType *t = dt.GetObjectType(); if( t == 0 || !(t->GetFlags() & asOBJ_ENUM) ) return asINVALID_TYPE; return (int)t->enumValues.GetLength(); } // interface const char *asCModule::GetEnumValueByIndex(int enumTypeId, asUINT index, int *outValue) const { asCDataType dt = engine->GetDataTypeFromTypeId(enumTypeId); asCObjectType *t = dt.GetObjectType(); if( t == 0 || !(t->GetFlags() & asOBJ_ENUM) ) return 0; if( index >= t->enumValues.GetLength() ) return 0; if( outValue ) *outValue = t->enumValues[index]->value; return t->enumValues[index]->name.AddressOf(); } // interface asUINT asCModule::GetTypedefCount() const { return (asUINT)typeDefs.GetLength(); } // interface const char *asCModule::GetTypedefByIndex(asUINT index, int *typeId, const char **nameSpace) const { if( index >= typeDefs.GetLength() ) return 0; if( typeId ) *typeId = engine->GetTypeIdFromDataType(typeDefs[index]->templateSubTypes[0]); if( nameSpace ) *nameSpace = typeDefs[index]->nameSpace->name.AddressOf(); return typeDefs[index]->name.AddressOf(); } // internal int asCModule::GetNextImportedFunctionId() { // TODO: multithread: This will break if one thread if freeing a module, while another is being compiled if( engine->freeImportedFunctionIdxs.GetLength() ) return FUNC_IMPORTED | (asUINT)engine->freeImportedFunctionIdxs[engine->freeImportedFunctionIdxs.GetLength()-1]; return FUNC_IMPORTED | (asUINT)engine->importedFunctions.GetLength(); } #ifndef AS_NO_COMPILER // internal int asCModule::AddScriptFunction(int sectionIdx, int declaredAt, int id, const asCString &name, const asCDataType &returnType, const asCArray ¶ms, const asCArray ¶mNames, const asCArray &inOutFlags, const asCArray &defaultArgs, bool isInterface, asCObjectType *objType, bool isConstMethod, bool isGlobalFunction, bool isPrivate, bool isProtected, bool isFinal, bool isOverride, bool isShared, asSNameSpace *ns) { asASSERT(id >= 0); // Store the function information asCScriptFunction *func = asNEW(asCScriptFunction)(engine, this, isInterface ? asFUNC_INTERFACE : asFUNC_SCRIPT); if( func == 0 ) { // Free the default args for( asUINT n = 0; n < defaultArgs.GetLength(); n++ ) if( defaultArgs[n] ) asDELETE(defaultArgs[n], asCString); return asOUT_OF_MEMORY; } if( ns == 0 ) ns = engine->nameSpaces[0]; // All methods of shared objects are also shared if( objType && objType->IsShared() ) isShared = true; func->name = name; func->nameSpace = ns; func->id = id; func->returnType = returnType; if( func->funcType == asFUNC_SCRIPT ) { func->scriptData->scriptSectionIdx = sectionIdx; func->scriptData->declaredAt = declaredAt; } func->parameterTypes = params; func->parameterNames = paramNames; func->inOutFlags = inOutFlags; func->defaultArgs = defaultArgs; func->objectType = objType; if( objType ) objType->AddRefInternal(); func->isReadOnly = isConstMethod; func->isPrivate = isPrivate; func->isProtected = isProtected; func->isFinal = isFinal; func->isOverride = isOverride; func->isShared = isShared; asASSERT( params.GetLength() == inOutFlags.GetLength() && params.GetLength() == defaultArgs.GetLength() ); // Verify that we are not assigning either the final or override specifier(s) if we are registering a non-member function asASSERT( !(!objType && isFinal) ); asASSERT( !(!objType && isOverride) ); // The internal ref count was already set by the constructor scriptFunctions.PushLast(func); engine->AddScriptFunction(func); // Compute the signature id if( objType ) func->ComputeSignatureId(); // Add reference if( isGlobalFunction ) globalFunctions.Put(func); return 0; } // internal int asCModule::AddScriptFunction(asCScriptFunction *func) { scriptFunctions.PushLast(func); func->AddRefInternal(); engine->AddScriptFunction(func); return 0; } // internal int asCModule::AddImportedFunction(int id, const asCString &name, const asCDataType &returnType, const asCArray ¶ms, const asCArray &inOutFlags, const asCArray &defaultArgs, asSNameSpace *ns, const asCString &moduleName) { asASSERT(id >= 0); // Store the function information asCScriptFunction *func = asNEW(asCScriptFunction)(engine, this, asFUNC_IMPORTED); if( func == 0 ) { // Free the default args for( asUINT n = 0; n < defaultArgs.GetLength(); n++ ) if( defaultArgs[n] ) asDELETE(defaultArgs[n], asCString); return asOUT_OF_MEMORY; } func->name = name; func->id = id; func->returnType = returnType; func->nameSpace = ns; func->parameterTypes = params; func->inOutFlags = inOutFlags; func->defaultArgs = defaultArgs; func->objectType = 0; sBindInfo *info = asNEW(sBindInfo); if( info == 0 ) { asDELETE(func, asCScriptFunction); return asOUT_OF_MEMORY; } info->importedFunctionSignature = func; info->boundFunctionId = -1; info->importFromModule = moduleName; bindInformations.PushLast(info); // Add the info to the array in the engine if( engine->freeImportedFunctionIdxs.GetLength() ) engine->importedFunctions[engine->freeImportedFunctionIdxs.PopLast()] = info; else engine->importedFunctions.PushLast(info); return 0; } #endif // internal asCScriptFunction *asCModule::GetImportedFunction(int index) const { return bindInformations[index]->importedFunctionSignature; } // interface int asCModule::BindImportedFunction(asUINT index, asIScriptFunction *func) { // First unbind the old function int r = UnbindImportedFunction(index); if( r < 0 ) return r; // Must verify that the interfaces are equal asCScriptFunction *dst = GetImportedFunction(index); if( dst == 0 ) return asNO_FUNCTION; if( func == 0 ) return asINVALID_ARG; asCScriptFunction *src = engine->GetScriptFunction(func->GetId()); if( src == 0 ) return asNO_FUNCTION; // Verify return type if( dst->returnType != src->returnType ) return asINVALID_INTERFACE; if( dst->parameterTypes.GetLength() != src->parameterTypes.GetLength() ) return asINVALID_INTERFACE; for( asUINT n = 0; n < dst->parameterTypes.GetLength(); ++n ) { if( dst->parameterTypes[n] != src->parameterTypes[n] ) return asINVALID_INTERFACE; } bindInformations[index]->boundFunctionId = src->GetId(); src->AddRefInternal(); return asSUCCESS; } // interface int asCModule::UnbindImportedFunction(asUINT index) { if( index >= bindInformations.GetLength() ) return asINVALID_ARG; // Remove reference to old module if( bindInformations[index] ) { int oldFuncID = bindInformations[index]->boundFunctionId; if( oldFuncID != -1 ) { bindInformations[index]->boundFunctionId = -1; engine->scriptFunctions[oldFuncID]->ReleaseInternal(); } } return asSUCCESS; } // interface const char *asCModule::GetImportedFunctionDeclaration(asUINT index) const { asCScriptFunction *func = GetImportedFunction(index); if( func == 0 ) return 0; asCString *tempString = &asCThreadManager::GetLocalData()->string; *tempString = func->GetDeclarationStr(); return tempString->AddressOf(); } // interface const char *asCModule::GetImportedFunctionSourceModule(asUINT index) const { if( index >= bindInformations.GetLength() ) return 0; return bindInformations[index]->importFromModule.AddressOf(); } // inteface int asCModule::BindAllImportedFunctions() { bool notAllFunctionsWereBound = false; // Bind imported functions int c = GetImportedFunctionCount(); for( int n = 0; n < c; ++n ) { asCScriptFunction *importFunc = GetImportedFunction(n); if( importFunc == 0 ) return asERROR; asCString str = importFunc->GetDeclarationStr(false, true); // Get module name from where the function should be imported const char *moduleName = GetImportedFunctionSourceModule(n); if( moduleName == 0 ) return asERROR; asCModule *srcMod = engine->GetModule(moduleName, false); asIScriptFunction *func = 0; if( srcMod ) func = srcMod->GetFunctionByDecl(str.AddressOf()); if( func == 0 ) notAllFunctionsWereBound = true; else { if( BindImportedFunction(n, func) < 0 ) notAllFunctionsWereBound = true; } } if( notAllFunctionsWereBound ) return asCANT_BIND_ALL_FUNCTIONS; return asSUCCESS; } // interface int asCModule::UnbindAllImportedFunctions() { asUINT c = GetImportedFunctionCount(); for( asUINT n = 0; n < c; ++n ) UnbindImportedFunction(n); return asSUCCESS; } // internal asCObjectType *asCModule::GetObjectType(const char *type, asSNameSpace *ns) { asUINT n; // TODO: optimize: Improve linear search for( n = 0; n < classTypes.GetLength(); n++ ) if( classTypes[n]->name == type && classTypes[n]->nameSpace == ns ) return classTypes[n]; for( n = 0; n < enumTypes.GetLength(); n++ ) if( enumTypes[n]->name == type && enumTypes[n]->nameSpace == ns ) return enumTypes[n]; for( n = 0; n < typeDefs.GetLength(); n++ ) if( typeDefs[n]->name == type && typeDefs[n]->nameSpace == ns ) return typeDefs[n]; return 0; } // internal asCGlobalProperty *asCModule::AllocateGlobalProperty(const char *name, const asCDataType &dt, asSNameSpace *ns) { asCGlobalProperty *prop = engine->AllocateGlobalProperty(); prop->name = name; prop->nameSpace = ns; // Allocate the memory for this property based on its type prop->type = dt; prop->AllocateMemory(); // Make an entry in the address to variable map engine->varAddressMap.Insert(prop->GetAddressOfValue(), prop); // Store the variable in the module scope scriptGlobals.Put(prop); prop->AddRef(); return prop; } // internal bool asCModule::IsEmpty() const { if( scriptFunctions.GetLength() ) return false; if( globalFunctions.GetSize() ) return false; if( bindInformations.GetLength() ) return false; if( scriptGlobals.GetSize() ) return false; if( classTypes.GetLength() ) return false; if( enumTypes.GetLength() ) return false; if( typeDefs.GetLength() ) return false; if( funcDefs.GetLength() ) return false; return true; } // interface int asCModule::SaveByteCode(asIBinaryStream *out, bool stripDebugInfo) const { #ifdef AS_NO_COMPILER UNUSED_VAR(out); UNUSED_VAR(stripDebugInfo); return asNOT_SUPPORTED; #else if( out == 0 ) return asINVALID_ARG; // Make sure there is actually something to save if( IsEmpty() ) return asERROR; asCWriter write(const_cast(this), out, engine, stripDebugInfo); return write.Write(); #endif } // interface int asCModule::LoadByteCode(asIBinaryStream *in, bool *wasDebugInfoStripped) { if( in == 0 ) return asINVALID_ARG; // Don't allow the module to be rebuilt if there are still // external references that will need the previous code if( HasExternalReferences(false) ) { engine->WriteMessage("", 0, 0, asMSGTYPE_ERROR, TXT_MODULE_IS_IN_USE); return asMODULE_IS_IN_USE; } // Only permit loading bytecode if no other thread is currently compiling // TODO: It should be possible to have multiple threads perform compilations int r = engine->RequestBuild(); if( r < 0 ) return r; asCReader read(this, in, engine); r = read.Read(wasDebugInfoStripped); JITCompile(); #ifdef AS_DEBUG // Verify that there are no unwanted gaps in the scriptFunctions array. for( asUINT n = 1; n < engine->scriptFunctions.GetLength(); n++ ) { int id = n; if( engine->scriptFunctions[n] == 0 && !engine->freeScriptFunctionIds.Exists(id) ) asASSERT( false ); } #endif engine->BuildCompleted(); return r; } // interface int asCModule::CompileGlobalVar(const char *sectionName, const char *code, int lineOffset) { #ifdef AS_NO_COMPILER UNUSED_VAR(sectionName); UNUSED_VAR(code); UNUSED_VAR(lineOffset); return asNOT_SUPPORTED; #else // Validate arguments if( code == 0 ) return asINVALID_ARG; // Only one thread may build at one time // TODO: It should be possible to have multiple threads perform compilations int r = engine->RequestBuild(); if( r < 0 ) return r; // Prepare the engine engine->PrepareEngine(); if( engine->configFailed ) { engine->WriteMessage("", 0, 0, asMSGTYPE_ERROR, TXT_INVALID_CONFIGURATION); engine->BuildCompleted(); return asINVALID_CONFIGURATION; } // Compile the global variable and add it to the module scope asCBuilder builder(engine, this); asCString str = code; r = builder.CompileGlobalVar(sectionName, str.AddressOf(), lineOffset); engine->BuildCompleted(); // Initialize the variable if( r >= 0 && engine->ep.initGlobalVarsAfterBuild ) { // Clear the memory asCGlobalProperty *prop = scriptGlobals.GetLast(); if( prop ) { memset(prop->GetAddressOfValue(), 0, sizeof(asDWORD)*prop->type.GetSizeOnStackDWords()); if( prop->GetInitFunc() ) { // Call the init function for the global variable asIScriptContext *ctx = 0; int r = engine->CreateContext(&ctx, true); if( r < 0 ) return r; r = ctx->Prepare(prop->GetInitFunc()); if( r >= 0 ) r = ctx->Execute(); ctx->Release(); } } } return r; #endif } // interface int asCModule::CompileFunction(const char *sectionName, const char *code, int lineOffset, asDWORD compileFlags, asIScriptFunction **outFunc) { // Make sure the outFunc is null if the function fails, so the // application doesn't attempt to release a non-existent function if( outFunc ) *outFunc = 0; #ifdef AS_NO_COMPILER UNUSED_VAR(sectionName); UNUSED_VAR(code); UNUSED_VAR(lineOffset); UNUSED_VAR(compileFlags); return asNOT_SUPPORTED; #else // Validate arguments if( code == 0 || (compileFlags != 0 && compileFlags != asCOMP_ADD_TO_MODULE) ) return asINVALID_ARG; // Only one thread may build at one time // TODO: It should be possible to have multiple threads perform compilations int r = engine->RequestBuild(); if( r < 0 ) return r; // Prepare the engine engine->PrepareEngine(); if( engine->configFailed ) { engine->WriteMessage("", 0, 0, asMSGTYPE_ERROR, TXT_INVALID_CONFIGURATION); engine->BuildCompleted(); return asINVALID_CONFIGURATION; } // Compile the single function asCBuilder builder(engine, this); asCString str = code; asCScriptFunction *func = 0; r = builder.CompileFunction(sectionName, str.AddressOf(), lineOffset, compileFlags, &func); engine->BuildCompleted(); if( r >= 0 && outFunc && func ) { // Return the function to the caller and add an external reference *outFunc = func; func->AddRef(); } // Release our reference to the function if( func ) func->ReleaseInternal(); return r; #endif } // interface int asCModule::RemoveFunction(asIScriptFunction *func) { // TODO: 2.30.0: redesign: Check if there are any references before removing the function // if there are, just hide it from the visible but do not destroy or // remove it from the module. // // Only if the function has no live references, nor internal references // can it be immediately removed, and its internal references released. // // Check if any previously hidden functions are without references, // if so they should removed too. // Find the global function asCScriptFunction *f = static_cast(func); int idx = globalFunctions.GetIndex(f); if( idx >= 0 ) { globalFunctions.Erase(idx); scriptFunctions.RemoveValue(f); f->ReleaseInternal(); return 0; } return asNO_FUNCTION; } #ifndef AS_NO_COMPILER // internal int asCModule::AddFuncDef(const asCString &name, asSNameSpace *ns) { asCScriptFunction *func = asNEW(asCScriptFunction)(engine, 0, asFUNC_FUNCDEF); if( func == 0 ) return asOUT_OF_MEMORY; func->name = name; func->nameSpace = ns; funcDefs.PushLast(func); engine->funcDefs.PushLast(func); func->id = engine->GetNextScriptFunctionId(); engine->AddScriptFunction(func); return (int)funcDefs.GetLength()-1; } #endif // interface asDWORD asCModule::SetAccessMask(asDWORD mask) { asDWORD old = accessMask; accessMask = mask; return old; } END_AS_NAMESPACE