lotuswordpro/source/filter/lwpobjhdr.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  either of the following licenses
   6  *
   7  *         - GNU Lesser General Public License Version 2.1
   8  *         - Sun Industry Standards Source License Version 1.1
   9  *
  10  *  Sun Microsystems Inc., October, 2000
  11  *
  12  *  GNU Lesser General Public License Version 2.1
  13  *  =============================================
  14  *  Copyright 2000 by Sun Microsystems, Inc.
  15  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  16  *
  17  *  This library is free software; you can redistribute it and/or
  18  *  modify it under the terms of the GNU Lesser General Public
  19  *  License version 2.1, as published by the Free Software Foundation.
  20  *
  21  *  This library is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  *  Lesser General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU Lesser General Public
  27  *  License along with this library; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  *  MA  02111-1307  USA
  30  *
  31  *
  32  *  Sun Industry Standards Source License Version 1.1
  33  *  =================================================
  34  *  The contents of this file are subject to the Sun Industry Standards
  35  *  Source License Version 1.1 (the "License"); You may not use this file
  36  *  except in compliance with the License. You may obtain a copy of the
  37  *  License at http://www.openoffice.org/license.html.
  38  *
  39  *  Software provided under this License is provided on an "AS IS" basis,
  40  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  41  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  42  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  43  *  See the License for the specific provisions governing your rights and
  44  *  obligations concerning the Software.
  45  *
  46  *  The Initial Developer of the Original Code is: IBM Corporation
  47  *
  48  *  Copyright: 2008 by IBM Corporation
  49  *
  50  *  All Rights Reserved.
  51  *
  52  *  Contributor(s): _______________________________________
  53  *
  54  *
  55  ************************************************************************/
  56 /*************************************************************************
  57  * @file
  58  *  For LWP filter architecture prototype
  59  ************************************************************************/
  60 /*************************************************************************
  61  * Change History
  62  Jan 2005           Created
  63  ************************************************************************/
  64
  65 #ifndef INCLUDED_LOTUSWORDPRO_SOURCE_FILTER_LWPOBJHDR_HXX
  66 #define INCLUDED_LOTUSWORDPRO_SOURCE_FILTER_LWPOBJHDR_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     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     bool Read(LwpSvStream &pStrm);
 115     inline sal_uInt32 GetTag();
 116     inline sal_uInt32 GetSize();
 117     inline LwpObjectID* GetID();
 118     inline 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 bool LwpObjectHeader::IsCompressed()
 134 {
 135     return m_bCompressed;
 136 }
 137 #endif
 138
 139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */