2021-01-04 21:01:09 +00:00
|
|
|
// Copyright (c) 2005-2021 Jay Berkenbilt
|
2018-12-19 02:56:56 +00:00
|
|
|
//
|
|
|
|
// This file is part of qpdf.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
//
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
//
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
// limitations under the License.
|
|
|
|
//
|
|
|
|
// Versions of qpdf prior to version 7 were released under the terms
|
|
|
|
// of version 2.0 of the Artistic License. At your option, you may
|
|
|
|
// continue to consider qpdf to be licensed under those terms. Please
|
|
|
|
// see the manual for additional information.
|
|
|
|
|
|
|
|
#ifndef QPDFNAMETREEOBJECTHELPER_HH
|
|
|
|
#define QPDFNAMETREEOBJECTHELPER_HH
|
|
|
|
|
|
|
|
#include <qpdf/QPDFObjectHelper.hh>
|
|
|
|
#include <qpdf/QPDFObjGen.hh>
|
|
|
|
#include <map>
|
2021-01-16 13:31:56 +00:00
|
|
|
#include <memory>
|
2021-01-16 17:11:17 +00:00
|
|
|
#include <iterator>
|
2018-12-19 02:56:56 +00:00
|
|
|
|
|
|
|
#include <qpdf/DLL.h>
|
|
|
|
|
|
|
|
// This is an object helper for name trees. See section 7.9.6 in the
|
2021-01-16 13:31:56 +00:00
|
|
|
// PDF spec (ISO 32000) for a description of name trees. When looking
|
|
|
|
// up items in the name tree, use UTF-8 strings. All names are
|
|
|
|
// normalized for lookup purposes.
|
|
|
|
|
|
|
|
class NNTreeImpl;
|
2021-01-16 17:11:17 +00:00
|
|
|
class NNTreeIterator;
|
|
|
|
class NNTreeDetails;
|
2018-12-19 02:56:56 +00:00
|
|
|
|
|
|
|
class QPDFNameTreeObjectHelper: public QPDFObjectHelper
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
QPDF_DLL
|
|
|
|
QPDFNameTreeObjectHelper(QPDFObjectHandle);
|
|
|
|
QPDF_DLL
|
|
|
|
virtual ~QPDFNameTreeObjectHelper();
|
|
|
|
|
|
|
|
// Return whether the number tree has an explicit entry for this
|
|
|
|
// number.
|
|
|
|
QPDF_DLL
|
|
|
|
bool hasName(std::string const& utf8);
|
|
|
|
|
|
|
|
// Find an object by name. If found, returns true and initializes
|
|
|
|
// oh.
|
|
|
|
QPDF_DLL
|
|
|
|
bool findObject(std::string const& utf8, QPDFObjectHandle& oh);
|
|
|
|
|
2021-01-16 17:11:17 +00:00
|
|
|
class iterator: public std::iterator<
|
|
|
|
std::bidirectional_iterator_tag,
|
|
|
|
std::pair<std::string, QPDFObjectHandle>,
|
|
|
|
void,
|
|
|
|
std::pair<std::string, QPDFObjectHandle>*,
|
|
|
|
std::pair<std::string, QPDFObjectHandle>>
|
|
|
|
{
|
|
|
|
friend class QPDFNameTreeObjectHelper;
|
|
|
|
public:
|
|
|
|
QPDF_DLL
|
|
|
|
bool valid() const;
|
|
|
|
QPDF_DLL
|
|
|
|
iterator& operator++();
|
|
|
|
QPDF_DLL
|
|
|
|
iterator operator++(int)
|
|
|
|
{
|
|
|
|
iterator t = *this;
|
|
|
|
++(*this);
|
|
|
|
return t;
|
|
|
|
}
|
|
|
|
QPDF_DLL
|
|
|
|
iterator& operator--();
|
|
|
|
QPDF_DLL
|
|
|
|
iterator operator--(int)
|
|
|
|
{
|
|
|
|
iterator t = *this;
|
|
|
|
--(*this);
|
|
|
|
return t;
|
|
|
|
}
|
|
|
|
QPDF_DLL
|
|
|
|
reference operator*();
|
|
|
|
QPDF_DLL
|
|
|
|
bool operator==(iterator const& other) const;
|
|
|
|
QPDF_DLL
|
|
|
|
bool operator!=(iterator const& other) const
|
|
|
|
{
|
|
|
|
return ! operator==(other);
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
iterator(std::shared_ptr<NNTreeIterator> const&);
|
|
|
|
std::shared_ptr<NNTreeIterator> impl;
|
|
|
|
};
|
|
|
|
|
|
|
|
// The iterator looks like map iterator, so i.first is a string
|
|
|
|
// and i.second is a QPDFObjectHandle.
|
|
|
|
QPDF_DLL
|
|
|
|
iterator begin() const;
|
|
|
|
QPDF_DLL
|
|
|
|
iterator end() const;
|
|
|
|
// Return a bidirectional iterator that points to the last item.
|
|
|
|
QPDF_DLL
|
|
|
|
iterator last() const;
|
|
|
|
|
|
|
|
// Find the entry with the given key. If return_prev_if_not_found
|
|
|
|
// is true and the item is not found, return the next lower item.
|
|
|
|
QPDF_DLL
|
|
|
|
iterator find(std::string const& key,
|
|
|
|
bool return_prev_if_not_found = false);
|
|
|
|
|
2021-01-16 13:31:56 +00:00
|
|
|
// Return the contents of the name tree as a map. Note that name
|
|
|
|
// trees may be very large, so this may use a lot of RAM. It is
|
|
|
|
// more efficient to use QPDFNameTreeObjectHelper's iterator.
|
2018-12-19 02:56:56 +00:00
|
|
|
QPDF_DLL
|
|
|
|
std::map<std::string, QPDFObjectHandle> getAsMap() const;
|
|
|
|
|
|
|
|
private:
|
|
|
|
class Members
|
|
|
|
{
|
|
|
|
friend class QPDFNameTreeObjectHelper;
|
|
|
|
|
|
|
|
public:
|
|
|
|
QPDF_DLL
|
|
|
|
~Members();
|
|
|
|
|
|
|
|
private:
|
2021-01-16 13:31:56 +00:00
|
|
|
Members(QPDFObjectHandle& oh);
|
|
|
|
Members(Members const&) = delete;
|
2018-12-19 02:56:56 +00:00
|
|
|
|
2021-01-16 13:31:56 +00:00
|
|
|
std::shared_ptr<NNTreeImpl> impl;
|
2018-12-19 02:56:56 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
PointerHolder<Members> m;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // QPDFNAMETREEOBJECTHELPER_HH
|