/usr/include/podofo/doc/PdfIdentityEncoding.h is in libpodofo-dev 0.9.0-1.2+b2.
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 | /***************************************************************************
* Copyright (C) 2010 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. *
***************************************************************************/
#ifndef _PDF_IDENTITY_ENCODING_H_
#define _PDF_IDENTITY_ENCODING_H_
#include "podofo/base/PdfDefines.h"
#include "podofo/base/PdfEncoding.h"
namespace PoDoFo {
/** PdfIdentityEncoding is a two-byte encoding which can be
* used with TrueType fonts to represent all characters
* present in a font. If the font contains all unicode
* glyphs, PdfIdentityEncoding will support all unicode
* characters.
*/
class PODOFO_DOC_API PdfIdentityEncoding : public PdfEncoding {
public:
/**
* Create a new PdfIdentityEncoding.
*
* \param nFirstChar the first supported unicode character code (at least 0)
* \param nLastChar the last supported unicode character code,
* must be larger than nFirstChar (max value is 0xffff)
* \param bAutoDelete if true the encoding is deleted by its owning font
*/
PdfIdentityEncoding( int nFirstChar = 0, int nLastChar = 0xffff, bool bAutoDelete = true );
/** Add this encoding object to a dictionary
* usually be adding an /Encoding key in font dictionaries.
*
* \param rDictionary add the encoding to this dictionary
*/
virtual void AddToDictionary( PdfDictionary & rDictionary ) const;
/** Convert a string that is encoded with this encoding
* to an unicode PdfString.
*
* \param rEncodedString a string encoded by this encoding.
* Usually this string was read from a content stream.
* \param pFont the font for which this string is converted
*
* \returns an unicode PdfString.
*/
virtual PdfString ConvertToUnicode( const PdfString & rEncodedString, const PdfFont* pFont ) const;
/** Convert a unicode PdfString to a string encoded with this encoding.
*
* \param rString an unicode PdfString.
* \param pFont the font for which this string is converted
*
* \returns an encoded PdfRefCountedBuffer. The PdfRefCountedBuffer is treated as a series of bytes
* and is allowed to have 0 bytes. The returned buffer must not be a unicode string.
*/
virtual PdfRefCountedBuffer ConvertToEncoding( const PdfString & rString, const PdfFont* pFont ) const;
/**
* PdfIdentityEncoding is usually delete along with the font.
*
* \returns true if this encoding should be deleted automatically with the
* font.
*/
virtual bool IsAutoDelete() const;
/**
* \returns true if this is a single byte encoding with a maximum of 256 values.
*/
virtual bool IsSingleByteEncoding() const;
/** Get the unicode character code for this encoding
* at the position nIndex. nIndex is a position between
* GetFirstChar() and GetLastChar()
*
* \param nIndex character code at position index
* \returns unicode character code
*
* \see GetFirstChar
* \see GetLastChar
*
* Will throw an exception if nIndex is out of range.
*/
virtual pdf_utf16be GetCharCode( int nIndex ) const;
protected:
/** Get a unique ID for this encoding
* which can used for comparisons!
*
* \returns a unique id for this encoding!
*/
inline virtual const PdfName & GetID() const;
private:
/** Gets the unicode value from a char code in this font
*
* \param lCharCode the character code (i.e. glyph id)
*
* \returns an unicode value
*/
pdf_utf16be GetUnicodeValue( long lCharCode ) const;
private:
bool m_bAutoDelete; ///< If true this encoding is deleted by its font.
PdfName m_id; ///< Unique ID of this encoding
};
// -----------------------------------------------------
//
// -----------------------------------------------------
inline const PdfName & PdfIdentityEncoding::GetID() const
{
return m_id;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
inline bool PdfIdentityEncoding::IsAutoDelete() const
{
return m_bAutoDelete;
}
// -----------------------------------------------------
//
// -----------------------------------------------------
inline bool PdfIdentityEncoding::IsSingleByteEncoding() const
{
return false;
}
}; /* namespace PoDoFo */
#endif // _PDF_IDENTITY_ENCODING_H_
|