urho3d/Source/Tools/BindingGenerator/ASUtils.h

//
// Copyright (c) 2008-2022 the Urho3D project.
//
// 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.
//

#pragma once

#include "XmlAnalyzer.h"

#include <map>
#include <stdexcept>
#include <string>

namespace ASBindingGenerator
{

enum class TypeUsage
{
    FunctionParameter = 0,
    FunctionReturn,
    StaticField,
    Field,
};

struct ConvertedVariable
{
    std::string asDeclaration_;
    std::string cppDeclaration_;
    std::string glue_;

    bool NeedWrapper() const { return !glue_.empty(); }
};

std::string JoinASDeclarations(const std::vector<ConvertedVariable>& vars);

enum class VariableUsage
{
    FunctionParameter = 0,
    FunctionReturn,
    StaticField,
    Field,
};

ConvertedVariable CppVariableToAS(const TypeAnalyzer& type, VariableUsage usage, const std::string& name = "", const std::string& defaultValue = "");

std::string CppTypeToAS(const TypeAnalyzer& type, TypeUsage typeUsage);

std::shared_ptr<EnumAnalyzer> FindEnum(const std::string& name);
std::string CppPrimitiveTypeToAS(const std::string& cppType);
std::string CppValueToAS(const std::string& cppValue);

class Exception : public std::runtime_error
{
    using runtime_error::runtime_error;
};

bool IsKnownCppType(const std::string& name);

std::shared_ptr<ClassAnalyzer> FindClassByName(const std::string& name);
std::shared_ptr<ClassAnalyzer> FindClassByID(const std::string& name);

std::string GenerateWrapperName(const GlobalFunctionAnalyzer& functionAnalyzer);
std::string GenerateWrapperName(const ClassStaticFunctionAnalyzer& functionAnalyzer);
std::string GenerateWrapperName(const MethodAnalyzer& methodAnalyzer, bool templateVersion = false);

std::string GenerateWrapper(const GlobalFunctionAnalyzer& functionAnalyzer, const std::vector<ConvertedVariable>& convertedParams, const ConvertedVariable& convertedReturn);
std::string GenerateWrapper(const ClassStaticFunctionAnalyzer& functionAnalyzer, bool templateVersion, const std::vector<ConvertedVariable>& convertedParams, const ConvertedVariable& convertedReturn);
std::string GenerateWrapper(const MethodAnalyzer& methodAnalyzer, bool templateVersion, const std::vector<ConvertedVariable>& convertedParams, const ConvertedVariable& convertedReturn);

std::string GenerateConstructorWrapper(const MethodAnalyzer& methodAnalyzer, const std::vector<ConvertedVariable>& convertedParams);
std::string GenerateFactoryWrapper(const MethodAnalyzer& methodAnalyzer, const std::vector<ConvertedVariable>& convertedParams);


std::string Generate_asFUNCTIONPR(const GlobalFunctionAnalyzer& functionAnalyzer);
std::string Generate_asFUNCTIONPR(const ClassStaticFunctionAnalyzer& functionAnalyzer, bool templateVersion);
std::string Generate_asMETHODPR(const MethodAnalyzer& methodAnalyzer, bool templateVersion);

}