2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2001 The LyX Team.
10 * ====================================================== */
20 #include "lyxcursor.h"
21 #include "paragraph.h"
35 This class holds the mapping between buffer paragraphs and screen rows.
46 NEED_VERY_LITTLE_REFRESH = 2,
52 // the word around the cursor, only if the cursor is
55 // the word around the cursor
57 /// the word begining from the cursor position
59 /// the word around the cursor or before the cursor
61 /// the next word (not yet used)
66 LyXText(BufferView *);
73 void init(BufferView *, bool reinit = false);
75 mutable int number_of_rows;
79 mutable unsigned int width;
80 /// the current font settings
81 mutable LyXFont current_font;
83 mutable LyXFont real_current_font;
84 /// first visible pixel-row is set from LyXScreen!!!
85 // unsigned is wrong here for text-insets!
88 BufferView * bv_owner;
90 InsetText * inset_owner;
92 UpdatableInset * the_locking_inset;
95 int getRealCursorX(BufferView *) const;
97 LyXFont const getFont(Buffer const *, Paragraph * par,
98 Paragraph::size_type pos) const;
100 LyXFont const getLayoutFont(Buffer const *, Paragraph * par) const;
102 LyXFont const getLabelFont(Buffer const *, Paragraph * par) const;
104 void setCharFont(Buffer const *, Paragraph * par,
105 Paragraph::size_type pos, LyXFont const & font);
106 void setCharFont(BufferView *, Paragraph * par,
107 Paragraph::size_type pos,
108 LyXFont const & font, bool toggleall);
109 /// returns a pointer to the very first Paragraph
110 Paragraph * firstParagraph() const;
112 /// what you expect when pressing <enter> at cursor position
113 void breakParagraph(BufferView *, char keep_layout = 0);
115 /** set layout over selection and make a total rebreak of
118 Paragraph * setLayout(BufferView *, LyXCursor & actual_cursor,
119 LyXCursor & selection_start,
120 LyXCursor & selection_end,
121 LyXTextClass::size_type layout);
122 void setLayout(BufferView *, LyXTextClass::size_type layout);
124 /// used in setlayout
125 void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
127 /** increment depth over selection and make a total rebreak of those
130 void incDepth(BufferView *);
132 /** decrement depth over selection and make a total rebreak of those
134 void decDepth(BufferView *);
136 /** Get the depth at current cursor position
138 int getDepth() const { return cursor.par()->getDepth(); }
140 /** set font over selection and make a total rebreak of those
142 toggleall defaults to false.
144 void setFont(BufferView *, LyXFont const &, bool toggleall = false);
146 /** deletes and inserts again all paragaphs between the cursor
147 and the specified par. The Cursor is needed to set the refreshing
149 This function is needed after SetLayout and SetFont etc.
151 void redoParagraphs(BufferView *, LyXCursor const & cursor,
152 Paragraph const * end_par) const;
154 void redoParagraph(BufferView *) const;
157 void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
160 string getStringToIndex(BufferView *);
162 /** recalculates the heights of all previous rows of the
163 specified paragraph. needed, if the last characters font
166 void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
168 /** forces the redrawing of a paragraph. Needed when manipulating a
171 void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
173 /** insert a character, moves all the following breaks in the
174 same Paragraph one to the right and make a little rebreak
176 void insertChar(BufferView *, char c);
178 void insertInset(BufferView *, Inset * inset);
180 /** Completes the insertion with a full rebreak.
181 Returns true if something was broken. */
182 bool fullRebreak(BufferView *);
185 mutable Row * need_break_row;
187 mutable int refresh_y;
195 mutable Row * refresh_row;
197 Paragraph::size_type refresh_pos;
199 /// give and set the LyXText status
200 text_status status() const;
202 void status(BufferView *, text_status) const;
205 /** wether the screen needs a refresh,
206 starting with refresh_y
208 mutable text_status status_;
211 /** returns a pointer to the row near the specified y-coordinate
212 (relative to the whole text). y is set to the real beginning
215 Row * getRowNearY(int & y) const;
217 /** returns the column near the specified x-coordinate of the row
218 x is set to the real beginning of this column
220 Paragraph::size_type getColumnNearX(BufferView *, Row * row,
221 int & x, bool & boundary) const;
223 /** returns a pointer to a specified row. y is set to the beginning
226 Row * getRow(Paragraph * par,
227 Paragraph::size_type pos, int & y) const;
229 /** returns the height of a default row, needed for scrollbar
231 int defaultHeight() const;
234 Later this variable has to be removed. There should be now internal
235 cursor in a text (and thus not in a buffer). By keeping this it is
236 (I think) impossible to have several views with the same buffer, but
237 the cursor placed at different places.
239 Since the LyXText now has been moved from Buffer to BufferView
240 it should not be absolutely needed to move the cursor...
242 mutable LyXCursor cursor; // actual cursor position
244 /** The structure that keeps track of the selections set. */
247 : set_(false), mark_(false)
261 LyXCursor cursor; // temporary cursor to hold a cursor position
262 // until setSelection is called!
263 LyXCursor start; // start of a REAL selection
264 LyXCursor end; // end of a REAL selection
266 bool set_; // former selection
267 bool mark_; // former mark_set
270 mutable Selection selection;
272 /// needed for the toggling (cursor position on last selection made)
273 mutable LyXCursor last_sel_cursor;
274 /// needed for toggling the selection in screen.C
275 mutable LyXCursor toggle_cursor;
276 /// needed for toggling the selection in screen.C
277 mutable LyXCursor toggle_end_cursor;
279 /// need the selection cursor:
280 void setSelection(BufferView *);
282 void clearSelection() const;
284 string const selectionAsString(Buffer const *, bool label) const;
286 /// select the word we need depending on word_location
287 void getWord(LyXCursor & from, LyXCursor & to,
288 word_location const) const;
289 /// just selects the word the cursor is in
290 void selectWord(BufferView *, word_location const);
291 /// returns the inset at cursor (if it exists), 0 otherwise
292 Inset * getInset() const;
294 /** 'selects" the next word, where the cursor is not in
295 and returns this word as string. THe cursor will be moved
296 to the beginning of this word.
297 With SelectSelectedWord can this be highlighted really
299 string const selectNextWordToSpellcheck(BufferView *, float & value) const;
301 void selectSelectedWord(BufferView *);
303 void setCursor(BufferView *, Paragraph * par,
304 Paragraph::size_type pos,
306 bool boundary = false) const;
308 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
309 Paragraph::size_type pos,
310 bool boundary = false) const;
312 void setCursorIntern(BufferView *, Paragraph * par,
313 Paragraph::size_type pos,
315 bool boundary = false) const;
317 void setCurrentFont(BufferView *) const;
320 bool isBoundary(Buffer const *, Paragraph * par,
321 Paragraph::size_type pos) const;
323 bool isBoundary(Buffer const *, Paragraph * par,
324 Paragraph::size_type pos,
325 LyXFont const & font) const;
328 void setCursorFromCoordinates(BufferView *, int x, int y) const;
330 void setCursorFromCoordinates(BufferView *, LyXCursor &,
333 void cursorUp(BufferView *) const;
335 void cursorDown(BufferView *) const;
337 void cursorLeft(BufferView *, bool internal = true) const;
339 void cursorRight(BufferView *, bool internal = true) const;
341 void cursorLeftOneWord(BufferView *) const;
343 void cursorLeftOneWord(LyXCursor &) const;
345 void cursorRightOneWord(BufferView *) const;
347 void cursorUpParagraph(BufferView *) const;
349 void cursorDownParagraph(BufferView *) const;
351 void cursorHome(BufferView *) const;
353 void cursorEnd(BufferView *) const;
355 void cursorTab(BufferView *) const;
357 void cursorTop(BufferView *) const;
359 void cursorBottom(BufferView *) const;
361 void Delete(BufferView *);
363 void backspace(BufferView *);
365 void deleteWordForward(BufferView *);
367 void deleteWordBackward(BufferView *);
369 void deleteLineForward(BufferView *);
371 bool selectWordWhenUnderCursor(BufferView *,
372 word_location const);
378 text_capitalization = 1,
382 /// Change the case of the word at cursor position.
383 void changeCase(BufferView *, TextCase action);
385 void changeRegionCase(BufferView * bview,
386 LyXCursor const & from,
387 LyXCursor const & to,
388 LyXText::TextCase action);
390 void transposeChars(BufferView &);
392 /** returns a printed row in a pixmap. The y value is needed to
393 decide, wether it is selected text or not. This is a strange
396 void getVisibleRow(BufferView *, int y_offset, int x_offset,
397 Row * row_ptr, int y, bool cleared=false);
400 void toggleInset(BufferView *);
402 void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
404 void copySelection(BufferView *);
406 void pasteSelection(BufferView *);
408 void copyEnvironmentType();
410 void pasteEnvironmentType(BufferView *);
412 /** the DTP switches for paragraphs. LyX will store the top settings
413 always in the first physical paragraph, the bottom settings in the
414 last. When a paragraph is broken, the top settings rest, the bottom
415 settings are given to the new one. So I can make shure, they do not
416 duplicate themself (and you cannnot make dirty things with them! )
418 void setParagraph(BufferView *,
419 bool line_top, bool line_bottom,
420 bool pagebreak_top, bool pagebreak_bottom,
421 VSpace const & space_top,
422 VSpace const & space_bottom,
423 Spacing const & spacing,
425 string labelwidthstring,
428 /* these things are for search and replace */
430 /** sets the selection over the number of characters of string,
433 void setSelectionOverString(BufferView *, string const & str);
435 /** simple replacing. The font of the first selected character
438 void replaceSelectionWithString(BufferView *, string const & str);
440 /// needed to insert the selection
441 void insertStringAsLines(BufferView *, string const & str);
442 /// needed to insert the selection
443 void insertStringAsParagraphs(BufferView *, string const & str);
445 /// Find next inset of some specified type.
446 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
447 string const & contents = string()) const;
450 /* for the greater insets */
452 /// returns false if inset wasn't found
453 bool updateInset(BufferView *, Inset *);
455 void checkParagraph(BufferView *, Paragraph * par,
456 Paragraph::size_type pos);
458 int numberOfCell(Paragraph * par,
459 Paragraph::size_type pos) const;
461 void removeTableRow(LyXCursor & cursor) const;
463 bool isEmptyTableCell() const;
465 void toggleAppendix(BufferView *);
467 int workWidth(BufferView *) const;
469 int workWidth(BufferView *, Inset * inset) const;
471 void computeBidiTables(Buffer const *, Row * row) const;
473 /// Maps positions in the visual string to positions in logical string.
475 Paragraph::size_type log2vis(Paragraph::size_type pos) const {
476 if (bidi_start == -1)
479 return log2vis_list[pos-bidi_start];
482 /// Maps positions in the logical string to positions in visual string.
484 Paragraph::size_type vis2log(Paragraph::size_type pos) const {
485 if (bidi_start == -1)
488 return vis2log_list[pos-bidi_start];
492 Paragraph::size_type bidi_level(Paragraph::size_type pos) const {
493 if (bidi_start == -1)
496 return bidi_levels[pos-bidi_start];
500 bool bidi_InRange(Paragraph::size_type pos) const {
501 return bidi_start == -1 ||
502 (bidi_start <= pos && pos <= bidi_end);
506 mutable Row * firstrow;
508 mutable Row * lastrow;
510 /** Copybuffer for copy environment type.
511 Asger has learned that this should be a buffer-property instead
512 Lgb has learned that 'char' is a lousy type for non-characters
514 LyXTextClass::size_type copylayouttype;
516 /** inserts a new row behind the specified row, increments
517 the touched counters */
518 void insertRow(Row * row, Paragraph * par,
519 Paragraph::size_type pos) const;
520 /** removes the row and reset the touched counters */
521 void removeRow(Row * row) const;
523 /** remove all following rows of the paragraph of the specified row. */
524 void removeParagraph(Row * row) const;
526 /** insert the specified paragraph behind the specified row */
527 void insertParagraph(BufferView *,
528 Paragraph * par, Row * row) const;
530 /** appends the implizit specified paragraph behind the specified row,
531 * start at the implizit given position */
532 void appendParagraph(BufferView *, Row * row) const;
535 void breakAgain(BufferView *, Row * row) const;
537 void breakAgainOneRow(BufferView *, Row * row);
538 /// Calculate and set the height of the row
539 void setHeightOfRow(BufferView *, Row * row_ptr) const;
541 /** this calculates the specified parameters. needed when setting
542 * the cursor and when creating a visible row */
543 void prepareToPrint(BufferView *, Row * row, float & x,
544 float & fill_separator,
546 float & fill_label_hfill,
547 bool bidi = true) const;
549 /// A struct used for drawing routines
550 struct DrawRowParams {
555 // the painter to use
557 // has the background been cleared
567 /// the inset/view full width
573 /// fill separator size
577 /// paint the background
578 bool paintRowBackground(DrawRowParams & p);
580 /// paint the selection background
581 void paintRowSelection(DrawRowParams & p);
583 /// paint appendix marker
584 void paintRowAppendix(DrawRowParams & p);
586 /// paint env depth bar
587 void paintRowDepthBar(DrawRowParams & p);
589 /// paint a first row in a paragraph
590 void paintFirstRow(DrawRowParams & p);
592 /// paint a last row in a paragraph
593 void paintLastRow(DrawRowParams & p);
596 void paintRowText(DrawRowParams & p);
598 // fix the cursor `cur' after a characters has been deleted at `where'
599 // position. Called by deleteEmptyParagraphMechanism
600 void fixCursorAfterDelete(BufferView * bview,
602 LyXCursor const & where) const;
605 void deleteEmptyParagraphMechanism(BufferView *,
606 LyXCursor const & old_cursor) const;
609 /** Updates all counters starting BEHIND the row. Changed paragraphs
610 * with a dynamic left margin will be rebroken. */
611 void updateCounters(BufferView *, Row * row) const;
614 void setCounter(Buffer const *, Paragraph * par) const;
617 * some low level functions
621 int singleWidth(BufferView *, Paragraph * par,
622 Paragraph::size_type pos) const;
624 int singleWidth(BufferView *, Paragraph * par,
625 Paragraph::size_type pos, char c) const;
627 void draw(BufferView *, Row const * row,
628 Paragraph::size_type & pos,
629 int offset, float & x, bool cleared);
631 /// get the next breakpoint in a given paragraph
632 Paragraph::size_type nextBreakPoint(BufferView *, Row const * row,
634 /// returns the minimum space a row needs on the screen in pixel
635 int fill(BufferView *, Row * row, int workwidth) const;
637 /** returns the minimum space a manual label needs on the
639 int labelFill(BufferView *, Row const * row) const;
643 beginningOfMainBody(Buffer const *, Paragraph const * par) const;
645 /** Returns the left beginning of the text.
646 This information cannot be taken from the layouts-objekt, because
647 in LaTeX the beginning of the text fits in some cases
648 (for example sections) exactly the label-width.
650 int leftMargin(BufferView *, Row const * row) const;
652 int rightMargin(Buffer const *, Row const * row) const;
654 int labelEnd (BufferView *, Row const * row) const;
656 /** returns the number of separators in the specified row.
657 The separator on the very last column doesnt count
659 int numberOfSeparators(Buffer const *, Row const * row) const;
661 /** returns the number of hfills in the specified row. The
662 LyX-Hfill is a LaTeX \hfill so that the hfills at the
663 beginning and at the end were ignored. This is {\em MUCH}
664 more usefull than not to ignore!
666 int numberOfHfills(Buffer const *, Row const * row) const;
668 /// like NumberOfHfills, but only those in the manual label!
669 int numberOfLabelHfills(Buffer const *, Row const * row) const;
670 /** returns true, if a expansion is needed. Rules are given by
673 bool hfillExpansion(Buffer const *, Row const * row_ptr,
674 Paragraph::size_type pos) const;
676 LColor::color backgroundColor();
680 mutable std::vector<Paragraph::size_type> log2vis_list;
683 mutable std::vector<Paragraph::size_type> vis2log_list;
686 mutable std::vector<Paragraph::size_type> bidi_levels;
689 mutable Paragraph::size_type bidi_start;
692 mutable Paragraph::size_type bidi_end;
695 mutable bool bidi_same_direction;
698 unsigned char transformChar(unsigned char c, Paragraph * par,
699 Paragraph::size_type pos) const;
701 /** returns the paragraph position of the last character in the
704 Paragraph::size_type rowLast(Row const * row) const;
706 Paragraph::size_type rowLastPrintable(Row const * row) const;
712 // special owner functions
714 Paragraph * ownerParagraph() const;
716 void ownerParagraph(Paragraph *) const;
717 // set it searching first for the right owner using the paragraph id
718 void ownerParagraph(int id, Paragraph *) const;
722 /* returns a pointer to the row near the specified y-coordinate
723 * (relative to the whole text). y is set to the real beginning
726 Row * LyXText::getRowNearY(int & y) const
728 // If possible we should optimize this method. (Lgb)
729 Row * tmprow = firstrow;
732 while (tmprow->next() && tmpy + tmprow->height() <= y) {
733 tmpy += tmprow->height();
734 tmprow = tmprow->next();
737 y = tmpy; // return the real y