diff options
Diffstat (limited to 'include/qpdf/QPDFOutlineDocumentHelper.hh')
-rw-r--r-- | include/qpdf/QPDFOutlineDocumentHelper.hh | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/include/qpdf/QPDFOutlineDocumentHelper.hh b/include/qpdf/QPDFOutlineDocumentHelper.hh new file mode 100644 index 00000000..f6fc74a7 --- /dev/null +++ b/include/qpdf/QPDFOutlineDocumentHelper.hh @@ -0,0 +1,108 @@ +// Copyright (c) 2005-2018 Jay Berkenbilt +// +// 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 QPDFOUTLINEDOCUMENTHELPER_HH +#define QPDFOUTLINEDOCUMENTHELPER_HH + +#include <qpdf/QPDFDocumentHelper.hh> +#include <qpdf/QPDFOutlineObjectHelper.hh> +#include <qpdf/QPDFNameTreeObjectHelper.hh> + +#include <qpdf/QPDF.hh> +#include <map> +#include <list> +#include <set> + +#include <qpdf/DLL.h> + +// This is a document helper for outlines, also known as bookmarks. +// Outlines are discussed in section 12.3.3 of the PDF spec +// (ISO-32000). With the help of QPDFOutlineObjectHelper, the outlines +// tree is traversed, and a bidirectional map is made between pages +// and outlines. See also QPDFOutlineObjectHelper. + +class QPDFOutlineDocumentHelper: public QPDFDocumentHelper +{ + public: + QPDF_DLL + QPDFOutlineDocumentHelper(QPDF&); + QPDF_DLL + virtual ~QPDFOutlineDocumentHelper(); + + QPDF_DLL + bool hasOutlines(); + + QPDF_DLL + std::list<QPDFOutlineObjectHelper> getTopLevelOutlines(); + + // If the name is a name object, look it up in the /Dests key of + // the document catalog. If the name is a string, look it up in + // the name tree pointed to by the /Dests key of the names + // dictionary. + QPDF_DLL + QPDFObjectHandle + resolveNamedDest(QPDFObjectHandle name); + + // Return a list outlines that are known to target the specified + // page + QPDF_DLL + std::list<QPDFOutlineObjectHelper> getOutlinesForPage(QPDFObjGen const&); + + class Accessor + { + friend class QPDFOutlineObjectHelper; + + QPDF_DLL + static bool + checkSeen(QPDFOutlineDocumentHelper& dh, QPDFObjGen const& og) + { + return dh.checkSeen(og); + } + }; + friend class Accessor; + + private: + bool checkSeen(QPDFObjGen const& og); + void initializeByPage(); + + class Members + { + friend class QPDFOutlineDocumentHelper; + + public: + QPDF_DLL + ~Members(); + + private: + Members(); + Members(Members const&); + + std::list<QPDFOutlineObjectHelper> outlines; + std::set<QPDFObjGen> seen; + QPDFObjectHandle dest_dict; + PointerHolder<QPDFNameTreeObjectHelper> names_dest; + std::map<QPDFObjGen, std::list<QPDFOutlineObjectHelper> > by_page; + }; + + PointerHolder<Members> m; +}; + +#endif // QPDFOUTLINEDOCUMENTHELPER_HH |