Commit dbed0702 authored by Masamichi Hosoda's avatar Masamichi Hosoda Committed by Albert Astals Cid

cpp: Add destination class

The information about a destination used in a PDF document.
parent 842a75d8
......@@ -9,6 +9,7 @@ configure_file(poppler-version.h.in ${CMAKE_CURRENT_BINARY_DIR}/poppler-version.
add_subdirectory(tests)
set(poppler_cpp_SRCS
poppler-destination.cpp
poppler-document.cpp
poppler-embedded-file.cpp
poppler-font.cpp
......@@ -33,6 +34,7 @@ target_link_libraries(poppler-cpp poppler ${ICONV_LIBRARIES})
install(TARGETS poppler-cpp RUNTIME DESTINATION bin LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR})
install(FILES
poppler-destination.h
poppler-document.h
poppler-embedded-file.h
poppler-font.h
......
/*
* Copyright (C) 2019, Masamichi Hosoda <trueroad@trueroad.jp>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, 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 General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef POPPLER_DESTINATION_PRIVATE_H
#define POPPLER_DESTINATION_PRIVATE_H
#include "poppler-global.h"
#include "poppler-destination.h"
#include "Object.h"
class PDFDoc;
class LinkDest;
namespace poppler
{
class destination_private
{
public:
destination_private(const LinkDest *ld, PDFDoc *doc);
destination::type_enum type;
bool page_number_unresolved;
union {
Ref page_ref;
int page_number;
};
double left, bottom;
double right, top;
double zoom;
bool change_left : 1, change_top : 1;
bool change_zoom : 1;
PDFDoc *pdf_doc;
};
}
#endif
/*
* Copyright (C) 2019, Masamichi Hosoda <trueroad@trueroad.jp>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, 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 General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include "poppler-destination.h"
#include "poppler-destination-private.h"
#include "PDFDoc.h"
#include "Link.h"
#include <utility>
using namespace poppler;
destination_private::destination_private(const LinkDest *ld, PDFDoc *doc)
: pdf_doc(doc)
{
if (!ld) {
type = destination::unknown;
return;
}
switch (ld->getKind()) {
case ::destXYZ:
type = destination::xyz;
break;
case ::destFit:
type = destination::fit;
break;
case ::destFitH:
type = destination::fit_h;
break;
case ::destFitV:
type = destination::fit_v;
break;
case ::destFitR:
type = destination::fit_r;
break;
case ::destFitB:
type = destination::fit_b;
break;
case ::destFitBH:
type = destination::fit_b_h;
break;
case ::destFitBV:
type = destination::fit_b_v;
break;
default:
type = destination::unknown;
break;
}
if (!ld->isPageRef()) {
// The page number has been resolved.
page_number_unresolved = false;
page_number = ld->getPageNum();
} else if (doc) {
// It is necessary to resolve the page number by its accessor.
page_number_unresolved = true;
page_ref = ld->getPageRef();
} else {
// The page number cannot be resolved because there is no PDFDoc.
page_number_unresolved = false;
page_number = 0;
}
left = ld->getLeft();
bottom = ld->getBottom();
right = ld->getRight();
top = ld->getTop();
zoom = ld->getZoom();
change_left = ld->getChangeLeft();
change_top = ld->getChangeTop();
change_zoom = ld->getChangeZoom();
}
/**
\class poppler::destination poppler-destination.h "poppler/cpp/poppler-destination.h"
The information about a destination used in a PDF %document.
*/
/**
\enum poppler::destination::type_enum
The various types of destinations available in a PDF %document.
*/
/**
\var poppler::destination::type_enum poppler::destination::unknown
unknown destination
*/
/**
\var poppler::destination::type_enum poppler::destination::xyz
go to page with coordinates (left, top) positioned at the upper-left
corner of the window and the contents of the page magnified
by the factor zoom
*/
/**
\var poppler::destination::type_enum poppler::destination::fit
go to page with its contents magnified just enough to fit the entire page
within the window both horizontally and vertically
*/
/**
\var poppler::destination::type_enum poppler::destination::fit_h
go to page with the vertical coordinate top positioned at the top edge
of the window and the contents of the page magnified just enough to fit
the entire width of the page within the window
*/
/**
\var poppler::destination::type_enum poppler::destination::fit_v
go to page with the horizontal coordinate left positioned at the left edge
of the window and the contents of the page magnified just enough to fit
the entire height of the page within the window
*/
/**
\var poppler::destination::type_enum poppler::destination::fit_r
go to page with its contents magnified just enough to fit the rectangle
specified by the coordinates left, bottom, right, and top entirely
within the window both horizontally and vertically
*/
/**
\var poppler::destination::type_enum poppler::destination::fit_b
go to page with its contents magnified just enough to fit its bounding box
entirely within the window both horizontally and vertically
*/
/**
\var poppler::destination::type_enum poppler::destination::fit_b_h
go to page with the vertical coordinate top positioned at the top edge
of the window and the contents of the page magnified just enough to fit
the entire width of its bounding box within the window
*/
/**
\var poppler::destination::type_enum poppler::destination::fit_b_v
go to page with the horizontal coordinate left positioned at the left edge
of the window and the contents of the page magnified just enough to fit
the entire height of its bounding box within the window
*/
destination::destination(destination_private *dd)
: d(dd)
{
}
/**
Move constructor.
*/
destination::destination(destination &&other)
{
*this = std::move(other);
}
/**
\returns the type of the destination
*/
destination::type_enum destination::type() const
{
return d->type;
}
/**
\note It is necessary not to destruct parent poppler::document
before calling this function for the first time.
\returns the page number of the destination
*/
int destination::page_number() const
{
if (d->page_number_unresolved) {
d->page_number_unresolved = false;
d->page_number =
d->pdf_doc->findPage(d->page_ref.num, d->page_ref.gen);
}
return d->page_number;
}
/**
\returns the left coordinate of the destination
*/
double destination::left() const
{
return d->left;
}
/**
\returns the bottom coordinate of the destination
*/
double destination::bottom() const
{
return d->bottom;
}
/**
\returns the right coordinate of the destination
*/
double destination::right() const
{
return d->right;
}
/**
\returns the top coordinate of the destination
*/
double destination::top() const
{
return d->top;
}
/**
\returns the scale factor of the destination
*/
double destination::zoom() const
{
return d->zoom;
}
/**
\returns whether left coordinate should be changed
*/
bool destination::is_change_left() const
{
return d->change_left;
}
/**
\returns whether top coordinate should be changed
*/
bool destination::is_change_top() const
{
return d->change_top;
}
/**
\returns whether scale factor should be changed
*/
bool destination::is_change_zoom() const
{
return d->change_zoom;
}
/**
Move assignment operator.
*/
destination& destination::operator=(destination &&other)
{
if (this != &other) {
d = other.d;
other.d = nullptr;
}
return *this;
}
/**
Destructor.
*/
destination::~destination()
{
delete d;
}
/*
* Copyright (C) 2019, Masamichi Hosoda <trueroad@trueroad.jp>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, 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 General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef POPPLER_DESTINATION_H
#define POPPLER_DESTINATION_H
#include "poppler-global.h"
namespace poppler
{
class destination_private;
class POPPLER_CPP_EXPORT destination : public poppler::noncopyable
{
public:
enum type_enum {
unknown,
xyz,
fit,
fit_h,
fit_v,
fit_r,
fit_b,
fit_b_h,
fit_b_v
};
~destination();
destination(destination &&other);
type_enum type() const;
int page_number() const;
double left() const;
double bottom() const;
double right() const;
double top() const;
double zoom() const;
bool is_change_left() const;
bool is_change_top() const;
bool is_change_zoom() const;
destination& operator=(destination &&other);
private:
destination(destination_private *dd);
destination_private *d;
friend class document;
};
}
#endif
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment