[Simian]

* Partial implementation of RezScript
* Ported LSL to C# conversion code from OpenSim. Big thank you to all of the OpenSim contributors
* Moved Simian scripting code to a new folder

git-svn-id: http://libopenmetaverse.googlecode.com/svn/libopenmetaverse/trunk@2518 52acb1d6-8a22-11de-b505-999d5b087335

Programs/Simian/Scripting/CSReservedWords.cs

@@ -0,0 +1,91 @@
+/*
+* 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.Collections.Generic;
+
+namespace Simian
+{
+    /// <summary>
+    /// A container for all of the reserved C# words that are not also reserved words in LSL.
+    /// The words must be maintained in alphabetical order.
+    /// The words that are key words in lsl are picked up by the lsl compiler as errors.
+    /// The LSL reserved words have been left in the list as comments for completeness
+    /// </summary>
+    public static class CSReservedWords
+    {
+        static List<string> reservedWords = new List<string>(new string[] {
+              "abstract","as",
+              "base","bool","break","byte",
+              "case","catch","char","checked","class","const","continue",
+              "decimal","default","delegate",
+            //"do",
+              "double",
+            //"else",
+              "enum",
+            //"event",
+              "explicit","extern",
+              "false","finally","fixed",
+            //"float","for",
+              "foreach",
+              "goto",
+            //"if",
+              "implicit","in","int","interface","internal","is",
+              "lock","long",
+              "namespace","new","null",
+              "object","operator","out","override",
+              "params","private","protected","public",
+              "readonly","ref",
+            //"return",
+              "sbyte","sealed","short","sizeof","stackalloc","static",
+            //"string",
+              "struct","switch",
+              "this","throw","true","try","typeof",
+              "uint","ulong","unchecked","unsafe","ushort","using",
+              "virtual","void","volatile",
+            //"while"
+        });
+
+        /// <summary>
+        /// Returns true if the passed string is in the list of reserved words with
+        /// a little simple pre-filtering.
+        /// </summary>
+        public static bool IsReservedWord(string word)
+        {
+            // A couple of quick filters to weed out single characters, ll functions and
+            // anything that starts with an uppercase letter
+            if (String.IsNullOrEmpty(word)) return false;
+            if (word.Length < 2) return false;
+            if (word.StartsWith("ll")) return false;
+            char first = word.ToCharArray(0,1)[0];
+            if (first >= 'A' && first <= 'Z') return false;
+            
+            return (reservedWords.BinarySearch(word) >= 0);
+        }
+    }
+}

Programs/Simian/Scripting/LSL2CSCodeTransformer.cs

@@ -0,0 +1,183 @@
+/*
+ * 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.Collections.Generic;
+using Tools;
+
+namespace Simian
+{
+    public class LSL2CSCodeTransformer
+    {
+        private SYMBOL m_astRoot = null;
+        private static Dictionary<string, string> m_datatypeLSL2OpenSim = null;
+
+        /// <summary>
+        /// Pass the new CodeTranformer an abstract syntax tree.
+        /// </summary>
+        /// <param name="astRoot">The root node of the AST.</param>
+        public LSL2CSCodeTransformer(SYMBOL astRoot)
+        {
+            m_astRoot = astRoot;
+
+            // let's populate the dictionary
+            if (null == m_datatypeLSL2OpenSim)
+            {
+                m_datatypeLSL2OpenSim = new Dictionary<string, string>();
+                m_datatypeLSL2OpenSim.Add("integer", "ScriptTypes.LSL_Integer");
+                m_datatypeLSL2OpenSim.Add("float", "ScriptTypes.LSL_Float");
+                //m_datatypeLSL2OpenSim.Add("key", "ScriptTypes.LSL_Key"); // key doesn't seem to be used
+                m_datatypeLSL2OpenSim.Add("key", "ScriptTypes.LSL_String");
+                m_datatypeLSL2OpenSim.Add("string", "ScriptTypes.LSL_String");
+                m_datatypeLSL2OpenSim.Add("vector", "ScriptTypes.LSL_Vector");
+                m_datatypeLSL2OpenSim.Add("rotation", "ScriptTypes.LSL_Rotation");
+                m_datatypeLSL2OpenSim.Add("list", "ScriptTypes.LSL_List");
+            }
+        }
+
+        /// <summary>
+        /// Transform the code in the AST we have.
+        /// </summary>
+        /// <returns>The root node of the transformed AST</returns>
+        public SYMBOL Transform()
+        {
+            foreach (SYMBOL s in m_astRoot.kids)
+                TransformNode(s);
+
+            return m_astRoot;
+        }
+
+        /// <summary>
+        /// Recursively called to transform each type of node. Will transform this
+        /// node, then all it's children.
+        /// </summary>
+        /// <param name="s">The current node to transform.</param>
+        private void TransformNode(SYMBOL s)
+        {
+            // make sure to put type lower in the inheritance hierarchy first
+            // ie: since IdentConstant and StringConstant inherit from Constant,
+            // put IdentConstant and StringConstant before Constant
+            if (s is Declaration)
+                ((Declaration) s).Datatype = m_datatypeLSL2OpenSim[((Declaration) s).Datatype];
+            else if (s is Constant)
+                ((Constant) s).Type = m_datatypeLSL2OpenSim[((Constant) s).Type];
+            else if (s is TypecastExpression)
+                ((TypecastExpression) s).TypecastType = m_datatypeLSL2OpenSim[((TypecastExpression) s).TypecastType];
+            else if (s is GlobalFunctionDefinition && "void" != ((GlobalFunctionDefinition) s).ReturnType) // we don't need to translate "void"
+                ((GlobalFunctionDefinition) s).ReturnType = m_datatypeLSL2OpenSim[((GlobalFunctionDefinition) s).ReturnType];
+
+            for (int i = 0; i < s.kids.Count; i++)
+            {
+                if (!(s is Assignment || s is ArgumentDeclarationList) && s.kids[i] is Declaration)
+                    AddImplicitInitialization(s, i);
+
+                TransformNode((SYMBOL) s.kids[i]);
+            }
+        }
+
+        /// <summary>
+        /// Replaces an instance of the node at s.kids[didx] with an assignment
+        /// node. The assignment node has the Declaration node on the left hand
+        /// side and a default initializer on the right hand side.
+        /// </summary>
+        /// <param name="s">
+        /// The node containing the Declaration node that needs replacing.
+        /// </param>
+        /// <param name="didx">Index of the Declaration node to replace.</param>
+        private void AddImplicitInitialization(SYMBOL s, int didx)
+        {
+            // We take the kids for a while to play with them.
+            int sKidSize = s.kids.Count;
+            object [] sKids = new object[sKidSize];
+            for (int i = 0; i < sKidSize; i++)
+                sKids[i] = s.kids.Pop();
+
+            // The child to be changed.
+            Declaration currentDeclaration = (Declaration) sKids[didx];
+
+            // We need an assignment node.
+            Assignment newAssignment = new Assignment(currentDeclaration.yyps,
+                                                      currentDeclaration,
+                                                      GetZeroConstant(currentDeclaration.yyps, currentDeclaration.Datatype),
+                                                      "=");
+            sKids[didx] = newAssignment;
+
+            // Put the kids back where they belong.
+            for (int i = 0; i < sKidSize; i++)
+                s.kids.Add(sKids[i]);
+        }
+
+        /// <summary>
+        /// Generates the node structure required to generate a default
+        /// initialization.
+        /// </summary>
+        /// <param name="p">
+        /// Tools.Parser instance to use when instantiating nodes.
+        /// </param>
+        /// <param name="constantType">String describing the datatype.</param>
+        /// <returns>
+        /// A SYMBOL node conaining the appropriate structure for intializing a
+        /// constantType.
+        /// </returns>
+        private SYMBOL GetZeroConstant(Parser p, string constantType)
+        {
+            switch (constantType)
+            {
+            case "integer":
+                return new Constant(p, constantType, "0");
+            case "float":
+                return new Constant(p, constantType, "0.0");
+            case "string":
+            case "key":
+                return new Constant(p, constantType, "");
+            case "list":
+                ArgumentList al = new ArgumentList(p);
+                return new ListConstant(p, al);
+            case "vector":
+                Constant vca = new Constant(p, "float", "0.0");
+                Constant vcb = new Constant(p, "float", "0.0");
+                Constant vcc = new Constant(p, "float", "0.0");
+                ConstantExpression vcea = new ConstantExpression(p, vca);
+                ConstantExpression vceb = new ConstantExpression(p, vcb);
+                ConstantExpression vcec = new ConstantExpression(p, vcc);
+                return new VectorConstant(p, vcea, vceb, vcec);
+            case "rotation":
+                Constant rca = new Constant(p, "float", "0.0");
+                Constant rcb = new Constant(p, "float", "0.0");
+                Constant rcc = new Constant(p, "float", "0.0");
+                Constant rcd = new Constant(p, "float", "0.0");
+                ConstantExpression rcea = new ConstantExpression(p, rca);
+                ConstantExpression rceb = new ConstantExpression(p, rcb);
+                ConstantExpression rcec = new ConstantExpression(p, rcc);
+                ConstantExpression rced = new ConstantExpression(p, rcd);
+                return new RotationConstant(p, rcea, rceb, rcec, rced);
+            default:
+                return null; // this will probably break stuff
+            }
+        }
+    }
+}