summaryrefslogtreecommitdiffstats
path: root/lotuswordpro/inc/lwpobjhdr.hxx
blob: e61b587f3190c2c1bb83fa01aba946a3094417aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: IBM Corporation
 *
 *  Copyright: 2008 by IBM Corporation
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
/*************************************************************************
 * @file
 *  For LWP filter architecture prototype
 ************************************************************************/

#ifndef INCLUDED_LOTUSWORDPRO_INC_LWPOBJHDR_HXX
#define INCLUDED_LOTUSWORDPRO_INC_LWPOBJHDR_HXX

#include <config_lgpl.h>
#include "lwpobjid.hxx"

/**
 * @brief   Base class of all Lwp VO objects
*/
class LwpObjectHeader
{
public:
    LwpObjectHeader();
private:
    sal_uInt32 m_nTag;
    LwpObjectID m_ID;
    sal_uInt32 m_nSize;     //Data size
    bool m_bCompressed;

    //localize the following members to save memory
    //sal_uInt8 m_nFlagBits;
    //sal_uInt32 m_nVersionID;
    //sal_uInt32 m_nRefCount;
    //sal_uInt32 m_nNextVersionOffset;
    //sal_uInt32 m_nNextVersionID;
    //sal_uInt32 m_nHeaderSize;

    enum
    {
        VERSION_BITS            = 0x03,
        DEFAULT_VERSION         = 0x00,
        ONE_BYTE_VERSION        = 0x01,
        TWO_BYTE_VERSION        = 0x02,
        FOUR_BYTE_VERSION       = 0x03,

        REFCOUNT_BITS           = 0x0C,
        ONE_BYTE_REFCOUNT       = 0x04,
        TWO_BYTE_REFCOUNT       = 0x08,
        FOUR_BYTE_REFCOUNT      = 0x0C,

        SIZE_BITS               = 0x30,
        ONE_BYTE_SIZE           = 0x10,
        TWO_BYTE_SIZE           = 0x20,
        FOUR_BYTE_SIZE          = 0x30,

        HAS_PREVOFFSET          = 0x40,
        DATA_COMPRESSED     = 0x80
    };

public:
    bool Read(LwpSvStream &pStrm);
    inline sal_uInt32 GetTag() const;
    inline sal_uInt32 GetSize() const;
    inline LwpObjectID& GetID();
    inline bool IsCompressed() const;
};

inline sal_uInt32 LwpObjectHeader::GetTag() const
{
    return m_nTag;
}
inline sal_uInt32 LwpObjectHeader::GetSize() const
{
    return m_nSize;
}
inline LwpObjectID& LwpObjectHeader::GetID()
{
    return m_ID;
}
inline bool LwpObjectHeader::IsCompressed() const
{
    return m_bCompressed;
}
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */