binfilter/inc/bf_svx/svdsuro.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: svdsuro.hxx,v $
  10  * $Revision: 1.4 $
  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 _SVDSURO_HXX
  32 #define _SVDSURO_HXX
  33
  34 #ifndef _SVDTYPES_HXX
  35 #include <bf_svx/svdtypes.hxx>
  36 #endif
  37 class SvStream;
  38 namespace binfilter {
  39
  40 ////////////////////////////////////////////////////////////////////////////////////////////////////
  41
  42 class SdrPage;
  43 class SdrModel;
  44 class SdrObject;
  45 class SdrObjList;
  46
  47 class SdrObjSurrogate {
  48 protected:
  49     const SdrObject*  pRefObj;
  50     SdrObject*  pObj;
  51     const SdrObjList* pList;
  52     const SdrObjList* pRootList;
  53     const SdrPage*    pPage;
  54     const SdrModel*   pModel;
  55     SdrObjListKind eList;
  56     UINT32      nOrdNum;         // Ordnungsnummer des Obj in seiner Liste
  57     UINT32*     pGrpOrdNums;     // Ordnungsnummern der Gruppenobjekte auf dem Path zum Zielobj
  58     UINT16      nGrpLevel;
  59     UINT16      nPageNum;
  60 #if _SOLAR__PRIVATE
  61 private:
  62     void ImpClearVars();
  63     void ImpMakeSurrogate();
  64     void ImpFindObj();
  65     void ImpRead(SvStream& rIn);
  66     void ImpWriteValue(SvStream& rOut, UINT32 nVal, unsigned nByteAnz) const;
  67     void ImpReadValue(SvStream& rIn, UINT32& rVal, unsigned nByteAnz) const;
  68 #endif // __PRIVATE
  69 public:
  70 //    TYPEINFO();
  71
  72     // Konstruktor zum Schreiben
  73     // pObj ist das referenzierte Objekt.
  74     // Wird ueber pRefObj ein Referenzobjekt angegeben, so muss dieses
  75     // auch beim spaeteren Einlesen wieder angegeben werden (fuer Verweis
  76     // von einem Zeichenobjekt auf ein anderes). Diese Verwendung ist platz-
  77     // und zeitsparender, wenn sich beide Objekte auf derselben Page oder
  78     // noch besser in der selben ObjList befinden.
  79     // (pRefObj hat einen Verweis auf pObj).
  80     SdrObjSurrogate(SdrObject* pObj1, const SdrObject* pRefObj1=NULL);
  81
  82     // Konstruktoren zum Lesen
  83     // Lesen eines absoluten Surrogats.
  84     SdrObjSurrogate(const SdrModel& rMod, SvStream& rIn);
  85     // Lesen eines relativen Surrogats. Muss verwendet werden, wenn das
  86     // Surrogat unter Angabe eines Referenzobjektes geschrieben wurde.
  87     SdrObjSurrogate(const SdrObject& rRefObj1, SvStream& rIn);
  88
  89     ~SdrObjSurrogate();
  90
  91     // GetObject() funktioniert nur sicher, wenn das gesamte Model
  92     // eingestreamt ist.
  93     SdrObject* GetObject();
  94
  95     friend SvStream& operator<<(SvStream& rOut, const SdrObjSurrogate& rSurro);
  96 };
  97
  98 /*
  99 Ein SdrObjSurrogat ist eine Ersatzdarstellung zur Realisierung einer
 100 persistenten Verbindung zu einem Zeichenobjekt. Anwendungsfaelle (Beispiele):
 101   - Virtuelles Objekt und Symbolreferenzierung
 102   - LayoutObjekt
 103   - Texterweiterungsrahmen
 104   - Konnektoren
 105 Beim Rausstreamen eines SdrObjSurrogate wird die Listenart und die
 106 Ordnungsnummer des Objekts in dieser Liste geschrieben, sowie ggf.
 107 Angaben ueber die Seitennummer und das Grouping-Level (zzgl. der
 108 Ordnungszahlen der Objektgruppen).
 109 Wichtig ist zu wissen, dass die Verbindungen beim Einlesen erst
 110 nach vollstaendigem Einlesen des SdrModel wiederhergestellt werden
 111 koennen. Aus diesem Grund gibt es nach dem Einlesen des Models ein
 112 Post-Processing (Methode AfterRead() wird noch im Stream-Operator
 113 des Models am Model, an allen Pages und allen Objekten gerufen),
 114 in dem allen Objekten Gelegenheit gegeben wird, nun die ersehnten
 115 SdrObject* zu erlangen.
 116
 117 Surrogate koennen nur auf Objekte zeigen, die Member einer dem
 118 Model bekannten Listen sind (DrawPages,MasterPages)
 119
 120 Internes Datenformat im Stream
 121 1 Byte: Bit0-Bit4=Listenkennung. Siehe SdrObjListKind in SdrPage.HXX
 122         Bit5     =TRUE bedeutet Objekt ist gruppiert (so.)
 123         Bit6-Bit7=Byteanzahl m der Ordnungsnummern
 124                   00=1Byte, 01=2Byte, 10=reserviert, 11=4Byte
 125 wenn Listenkennung!=OBJLIST_UNKNOWN
 126   m Bytes: Ordnungsnummer des referenzierten Objekts
 127   wenn eine Page  angegeben ist (SdrIsPageKind(Listenkennung)=TRUE)
 128     2 Byte: USHORT : Seitennummer
 129   wenn Bit5=TRUE
 130     2 Byte: USHORT : Tiefe n der Objektschachtelung
 131     n*m Bytes      : Ordnungsnummern der jeweiligen Gruppenobjekte
 132
 133 Virtuelle Objekte und Symbolreferenzierungen benoetigen z.B. bei Ordnungszahlen
 134 bis 255 (also z.B. die ersten 256 Symbole) 2 Bytes im Stream.
 135 Bei Referenzierung eines Objektes das in einem Gruppenobjekt steckt kommen
 136 mind. 3 Bytes hinzu. Im unguenstigsten Fall liegt dieses Objekt auf einer
 137 anderen Seite (z.B. Texterweiterungsrahmen), was bedeutet, dass weitere 2 Bytes
 138 fuer die Seitennummer benoetigt werden.
 139 Ein absolutes Surrogat welches ein nichtgruppiertes Objekt auf einer Page
 140 repraesentiert benoetigt demzufolge mind. 4 Bytes und maximal 7 Bytes.
 141 Ein NULL-Surrogat schreibt stets nur 1 Byte in den Stream, naemlich eine 0.
 142 */
 143
 144 ////////////////////////////////////////////////////////////////////////////////////////////////////
 145
 146 }//end of namespace binfilter
 147 #endif //_SVDSURO_HXX
 148