/usr/include/podofo/base/PdfReference.h is in libpodofo-dev 0.9.3-4.
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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | /***************************************************************************
* Copyright (C) 2006 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_REFERENCE_H_
#define _PDF_REFERENCE_H_
#include "PdfDefines.h"
#include "PdfDataType.h"
namespace PoDoFo {
typedef pdf_uint32 pdf_objnum;
/* Technically a generation number must be able to represent 99999 so 65535 isn't good enough.
* In practice Adobe's implementation notes suggest that they use a uint16 internally, and PDFs
* with greater object numbers won't work on many viewers. So we'll stick with uint16.
*
* If you change this you'll need to change PdfReference::Write(...) to use the apppropriate
* format, too. */
typedef pdf_uint16 pdf_gennum;
class PdfOutputDevice;
/**
* A reference is a pointer to a object in the PDF file of the form
* "4 0 R", where 4 is the object number and 0 is the generation number.
* Every object in the PDF file can be identified this way.
*
* This class is a indirect reference in a PDF file.
*/
class PODOFO_API PdfReference : public PdfDataType {
public:
/**
* Create a PdfReference with object number and generation number
* initialized to 0.
*/
PdfReference()
: m_nObjectNo( 0 ), m_nGenerationNo( 0 )
{
}
/**
* Create a PdfReference to an object with a given object and generation number.
*
* \param nObjectNo the object number
* \param nGenerationNo the generation number
*/
PdfReference( const pdf_objnum nObjectNo, const pdf_gennum nGenerationNo )
: m_nObjectNo( nObjectNo ), m_nGenerationNo( nGenerationNo )
{
}
/**
* Create a copy of an existing PdfReference.
*
* \param rhs the object to copy
*/
PdfReference( const PdfReference & rhs ) : PdfDataType()
{
this->operator=( rhs );
}
PODOFO_NOTHROW virtual ~PdfReference() { }
/** Convert the reference to a string.
* \returns a string representation of the object.
*
* \see PdfVariant::ToString
*/
const std::string ToString() const;
/**
* Assign the value of another object to this PdfReference.
*
* \param rhs the object to copy
*/
PODOFO_NOTHROW inline const PdfReference & operator=( const PdfReference & rhs );
/** Write the complete variant to an output device.
* This is an overloaded member function.
*
* \param pDevice write the object to this device
* \param eWriteMode additional options for writing this object
* \param pEncrypt an encryption object which is used to encrypt this object
* or NULL to not encrypt this object
*/
void Write( PdfOutputDevice* pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt* pEncrypt = NULL ) const;
/**
* Compare to PdfReference objects.
* \returns true if both reference the same object
*/
PODOFO_NOTHROW inline bool operator==( const PdfReference & rhs ) const;
/**
* Compare to PdfReference objects.
* \returns false if both reference the same object
*/
PODOFO_NOTHROW inline bool operator!=( const PdfReference & rhs ) const;
/**
* Compare to PdfReference objects.
* \returns true if this reference has a smaller object and generation number
*/
PODOFO_NOTHROW inline bool operator<( const PdfReference & rhs ) const;
/** Set the object number of this object
* \param o the new object number
*/
PODOFO_NOTHROW inline void SetObjectNumber( pdf_objnum o );
/** Get the object number.
* \returns the object number of this PdfReference
*/
PODOFO_NOTHROW inline pdf_objnum ObjectNumber() const;
/** Set the generation number of this object
* \param g the new generation number
*/
PODOFO_NOTHROW inline void SetGenerationNumber( const pdf_gennum g );
/** Get the generation number.
* \returns the generation number of this PdfReference
*/
PODOFO_NOTHROW inline pdf_gennum GenerationNumber() const;
/** Allows to check if a reference points to an indirect
* object.
*
* A reference is indirect if object number and generation
* number are both not equal 0.
*
* \returns true if this reference is the reference of
* an indirect object.
*/
PODOFO_NOTHROW inline bool IsIndirect() const;
private:
pdf_objnum m_nObjectNo;
pdf_gennum m_nGenerationNo;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
const PdfReference & PdfReference::operator=( const PdfReference & rhs )
{
m_nObjectNo = rhs.m_nObjectNo;
m_nGenerationNo = rhs.m_nGenerationNo;
return *this;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
bool PdfReference::operator<( const PdfReference & rhs ) const
{
return m_nObjectNo == rhs.m_nObjectNo ? m_nGenerationNo < rhs.m_nGenerationNo : m_nObjectNo < rhs.m_nObjectNo;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
bool PdfReference::operator==( const PdfReference & rhs ) const
{
return ( m_nObjectNo == rhs.m_nObjectNo && m_nGenerationNo == rhs.m_nGenerationNo);
}
// -----------------------------------------------------
//
// -----------------------------------------------------
inline bool PdfReference::operator!=( const PdfReference & rhs ) const
{
return !this->operator==( rhs );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfReference::SetObjectNumber( pdf_objnum o )
{
m_nObjectNo = o;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
pdf_objnum PdfReference::ObjectNumber() const
{
return m_nObjectNo;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
void PdfReference::SetGenerationNumber( pdf_gennum g )
{
m_nGenerationNo = g;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
pdf_gennum PdfReference::GenerationNumber() const
{
return m_nGenerationNo;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
bool PdfReference::IsIndirect() const
{
return !( !m_nObjectNo && !m_nGenerationNo );
}
};
#endif // _PDF_REFERENCE_H_
|