include/cppuhelper/implbase_ex.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 /*
  21  * This file is part of LibreOffice published API.
  22  */
  23 #ifndef INCLUDED_CPPUHELPER_IMPLBASE_EX_HXX
  24 #define INCLUDED_CPPUHELPER_IMPLBASE_EX_HXX
  25
  26 #include "com/sun/star/uno/Any.h"
  27 #include "com/sun/star/uno/Sequence.h"
  28 #include "com/sun/star/uno/Type.h"
  29 #include "com/sun/star/uno/genfunc.h"
  30 #include "cppuhelper/cppuhelperdllapi.h"
  31 #include "sal/types.h"
  32
  33 namespace cppu { class OWeakAggObject; }
  34 namespace cppu { class OWeakObject; }
  35
  36
  37 /* If you need to define implementation helper classes that deal with more than
  38    12 interfaces, then use macros as follows, e.g. for 3 interfaces:
  39
  40 #include <cppuhelper/implbase_ex_pre.hxx>
  41 #define __IFC_EX_TYPE_INIT3( class_cast ) \
  42     __IFC_EX_TYPE_INIT( class_cast, 1 ), __IFC_EX_TYPE_INIT( class_cast, 2 ), \
  43     __IFC_EX_TYPE_INIT( class_cast, 3 )
  44 #include <cppuhelper/implbase_ex_post.hxx>
  45 __DEF_IMPLHELPER_EX( 3 )
  46 */
  47
  48 /// @cond INTERNAL
  49
  50 namespace cppu
  51 {
  52
  53 /** function pointer signature for getCppuType
  54 */
  55 typedef css::uno::Type const & (SAL_CALL * fptr_getCppuType)( void * );
  56
  57 /** single type + object offset
  58 */
  59 struct SAL_WARN_UNUSED type_entry
  60 {
  61     /** the type_entry is initialized with function pointer to ::getCppuType() function first,
  62         but holds an unacquired typelib_TypeDescriptionReference * after initialization,
  63         thus reusing the memory.  Flag class_data::m_storedTypeRefs
  64     */
  65     union
  66     {
  67         fptr_getCppuType getCppuType;
  68         typelib_TypeDescriptionReference * typeRef;
  69     } m_type;
  70     /** offset for interface pointer
  71     */
  72     sal_IntPtr m_offset;
  73 };
  74
  75 /** in the future, this can be a constexpr template method */
  76 #define CPPUHELPER_DETAIL_TYPEENTRY(Ifc) \
  77     { { Ifc::static_type }, \
  78       reinterpret_cast<sal_IntPtr>( static_cast<Ifc *>( reinterpret_cast<Impl *>(16) )) - 16 }
  79
  80 /** identical dummy struct for casting class_dataN to class_data
  81 */
  82 struct SAL_WARN_UNUSED class_data
  83 {
  84     /** number of supported types in m_typeEntries
  85     */
  86     sal_Int16 m_nTypes;
  87
  88     /** determines whether m_typeEntries is initialized and carries unacquired type refs
  89     */
  90     sal_Bool m_storedTypeRefs;
  91
  92     /** determines whether an implementation id was created in m_id
  93     */
  94     sal_Bool m_createdId;
  95
  96     /** implementation id
  97      */
  98     sal_Int8 m_id[ 16 ];
  99
 100     /** type, object offset
 101     */
 102     type_entry m_typeEntries[ 1 ];
 103 };
 104
 105 /** ImplHelper
 106 */
 107 CPPUHELPER_DLLPUBLIC css::uno::Any SAL_CALL ImplHelper_query(
 108     css::uno::Type const & rType,
 109     class_data * cd,
 110     void * that );
 111 /** ImplHelper
 112 */
 113 CPPUHELPER_DLLPUBLIC css::uno::Any SAL_CALL ImplHelper_queryNoXInterface(
 114     css::uno::Type const & rType,
 115     class_data * cd,
 116     void * that );
 117 /** ImplHelper
 118 */
 119 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 120 SAL_CALL ImplHelper_getTypes(
 121     class_data * cd );
 122 /** ImplHelper
 123 */
 124 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 125 SAL_CALL ImplInhHelper_getTypes(
 126     class_data * cd,
 127     css::uno::Sequence< css::uno::Type > const & rAddTypes );
 128 /** ImplHelper
 129 */
 130 CPPUHELPER_DLLPUBLIC css::uno::Sequence< sal_Int8 >
 131 SAL_CALL ImplHelper_getImplementationId(
 132     class_data * cd );
 133
 134 /** WeakImplHelper
 135 */
 136 CPPUHELPER_DLLPUBLIC css::uno::Any SAL_CALL WeakImplHelper_query(
 137     css::uno::Type const & rType,
 138     class_data * cd,
 139     void * that,
 140     ::cppu::OWeakObject * pBase );
 141 /** WeakImplHelper
 142 */
 143 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 144 SAL_CALL WeakImplHelper_getTypes(
 145     class_data * cd );
 146
 147 /** WeakAggImplHelper
 148 */
 149 CPPUHELPER_DLLPUBLIC css::uno::Any
 150 SAL_CALL WeakAggImplHelper_queryAgg(
 151     css::uno::Type const & rType,
 152     class_data * cd,
 153     void * that,
 154     ::cppu::OWeakAggObject * pBase );
 155 /** WeakAggImplHelper
 156 */
 157 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 158 SAL_CALL WeakAggImplHelper_getTypes(
 159     class_data * cd );
 160
 161 }
 162
 163 /// @endcond
 164
 165 #endif
 166
 167 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */