1 files changed, 649 insertions, 0 deletions

diff --git a/src/object/sp-page.cpp b/src/object/sp-page.cpp
new file mode 100644
index 0000000..cc5c41f
--- /dev/null
+++ b/src/object/sp-page.cpp
@@ -0,0 +1,649 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Inkscape pages implementation
+ *
+ * Authors:
+ *   Martin Owens <doctormo@geek-2.com>
+ *
+ * Copyright (C) 2021 Martin Owens
+ *
+ * Released under GNU GPL v2+, read the file 'COPYING' for more information.
+ */
+
+#include <glibmm/i18n.h>
+
+#include "sp-page.h"
+
+#include "attributes.h"
+#include "desktop.h"
+#include "display/control/canvas-page.h"
+#include "inkscape.h"
+#include "object/object-set.h"
+#include "sp-namedview.h"
+#include "sp-root.h"
+#include "util/numeric/converters.h"
+
+using Inkscape::DocumentUndo;
+
+SPPage::SPPage()
+    : SPObject()
+{
+    _canvas_item = new Inkscape::CanvasPage();
+}
+
+SPPage::~SPPage()
+{
+    delete _canvas_item;
+    _canvas_item = nullptr;
+}
+
+void SPPage::build(SPDocument *document, Inkscape::XML::Node *repr)
+{
+    SPObject::build(document, repr);
+
+    this->readAttr(SPAttr::INKSCAPE_LABEL);
+    this->readAttr(SPAttr::PAGE_SIZE);
+    this->readAttr(SPAttr::X);
+    this->readAttr(SPAttr::Y);
+    this->readAttr(SPAttr::WIDTH);
+    this->readAttr(SPAttr::HEIGHT);
+    this->readAttr(SPAttr::PAGE_MARGIN);
+    this->readAttr(SPAttr::PAGE_BLEED);
+
+    /* Register */
+    document->addResource("page", this);
+}
+
+void SPPage::release()
+{
+    if (this->document) {
+        // Unregister ourselves
+        this->document->removeResource("page", this);
+    }
+
+    SPObject::release();
+}
+
+void SPPage::set(SPAttr key, const gchar *value)
+{
+    switch (key) {
+        case SPAttr::X:
+            this->x.readOrUnset(value);
+            break;
+        case SPAttr::Y:
+            this->y.readOrUnset(value);
+            break;
+        case SPAttr::WIDTH:
+            this->width.readOrUnset(value);
+            break;
+        case SPAttr::HEIGHT:
+            this->height.readOrUnset(value);
+            break;
+        case SPAttr::PAGE_MARGIN:
+            this->margin.readOrUnset(value);
+            break;
+        case SPAttr::PAGE_BLEED:
+            this->bleed.readOrUnset(value);
+            break;
+        case SPAttr::PAGE_SIZE:
+            this->_size_label = value ? std::string(value) : "";
+            break;
+        default:
+            SPObject::set(key, value);
+            break;
+    }
+    update_relatives();
+    this->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
+}
+
+/**
+ * Update the percentage values of the svg boxes
+ */
+void SPPage::update_relatives()
+{
+    if (this->width && this->height) {
+        if (this->margin)
+            this->margin.update(12, 6, this->width.computed, this->height.computed);
+        if (this->bleed)
+            this->bleed.update(12, 6, this->width.computed, this->height.computed);
+    }
+}
+
+/**
+ * Returns true if the only aspect to this page is its size
+ */
+bool SPPage::isBarePage() const
+{
+    if (margin || bleed) {
+        return false;
+    }
+    return true;
+}
+
+/**
+ * Gets the rectangle in document units
+ */
+Geom::Rect SPPage::getRect() const
+{
+    return Geom::Rect::from_xywh(x.computed, y.computed, width.computed, height.computed);
+}
+
+/**
+ * Get the rectangle of the page, in desktop units
+ */
+Geom::Rect SPPage::getDesktopRect() const
+{
+    return getDocumentRect() * document->doc2dt();
+}
+
+/**
+ * Gets the page's position as a translation in desktop units.
+ */
+Geom::Translate SPPage::getDesktopAffine() const
+{
+    auto box = getDesktopRect();
+    return Geom::Translate(box.left(), box.top());
+}
+
+/**
+ * Get document rect, minus the margin amounts.
+ */
+Geom::Rect SPPage::getDocumentMargin() const
+{
+    auto rect = getDocumentRect();
+    rect.setTop(rect.top() + margin.top().computed);
+    rect.setLeft(rect.left() + margin.left().computed);
+    rect.setBottom(rect.bottom() - margin.bottom().computed);
+    rect.setRight(rect.right() - margin.right().computed);
+    if (rect.hasZeroArea())
+        return getDocumentRect(); // Cancel!
+    return rect;
+}
+
+Geom::Rect SPPage::getDesktopMargin() const
+{
+    return getDocumentMargin() * document->doc2dt();
+}
+
+/**
+ * Get document rect, plus the bleed amounts.
+ */
+Geom::Rect SPPage::getDocumentBleed() const
+{
+    auto rect = getDocumentRect();
+    rect.setTop(rect.top() - bleed.top().computed);
+    rect.setLeft(rect.left() - bleed.left().computed);
+    rect.setBottom(rect.bottom() + bleed.bottom().computed);
+    rect.setRight(rect.right() + bleed.right().computed);
+    if (rect.hasZeroArea())
+        return getDocumentRect(); // Cancel!
+    return rect;
+}
+
+Geom::Rect SPPage::getDesktopBleed() const
+{
+    return getDocumentBleed() * document->doc2dt();
+}
+
+/**
+ * Get the rectangle of the page, scaled to the document.
+ */
+Geom::Rect SPPage::getDocumentRect() const
+{
+    return getRect() * document->getDocumentScale();
+}
+
+/**
+ * Like getDesktopRect but returns a slightly shrunken rectangle
+ * so interactions don't confuse the border with the object.
+ */
+Geom::Rect SPPage::getSensitiveRect() const
+{
+    auto rect = getDesktopRect();
+    rect.expandBy(-0.1);
+    return rect;
+}
+
+/**
+ * Set the page rectangle in its native units.
+ */
+void SPPage::setRect(Geom::Rect rect)
+{
+    this->x = rect.left();
+    this->y = rect.top();
+    this->width = rect.width();
+    this->height = rect.height();
+
+    // always clear size label, toolbar is responsible for putting it back if needed.
+    this->_size_label = "";
+
+    // This is needed to update the xml
+    this->updateRepr();
+
+    // This eventually calls the ::update below while idle
+    this->requestModified(SP_OBJECT_MODIFIED_FLAG);
+}
+
+/**
+ * Set the page rectangle in document coordinates.
+ */
+void SPPage::setDocumentRect(Geom::Rect rect, bool add_margins)
+{
+    if (add_margins) {
+        // Add margins to rectangle.
+        rect.setTop(rect.top() - margin.top().computed);
+        rect.setLeft(rect.left() - margin.left().computed);
+        rect.setBottom(rect.bottom() + margin.bottom().computed);
+        rect.setRight(rect.right() + margin.right().computed);
+    }
+    setRect(rect * document->getDocumentScale().inverse());
+}
+
+/**
+ * Set the page rectangle in desktop coordinates.
+ */
+void SPPage::setDesktopRect(Geom::Rect rect)
+{
+    setDocumentRect(rect * document->dt2doc());
+}
+
+/** @brief
+ * Set just the height and width from a predefined size.
+ * These dimensions are in document units, which happen to be the same
+ * as desktop units, since pages are aligned to the coordinate axes.
+ *
+ * @param width The desired width in document/desktop units.
+ * @param height The desired height in document/desktop units.
+ */
+void SPPage::setSize(double width, double height)
+{
+    auto rect = getDocumentRect();
+    rect.setMax(rect.corner(0) + Geom::Point(width, height));
+    setDocumentRect(rect);
+}
+
+/**
+ * Set the page's margin
+ */
+void SPPage::setMargin(const std::string &value)
+{
+    this->margin.fromString(value, document->getDisplayUnit()->abbr);
+    this->updateRepr();
+}
+
+/**
+ * Set the page's bleed
+ */
+void SPPage::setBleed(const std::string &value)
+{
+    this->bleed.fromString(value, document->getDisplayUnit()->abbr);
+    this->updateRepr();
+}
+
+/**
+ * Get the margin side of the box.
+ */
+double SPPage::getMarginSide(int side)
+{
+    return this->margin.get((BoxSide)side);
+}
+
+/**
+ * Set the margin at this side of the box.
+ */
+void SPPage::setMarginSide(int side, double value, bool confine)
+{
+    if (confine && !margin) {
+        this->margin.set(value, value, value, value);
+    } else {
+        this->margin.set((BoxSide)side, value, confine);
+    }
+    this->updateRepr();
+}
+void SPPage::setMarginSide(int side, const std::string &value, bool confine)
+{
+    auto unit = document->getDisplayUnit()->abbr;
+    if (confine && !margin) {
+        this->margin.fromString(value, unit);
+    } else {
+        this->margin.fromString((BoxSide)side, value, unit);
+    }
+    this->updateRepr();
+}
+
+std::string SPPage::getMarginLabel() const
+{
+    if (!margin || margin.isZero())
+        return "";
+    auto unit = document->getDisplayUnit()->abbr;
+    return margin.toString(unit, 2);
+}
+
+std::string SPPage::getBleedLabel() const
+{
+    if (!bleed || bleed.isZero())
+        return "";
+    auto unit = document->getDisplayUnit()->abbr;
+    return bleed.toString(unit, 2);
+}
+
+/**
+ * Get the items which are ONLY on this page and don't overlap.
+ *
+ * This ignores layers so items in the same layer which are shared
+ * between pages are not moved around or exported into pages they
+ * shouldn't be.
+ *
+ * @param hidden - Return hidden items (default: true)
+ * @param in_bleed - Use the bleed box instead of the page box
+ * @param in_layers - Should layers be traversed to find items (default: true)
+ */
+std::vector<SPItem *> SPPage::getExclusiveItems(bool hidden, bool in_bleed, bool in_layers) const
+{
+    return document->getItemsInBox(0, in_bleed ? getDocumentBleed() : getDocumentRect(), hidden, true, true, false, in_layers);
+}
+
+/**
+ * Like ExcludiveItems above but get all the items which are inside or overlapping.
+ *
+ * @param hidden - Return hidden items (default: true)
+ * @param in_bleed - Use the bleed box instead of the page box
+ * @param in_layers - Should layers be traversed to find items (default: true)
+ */
+std::vector<SPItem *> SPPage::getOverlappingItems(bool hidden, bool in_bleed, bool in_layers) const
+{
+    return document->getItemsPartiallyInBox(0, in_bleed ? getDocumentBleed() : getDocumentRect(), hidden, true, true, false, in_layers);
+}
+
+/**
+ * Return true if this item is contained within the page boundary.
+ */
+bool SPPage::itemOnPage(SPItem *item, bool contains) const
+{
+    if (auto box = item->desktopGeometricBounds()) {
+        if (contains) {
+            return getDesktopRect().contains(*box);
+        }
+        return getDesktopRect().intersects(*box);
+    }
+    return false;
+}
+
+/**
+ * Returns true if this page is the same as the viewport.
+ */
+bool SPPage::isViewportPage() const
+{
+    auto rect = document->preferredBounds();
+    return getDocumentRect().corner(0) == rect->corner(0);
+}
+
+/**
+ * Shows the page in the given canvas item group.
+ */
+void SPPage::showPage(Inkscape::CanvasItemGroup *fg, Inkscape::CanvasItemGroup *bg)
+{
+    _canvas_item->add(getDesktopRect(), fg, bg);
+    // The final steps are completed in an update cycle
+    this->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
+}
+
+/**
+ * Sets the default attributes from the namedview.
+ */
+bool SPPage::setDefaultAttributes()
+{
+    if (document->getPageManager().setDefaultAttributes(_canvas_item)) {
+        this->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
+        return true;
+    }
+    return false;
+}
+
+/**
+ * Set the selected high-light for this page.
+ */
+void SPPage::setSelected(bool sel)
+{
+    this->_canvas_item->is_selected = sel;
+    this->requestDisplayUpdate(SP_OBJECT_MODIFIED_FLAG);
+}
+
+/**
+ * Returns the page number (order of pages) starting at 1
+ */
+int SPPage::getPageIndex() const
+{
+    return document->getPageManager().getPageIndex(this);
+}
+
+/**
+ * Set this page to a new order in the page stack.
+ *
+ * @param index - Placement of page in the stack, starting at '0'
+ * @param swap_page - Swap the rectangle position
+ *
+ * @returns true if page has been moved.
+ */
+bool SPPage::setPageIndex(int index, bool swap_page)
+{
+    int current = getPageIndex();
+
+    if (current != index) {
+        auto &page_manager = document->getPageManager();
+
+        // The page we're going to be shifting to
+        auto sibling = page_manager.getPage(index);
+
+        // Insertions are done to the right of the sibling
+        if (index < current) {
+            index -= 1;
+        }
+        auto insert_after = page_manager.getPage(index);
+
+        // We may have selected an index off the end, so attach it after the last page.
+        if (!insert_after && index > 0) {
+            insert_after = page_manager.getLastPage();
+            sibling = nullptr; // disable swap
+        }
+
+        if (insert_after) {
+            if (this == insert_after) {
+                g_warning("Page is already at this index. Not moving.");
+                return false;
+            }
+            // Attach after the given page
+            getRepr()->parent()->changeOrder(getRepr(), insert_after->getRepr());
+        } else {
+            // Attach to before any existing page
+            sibling = page_manager.getFirstPage();
+            getRepr()->parent()->changeOrder(getRepr(), nullptr);
+        }
+        if (sibling && swap_page) {
+            swapPage(sibling, true);
+        }
+        return true;
+    }
+    return false;
+}
+
+/**
+ * Returns the sibling page next to this one in the stack order.
+ */
+SPPage *SPPage::getNextPage()
+{
+    SPObject *item = this;
+    while ((item = item->getNext())) {
+        if (auto next = cast<SPPage>(item)) {
+            return next;
+        }
+    }
+    return nullptr;
+}
+
+/**
+ * Returns the sibling page previous to this one in the stack order.
+ */
+SPPage *SPPage::getPreviousPage()
+{
+    SPObject *item = this;
+    while ((item = item->getPrev())) {
+        if (auto prev = cast<SPPage>(item)) {
+            return prev;
+        }
+    }
+    return nullptr;
+}
+
+/**
+ * Move the page by the given affine, in desktop units.
+ *
+ * @param translate - The positional translation to apply.
+ * @param with_objects - Flag to request that connected objects also move.
+ */
+void SPPage::movePage(Geom::Affine translate, bool with_objects)
+{
+    if (translate.isTranslation()) {
+        if (with_objects) {
+            // Move each item that is overlapping this page too
+            moveItems(translate, getOverlappingItems());
+        }
+        setDesktopRect(getDesktopRect() * translate);
+    }
+}
+
+/**
+ * Move the given items by the given translation in document units.
+ *
+ * @param translate - The movement to be applied
+ * @param objects - a vector of SPItems to move
+ */
+void SPPage::moveItems(Geom::Affine translate, std::vector<SPItem *> const &items)
+{
+    if (items.empty()) {
+        return;
+    }
+    Inkscape::ObjectSet set(items[0]->document);
+    for (auto &item : items) {
+        if (item->isLocked()) {
+            continue;
+        }
+        set.add(item);
+    }
+    set.applyAffine(translate, true, false, true);
+}
+
+/**
+ * Swap the locations of this page with another page (see movePage)
+ *
+ * @param other - The other page to swap with
+ * @param with_objects - Should the page objects move too.
+ */
+void SPPage::swapPage(SPPage *other, bool with_objects)
+{
+    // Swapping with the viewport page must be handled gracefully.
+    if (this->isViewportPage()) {
+        auto other_rect = other->getDesktopRect();
+        auto new_rect = Geom::Rect(Geom::Point(0, 0),
+            Geom::Point(other_rect.width(), other_rect.height()));
+        this->document->fitToRect(new_rect, false);
+    } else if (other->isViewportPage()) {
+        other->swapPage(this, with_objects);
+        return;
+    }
+
+    auto this_affine = Geom::Translate(getDesktopRect().corner(0));
+    auto other_affine = Geom::Translate(other->getDesktopRect().corner(0));
+    movePage(this_affine.inverse() * other_affine, with_objects);
+    other->movePage(other_affine.inverse() * this_affine, with_objects);
+}
+
+void SPPage::update(SPCtx * /*ctx*/, unsigned int /*flags*/)
+{
+    // This is manual because this is not an SPItem, but it's own visual identity.
+    auto lbl = label();
+    char *alt = nullptr;
+    if (document->getPageManager().showDefaultLabel()) {
+        alt = g_strdup_printf("%d", getPagePosition());
+    }
+    _canvas_item->update(getDesktopRect(), getDesktopMargin(), getDesktopBleed(), lbl ? lbl : alt);
+    g_free(alt);
+}
+
+/**
+ * Write out the page's data into its xml structure.
+ */
+Inkscape::XML::Node *SPPage::write(Inkscape::XML::Document *xml_doc, Inkscape::XML::Node *repr, guint flags)
+{
+    if ((flags & SP_OBJECT_WRITE_BUILD) && !repr) {
+        repr = xml_doc->createElement("inkscape:page");
+    }
+
+    repr->setAttributeSvgDouble("x", this->x.computed);
+    repr->setAttributeSvgDouble("y", this->y.computed);
+    repr->setAttributeSvgDouble("width", this->width.computed);
+    repr->setAttributeSvgDouble("height", this->height.computed);
+    repr->setAttributeOrRemoveIfEmpty("margin", this->margin.write());
+    repr->setAttributeOrRemoveIfEmpty("bleed", this->bleed.write());
+    repr->setAttributeOrRemoveIfEmpty("page-size", this->_size_label);
+
+    return SPObject::write(xml_doc, repr, flags);
+}
+
+void SPPage::setSizeLabel(std::string label)
+{
+    _size_label = label;
+    // This is needed to update the xml
+    this->updateRepr();
+}
+
+std::string SPPage::getDefaultLabel() const
+{
+    gchar *format = g_strdup_printf(_("Page %d"), getPagePosition());
+    auto ret = std::string(format);
+    g_free(format);
+    return ret;
+}
+
+std::string SPPage::getLabel() const
+{
+    auto ret = label();
+    if (!ret) {
+        return getDefaultLabel();
+    }
+    return std::string(ret);
+}
+
+std::string SPPage::getSizeLabel() const
+{
+    return _size_label;
+}
+
+/**
+ * Copy non-size attributes from the given page.
+ */
+void SPPage::copyFrom(SPPage *page)
+{
+    this->_size_label = page->_size_label;
+    if (auto margin = page->getMargin()) {
+        this->margin.read(margin.write());
+    }
+    if (auto bleed = page->getBleed()) {
+        this->bleed.read(bleed.write());
+    }
+}
+
+void SPPage::set_guides_visible(bool show) {
+    _canvas_item->set_guides_visible(show);
+}
+
+/*
+  Local Variables:
+  mode:c++
+  c-file-style:"stroustrup"
+  c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
+  indent-tabs-mode:nil
+  fill-column:99
+  End:
+*/
+// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :