AtomicGameEngine/Source/ToolCore/JSBind/CSharp/CSModuleWriter.cpp

//
// Copyright (c) 2014-2016 THUNDERBEAST GAMES LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#include <Atomic/IO/File.h>
#include <Atomic/IO/FileSystem.h>

#include "../JSBind.h"
#include "../JSBPackage.h"
#include "../JSBModule.h"
#include "../JSBEnum.h"
#include "../JSBClass.h"
#include "../JSBFunction.h"
#include "../JSBEvent.h"

#include "CSTypeHelper.h"
#include "CSClassWriter.h"
#include "CSModuleWriter.h"

namespace ToolCore
{

CSModuleWriter::CSModuleWriter(JSBModule *module) : JSBModuleWriter(module)
{

}

void CSModuleWriter::WriteIncludes(String& source)
{

    Vector<String>& includes = module_->includes_;
    for (unsigned i = 0; i < includes.Size(); i++)
    {
        if (includes[i].StartsWith("<"))
            source.AppendWithFormat("#include %s\n", includes[i].CString());
        else
            source.AppendWithFormat("#include \"%s\"\n", includes[i].CString());
    }

    Vector<JSBHeader*> allheaders;

    HashMap<StringHash, SharedPtr<JSBEnum> >::Iterator eitr = module_->enums_.Begin();
    while (eitr != module_->enums_.End())
    {
        allheaders.Push(eitr->second_->GetHeader());
        eitr++;
    }

    Vector<SharedPtr<JSBClass>> classes = module_->GetClasses();

    Vector<SharedPtr<JSBClass>>::Iterator citr = classes.Begin();
    while (citr != classes.End())
    {
        allheaders.Push((*citr)->GetHeader());
        citr++;
    }

    Vector<JSBHeader*> included;

    for (unsigned i = 0; i < allheaders.Size(); i++)
    {
        JSBHeader* header = allheaders.At(i);

        if (included.Contains(header))
            continue;

        String headerPath = GetPath(header->GetFilePath());

        String headerfile = GetFileNameAndExtension(header->GetFilePath());

        JSBind* jsbind = header->GetSubsystem<JSBind>();

        headerPath.Replace(jsbind->GetSourceRootFolder() + "Source/", "");

        source.AppendWithFormat("#include <%s%s>\n", headerPath.CString(), headerfile.CString());

        included.Push(header);
    }

    source += "\n#include <Atomic/Script/ScriptVector.h>\n";

    source += ToString("\n#include \"CSPackage%s.h\"\n", module_->GetPackage()->GetName().CString());

}

void CSModuleWriter::GenerateNativeSource()
{
    String source = "// This file was autogenerated by JSBind, changes will be lost\n";

    String moduleGuard = module_->GetModuleDefineGuard();

    if (moduleGuard.Length())
    {
        source += ToString("\n%s\n", moduleGuard.CString());
    }

    source += "#ifdef ATOMIC_PLATFORM_WINDOWS\n";

    source += "#pragma warning(disable: 4244) // possible loss of data\n";

    source += "#define ATOMIC_EXPORT_API __declspec(dllexport)\n";

    source += "#else\n";

    source += "#define ATOMIC_EXPORT_API\n";

    source += "#endif\n";

    if (module_->Requires("3D"))
    {
        source += "#ifdef ATOMIC_3D\n";
    }

    WriteIncludes(source);

    // NOTE: We include Deserializer/Serializer here as they are interfaces
    // If additional interfaces are introduced, consider generalizing this
    source += "\n#include <Atomic/IO/Deserializer.h>\n";
    source += "#include <Atomic/IO/Serializer.h>\n";
    source += "#include <AtomicNET/NETNative/NETCore.h>\n";

    String ns = module_->GetPackage()->GetNamespace();

    source += "\n\nusing namespace " + ns + ";\n\n";

    source += "\n\nextern \"C\" \n{\n \n";

    source += "// Begin Class Declarations\n";

    source += "// End Class Declarations\n\n";

    source += "// Begin Classes\n";

    Vector<SharedPtr<JSBClass>> classes = module_->GetClasses();

    for (unsigned i = 0; i < classes.Size(); i++)
    {

        String classGuard = module_->GetClassDefineGuard(classes[i]->GetNativeName());

        if (classGuard.Length())
        {
            source += ToString("\n%s\n\n", classGuard.CString());
        }

        CSClassWriter clsWriter(classes[i]);
        clsWriter.GenerateNativeSource(source);

        if (classGuard.Length())
        {
            source += "#endif\n\n";
        }

    }

    source += "// End Classes\n\n";

    // end Atomic namespace
    source += "\n}\n";

    if (module_->Requires("3D"))
    {
        source += "#endif //ATOMIC_3D\n";
    }

    if (moduleGuard.Length())
    {
        source += "\n#endif\n";
    }

    JSBind* jsbind = module_->GetSubsystem<JSBind>();

    String filepath = jsbind->GetDestNativeFolder() + "/CSModule" + module_->name_ + ".cpp";

    File file(module_->GetContext());
    file.Open(filepath, FILE_WRITE);
    file.Write(source.CString(), source.Length());
    file.Close();

}

String CSModuleWriter::GetManagedPrimitiveType(JSBPrimitiveType* ptype)
{
    if (ptype->kind_ == JSBPrimitiveType::Bool)
        return "bool";
    if (ptype->kind_ == JSBPrimitiveType::Int && ptype->isUnsigned_)
        return "uint";
    else if (ptype->kind_ == JSBPrimitiveType::Int)
        return "int";
    if (ptype->kind_ == JSBPrimitiveType::Float)
        return "float";

    return "int";
}

void CSModuleWriter::GenerateManagedClasses(String& source)
{

    Vector<SharedPtr<JSBClass>> classes = module_->GetClasses();

    for (unsigned i = 0; i < classes.Size(); i++)
    {
        JSBClass* klass = classes.At(i);

        if (klass->IsNumberArray())
            continue;

        CSClassWriter clsWriter(klass);
        clsWriter.GenerateManagedSource(source);

    }

}

void CSModuleWriter::GenerateManagedEnumsAndConstants(String& source)
{
    Vector<SharedPtr<JSBEnum>> enums = module_->enums_.Values();

    Indent();

    for (unsigned i = 0; i < enums.Size(); i++)
    {
        JSBEnum* jenum = enums[i];

        source += "\n";
        String line = "public enum " + jenum->GetName() + "\n";
        source += IndentLine(line);
        source += IndentLine("{\n");

        HashMap<String, String>& values = jenum->GetValues();

        HashMap<String, String>::ConstIterator itr = values.Begin();

        Indent();

        while (itr != values.End())
        {
            String name = (*itr).first_;
            String value = (*itr).second_;

            // BodyType2D enum order is assigned in RigidBody2D.h in incorrect order
            if (jenum->GetName() == "BodyType2D")
            {                 
                if (name == "BT_STATIC")
                    value = "0";
                else if (name == "BT_KINEMATIC")
                    value = "1";
                else if (name == "BT_DYNAMIC")
                    value = "2";
            }

            if (value.Length())
            {
                line = name + " = " + value;
            }
            else
            {
                line = name;
            }

            itr++;

            if (itr != values.End())
                line += ",";

            line += "\n";

            source += IndentLine(line);

        }

        Dedent();

        source += IndentLine("}\n");

    }

    // constants

    HashMap<String, JSBModule::Constant>& constants = module_->GetConstants();

    if (constants.Size())
    {

        source += "\n";

        String line = "public static partial class Constants\n";
        source += IndentLine(line);
        source += IndentLine("{\n");

        const Vector<String>& constantsName = constants.Keys();

        Indent();

        for (unsigned i = 0; i < constantsName.Size(); i++)
        {
            const String& cname = constantsName.At(i);

            JSBModule::Constant& constant = constants[cname];

            String managedType = GetManagedPrimitiveType(constant.type);

            String value = constant.value;

            if (!value.Length())
                continue;

            //static const unsigned M_MIN_UNSIGNED = 0x00000000;
//            /static const unsigned M_MAX_UNSIGNED = 0xffffffff;

            if (cname == "M_MIN_INT")
                value = "int.MinValue";

            if (cname == "M_INFINITY")
                value = "float.MaxValue";

            if (value == "M_MAX_UNSIGNED")
                value = "0xffffffff";

            // Input stuff

            if (module_->GetName() == "Input")
            {
                if (cname.StartsWith("KEY_"))
                {
                    if (value.Length() == 1 && (IsAlpha(value[0]) || IsDigit(value[0])))
                        value = "'" + value + "'";
                }

                // https://raw.githubusercontent.com/flibitijibibo/SDL2-CS/master/src/SDL2.cs

                if (value.StartsWith("SDL_BUTTON_") || value.StartsWith("SDL_HAT_"))
                {
                    value = "(int) SDL." + value;
                }
                else if (value.StartsWith("SDLK_"))
                {
                    value = "(int) SDL.SDL_Keycode." + value;
                }
                else if (value.StartsWith("SDL_SCANCODE_"))
                {
                    value = "(int) SDL.SDL_Scancode." + value;
                }
                else if (value.StartsWith("SDL_CONTROLLER_BUTTON_"))
                {
                    value = "(int) SDL.SDL_GameControllerButton." + value;
                }
                else if (value.StartsWith("SDL_CONTROLLER_AXIS_"))
                {
                    value = "(int) SDL.SDL_GameControllerAxis." + value;
                }
            }

            String line = "public const " + managedType + " " + cname + " = " + value;

            if (managedType == "float" && !line.EndsWith("f") && IsDigit(line[line.Length()-1]))
                line += "f";

            line += ";\n";

            source += IndentLine(line);

        }

        Dedent();

        source += "\n";
        line = "}\n";
        source += IndentLine(line);

    }

    source += "\n";

    Dedent();

}

void CSModuleWriter::GenerateManagedNativeEvents(String& sourceOut)
{
    Indent();

    String source;

    const Vector<SharedPtr<JSBEvent>>& events = module_->GetEvents();

    for (unsigned i = 0; i < events.Size(); i++)
    {
        JSBEvent* event = events[i];

        const String& eventID = event->GetEventID();

        String line = ToString("public partial class %s : NativeEventData\n", event->GetScriptEventName().CString());

        source += IndentLine(line);

        source += IndentLine("{\n\n");

        Indent();

        // parameters

        const Vector<JSBEvent::EventParam>& params = event->GetParameters();

        for (unsigned j = 0; j < params.Size(); j++)
        {
            const JSBEvent::EventParam& p = params[j];

            JSBClass* cls = JSBPackage::GetClassAllPackages(p.typeInfo_);

            String typeName = p.typeInfo_;
            String enumTypeName = p.enumTypeName_;

            if (!cls)
                typeName = typeName.ToLower();
            else
                typeName = cls->GetName();

            if (typeName == "int" || typeName == "float" ||
                typeName == "bool" || typeName == "string" || typeName == "enum" || cls)
            {

                bool isEnum = false;
                if (typeName == "enum")
                {   
                    isEnum = true;
                    if (enumTypeName.Length())
                        typeName = enumTypeName;
                    else
                        typeName = "int";
                }

                line = "public " + typeName + " " + p.paramName_ + "\n";
                source += IndentLine(line);
                source += IndentLine("{\n");

                Indent();

                source += IndentLine("get\n");
                source += IndentLine("{\n");

                Indent();

                line = "return ";

                if (typeName == "int")
                    line += "scriptMap.GetInt";
                else if (isEnum)
                {
                    line += ToString("(%s) scriptMap.GetInt", typeName.CString());
                }
                else if (typeName == "float")
                    line += "scriptMap.GetFloat";
                else if (typeName == "bool")
                    line += "scriptMap.GetBool";
                else if (typeName == "string")
                    line += "scriptMap.GetString";
                else if (cls)
                {
                    if (typeName == "Vector3")
                    {
                        line += "scriptMap.Get" + typeName;
                    }
                    else
                    {
                        line += ToString("scriptMap.GetPtr<%s>", cls->GetName().CString());
                    }
                    
                }

                line += ToString("(\"%s\");\n", p.paramName_.CString());
                source += IndentLine(line);

                Dedent();

                source += IndentLine("}\n");

                Dedent();

                source += IndentLine("}\n\n");

            }

        }

        Dedent();

        source += IndentLine("}\n\n");

    }


    sourceOut += source;

    Dedent();
}

void CSModuleWriter::GenerateManagedModuleClass(String& sourceOut)
{
    Indent();

    String source;
    String line = ToString("public static partial class %sModule\n", module_->GetName().CString());

    source += IndentLine(line);

    source += IndentLine("{\n");

    Indent();

    source += IndentLine("public static void Initialize()\n");

    source += IndentLine("{\n");

    Indent();

    Vector<SharedPtr<JSBClass>> classes = module_->GetClasses();

    for (unsigned i = 0; i < classes.Size(); i++)
    {
        JSBClass* klass = classes.At(i);
        JSBPackage* package = module_->GetPackage();

        if (klass->IsNumberArray() || klass->IsAbstract())
            continue;

        const char* className = klass->GetName().CString();

        String classGuard = module_->GetClassDefineGuard(classes[i]->GetNativeName(), "csharp");

        if (classGuard.Length())
        {
            source += ToString("\n%s\n", classGuard.CString());
        }

        line = ToString("new NativeType(%s.csb_%s_%s_GetClassIDStatic (), ", className, package->GetName().CString(), className);
        line += ToString("typeof(%s), (IntPtr x) => { return new %s (x); } );\n",className, className);

        source += IndentLine(line);

        if (classGuard.Length())
        {
            source += ToString("#endif\n", classGuard.CString());
        }


    }

    source += "\n";

    // Native Events
    const Vector<SharedPtr<JSBEvent>>& events = module_->GetEvents();

    for (unsigned i = 0; i < events.Size(); i++)
    {
        JSBEvent* event = events[i];

        line = ToString("NativeEvents.RegisterEventID<%s>(\"%s\");\n", event->GetScriptEventName().CString(), event->GetEventName().CString());
        source += IndentLine(line);
    }

    Dedent();

    source += IndentLine("}\n");

    Dedent();

    source += IndentLine("}\n");

    sourceOut += source;

    Dedent();
}

void CSModuleWriter::GenerateManagedSource()
{
    String source = "// Autogenerated";

    String moduleName = module_->GetPackage()->GetNamespace();

    source += "\nusing System;\nusing System.Collections.Generic;\nusing System.Runtime.InteropServices;\nusing static System.Reflection.IntrospectionExtensions;\n";

    if (moduleName == "Atomic")
        moduleName = "AtomicEngine";

    if (moduleName != "AtomicEngine")
    {
        source += "using AtomicEngine;\n";
    }

    source += "\n\n";

    source += "namespace " + moduleName + "\n";
    source += "{\n";

    GenerateManagedEnumsAndConstants(source);
    GenerateManagedNativeEvents(source);
    GenerateManagedModuleClass(source);
    GenerateManagedClasses(source);

    source += "}\n";


    JSBind* jsbind = module_->GetSubsystem<JSBind>();
    String filepath = jsbind->GetDestScriptFolder() + "/CSModule" + module_->name_ + ".cs";

    File file(module_->GetContext());
    file.Open(filepath, FILE_WRITE);
    file.Write(source.CString(), source.Length());
    file.Close();

}

void CSModuleWriter::GenerateSource()
{
    GenerateNativeSource();
    GenerateManagedSource();
}

}