Files
GDevelop/Extensions/Function/Extension.cpp
T
Florian 22e63e8cdc Latest commit before switching to git for the whole Extension directory.
git-svn-id: svn://localhost@1109 8062f311-0dae-4547-b526-b8ab9ac864a5
2013-07-01 22:01:24 +00:00

270 lines
13 KiB
C++

/**
Game Develop - Function Extension
Copyright (c) 2008-2013 Florian Rival (Florian.Rival@gmail.com)
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.
*/
#include "GDCpp/ExtensionBase.h"
#include "GDCore/Tools/Version.h"
#include "GDCore/Events/ExpressionsCodeGeneration.h"
#include "GDCore/Events/EventsCodeGenerationContext.h"
#include "GDCore/Events/EventsCodeGenerator.h"
#include "GDCore/Events/EventsCodeNameMangler.h"
#include "GDCpp/CppPlatform.h"
#include "GDCpp/Project.h"
#include "GDCpp/Scene.h"
#include "GDCpp/CommonTools.h"
#if defined(GD_IDE_ONLY)
#include "GDCore/Events/ExpressionParser.h"
#include "GDCore/Events/Instruction.h"
#endif
#include "FunctionEvent.h"
#include <boost/version.hpp>
/**
* \brief This class declares information about the extension.
*/
class Extension : public ExtensionBase
{
public:
/**
* Constructor of an extension declares everything the extension contains : Objects, actions, conditions and expressions.
*/
Extension()
{
SetExtensionInformation("Function",
_("Function events"),
_("Extension allowing to use events behaving as functions."),
"Florian Rival",
"zlib/libpng License ( Open Source )");
#if defined(GD_IDE_ONLY)
{
class CodeGenerator : public gd::InstructionMetadata::ExtraInformation::CustomCodeGenerator
{
virtual std::string GenerateCode(gd::Instruction & instruction, gd::EventsCodeGenerator & codeGenerator, gd::EventsCodeGenerationContext & context)
{
codeGenerator.AddGlobalDeclaration(FunctionEvent::globalDeclaration);
std::string functionName = instruction.GetParameter(0).GetPlainString();
const gd::Project & project = codeGenerator.GetProject();
const gd::Layout & scene = codeGenerator.GetLayout();
boost::shared_ptr<FunctionEvent> functionEvent = FunctionEvent::SearchForFunctionInEvents(scene.GetEvents(), functionName);
if ( functionEvent == boost::shared_ptr<FunctionEvent>() )
{
std::cout << "Function \""+functionName+"\" not found!" << std::endl;
return "//Function \""+functionName+"\" not found.\n";
}
std::string code;
//Generate code for objects passed as arguments
std::string objectsAsArgumentCode;
{
objectsAsArgumentCode += "runtimeContext->ClearObjectListsMap()";
std::vector<std::string> realObjects = codeGenerator.ExpandObjectsName(functionEvent->GetObjectsPassedAsArgument(), context);
for (unsigned int i = 0;i<realObjects.size();++i)
{
context.EmptyObjectsListNeeded(realObjects[i]);
objectsAsArgumentCode += ".AddObjectListToMap(\""+codeGenerator.ConvertToString(realObjects[i])+"\", "+ManObjListName(realObjects[i])+")";
}
objectsAsArgumentCode += ".ReturnObjectListsMap()";
}
//Generate code for evaluating parameters
code += "std::vector<std::string> functionParameters;\n";
for (unsigned int i = 1;i<8;++i)
{
std::string parameterCode;
gd::CallbacksForGeneratingExpressionCode callbacks(parameterCode, codeGenerator, context);
gd::ExpressionParser parser(instruction.GetParameter(i).GetPlainString());
parser.ParseStringExpression(CppPlatform::Get(), project, scene, callbacks);
if (parameterCode.empty()) parameterCode = "\"\"";
code += "functionParameters.push_back("+parameterCode+");\n";
}
code += "std::vector<std::string> * oldFunctionParameters = currentFunctionParameters;\n";
code += "currentFunctionParameters = &functionParameters;\n";
code += FunctionEvent::MangleFunctionName(*functionEvent)+"(runtimeContext, "+objectsAsArgumentCode+");\n";
code += "currentFunctionParameters = oldFunctionParameters;\n";
return code;
};
};
gd::InstructionMetadata::ExtraInformation::CustomCodeGenerator * codeGenerator = new CodeGenerator; //Need for code to compile
AddAction("LaunchFunction",
_("Launch a function"),
_("Launch a function"),
_("Launch _PARAM0_ (_PARAM1_, _PARAM2_, _PARAM3_, _PARAM4_, _PARAM5_, _PARAM6_, _PARAM7_)"),
_("Functions"),
"res/actions/function24.png",
"res/actions/function.png")
.AddParameter("", _("Name of the function"))
.AddParameter("string", _("Parameter 1"), "", true)
.AddParameter("string", _("Parameter 2"), "", true)
.AddParameter("string", _("Parameter 3"), "", true)
.AddParameter("string", _("Parameter 4"), "", true)
.AddParameter("string", _("Parameter 5"), "", true)
.AddParameter("string", _("Parameter 6"), "", true)
.AddParameter("string", _("Parameter 7"), "", true)
.codeExtraInformation.SetCustomCodeGenerator(boost::shared_ptr<gd::InstructionMetadata::ExtraInformation::CustomCodeGenerator>(codeGenerator));
}
{
class CodeGen : public gd::EventMetadata::CodeGenerator
{
virtual std::string Generate(gd::BaseEvent & event_, gd::EventsCodeGenerator & codeGenerator,
gd::EventsCodeGenerationContext & /* The function has nothing to do with the current context */)
{
FunctionEvent & event = dynamic_cast<FunctionEvent&>(event_);
//Declaring the pointer to the function parameters
codeGenerator.AddGlobalDeclaration(event.globalDeclaration);
//Declaring function prototype.
codeGenerator.AddGlobalDeclaration("void "+FunctionEvent::MangleFunctionName(event)+"(RuntimeContext *, std::map <std::string, std::vector<RuntimeObject*> *>);\n");
//Generating function code:
std::string functionCode;
functionCode += "\nvoid "+FunctionEvent::MangleFunctionName(event)+"(RuntimeContext * runtimeContext, std::map <std::string, std::vector<RuntimeObject*> *> objectsListsMap)\n{\n";
gd::EventsCodeGenerationContext callerContext;
{
std::vector<std::string> realObjects = codeGenerator.ExpandObjectsName(event.GetObjectsPassedAsArgument(), callerContext);
for (unsigned int i = 0;i<realObjects.size();++i)
{
callerContext.EmptyObjectsListNeeded(realObjects[i]);
functionCode += "std::vector<RuntimeObject*> "+ManObjListName(realObjects[i]) + ";\n";
functionCode += "if ( objectsListsMap[\""+realObjects[i]+"\"] != NULL ) "+ManObjListName(realObjects[i])+" = *objectsListsMap[\""+realObjects[i]+"\"];\n";
}
}
functionCode += "{";
gd::EventsCodeGenerationContext context;
context.InheritsFrom(callerContext);
//Generating function body code
std::string conditionsCode = codeGenerator.GenerateConditionsListCode(event.GetConditions(), context);
std::string actionsCode = codeGenerator.GenerateActionsListCode(event.GetActions(), context);
std::string subeventsCode = codeGenerator.GenerateEventsListCode(event.GetSubEvents(), context);
functionCode += codeGenerator.GenerateObjectsDeclarationCode(context);
std::string ifPredicat = "true";
for (unsigned int i = 0;i<event.GetConditions().size();++i)
ifPredicat += " && condition"+ToString(i)+"IsTrue";
functionCode += conditionsCode;
functionCode += "if (" +ifPredicat+ ")\n";
functionCode += "{\n";
functionCode += actionsCode;
if ( event.HasSubEvents() ) //Sub events
{
functionCode += "\n{\n";
functionCode += subeventsCode;
functionCode += "}\n";
}
functionCode += "}\n";
functionCode += "}\n"; //Context end
functionCode += "}\n"; //Function end
codeGenerator.AddCustomCodeOutsideMain(functionCode);
return "";
}
};
gd::EventMetadata::CodeGenerator * codeGen = new CodeGen;
AddEvent("Function",
_("Function"),
_("Function event : An event which is launched only thanks to action \"Launch a function\""),
"",
"res/function.png",
boost::shared_ptr<gd::BaseEvent>(new FunctionEvent))
.SetCodeGenerator(boost::shared_ptr<gd::EventMetadata::CodeGenerator>(codeGen));
}
{
class CodeGenerator : public gd::StrExpressionMetadata::ExtraInformation::CustomCodeGenerator
{
virtual std::string GenerateCode(const std::vector<gd::Expression> & parameters, gd::EventsCodeGenerator & codeGenerator, gd::EventsCodeGenerationContext & context)
{
codeGenerator.AddGlobalDeclaration(FunctionEvent::globalDeclaration);
codeGenerator.AddIncludeFile("Function/FunctionTools.h");
const gd::Project & game = codeGenerator.GetProject();
const gd::Layout & scene = codeGenerator.GetLayout();
//Generate code for evaluating index
std::string expression;
gd::CallbacksForGeneratingExpressionCode callbacks(expression, codeGenerator, context);
gd::ExpressionParser parser(parameters[0].GetPlainString());
if (!parser.ParseMathExpression(codeGenerator.GetPlatform(), game, scene, callbacks) || expression.empty()) expression = "0";
std::string code;
code += "GDpriv::FunctionTools::GetSafelyStringFromVector(currentFunctionParameters, "+expression+")";
return code;
};
};
gd::StrExpressionMetadata::ExtraInformation::CustomCodeGenerator * codeGenerator = new CodeGenerator; //Need for code to compile
AddStrExpression("Parameter",
_("Parameter of the current function"),
_("Return the text contained in a parameter of the currently launched function"),
_("Function"),
"res/function.png")
.AddParameter("expression", _("Number of the parameter ( Parameters start at 0 ! )"))
.codeExtraInformation.SetCustomCodeGenerator(boost::shared_ptr<gd::StrExpressionMetadata::ExtraInformation::CustomCodeGenerator>(codeGenerator));
}
#endif
GD_COMPLETE_EXTENSION_COMPILATION_INFORMATION();
};
virtual ~Extension() {};
};
/**
* Used by Game Develop to create the extension class
* -- Do not need to be modified. --
*/
extern "C" ExtensionBase * GD_EXTENSION_API CreateGDExtension() {
return new Extension;
}
/**
* Used by Game Develop to destroy the extension class
* -- Do not need to be modified. --
*/
extern "C" void GD_EXTENSION_API DestroyGDExtension(ExtensionBase * p) {
delete p;
}