typedescription.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

/*
 * This file is part of LibreOffice published API.
 */
#ifndef INCLUDED_TYPELIB_TYPEDESCRIPTION_H
#define INCLUDED_TYPELIB_TYPEDESCRIPTION_H

#include "cppu/cppudllapi.h"
#include "typelib/uik.h"
#include "typelib/typeclass.h"
#include "rtl/ustring.h"

#ifdef __cplusplus
extern "C"
{
#endif

struct _typelib_TypeDescription;

#if defined( _WIN32)
#pragma pack(push, 8)
#endif

typedef struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescriptionReference
{
    sal_Int32                           nRefCount;
    sal_Int32                           nStaticRefCount;
    typelib_TypeClass                   eTypeClass;
    rtl_uString *                       pTypeName;
    struct _typelib_TypeDescription *   pType;
    void *                              pUniqueIdentifier;
    void *                              pReserved;
} typelib_TypeDescriptionReference;

typedef struct SAL_DLLPUBLIC_RTTI _typelib_TypeDescription
{
    sal_Int32                           nRefCount;
    sal_Int32                           nStaticRefCount;
    typelib_TypeClass                   eTypeClass;
    rtl_uString *                       pTypeName;
    struct _typelib_TypeDescription *   pSelf;
    void *                              pUniqueIdentifier;
    void *                              pReserved;

    sal_Bool                            bComplete;
    sal_Int32                           nSize;
    sal_Int32                           nAlignment;
    typelib_TypeDescriptionReference *  pWeakRef;
    sal_Bool                            bOnDemand;
} typelib_TypeDescription;

typedef struct _typelib_CompoundTypeDescription
{
    typelib_TypeDescription             aBase;

    struct _typelib_CompoundTypeDescription * pBaseTypeDescription;

    sal_Int32                           nMembers;
    sal_Int32 *                         pMemberOffsets;
    typelib_TypeDescriptionReference ** ppTypeRefs;
    rtl_uString **                      ppMemberNames;
} typelib_CompoundTypeDescription;

typedef struct _typelib_StructTypeDescription
{
    typelib_CompoundTypeDescription aBase;

    sal_Bool * pParameterizedTypes;
} typelib_StructTypeDescription;

typedef struct _typelib_IndirectTypeDescription
{
    typelib_TypeDescription             aBase;

    typelib_TypeDescriptionReference *  pType;
} typelib_IndirectTypeDescription;

typedef struct _typelib_EnumTypeDescription
{
    typelib_TypeDescription             aBase;

    sal_Int32                           nDefaultEnumValue;
    sal_Int32                           nEnumValues;
    rtl_uString **                      ppEnumNames;
    sal_Int32 *                         pEnumValues;
} typelib_EnumTypeDescription;

typedef struct _typelib_MethodParameter
{
    rtl_uString *                       pName;
    typelib_TypeDescriptionReference *  pTypeRef;
    sal_Bool                            bIn;
    sal_Bool                            bOut;
} typelib_MethodParameter;

typedef struct _typelib_InterfaceMemberTypeDescription
{
    typelib_TypeDescription             aBase;

    sal_Int32                           nPosition;
    rtl_uString *                       pMemberName;
} typelib_InterfaceMemberTypeDescription;

typedef struct _typelib_InterfaceMethodTypeDescription
{
    typelib_InterfaceMemberTypeDescription      aBase;

    typelib_TypeDescriptionReference *          pReturnTypeRef;
    sal_Int32                                   nParams;
    typelib_MethodParameter *                   pParams;
    sal_Int32                                   nExceptions;
    typelib_TypeDescriptionReference **         ppExceptions;
    sal_Bool                                    bOneWay;

    struct _typelib_InterfaceTypeDescription *  pInterface;
    typelib_TypeDescriptionReference *          pBaseRef;
    sal_Int32                                   nIndex;
} typelib_InterfaceMethodTypeDescription;

typedef struct _typelib_InterfaceAttributeTypeDescription
{
    typelib_InterfaceMemberTypeDescription      aBase;

    sal_Bool                                    bReadOnly;
    typelib_TypeDescriptionReference *          pAttributeTypeRef;

    struct _typelib_InterfaceTypeDescription *  pInterface;
    typelib_TypeDescriptionReference *          pBaseRef;
    sal_Int32                                   nIndex;
    sal_Int32                                   nGetExceptions;
    typelib_TypeDescriptionReference **         ppGetExceptions;
    sal_Int32                                   nSetExceptions;
    typelib_TypeDescriptionReference **         ppSetExceptions;
} typelib_InterfaceAttributeTypeDescription;

typedef struct SAL_DLLPUBLIC_RTTI _typelib_InterfaceTypeDescription
{
    typelib_TypeDescription                     aBase;

    struct _typelib_InterfaceTypeDescription *  pBaseTypeDescription;
    typelib_Uik                                 aUik;
    sal_Int32                                   nMembers;
    typelib_TypeDescriptionReference **         ppMembers;
    sal_Int32                                   nAllMembers;
    typelib_TypeDescriptionReference **         ppAllMembers;
    sal_Int32 *                                 pMapMemberIndexToFunctionIndex;
    sal_Int32                                   nMapFunctionIndexToMemberIndex;
    sal_Int32 *                                 pMapFunctionIndexToMemberIndex;
    sal_Int32                                   nBaseTypes;
    struct _typelib_InterfaceTypeDescription ** ppBaseTypes;
} typelib_InterfaceTypeDescription;

typedef struct _typelib_CompoundMember_Init
{
    typelib_TypeClass   eTypeClass;
    rtl_uString *       pTypeName;
    rtl_uString *       pMemberName;
} typelib_CompoundMember_Init;

typedef struct _typelib_StructMember_Init
{
    typelib_CompoundMember_Init aBase;

    sal_Bool bParameterizedType;
} typelib_StructMember_Init;

typedef struct _typelib_Parameter_Init
{
    typelib_TypeClass   eTypeClass;
    rtl_uString *       pTypeName;
    rtl_uString *       pParamName;
    sal_Bool            bIn;
    sal_Bool            bOut;
} typelib_Parameter_Init;

#if defined( _WIN32)
#pragma pack(pop)
#endif

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_newEnum(
    typelib_TypeDescription ** ppRet,
    rtl_uString * pTypeName,
    sal_Int32 nDefaultValue,
    sal_Int32 nEnumValues,
    rtl_uString ** ppEnumNames,
    sal_Int32 * pEnumValues )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_new(
    typelib_TypeDescription ** ppRet,
    typelib_TypeClass eTypeClass,
    rtl_uString * pTypeName,
    typelib_TypeDescriptionReference * pType,
    sal_Int32 nMembers,
    typelib_CompoundMember_Init * pMembers )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_newStruct(
    typelib_TypeDescription ** ppRet,
    rtl_uString * pTypeName,
    typelib_TypeDescriptionReference * pType,
    sal_Int32 nMembers,
    typelib_StructMember_Init * pMembers )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_newInterface(
    typelib_InterfaceTypeDescription ** ppRet,
    rtl_uString * pTypeName,
    sal_uInt32 nUik1, sal_uInt16 nUik2, sal_uInt16 nUik3, sal_uInt32 nUik4, sal_uInt32 nUik5,
    typelib_TypeDescriptionReference * pBaseInterface,
    sal_Int32 nMembers,
    typelib_TypeDescriptionReference ** ppMembers )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_newMIInterface(
    typelib_InterfaceTypeDescription ** ppRet,
    rtl_uString * pTypeName,
    sal_uInt32 nUik1, sal_uInt16 nUik2, sal_uInt16 nUik3, sal_uInt32 nUik4, sal_uInt32 nUik5,
    sal_Int32 nBaseInterfaces,
    typelib_TypeDescriptionReference ** ppBaseInterfaces,
    sal_Int32 nMembers,
    typelib_TypeDescriptionReference ** ppMembers )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_newInterfaceMethod(
    typelib_InterfaceMethodTypeDescription ** ppRet,
    sal_Int32 nAbsolutePosition,
    sal_Bool bOneWay,
    rtl_uString * pMethodName,
    typelib_TypeClass eReturnTypeClass,
    rtl_uString * pReturnTypeName,
    sal_Int32 nParams,
    typelib_Parameter_Init * pParams,
    sal_Int32 nExceptions,
    rtl_uString ** ppExceptionNames )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_newInterfaceAttribute(
    typelib_InterfaceAttributeTypeDescription ** ppRet,
    sal_Int32 nAbsolutePosition,
    rtl_uString * pAttributeName,
    typelib_TypeClass eAttributeTypeClass,
    rtl_uString * pAttributeTypeName,
    sal_Bool bReadOnly )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_newExtendedInterfaceAttribute(
    typelib_InterfaceAttributeTypeDescription ** ppRet,
    sal_Int32 nAbsolutePosition,
    rtl_uString * pAttributeName,
    typelib_TypeClass eAttributeTypeClass,
    rtl_uString * pAttributeTypeName,
    sal_Bool bReadOnly,
    sal_Int32 nGetExceptions, rtl_uString ** ppGetExceptionNames,
    sal_Int32 nSetExceptions, rtl_uString ** ppSetExceptionNames )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_acquire(
    typelib_TypeDescription * pDesc )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_release(
    typelib_TypeDescription * pDesc )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_register(
    typelib_TypeDescription ** ppNewDescription )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC sal_Bool SAL_CALL typelib_typedescription_equals(
    const typelib_TypeDescription * p1, const typelib_TypeDescription * p2 )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_getByName(
    typelib_TypeDescription ** ppRet, rtl_uString * pName )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_setCacheSize(
    sal_Int32 nNewSize )
    SAL_THROW_EXTERN_C();

typedef void (SAL_CALL * typelib_typedescription_Callback)(
    void * pContext, typelib_TypeDescription ** ppRet, rtl_uString * pTypeName );

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_registerCallback(
    void * pContext, typelib_typedescription_Callback pCallback )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescription_revokeCallback(
    void * pContext, typelib_typedescription_Callback pCallback )
    SAL_THROW_EXTERN_C();


/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_new(
    typelib_TypeDescriptionReference ** ppTDR,
    typelib_TypeClass eTypeClass,
    rtl_uString * pTypeName )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_newByAsciiName(
    typelib_TypeDescriptionReference ** ppTDR,
    typelib_TypeClass eTypeClass,
    const char * pTypeName )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_acquire(
    typelib_TypeDescriptionReference * pRef )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_release(
    typelib_TypeDescriptionReference * pRef )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_getDescription(
    typelib_TypeDescription ** ppRet, typelib_TypeDescriptionReference * pRef )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC sal_Bool SAL_CALL typelib_typedescriptionreference_equals(
    const typelib_TypeDescriptionReference * p1, const typelib_TypeDescriptionReference * p2 )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_assign(
    typelib_TypeDescriptionReference ** ppDest,
    typelib_TypeDescriptionReference * pSource )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC sal_Bool SAL_CALL typelib_typedescription_isAssignableFrom(
    typelib_TypeDescription * pAssignable,
    typelib_TypeDescription * pFrom )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC sal_Bool SAL_CALL typelib_typedescriptionreference_isAssignableFrom(
    typelib_TypeDescriptionReference * pAssignable,
    typelib_TypeDescriptionReference * pFrom )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC typelib_TypeDescriptionReference ** SAL_CALL typelib_static_type_getByTypeClass(
    typelib_TypeClass eTypeClass )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_static_type_init(
    typelib_TypeDescriptionReference ** ppRef,
    typelib_TypeClass eTypeClass, const char * pTypeName )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_static_sequence_type_init(
    typelib_TypeDescriptionReference ** ppRef,
    typelib_TypeDescriptionReference * pElementType )
    SAL_THROW_EXTERN_C ();

CPPU_DLLPUBLIC void SAL_CALL typelib_static_compound_type_init(
    typelib_TypeDescriptionReference ** ppRef,
    typelib_TypeClass eTypeClass, const char * pTypeName,
    typelib_TypeDescriptionReference * pBaseType,
    sal_Int32 nMembers, typelib_TypeDescriptionReference ** ppMembers )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_static_struct_type_init(
    typelib_TypeDescriptionReference ** ppRef, const char * pTypeName,
    typelib_TypeDescriptionReference * pBaseType,
    sal_Int32 nMembers, typelib_TypeDescriptionReference ** ppMembers,
    sal_Bool const * pParameterizedTypes )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_static_interface_type_init(
    typelib_TypeDescriptionReference ** ppRef,
    const char * pTypeName,
    typelib_TypeDescriptionReference * pBaseType )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_static_mi_interface_type_init(
    typelib_TypeDescriptionReference ** ppRef,
    const char * pTypeName,
    sal_Int32 nBaseTypes,
    typelib_TypeDescriptionReference ** ppBaseTypes )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC void SAL_CALL typelib_static_enum_type_init(
    typelib_TypeDescriptionReference ** ppRef,
    const char * pTypeName,
    sal_Int32 nDefaultValue )
    SAL_THROW_EXTERN_C();

CPPU_DLLPUBLIC sal_Bool SAL_CALL typelib_typedescription_complete(
    typelib_TypeDescription ** ppTypeDescr )
    SAL_THROW_EXTERN_C();


#if defined LIBO_INTERNAL_ONLY && defined __cplusplus
constexpr
#endif
inline bool TYPELIB_TYPEDESCRIPTIONREFERENCE_ISREALLYWEAK( _typelib_TypeClass eTypeClass )
{
    return (eTypeClass == typelib_TypeClass_INTERFACE_METHOD) ||
     (eTypeClass == typelib_TypeClass_INTERFACE_ATTRIBUTE);
}

inline void TYPELIB_DANGER_GET( typelib_TypeDescription** ppMacroTypeDescr,
    typelib_TypeDescriptionReference* pMacroTypeRef )
{
    if (TYPELIB_TYPEDESCRIPTIONREFERENCE_ISREALLYWEAK( pMacroTypeRef->eTypeClass ))
    {
        typelib_typedescriptionreference_getDescription( ppMacroTypeDescr, pMacroTypeRef );
    }
    else if (!pMacroTypeRef->pType || !pMacroTypeRef->pType->pWeakRef)
    {
        typelib_typedescriptionreference_getDescription( ppMacroTypeDescr, pMacroTypeRef );
        if (*ppMacroTypeDescr)
            typelib_typedescription_release( *ppMacroTypeDescr );
    }
    else
    {
        *ppMacroTypeDescr = pMacroTypeRef->pType;
    }
}

inline void TYPELIB_DANGER_RELEASE( typelib_TypeDescription* pDescription )
{
    if (TYPELIB_TYPEDESCRIPTIONREFERENCE_ISREALLYWEAK( pDescription->eTypeClass ))
        typelib_typedescription_release( pDescription );
}


#ifdef __cplusplus
}
#endif

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */