TypeRepository.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2004-2015 (http://safirsdkcore.com)
*
* Created by: Joel Ottosson / joot
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more Internals.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
#ifndef __DOTS_INTERNAL_TYPE_REPOSITORY_H__
#define __DOTS_INTERNAL_TYPE_REPOSITORY_H__
 
#include <set>
#include <map>
#include <string>
#include <Safir/Dob/Typesystem/LanguageInterfaceDefs.h>
#include <Safir/Utilities/Internal/Id.h>
 
namespace Safir
{
namespace Dob
{
namespace Typesystem
{
namespace ToolSupport
{
    //forward declarations
    template <class T> struct TypeRepositoryTraits;
    class ClassDescription;
    class MemberDescription;
 
    class PropertyDescription
    {
    public:
        virtual ~PropertyDescription() = default;
 
        virtual const char* FileName() const=0;
 
        virtual const char* Summary() const=0;
 
        virtual DotsC_TypeId GetTypeId() const=0;
 
        virtual const char* GetName() const=0;
 
        virtual int GetNumberOfMembers() const=0;
 
        virtual DotsC_MemberIndex GetMemberIndex(const std::string& memberName) const=0;
 
        virtual const MemberDescription* GetMember(DotsC_MemberIndex index) const=0;
    };
 
    class ExceptionDescription
    {
    public:
        virtual ~ExceptionDescription() = default;
 
        virtual const char* FileName() const=0;
 
        virtual const char* Summary() const=0;
 
        virtual DotsC_TypeId GetTypeId() const=0;
 
        virtual const char* GetName() const=0;
 
        virtual const ExceptionDescription* GetBaseClass() const=0;
    };
 
    class ParameterDescription
    {
    public:
        virtual ~ParameterDescription() = default;
 
        virtual const char* Summary() const=0;
 
        virtual const char* GetName() const=0; //get the parameter name, no namespace and class name: MyParameter
 
        virtual DotsC_TypeId GetClassTypeId() const=0;
 
        virtual const char* GetQualifiedName() const=0;
 
        virtual DotsC_MemberType GetMemberType() const=0;
 
        virtual DotsC_TypeId GetTypeId() const=0;
 
        virtual DotsC_CollectionType GetCollectionType() const=0;
 
        virtual DotsC_MemberType GetKeyType() const=0; //only valid if collectionType is Dictionary
 
        virtual DotsC_TypeId GetKeyTypeId() const=0;
 
        virtual int GetNumberOfValues() const=0;
 
        virtual bool IsHidden() const=0;
 
        //Get parameter values - depending on actual type of the parameter
        //For entityId use GetInt64Value for typeId and GetHashedValue for instanceId
 
        virtual DotsC_Int32 GetInt32Value(int index) const=0; //int32, enum
 
        virtual DotsC_Int64 GetInt64Value(int index) const=0; //int64, typeId
 
        virtual DotsC_Float32 GetFloat32Value(int index) const=0; //float32, si32
 
        virtual DotsC_Float64 GetFloat64Value(int index) const=0; //float64, si64
 
        virtual bool GetBoolValue(int index) const=0;
 
        virtual const char* GetStringValue(int index) const=0;
 
        virtual std::pair<const char*, DotsC_Int32> GetObjectValue(int index) const=0;
 
        virtual std::pair<const char*, DotsC_Int32> GetBinaryValue(int index) const=0;
 
        virtual std::pair<DotsC_Int64, const char*> GetHashedValue(int index) const=0; //instanceId, channelId, handlerId
 
        virtual DotsC_Int32 GetInt32Key(int index) const=0;
 
        virtual DotsC_Int64 GetInt64Key(int index) const=0;
 
        virtual const char* GetStringKey(int index) const=0;
 
        virtual std::pair<DotsC_Int64, const char*> GetHashedKey(int index) const=0; //instanceId, channelId, handlerId
 
        virtual int GetIndexByUnifiedKey(DotsC_Int64 unifiedKey) const=0;
 
        virtual const std::map<DotsC_Int64, int>& UnifiedKeyToIndexMap() const=0;
    };
 
    class EnumDescription
    {
    public:
        virtual ~EnumDescription() = default;
 
        virtual const char* FileName() const=0;
 
        virtual const char* Summary() const=0;
 
        virtual DotsC_TypeId GetTypeId() const=0;
 
        virtual const char* GetName() const=0;
 
        virtual DotsC_TypeId GetChecksum() const=0;
 
        virtual int GetNumberOfValues() const=0;
 
        virtual const char* GetValueName(DotsC_EnumerationValue val) const=0;
 
        virtual int GetIndexOfValue(const std::string& valueName) const=0;
    };
 
    class MemberDescription
    {
    public:
        virtual ~MemberDescription() = default;
 
        virtual const char* Summary() const=0;
 
        virtual DotsC_TypeId GetTypeId() const=0;
 
        virtual const char* GetName() const=0;
 
        virtual DotsC_MemberType GetMemberType() const=0;
 
        virtual DotsC_CollectionType GetCollectionType() const=0;
 
        virtual DotsC_MemberType GetKeyType() const=0; //only valid if collectionType is Dictionary
 
        virtual DotsC_TypeId GetKeyTypeId() const=0;
 
        virtual int GetArraySize() const=0;
 
        virtual int GetMaxLength() const=0;
    };
 
    class MemberMappingDescription
    {
    public:
        virtual ~MemberMappingDescription() = default;
 
        virtual DotsC_PropertyMappingKind GetMappingKind() const=0;
 
        virtual std::pair<const ParameterDescription*, int /*paramIndex*/> GetParameter() const=0;
 
        //if mapped to member
        virtual int MemberReferenceDepth() const=0;
 
        virtual std::pair<DotsC_MemberIndex, DotsC_Int32> GetMemberReference(int depth) const=0;
    };
 
    class PropertyMappingDescription
    {
    public:
        virtual ~PropertyMappingDescription() = default;
 
        virtual const char* FileName() const=0;
 
        virtual const char* Summary() const=0;
 
        virtual const PropertyDescription* GetProperty() const=0;
 
        virtual const ClassDescription* GetClass() const=0;
 
        virtual const MemberMappingDescription* GetMemberMapping(int propertyMemberIndex) const=0;
    };
 
    class CreateRoutineDescription
    {
    public:
        virtual ~CreateRoutineDescription() = default;
 
        virtual const char* Summary() const=0;
 
        virtual const char* GetName() const=0;
 
        virtual int GetNumberOfInParameters() const=0;
 
        virtual const MemberDescription* GetInParameterMember(int index) const=0;
 
        virtual int GetNumberOfDefaultValues() const=0;
 
        virtual const MemberDescription* GetDefaultValueMember(int index) const=0;
 
        virtual std::pair<const ParameterDescription*, int /*paramIndex*/> GetDefaultValue(int index) const=0;
    };
 
    class ClassDescription
    {
    public:
        virtual ~ClassDescription() = default;
 
        virtual const char* FileName() const=0;
 
        virtual const char* Summary() const=0;
 
        virtual DotsC_TypeId GetTypeId() const=0;
 
        virtual const char* GetName() const=0;
 
        virtual const ClassDescription* GetBaseClass() const=0;
 
        virtual int GetNumberOfDescendants() const=0;
 
        virtual const ClassDescription* GetDescendant(int index) const=0;
 
        virtual int GetNumberOfMembers() const=0;
 
        virtual int GetNumberOfOwnMembers() const=0;
 
        virtual int GetNumberOfInheritedMembers() const=0;
 
        virtual DotsC_MemberIndex GetMemberIndex(const std::string& memberName) const=0;
 
        virtual const MemberDescription* GetMember(DotsC_MemberIndex index) const=0;
 
        virtual int GetNumberOfParameters() const=0;
 
        virtual int GetNumberOfOwnParameters() const=0;
 
        virtual int GetNumberOfInheritedParameters() const=0;
 
        virtual const ParameterDescription* GetParameter(DotsC_ParameterIndex index) const=0;
 
        virtual void GetPropertyIds(std::set<DotsC_TypeId>& propertyIds) const=0;
 
        virtual const PropertyMappingDescription* GetPropertyMapping(DotsC_TypeId propertyTypeId, bool& isInherited) const=0;
 
        virtual int GetNumberOfCreateRoutines() const=0;
 
        virtual const CreateRoutineDescription* GetCreateRoutine(int index) const=0;
 
        virtual DotsC_TypeId GetChecksum() const=0;
    };
 
    class TypeRepository
    {
    public:
 
        virtual ~TypeRepository() = default;
 
        //-----------------
        // Enumerations
        //-----------------
        virtual const EnumDescription* GetEnum(DotsC_TypeId typeId) const=0;
 
        virtual int GetNumberOfEnums() const=0;
 
        virtual void GetAllEnumTypeIds(std::set<DotsC_TypeId>& typeIds) const=0;
 
        //-----------------
        // Properties
        //-----------------
        virtual const PropertyDescription* GetProperty(DotsC_TypeId typeId) const=0;
 
        virtual int GetNumberOfProperties() const=0;
 
        virtual void GetAllPropertyTypeIds(std::set<DotsC_TypeId>& typeIds) const=0;
 
        //-----------------
        // Classes
        //-----------------
        virtual const ClassDescription* GetClass(DotsC_TypeId typeId) const=0;
 
        virtual int GetNumberOfClasses() const=0;
 
        virtual void GetAllClassTypeIds(std::set<DotsC_TypeId>& typeIds) const=0;
 
        //-----------------
        // Exceptions
        //-----------------
        virtual const ExceptionDescription* GetException(DotsC_TypeId typeId) const=0;
 
        virtual int GetNumberOfExceptions() const=0;
 
        virtual void GetAllExceptionTypeIds(std::set<DotsC_TypeId>& typeIds) const=0;
    };
 
    template<> struct TypeRepositoryTraits<TypeRepository>
    {
        typedef TypeRepository RepositoryType;
        typedef ClassDescription ClassDescriptionType;
        typedef MemberDescription MemberDescriptionType;
        typedef PropertyDescription PropertyDescriptionType;
        typedef ExceptionDescription ExceptionDescriptionType;
        typedef ParameterDescription ParameterDescriptionType;
        typedef EnumDescription EnumDescriptionType;
        typedef MemberMappingDescription MemberMappingDescriptionType;
        typedef PropertyMappingDescription PropertyMappingDescriptionType;
        typedef CreateRoutineDescription CreateRoutineDescriptionType;
    };
}
}
}
} //end namespace Safir::Dob::Typesystem::Internal
 
#endif