Spinning Topp Logo BlackTopp Studios
inc
scriptingmanager.h
Go to the documentation of this file.
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _scriptingmanager_h
41 #define _scriptingmanager_h
42 
43 /// @file
44 /// @brief This file has the interfaces for Scripting managers and the associated dependency chain
45 
46 #include "entresolmanager.h"
48 #include "Scripting/script.h"
49 #include "singleton.h"
50 
51 namespace Mezzanine
52 {
53  namespace Scripting
54  {
55 
56  ///////////////////////////////////////////////////////////////////////////////
57  /// @brief What a scripting manager should look like.
58  /// @details This scripting manager implements no scripting language, but serves as
59  /// model for what scripting managers.
60  /// @n @n
61  /// If a scripting language does not support compilation It should implement
62  /// this
63  ///////////////////////////////////////
65  {
66  protected:
67 
68  public:
69  /// @brief Class constructor.
70  /// @details Sets Priority as required by single threaaded main loop
72 
73  /// @brief Class destructor.
74  virtual ~iScriptingManager();
75 
76  ///////////////////////////////////////////////////////////////////////////////
77  // Scripting Manager Core Functionality
78 
79  /// @brief Run a string containing script soure code.
80  /// @param ScriptSource The source code of the script.
81  /// @details In implementations it is expected that this will create a script
82  /// object, execute it and return it.
83  /// @return A Shared pointer to the created Script.
84  virtual CountedPtr<iScript> Execute(const String& ScriptSource) = 0;
85 
86  /// @brief Run the script.
87  /// @param ScriptToRun A shared ptr that points to a script to run.
88  /// @details In Scripting langauge implementations this is expected to
89  /// run (compile if needed) a script.
90  virtual void Execute(CountedPtr<iScript>& ScriptToRun) = 0;
91 
92  ///////////////////////////////////////////////////////////////////////////////
93  // Utility
94 
95  /// @copydoc ManagerBase::Initialize()
96  virtual void Initialize();
97 
98  /// @copydoc ManagerBase::Deinitialize()
99  virtual void Deinitialize();
100 
101  ///////////////////////////////////////////////////////////////////////////////
102  // Type Identifier Methods
103 
104  /// @copydoc ManagerBase::GetInterfaceType()
105  virtual ManagerType GetInterfaceType() const;
106 
107  /// @copydoc ManagerBase::GetImplementationTypeName()
108  virtual String GetImplementationTypeName() const = 0;
109  }; //ScriptingManager
110 
111  ///////////////////////////////////////////////////////////////////////////////
112  /// @brief What a scripting manager should look like.
113  /// @details This scripting manager implements no scripting language, but serves as
114  /// model for what scripting managers
115  ///////////////////////////////////////
117  {
118  public:
119  /// @brief Overidable deconstructor.
120  virtual ~iScriptCompilationManager();
121 
122  /// @brief Compile a script.
123  /// @param ScriptToCompile A script object to be compiled.
124  virtual void Compile(CountedPtr<iScriptCompilable>& ScriptToCompile) = 0;
125 
126  /// @brief Comvert a string into a Script that is compiled and ready for use.
127  /// @param SourceToCompile A string containing source code in the target language.
128  /// @return The Script compiled and ready for use.
129  virtual CountedPtr<iScriptCompilable> Compile(const String& SourceToCompile) = 0;
130  };
131 
132  }// Scripting
133 }//Mezzanine
134 
135 // possible languages Lua, Tcl, squirrel, Angelscript, falcon
136 
137 #endif // \_scriptingmanager_h
What a scripting manager should look like.
ManagerType
A listing of Manager Types.
Definition: managerbase.h:65
A simple reference counting pointer.
Definition: countedptr.h:70
What a scripting manager should look like.
This file has the interfaces for Scripts and tag derived classes.
This is the base class for all managers that do no describe properties of a single world...
This file has the interfaces for Script Arguments and the associated dependency chain.
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159