blob: b775a574d9909d9dac6d007acc2535defb7cf779 [file] [log] [blame]
// Dict.h
// Copyright 1996-2003 Glyph & Cog, LLC
// Modified under the Poppler project -
// 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 Albert Astals Cid <>
// Copyright (C) 2010 Paweł Wiejacha <>
// Copyright (C) 2013 Thomas Freitag <>
// 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
#pragma interface
#include "poppler-config.h"
#include "Object.h"
#include "goo/GooMutex.h"
// Dict
struct DictEntry {
char *key;
Object val;
class Dict {
// Constructor.
Dict(XRef *xrefA);
Dict(Dict* dictA);
Dict *copy(XRef *xrefA);
// Destructor.
// Get number of entries.
int getLength() { return length; }
// Add an entry. NB: does not copy key.
// val becomes a dead object after the call
void add(char *key, Object &&val);
// 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.
GBool is(const char *type);
// Look up an entry and return the value. Returns a null object
// if <key> is not in the dictionary.
Object lookup(const char *key, int recursion = 0);
Object lookupNF(const char *key);
GBool lookupInt(const char *key, const char *alt_key, int *value);
// Iterative accessors.
char *getKey(int i);
Object getVal(int i);
Object getValNF(int i);
// 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() { return xref; }
GBool hasKey(const char *key);
friend class Object; // for incRef/decRef
// Reference counting.
int incRef();
int decRef();
GBool sorted;
XRef *xref; // the xref table for this PDF file
DictEntry *entries; // array of entries
int size; // size of <entries> array
int length; // number of entries in dictionary
int ref; // reference count
GooMutex mutex;
DictEntry *find(const char *key);