* Applied patch from Melanie, mantis issue #1581 - "Refactor LSL language, api and compiler out of XEngine"

"First stage in a major Script Engine refactor, that will result in the LSL implementaions ebing reconverged. Not there yet, but one major part is done."
Thank you, Melanie!

3 files changed, 146 insertions, 38 deletions

diff --git a/OpenSim/Region/ScriptEngine/XEngine/Compiler.cs b/OpenSim/Region/ScriptEngine/Shared/CodeTools/Compiler.cs
index 68fb1dd..2edcee0 100644
--- a/OpenSim/Region/ScriptEngine/XEngine/Compiler.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/CodeTools/Compiler.cs
@@ -34,8 +34,9 @@ using Microsoft.CSharp;
 using Microsoft.JScript;
 using Microsoft.VisualBasic;
 using OpenSim.Region.Environment.Interfaces;
+using OpenSim.Region.ScriptEngine.Interfaces;
 
-namespace OpenSim.Region.ScriptEngine.XEngine
+namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
 {
     public class Compiler
     {
@@ -78,8 +79,8 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         private static int instanceID = new Random().Next(0, int.MaxValue);                 // Unique number to use on our compiled files
         private static UInt64 scriptCompileCounter = 0;                                     // And a counter
 
-        public XEngine m_scriptEngine;
-        public Compiler(XEngine scriptEngine)
+        public IScriptEngine m_scriptEngine;
+        public Compiler(IScriptEngine scriptEngine)
         {
             m_scriptEngine = scriptEngine;
             ReadConfig();
@@ -89,11 +90,11 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         {
 
             // Get some config
-            WriteScriptSourceToDebugFile = m_scriptEngine.ScriptConfigSource.GetBoolean("WriteScriptSourceToDebugFile", true);
-            CompileWithDebugInformation = m_scriptEngine.ScriptConfigSource.GetBoolean("CompileWithDebugInformation", true);
+            WriteScriptSourceToDebugFile = m_scriptEngine.Config.GetBoolean("WriteScriptSourceToDebugFile", true);
+            CompileWithDebugInformation = m_scriptEngine.Config.GetBoolean("CompileWithDebugInformation", true);
 
             // Get file prefix from scriptengine name and make it file system safe:
-            FilePrefix = m_scriptEngine.ScriptEngineName;
+            FilePrefix = "CommonCompiler";
             foreach (char c in Path.GetInvalidFileNameChars())
             {
                 FilePrefix = FilePrefix.Replace(c, '_');
@@ -113,11 +114,11 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             LanguageMapping.Add(enumCompileType.js.ToString(), enumCompileType.js);
 
             // Allowed compilers
-            string allowComp = m_scriptEngine.ScriptConfigSource.GetString("AllowedCompilers", "lsl,cs,vb,js");
+            string allowComp = m_scriptEngine.Config.GetString("AllowedCompilers", "lsl,cs,vb,js");
             AllowedCompilers.Clear();
 
 #if DEBUG
-            m_scriptEngine.Log.Debug("[" + m_scriptEngine.ScriptEngineName + "]: Allowed languages: " + allowComp);
+            m_scriptEngine.Log.Debug("[Compiler]: Allowed languages: " + allowComp);
 #endif
 
 
@@ -126,26 +127,26 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 string strlan = strl.Trim(" \t".ToCharArray()).ToLower();
                 if (!LanguageMapping.ContainsKey(strlan))
                 {
-                    m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: Config error. Compiler is unable to recognize language type \"" + strlan + "\" specified in \"AllowedCompilers\".");
+                    m_scriptEngine.Log.Error("[Compiler]: Config error. Compiler is unable to recognize language type \"" + strlan + "\" specified in \"AllowedCompilers\".");
                 }
                 else
                 {
 #if DEBUG
-                    //m_scriptEngine.Log.Debug("[" + m_scriptEngine.ScriptEngineName + "]: Config OK. Compiler recognized language type \"" + strlan + "\" specified in \"AllowedCompilers\".");
+                    //m_scriptEngine.Log.Debug("[Compiler]: Config OK. Compiler recognized language type \"" + strlan + "\" specified in \"AllowedCompilers\".");
 #endif
                 }
                 AllowedCompilers.Add(strlan, true);
             }
             if (AllowedCompilers.Count == 0)
-                m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: Config error. Compiler could not recognize any language in \"AllowedCompilers\". Scripts will not be executed!");
+                m_scriptEngine.Log.Error("[Compiler]: Config error. Compiler could not recognize any language in \"AllowedCompilers\". Scripts will not be executed!");
 
             // Default language
-            string defaultCompileLanguage = m_scriptEngine.ScriptConfigSource.GetString("DefaultCompileLanguage", "lsl").ToLower();
+            string defaultCompileLanguage = m_scriptEngine.Config.GetString("DefaultCompileLanguage", "lsl").ToLower();
 
             // Is this language recognized at all?
             if (!LanguageMapping.ContainsKey(defaultCompileLanguage))
             {
-                m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: " +
+                m_scriptEngine.Log.Error("[Compiler]: " +
                                             "Config error. Default language \"" + defaultCompileLanguage + "\" specified in \"DefaultCompileLanguage\" is not recognized as a valid language. Changing default to: \"lsl\".");
                 defaultCompileLanguage = "lsl";
             }
@@ -153,13 +154,13 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             // Is this language in allow-list?
             if (!AllowedCompilers.ContainsKey(defaultCompileLanguage))
             {
-                m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: " +
+                m_scriptEngine.Log.Error("[Compiler]: " +
                                             "Config error. Default language \"" + defaultCompileLanguage + "\"specified in \"DefaultCompileLanguage\" is not in list of \"AllowedCompilers\". Scripts may not be executed!");
             }
             else
             {
 #if DEBUG
-//                m_scriptEngine.Log.Debug("[" + m_scriptEngine.ScriptEngineName + "]: " +
+//                m_scriptEngine.Log.Debug("[Compiler]: " +
 //                                            "Config OK. Default language \"" + defaultCompileLanguage + "\" specified in \"DefaultCompileLanguage\" is recognized as a valid language.");
 #endif
                 // LANGUAGE IS IN ALLOW-LIST
@@ -185,7 +186,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 }
                 catch (Exception ex)
                 {
-                    m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: Exception trying to create ScriptEngine directory \"" + ScriptEnginesPath + "\": " + ex.ToString());
+                    m_scriptEngine.Log.Error("[Compiler]: Exception trying to create ScriptEngine directory \"" + ScriptEnginesPath + "\": " + ex.ToString());
                 }
             }
 
