Generator.cs

#pragma warning disable CS1587
#pragma warning disable CS1573
#pragma warning disable CS1591

using System;
using System.IO;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace RDFWrappers
{
    class Generator
    {
        /// <summary>
        /// 
        /// </summary>
        const string KWD_PREPROC = "//##";

        const string KWD_NAMESPACE = "NAMESPACE_NAME";
        const string KWD_CLASS_NAME = "CLASS_NAME";
        const string KWD_BASE_CLASS = "/*BASE CLASS*/Instance";
        const string KWD_PROPERTIES_OF = "PROPERTIES_OF_CLASS";
        const string KWD_PROPERTY_NAME = "PROPERTY_NAME";
        const string KWD_DATA_TYPE = "double";
        const string KWD_CARDINALITY_MIN = "CARDINALITY_MIN";
        const string KWD_CARDINALITY_MAX = "CARDINALITY_MAX";
        const string KWD_OBJECT_TYPE = "Instance";
        const string KWD_asType = "asTYPE";
        const string KWD_SUFIX = "_sufix";

        /// <summary>
        /// 
        /// </summary>
        enum Template
        { 
            None,
            BeginFile,
            ClassForwardDeclaration,
            BeginAllClasses,
            BeginWrapperClass,
            StartPropertiesBlock,
            SetDataProperty,
            SetDataArrayProperty,
            GetDataProperty,
            GetDataArrayProperty,
            SetObjectProperty,
            SetObjectArrayProperty,
            GetObjectProperty,
            GetObjectArrayProperty,
            GetObjectArrayPropertyInt64,
            EndWrapperClass,
            EndFile
        }

        /// <summary>
        /// 
        /// </summary>
        bool m_cs; //cs or cpp
        string m_TInt64;
        string m_namespace;

        Schema m_schema;

        Dictionary<Template, string> m_template = new Dictionary<Template, string>();

        Dictionary<string, string> m_replacements;

        HashSet<string> m_generatedClasses;

        HashSet<string> m_addedProperties;

        /// <summary>
        /// 
        /// </summary>
        /// <param name="schema"></param>
        /// <param name="cs"></param>
        public Generator (Schema schema, bool cs, string namespace_)
        {
            m_cs = cs;            
            m_TInt64 = m_cs ? "Int64" : "int64_t";
            m_namespace = namespace_;

            m_schema = schema;

            foreach (var template in Enum.GetValues(Template.BeginFile.GetType ()))
            {
                m_template.Add((Template)template, "");
            }

            ParseTemplate();
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="outputFile"></param>
        public void WriteWrapper(string outputFile)
        {
            m_generatedClasses = new HashSet<string>();

            using (var writer = new StreamWriter(outputFile))
            {
                m_replacements = new Dictionary<string, string>();
                m_replacements[KWD_NAMESPACE] = m_namespace;

                WriteByTemplate(writer, Template.BeginFile);

                //
                // write forward declarationa
                //
                foreach (var cls in m_schema.m_classes)
                {
                    m_replacements[KWD_CLASS_NAME] = cls.Key;
                    WriteByTemplate(writer, Template.ClassForwardDeclaration);
                }

                //
                // write class definitions
                //
                writer.Write(m_template[Template.BeginAllClasses]);

                foreach (var cls in m_schema.m_classes)
                {
                    WriteClassWrapper(writer, cls.Key, cls.Value);
                }

                //
                writer.Write(m_template[Template.EndFile]);
            }
        }


        /// <summary>
        /// 
        /// </summary>
        /// <param name="writer"></param>
        /// <param name="clsName"></param>
        /// <param name="cls"></param>
        private void WriteClassWrapper (StreamWriter writer, string clsName, Schema.Class cls)
        {
            if (!m_generatedClasses.Add (clsName))
            {
                return;
            }

            if (!m_cs) //c++ requires base classes defined first
            {
                foreach (var parentId in cls.parents)
                {
                    var parentName = m_schema.GetNameOfClass(parentId);
                    WriteClassWrapper(writer, parentName, m_schema.m_classes[parentName]);
                }
            }

            clsName = ValidateIdentifier(clsName);

            m_addedProperties = new HashSet<string>();
            m_replacements = new Dictionary<string, string>();

            //
            //
            m_replacements.Add(KWD_CLASS_NAME, clsName);

            //
            //
            var baseClass = "Instance";
            
            //first parent is the base class
            var itParent = cls.parents.GetEnumerator();
            if (itParent.MoveNext())
            {
                var parentId = itParent.Current;
                baseClass = m_schema.GetNameOfClass(parentId);
                baseClass = ValidateIdentifier(baseClass);

                //gather base classes properties to avoid override here
                CollectParentProperties(parentId);
            }

            m_replacements[KWD_BASE_CLASS] = baseClass;

            //
            //
            WriteByTemplate(writer, Template.BeginWrapperClass);

            //
            //
            WriteProperties(writer, clsName, cls.properties);

            //
            // only single inheritance is suppirted, dirrectly take properties from othe parents
            while (itParent.MoveNext())
            {
                WriteParentProperties(writer, itParent.Current);
            }

            //
            //
            WriteByTemplate(writer,Template.EndWrapperClass);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="parentId"></param>
        private void CollectParentProperties(Int64 parentId)
        {
            string parentName = m_schema.GetNameOfClass(parentId);
            var parentClass = m_schema.m_classes[parentName];

            foreach (var cp in parentClass.properties)
            {
                m_addedProperties.Add(cp.name);
            }

            foreach (var nextParent in parentClass.parents)
            {
                CollectParentProperties(nextParent);
            }
        }

        private void WriteByTemplate(StreamWriter writer, Template template)
        {
            string code = m_template[template];

            foreach (var r in m_replacements)
            {
                if (r.Key.Equals(KWD_asType) || r.Key.Equals(KWD_PROPERTY_NAME))
                {
                    code = code.Replace(r.Key, r.Value, true, null); //ignore case
                }
                else 
                {
                    code = code.Replace(r.Key, r.Value);
                }
            }

            if (m_cs)
            {
                code = code.Replace("string?", "string"); //warning CS8632: The annotation for nullable reference types should only be used in code within a '#nullable' annotations context.
            }
            else
            {
                code = code.Replace("const const", "const");
            }

            writer.Write(code);
        }

        /// <summary>
        /// 
        /// </summary>
        private void WriteParentProperties (StreamWriter writer, Int64 parentClassId)
        {
            string parentName = m_schema.GetNameOfClass(parentClassId);
            var parentClass = m_schema.m_classes[parentName];

            WriteProperties(writer, parentName, parentClass.properties);
            
            foreach (var nextParent in parentClass.parents)
            {
                WriteParentProperties(writer, nextParent);
            }
        }

        /// <summary>
        /// 
        /// </summary>
        private void WriteProperties (StreamWriter writer, string properiesOfClass, List<Schema.ClassProperty> properties)
        {
            m_replacements[KWD_PROPERTIES_OF] = properiesOfClass;

            bool first = true;
            foreach (var prop in properties)
            {
                if (m_addedProperties.Add (prop.name))
                {
                    if (first)
                    {
                        WriteByTemplate(writer, Template.StartPropertiesBlock);
                        first = false;
                    }

                    WritePropertyMethods(writer, prop);
                }
            }
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="writer"></param>
        /// <param name="classProp"></param>
        private void WritePropertyMethods (StreamWriter writer, Schema.ClassProperty classProp)
        {
            var prop = m_schema.m_properties[classProp.name];

            var propName = classProp.name;
            m_replacements[KWD_PROPERTY_NAME] = propName;
            m_replacements[KWD_DATA_TYPE] = prop.DataType(m_cs);
            m_replacements[KWD_CARDINALITY_MIN] = classProp.min.ToString();
            m_replacements[KWD_CARDINALITY_MAX] = classProp.max.ToString();
            m_replacements[KWD_asType] = "";
            m_replacements[KWD_SUFIX] = "";
            
            if (m_cs && propName == "object")
                {
                m_replacements[KWD_SUFIX] = "_";
                }

            if (!prop.IsObject())
            {
                if (classProp.max == 1)
                {
                    WriteByTemplate(writer, Template.SetDataProperty);
                    WriteByTemplate(writer, Template.GetDataProperty);
                }
                else
                {
                    WriteByTemplate(writer, Template.SetDataArrayProperty);
                    WriteByTemplate(writer, Template.GetDataArrayProperty);
                }

            }
            else
            {
                if (classProp.max == 1)
                {
                    WriteSetObjectProperty(writer, prop, Template.SetObjectProperty);
                    //do we need this? we lose restrictions control! WriteAccessObjectProperty(writer, classProp.name, TInt64, "", Template.SetObjectProperty);
                    WriteGetObjectProperty(writer, prop, Template.GetObjectProperty);
                }
                else
                {
                    WriteSetObjectProperty(writer, prop, Template.SetObjectArrayProperty);
                    WriteAccessObjectProperty(writer, m_TInt64, "", Template.SetObjectArrayProperty);

                    WriteGetObjectProperty(writer, prop, Template.GetObjectArrayProperty);
                    WriteAccessObjectProperty(writer, m_TInt64, "", Template.GetObjectArrayPropertyInt64);
                }

            }
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="writer"></param>
        /// <param name="prop"></param>
        /// <param name="template"></param>
        private void WriteSetObjectProperty(StreamWriter writer, Schema.Property prop, Template template)
            {
            int cnt = prop.resrtictions.Count;
            if (cnt > 0)
                {
                Verify(cnt == 1, "This case was not tested yet: more then one restriction for 1-cardinality object property - needs handling for C#");
                foreach (var restr in prop.resrtictions)
                    {
                    string instClass = m_schema.GetNameOfClass(restr);
                    WriteAccessObjectProperty(writer, instClass, "", template);
                    }
                }
            else
                {
                Verify(false, "This case was not tested yet: no restriction");
                WriteAccessObjectProperty(writer, "Instance", "", template);
                }
            }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="writer"></param>
        /// <param name="prop"></param>
        /// <param name="template"></param>
        private void WriteGetObjectProperty(StreamWriter writer, Schema.Property prop, Template template)
            {
            int cnt = prop.resrtictions.Count;
            if (cnt > 0)
                {
                Verify(cnt == 1, "This case was not tested yet: more then one restriction for 1-cardinality object property - needs handling for C#");
                foreach (var restr in prop.resrtictions)
                    {
                    string instClass = m_schema.GetNameOfClass(restr);
                    WriteAccessObjectProperty(writer, instClass, "", template);
                    }
                }
            else
                {
                Verify(false, "This case was not tested yet: no restriction");
                WriteAccessObjectProperty(writer, "Instance", "", template);
                }
            }



        /// <summary>
        /// 
        /// </summary>
        /// <param name="writer"></param>
        /// <param name="objectType"></param>
        /// <param name="asType"></param>
        /// <param name="template"></param>
        private void WriteAccessObjectProperty(StreamWriter writer, string objectType, string asType, Template template)
        {
            m_replacements[KWD_OBJECT_TYPE] = objectType;
            m_replacements[KWD_asType] = asType;
            WriteByTemplate(writer, template);
        }


        /// <summary>
        /// 
        /// </summary>
        private void ParseTemplate()
        {
            System.Reflection.Assembly assembly = System.Reflection.Assembly.GetCallingAssembly();

            var templateName = m_cs ? "EngineEx_Template.cs" : "EngineEx_Template.h";

            string resourceName = FormatResourceName(assembly, templateName);

            using (Stream stream = assembly.GetManifestResourceStream(resourceName))
            {
                Verify(stream != null, "Failed get resource " + resourceName);
                using (StreamReader reader = new StreamReader(stream)) //to read from file use new StreamReader(templateFile))
                {
                    Verify(reader != null, "Failed create stream reader for " + templateName);
                    Template part = Template.BeginFile;
                    int nline = 0;
                    string line;
                    while ((line = reader.ReadLine()) != null)
                    {
                        nline++;

                        if (line.Contains(KWD_PREPROC))
                        {
                            part++;
                            Verify(line.Contains(part.ToString()), string.Format("Expected line {0} contains '{1}' substing while parsing template fle {2}", nline, part.ToString(), templateName));
                        }
                        else
                        {
                            string str = m_template[part];
                            str = str + line + "\r\n";
                            m_template[part] = str;
                        }
                    }
                }
            }
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="assembly"></param>
        /// <param name="resourceName"></param>
        /// <returns></returns>
        private static string FormatResourceName(System.Reflection.Assembly assembly, string resourceName)
        {
            return assembly.GetName().Name + "." + resourceName.Replace(" ", "_").Replace("\\", ".").Replace("/", ".");
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="condition"></param>
        /// <param name="exceptionMsg"></param>
        public static void Verify (bool condition, string exceptionMsg)
        {
            System.Diagnostics.Trace.Assert(condition);
            if (!condition)
            {
                throw new ApplicationException(exceptionMsg);
            }
        }

        public static string ValidateIdentifier (string name)
        {
            using (var codeProvider = System.CodeDom.Compiler.CodeDomProvider.CreateProvider("C#"))
            {
                
                if (!codeProvider.IsValidIdentifier(name))
                {
                    //does not work as expected, var id = codeProvider.CreateValidIdentifier(name);
                    bool first = true;
                    var builder = new System.Text.StringBuilder();
                    foreach (var ch in name)
                    {
                        if (first && char.IsLetter(ch) || !first && char.IsLetterOrDigit(ch))
                        {
                            //fits
                            builder.Append(ch);
                        }
                        else
                        {
                            //replace
                            builder.Append("_R");
                            builder.Append(((byte)ch).ToString());
                            builder.Append("R_");
                        }

                        first = false;
                    }

                    var id = builder.ToString();

                    Console.Write("!!!  {0} is not a valid identifier, changed to {1}", name, id);
                    return id;
                }
                else
                {
                    return name;
                }
            }
        }
    }
}