/usr/include/podofo/base/PdfOutputDevice.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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | /***************************************************************************
* 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_OUTPUT_DEVICE_H_
#define _PDF_OUTPUT_DEVICE_H_
#include <cstdarg>
#include <ostream>
#include "PdfDefines.h"
#include "PdfLocale.h"
#include "PdfRefCountedBuffer.h"
namespace PoDoFo {
/** This class provides an output device which operates
* either on a file or on a buffer in memory.
* Additionally it can count the bytes written to the device.
*
* This class is suitable for inheritance to provide output
* devices of your own for PoDoFo.
* Just overide the required virtual methods.
*/
class PODOFO_API PdfOutputDevice {
public:
/** Construct a new PdfOutputDevice that does not write any data. Only the length
* of the data is counted.
*
*/
PdfOutputDevice();
/** Construct a new PdfOutputDevice that writes all data to a file.
*
* \param pszFilename path to a file that will be opened and all data
* is written to this file.
*/
PdfOutputDevice( const char* pszFilename );
#ifdef _WIN32
/** Construct a new PdfOutputDevice that writes all data to a file.
*
* \param pszFilename path to a file that will be opened and all data
* is written to this file.
*
* This is an overloaded member function to allow working
* with unicode characters. On Unix systes you can also path
* UTF-8 to the const char* overload.
*/
PdfOutputDevice( const wchar_t* pszFilename );
#endif // _WIN32
/** Construct a new PdfOutputDevice that writes all data to a memory buffer.
* The buffer will not be owned by this object and has to be allocated before.
*
* \param pBuffer a buffer in memory
* \param lLen the length of the buffer in memory
*/
PdfOutputDevice( char* pBuffer, size_t lLen );
/** Construct a new PdfOutputDevice that writes all data to a std::ostream.
*
* WARNING: PoDoFo will change the stream's locale. It will be restored when
* the PdfOutputStream controlling the stream is destroyed.
*
* \param pOutStream write to this std::ostream
*/
PdfOutputDevice( const std::ostream* pOutStream );
/** Construct a new PdfOutputDevice that writes all data to a PdfRefCountedBuffer.
* This output device has the advantage that the PdfRefCountedBuffer will resize itself
* if more memory is needed to hold all data.
*
* \param pOutBuffer write to this PdfRefCountedBuffer
*
* \see PdfRefCountedBuffer
*/
PdfOutputDevice( PdfRefCountedBuffer* pOutBuffer );
/** Destruct the PdfOutputDevice object and close any open files.
*/
virtual ~PdfOutputDevice();
/** The number of bytes written to this object.
* \returns the number of bytes written to this object.
*
* \see Init
*/
virtual inline size_t GetLength() const;
/** Write to the PdfOutputDevice. Usage is as the usage of printf.
*
* WARNING: Do not use this for doubles or floating point values
* as the output might depend on the current locale.
*
* \param pszFormat a format string as you would use it with printf
*
* \see Write
*/
virtual void Print( const char* pszFormat, ... );
/** Write to the PdfOutputDevice. Usage is as the usage of printf.
*
* WARNING: Do not use this for doubles or floating point values
* as the output might depend on the current locale.
*
* \param pszFormat a format string as you would use it with printf
* \param lBytes length of the format string in bytes when written
* \param argptr variable argument list
*
* \see Write
*/
virtual void PrintV( const char* pszFormat, long lBytes, va_list argptr );
/**
* Determine the length of a format string in bytes
* when written using PrintV
*
* \param pszFormat format string
* \param args variable argument list
*
* \returns length in bytes
* \see PrintV
*/
long PrintVLen( const char* pszFormat, va_list args );
/** Write data to the buffer. Use this call instead of Print if you
* want to write binary data to the PdfOutputDevice.
*
* \param pBuffer a pointer to the data buffer
* \param lLen write lLen bytes of pBuffer to the PdfOutputDevice
*
* \see Print
*/
virtual void Write( const char* pBuffer, size_t lLen );
/** Read data from the device
* \param pBuffer a pointer to the data buffer
* \param lLen length of the output buffer
* \returns Number of read bytes. Return 0 if EOF
*/
virtual size_t Read( char* pBuffer, size_t lLen );
/** Seek the device to the position offset from the begining
* \param offset from the beginning of the file
*/
virtual void Seek( size_t offset );
/** Get the current offset from the beginning of the file.
* \return the offset form the beginning of the file.
*/
virtual inline size_t Tell() const;
/** Flush the output files buffer to disk if this devices
* operates on a disk.
*/
virtual void Flush();
private:
/** Initialize all private members
*/
void Init();
protected:
size_t m_ulLength;
private:
FILE* m_hFile;
char* m_pBuffer;
size_t m_lBufferLen;
std::ostream* m_pStream;
std::istream* m_pReadStream;
bool m_pStreamOwned;
#if USE_CXX_LOCALE
std::locale m_pStreamSavedLocale;
#endif
PdfRefCountedBuffer* m_pRefCountedBuffer;
size_t m_ulPosition;
PdfRefCountedBuffer m_printBuffer;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
size_t PdfOutputDevice::GetLength() const
{
return m_ulLength;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
size_t PdfOutputDevice::Tell() const
{
return m_ulPosition;
}
};
#endif // _PDF_OUTPUT_DEVICE_H_
|