//======================================================================== // // Dict.h // // Copyright 1996-2003 Glyph & Cog, LLC // //======================================================================== //======================================================================== // // Modified under the Poppler project - http://poppler.freedesktop.org // // All changes made under the Poppler project to this file are licensed // under GPL version 2 or later // // Copyright (C) 2005 Kristian Høgsberg // Copyright (C) 2006 Krzysztof Kowalczyk // Copyright (C) 2007-2008 Julien Rebetez // Copyright (C) 2010, 2017-2022 Albert Astals Cid // Copyright (C) 2010 Paweł Wiejacha // Copyright (C) 2013 Thomas Freitag // Copyright (C) 2017 Adrian Johnson // Copyright (C) 2018 Adam Reichold // // To see a description of the changes please see the Changelog file that // came with your tarball or type make ChangeLog if you are building from git // //======================================================================== #ifndef DICT_H #define DICT_H #include #include #include #include #include #include "poppler-config.h" #include "poppler_private_export.h" #include "Object.h" //------------------------------------------------------------------------ // Dict //------------------------------------------------------------------------ class POPPLER_PRIVATE_EXPORT Dict { public: // Constructor. explicit Dict(XRef *xrefA); explicit Dict(const Dict *dictA); Dict *copy(XRef *xrefA) const; Dict *deepCopy() const; Dict(const Dict &) = delete; Dict &operator=(const Dict &) = delete; // Get number of entries. int getLength() const { return static_cast(entries.size()); } // Add an entry. (Copies key into Dict.) // val becomes a dead object after the call void add(const char *key, Object &&val); // Add an entry. (Takes ownership of key.) void add(char *key, Object &&val) = delete; // Update the value of an existing entry, otherwise create it // val becomes a dead object after the call void set(const char *key, Object &&val); // Remove an entry. This invalidate indexes void remove(const char *key); // Check if dictionary is of specified type. bool is(const char *type) const; // Look up an entry and return the value. Returns a null object // if is not in the dictionary. Object lookup(const char *key, int recursion = 0) const; // Same as above but if the returned object is a fetched Ref returns such Ref in returnRef, otherwise returnRef is Ref::INVALID() Object lookup(const char *key, Ref *returnRef, int recursion = 0) const; // Look up an entry and return the value. Returns a null object // if is not in the dictionary or if it is a ref to a non encrypted object in a partially encrypted document Object lookupEnsureEncryptedIfNeeded(const char *key) const; const Object &lookupNF(const char *key) const; bool lookupInt(const char *key, const char *alt_key, int *value) const; // Iterative accessors. const char *getKey(int i) const { return entries[i].first.c_str(); } Object getVal(int i) const { return entries[i].second.fetch(xref); } // Same as above but if the returned object is a fetched Ref returns such Ref in returnRef, otherwise returnRef is Ref::INVALID() Object getVal(int i, Ref *returnRef) const; const Object &getValNF(int i) const { return entries[i].second; } // Set the xref pointer. This is only used in one special case: the // trailer dictionary, which is read before the xref table is // parsed. void setXRef(XRef *xrefA) { xref = xrefA; } XRef *getXRef() const { return xref; } bool hasKey(const char *key) const; // Returns a key name that is not in the dictionary // It will be suggestedKey itself if available // otherwise it will start adding 0, 1, 2, 3, etc. to suggestedKey until there's one available std::string findAvailableKey(const std::string &suggestedKey); private: friend class Object; // for incRef/decRef // Reference counting. int incRef() { return ++ref; } int decRef() { return --ref; } using DictEntry = std::pair; struct CmpDictEntry; XRef *xref; // the xref table for this PDF file std::vector entries; std::atomic_int ref; // reference count std::atomic_bool sorted; mutable std::recursive_mutex mutex; const DictEntry *find(const char *key) const; DictEntry *find(const char *key); }; #endif