/usr/include/podofo/base/PdfParserObject.h is in libpodofo-dev 0.9.4-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | /***************************************************************************
* Copyright (C) 2005 by Dominik Seichter *
* domseichter@web.de *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Library General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program 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 General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
* *
* In addition, as a special exception, the copyright holders give *
* permission to link the code of portions of this program with the *
* OpenSSL library under certain conditions as described in each *
* individual source file, and distribute linked combinations *
* including the two. *
* You must obey the GNU General Public License in all respects *
* for all of the code used other than OpenSSL. If you modify *
* file(s) with this exception, you may extend this exception to your *
* version of the file(s), but you are not obligated to do so. If you *
* do not wish to do so, delete this exception statement from your *
* version. If you delete this exception statement from all source *
* files in the program, then also delete it here. *
***************************************************************************/
#ifndef _PDF_PARSER_OBJECT_H_
#define _PDF_PARSER_OBJECT_H_
#include "PdfDefines.h"
#include "PdfObject.h"
#include "PdfTokenizer.h"
namespace PoDoFo {
class PdfEncrypt;
class PdfParser;
/**
* A PdfParserObject constructs a PdfObject from a PDF file.
* Parsing starts always at the current file position.
*/
class PODOFO_API PdfParserObject : public PdfObject, public PdfTokenizer {
public:
/** Parse the object data from the given file handle starting at
* the current position.
* \param pCreator pointer to a PdfVecObjects to resolve object references
* \param rDevice an open reference counted input device which is positioned in
* front of the object which is going to be parsed.
* \param rBuffer buffer to use for parsing to avoid reallocations
* \param lOffset the position in the device from which the object shall be read
* if lOffset = -1, the object will be read from the current
* position in the file.
*/
PdfParserObject( PdfVecObjects* pCreator, const PdfRefCountedInputDevice & rDevice, const PdfRefCountedBuffer & rBuffer, pdf_long lOffset = -1 );
/** Parse the object data for an internal object.
* You have to call ParseDictionaryKeys as next function call.
*
* The following two parameters are used to avoid allocation of a new
* buffer in PdfSimpleParser.
*
* \warning This constructor is for internal usage only!
*
* \param rBuffer buffer to use for parsing to avoid reallocations
*/
explicit PdfParserObject( const PdfRefCountedBuffer & rBuffer );
virtual ~PdfParserObject();
/** Parse the object data from the given file handle
* If delayed loading is enabled, only the object and generation number
* is read now and everything else is read later.
*
* \param pEncrypt an encryption dictionary which is used to decrypt
* strings and streams during parsing or NULL if the PDF
* file was not encrypted
* \param bIsTrailer wether this is a trailer dictionary or not.
* trailer dictionaries do not have a object number etc.
*/
void ParseFile( PdfEncrypt* pEncrypt, bool bIsTrailer = false );
/** Returns if this object has a stream object appended.
* which has to be parsed.
* \returns true if there is a stream
*/
inline bool HasStreamToParse() const;
/** \returns true if this PdfParser loads all objects at
* the time they are accessed for the first time.
* The default is to load all object immediately.
* In this case false is returned.
*/
inline bool IsLoadOnDemand() const;
/** Sets wether this object shall be loaded on demand
* when it's data is accessed for the first time.
* \param bDelayed if true the object is loaded delayed.
*/
inline void SetLoadOnDemand( bool bDelayed );
/** Set the object number of this object.
* It is almost never necessary to use this call.
* It is only included for usage in the PdfParser.
*
* \param nObjNo the new object number of this object
*/
inline void SetObjectNumber( unsigned int nObjNo );
/** Tries to free all memory allocated by this
* PdfObject (variables and streams) and reads
* it from disk again if it is requested another time.
*
* This will only work if load on demand is used.
* If the object is dirty if will not be free'd.
*
* \param bForce if true the object will be free'd
* even if IsDirty() returns true.
* So you will loose any changes made
* to this object.
*
* \see IsLoadOnDemand
* \see IsDirty
*/
void FreeObjectMemory( bool bForce = false );
protected:
/** Load all data of the object if load object on demand is enabled.
* Reimplemented from PdfVariant. Do not call this directly, use
* DelayedLoad().
*/
virtual void DelayedLoadImpl();
/** Load the stream of the object if it has one and if loading on demand is enabled.
* Reimplemented from PdfObject. Do not call this directly, use
* DelayedStreamLoad().
*/
virtual void DelayedStreamLoadImpl();
/** Starts reading at the file position m_lStreamOffset and interprets all bytes
* as contents of the objects stream.
* It is assumed that the dictionary has a valid /Length key already.
*
* Called from DelayedStreamLoadImpl(). Do not call directly.
*/
void ParseStream();
private:
/** Initialize private members in this object with their default values
*/
void InitPdfParserObject();
/** Parse the object data from the given file handle
* \param bIsTrailer wether this is a trailer dictionary or not.
* trailer dictionaries do not have a object number etc.
*/
void ParseFileComplete( bool bIsTrailer );
void ReadObjectNumber();
private:
PdfEncrypt* m_pEncrypt;
bool m_bIsTrailer;
// Should the object try to defer loading of its contents until needed?
// If false, object contents will be loaded during ParseFile(...). Note that
// this still uses the delayed loading infrastructure.
// If true, loading will be triggered the first time the information is needed by
// an external caller.
// Outside callers should not be able to tell the difference between the two modes
// of operation.
bool m_bLoadOnDemand;
pdf_long m_lOffset;
bool m_bStream;
pdf_long m_lStreamOffset;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfParserObject::SetObjectNumber( unsigned int nObjNo )
{
m_reference.SetObjectNumber( nObjNo );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
bool PdfParserObject::IsLoadOnDemand() const
{
return m_bLoadOnDemand;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfParserObject::SetLoadOnDemand( bool bDelayed )
{
m_bLoadOnDemand = bDelayed;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
bool PdfParserObject::HasStreamToParse() const
{
return m_bStream;
}
};
#endif // _PDF_PARSER_OBJECT_H_
|