sd/source/filter/ppt/pptatom.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <filter/msfilter/dffrecordheader.hxx>
  23
  24 namespace ppt
  25 {
  26 class Atom
  27 {
  28 public:
  29     ~Atom();
  30
  31     /** imports this atom and its child atoms */
  32     static Atom* import(const DffRecordHeader& rRootRecordHeader, SvStream& rStCtrl);
  33
  34     /** @return true if at least one atom with the given nRecType is found */
  35     inline bool hasChildAtom(sal_uInt16 nRecType) const;
  36
  37     /** @return the first child atom with nRecType or NULL */
  38     inline const Atom* findFirstChildAtom(sal_uInt16 nRecType) const;
  39
  40     /** @return the next child atom after pLast with nRecType or NULL */
  41     const Atom* findNextChildAtom(sal_uInt16 nRecType, const Atom* pLast) const;
  42
  43     /** @return the first child atom or NULL */
  44     inline const Atom* findFirstChildAtom() const;
  45
  46     /** @return the next child atom after pLast or NULL */
  47     static inline const Atom* findNextChildAtom(const Atom* pLast);
  48
  49     /** @return true if this atom is a container */
  50     inline bool isContainer() const;
  51
  52     /** seeks to the contents of this atom */
  53     inline bool seekToContent() const;
  54
  55     /** @return the record type */
  56     inline sal_uInt16 getType() const;
  57
  58     /** @return the record instance */
  59     inline sal_uInt16 getInstance() const;
  60
  61     /** @return the record length */
  62     inline sal_uInt32 getLength() const;
  63
  64 private:
  65     Atom(const DffRecordHeader& rRecordHeader, SvStream& rStCtrl);
  66
  67     SvStream& mrStream;
  68     DffRecordHeader maRecordHeader;
  69     Atom* mpFirstChild;
  70     Atom* mpNextAtom;
  71 };
  72
  73 inline bool Atom::hasChildAtom(sal_uInt16 nRecType) const
  74 {
  75     return findFirstChildAtom(nRecType) != nullptr;
  76 }
  77
  78 inline const Atom* Atom::findFirstChildAtom(sal_uInt16 nRecType) const
  79 {
  80     return findNextChildAtom(nRecType, nullptr);
  81 }
  82
  83 inline const Atom* Atom::findFirstChildAtom() const { return mpFirstChild; }
  84
  85 inline const Atom* Atom::findNextChildAtom(const Atom* pLast)
  86 {
  87     return pLast ? pLast->mpNextAtom : pLast;
  88 }
  89
  90 inline bool Atom::isContainer() const { return maRecordHeader.IsContainer(); }
  91
  92 inline bool Atom::seekToContent() const
  93 {
  94     maRecordHeader.SeekToContent(mrStream);
  95     return mrStream.GetError() == ERRCODE_NONE;
  96 }
  97
  98 inline sal_uInt16 Atom::getType() const { return maRecordHeader.nRecType; }
  99
 100 inline sal_uInt16 Atom::getInstance() const { return maRecordHeader.nRecInstance; }
 101
 102 inline sal_uInt32 Atom::getLength() const { return maRecordHeader.nRecLen; }
 103
 104 } // namespace ppt
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */