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"
23 #include "insets/inset.h"
38 This class holds the mapping between buffer paragraphs and screen rows.
49 NEED_VERY_LITTLE_REFRESH = 2,
55 // the word around the cursor, only if the cursor is
58 // the word around the cursor
60 /// the word begining from the cursor position
62 /// the word around the cursor or before the cursor
64 /// the next word (not yet used)
69 LyXText(BufferView *);
70 /// sets inset as owner
76 void init(BufferView *, bool reinit = false);
80 mutable unsigned int width;
81 /// the current font settings
82 mutable LyXFont current_font;
84 mutable LyXFont real_current_font;
85 /// first visible pixel-row is set from LyXScreen!!!
86 // unsigned is wrong here for text-insets!
89 BufferView * bv_owner;
91 InsetText * inset_owner;
93 UpdatableInset * the_locking_inset;
96 int getRealCursorX(BufferView *) const;
98 LyXFont const getFont(Buffer const *, Paragraph * par,
99 lyx::pos_type pos) const;
101 LyXFont const getLayoutFont(Buffer const *, Paragraph * par) const;
103 LyXFont const getLabelFont(Buffer const *, Paragraph * par) const;
105 void setCharFont(Buffer const *, Paragraph * par,
106 lyx::pos_type pos, LyXFont const & font);
107 void setCharFont(BufferView *, Paragraph * par,
108 lyx::pos_type pos, LyXFont const & font, bool toggleall);
110 /// what you expect when pressing <enter> at cursor position
111 void breakParagraph(BufferView *, char keep_layout = 0);
113 /** set layout over selection and make a total rebreak of
116 Paragraph * setLayout(BufferView *, LyXCursor & actual_cursor,
117 LyXCursor & selection_start,
118 LyXCursor & selection_end,
119 string const & layout);
121 void setLayout(BufferView *, string const & layout);
123 /** increment depth over selection and make a total rebreak of those
126 void incDepth(BufferView *);
128 /** decrement depth over selection and make a total rebreak of those
130 void decDepth(BufferView *);
132 /// get the depth at current cursor position
133 int getDepth() const;
135 /** set font over selection and make a total rebreak of those
137 toggleall defaults to false.
139 void setFont(BufferView *, LyXFont const &, bool toggleall = false);
141 /** deletes and inserts again all paragaphs between the cursor
142 and the specified par. The Cursor is needed to set the refreshing
144 This function is needed after SetLayout and SetFont etc.
146 void redoParagraphs(BufferView *, LyXCursor const & cursor,
147 Paragraph const * end_par) const;
149 void redoParagraph(BufferView *) const;
152 void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
155 string getStringToIndex(BufferView *);
157 /** recalculates the heights of all previous rows of the
158 specified paragraph. needed, if the last characters font
161 void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
163 /** insert a character, moves all the following breaks in the
164 same Paragraph one to the right and make a little rebreak
166 void insertChar(BufferView *, char c);
168 void insertInset(BufferView *, Inset * inset);
170 /// Completes the insertion with a full rebreak
171 void fullRebreak(BufferView *);
174 mutable Row * need_break_row;
176 mutable int refresh_y;
178 mutable Row * refresh_row;
180 /// give and set the LyXText status
181 text_status status() const;
183 void status(BufferView *, text_status) const;
186 Inset::RESULT dispatch(FuncRequest const & cmd);
189 /** wether the screen needs a refresh,
190 starting with refresh_y
192 mutable text_status status_;
195 /** returns a pointer to the row near the specified y-coordinate
196 (relative to the whole text). y is set to the real beginning
199 Row * getRowNearY(int & y) const;
201 /** returns the column near the specified x-coordinate of the row
202 x is set to the real beginning of this column
204 lyx::pos_type getColumnNearX(BufferView *, Row * row,
205 int & x, bool & boundary) const;
207 /** returns a pointer to a specified row. y is set to the beginning
210 Row * getRow(Paragraph * par, lyx::pos_type pos, int & y) const;
211 /** returns the firstrow, this could be done with the above too but
212 IMO it's stupid to have to allocate a dummy y all the time I need
215 Row * firstRow() { return firstrow; }
217 /** returns the height of a default row, needed for scrollbar
219 int defaultHeight() const;
222 Later this variable has to be removed. There should be now internal
223 cursor in a text (and thus not in a buffer). By keeping this it is
224 (I think) impossible to have several views with the same buffer, but
225 the cursor placed at different places.
227 Since the LyXText now has been moved from Buffer to BufferView
228 it should not be absolutely needed to move the cursor...
230 mutable LyXCursor cursor; // actual cursor position
232 /** The structure that keeps track of the selections set. */
235 : set_(false), mark_(false)
249 LyXCursor cursor; // temporary cursor to hold a cursor position
250 // until setSelection is called!
251 LyXCursor start; // start of a REAL selection
252 LyXCursor end; // end of a REAL selection
254 bool set_; // former selection
255 bool mark_; // former mark_set
258 mutable Selection selection;
259 // this is used to handle XSelection events in the right manner
260 mutable Selection xsel_cache;
262 /// needed for the toggling (cursor position on last selection made)
263 mutable LyXCursor last_sel_cursor;
264 /// needed for toggling the selection in screen.C
265 mutable LyXCursor toggle_cursor;
266 /// needed for toggling the selection in screen.C
267 mutable LyXCursor toggle_end_cursor;
269 /// need the selection cursor:
270 void setSelection(BufferView *);
272 void clearSelection() const;
274 string const selectionAsString(Buffer const *, bool label) const;
276 /// select the word we need depending on word_location
277 void getWord(LyXCursor & from, LyXCursor & to,
278 word_location const) const;
279 /// just selects the word the cursor is in
280 void selectWord(BufferView *, word_location const);
281 /// returns the inset at cursor (if it exists), 0 otherwise
282 Inset * getInset() const;
284 /** 'selects" the next word, where the cursor is not in
285 and returns this word as string. THe cursor will be moved
286 to the beginning of this word.
287 With SelectSelectedWord can this be highlighted really
289 WordLangTuple const selectNextWordToSpellcheck(BufferView *, float & value) const;
291 void selectSelectedWord(BufferView *);
292 /// returns true if par was empty and was removed
293 bool setCursor(BufferView *, Paragraph * par,
296 bool boundary = false) const;
298 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
300 bool boundary = false) const;
302 void setCursorIntern(BufferView *, Paragraph * par,
305 bool boundary = false) const;
307 void setCurrentFont(BufferView *) const;
310 bool isBoundary(Buffer const *, Paragraph * par,
311 lyx::pos_type pos) const;
313 bool isBoundary(Buffer const *, Paragraph * par,
315 LyXFont const & font) const;
318 void setCursorFromCoordinates(BufferView *, int x, int y) const;
320 void setCursorFromCoordinates(BufferView *, LyXCursor &,
323 void cursorUp(BufferView *, bool selecting = false) const;
325 void cursorDown(BufferView *, bool selecting = false) const;
327 void cursorLeft(BufferView *, bool internal = true) const;
329 void cursorRight(BufferView *, bool internal = true) const;
331 void cursorLeftOneWord(BufferView *) const;
333 void cursorRightOneWord(BufferView *) const;
335 void cursorUpParagraph(BufferView *) const;
337 void cursorDownParagraph(BufferView *) const;
339 void cursorHome(BufferView *) const;
341 void cursorEnd(BufferView *) const;
343 void cursorPrevious(BufferView * bv);
345 void cursorNext(BufferView * bv);
347 void cursorTab(BufferView *) const;
349 void cursorTop(BufferView *) const;
351 void cursorBottom(BufferView *) const;
353 void Delete(BufferView *);
355 void backspace(BufferView *);
357 bool selectWordWhenUnderCursor(BufferView *,
358 word_location const);
364 text_capitalization = 1,
368 /// Change the case of the word at cursor position.
369 void changeCase(BufferView *, TextCase action);
371 void transposeChars(BufferView &);
373 /** returns a printed row in a pixmap. The y value is needed to
374 decide, wether it is selected text or not. This is a strange
377 void getVisibleRow(BufferView *, int y_offset, int x_offset,
378 Row * row_ptr, int y, bool cleared=false);
381 void toggleInset(BufferView *);
383 void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
385 void copySelection(BufferView *);
387 void pasteSelection(BufferView *);
389 void copyEnvironmentType();
391 void pasteEnvironmentType(BufferView *);
393 /** the DTP switches for paragraphs. LyX will store the top settings
394 always in the first physical paragraph, the bottom settings in the
395 last. When a paragraph is broken, the top settings rest, the bottom
396 settings are given to the new one. So I can make shure, they do not
397 duplicate themself (and you cannnot make dirty things with them! )
399 void setParagraph(BufferView *,
400 bool line_top, bool line_bottom,
401 bool pagebreak_top, bool pagebreak_bottom,
402 VSpace const & space_top,
403 VSpace const & space_bottom,
404 Spacing const & spacing,
406 string labelwidthstring,
409 /* these things are for search and replace */
411 /** sets the selection over the number of characters of string,
414 void setSelectionOverString(BufferView *, string const & str);
416 /** simple replacing. The font of the first selected character
419 void replaceSelectionWithString(BufferView *, string const & str);
421 /// needed to insert the selection
422 void insertStringAsLines(BufferView *, string const & str);
423 /// needed to insert the selection
424 void insertStringAsParagraphs(BufferView *, string const & str);
426 /// Find next inset of some specified type.
427 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
428 string const & contents = string()) const;
430 void gotoInset(BufferView * bv, std::vector<Inset::Code> const & codes,
433 void gotoInset(BufferView * bv, Inset::Code code, bool same_content);
436 /* for the greater insets */
438 /// returns false if inset wasn't found
439 bool updateInset(BufferView *, Inset *);
441 void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
443 int workWidth(BufferView *) const;
445 int workWidth(BufferView *, Inset * inset) const;
447 void computeBidiTables(Buffer const *, Row * row) const;
449 /// Maps positions in the visual string to positions in logical string.
451 lyx::pos_type log2vis(lyx::pos_type pos) const {
452 if (bidi_start == -1)
455 return log2vis_list[pos-bidi_start];
458 /// Maps positions in the logical string to positions in visual string.
460 lyx::pos_type vis2log(lyx::pos_type pos) const {
461 if (bidi_start == -1)
464 return vis2log_list[pos-bidi_start];
468 lyx::pos_type bidi_level(lyx::pos_type pos) const {
469 if (bidi_start == -1)
472 return bidi_levels[pos-bidi_start];
476 bool bidi_InRange(lyx::pos_type pos) const {
477 return bidi_start == -1 ||
478 (bidi_start <= pos && pos <= bidi_end);
482 mutable Row * firstrow;
484 mutable Row * lastrow;
487 void cursorLeftOneWord(LyXCursor &) const;
490 float getCursorX(BufferView *, Row *, lyx::pos_type pos,
491 lyx::pos_type last, bool boundary) const;
493 void changeRegionCase(BufferView * bv,
494 LyXCursor const & from,
495 LyXCursor const & to,
496 LyXText::TextCase action);
497 /// used in setlayout
498 void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
500 /** forces the redrawing of a paragraph. Needed when manipulating a
503 void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
505 /** Copybuffer for copy environment type.
506 Asger has learned that this should be a buffer-property instead
507 Lgb has learned that 'char' is a lousy type for non-characters
509 string copylayouttype;
511 /** inserts a new row behind the specified row, increments
512 the touched counters */
513 void insertRow(Row * row, Paragraph * par, lyx::pos_type pos) const;
514 /// removes the row and reset the touched counters
515 void removeRow(Row * row) const;
517 /// remove all following rows of the paragraph of the specified row.
518 void removeParagraph(Row * row) const;
520 /// insert the specified paragraph behind the specified row
521 void insertParagraph(BufferView *,
522 Paragraph * par, Row * row) const;
524 /** appends the implizit specified paragraph behind the specified row,
525 * start at the implizit given position */
526 void appendParagraph(BufferView *, Row * row) const;
529 void breakAgain(BufferView *, Row * row) const;
531 void breakAgainOneRow(BufferView *, Row * row);
532 /// Calculate and set the height of the row
533 void setHeightOfRow(BufferView *, Row * row_ptr) const;
535 /** this calculates the specified parameters. needed when setting
536 * the cursor and when creating a visible row */
537 void prepareToPrint(BufferView *, Row * row, float & x,
538 float & fill_separator,
540 float & fill_label_hfill,
541 bool bidi = true) const;
543 /// A struct used for drawing routines
544 struct DrawRowParams {
549 // the painter to use
551 // has the background been cleared
553 /// x offset (e.g. for insets)
555 /// y offset (e.g. for insets)
561 /// the inset/view full width
567 /// fill separator size
571 /// paint the background
572 bool paintRowBackground(DrawRowParams & p);
574 /// paint the selection background
575 void paintRowSelection(DrawRowParams & p);
577 /// paint appendix marker
578 void paintRowAppendix(DrawRowParams & p);
580 /// paint page break marker. Returns its height.
581 int paintPageBreak(string const & label, int y, DrawRowParams & p);
583 /// paint env depth bar
584 void paintRowDepthBar(DrawRowParams & p);
586 /// get the on-screen size of the length marker
587 int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
589 /// paint an added space marker
590 int drawLengthMarker(DrawRowParams & p, string const & str,
591 VSpace const & vsp, int start);
593 /// paint a first row in a paragraph
594 void paintFirstRow(DrawRowParams & p);
596 /// paint a last row in a paragraph
597 void paintLastRow(DrawRowParams & p);
600 void paintRowText(DrawRowParams & p);
602 // fix the cursor `cur' after a characters has been deleted at `where'
603 // position. Called by deleteEmptyParagraphMechanism
604 void fixCursorAfterDelete(BufferView * bv,
606 LyXCursor const & where) const;
608 /// delete double space (false) or empty paragraphs (true) around old_cursor
609 bool deleteEmptyParagraphMechanism(BufferView *,
610 LyXCursor const & old_cursor) const;
613 /** Updates all counters starting BEHIND the row. Changed paragraphs
614 * with a dynamic left margin will be rebroken. */
615 void updateCounters(BufferView *) const;
617 void update(BufferView * bv, bool changed = true);
619 * Returns an inset if inset was hit, or 0 if not.
620 * If hit, the coordinates are changed relative to the inset.
622 Inset * checkInsetHit(BufferView * bv, int & x, int & y) const;
626 void setCounter(Buffer const *, Paragraph * par) const;
628 void deleteWordForward(BufferView *);
630 void deleteWordBackward(BufferView *);
632 void deleteLineForward(BufferView *);
635 * some low level functions
639 int singleWidth(BufferView *, Paragraph * par,
640 lyx::pos_type pos) const;
642 int singleWidth(BufferView *, Paragraph * par,
643 lyx::pos_type pos, char c) const;
646 /// draw normal chars
647 void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
648 bool hebrew, bool arabic);
649 /// draw from arabic composed char
650 void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
651 /// draw from hebrew composed char
652 void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
653 /// draw a mark for foreign language, starting from orig_x
654 void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
656 bool drawInset(DrawRowParams & p, lyx::pos_type const pos);
657 /// draw new line marker
658 void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
660 bool draw(DrawRowParams & p, lyx::pos_type & vpos);
662 /// get the next breakpoint in a given paragraph
663 lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
664 /// returns the minimum space a row needs on the screen in pixel
665 int fill(BufferView *, Row * row, int workwidth) const;
667 /** returns the minimum space a manual label needs on the
669 int labelFill(BufferView *, Row const * row) const;
672 lyx::pos_type beginningOfMainBody(Buffer const *, Paragraph const * par) const;
675 * Returns the left beginning of the text.
676 * This information cannot be taken from the layout object, because
677 * in LaTeX the beginning of the text fits in some cases
678 * (for example sections) exactly the label-width.
680 int leftMargin(BufferView *, Row const * row) const;
682 int rightMargin(Buffer const *, Row const * row) const;
684 int labelEnd (BufferView *, Row const * row) const;
686 /** returns the number of separators in the specified row.
687 The separator on the very last column doesnt count
689 int numberOfSeparators(Buffer const *, Row const * row) const;
691 /** returns the number of hfills in the specified row. The
692 LyX-Hfill is a LaTeX \hfill so that the hfills at the
693 beginning and at the end were ignored. This is {\em MUCH}
694 more usefull than not to ignore!
696 int numberOfHfills(Buffer const *, Row const * row) const;
698 /// like NumberOfHfills, but only those in the manual label!
699 int numberOfLabelHfills(Buffer const *, Row const * row) const;
700 /** returns true, if a expansion is needed. Rules are given by
703 bool hfillExpansion(Buffer const *, Row const * row_ptr,
704 lyx::pos_type pos) const;
706 LColor::color backgroundColor();
710 mutable std::vector<lyx::pos_type> log2vis_list;
713 mutable std::vector<lyx::pos_type> vis2log_list;
716 mutable std::vector<lyx::pos_type> bidi_levels;
719 mutable lyx::pos_type bidi_start;
722 mutable lyx::pos_type bidi_end;
725 mutable bool bidi_same_direction;
728 unsigned char transformChar(unsigned char c, Paragraph * par,
729 lyx::pos_type pos) const;
731 /** returns the paragraph position of the last character in the
734 lyx::pos_type rowLast(Row const * row) const;
736 lyx::pos_type rowLastPrintable(Row const * row) const;
742 // special owner functions
744 Paragraph * ownerParagraph() const;
746 void ownerParagraph(Paragraph *) const;
747 // set it searching first for the right owner using the paragraph id
748 void ownerParagraph(int id, Paragraph *) const;