codemaker/source/cunomaker/cunotype.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: cunotype.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_CODEMAKER_SOURCE_CUNOMAKER_CUNOTYPE_HXX_
  32 #define INCLUDED_CODEMAKER_SOURCE_CUNOMAKER_CUNOTYPE_HXX
  33
  34 #include        <codemaker/typemanager.hxx>
  35 #include        <codemaker/dependency.hxx>
  36
  37 enum BASETYPE
  38 {
  39     BT_INVALID,
  40     BT_VOID,
  41     BT_ANY,
  42     BT_TYPE,
  43     BT_BOOLEAN,
  44     BT_CHAR,
  45     BT_STRING,
  46     BT_FLOAT,
  47     BT_DOUBLE,
  48     BT_OCTET,
  49     BT_BYTE,
  50     BT_SHORT,
  51     BT_LONG,
  52     BT_HYPER,
  53     BT_UNSIGNED_SHORT,
  54     BT_UNSIGNED_LONG,
  55     BT_UNSIGNED_HYPER
  56 };
  57
  58
  59 enum CunoTypeDecl
  60 {
  61     CUNOTYPEDECL_ALLTYPES,
  62     CUNOTYPEDECL_NOINTERFACES,
  63     CUNOTYPEDECL_ONLYINTERFACES
  64 };
  65
  66 class CunoOptions;
  67 class FileStream;
  68
  69 class CunoType
  70 {
  71 public:
  72     CunoType(TypeReader& typeReader,
  73              const ::rtl::OString& typeName,
  74              const TypeManager& typeMgr,
  75              const TypeDependency& typeDependencies);
  76
  77     virtual ~CunoType();
  78
  79     virtual sal_Bool dump(CunoOptions* pOptions) throw( CannotDumpException );
  80     virtual sal_Bool dumpDependedTypes(CunoOptions* pOptions)  throw( CannotDumpException );
  81     virtual sal_Bool dumpHFile(FileStream& o) throw( CannotDumpException ) = 0;
  82     virtual sal_Bool dumpCFile(FileStream& o) throw( CannotDumpException ) = 0;
  83
  84     virtual ::rtl::OString dumpHeaderDefine(FileStream& o, sal_Char* prefix, sal_Bool bExtended=sal_False);
  85     virtual void dumpDefaultHIncludes(FileStream& o);
  86     virtual void dumpDefaultCIncludes(FileStream& o);
  87     virtual void dumpInclude(FileStream& o, const ::rtl::OString& typeName, sal_Char* prefix, sal_Bool bExtended=sal_False, sal_Bool bCaseSensitive=sal_False);
  88     virtual void dumpDepIncludes(FileStream& o, const ::rtl::OString& typeName, sal_Char* prefix);
  89
  90     virtual void dumpOpenExternC(FileStream& o);
  91     virtual void dumpCloseExternC(FileStream& o);
  92
  93     virtual void dumpGetCunoType(FileStream& o);
  94     virtual void dumpCGetCunoType(FileStream& o);
  95     virtual void dumpLGetCunoType(FileStream& o);
  96
  97     virtual void dumpType(FileStream& o, const ::rtl::OString& type, sal_Bool bConst=sal_False,
  98                           sal_Bool bPointer=sal_False, sal_Bool bParam=sal_False)
  99                     throw( CannotDumpException );
 100     ::rtl::OString      getTypeClass(const ::rtl::OString& type="", sal_Bool bCStyle=sal_False);
 101     ::rtl::OString      getBaseType(const ::rtl::OString& type);
 102     void        dumpCppuGetType(FileStream& o, const ::rtl::OString& type, sal_Bool bDecl=sal_False, CunoTypeDecl eDeclFlag=CUNOTYPEDECL_ALLTYPES);
 103     void        dumpTypeInit(FileStream& o, const ::rtl::OString& type);
 104     BASETYPE isBaseType(const ::rtl::OString& type);
 105
 106     ::rtl::OString typeToIdentifier(const ::rtl::OString& type);
 107
 108     void        dumpConstantValue(FileStream& o, sal_uInt16 index);
 109
 110     virtual sal_uInt32  getMemberCount();
 111     virtual sal_uInt32  getInheritedMemberCount();
 112     void        dumpInheritedMembers(FileStream& o, rtl::OString& superType);
 113
 114     sal_Bool isSeqType(const ::rtl::OString& type, ::rtl::OString& baseType, ::rtl::OString& seqPrefix);
 115     sal_Bool isArrayType(const ::rtl::OString& type, ::rtl::OString& baseType, ::rtl::OString& arrayPrefix);
 116     sal_Bool isVoid(const ::rtl::OString& type)
 117         { return type.equals("void"); }
 118     void                        inc(sal_uInt32 num=4);
 119     void                        dec(sal_uInt32 num=4);
 120     ::rtl::OString      indent();
 121     ::rtl::OString      indent(sal_uInt32 num);
 122 protected:
 123     virtual sal_uInt32  checkInheritedMemberCount(const TypeReader* pReader);
 124
 125     ::rtl::OString      checkSpecialCunoType(const ::rtl::OString& type);
 126     ::rtl::OString      checkRealBaseType(const ::rtl::OString& type, sal_Bool bResolveTypeOnly = sal_False);
 127     void        dumpCppuGetTypeMemberDecl(FileStream& o, CunoTypeDecl eDeclFlag);
 128
 129      sal_Bool isNestedType()
 130         { return m_bIsNestedType; };
 131
 132      RegistryKeyNames& getNestedTypeNames()
 133         { return  m_nestedTypeNames; };
 134
 135      sal_Bool isNestedTypeByName(const ::rtl::OString& type);
 136      sal_Bool hasNestedType(const ::rtl::OString& type);
 137
 138 protected:
 139     sal_uInt32                  m_inheritedMemberCount;
 140
 141     sal_Bool                    m_cunoTypeLib;
 142     sal_Bool                    m_cunoTypeLeak;
 143     sal_Bool                    m_cunoTypeDynamic;
 144     sal_uInt32                  m_indentLength;
 145     ::rtl::OString              m_typeName;
 146     ::rtl::OString              m_name;
 147     TypeReader                  m_reader;
 148     TypeManager&                m_typeMgr;
 149     TypeDependency      m_dependencies;
 150     sal_Bool                    m_bIsNestedType;
 151     RegistryKeyNames    m_nestedTypeNames;
 152 };
 153
 154 class InterfaceType : public CunoType
 155 {
 156 public:
 157     InterfaceType(TypeReader& typeReader,
 158                  const ::rtl::OString& typeName,
 159                  const TypeManager& typeMgr,
 160                  const TypeDependency& typeDependencies);
 161
 162     virtual ~InterfaceType();
 163
 164     sal_Bool    dumpDeclaration(FileStream& o) throw( CannotDumpException );
 165     sal_Bool    dumpHFile(FileStream& o) throw( CannotDumpException );
 166     sal_Bool    dumpCFile(FileStream& o) throw( CannotDumpException );
 167
 168     void                dumpInheritedFunctions(FileStream& o, rtl::OString& superType);
 169     void                dumpAttributes(FileStream& o, const ::rtl::OString& interfaceType, TypeReader& reader );
 170     void                dumpMethods(FileStream& o, const ::rtl::OString& interfaceType, TypeReader& reader );
 171     void                dumpGetCunoType(FileStream& o);
 172     void                dumpCGetCunoType(FileStream& o);
 173     void                dumpCUnoAttributeTypeNames(FileStream& o, sal_Bool bRelease=sal_False);
 174     void                dumpCUnoMethodTypeNames(FileStream& o, sal_Bool bRelease=sal_False);
 175     void                dumpCUnoAttributeRefs(FileStream& o, sal_uInt32& index);
 176     void                dumpCUnoMethodRefs(FileStream& o, sal_uInt32& index);
 177     void                dumpCUnoAttributes(FileStream& o, sal_uInt32& index);
 178     void                dumpCUnoMethods(FileStream& o, sal_uInt32& index);
 179     void                dumpAttributesCppuDecl(FileStream& o, StringSet* pFinishedTypes, CunoTypeDecl eDeclFlag);
 180     void                dumpMethodsCppuDecl(FileStream& o, StringSet* pFinishedTypes, CunoTypeDecl eDeclFlag );
 181
 182     sal_uInt32  getMemberCount();
 183     sal_uInt32  getInheritedMemberCount();
 184
 185 protected:
 186     sal_uInt32  checkInheritedMemberCount(const TypeReader* pReader);
 187
 188 protected:
 189     sal_uInt32  m_inheritedMemberCount;
 190     sal_Bool    m_hasAttributes;
 191     sal_Bool    m_hasMethods;
 192 };
 193
 194 class ModuleType : public CunoType
 195 {
 196 public:
 197     ModuleType(TypeReader& typeReader,
 198                   const ::rtl::OString& typeName,
 199                const TypeManager& typeMgr,
 200                const TypeDependency& typeDependencies);
 201
 202     virtual ~ModuleType();
 203
 204     virtual sal_Bool    dump(CunoOptions* pOptions) throw( CannotDumpException );
 205
 206     sal_Bool                    dumpDeclaration(FileStream& o) throw( CannotDumpException );
 207     sal_Bool                    dumpHFile(FileStream& o) throw( CannotDumpException );
 208     sal_Bool                    dumpCFile(FileStream& o) throw( CannotDumpException );
 209     sal_Bool                    hasConstants();
 210 };
 211
 212 class ConstantsType : public ModuleType
 213 {
 214 public:
 215     ConstantsType(TypeReader& typeReader,
 216                   const ::rtl::OString& typeName,
 217                const TypeManager& typeMgr,
 218                const TypeDependency& typeDependencies);
 219
 220     virtual ~ConstantsType();
 221
 222     virtual sal_Bool    dump(CunoOptions* pOptions) throw( CannotDumpException );
 223 };
 224
 225 class StructureType : public CunoType
 226 {
 227 public:
 228     StructureType(TypeReader& typeReader,
 229                   const ::rtl::OString& typeName,
 230                   const TypeManager& typeMgr,
 231                   const TypeDependency& typeDependencies);
 232
 233     virtual ~StructureType();
 234
 235     sal_Bool    dumpDeclaration(FileStream& o) throw( CannotDumpException );
 236     sal_Bool    dumpHFile(FileStream& o) throw( CannotDumpException );
 237     sal_Bool    dumpCFile(FileStream& o) throw( CannotDumpException );
 238 };
 239
 240 class ExceptionType : public CunoType
 241 {
 242 public:
 243     ExceptionType(TypeReader& typeReader,
 244                   const ::rtl::OString& typeName,
 245                   const TypeManager& typeMgr,
 246                   const TypeDependency& typeDependencies);
 247
 248     virtual ~ExceptionType();
 249
 250     sal_Bool    dumpDeclaration(FileStream& o) throw( CannotDumpException );
 251     sal_Bool    dumpHFile(FileStream& o) throw( CannotDumpException );
 252     sal_Bool    dumpCFile(FileStream& o) throw( CannotDumpException );
 253 };
 254
 255 class EnumType : public CunoType
 256 {
 257 public:
 258     EnumType(TypeReader& typeReader,
 259               const ::rtl::OString& typeName,
 260               const TypeManager& typeMgr,
 261               const TypeDependency& typeDependencies);
 262
 263     virtual ~EnumType();
 264
 265     sal_Bool    dumpDeclaration(FileStream& o) throw( CannotDumpException );
 266     sal_Bool    dumpHFile(FileStream& o) throw( CannotDumpException );
 267     sal_Bool    dumpCFile(FileStream& o) throw( CannotDumpException );
 268
 269     void                dumpGetCunoType(FileStream& o);
 270     void                dumpCGetCunoType(FileStream& o);
 271 };
 272
 273 class TypeDefType : public CunoType
 274 {
 275 public:
 276     TypeDefType(TypeReader& typeReader,
 277               const ::rtl::OString& typeName,
 278               const TypeManager& typeMgr,
 279               const TypeDependency& typeDependencies);
 280
 281     virtual ~TypeDefType();
 282
 283     sal_Bool    dumpDeclaration(FileStream& o) throw( CannotDumpException );
 284     sal_Bool    dumpHFile(FileStream& o) throw( CannotDumpException );
 285     sal_Bool    dumpCFile(FileStream& o) throw( CannotDumpException );
 286
 287     void                dumpGetCunoType(FileStream& o);
 288     void                dumpLGetCunoType(FileStream& o);
 289     void                dumpCGetCunoType(FileStream& o);
 290 };
 291
 292
 293 sal_Bool produceType(const ::rtl::OString& typeName,
 294                      TypeManager& typeMgr,
 295                      TypeDependency& typeDependencies,
 296                      CunoOptions* pOptions)
 297                  throw( CannotDumpException );
 298
 299 /**
 300  * This function returns a C++ scoped name, represents the namespace
 301  * scoping of this type, e.g. com:.sun::star::uno::XInterface. If the scope of
 302  * the type is equal scope, the relativ name will be used.
 303  */
 304 ::rtl::OString scopedName(const ::rtl::OString& scope, const ::rtl::OString& type,
 305                    sal_Bool bNoNameSpace=sal_False);
 306
 307 ::rtl::OString shortScopedName(const ::rtl::OString& scope, const ::rtl::OString& type,
 308                            sal_Bool bNoNameSpace=sal_False);
 309
 310
 311 #endif // INCLUDED_CODEMAKER_SOURCE_CUNOMAKER_CUNOTYPE_HXX
 312