sd/source/filter/ppt/pptatom.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: pptatom.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 _PPTATOM_HXX_
  32 #define _PPTATOM_HXX_
  33
  34 #include <svx/msdffdef.hxx>
  35
  36 class SvStream;
  37
  38 namespace ppt
  39 {
  40
  41 class Atom
  42 {
  43 public:
  44     ~Atom();
  45
  46     /** imports this atom and its child atoms */
  47     static Atom* import( const DffRecordHeader& rRootRecordHeader, SvStream& rStCtrl );
  48
  49     inline const DffRecordHeader& getHeader() const;
  50
  51     /** returns true if at least one atim with the given nRecType is found */
  52     inline bool hasChildAtom( sal_uInt16 nRecType ) const;
  53
  54     /** returns true if at least one atim with the given nRecType and nRecInstnace is found */
  55     inline bool hasChildAtom( sal_uInt16 nRecType, sal_uInt16 nRecInstance ) const;
  56
  57     /** returns the first child atom with nRecType or NULL */
  58     inline const Atom* findFirstChildAtom( sal_uInt16 nRecType ) const;
  59
  60     /** returns the next child atom after pLast with nRecType or NULL */
  61     const Atom* findNextChildAtom( sal_uInt16 nRecType, const Atom* pLast ) const;
  62
  63     /** returns the first child atom with nRecType and nRecInstance or NULL */
  64     inline const Atom* findFirstChildAtom( sal_uInt16 nRecType, sal_uInt16 nRecInstance ) const;
  65
  66     /** returns the next child atom after pLast with nRecType and nRecInstance or NULL */
  67     const Atom* findNextChildAtom( sal_uInt16 nRecType, sal_uInt16 nRecInstance, const Atom* pLast ) const;
  68
  69     /** returns the first child atom or NULL */
  70     inline const Atom* findFirstChildAtom() const;
  71
  72     /** returns the next child atom after pLast or NULL */
  73     inline const Atom* findNextChildAtom( const Atom* pLast ) const;
  74
  75     /** returns true if this atom is a container */
  76     inline bool isContainer() const;
  77
  78     /** seeks to the contents of this atom */
  79     inline bool seekToContent() const;
  80
  81     /** returns the record type */
  82     inline sal_uInt16 getType() const;
  83
  84     /** returns the record instance */
  85     inline sal_uInt16 getInstance() const;
  86
  87     /** returns the record length */
  88     inline sal_uInt32 getLength() const;
  89
  90 private:
  91     Atom( const DffRecordHeader& rRecordHeader, SvStream& rStCtrl );
  92
  93     SvStream& mrStream;
  94     DffRecordHeader maRecordHeader;
  95     Atom* mpFirstChild;
  96     Atom* mpNextAtom;
  97 };
  98
  99 inline bool Atom::hasChildAtom( sal_uInt16 nRecType ) const
 100 {
 101     return findFirstChildAtom( nRecType ) != NULL;
 102 }
 103
 104 inline bool Atom::hasChildAtom( sal_uInt16 nRecType, sal_uInt16 nRecInstance ) const
 105 {
 106     return findFirstChildAtom( nRecType, nRecInstance ) != NULL;
 107 }
 108
 109 inline const Atom* Atom::findFirstChildAtom( sal_uInt16 nRecType ) const
 110 {
 111     return findNextChildAtom( nRecType, NULL );
 112 }
 113
 114 inline const DffRecordHeader& Atom::getHeader() const
 115 {
 116     return maRecordHeader;
 117 }
 118
 119 inline const Atom* Atom::findFirstChildAtom( sal_uInt16 nRecType, sal_uInt16 nRecInstance ) const
 120 {
 121     return findNextChildAtom( nRecType, nRecInstance, NULL );
 122 }
 123
 124 inline const Atom* Atom::findFirstChildAtom() const
 125 {
 126     return mpFirstChild;
 127 }
 128
 129 inline const Atom* Atom::findNextChildAtom( const Atom* pLast ) const
 130 {
 131     return pLast ? pLast->mpNextAtom : pLast;
 132 }
 133
 134 inline bool Atom::isContainer() const
 135 {
 136     return (bool)maRecordHeader.IsContainer();
 137 }
 138
 139 inline bool Atom::seekToContent() const
 140 {
 141     maRecordHeader.SeekToContent( mrStream );
 142     return mrStream.GetError() == 0;
 143 }
 144
 145 inline sal_uInt16 Atom::getType() const
 146 {
 147     return maRecordHeader.nRecType;
 148 }
 149
 150 inline sal_uInt16 Atom::getInstance() const
 151 {
 152     return maRecordHeader.nRecInstance;
 153 }
 154
 155 inline sal_uInt32 Atom::getLength() const
 156 {
 157     return maRecordHeader.nRecLen;
 158 }
 159
 160 } // namespace ppt
 161
 162 #endif