@@ -199,7 +200,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 }
                 catch (Exception ex)
                 {
-                    m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: Exception trying to create ScriptEngine directory \"" + Path.Combine(ScriptEnginesPath,
+                    m_scriptEngine.Log.Error("[Compiler]: Exception trying to create ScriptEngine directory \"" + Path.Combine(ScriptEnginesPath,
                                             m_scriptEngine.World.RegionInfo.RegionID.ToString())+ "\": " + ex.ToString());
                 }
             }
@@ -207,7 +208,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             foreach (string file in Directory.GetFiles(Path.Combine(ScriptEnginesPath,
                                 m_scriptEngine.World.RegionInfo.RegionID.ToString())))
             {
-                //m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: FILE FOUND: " + file);
+                //m_scriptEngine.Log.Error("[Compiler]: FILE FOUND: " + file);
 
                 if (file.ToLower().StartsWith(FilePrefix + "_compiled_") ||
                     file.ToLower().StartsWith(FilePrefix + "_source_"))
@@ -218,7 +219,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                     }
                     catch (Exception ex)
                     {
-                        m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: Exception trying delete old script file \"" + file + "\": " + ex.ToString());
+                        m_scriptEngine.Log.Error("[Compiler]: Exception trying delete old script file \"" + file + "\": " + ex.ToString());
                     }
 
                 }
@@ -233,10 +234,10 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         //    {
         //        case ".txt":
         //        case ".lsl":
-        //            Common.ScriptEngineBase.Common.SendToDebug("Source code is LSL, converting to CS");
+        //            Common.ScriptEngineBase.Shared.SendToDebug("Source code is LSL, converting to CS");
         //            return CompileFromLSLText(File.ReadAllText(LSOFileName));
         //        case ".cs":
-        //            Common.ScriptEngineBase.Common.SendToDebug("Source code is CS");
+        //            Common.ScriptEngineBase.Shared.SendToDebug("Source code is CS");
         //            return CompileFromCSText(File.ReadAllText(LSOFileName));
         //        default:
         //            throw new Exception("Unknown script type.");
@@ -258,7 +259,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
 
             if (File.Exists(OutFile))
             {
-                m_scriptEngine.Log.DebugFormat("[XEngine] Returning existing assembly for {0}", asset);
+                m_scriptEngine.Log.DebugFormat("[Compiler] Returning existing assembly for {0}", asset);
                 return OutFile;
             }
 
@@ -359,9 +360,9 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         private static string CreateJSCompilerScript(string compileScript)
         {
             compileScript = String.Empty +
-                "import OpenSim.Region.ScriptEngine.XEngine.Script; import System.Collections.Generic;\r\n" +
+                "import OpenSim.Region.ScriptEngine.Shared; import System.Collections.Generic;\r\n" +
                 "package SecondLife {\r\n" +
-                "class Script extends OpenSim.Region.ScriptEngine.XEngine.Script.BuiltIn_Commands_BaseClass { \r\n" +
+                "class Script extends OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass { \r\n" +
                 compileScript +
                 "} }\r\n";
             return compileScript;
@@ -370,9 +371,9 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         private static string CreateCSCompilerScript(string compileScript)
         {
             compileScript = String.Empty +
-                "using OpenSim.Region.ScriptEngine.XEngine.Script; using System.Collections.Generic;\r\n" +
+                "using OpenSim.Region.ScriptEngine.Shared; using System.Collections.Generic;\r\n" +
                 String.Empty + "namespace SecondLife { " +
-                String.Empty + "public class Script : OpenSim.Region.ScriptEngine.XEngine.Script.BuiltIn_Commands_BaseClass { \r\n" +
+                String.Empty + "public class Script : OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass { \r\n" +
                 @"public Script() { } " +
                 compileScript +
                 "} }\r\n";
@@ -382,9 +383,9 @@ namespace OpenSim.Region.ScriptEngine.XEngine
         private static string CreateVBCompilerScript(string compileScript)
         {
             compileScript = String.Empty +
-                "Imports OpenSim.Region.ScriptEngine.XEngine.Script: Imports System.Collections.Generic: " +
+                "Imports OpenSim.Region.ScriptEngine.Shared: Imports System.Collections.Generic: " +
                 String.Empty + "NameSpace SecondLife:" +
-                String.Empty + "Public Class Script: Inherits OpenSim.Region.ScriptEngine.XEngine.Script.BuiltIn_Commands_BaseClass: " +
+                String.Empty + "Public Class Script: Inherits OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass: " +
                 "\r\nPublic Sub New()\r\nEnd Sub: " +
                 compileScript +
                 ":End Class :End Namespace\r\n";
@@ -406,7 +407,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                                               m_scriptEngine.World.RegionInfo.RegionID.ToString(),
                                               FilePrefix + "_compiled_" + asset + ".dll"));
 #if DEBUG
-//            m_scriptEngine.Log.Debug("[" + m_scriptEngine.ScriptEngineName + "]: Starting compile of \"" + OutFile + "\".");
+//            m_scriptEngine.Log.Debug("[Compiler]: Starting compile of \"" + OutFile + "\".");
 #endif
             try
             {
@@ -414,7 +415,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             }
             catch (Exception e) // NOTLEGIT - Should be just catching FileIOException
             {
-                //m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: Unable to delete old existring script-file before writing new. Compile aborted: " + e.ToString());
+                //m_scriptEngine.Log.Error("[Compiler]: Unable to delete old existring script-file before writing new. Compile aborted: " + e.ToString());
                 throw new Exception("Unable to delete old existring script-file before writing new. Compile aborted: " + e.ToString());
             }
             //string OutFile = Path.Combine("ScriptEngines", "SecondLife.Script.dll");
@@ -432,7 +433,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 }
                 catch (Exception ex) // NOTLEGIT - Should be just catching FileIOException
                 {
-                    m_scriptEngine.Log.Error("[" + m_scriptEngine.ScriptEngineName + "]: Exception while trying to write script source to file \"" + srcFileName + "\": " + ex.ToString());
+                    m_scriptEngine.Log.Error("[Compiler]: Exception while trying to write script source to file \"" + srcFileName + "\": " + ex.ToString());
                 }
             }
 
