first commit
This commit is contained in:
Jose Caban
202
trunk/bin/Release/Scripting.xml
Normal file
202
trunk/bin/Release/Scripting.xml
Normal file
@@ -0,0 +1,202 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Icarus.Scripting</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Icarus.Scripting.ScriptingConsole">
|
||||
<summary>
|
||||
Summary description for ScriptingConsole.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptingConsole.components">
|
||||
<summary>
|
||||
Required designer variable.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptingConsole.m_ConsoleWriter">
|
||||
<summary>
|
||||
This is a text writer that outputs the stuff to the console textbox.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingConsole.#ctor">
|
||||
<summary>
|
||||
Initialize the Scripting Console
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingConsole.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Clean up any resources being used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingConsole.InitializeComponent">
|
||||
<summary>
|
||||
Required method for Designer support - do not modify
|
||||
the contents of this method with the code editor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.Scripting.ScriptingConsole.ConsoleWriter">
|
||||
<summary>
|
||||
Gets the console text writer.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Icarus.Scripting.Language">
|
||||
<summary>
|
||||
Enumerates all the languages that can be used for scripting.
|
||||
</summary>
|
||||
<remarks>
|
||||
If more languages are added here, please modify ScriptingProvider.InitializeCodeCompilerFor function to get the proper compiler for the new language.
|
||||
</remarks>
|
||||
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.Language.CSharp">
|
||||
<summary>
|
||||
Represents the C# Programming language as being readable by the Scripting Engine
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.Language.JScript">
|
||||
<summary>
|
||||
Represents the JScript Programming language as being readable by the Scripting Engine
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.Language.VisualBasic">
|
||||
<summary>
|
||||
Represents the Visual Basic Programming language as being readable by the Scripting Engine
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Icarus.Scripting.UnknownLanguageException">
|
||||
<summary>
|
||||
This exception is thrown when we get an unknown file extension, or a bad language.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.UnknownLanguageException.#ctor(System.String)">
|
||||
<summary>
|
||||
Delegates Exception handing
|
||||
</summary>
|
||||
<param name="text">The text description of the error</param>
|
||||
</member>
|
||||
<member name="T:Icarus.Scripting.ScriptingProvider">
|
||||
<summary>
|
||||
The scripting provider class will handle providing scripting engines to the rest of the scripting module. It handles various code providers in such a way that they don't have to be reinitialized every time we want to use scripting.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptingProvider.mg_Instance">
|
||||
<summary>
|
||||
Singleton Implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptingProvider.m_CodeProviders">
|
||||
<summary>
|
||||
This dictionary maps Language enum items to the code providers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptingProvider.m_ExecutableCodeTemplates">
|
||||
<summary>
|
||||
This is a dictionary of templates to use for wrapping around the executable code compiled for a specific language.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptingProvider.m_LanguageExtensions">
|
||||
<summary>
|
||||
Maps file extensions to language that they correspond to.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingProvider.#ctor">
|
||||
<summary>
|
||||
Singleton Implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingProvider.GetCodeCompilerFor(Icarus.Scripting.Language)">
|
||||
<summary>
|
||||
Returns the code provider for the specified language.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingProvider.GetExecutableTemplateFor(Icarus.Scripting.Language)">
|
||||
<summary>
|
||||
Returns a template, so that when we perform a string format on it with one parameter, the resulting code is wrapped in whatever it needs to be wrapped in for the compiler to generate an executable.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingProvider.GetLanguageForExtension(System.String)">
|
||||
<summary>
|
||||
Given the extension of a file, returns the language that the file's script is written in.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptingProvider.InitializeCodeCompilerFor(Icarus.Scripting.Language)">
|
||||
<summary>
|
||||
Generates a code provider for the specified language and registers it in our local dictionary.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.Scripting.ScriptingProvider.Instance">
|
||||
<summary>
|
||||
Singleton Implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Icarus.Scripting.ScriptManager">
|
||||
<summary>
|
||||
This singleton class manages scripts. When a script is requested, the local register of recently compiled scripts will be checked, and if the script is already there, then it will be run. Otherwise, the script will be loaded from the hard drive and compiled and then executed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptManager.mg_Instance">
|
||||
<summary>
|
||||
Singleton Implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptManager.m_CompilerParameters">
|
||||
<summary>
|
||||
These are the parameters that will be used to compile scripts.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptManager.m_ForceRecompile">
|
||||
<summary>
|
||||
Determines whether the recompile is forced or not.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.Scripting.ScriptManager.m_CurrentLanguage">
|
||||
<summary>
|
||||
The language that will be used to compile the scripts.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptManager.#ctor">
|
||||
<summary>
|
||||
Singleton Implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptManager.InitializeCompilerParameters">
|
||||
<summary>
|
||||
Initializes the Compiler Parameters with some default values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptManager.ExecuteScript(System.String,System.String[])">
|
||||
<summary>
|
||||
Compiles and executes the script passed in. CurrentLanguage scripting language is used to compile the script.
|
||||
</summary>
|
||||
<param name="scriptText">The text of the script to run.</param>
|
||||
<param name="args">The arguments to pass to the main function of the script, if so desired.</param>
|
||||
<returns>If there were any compilation errors (and thus the script was not run) they are returned. Otherwise, returns null, which signifies a successful run.</returns>
|
||||
</member>
|
||||
<member name="M:Icarus.Scripting.ScriptManager.ExecuteFile(System.String,System.String[])">
|
||||
<summary>
|
||||
Compiles and executes the file whose name is passed in. The language in which the script is written is deduced from the extension of the file.
|
||||
</summary>
|
||||
<param name="filename">The fully qualified name of the file to execute.</param>
|
||||
<param name="args">Optional arguments to pass to the main function of the script.</param>
|
||||
<returns>If there were any compilation errors, they are returned.</returns>
|
||||
</member>
|
||||
<member name="P:Icarus.Scripting.ScriptManager.Instance">
|
||||
<summary>
|
||||
Singleton Implementation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.Scripting.ScriptManager.ForceRecompile">
|
||||
<summary>
|
||||
Gets or sets the force recompile property.
|
||||
If it is true, then every time a script is requested, it will be recompiled.
|
||||
If it is false, then the first time the script will be recompiled, but the consecutive times it will be referenced without recompilation.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.Scripting.ScriptManager.CurrentLanguage">
|
||||
<summary>
|
||||
Gets or sets the CurrentLanguage property. This is the language that will be used to compile the scripts.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Reference in New Issue
Block a user