caret.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#pragma once
 
#include <sal/config.h>
#include "node.hxx"
 
struct SmCaretPos
{
    SmCaretPos(SmNode* selectedNode = nullptr, int iIndex = 0)
        : pSelectedNode(selectedNode)
        , nIndex(iIndex)
    {
        assert(nIndex >= 0);
    }
 
    SmNode* pSelectedNode;
 
    //TODO: Special cases for SmBlankNode is needed
    //TODO: Consider forgetting about the todo above... As it's really unpleasant.
    int nIndex;
 
    bool IsValid() const { return pSelectedNode != nullptr; }
    bool operator==(const SmCaretPos& pos) const
    {
        return pos.pSelectedNode == pSelectedNode && nIndex == pos.nIndex;
    }
    static SmCaretPos GetPosAfter(SmNode* pNode)
    {
        if (pNode && pNode->GetType() == SmNodeType::Text)
            return SmCaretPos(pNode, static_cast<SmTextNode*>(pNode)->GetText().getLength());
        return SmCaretPos(pNode, 1);
    }
};
 
class SmCaretLine
{
public:
    SmCaretLine(tools::Long left = 0, tools::Long top = 0, tools::Long height = 0)
    {
        _top = top;
        _left = left;
        _height = height;
    }
    tools::Long GetTop() const { return _top; }
    tools::Long GetLeft() const { return _left; }
    tools::Long GetHeight() const { return _height; }
    tools::Long SquaredDistanceX(const SmCaretLine& line) const
    {
        return (GetLeft() - line.GetLeft()) * (GetLeft() - line.GetLeft());
    }
    tools::Long SquaredDistanceX(const Point& pos) const
    {
        return (GetLeft() - pos.X()) * (GetLeft() - pos.X());
    }
    tools::Long SquaredDistanceY(const SmCaretLine& line) const
    {
        tools::Long d = GetTop() - line.GetTop();
        if (d < 0)
            d = (d * -1) - GetHeight();
        else
            d = d - line.GetHeight();
        if (d < 0)
            return 0;
        return d * d;
    }
    tools::Long SquaredDistanceY(const Point& pos) const
    {
        tools::Long d = GetTop() - pos.Y();
        if (d < 0)
            d = (d * -1) - GetHeight();
        if (d < 0)
            return 0;
        return d * d;
    }
 
private:
    tools::Long _top;
    tools::Long _left;
    tools::Long _height;
};
 
// SmCaretPosGraph
 
struct SmCaretPosGraphEntry
{
    SmCaretPosGraphEntry(SmCaretPos pos, SmCaretPosGraphEntry* left, SmCaretPosGraphEntry* right)
        : CaretPos{ pos }
        , Left{ left }
        , Right{ right }
    {
    }
    const SmCaretPos CaretPos;
    SmCaretPosGraphEntry* Left;
    SmCaretPosGraphEntry* Right;
    void SetRight(SmCaretPosGraphEntry* right) { Right = right; }
    void SetLeft(SmCaretPosGraphEntry* left) { Left = left; }
};
 
class SmCaretPosGraph
{
public:
    SmCaretPosGraph();
 
    ~SmCaretPosGraph();
 
    SmCaretPosGraphEntry* Add(SmCaretPos pos, SmCaretPosGraphEntry* left = nullptr);
 
    std::vector<std::unique_ptr<SmCaretPosGraphEntry>>::iterator begin()
    {
        return mvEntries.begin();
    }
 
    std::vector<std::unique_ptr<SmCaretPosGraphEntry>>::iterator end() { return mvEntries.end(); }
 
private:
    std::vector<std::unique_ptr<SmCaretPosGraphEntry>> mvEntries;
};
 
/* TODO: Write documentation about the following keywords:
 *
 * Visual Selections:
 *  - Show images
 *  - Talk about how the visitor does this
 *
 * Modifying a Visual Line:
 *  - Find top most non-compo of the line (e.g. The subtree that constitutes a line)
 *  - Make the line into a list
 *  - Edit the list, add/remove/modify nodes
 *  - Parse the list back into a subtree
 *  - Insert the new subtree where the old was taken
 */
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */