lotuswordpro/source/filter/lwpobjhdr.hxx

   1 /*************************************************************************
   2  *
   3  *  The Contents of this file are made available subject to the terms of
   4  *  either of the following licenses
   5  *
   6  *         - GNU Lesser General Public License Version 2.1
   7  *         - Sun Industry Standards Source License Version 1.1
   8  *
   9  *  Sun Microsystems Inc., October, 2000
  10  *
  11  *  GNU Lesser General Public License Version 2.1
  12  *  =============================================
  13  *  Copyright 2000 by Sun Microsystems, Inc.
  14  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  15  *
  16  *  This library is free software; you can redistribute it and/or
  17  *  modify it under the terms of the GNU Lesser General Public
  18  *  License version 2.1, as published by the Free Software Foundation.
  19  *
  20  *  This library is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  *  Lesser General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU Lesser General Public
  26  *  License along with this library; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  28  *  MA  02111-1307  USA
  29  *
  30  *
  31  *  Sun Industry Standards Source License Version 1.1
  32  *  =================================================
  33  *  The contents of this file are subject to the Sun Industry Standards
  34  *  Source License Version 1.1 (the "License"); You may not use this file
  35  *  except in compliance with the License. You may obtain a copy of the
  36  *  License at http://www.openoffice.org/license.html.
  37  *
  38  *  Software provided under this License is provided on an "AS IS" basis,
  39  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  40  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  41  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  42  *  See the License for the specific provisions governing your rights and
  43  *  obligations concerning the Software.
  44  *
  45  *  The Initial Developer of the Original Code is: IBM Corporation
  46  *
  47  *  Copyright: 2008 by IBM Corporation
  48  *
  49  *  All Rights Reserved.
  50  *
  51  *  Contributor(s): _______________________________________
  52  *
  53  *
  54  ************************************************************************/
  55 /*************************************************************************
  56  * @file
  57  *  For LWP filter architecture prototype
  58  ************************************************************************/
  59 /*************************************************************************
  60  * Change History
  61  Jan 2005                       Created
  62  ************************************************************************/
  63
  64
  65 #ifndef _LWPOBJECTHEADER_HXX
  66 #define _LWPOBJECTHEADER_HXX
  67
  68 #include "lwpobjid.hxx"
  69 #include "lwpobjtags.hxx"
  70 /**
  71  * @brief       Base class of all Lwp VO objects
  72 */
  73 class LwpObjectHeader
  74 {
  75 public:
  76         LwpObjectHeader();
  77 private:
  78         sal_uInt32 m_nTag;
  79         LwpObjectID m_ID;
  80         sal_uInt32 m_nSize;             //Data size
  81         sal_Bool m_bCompressed;
  82
  83         //localize the following memebers to save memory
  84         //sal_uInt8 m_nFlagBits;
  85         //sal_uInt32 m_nVersionID;
  86         //sal_uInt32 m_nRefCount;
  87         //sal_uInt32 m_nNextVersionOffset;
  88         //sal_uInt32 m_nNextVersionID;
  89         //sal_uInt32 m_nHeaderSize;
  90
  91         enum
  92         {
  93                 VERSION_BITS                    = 0x03,
  94                 DEFAULT_VERSION                 = 0x00,
  95                 ONE_BYTE_VERSION                = 0x01,
  96                 TWO_BYTE_VERSION                = 0x02,
  97                 FOUR_BYTE_VERSION               = 0x03,
  98
  99                 REFCOUNT_BITS                   = 0x0C,
 100                 ONE_BYTE_REFCOUNT               = 0x04,
 101                 TWO_BYTE_REFCOUNT               = 0x08,
 102                 FOUR_BYTE_REFCOUNT              = 0x0C,
 103
 104                 SIZE_BITS                               = 0x30,
 105                 ONE_BYTE_SIZE                   = 0x10,
 106                 TWO_BYTE_SIZE                   = 0x20,
 107                 FOUR_BYTE_SIZE                  = 0x30,
 108
 109                 HAS_PREVOFFSET                  = 0x40,
 110                 DATA_COMPRESSED         = 0x80
 111         };
 112
 113 public:
 114         void Read(LwpSvStream &pStrm);
 115         inline sal_uInt32 GetTag();
 116         inline sal_uInt32 GetSize();
 117         inline LwpObjectID* GetID();
 118         inline sal_Bool IsCompressed();
 119 };
 120
 121 inline sal_uInt32 LwpObjectHeader::GetTag()
 122 {
 123         return m_nTag;
 124 }
 125 inline sal_uInt32 LwpObjectHeader::GetSize()
 126 {
 127         return m_nSize;
 128 }
 129 inline LwpObjectID* LwpObjectHeader::GetID()
 130 {
 131         return &m_ID;
 132 }
 133 inline sal_Bool LwpObjectHeader::IsCompressed()
 134 {
 135         return m_bCompressed;
 136 }
 137 #endif