idl/inc/basobj.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: basobj.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 _BASOBJ_HXX
  32 #define _BASOBJ_HXX
  33
  34 #include <tools/ref.hxx>
  35 #include <bastype.hxx>
  36 #include <tools/pstm.hxx>
  37
  38 class SvTokenStream;
  39 class SvMetaObject;
  40 class SvAttributeList;
  41 class SvIdlDataBase;
  42
  43 typedef SvMetaObject * (*CreateMetaObjectType)();
  44 #define IDL_WRITE_COMPILER  0x8000
  45 #define IDL_WRITE_BROWSER   0x4000
  46 #define IDL_WRITE_CALLING   0x2000
  47 #define IDL_WRITE_MASK      0xE000
  48
  49 #define C_PREF  "C_"
  50
  51 enum WriteType
  52 {
  53     WRITE_IDL, WRITE_ODL, WRITE_SLOTMAP, WRITE_C_HEADER, WRITE_C_SOURCE,
  54     WRITE_CXX_HEADER, WRITE_CXX_SOURCE, WRITE_DOCU
  55 };
  56
  57 enum
  58 {
  59     WA_METHOD = 0x1,    WA_VARIABLE = 0x2,      WA_ARGUMENT = 0x4,
  60     WA_STRUCT = 0x8,    WA_READONLY = 0x10
  61 };
  62 typedef int WriteAttribute;
  63
  64 /******************** Meta Factory **************************************/
  65 #ifdef IDL_COMPILER
  66
  67 #define PRV_SV_DECL_META_FACTORY( Class )                               \
  68     static SvAttributeList * pAttribList;                               \
  69     static SvMetaObject * Create() { return new Class; }                \
  70     static const char *   GetClassName() { return #Class; }
  71
  72 #define PRV_SV_IMPL_META_FACTORY( Class )                               \
  73     SvAttributeList * Class::pAttribList = NULL;
  74
  75 #else
  76
  77 #define PRV_SV_DECL_META_FACTORY( Class )
  78
  79 #define PRV_SV_IMPL_META_FACTORY( Class )
  80
  81 #endif // IDL_COMPILER
  82
  83 #define SV_DECL_META_FACTORY( Class, CLASS_ID )                         \
  84     SV_DECL_PERSIST( Class, CLASS_ID )                                  \
  85     PRV_SV_DECL_META_FACTORY( Class )
  86
  87
  88 #define SV_DECL_META_FACTORY1( Class, Super1, CLASS_ID )                \
  89     SV_DECL_PERSIST1( Class, Super1, CLASS_ID )                         \
  90     PRV_SV_DECL_META_FACTORY( Class )
  91
  92 #define SV_IMPL_META_FACTORY( Class )                                   \
  93     PRV_SV_IMPL_META_FACTORY( Class )                                   \
  94     SV_IMPL_PERSIST( Class )
  95
  96
  97 #define SV_IMPL_META_FACTORY1( Class, Super1 )                          \
  98     PRV_SV_IMPL_META_FACTORY( Class )                                   \
  99     SV_IMPL_PERSIST1( Class, Super1 )
 100
 101
 102 /******************** class SvMetaObject ********************************/
 103 class SvMetaObject : public SvPersistBase
 104 {
 105 public:
 106             SV_DECL_META_FACTORY1( SvMetaObject, SvPersistBase, 14 )
 107             SvMetaObject();
 108
 109 #ifdef IDL_COMPILER
 110     static void                 WriteTab( SvStream & rOutStm, USHORT nTab );
 111     static BOOL                 TestAndSeekSpaceOnly( SvStream &, ULONG nBegPos );
 112     static void                 Back2Delemitter( SvStream & );
 113     static void                 WriteStars( SvStream & );
 114
 115     virtual BOOL        ReadSvIdl( SvIdlDataBase &, SvTokenStream & rInStm );
 116     virtual void        WriteSvIdl( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab );
 117
 118     virtual void        Write( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab,
 119                                 WriteType, WriteAttribute = 0 );
 120
 121     virtual void        WriteCxx( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab );
 122     virtual void        WriteHxx( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab );
 123 #endif
 124 };
 125 SV_DECL_IMPL_REF(SvMetaObject)
 126 //SV_DECL_IMPL_PERSIST_LIST(SvMetaObject,SvMetaObject *)
 127 SV_DECL_PERSIST_LIST(SvMetaObject,SvMetaObject *)
 128 SV_IMPL_PERSIST_LIST(SvMetaObject,SvMetaObject *)
 129
 130
 131 class SvMetaObjectMemberStack
 132 {
 133     SvMetaObjectMemberList aList;
 134 public:
 135             SvMetaObjectMemberStack() {;}
 136
 137     void            Push( SvMetaObject * pObj )
 138                     { aList.Insert( pObj, LIST_APPEND ); }
 139     SvMetaObject *  Pop() { return aList.Remove( aList.Count() -1 ); }
 140     SvMetaObject *  Top() const { return aList.GetObject( aList.Count() -1 ); }
 141     void            Clear() { aList.Clear(); }
 142     ULONG           Count() const { return aList.Count(); }
 143
 144     SvMetaObject *  Get( TypeId nType )
 145                     {
 146                         SvMetaObject * pObj = aList.Last();
 147                         while( pObj )
 148                         {
 149                             if( pObj->IsA( nType ) )
 150                                 return pObj;
 151                             pObj = aList.Prev();
 152                         }
 153                         return NULL;
 154                     }
 155 };
 156
 157 /******************** class SvMetaName **********************************/
 158 class SvMetaName : public SvMetaObject
 159 {
 160     SvString      aName;
 161     SvHelpContext aHelpContext;
 162     SvHelpText    aHelpText;
 163     SvString      aConfigName;
 164     SvString      aDescription;
 165
 166 protected:
 167 #ifdef IDL_COMPILER
 168     virtual BOOL ReadNameSvIdl( SvIdlDataBase &, SvTokenStream & rInStm );
 169             void DoReadContextSvIdl( SvIdlDataBase &, SvTokenStream & rInStm,
 170                                      char c = '\0' );
 171     virtual void ReadContextSvIdl( SvIdlDataBase &, SvTokenStream & rInStm );
 172     virtual void WriteContextSvIdl( SvIdlDataBase & rBase,
 173                                     SvStream & rOutStm, USHORT nTab );
 174     virtual void ReadAttributesSvIdl( SvIdlDataBase & rBase,
 175                                       SvTokenStream & rInStm );
 176     virtual void WriteAttributesSvIdl( SvIdlDataBase & rBase,
 177                                        SvStream & rOutStm, USHORT nTab );
 178     virtual void WriteAttributes( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab,
 179                                         WriteType, WriteAttribute = 0);
 180     virtual void WriteContext( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab,
 181                                         WriteType, WriteAttribute = 0);
 182 #endif
 183 public:
 184             SV_DECL_META_FACTORY1( SvMetaName, SvMetaObject, 15 )
 185             SvMetaName();
 186
 187     virtual BOOL                        SetName( const ByteString & rName, SvIdlDataBase * = NULL  );
 188     void                                        SetDescription( const ByteString& rText )
 189                                 { aDescription = rText; }
 190     const SvHelpContext&                GetHelpContext() const { return aHelpContext; }
 191     virtual const SvString &    GetName() const { return aName; }
 192     virtual const SvString &    GetHelpText() const { return aHelpText; }
 193     virtual const SvString &    GetConfigName() const{ return aConfigName; }
 194     virtual const SvString&     GetDescription() const{ return aDescription; }
 195
 196 #ifdef IDL_COMPILER
 197     virtual BOOL                Test( SvIdlDataBase &, SvTokenStream & rInStm );
 198     virtual BOOL        ReadSvIdl( SvIdlDataBase &, SvTokenStream & rInStm );
 199     virtual void        WriteSvIdl( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab );
 200     virtual void        Write( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab,
 201                                        WriteType, WriteAttribute = 0);
 202     void                                WriteDescription( SvStream& rOutStm );
 203 #endif
 204 };
 205 SV_DECL_IMPL_REF(SvMetaName)
 206 SV_DECL_IMPL_PERSIST_LIST(SvMetaName,SvMetaName *)
 207
 208
 209 /******************** class SvMetaReference *****************************/
 210 SV_DECL_REF(SvMetaReference)
 211 class SvMetaReference : public SvMetaName
 212 {
 213 protected:
 214     SvMetaReferenceRef  aRef;
 215 public:
 216             SV_DECL_META_FACTORY1( SvMetaReference, SvMetaName, 17 )
 217             SvMetaReference();
 218
 219     const SvString &    GetName() const
 220                         {
 221                             return ( !aRef.Is()
 222                                     || SvMetaName::GetName().Len() )
 223                                 ? SvMetaName::GetName()
 224                                 : aRef->GetName();
 225                         }
 226
 227     const SvString &    GetHelpText() const
 228                         {
 229                             return ( !aRef.Is()
 230                                     || SvMetaName::GetHelpText().Len() )
 231                                 ? SvMetaName::GetHelpText()
 232                                 : aRef->GetHelpText();
 233                         }
 234
 235     const SvString &    GetConfigName() const
 236                         {
 237                             return ( !aRef.Is()
 238                                     || SvMetaName::GetConfigName().Len() )
 239                                 ? SvMetaName::GetConfigName()
 240                                 : aRef->GetConfigName();
 241                         }
 242
 243     const SvString &    GetDescription() const
 244                         {
 245                             return ( !aRef.Is()
 246                                     || SvMetaName::GetDescription().Len() )
 247                                 ? SvMetaName::GetDescription()
 248                                 : aRef->GetDescription();
 249                         }
 250     SvMetaReference *   GetRef() const { return aRef; }
 251     void                SetRef( SvMetaReference * pRef  )
 252                         { aRef = pRef; }
 253 };
 254 SV_IMPL_REF(SvMetaReference)
 255 SV_DECL_IMPL_PERSIST_LIST(SvMetaReference,SvMetaReference *)
 256
 257
 258 /******************** class SvMetaExtern *********************************/
 259 class SvMetaModule;
 260 class SvMetaExtern : public SvMetaReference
 261 {
 262     SvMetaModule *          pModule;    // in welchem Modul enthalten
 263
 264     SvUUId                  aUUId;
 265     SvVersion               aVersion;
 266     BOOL                                        bReadUUId;
 267     BOOL                                        bReadVersion;
 268 public:
 269                         SV_DECL_META_FACTORY1( SvMetaExtern, SvMetaName, 16 )
 270                         SvMetaExtern();
 271
 272     SvMetaModule *      GetModule() const;
 273
 274     const SvGlobalName &GetUUId() const;
 275     const SvVersion &   GetVersion() const { return aVersion; }
 276 #ifdef IDL_COMPILER
 277     void                                SetModule( SvIdlDataBase & rBase );
 278     virtual BOOL        ReadSvIdl( SvIdlDataBase &, SvTokenStream & rInStm );
 279     virtual void        WriteSvIdl( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab );
 280
 281     virtual void        Write( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab,
 282                                   WriteType, WriteAttribute = 0);
 283 protected:
 284     virtual void        ReadAttributesSvIdl( SvIdlDataBase &, SvTokenStream & rInStm );
 285     virtual void        WriteAttributesSvIdl( SvIdlDataBase & rBase,
 286                                               SvStream & rOutStm, USHORT nTab );
 287     virtual void        WriteAttributes( SvIdlDataBase & rBase, SvStream & rOutStm, USHORT nTab,
 288                                           WriteType, WriteAttribute = 0);
 289 #endif
 290 };
 291 SV_DECL_IMPL_REF(SvMetaExtern)
 292 SV_DECL_IMPL_PERSIST_LIST(SvMetaExtern,SvMetaExtern *)
 293
 294
 295 #endif // _BASOBJ_HXX
 296
 297