lyx_mirror/src/Cursor.cpp
Guillaume Munch c137ae4c43 Automatically show the review toolbar if the document has tracked changes
(#8738)

For efficiency, we add a new flag to the buffer indicating when changes are
present. This flag is updated at each buffer update, and also when explicitly
requested via a dispatch result flag.
2016-06-15 22:32:53 +01:00

2445 lines
58 KiB
C++

/**
* \file Cursor.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Alejandro Aguilar Sierra
* \author Alfredo Braunstein
* \author Dov Feldstern
* \author André Pönitz
* \author Stefan Schimanski
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "Buffer.h"
#include "BufferView.h"
#include "CoordCache.h"
#include "Cursor.h"
#include "CutAndPaste.h"
#include "DispatchResult.h"
#include "Encoding.h"
#include "Font.h"
#include "FuncCode.h"
#include "FuncRequest.h"
#include "Language.h"
#include "Layout.h"
#include "LyXAction.h"
#include "LyXRC.h"
#include "Paragraph.h"
#include "ParIterator.h"
#include "Row.h"
#include "Text.h"
#include "TextMetrics.h"
#include "TocBackend.h"
#include "support/debug.h"
#include "support/docstream.h"
#include "support/ExceptionMessage.h"
#include "support/gettext.h"
#include "support/lassert.h"
#include "insets/InsetTabular.h"
#include "insets/InsetText.h"
#include "mathed/InsetMath.h"
#include "mathed/InsetMathBrace.h"
#include "mathed/InsetMathScript.h"
#include "mathed/MacroTable.h"
#include "mathed/MathData.h"
#include "mathed/MathMacro.h"
#include "support/bind.h"
#include <sstream>
#include <limits>
#include <map>
#include <algorithm>
using namespace std;
namespace lyx {
namespace {
// Find position closest to (x, y) in cell given by iter.
// Used only in mathed
DocIterator bruteFind2(Cursor const & c, int x, int y)
{
double best_dist = numeric_limits<double>::max();
DocIterator result;
DocIterator it = c;
it.top().pos() = 0;
DocIterator et = c;
et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
for (size_t i = 0;; ++i) {
int xo;
int yo;
Inset const * inset = &it.inset();
CoordCache const & cache = c.bv().coordCache();
// FIXME: in the case where the inset is not in the cache, this
// means that no part of it is visible on screen. In this case
// we don't do elaborate search and we just return the forwarded
// DocIterator at its beginning.
if (!cache.getInsets().has(inset)) {
it.top().pos() = 0;
return it;
}
Point const o = cache.getInsets().xy(inset);
inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
// Convert to absolute
xo += o.x_;
yo += o.y_;
double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
// '<=' in order to take the last possible position
// this is important for clicking behind \sum in e.g. '\sum_i a'
LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
<< " best: " << best_dist);
if (d <= best_dist) {
best_dist = d;
result = it;
}
if (it == et)
break;
it.forwardPos();
}
return result;
}
/*
/// moves position closest to (x, y) in given box
bool bruteFind(Cursor & cursor,
int x, int y, int xlow, int xhigh, int ylow, int yhigh)
{
LASSERT(!cursor.empty(), return false);
Inset & inset = cursor[0].inset();
BufferView & bv = cursor.bv();
CoordCache::InnerParPosCache const & cache =
bv.coordCache().getParPos().find(cursor.bottom().text())->second;
// Get an iterator on the first paragraph in the cache
DocIterator it(inset);
it.push_back(CursorSlice(inset));
it.pit() = cache.begin()->first;
// Get an iterator after the last paragraph in the cache
DocIterator et(inset);
et.push_back(CursorSlice(inset));
et.pit() = prev(cache.end(), 1)->first;
if (et.pit() >= et.lastpit())
et = doc_iterator_end(inset);
else
++et.pit();
double best_dist = numeric_limits<double>::max();
DocIterator best_cursor = et;
for ( ; it != et; it.forwardPos(true)) {
// avoid invalid nesting when selecting
if (!cursor.selection() || positionable(it, cursor.anchor_)) {
Point p = bv.getPos(it, false);
int xo = p.x_;
int yo = p.y_;
if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
double const dx = xo - x;
double const dy = yo - y;
double const d = dx * dx + dy * dy;
// '<=' in order to take the last possible position
// this is important for clicking behind \sum in e.g. '\sum_i a'
if (d <= best_dist) {
// lyxerr << "*" << endl;
best_dist = d;
best_cursor = it;
}
}
}
}
if (best_cursor != et) {
cursor.setCursor(best_cursor);
return true;
}
return false;
}
*/
/*
/// moves position closest to (x, y) in given box
bool bruteFind3(Cursor & cur, int x, int y, bool up)
{
BufferView & bv = cur.bv();
int ylow = up ? 0 : y + 1;
int yhigh = up ? y - 1 : bv.workHeight();
int xlow = 0;
int xhigh = bv.workWidth();
// FIXME: bit more work needed to get 'from' and 'to' right.
pit_type from = cur.bottom().pit();
//pit_type to = cur.bottom().pit();
//lyxerr << "Pit start: " << from << endl;
//lyxerr << "bruteFind3: x: " << x << " y: " << y
// << " xlow: " << xlow << " xhigh: " << xhigh
// << " ylow: " << ylow << " yhigh: " << yhigh
// << endl;
DocIterator it = doc_iterator_begin(cur.buffer());
it.pit() = from;
DocIterator et = doc_iterator_end(cur.buffer());
double best_dist = numeric_limits<double>::max();
DocIterator best_cursor = et;
for ( ; it != et; it.forwardPos()) {
// avoid invalid nesting when selecting
if (bv.cursorStatus(it) == CUR_INSIDE
&& (!cur.selection() || positionable(it, cur.realAnchor()))) {
// If this function is ever used again, check
// whether this is the same as "bv.getPos(it,
// false)" with boundary = false.
Point p = bv.getPos(it);
int xo = p.x_;
int yo = p.y_;
if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
double const dx = xo - x;
double const dy = yo - y;
double const d = dx * dx + dy * dy;
//lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
// << " dx: " << dx << " dy: " << dy
// << " idx: " << it.idx() << " pos: " << it.pos()
// << " it:\n" << it
// << endl;
// '<=' in order to take the last possible position
// this is important for clicking behind \sum in e.g. '\sum_i a'
if (d <= best_dist) {
//lyxerr << "*" << endl;
best_dist = d;
best_cursor = it;
}
}
}
}
//lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
if (best_cursor == et)
return false;
cur.setCursor(best_cursor);
return true;
}
*/
} // namespace anon
CursorData::CursorData()
: DocIterator(), anchor_(),
selection_(false), mark_(false), word_selection_(false),
logicalpos_(false), current_font(inherit_font),
autocorrect_(false), macromode_(false)
{}
CursorData::CursorData(Buffer * buffer)
: DocIterator(buffer), anchor_(),
selection_(false), mark_(false), word_selection_(false),
logicalpos_(false), current_font(inherit_font),
autocorrect_(false), macromode_(false)
{}
CursorData::CursorData(DocIterator const & dit)
: DocIterator(dit), anchor_(),
selection_(false), mark_(false), word_selection_(false),
logicalpos_(false), current_font(inherit_font),
autocorrect_(false), macromode_(false)
{}
ostream & operator<<(ostream & os, CursorData const & cur)
{
os << "\n cursor: | anchor:\n";
for (size_t i = 0, n = cur.depth(); i != n; ++i) {
os << " " << cur[i] << " | ";
if (i < cur.anchor_.depth())
os << cur.anchor_[i];
else
os << "-------------------------------";
os << "\n";
}
for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
os << "------------------------------- | " << cur.anchor_[i] << "\n";
}
os << " selection: " << cur.selection_
// << " x_target: " << cur.x_target_
<< " boundary: " << cur.boundary() << endl;
return os;
}
LyXErr & operator<<(LyXErr & os, CursorData const & cur)
{
os.stream() << cur;
return os;
}
// be careful: this is called from the bv's constructor, too, so
// bv functions are not yet available!
Cursor::Cursor(BufferView & bv)
: CursorData(&bv.buffer()), bv_(&bv),
x_target_(-1), textTargetOffset_(0),
beforeDispatchPosX_(0), beforeDispatchPosY_(0)
{}
void Cursor::reset()
{
clear();
push_back(CursorSlice(buffer()->inset()));
anchor_ = doc_iterator_begin(buffer());
anchor_.clear();
new_word_ = doc_iterator_begin(buffer());
new_word_.clear();
clearTargetX();
selection_ = false;
mark_ = false;
}
// this (intentionally) does neither touch anchor nor selection status
void Cursor::setCursor(DocIterator const & cur)
{
DocIterator::operator=(cur);
}
void Cursor::setCursorToAnchor()
{
if (selection()) {
DocIterator normal = anchor_;
while (depth() < normal.depth())
normal.pop_back();
if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
++normal.pos();
setCursor(normal);
}
}
void Cursor::setCursorData(CursorData const & data)
{
CursorData::operator=(data);
}
bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
{
Cursor cur = *this;
// Try to fix cursor in case it is broken.
cur.fixIfBroken();
// Is this a function that acts on inset at point?
Inset * inset = cur.nextInset();
if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
&& inset && inset->getStatus(cur, cmd, status))
return true;
// This is, of course, a mess. Better create a new doc iterator and use
// this in Inset::getStatus. This might require an additional
// BufferView * arg, though (which should be avoided)
//Cursor safe = *this;
bool res = false;
for ( ; cur.depth(); cur.pop()) {
//lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
// LASSERT: Is it safe to continue here, or should we return?
LASSERT(cur.idx() <= cur.lastidx(), /**/);
LASSERT(cur.pit() <= cur.lastpit(), /**/);
LASSERT(cur.pos() <= cur.lastpos(), /**/);
// The inset's getStatus() will return 'true' if it made
// a definitive decision on whether it want to handle the
// request or not. The result of this decision is put into
// the 'status' parameter.
if (cur.inset().getStatus(cur, cmd, status)) {
res = true;
break;
}
}
return res;
}
void Cursor::saveBeforeDispatchPosXY()
{
getPos(beforeDispatchPosX_, beforeDispatchPosY_);
}
void Cursor::dispatch(FuncRequest const & cmd0)
{
LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
if (empty())
return;
fixIfBroken();
FuncRequest cmd = cmd0;
Cursor safe = *this;
Cursor old = *this;
disp_ = DispatchResult();
beginUndoGroup();
// Is this a function that acts on inset at point?
if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
&& nextInset()) {
disp_.dispatched(true);
disp_.screenUpdate(Update::FitCursor | Update::Force);
FuncRequest tmpcmd = cmd;
LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
<< cmd0 << endl << *this);
nextInset()->dispatch(*this, tmpcmd);
if (disp_.dispatched()) {
endUndoGroup();
return;
}
}
// store some values to be used inside of the handlers
beforeDispatchCursor_ = *this;
for (; depth(); pop(), boundary(false)) {
LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
<< cmd0 << endl << *this);
// In any of these cases, the cursor is invalid, and we should
// try to save this document rather than crash.
LBUFERR(pos() <= lastpos());
LBUFERR(idx() <= lastidx());
LBUFERR(pit() <= lastpit());
// The common case is 'LFUN handled, need update', so make the
// LFUN handler's life easier by assuming this as default value.
// The handler can reset the update and val flags if necessary.
disp_.screenUpdate(Update::FitCursor | Update::Force);
disp_.dispatched(true);
inset().dispatch(*this, cmd);
if (disp_.dispatched())
break;
}
// it completely to get a 'bomb early' behaviour in case this
// object will be used again.
if (!disp_.dispatched()) {
LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
// We might have invalidated the cursor when removing an empty
// paragraph while the cursor could not be moved out the inset
// while we initially thought we could. This might happen when
// a multiline inset becomes an inline inset when the second
// paragraph is removed.
if (safe.pit() > safe.lastpit()) {
safe.pit() = safe.lastpit();
safe.pos() = safe.lastpos();
}
operator=(safe);
disp_.screenUpdate(Update::None);
disp_.dispatched(false);
} else {
// restore the previous one because nested Cursor::dispatch calls
// are possible which would change it
beforeDispatchCursor_ = safe.beforeDispatchCursor_;
}
endUndoGroup();
// NOTE: The code below has been copied to BufferView::dispatch.
// If you need to modify this, please update the other one too.
// notify insets we just left
if (*this != old) {
old.beginUndoGroup();
old.fixIfBroken();
bool badcursor = notifyCursorLeavesOrEnters(old, *this);
if (badcursor) {
fixIfBroken();
bv().resetInlineCompletionPos();
}
old.endUndoGroup();
}
}
DispatchResult const & Cursor::result() const
{
return disp_;
}
BufferView & Cursor::bv() const
{
LBUFERR(bv_);
return *bv_;
}
void Cursor::pop()
{
LBUFERR(depth() >= 1);
pop_back();
}
void Cursor::push(Inset & p)
{
push_back(CursorSlice(p));
p.setBuffer(*buffer());
}
void Cursor::pushBackward(Inset & p)
{
LASSERT(!empty(), return);
//lyxerr << "Entering inset " << t << " front" << endl;
push(p);
p.idxFirst(*this);
}
bool Cursor::popBackward()
{
LASSERT(!empty(), return false);
if (depth() == 1)
return false;
pop();
return true;
}
bool Cursor::popForward()
{
LASSERT(!empty(), return false);
//lyxerr << "Leaving inset from in back" << endl;
const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
if (depth() == 1)
return false;
pop();
pos() += lastpos() - lp + 1;
return true;
}
int Cursor::currentMode()
{
LASSERT(!empty(), return Inset::UNDECIDED_MODE);
for (int i = depth() - 1; i >= 0; --i) {
int res = operator[](i).inset().currentMode();
bool locked_mode = operator[](i).inset().lockedMode();
// Also return UNDECIDED_MODE when the mode is locked,
// as in this case it is treated the same as TEXT_MODE
if (res != Inset::UNDECIDED_MODE || locked_mode)
return res;
}
return Inset::TEXT_MODE;
}
bool Cursor::inCoordCache() const
{
// the root inset is not in cache, but we do not need it.
if (depth() == 1)
return true;
CoordCache::Insets const & icache = bv_->coordCache().getInsets();
for (size_t i = 1 ; i < depth() ; ++i)
if (!icache.has(&(*this)[i].inset()))
return false;
return true;
}
void Cursor::getPos(int & x, int & y) const
{
Point p = bv().getPos(*this);
x = p.x_;
y = p.y_;
}
Row const & Cursor::textRow() const
{
CursorSlice const & cs = innerTextSlice();
ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
return pm.getRow(pos(), boundary());
}
void Cursor::resetAnchor()
{
anchor_ = *this;
checkNewWordPosition();
}
void Cursor::markNewWordPosition()
{
if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
FontSpan nw = locateWord(WHOLE_WORD);
if (nw.size() == 1) {
LYXERR(Debug::DEBUG, "start new word: "
<< " par: " << pit()
<< " pos: " << nw.first);
new_word_ = *this;
}
}
}
void Cursor::clearNewWordPosition()
{
if (!new_word_.empty()) {
LYXERR(Debug::DEBUG, "clear new word: "
<< " par: " << pit()
<< " pos: " << pos());
new_word_.resize(0);
}
}
void Cursor::checkNewWordPosition()
{
if (!lyxrc.spellcheck_continuously || new_word_.empty())
return ;
if (!inTexted())
clearNewWordPosition();
else {
// forget the position of the current new word if
// 1) the paragraph changes or
// 2) the count of nested insets changes or
// 3) the cursor pos is out of paragraph bound
if (pit() != new_word_.pit() ||
depth() != new_word_.depth() ||
new_word_.pos() > new_word_.lastpos()) {
clearNewWordPosition();
} else if (new_word_.fixIfBroken())
// 4) or the remembered position was "broken"
clearNewWordPosition();
else {
FontSpan nw = locateWord(WHOLE_WORD);
if (!nw.empty()) {
FontSpan ow = new_word_.locateWord(WHOLE_WORD);
if (nw.intersect(ow).empty())
clearNewWordPosition();
else
LYXERR(Debug::DEBUG, "new word: "
<< " par: " << pit()
<< " pos: " << nw.first << ".." << nw.last);
} else {
clearNewWordPosition();
}
}
}
}
bool Cursor::posBackward()
{
if (pos() == 0)
return false;
--pos();
return true;
}
bool Cursor::posForward()
{
if (pos() == lastpos())
return false;
++pos();
return true;
}
bool Cursor::posVisRight(bool skip_inset)
{
Cursor new_cur = *this; // where we will move to
pos_type left_pos; // position visually left of current cursor
pos_type right_pos; // position visually right of current cursor
getSurroundingPos(left_pos, right_pos);
LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
// Are we at an inset?
new_cur.pos() = right_pos;
new_cur.boundary(false);
if (!skip_inset &&
text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
// we actually move the cursor at the end of this
// function, for now we just keep track of the new
// position in new_cur...
LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
}
// Are we already at rightmost pos in row?
else if (text()->empty() || right_pos == -1) {
new_cur = *this;
if (!new_cur.posVisToNewRow(false)) {
LYXERR(Debug::RTL, "not moving!");
return false;
}
// we actually move the cursor at the end of this
// function, for now just keep track of the new
// position in new_cur...
LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
<< int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
}
// normal movement to the right
else {
new_cur = *this;
// Recall, if the cursor is at position 'x', that
// means *before* the character at position 'x'. In
// RTL, "before" means "to the right of", in LTR, "to
// the left of". So currently our situation is this:
// the position to our right is 'right_pos' (i.e.,
// we're currently to the left of 'right_pos'). In
// order to move to the right, it depends whether or
// not the character at 'right_pos' is RTL.
bool const new_pos_is_RTL = paragraph().getFontSettings(
buffer()->params(), right_pos).isVisibleRightToLeft();
// If the character at 'right_pos' *is* LTR, then in
// order to move to the right of it, we need to be
// *after* 'right_pos', i.e., move to position
// 'right_pos' + 1.
if (!new_pos_is_RTL) {
new_cur.pos() = right_pos + 1;
// set the boundary to true in two situations:
if (
// 1. if new_pos is now lastpos, and we're in
// an RTL paragraph (this means that we're
// moving right to the end of an LTR chunk
// which is at the end of an RTL paragraph);
(new_cur.pos() == lastpos()
&& paragraph().isRTL(buffer()->params()))
// 2. if the position *after* right_pos is RTL
// (we want to be *after* right_pos, not
// before right_pos + 1!)
|| paragraph().getFontSettings(buffer()->params(),
new_cur.pos()).isVisibleRightToLeft()
)
new_cur.boundary(true);
else // set the boundary to false
new_cur.boundary(false);
}
// Otherwise (if the character at position 'right_pos'
// is RTL), then moving to the right of it is as easy
// as setting the new position to 'right_pos'.
else {
new_cur.pos() = right_pos;
new_cur.boundary(false);
}
}
bool const moved = new_cur != *this || new_cur.boundary() != boundary();
if (moved) {
LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
<< (new_cur.boundary() ? " (boundary)" : ""));
*this = new_cur;
}
return moved;
}
bool Cursor::posVisLeft(bool skip_inset)
{
Cursor new_cur = *this; // where we will move to
pos_type left_pos; // position visually left of current cursor
pos_type right_pos; // position visually right of current cursor
getSurroundingPos(left_pos, right_pos);
LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
// Are we at an inset?
new_cur.pos() = left_pos;
new_cur.boundary(false);
if (!skip_inset &&
text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
// we actually move the cursor at the end of this
// function, for now we just keep track of the new
// position in new_cur...
LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
}
// Are we already at leftmost pos in row?
else if (text()->empty() || left_pos == -1) {
new_cur = *this;
if (!new_cur.posVisToNewRow(true)) {
LYXERR(Debug::RTL, "not moving!");
return false;
}
// we actually move the cursor at the end of this
// function, for now just keep track of the new
// position in new_cur...
LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
<< int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
}
// normal movement to the left
else {
new_cur = *this;
// Recall, if the cursor is at position 'x', that
// means *before* the character at position 'x'. In
// RTL, "before" means "to the right of", in LTR, "to
// the left of". So currently our situation is this:
// the position to our left is 'left_pos' (i.e., we're
// currently to the right of 'left_pos'). In order to
// move to the left, it depends whether or not the
// character at 'left_pos' is RTL.
bool const new_pos_is_RTL = paragraph().getFontSettings(
buffer()->params(), left_pos).isVisibleRightToLeft();
// If the character at 'left_pos' *is* RTL, then in
// order to move to the left of it, we need to be
// *after* 'left_pos', i.e., move to position
// 'left_pos' + 1.
if (new_pos_is_RTL) {
new_cur.pos() = left_pos + 1;
// set the boundary to true in two situations:
if (
// 1. if new_pos is now lastpos and we're in
// an LTR paragraph (this means that we're
// moving left to the end of an RTL chunk
// which is at the end of an LTR paragraph);
(new_cur.pos() == lastpos()
&& !paragraph().isRTL(buffer()->params()))
// 2. if the position *after* left_pos is not
// RTL (we want to be *after* left_pos, not
// before left_pos + 1!)
|| !paragraph().getFontSettings(buffer()->params(),
new_cur.pos()).isVisibleRightToLeft()
)
new_cur.boundary(true);
else // set the boundary to false
new_cur.boundary(false);
}
// Otherwise (if the character at position 'left_pos'
// is LTR), then moving to the left of it is as easy
// as setting the new position to 'left_pos'.
else {
new_cur.pos() = left_pos;
new_cur.boundary(false);
}
}
bool const moved = new_cur != *this || new_cur.boundary() != boundary();
if (moved) {
LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
<< (new_cur.boundary() ? " (boundary)" : ""));
*this = new_cur;
}
return moved;
}
namespace {
// Return true on success
bool findNonVirtual(Row const & row, Row::const_iterator & cit, bool onleft)
{
if (onleft) {
while (cit != row.begin() && cit->isVirtual())
--cit;
} else {
while (cit != row.end() && cit->isVirtual())
++cit;
}
return cit != row.end() && !cit->isVirtual();
}
}
void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const
{
// by default, we know nothing.
left_pos = -1;
right_pos = -1;
Row const & row = textRow();
TextMetrics const & tm = bv_->textMetrics(text());
double dummy = 0;
Row::const_iterator cit = tm.findRowElement(row, pos(), boundary(), dummy);
// Handle the case of empty row
if (cit == row.end()) {
if (paragraph().isRTL(buffer()->params()))
right_pos = row.pos();
else
left_pos = row.pos() - 1;
return;
}
// skip virtual elements and exit if no non-virtual one exists
if (!findNonVirtual(row, cit, !cit->isRTL()))
return;
// if the position is at the left side of the element, we have to
// look at the previous element
if (pos() == cit->left_pos()) {
LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
<< "), AT LEFT of *cit=" << *cit);
// this one is easy (see common case below)
right_pos = pos() - (cit->isRTL() ? 1 : 0);
// at the left of the row
if (cit == row.begin())
return;
--cit;
if (!findNonVirtual(row, cit, true))
return;
// [...[ is the row element, | is cursor position (! with boundary)
// [ 1 2 [ is a ltr row element with pos=1 and endpos=3
// ] 2 1] is an rtl row element with pos=1 and endpos=3
// [ 1 2 [ [|3 4 [ => (2, 3)
// or [ 1 2 [ ]!4 3 ] => (2, 4)
// or ] 2 1 ] [|3 4 [ => (1, 3)
// or ] 4 3 ] ]!2 1 ] => (3, 2)
left_pos = cit->right_pos() - (cit->isRTL() ? 0 : 1);
// happens with consecutive row of same direction
if (left_pos == right_pos) {
left_pos += cit->isRTL() ? 1 : -1;
}
}
// same code but with the element at the right
else if (pos() == cit->right_pos()) {
LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
<< "), AT RIGHT of *cit=" << *cit);
// this one is easy (see common case below)
left_pos = pos() - (cit->isRTL() ? 0 : 1);
// at the right of the row
if (cit + 1 == row.end())
return;
++cit;
if (!findNonVirtual(row, cit, false))
return;
// [ 1 2![ [ 3 4 [ => (2, 3)
// or [ 1 2![ ] 4 3 ] => (2, 4)
// or ] 2 1|] [ 3 4 [ => (1, 3)
// or ] 4 3|] ] 2 1 ] => (3, 2)
right_pos = cit->left_pos() - (cit->isRTL() ? 1 : 0);
// happens with consecutive row of same direction
if (right_pos == left_pos)
right_pos += cit->isRTL() ? -1 : 1;
}
// common case: both positions are inside the row element
else {
// [ 1 2|3 [ => (2, 3)
// or ] 3|2 1 ] => (3, 2)
left_pos = pos() - (cit->isRTL() ? 0 : 1);
right_pos = pos() - (cit->isRTL() ? 1 : 0);
}
// Note that debug message does not catch all early returns above
LYXERR(Debug::RTL,"getSurroundingPos(" << pos() << (boundary() ? "b" : "")
<< ") => (" << left_pos << ", " << right_pos <<")");
}
bool Cursor::posVisToNewRow(bool movingLeft)
{
Paragraph const & par = paragraph();
Buffer const & buf = *buffer();
Row const & row = textRow();
bool par_is_LTR = !par.isRTL(buf.params());
// Inside a table, determining whether to move to the next or
// previous row should be done based on the table's direction.
if (inset().asInsetTabular()) {
par_is_LTR = !inset().asInsetTabular()->isRightToLeft(*this);
LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
}
// if moving left in an LTR paragraph or moving right in an
// RTL one, move to previous row
if (par_is_LTR == movingLeft) {
if (row.pos() == 0) { // we're at first row in paragraph
if (pit() == 0) // no previous paragraph! don't move
return false;
// move to last pos in previous par
--pit();
pos() = lastpos();
boundary(false);
} else { // move to previous row in this par
pos() = row.pos() - 1; // this is guaranteed to be in previous row
boundary(false);
}
}
// if moving left in an RTL paragraph or moving right in an
// LTR one, move to next row
else {
if (row.endpos() == lastpos()) { // we're at last row in paragraph
if (pit() == lastpit()) // last paragraph! don't move
return false;
// move to first row in next par
++pit();
pos() = 0;
boundary(false);
} else { // move to next row in this par
pos() = row.endpos();
boundary(false);
}
}
// make sure we're at left-/right-most pos in new row
posVisToRowExtremity(!movingLeft);
return true;
}
void Cursor::posVisToRowExtremity(bool left)
{
LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
<< (boundary() ? 1 : 0));
TextMetrics const & tm = bv_->textMetrics(text());
// Looking for extremities is like clicking on the left or the
// right of the row.
int x = tm.origin().x_ + (left ? 0 : textRow().width());
bool b = false;
pos() = tm.getPosNearX(textRow(), x, b);
boundary(b);
LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
<< (boundary() ? 1 : 0));
}
bool Cursor::reverseDirectionNeeded() const
{
/*
* We determine the directions based on the direction of the
* bottom() --- i.e., outermost --- paragraph, because that is
* the only way to achieve consistency of the arrow's movements
* within a paragraph, and thus avoid situations in which the
* cursor gets stuck.
*/
return bottom().paragraph().isRTL(bv().buffer().params());
}
CursorSlice Cursor::normalAnchor() const
{
if (!selection())
return top();
// LASSERT: There have been several bugs around this code, that seem
// to involve failures to reset the anchor. We can at least not crash
// in release mode by resetting it ourselves.
if (anchor_.depth() < depth()) {
LYXERR0("Cursor is deeper than anchor. PLEASE REPORT.\nCursor is"
<< *this);
const_cast<DocIterator &>(anchor_) = *this;
}
CursorSlice normal = anchor_[depth() - 1];
if (depth() < anchor_.depth() && top() <= normal) {
// anchor is behind cursor -> move anchor behind the inset
++normal.pos();
}
return normal;
}
DocIterator & Cursor::realAnchor()
{
return anchor_;
}
CursorSlice Cursor::selBegin() const
{
if (!selection())
return top();
return normalAnchor() < top() ? normalAnchor() : top();
}
CursorSlice Cursor::selEnd() const
{
if (!selection())
return top();
return normalAnchor() > top() ? normalAnchor() : top();
}
DocIterator Cursor::selectionBegin() const
{
if (!selection())
return *this;
DocIterator di;
// FIXME: This is a work-around for the problem that
// CursorSlice doesn't keep track of the boundary.
if (normalAnchor() == top())
di = anchor_.boundary() > boundary() ? anchor_ : *this;
else
di = normalAnchor() < top() ? anchor_ : *this;
di.resize(depth());
return di;
}
DocIterator Cursor::selectionEnd() const
{
if (!selection())
return *this;
DocIterator di;
// FIXME: This is a work-around for the problem that
// CursorSlice doesn't keep track of the boundary.
if (normalAnchor() == top())
di = anchor_.boundary() < boundary() ? anchor_ : *this;
else
di = normalAnchor() > top() ? anchor_ : *this;
if (di.depth() > depth()) {
di.resize(depth());
++di.pos();
}
return di;
}
void Cursor::setSelection()
{
setSelection(true);
if (idx() == normalAnchor().idx() &&
pit() == normalAnchor().pit() &&
pos() == normalAnchor().pos())
setSelection(false);
}
void Cursor::setSelection(DocIterator const & where, int n)
{
setCursor(where);
setSelection(true);
anchor_ = where;
pos() += n;
}
void Cursor::clearSelection()
{
setSelection(false);
setWordSelection(false);
setMark(false);
resetAnchor();
}
void Cursor::setTargetX(int x)
{
x_target_ = x;
textTargetOffset_ = 0;
}
int Cursor::x_target() const
{
return x_target_;
}
void Cursor::clearTargetX()
{
x_target_ = -1;
textTargetOffset_ = 0;
}
void Cursor::updateTextTargetOffset()
{
int x;
int y;
getPos(x, y);
textTargetOffset_ = x - x_target_;
}
void Cursor::info(odocstream & os) const
{
for (int i = 1, n = depth(); i < n; ++i) {
operator[](i).inset().infoize(os);
os << " ";
}
if (pos() != 0) {
Inset const * inset = prevInset();
// prevInset() can return 0 in certain case.
if (inset)
prevInset()->infoize2(os);
}
}
bool Cursor::selHandle(bool sel)
{
//lyxerr << "Cursor::selHandle" << endl;
if (mark())
sel = true;
if (sel == selection())
return false;
if (!sel)
cap::saveSelection(*this);
resetAnchor();
setSelection(sel);
return true;
}
} // namespace lyx
///////////////////////////////////////////////////////////////////
//
// FIXME: Look here
// The part below is the non-integrated rest of the original math
// cursor. This should be either generalized for texted or moved
// back to mathed (in most cases to InsetMathNest).
//
///////////////////////////////////////////////////////////////////
#include "mathed/InsetMathChar.h"
#include "mathed/InsetMathGrid.h"
#include "mathed/InsetMathScript.h"
#include "mathed/InsetMathUnknown.h"
#include "mathed/MathFactory.h"
#include "mathed/MathStream.h"
#include "mathed/MathSupport.h"
namespace lyx {
bool Cursor::isInside(Inset const * p) const
{
for (size_t i = 0; i != depth(); ++i)
if (&operator[](i).inset() == p)
return true;
return false;
}
void Cursor::leaveInset(Inset const & inset)
{
for (size_t i = 0; i != depth(); ++i) {
if (&operator[](i).inset() == &inset) {
resize(i);
return;
}
}
}
bool Cursor::openable(MathAtom const & t) const
{
if (!t->isActive())
return false;
if (t->lock())
return false;
if (!selection())
return true;
// we can't move into anything new during selection
if (depth() >= anchor_.depth())
return false;
if (t.nucleus() != &anchor_[depth()].inset())
return false;
return true;
}
void Cursor::setScreenPos(int x, int /*y*/)
{
setTargetX(x);
//bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
}
void Cursor::plainErase()
{
cell().erase(pos());
}
void Cursor::markInsert()
{
insert(char_type(0));
}
void Cursor::markErase()
{
cell().erase(pos());
}
void Cursor::plainInsert(MathAtom const & t)
{
cell().insert(pos(), t);
++pos();
inset().setBuffer(bv_->buffer());
inset().initView();
checkBufferStructure();
}
void Cursor::insert(docstring const & str)
{
for_each(str.begin(), str.end(),
bind(static_cast<void(Cursor::*)(char_type)>
(&Cursor::insert), this, _1));
}
void Cursor::insert(char_type c)
{
//lyxerr << "Cursor::insert char '" << c << "'" << endl;
LASSERT(!empty(), return);
if (inMathed()) {
cap::selClearOrDel(*this);
insert(new InsetMathChar(c));
} else {
text()->insertChar(*this, c);
}
}
void Cursor::insert(MathAtom const & t)
{
//lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
macroModeClose();
cap::selClearOrDel(*this);
plainInsert(t);
}
void Cursor::insert(Inset * inset0)
{
LASSERT(inset0, return);
if (inMathed())
insert(MathAtom(inset0->asInsetMath()));
else {
text()->insertInset(*this, inset0);
inset0->setBuffer(bv_->buffer());
inset0->initView();
if (inset0->isLabeled())
forceBufferUpdate();
}
}
int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
{
MathData ar(buffer());
asArray(t, ar, f);
if (ar.size() == 1 && (enter || selection()))
niceInsert(ar[0]);
else
insert(ar);
return ar.size();
}
void Cursor::niceInsert(MathAtom const & t)
{
macroModeClose();
docstring const safe = cap::grabAndEraseSelection(*this);
plainInsert(t);
// If possible, enter the new inset and move the contents of the selection
if (t->isActive()) {
posBackward();
// be careful here: don't use 'pushBackward(t)' as this we need to
// push the clone, not the original
pushBackward(*nextInset());
// We may not use niceInsert here (recursion)
MathData ar(buffer());
asArray(safe, ar);
insert(ar);
} else if (t->asMacro() && !safe.empty()) {
MathData ar(buffer());
asArray(safe, ar);
docstring const name = t->asMacro()->name();
MacroData const * data = buffer()->getMacro(name);
if (data && data->numargs() - data->optionals() > 0) {
plainInsert(MathAtom(new InsetMathBrace(ar)));
posBackward();
}
}
}
void Cursor::insert(MathData const & ar)
{
macroModeClose();
if (selection())
cap::eraseSelection(*this);
cell().insert(pos(), ar);
pos() += ar.size();
// FIXME audit setBuffer calls
inset().setBuffer(bv_->buffer());
}
bool Cursor::backspace()
{
if (selection()) {
cap::eraseSelection(*this);
return true;
}
if (pos() == 0) {
// If empty cell, and not part of a big cell
if (lastpos() == 0 && inset().nargs() == 1) {
popBackward();
// Directly delete empty cell: [|[]] => [|]
if (inMathed()) {
plainErase();
resetAnchor();
return true;
}
// [|], can not delete from inside
return false;
} else {
if (inMathed())
pullArg();
else
popBackward();
return true;
}
}
if (inMacroMode()) {
InsetMathUnknown * p = activeMacro();
if (p->name().size() > 1) {
p->setName(p->name().substr(0, p->name().size() - 1));
return true;
}
}
if (pos() != 0 && prevAtom()->nargs() > 0) {
// let's require two backspaces for 'big stuff' and
// highlight on the first
resetAnchor();
setSelection(true);
--pos();
} else {
--pos();
plainErase();
}
return true;
}
bool Cursor::erase()
{
if (inMacroMode())
return true;
if (selection()) {
cap::eraseSelection(*this);
return true;
}
// delete empty cells if possible
if (pos() == lastpos() && inset().idxDelete(idx()))
return true;
// special behaviour when in last position of cell
if (pos() == lastpos()) {
bool one_cell = inset().nargs() == 1;
if (one_cell && lastpos() == 0) {
popBackward();
// Directly delete empty cell: [|[]] => [|]
if (inMathed()) {
plainErase();
resetAnchor();
return true;
}
// [|], can not delete from inside
return false;
}
// remove markup
if (!one_cell)
inset().idxGlue(idx());
return true;
}
// 'clever' UI hack: only erase large items if previously slected
if (pos() != lastpos() && nextAtom()->nargs() > 0) {
resetAnchor();
setSelection(true);
++pos();
} else {
plainErase();
}
return true;
}
bool Cursor::up()
{
macroModeClose();
DocIterator save = *this;
FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
this->dispatch(cmd);
if (disp_.dispatched())
return true;
setCursor(save);
return false;
}
bool Cursor::down()
{
macroModeClose();
DocIterator save = *this;
FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
this->dispatch(cmd);
if (disp_.dispatched())
return true;
setCursor(save);
return false;
}
bool Cursor::macroModeClose()
{
if (!inMacroMode())
return false;
InsetMathUnknown * p = activeMacro();
p->finalize();
MathData selection(buffer());
asArray(p->selection(), selection);
docstring const s = p->name();
--pos();
cell().erase(pos());
// do nothing if the macro name is empty
if (s == "\\")
return false;
// trigger updates of macros, at least, if no full
// updates take place anyway
screenUpdateFlags(Update::Force);
docstring const name = s.substr(1);
InsetMathNest * const in = inset().asInsetMath()->asNestInset();
if (in && in->interpretString(*this, s))
return true;
MathAtom atom = buffer()->getMacro(name, *this, false) ?
MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
// try to put argument into macro, if we just inserted a macro
bool macroArg = false;
MathMacro * atomAsMacro = atom.nucleus()->asMacro();
if (atomAsMacro) {
// macros here are still unfolded (in init mode in fact). So
// we have to resolve the macro here manually and check its arity
// to put the selection behind it if arity > 0.
MacroData const * data = buffer()->getMacro(atomAsMacro->name());
if (!selection.empty() && data && data->numargs() - data->optionals() > 0) {
macroArg = true;
atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
} else
// non-greedy case. Do not touch the arguments behind
atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
}
// insert remembered selection into first argument of a non-macro
else if (atom.nucleus()->nargs() > 0)
atom.nucleus()->cell(0).append(selection);
plainInsert(atom);
// finally put the macro argument behind, if needed
if (macroArg) {
if (selection.size() > 1 || selection[0]->asScriptInset())
plainInsert(MathAtom(new InsetMathBrace(selection)));
else
insert(selection);
}
return true;
}
docstring Cursor::macroName()
{
return inMacroMode() ? activeMacro()->name() : docstring();
}
void Cursor::handleNest(MathAtom const & a, int c)
{
//lyxerr << "Cursor::handleNest: " << c << endl;
MathAtom t = a;
asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
insert(t);
posBackward();
pushBackward(*nextInset());
}
int Cursor::targetX() const
{
if (x_target() != -1)
return x_target();
int x = 0;
int y = 0;
getPos(x, y);
return x;
}
int Cursor::textTargetOffset() const
{
return textTargetOffset_;
}
void Cursor::setTargetX()
{
int x;
int y;
getPos(x, y);
setTargetX(x);
}
bool Cursor::inMacroMode() const
{
if (!inMathed())
return false;
if (pos() == 0 || cell().empty())
return false;
InsetMathUnknown const * p = prevAtom()->asUnknownInset();
return p && !p->final();
}
InsetMathUnknown * Cursor::activeMacro()
{
return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
}
InsetMathUnknown const * Cursor::activeMacro() const
{
return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
}
void Cursor::pullArg()
{
// FIXME: Look here
MathData ar = cell();
if (popBackward() && inMathed()) {
plainErase();
cell().insert(pos(), ar);
resetAnchor();
} else {
//formula()->mutateToText();
}
}
void Cursor::touch()
{
// FIXME: look here
#if 0
DocIterator::const_iterator it = begin();
DocIterator::const_iterator et = end();
for ( ; it != et; ++it)
it->cell().touch();
#endif
}
void Cursor::normalize()
{
if (idx() > lastidx()) {
lyxerr << "this should not really happen - 1: "
<< idx() << ' ' << nargs()
<< " in: " << &inset() << endl;
idx() = lastidx();
}
if (pos() > lastpos()) {
lyxerr << "this should not really happen - 2: "
<< pos() << ' ' << lastpos() << " in idx: " << idx()
<< " in atom: '";
odocstringstream os;
TexRow texrow(false);
otexrowstream ots(os,texrow);
WriteStream wi(ots, false, true, WriteStream::wsDefault);
inset().asInsetMath()->write(wi);
lyxerr << to_utf8(os.str()) << endl;
pos() = lastpos();
}
}
bool Cursor::upDownInMath(bool up)
{
// Be warned: The 'logic' implemented in this function is highly
// fragile. A distance of one pixel or a '<' vs '<=' _really
// matters. So fiddle around with it only if you think you know
// what you are doing!
int xo = 0;
int yo = 0;
getPos(xo, yo);
xo = beforeDispatchPosX_;
// check if we had something else in mind, if not, this is the future
// target
if (x_target_ == -1)
setTargetX(xo);
else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
// In text mode inside the line (not left or right) possibly set a new target_x,
// but only if we are somewhere else than the previous target-offset.
// We want to keep the x-target on subsequent up/down movements
// that cross beyond the end of short lines. Thus a special
// handling when the cursor is at the end of line: Use the new
// x-target only if the old one was before the end of line
// or the old one was after the beginning of the line
bool inRTL = innerParagraph().isRTL(bv().buffer().params());
bool left;
bool right;
if (inRTL) {
left = pos() == textRow().endpos();
right = pos() == textRow().pos();
} else {
left = pos() == textRow().pos();
right = pos() == textRow().endpos();
}
if ((!left && !right) ||
(left && !right && xo < x_target_) ||
(!left && right && x_target_ < xo))
setTargetX(xo);
else
xo = targetX();
} else
xo = targetX();
// try neigbouring script insets
Cursor old = *this;
if (inMathed() && !selection()) {
// try left
if (pos() != 0) {
InsetMathScript const * p = prevAtom()->asScriptInset();
if (p && p->has(up)) {
--pos();
push(*const_cast<InsetMathScript*>(p));
idx() = p->idxOfScript(up);
pos() = lastpos();
// we went in the right direction? Otherwise don't jump into the script
int x;
int y;
getPos(x, y);
int oy = beforeDispatchPosY_;
if ((!up && y <= oy) ||
(up && y >= oy))
operator=(old);
else
return true;
}
}
// try right
if (pos() != lastpos()) {
InsetMathScript const * p = nextAtom()->asScriptInset();
if (p && p->has(up)) {
push(*const_cast<InsetMathScript*>(p));
idx() = p->idxOfScript(up);
pos() = 0;
// we went in the right direction? Otherwise don't jump into the script
int x;
int y;
getPos(x, y);
int oy = beforeDispatchPosY_;
if ((!up && y <= oy) ||
(up && y >= oy))
operator=(old);
else
return true;
}
}
}
// try to find an inset that knows better then we,
if (inset().idxUpDown(*this, up)) {
//lyxerr << "idxUpDown triggered" << endl;
// try to find best position within this inset
if (!selection())
setCursor(bruteFind2(*this, xo, yo));
return true;
}
// any improvement going just out of inset?
if (popBackward() && inMathed()) {
//lyxerr << "updown: popBackward succeeded" << endl;
int xnew;
int ynew;
int yold = beforeDispatchPosY_;
getPos(xnew, ynew);
if (up ? ynew < yold : ynew > yold)
return true;
}
// no success, we are probably at the document top or bottom
operator=(old);
return false;
}
bool Cursor::atFirstOrLastRow(bool up)
{
TextMetrics const & tm = bv_->textMetrics(text());
ParagraphMetrics const & pm = tm.parMetrics(pit());
int row;
if (pos() && boundary())
row = pm.pos2row(pos() - 1);
else
row = pm.pos2row(pos());
if (up) {
if (pit() == 0 && row == 0)
return true;
} else {
if (pit() + 1 >= int(text()->paragraphs().size()) &&
row + 1 >= int(pm.rows().size()))
return true;
}
return false;
}
bool Cursor::upDownInText(bool up, bool & updateNeeded)
{
LASSERT(text(), return false);
// where are we?
int xo = 0;
int yo = 0;
getPos(xo, yo);
xo = beforeDispatchPosX_;
// update the targetX - this is here before the "return false"
// to set a new target which can be used by InsetTexts above
// if we cannot move up/down inside this inset anymore
if (x_target_ == -1)
setTargetX(xo);
else if (xo - textTargetOffset() != x_target() &&
depth() == beforeDispatchCursor_.depth()) {
// In text mode inside the line (not left or right)
// possibly set a new target_x, but only if we are
// somewhere else than the previous target-offset.
// We want to keep the x-target on subsequent up/down
// movements that cross beyond the end of short lines.
// Thus a special handling when the cursor is at the
// end of line: Use the new x-target only if the old
// one was before the end of line or the old one was
// after the beginning of the line
bool inRTL = innerParagraph().isRTL(bv().buffer().params());
bool left;
bool right;
if (inRTL) {
left = pos() == textRow().endpos();
right = pos() == textRow().pos();
} else {
left = pos() == textRow().pos();
right = pos() == textRow().endpos();
}
if ((!left && !right) ||
(left && !right && xo < x_target_) ||
(!left && right && x_target_ < xo))
setTargetX(xo);
else
xo = targetX();
} else
xo = targetX();
// first get the current line
TextMetrics & tm = bv_->textMetrics(text());
ParagraphMetrics const & pm = tm.parMetrics(pit());
int row;
if (pos() && boundary())
row = pm.pos2row(pos() - 1);
else
row = pm.pos2row(pos());
if (atFirstOrLastRow(up)) {
// Is there a place for the cursor to go ? If yes, we
// can execute the DEPM, otherwise we should keep the
// paragraph to host the cursor.
Cursor dummy = *this;
bool valid_destination = false;
for(; dummy.depth(); dummy.pop())
if (!dummy.atFirstOrLastRow(up)) {
valid_destination = true;
break;
}
// will a next dispatch follow and if there is a new
// dispatch will it move the cursor out ?
if (depth() > 1 && valid_destination) {
// The cursor hasn't changed yet. This happens when
// you e.g. move out of an inset. And to give the
// DEPM the possibility of doing something we must
// provide it with two different cursors. (Lgb, vfr)
dummy = *this;
dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
updateNeeded |= bv().checkDepm(dummy, *this);
updateTextTargetOffset();
if (updateNeeded)
forceBufferUpdate();
}
return false;
}
// with and without selection are handled differently
if (!selection()) {
int yo = bv().getPos(*this).y_;
Cursor old = *this;
// To next/previous row
if (up)
tm.editXY(*this, xo, yo - textRow().ascent() - 1);
else
tm.editXY(*this, xo, yo + textRow().descent() + 1);
clearSelection();
// This happens when you move out of an inset.
// And to give the DEPM the possibility of doing
// something we must provide it with two different
// cursors. (Lgb)
Cursor dummy = *this;
if (dummy == old)
++dummy.pos();
if (bv().checkDepm(dummy, old)) {
updateNeeded = true;
// Make sure that cur gets back whatever happened to dummy (Lgb)
operator=(dummy);
}
if (inTexted() && pos() && paragraph().isEnvSeparator(pos() - 1))
posBackward();
} else {
// if there is a selection, we stay out of any inset,
// and just jump to the right position:
Cursor old = *this;
int next_row = row;
if (up) {
if (row > 0) {
--next_row;
} else if (pit() > 0) {
--pit();
TextMetrics & tm = bv_->textMetrics(text());
if (!tm.contains(pit()))
tm.newParMetricsUp();
ParagraphMetrics const & pmcur = tm.parMetrics(pit());
next_row = pmcur.rows().size() - 1;
}
} else {
if (row + 1 < int(pm.rows().size())) {
++next_row;
} else if (pit() + 1 < int(text()->paragraphs().size())) {
++pit();
TextMetrics & tm = bv_->textMetrics(text());
if (!tm.contains(pit()))
tm.newParMetricsDown();
next_row = 0;
}
}
Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
bool bound = false;
top().pos() = tm.getPosNearX(real_next_row, xo, bound);
boundary(bound);
updateNeeded |= bv().checkDepm(*this, old);
}
if (updateNeeded)
forceBufferUpdate();
updateTextTargetOffset();
return true;
}
void Cursor::handleFont(string const & font)
{
LYXERR(Debug::DEBUG, font);
docstring safe;
if (selection()) {
macroModeClose();
safe = cap::grabAndEraseSelection(*this);
}
recordUndoInset();
if (lastpos() != 0) {
// something left in the cell
if (pos() == 0) {
// cursor in first position
popBackward();
} else if (pos() == lastpos()) {
// cursor in last position
popForward();
} else {
// cursor in between. split cell
MathData::iterator bt = cell().begin();
MathAtom at = createInsetMath(from_utf8(font), buffer());
at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
cell().erase(bt, bt + pos());
popBackward();
plainInsert(at);
}
} else {
// nothing left in the cell
popBackward();
plainErase();
resetAnchor();
}
insert(safe);
}
void Cursor::message(docstring const & msg) const
{
disp_.setMessage(msg);
}
void Cursor::errorMessage(docstring const & msg) const
{
disp_.setMessage(msg);
disp_.setError(true);
}
namespace {
docstring parbreak(Cursor const * cur)
{
odocstringstream os;
os << '\n';
// only add blank line if we're not in a ParbreakIsNewline situation
if (!cur->inset().getLayout().parbreakIsNewline()
&& !cur->paragraph().layout().parbreak_is_newline)
os << '\n';
return os.str();
}
}
docstring Cursor::selectionAsString(bool with_label) const
{
if (!selection())
return docstring();
if (inMathed())
return cap::grabSelection(*this);
int const label = with_label
? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
idx_type const startidx = selBegin().idx();
idx_type const endidx = selEnd().idx();
if (startidx != endidx) {
// multicell selection
InsetTabular * table = inset().asInsetTabular();
LASSERT(table, return docstring());
return table->asString(startidx, endidx);
}
ParagraphList const & pars = text()->paragraphs();
pit_type const startpit = selBegin().pit();
pit_type const endpit = selEnd().pit();
size_t const startpos = selBegin().pos();
size_t const endpos = selEnd().pos();
if (startpit == endpit)
return pars[startpit].asString(startpos, endpos, label);
// First paragraph in selection
docstring result = pars[startpit].
asString(startpos, pars[startpit].size(), label)
+ parbreak(this);
// The paragraphs in between (if any)
for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
Paragraph const & par = pars[pit];
result += par.asString(0, par.size(), label)
+ parbreak(this);
}
// Last paragraph in selection
result += pars[endpit].asString(0, endpos, label);
return result;
}
docstring Cursor::currentState() const
{
if (inMathed()) {
odocstringstream os;
info(os);
#ifdef DEVEL_VERSION
InsetMath * math = inset().asInsetMath();
if (math)
os << _(", Inset: ") << math->id();
os << _(", Cell: ") << idx();
os << _(", Position: ") << pos();
#endif
return os.str();
}
if (inTexted())
return text()->currentState(*this);
return docstring();
}
docstring Cursor::getPossibleLabel() const
{
return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
}
Encoding const * Cursor::getEncoding() const
{
if (empty())
return 0;
CursorSlice const & sl = innerTextSlice();
Text const & text = *sl.text();
Font font = text.getPar(sl.pit()).getFont(
bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
return font.language()->encoding();
}
void Cursor::undispatched() const
{
disp_.dispatched(false);
}
void Cursor::dispatched() const
{
disp_.dispatched(true);
}
void Cursor::screenUpdateFlags(Update::flags f) const
{
disp_.screenUpdate(f);
}
void Cursor::forceBufferUpdate() const
{
disp_.forceBufferUpdate();
}
void Cursor::clearBufferUpdate() const
{
disp_.clearBufferUpdate();
}
bool Cursor::needBufferUpdate() const
{
return disp_.needBufferUpdate();
}
void Cursor::noScreenUpdate() const
{
disp_.screenUpdate(Update::None);
}
Font Cursor::getFont() const
{
// The logic here should more or less match to the
// Cursor::setCurrentFont logic, i.e. the cursor height should
// give a hint what will happen if a character is entered.
// HACK. far from being perfect...
CursorSlice const & sl = innerTextSlice();
Text const & text = *sl.text();
Paragraph const & par = text.getPar(sl.pit());
// on boundary, so we are really at the character before
pos_type pos = sl.pos();
if (pos > 0 && boundary())
--pos;
// on space? Take the font before (only for RTL boundary stay)
if (pos > 0) {
TextMetrics const & tm = bv().textMetrics(&text);
if (pos == sl.lastpos()
|| (par.isSeparator(pos)
&& !tm.isRTLBoundary(sl.pit(), pos)))
--pos;
}
// get font at the position
Font font = par.getFont(buffer()->params(), pos,
text.outerFont(sl.pit()));
return font;
}
bool Cursor::fixIfBroken()
{
bool const broken_cursor = DocIterator::fixIfBroken();
bool const broken_anchor = anchor_.fixIfBroken();
if (broken_cursor || broken_anchor) {
clearNewWordPosition();
clearSelection();
return true;
}
return false;
}
void Cursor::sanitize()
{
setBuffer(&bv_->buffer());
DocIterator::sanitize();
if (selection())
anchor_.sanitize();
else
resetAnchor();
}
bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
{
// find inset in common
size_type i;
for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
if (&old[i].inset() != &cur[i].inset())
break;
}
// update words if we just moved to another paragraph
if (i == old.depth() && i == cur.depth()
&& !cur.buffer()->isClean()
&& cur.inTexted() && old.inTexted()
&& cur.pit() != old.pit()) {
old.paragraph().updateWords();
}
// notify everything on top of the common part in old cursor,
// but stop if the inset claims the cursor to be invalid now
for (size_type j = i; j < old.depth(); ++j) {
Cursor inset_pos = old;
inset_pos.cutOff(j);
if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
return true;
}
// notify everything on top of the common part in new cursor,
// but stop if the inset claims the cursor to be invalid now
for (; i < cur.depth(); ++i) {
if (cur[i].inset().notifyCursorEnters(cur))
return true;
}
return false;
}
void Cursor::setCurrentFont()
{
CursorSlice const & cs = innerTextSlice();
Paragraph const & par = cs.paragraph();
pos_type cpit = cs.pit();
pos_type cpos = cs.pos();
Text const & ctext = *cs.text();
TextMetrics const & tm = bv().textMetrics(&ctext);
// are we behind previous char in fact? -> go to that char
if (cpos > 0 && boundary())
--cpos;
// find position to take the font from
if (cpos != 0) {
// paragraph end? -> font of last char
if (cpos == lastpos())
--cpos;
// on space? -> look at the words in front of space
else if (cpos > 0 && par.isSeparator(cpos)) {
// abc| def -> font of c
// abc |[WERBEH], i.e. boundary==true -> font of c
// abc [WERBEH]| def, font of the space
if (!tm.isRTLBoundary(cpit, cpos))
--cpos;
}
}
// get font
BufferParams const & bufparams = buffer()->params();
current_font = par.getFontSettings(bufparams, cpos);
real_current_font = tm.displayFont(cpit, cpos);
// special case for paragraph end
if (cs.pos() == lastpos()
&& tm.isRTLBoundary(cpit, cs.pos())
&& !boundary()) {
Language const * lang = par.getParLanguage(bufparams);
current_font.setLanguage(lang);
current_font.fontInfo().setNumber(FONT_OFF);
real_current_font.setLanguage(lang);
real_current_font.fontInfo().setNumber(FONT_OFF);
}
}
bool Cursor::textUndo()
{
if (!buffer()->undo().textUndo(*this))
return false;
sanitize();
return true;
}
bool Cursor::textRedo()
{
if (!buffer()->undo().textRedo(*this))
return false;
sanitize();
return true;
}
void Cursor::finishUndo() const
{
buffer()->undo().finishUndo();
}
void Cursor::beginUndoGroup() const
{
buffer()->undo().beginUndoGroup(*this);
}
void Cursor::endUndoGroup() const
{
buffer()->undo().endUndoGroup(*this);
}
void Cursor::recordUndo(pit_type from, pit_type to) const
{
buffer()->undo().recordUndo(*this, from, to);
}
void Cursor::recordUndo(pit_type from) const
{
buffer()->undo().recordUndo(*this, from, pit());
}
void Cursor::recordUndo(UndoKind kind) const
{
buffer()->undo().recordUndo(*this, kind);
}
void Cursor::recordUndoInset(Inset const * in) const
{
buffer()->undo().recordUndoInset(*this, in);
}
void Cursor::recordUndoFullBuffer() const
{
buffer()->undo().recordUndoFullBuffer(*this);
}
void Cursor::recordUndoBufferParams() const
{
buffer()->undo().recordUndoBufferParams(*this);
}
void Cursor::recordUndoSelection() const
{
if (inMathed()) {
if (cap::multipleCellsSelected(*this))
recordUndoInset();
else
recordUndo();
} else {
buffer()->undo().recordUndo(*this,
selBegin().pit(), selEnd().pit());
}
}
void Cursor::checkBufferStructure()
{
Buffer const * master = buffer()->masterBuffer();
master->tocBackend().updateItem(*this);
if (master != buffer() && !master->hasGuiDelegate())
// In case the master has no gui associated with it,
// the TocItem is not updated (part of bug 5699).
buffer()->tocBackend().updateItem(*this);
// If the last tracked change of the paragraph has just been
// deleted, then we need to recompute the buffer flag
// tracked_changes_present_.
if (inTexted() && paragraph().isChangeUpdateRequired())
disp_.forceChangesUpdate();
}
} // namespace lyx