@@ -451,10 +452,9 @@ namespace OpenSim.Region.ScriptEngine.XEngine
             string rootPath = Path.GetDirectoryName(AppDomain.CurrentDomain.BaseDirectory);
             string rootPathSE = Path.GetDirectoryName(GetType().Assembly.Location);
             //Console.WriteLine("Assembly location: " + rootPath);
-            parameters.ReferencedAssemblies.Add(Path.Combine(rootPath, "OpenSim.Region.ScriptEngine.XEngine.Script.dll"));
-//            parameters.ReferencedAssemblies.Add(Path.Combine(rootPathSE, "OpenSim.Region.ScriptEngine.XEngine.dll"));
+            parameters.ReferencedAssemblies.Add(Path.Combine(rootPath, "OpenSim.Region.ScriptEngine.Shared.dll"));
+            parameters.ReferencedAssemblies.Add(Path.Combine(rootPath, "OpenSim.Region.ScriptEngine.Shared.Api.Runtime.dll"));
 
-            //parameters.ReferencedAssemblies.Add("OpenSim.Region.Environment");
             parameters.GenerateExecutable = false;
             parameters.OutputAssembly = OutFile;
             parameters.IncludeDebugInformation = CompileWithDebugInformation;
@@ -508,7 +508,7 @@ namespace OpenSim.Region.ScriptEngine.XEngine
                 errtext += "No compile error. But not able to locate compiled file.";
                 throw new Exception(errtext);
             }
-            m_scriptEngine.Log.DebugFormat("[XEngine] Compiled new assembly for {0}", asset);
+            m_scriptEngine.Log.DebugFormat("[Compiler] Compiled new assembly for {0}", asset);
             return OutFile;
         }
     }
diff --git a/OpenSim/Region/ScriptEngine/XEngine/LSL2CSConverter.cs b/OpenSim/Region/ScriptEngine/Shared/CodeTools/LSL2CSConverter.cs
index 2dc8547..380686e 100644
--- a/OpenSim/Region/ScriptEngine/XEngine/LSL2CSConverter.cs
+++ b/OpenSim/Region/ScriptEngine/Shared/CodeTools/LSL2CSConverter.cs
@@ -30,7 +30,7 @@ using System;
 using System.Collections.Generic;
 using System.Text.RegularExpressions;
 
-namespace OpenSim.Region.ScriptEngine.XEngine
+namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
 {
     public class LSL2CSConverter
     {
@@ -355,13 +355,13 @@ namespace OpenSim.Region.ScriptEngine.XEngine
 
             //System.Console.WriteLine(Script);
             Return = String.Empty;// +
-                     //"using OpenSim.Region.ScriptEngine.Common; using System.Collections.Generic;";
+                     //"using OpenSim.Region.ScriptEngine.Shared; using System.Collections.Generic;";
 
             //Return += String.Empty +
             //          "namespace SecondLife { ";
             //Return += String.Empty +
             //          //"[Serializable] " +
-            //          "public class Script : OpenSim.Region.ScriptEngine.Common.LSL_BaseClass { ";
+            //          "public class Script : OpenSim.Region.ScriptEngine.Shared.LSL_BaseClass { ";
             //Return += @"public Script() { } ";
             Return += Script;
             //Return += "} }\r\n";
diff --git a/OpenSim/Region/ScriptEngine/Shared/CodeTools/YP2CSConverter.cs b/OpenSim/Region/ScriptEngine/Shared/CodeTools/YP2CSConverter.cs
new file mode 100644
index 0000000..54b4861
--- /dev/null
+++ b/OpenSim/Region/ScriptEngine/Shared/CodeTools/YP2CSConverter.cs
@@ -0,0 +1,108 @@
+/*
+* Copyright (c) Contributors, http://opensimulator.org/
+* See CONTRIBUTORS.TXT for a full list of copyright holders.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of the OpenSim Project nor the
+*       names of its contributors may be used to endorse or promote products
+*       derived from this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS AS IS AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*
+*/
+
+using System;
+using System.IO;
+using System.Collections.Generic;
+using System.Text;
+using System.Text.RegularExpressions;
+using OpenSim.Region.ScriptEngine.Shared.YieldProlog;
+
+namespace OpenSim.Region.ScriptEngine.Shared.CodeTools
+{
+    public class YP2CSConverter
+    {
+        public YP2CSConverter()
+        {
+        }
+
+        public string Convert(string Script)
+        {
+            string CS_code = GenCode(Script);
+            return CS_code;
+        }
+
+        static string GenCode(string myCode)
+        {
+            Variable TermList = new Variable();
+            Variable FunctionCode = new Variable();
+
+            string CS_code = "";
+
+            int cs_pointer = myCode.IndexOf("\n//cs");
+            if (cs_pointer > 0)
+            {
+                CS_code = myCode.Substring(cs_pointer); // CS code comes after
+                myCode = myCode.Substring(0, cs_pointer);
+            }
+            myCode.Replace("//yp", "%YPCode");
+            
+            StringWriter myCS_SW = new StringWriter();
+            StringReader myCode_SR = new StringReader(" yp_nop_header_nop. \n "+myCode + "\n");
+
+            YP.see(myCode_SR);
+            YP.tell(myCS_SW);
+
+            //Console.WriteLine("Mycode\n ===================================\n" + myCode+"\n");
+            foreach (bool l1 in Parser.parseInput(TermList))
+            {
+                foreach (bool l2 in YPCompiler.makeFunctionPseudoCode(TermList, FunctionCode))
+                {
+                    ListPair VFC = new ListPair(FunctionCode, new Variable());
+                    //Console.WriteLine("-------------------------")
+                    //Console.WriteLine(FunctionCode.ToString())
+                    //Console.WriteLine("-------------------------")
+                    YPCompiler.convertFunctionCSharp(FunctionCode);
+                    //YPCompiler.convertStringCodesCSharp(VFC);
+                }
+            }
+            YP.seen();
+            myCS_SW.Close();
+            YP.told();
+            StringBuilder bu = myCS_SW.GetStringBuilder();
+            string finalcode = "//YPEncoded\n" + bu.ToString();
+            // FIX script events (we're in the same script)
+            // 'YP.script_event(Atom.a(@"sayit"),' ==> 'sayit('
+            finalcode = Regex.Replace(finalcode,
+                                        @"YP.script_event\(Atom.a\(\@\""(.*?)""\)\,",
+                                        @"this.$1(",
+                                        RegexOptions.Compiled | RegexOptions.Singleline);
+            finalcode = Regex.Replace(finalcode,
+                            @" static ",
+                            @" ",
+                            RegexOptions.Compiled | RegexOptions.Singleline);
+
+            finalcode = CS_code+"\n\r"+ finalcode;
+            finalcode = Regex.Replace(finalcode,
+                                        @"PrologCallback",
+                                        @"public IEnumerable<bool> ",
+                                        RegexOptions.Compiled | RegexOptions.Singleline);
+            return finalcode;
+        }
+    }
+}