/usr/include/podofo/doc/PdfNamesTree.h is in libpodofo-dev 0.9.5-9.
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 | /***************************************************************************
* 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_NAMES_TREE_H_
#define _PDF_NAMES_TREE_H_
#include "podofo/base/PdfDefines.h"
#include "PdfElement.h"
namespace PoDoFo {
class PdfDictionary;
class PdfName;
class PdfObject;
class PdfString;
class PdfVecObjects;
enum EPdfNameLimits {
ePdfNameLimits_Before,
ePdfNameLimits_Inside,
ePdfNameLimits_After
};
class PODOFO_DOC_API PdfNamesTree : public PdfElement {
public:
/** Create a new PdfNamesTree object
* \param pParent parent of this action
*/
PdfNamesTree( PdfVecObjects* pParent );
/** Create a PdfNamesTree object from an existing PdfObject
* \param pObject the object to create from
* \param pCatalog the Catalog dictionary of the owning PDF
*/
PdfNamesTree( PdfObject* pObject, PdfObject* pCatalog );
virtual ~PdfNamesTree() { }
/** Insert a key and value in one of the dictionaries of the name tree.
* \param tree name of the tree to search for the key.
* \param key the key to insert. If it exists, it will be overwritten.
* \param rValue the value to insert.
*/
void AddValue( const PdfName & tree, const PdfString & key, const PdfObject & rValue );
/** Get the object referenced by a string key in one of the dictionaries
* of the name tree.
* \param tree name of the tree to search for the key.
* \param key the key to search for
* \returns the value of the key or NULL if the key was not found.
* if the value is a reference, the object referenced by
* this reference is returned.
*/
PdfObject* GetValue( const PdfName & tree, const PdfString & key ) const;
/** Tests wether a certain nametree has a value.
*
* It is generally faster to use GetValue and check for NULL
* as return value.
*
* \param tree name of the tree to search for the key.
* \param key name of the key to look for
* \returns true if the dictionary has such a key.
*/
bool HasValue( const PdfName & tree, const PdfString & key ) const;
/** Tests wether a key is in the range of a limits entry of a name tree node
* \returns ePdfNameLimits_Inside if the key is inside of the range
* \returns ePdfNameLimits_After if the key is greater than the specified range
* \returns ePdfNameLimits_Before if the key is smalelr than the specified range
*
* Internal use only.
*/
static EPdfNameLimits CheckLimits( const PdfObject* pObj, const PdfString & key );
/**
* Adds all keys and values from a name tree to a dictionary.
* Removes all keys that have been previously in the dictionary.
*
* \param tree the name of the tree to convert into a dictionary
* \param rDict add all keys and values to this dictionary
*/
void ToDictionary( const PdfName & dictionary, PdfDictionary& rDict );
/** Peter Petrov: 23 May 2008
* I have made it for access to "JavaScript" dictonary. This is "document-level javascript storage"
* \param bCreate if true the javascript node is created if it does not exists.
*/
inline PdfObject* GetJavaScriptNode(bool bCreate = false) const;
/** Peter Petrov: 6 June 2008
* I have made it for access to "Dest" dictionary. This is "document-level named destination storage"
* \param bCreate if true the dests node is created if it does not exists.
*/
inline PdfObject* GetDestsNode(bool bCreate = false) const;
private:
/** Get a PdfNameTrees root node for a certain name.
* \param name that identifies a specific name tree.
* Valid names are:
* - Dests
* - AP
* - JavaScript
* - Pages
* - Templates
* - IDS
* - URLS
* - EmbeddedFiles
* - AlternatePresentations
* - Renditions
*
* \param bCreate if true the root node is created if it does not exists.
* \returns the root node of the tree or NULL if it does not exists
*/
PdfObject* GetRootNode( const PdfName & name, bool bCreate = false ) const;
/** Recursively walk through the name tree and find the value for key.
* \param pObj the name tree
* \param key the key to find a value for
* \return the value for the key or NULL if it was not found
*/
PdfObject* GetKeyValue( PdfObject* pObj, const PdfString & key ) const;
/**
* Add all keys and values from an object and its children to a dictionary.
* \param pObj a pdf name tree node
* \param rDict a dictionary
*/
void AddToDictionary( PdfObject* pObj, PdfDictionary & rDict );
private:
PdfObject* m_pCatalog;
};
// -----------------------------------------------------
//
// -----------------------------------------------------
PdfObject* PdfNamesTree::GetJavaScriptNode(bool bCreate) const
{
return this->GetRootNode( PdfName("JavaScript"), bCreate );
}
// -----------------------------------------------------
//
// -----------------------------------------------------
PdfObject* PdfNamesTree::GetDestsNode(bool bCreate) const
{
return this->GetRootNode( PdfName("Dests"), bCreate );
}
};
#endif // _PDF_NAMES_TREE_H_
|