AtomicGameEngine/Source/ToolCore/JSBind/JSBModule.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/Log.h>
#include <Atomic/IO/File.h>
#include <Atomic/IO/FileSystem.h>
#include <Atomic/Resource/JSONFile.h>

#include "Atomic/Core/ProcessUtils.h"

#include "JSBind.h"
#include "JSBPackage.h"
#include "JSBModule.h"
#include "JSBHeader.h"
#include "JSBClass.h"
#include "JSBEnum.h"
#include "JSBModuleWriter.h"
#include "JSBType.h"
#include "JSBEvent.h"

#include "JavaScript/JSModuleWriter.h"
#include "CSharp/CSModuleWriter.h"

namespace ToolCore
{

JSBModule::JSBModule(Context* context, JSBPackage* package) : Object(context),
    package_(package),
    dotNetModule_(false)
{

}

JSBModule::~JSBModule()
{

}

Vector<SharedPtr<JSBClass>> JSBModule::GetClasses(bool includeInterfaces)
{
    if (includeInterfaces)
        return classes_.Values();

    Vector<SharedPtr<JSBClass>> retValue;

    Vector<SharedPtr<JSBClass>> classes = classes_.Values();

    for (unsigned i = 0; i < classes.Size(); i++)
        if (!classes[i]->IsInterface())
            retValue.Push(classes[i]);

    return retValue;

}

Vector<SharedPtr<JSBEnum>> JSBModule::GetEnums()
{
    return enums_.Values();
}

void JSBModule::PreprocessHeaders()
{
    for (unsigned i = 0; i < headers_.Size(); i++)
    {
        headers_[i]->VisitPreprocess();
    }
}

void JSBModule::VisitHeaders()
{
    for (unsigned i = 0; i < headers_.Size(); i++)
    {
        headers_[i]->VisitHeader();
    }

    // validate that all classes found
    for (unsigned i = 0; i < classnames_.Size(); i++)
    {
        JSBClass* cls = GetClass(classnames_[i]);

        if (!cls)
        {
            ErrorExit(ToString("Module class not found %s", classnames_[i].CString()));
        }
    }

    ProcessOverloads();
    ProcessExcludes();
    ProcessClassExcludes();
    ProcessTypeScriptDecl();
    ProcessHaxeDecl();
    ProcessCSharpDecl();
}

void JSBModule::PreprocessClasses()
{
    HashMap<StringHash, SharedPtr<JSBClass> >::Iterator itr;

    for (itr = classes_.Begin(); itr != classes_.End(); itr++)
    {
        itr->second_->Preprocess();
    }
}

void JSBModule::ProcessClasses()
{
    HashMap<StringHash, SharedPtr<JSBClass> >::Iterator itr;

    for (itr = classes_.Begin(); itr != classes_.End(); itr++)
    {
        itr->second_->Process();
    }
}

void JSBModule::PostProcessClasses()
{
    HashMap<StringHash, SharedPtr<JSBClass> >::Iterator itr;

    for (itr = classes_.Begin(); itr != classes_.End(); itr++)
    {
        itr->second_->PostProcess();
    }
}

void JSBModule::ProcessOverloads()
{
    // overloads

    JSONValue& root = moduleJSON_->GetRoot();

    JSONValue overloads = root.Get("overloads");

    if (overloads.IsObject())
    {
        Vector<String> childNames = overloads.GetObject().Keys();

        for (unsigned j = 0; j < childNames.Size(); j++)
        {
            String classname = childNames.At(j);

            JSBClass* klass = GetClass(classname);

            if (!klass)
            {
                ErrorExit("Bad overload klass");
            }

            JSONValue classoverloads = overloads.Get(classname);

            Vector<String> functionNames = classoverloads.GetObject().Keys();

            for (unsigned k = 0; k < functionNames.Size(); k++)
            {
                JSONValue _sig = classoverloads.Get(functionNames[k]);

                if (!_sig.IsArray())
                {
                    ErrorExit("Bad overload definition");
                }

                JSONArray sig = _sig.GetArray();

                Vector<String> values;
                for (unsigned x = 0; x < sig.Size(); x++)
                {
                    values.Push(sig[x].GetString());
                }

                JSBFunctionSignature* fo = new JSBFunctionSignature(functionNames[k], values);
                klass->AddFunctionOverride(fo);

            }
        }
    }
}

void JSBModule::ProcessExcludes(const JSONValue& excludes, BindingLanguage language)
{
    Vector<String> childNames = excludes.GetObject().Keys();

    for (unsigned j = 0; j < childNames.Size(); j++)
    {
        String classname = childNames.At(j);

        if (classname == "CSharp")
        {
            JSONValue sharpexcludes = excludes.Get("CSharp");

            if (sharpexcludes.IsObject())
            {
                ProcessExcludes(sharpexcludes, BINDINGLANGUAGE_CSHARP);
            }

            continue;
        }

        JSBClass* klass = GetClass(classname);

        if (!klass)
        {
            ErrorExit("Bad exclude klass");
        }

        JSONValue classexcludes = excludes.Get(classname);

        Vector<String> functionNames = classexcludes.GetObject().Keys();

        for (unsigned k = 0; k < functionNames.Size(); k++)
        {
            JSONValue _sig = classexcludes.Get(functionNames[k]);

            if (!_sig.IsArray())
            {
                ErrorExit("Bad exclude defintion");
            }

            JSONArray sig = _sig.GetArray();

            Vector<String> values;
            for (unsigned x = 0; x < sig.Size(); x++)
            {
                values.Push(sig[x].GetString());
            }

            JSBFunctionSignature* fe = new JSBFunctionSignature(functionNames[k], values);
            
            if (language != BINDINGLANGUAGE_ANY)
                fe->associatedBindings_.Push(language);
            
            klass->AddFunctionExclude(fe);

        }
    }

}

void JSBModule::ProcessExcludes()
{
    // excludes

    JSONValue& root = moduleJSON_->GetRoot();

    JSONValue excludes = root.Get("excludes");

    if (excludes.IsObject())
    {
        ProcessExcludes(excludes);
    }
}

void JSBModule::ProcessClassExcludes()
{
    JSONValue& root = moduleJSON_->GetRoot();

    JSONValue excludes = root.Get("classExcludes");

    if (excludes.IsObject())
    {
        Vector<String> classes = excludes.GetObject().Keys();

        for (unsigned i = 0; i < classes.Size(); i++)
        {
            const String& classname = classes[i];

            if (!classExcludes_.Contains(classname))
            {
                classExcludes_[classname] = Vector<String>();
            }

            JSONArray platforms = excludes[classname].GetArray();

            for (unsigned j = 0; j < platforms.Size(); j++)
            {
                classExcludes_[classname].Push(platforms[j].GetString());
            }

        }

    }

}

void JSBModule::ProcessTypeScriptDecl()
{
    // TypeScript declarations

    JSONValue& root = moduleJSON_->GetRoot();

    JSONValue decl = root.Get("typescript_decl");

    if (decl.IsObject())
    {
        Vector<String> childNames = decl.GetObject().Keys();

        for (unsigned j = 0; j < childNames.Size(); j++)
        {
            String classname = childNames.At(j);

            JSBClass* klass = GetClass(classname);

            if (!klass)
            {
                ErrorExit("Bad TypeScript decl klass");
            }

            JSONArray classdecl = decl.Get(classname).GetArray();

            for (unsigned k = 0; k < classdecl.Size(); k++)
            {
                klass->AddTypeScriptDecl(classdecl[k].GetString());
            }
        }
    }
}

void JSBModule::ProcessHaxeDecl()
{
    // Haxe declarations

    JSONValue& root = moduleJSON_->GetRoot();

    JSONValue decl = root.Get("haxe_decl");

    if (decl.IsObject())
    {
        Vector<String> childNames = decl.GetObject().Keys();

        for (unsigned j = 0; j < childNames.Size(); j++)
        {
            String classname = childNames.At(j);

            JSBClass* klass = GetClass(classname);

            if (!klass)
            {
                ErrorExit("Bad Haxe decl class");
            }

            JSONArray classdecl = decl.Get(classname).GetArray();

            for (unsigned k = 0; k < classdecl.Size(); k++)
            {
                klass->AddHaxeDecl(classdecl[k].GetString());
            }
        }
    }
}

void JSBModule::ProcessCSharpDecl()
{
    // C# declarations

    JSONValue& root = moduleJSON_->GetRoot();

    JSONValue interfaceDecl = root.Get("csharp_interface_decl");

    if (interfaceDecl.IsObject())
    {
        Vector<String> childNames = interfaceDecl.GetObject().Keys();

        for (unsigned j = 0; j < childNames.Size(); j++)
        {
            String classname = childNames.At(j);

            JSBClass* klass = GetClass(classname);

            if (!klass)
            {
                ErrorExit("Bad csharp decl class");
            }

            JSONArray interfaces = interfaceDecl.Get(classname).GetArray();

            for (unsigned k = 0; k < interfaces.Size(); k++)
            {
                klass->AddCSharpInterface(interfaces[k].GetString());
            }
        }
    }

}

void JSBModule::ScanHeaders()
{
    JSBind* jsbind = GetSubsystem<JSBind>();
    FileSystem* fs = GetSubsystem<FileSystem>();

    const String& sourceRoot = jsbind->GetSourceRootFolder();

    for (unsigned i = 0; i < sourceDirs_.Size(); i++)
    {
        const String& dir = sourceRoot + sourceDirs_[i] + "/";

        Vector<String> fileNames;
        fs->ScanDir(fileNames, dir, "*.h", SCAN_FILES, false);

        for (unsigned k = 0; k < fileNames.Size(); k++)
        {
            String filepath = dir + fileNames[k];

            SharedPtr<JSBHeader> header(new JSBHeader(context_, this, filepath));

            // Parse the C++ header
            header->Parse();

            headers_.Push(header);
        }

    }

}

JSBClass* JSBModule::GetClass(const String& name, bool includeInterfaces)
{
    if (classes_.Contains(name))
    {
        JSBClass* klass = classes_[name];

        if (!includeInterfaces && klass->IsInterface())
            return 0;

        return klass;
    }

    return 0;
}

void JSBModule::RegisterClass(String name)
{
    String nativeName = name;

    if (classnames_.Contains(name) || interfaceNames_.Contains(name))
    {
        if (classRenames_.Contains(name))
        {
            name = classRenames_[name];
        }

        if (JSBPackage::GetClassAllPackages(nativeName, true))
        {
            ErrorExit(ToString("Class collision: %s", name.CString()));
        }

        bool interface = false;
        if (interfaceNames_.Contains(nativeName))
        {
            interface = true;
        }

        JSBClass* cls = new JSBClass(context_, this, name, nativeName, interface);

        if (genericClassnames_.Contains(name))
        {
            cls->SetGeneric();
        }

        classes_[nativeName] = cls;

        package_->RegisterClass(cls);
    }
}

void JSBModule::RegisterEvent(JSBEvent* event)
{
    if (JSBPackage::GetEventAllPackages(event->GetEventID(), event->GetEventName()))
    {
        ErrorExit(ToString("Event collision: %s : %s", event->GetEventID().CString(), event->GetEventName().CString()));
    }

    events_.Push(SharedPtr<JSBEvent>(event));
}

JSBEvent* JSBModule::GetEvent(const String& eventID, const String& eventName)
{
    for (unsigned i = 0; i < events_.Size(); i++)
    {
        if (events_[i]->GetEventName() == eventName || events_[i]->GetEventID() == eventID)
        {
            return events_[i];
        }
    }

    return 0;
}

const Vector<SharedPtr<JSBEvent>>& JSBModule::GetEvents()
{    
    return events_;
}

void JSBModule::RegisterEnum(JSBEnum* jenum)
{
    if (JSBPackage::GetClassAllPackages(jenum->GetName()))
    {
        ErrorExit(ToString("Enum collision: %s", jenum->GetName().CString()));
    }

    enums_[jenum->GetName()] = jenum;

}

JSBEnum* JSBModule::GetEnum(const String& name)
{
    if (enums_.Contains(name))
    {
        return enums_[name];
    }

    return 0;

}

String JSBModule::GetClassDefineGuard(const String& name, const String& language) const
{
    StringVector platforms;

    if (!classExcludes_.TryGetValue(name, platforms) || !platforms.Size())
        return String::EMPTY;

    Vector<String> defines;

    for (unsigned i = 0; i < platforms.Size(); i++)
    {
        String platform = platforms[i].ToLower();

        if (platform == "windows")
        {
            if (language == "csharp")
            {
                if (!defines.Contains("!ATOMIC_DESKTOP"))
                    defines.Push("!ATOMIC_DESKTOP");
            }
            else
            {
                defines.Push("!defined(ATOMIC_PLATFORM_WINDOWS)");
            }
            
        }
        else if (platform == "macosx")
        {
            if (language == "csharp")
            {
                if (!defines.Contains("!ATOMIC_DESKTOP"))
                    defines.Push("!ATOMIC_DESKTOP");
            }
            else
            {
                defines.Push("!defined(ATOMIC_PLATFORM_OSX)");
            }
        }
        else if (platform == "linux")
        {
            if (language == "csharp")
            {
                if (!defines.Contains("!ATOMIC_DESKTOP"))
                    defines.Push("!ATOMIC_DESKTOP");
            }
            else
            {
                defines.Push("!defined(ATOMIC_PLATFORM_LINUX)");
            }
        }
        else if (platform == "android")
        {
            if (language == "csharp")
            {
                defines.Push("!ATOMIC_ANDROID");
            }
            else
            {
                defines.Push("!defined(ATOMIC_PLATFORM_ANDROID)");
            }
        }
        else if (platform == "ios")
        {
            if (language == "csharp")
            {
                defines.Push("!ATOMIC_IOS");
            }
            else
            {
                defines.Push("!defined(ATOMIC_PLATFORM_IOS)");
            }
        }
        else if (platform == "web")
        {
            if (language == "csharp")
            {
                defines.Push("!ATOMIC_WEB");
            }
            else
            {
                defines.Push("!defined(ATOMIC_PLATFORM_WEB)");
            }
        }
        else
        {
            ATOMIC_LOGERRORF("Unknown package platform: %s", platform.CString());
        }
    }

    if (!defines.Size())
        return String::EMPTY;

    String defineString = "#if " + String::Joined(defines, " && ");

    return defineString;

}

String JSBModule::GetModuleDefineGuard() const
{
    // platform -> vector of modules
    const HashMap<String, Vector<String>>& platformExcludes = package_->GetModuleExcludes();
    HashMap<String, Vector<String>>::ConstIterator itr = platformExcludes.Begin();

    Vector<String> defines;

    while (itr != platformExcludes.End())
    {
        const String& platform = itr->first_;
        const Vector<String>& modules = itr->second_;

        for (unsigned i = 0; i < modules.Size(); i++)
        {
            if (modules[i].ToLower() == name_.ToLower())
            {
                if (platform.ToLower() == "windows")
                    defines.Push("!defined(ATOMIC_PLATFORM_WINDOWS)");
                else if (platform.ToLower() == "macosx")
                    defines.Push("!defined(ATOMIC_PLATFORM_OSX)");
                else if (platform.ToLower() == "linux")
                    defines.Push("!defined(ATOMIC_PLATFORM_LINUX)");
                else if (platform.ToLower() == "android")
                    defines.Push("!defined(ATOMIC_PLATFORM_ANDROID)");
                else if (platform.ToLower() == "ios")
                    defines.Push("!defined(ATOMIC_PLATFORM_IOS)");
                else if (platform.ToLower() == "web")
                    defines.Push("!defined(ATOMIC_PLATFORM_WEB)");
                else
                {
                    ATOMIC_LOGERRORF("Unknown package platform: %s", platform.CString());
                }

                break;
            }

        }
    
        itr++;
    }
    
    if (!defines.Size())
        return String::EMPTY;

    String defineString = "#if " + String::Joined(defines, " && ");

    return defineString;
    
}

bool JSBModule::ContainsConstant(const String& constantName)
{
    return constants_.Contains(constantName);
}

void JSBModule::RegisterConstant(const String& constantName, const String& value, unsigned type, bool isUnsigned)
{
    // MAX_CASCADE_SPLITS is defined differently for desktop/mobile
    if (constantName == "MAX_CASCADE_SPLITS" && JSBPackage::ContainsConstantAllPackages(constantName))
    {
        return;
    }

    if (JSBPackage::ContainsConstantAllPackages(constantName))
    {
        ErrorExit(ToString("Constant collision: %s", constantName.CString()));
    }

    Constant c;
    c.type = new JSBPrimitiveType(type, isUnsigned);
    c.value = value;
    constants_[constantName] = c;
}

bool JSBModule::Load(const String& jsonFilename)
{    
    ATOMIC_LOGINFOF("Loading Module: %s", jsonFilename.CString());

    JSBind* jsbind = GetSubsystem<JSBind>();

    SharedPtr<File> jsonFile(new File(context_, jsonFilename));

    if (!jsonFile->IsOpen())
    {
        ATOMIC_LOGERRORF("Unable to open module json: %s", jsonFilename.CString());
        return false;
    }

    moduleJSON_ = new JSONFile(context_);

    if (!moduleJSON_->BeginLoad(*jsonFile))
    {
        ATOMIC_LOGERRORF("Unable to parse module json: %s", jsonFilename.CString());
        return false;
    }

    JSONValue& root = moduleJSON_->GetRoot();

    name_ = root.Get("name").GetString();

    JSONValue requires = root.Get("requires");

    if (requires.IsArray())
    {
        for (unsigned j = 0; j < requires.GetArray().Size(); j++)
        {
            requirements_.Push(requires[j].GetString());
        }

    }

    JSONArray classes = root.Get("classes").GetArray();

    for (unsigned i = 0; i < classes.Size(); i++)
    {
        classnames_.Push(classes[i].GetString());
    }

    JSONArray classesGeneric = root.Get("classes_generic").GetArray();

    for (unsigned i = 0; i < classesGeneric.Size(); i++)
    {
        genericClassnames_.Push(classesGeneric[i].GetString());
    }

    JSONValue classes_rename = root.Get("classes_rename");

    if (classes_rename.IsObject())
    {
        Vector<String> childNames = classes_rename.GetObject().Keys();
        for (unsigned j = 0; j < childNames.Size(); j++)
        {
            String classname = childNames.At(j);
            String crename = classes_rename.Get(classname).GetString();
            classRenames_[classname] = crename;
        }

    }

    JSONArray interfaces = root.Get("interfaces").GetArray();

    for (unsigned i = 0; i < interfaces.Size(); i++)
    {
        interfaceNames_.Push(interfaces[i].GetString());
    }


    JSONValue includes = root.Get("includes");

    if (includes.IsArray())
    {
        for (unsigned j = 0; j < includes.GetArray().Size(); j++)
        {
            includes_.Push(includes.GetArray()[j].GetString());

        }
    }

    JSONValue jsmodulepreamble = root.Get("jsmodulepreamble");

    if (jsmodulepreamble.IsArray())
    {
        for (unsigned j = 0; j < jsmodulepreamble.GetArray().Size(); j++)
        {
            jsmodulePreamble_.Push(jsmodulepreamble.GetArray()[j].GetString());
        }
    }

    JSONValue sources = root.Get("sources");

    for (unsigned i = 0; i < sources.GetArray().Size(); i++)
    {
        sourceDirs_.Push(sources.GetArray()[i].GetString());
    }

    ScanHeaders();

    return true;
}

}