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 #ifndef INCLUDED_CPPUHELPER_IMPLBASE_EX_HXX
  20 #define INCLUDED_CPPUHELPER_IMPLBASE_EX_HXX
  21
  22 #include <cppuhelper/weak.hxx>
  23 #include <cppuhelper/weakagg.hxx>
  24 #include <com/sun/star/lang/XTypeProvider.hpp>
  25
  26
  27 /* If you need to define implementation helper classes that deal with more than
  28    12 interfaces, then use macros as follows, e.g. for 3 interfaces:
  29
  30 #include <cppuhelper/implbase_ex_pre.hxx>
  31 #define __IFC_EX_TYPE_INIT3( class_cast ) \
  32     __IFC_EX_TYPE_INIT( class_cast, 1 ), __IFC_EX_TYPE_INIT( class_cast, 2 ), \
  33     __IFC_EX_TYPE_INIT( class_cast, 3 )
  34 #include <cppuhelper/implbase_ex_post.hxx>
  35 __DEF_IMPLHELPER_EX( 3 )
  36 */
  37
  38 /// @cond INTERNAL
  39
  40 namespace cppu
  41 {
  42
  43 /** function pointer signature for getCppuType
  44 */
  45 typedef css::uno::Type const & (SAL_CALL * fptr_getCppuType)( void * );
  46
  47 /** single type + object offset
  48 */
  49 struct SAL_WARN_UNUSED type_entry
  50 {
  51     /** the type_entry is initialized with function pointer to ::getCppuType() function first,
  52         but holds an unacquired typelib_TypeDescriptionReference * after initialization,
  53         thus reusing the memory.  Flag class_data::m_storedTypeRefs
  54     */
  55     union
  56     {
  57         fptr_getCppuType getCppuType;
  58         typelib_TypeDescriptionReference * typeRef;
  59     } m_type;
  60     /** offset for interface pointer
  61     */
  62     sal_IntPtr m_offset;
  63 };
  64
  65 /** in the future, this can be a constexpr template method */
  66 #define CPPUHELPER_DETAIL_TYPEENTRY(Ifc) \
  67     { { Ifc::static_type }, \
  68       reinterpret_cast<sal_IntPtr>( static_cast<Ifc *>( reinterpret_cast<Impl *>(16) )) - 16 }
  69
  70 /** identical dummy struct for casting class_dataN to class_data
  71 */
  72 struct SAL_WARN_UNUSED class_data
  73 {
  74     /** number of supported types in m_typeEntries
  75     */
  76     sal_Int16 m_nTypes;
  77
  78     /** determines whether m_typeEntries is initialized and carries unacquired type refs
  79     */
  80     sal_Bool m_storedTypeRefs;
  81
  82     /** determines whether an implementation id was created in m_id
  83     */
  84     sal_Bool m_createdId;
  85
  86     /** implementation id
  87      */
  88     sal_Int8 m_id[ 16 ];
  89
  90     /** type, object offset
  91     */
  92     type_entry m_typeEntries[ 1 ];
  93 };
  94
  95 /** ImplHelper
  96 */
  97 CPPUHELPER_DLLPUBLIC css::uno::Any SAL_CALL ImplHelper_query(
  98     css::uno::Type const & rType,
  99     class_data * cd,
 100     void * that );
 101 /** ImplHelper
 102 */
 103 CPPUHELPER_DLLPUBLIC css::uno::Any SAL_CALL ImplHelper_queryNoXInterface(
 104     css::uno::Type const & rType,
 105     class_data * cd,
 106     void * that );
 107 /** ImplHelper
 108 */
 109 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 110 SAL_CALL ImplHelper_getTypes(
 111     class_data * cd );
 112 /** ImplHelper
 113 */
 114 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 115 SAL_CALL ImplInhHelper_getTypes(
 116     class_data * cd,
 117     css::uno::Sequence< css::uno::Type > const & rAddTypes );
 118 /** ImplHelper
 119 */
 120 CPPUHELPER_DLLPUBLIC css::uno::Sequence< sal_Int8 >
 121 SAL_CALL ImplHelper_getImplementationId(
 122     class_data * cd );
 123
 124 /** WeakImplHelper
 125 */
 126 CPPUHELPER_DLLPUBLIC css::uno::Any SAL_CALL WeakImplHelper_query(
 127     css::uno::Type const & rType,
 128     class_data * cd,
 129     void * that,
 130     ::cppu::OWeakObject * pBase );
 131 /** WeakImplHelper
 132 */
 133 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 134 SAL_CALL WeakImplHelper_getTypes(
 135     class_data * cd );
 136
 137 /** WeakAggImplHelper
 138 */
 139 CPPUHELPER_DLLPUBLIC css::uno::Any
 140 SAL_CALL WeakAggImplHelper_queryAgg(
 141     css::uno::Type const & rType,
 142     class_data * cd,
 143     void * that,
 144     ::cppu::OWeakAggObject * pBase );
 145 /** WeakAggImplHelper
 146 */
 147 CPPUHELPER_DLLPUBLIC css::uno::Sequence< css::uno::Type >
 148 SAL_CALL WeakAggImplHelper_getTypes(
 149     class_data * cd );
 150
 151 }
 152
 153 /// @endcond
 154
 155 #endif
 156
 157 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */