include/tools/rtti.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 #ifndef _RTTI_HXX
  21 #define _RTTI_HXX
  22
  23 #include <string.h>
  24 #include <tools/solar.h>
  25
  26 typedef void* (*TypeId)();
  27
  28 #define TYPEINFO() \
  29         static  void*  CreateType(); \
  30         static  TypeId StaticType(); \
  31         static  sal_Bool   IsOf( TypeId aSameOrSuperType ); \
  32         virtual TypeId Type() const; \
  33         virtual sal_Bool   IsA( TypeId aSameOrSuperType ) const
  34
  35 #define TYPEINFO_VISIBILITY(visibility) \
  36         visibility static  void*  CreateType(); \
  37         visibility static  TypeId StaticType(); \
  38         visibility static  sal_Bool   IsOf( TypeId aSameOrSuperType ); \
  39         visibility virtual TypeId Type() const; \
  40         visibility virtual sal_Bool   IsA( TypeId aSameOrSuperType ) const
  41
  42 #define TYPEINIT_FACTORY(sType, Factory ) \
  43         void*  sType::CreateType() { return Factory; } \
  44         TypeId sType::StaticType() { return &CreateType; } \
  45         TypeId sType::Type() const { return &CreateType; } \
  46         sal_Bool sType::IsOf( TypeId aSameOrSuperType ) \
  47         { \
  48             if ( aSameOrSuperType == StaticType() ) \
  49                 return sal_True
  50
  51 #define STATICTYPE(sType) (sType::StaticType())
  52
  53 #define SUPERTYPE(sSuper) \
  54             if ( sSuper::IsOf(aSameOrSuperType ) ) \
  55                 return sal_True
  56
  57 #define TYPEINIT_END(sType) \
  58             return sal_False; \
  59         } \
  60         sal_Bool sType::IsA( TypeId aSameOrSuperType ) const \
  61         { return IsOf( aSameOrSuperType ); }
  62
  63 #define TYPEINIT0_FACTORY(sType, Factory) \
  64         TYPEINIT_FACTORY(sType, Factory); \
  65         TYPEINIT_END(sType)
  66 #define TYPEINIT0_AUTOFACTORY(sType) TYPEINIT0_FACTORY(sType, new sType)
  67 #define TYPEINIT0(sType) TYPEINIT0_FACTORY(sType, 0)
  68
  69 #define TYPEINIT1_FACTORY(sType, sSuper, Factory) \
  70         TYPEINIT_FACTORY(sType, Factory); \
  71             SUPERTYPE(sSuper); \
  72         TYPEINIT_END(sType)
  73 #define TYPEINIT1_AUTOFACTORY(sType, sSuper) \
  74             TYPEINIT1_FACTORY(sType, sSuper, new sType)
  75 #define TYPEINIT1(sType, sSuper) \
  76             TYPEINIT1_FACTORY(sType, sSuper, 0)
  77
  78 #define TYPEINIT2_FACTORY(sType, sSuper1, sSuper2, Factory) \
  79         TYPEINIT_FACTORY(sType, Factory); \
  80             SUPERTYPE(sSuper1); \
  81             SUPERTYPE(sSuper2); \
  82         TYPEINIT_END(sType)
  83 #define TYPEINIT2_AUTOFACTORY(sType, sSuper1, sSuper2) \
  84             TYPEINIT2_FACTORY(sType, sSuper1, sSuper2, new sType)
  85 #define TYPEINIT2(sType, sSuper1, sSuper2) \
  86             TYPEINIT2_FACTORY(sType, sSuper1, sSuper2, 0)
  87
  88 #define TYPEINIT3_FACTORY(sType, sSuper1, sSuper2, sSuper3, Factory) \
  89         TYPEINIT_FACTORY(sType, Factory); \
  90             SUPERTYPE(sSuper1); \
  91             SUPERTYPE(sSuper2); \
  92             SUPERTYPE(sSuper3); \
  93         TYPEINIT_END(sType)
  94 #define TYPEINIT3(sType, sSuper1, sSuper2, sSuper3) \
  95             TYPEINIT3_FACTORY(sType, sSuper1, sSuper2, sSuper3, 0)
  96
  97 #define TYPE(sType) (sType::StaticType())
  98 #define ISA(sType) IsA(sType::StaticType())
  99 #define ISOF(sType) IsOf(sType::StaticType())
 100 #define CREATE(TypeId) (TypeId())
 101
 102 /** Exemplary application macros for pointers
 103     (can be extended for use with references)
 104
 105     PTR_CAST: Safe pointer casting to a derived class.
 106               Returns NULL pointer on cast error
 107
 108     T: Target type to cast into
 109     p: Pointer to be cast into T
 110 */
 111 #define PTR_CAST( T, pObj ) \
 112         ( pObj && (pObj)->IsA( TYPE(T) ) ? (T*)(pObj) : 0 )
 113
 114 /** Check whether object pObj has a Base Class T
 115     (or if pObj is an instance of T) */
 116 #define HAS_BASE( T, pObj ) \
 117         ( pObj && (pObj)->IsA( TYPE(T) ) )
 118
 119 /** Check whether a pointer is targetting and object of type T. */
 120 #define IS_TYPE(T,pObj) \
 121         ( pObj && (pObj)->Type() == TYPE(T) )
 122
 123 #endif
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */