First version of position mapping between LSL <-> C# implemented.

2 files changed, 123 insertions, 3 deletions

diff --git a/OpenSim/Tests/OpenSim/Region/ScriptEngine/Shared/CodeTools/LSLCompilerTest.cs b/OpenSim/Tests/OpenSim/Region/ScriptEngine/Shared/CodeTools/CSCodeGeneratorTest.cs
index 70472cb..0b07b30 100644
--- a/OpenSim/Tests/OpenSim/Region/ScriptEngine/Shared/CodeTools/LSLCompilerTest.cs
+++ b/OpenSim/Tests/OpenSim/Region/ScriptEngine/Shared/CodeTools/CSCodeGeneratorTest.cs
@@ -38,7 +38,7 @@ namespace OpenSim.Region.ScriptEngine.Shared.CodeTools.Tests
     /// The generated C# code is compared against the expected C# code.
     /// </summary>
     [TestFixture]
-    public class LSLCompilerTest
+    public class CSCodeGeneratorTest
     {
         [Test]
         public void TestDefaultState()
@@ -685,7 +685,7 @@ default
         integer x = 1;
 
         if(x) llSay(0, ""Hello"");
-        if(1) 
+        if(1)
         {
             llSay(0, ""Hi"");
             integer r = 3;
@@ -791,7 +791,7 @@ default
         integer y = 0;
 
         if(x && y) llSay(0, ""Hello"");
-        if(x || y) 
+        if(x || y)
         {
             llSay(0, ""Hi"");
             integer r = 3;
diff --git a/OpenSim/Tests/OpenSim/Region/ScriptEngine/Shared/CodeTools/CompilerTest.cs b/OpenSim/Tests/OpenSim/Region/ScriptEngine/Shared/CodeTools/CompilerTest.cs
new file mode 100644
index 0000000..7a11d33
--- /dev/null
+++ b/OpenSim/Tests/OpenSim/Region/ScriptEngine/Shared/CodeTools/CompilerTest.cs
@@ -0,0 +1,120 @@
+/*
+ * 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.IO;
+using System.CodeDom.Compiler;
+using System.Collections.Generic;
+using Microsoft.CSharp;
+using NUnit.Framework;
+using OpenSim.Region.ScriptEngine.Shared.CodeTools;
+
+namespace OpenSim.Region.ScriptEngine.Shared.CodeTools.Tests
+{
+    /// <summary>
+    /// Tests the LSL compiler. Among other things, test that error messages
+    /// generated by the C# compiler can be mapped to prper lines/columns in
+    /// the LSL source.
+    /// </summary>
+    [TestFixture]
+    public class CompilerTest
+    {
+        private string m_testDir;
+        private CSharpCodeProvider m_CSCodeProvider;
+        private CompilerParameters m_compilerParameters;
+        private CompilerResults m_compilerResults;
+
+        /// <summary>
+        /// Creates a temporary directory where build artifacts are stored.
+        /// </summary>
+        [TestFixtureSetUp]
+        public void Init()
+        {
+            m_testDir = Path.Combine(Path.GetTempPath(), "opensim_compilerTest_" + Path.GetRandomFileName());
+
+            if (!Directory.Exists(m_testDir))
+            {
+                // Create the temporary directory for housing build artifacts.
+                Directory.CreateDirectory(m_testDir);
+            }
+
+            // Create a CSCodeProvider and CompilerParameters.
+            m_CSCodeProvider = new CSharpCodeProvider();
+            m_compilerParameters = new CompilerParameters();
+
+            string rootPath = Path.Combine(Path.GetDirectoryName(System.AppDomain.CurrentDomain.BaseDirectory), "bin");
+            m_compilerParameters.ReferencedAssemblies.Add(Path.Combine(rootPath, "OpenSim.Region.ScriptEngine.Shared.dll"));
+            m_compilerParameters.ReferencedAssemblies.Add(Path.Combine(rootPath, "OpenSim.Region.ScriptEngine.Shared.Api.Runtime.dll"));
+            m_compilerParameters.GenerateExecutable = false;
+        }
+
+        /// <summary>
+        /// Removes the temporary build directory and any build artifacts
+        /// inside it.
+        /// </summary>
+        [TestFixtureTearDown]
+        public void CleanUp()
+        {
+            if (Directory.Exists(m_testDir))
+            {
+                // Blow away the temporary directory with artifacts.
+                Directory.Delete(m_testDir, true);
+            }
+        }
+
+        [Test]
+        /// <summary>
+        /// Test the C# compiler error message can be mapped to the correct
+        /// line/column in the LSL source when an undeclared variable is used.
+        /// </summary>
+        public void TestUseUndeclaredVariable()
+        {
+            m_compilerParameters.OutputAssembly = Path.Combine(m_testDir, Path.GetRandomFileName() + ".dll");
+
+            string input = @"default
+{
+    state_entry()
+    {
+        integer y = x + 3;
+    }
+}";
+
+            CSCodeGenerator cg = new CSCodeGenerator();
+            string output = "using OpenSim.Region.ScriptEngine.Shared; using System.Collections.Generic;\n" +
+                            "namespace SecondLife { " +
+                            "public class Script : OpenSim.Region.ScriptEngine.Shared.ScriptBase.ScriptBaseClass {\n" +
+                            "public Script() { } " +
+                            cg.Convert(input) +
+                            "} }\n";
+            Dictionary<KeyValuePair<int, int>, KeyValuePair<int, int>> positionMap = cg.PositionMap;
+
+            m_compilerResults = m_CSCodeProvider.CompileAssemblyFromSource(m_compilerParameters, output);
+
+            Assert.AreEqual(new KeyValuePair<int, int>(5, 21),
+                            positionMap[new KeyValuePair<int, int>(m_compilerResults.Errors[0].Line, m_compilerResults.Errors[0].Column)]);
+        }
+    }
+}