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"
24 #include "WordLangTuple.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 *);
76 void init(BufferView *, bool reinit = false);
78 mutable int number_of_rows;
82 mutable unsigned int width;
83 /// the current font settings
84 mutable LyXFont current_font;
86 mutable LyXFont real_current_font;
87 /// first visible pixel-row is set from LyXScreen!!!
88 // unsigned is wrong here for text-insets!
91 BufferView * bv_owner;
93 InsetText * inset_owner;
95 UpdatableInset * the_locking_inset;
98 int getRealCursorX(BufferView *) const;
100 LyXFont const getFont(Buffer const *, Paragraph * par,
101 lyx::pos_type pos) const;
103 LyXFont const getLayoutFont(Buffer const *, Paragraph * par) const;
105 LyXFont const getLabelFont(Buffer const *, Paragraph * par) const;
107 void setCharFont(Buffer const *, Paragraph * par,
108 lyx::pos_type pos, LyXFont const & font);
109 void setCharFont(BufferView *, Paragraph * par,
110 lyx::pos_type pos, LyXFont const & font, bool toggleall);
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 string const & layout);
123 void setLayout(BufferView *, string const & layout);
125 /** increment depth over selection and make a total rebreak of those
128 void incDepth(BufferView *);
130 /** decrement depth over selection and make a total rebreak of those
132 void decDepth(BufferView *);
134 /** Get the depth at current cursor position
136 int getDepth() const;
138 /** set font over selection and make a total rebreak of those
140 toggleall defaults to false.
142 void setFont(BufferView *, LyXFont const &, bool toggleall = false);
144 /** deletes and inserts again all paragaphs between the cursor
145 and the specified par. The Cursor is needed to set the refreshing
147 This function is needed after SetLayout and SetFont etc.
149 void redoParagraphs(BufferView *, LyXCursor const & cursor,
150 Paragraph const * end_par) const;
152 void redoParagraph(BufferView *) const;
155 void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
158 string getStringToIndex(BufferView *);
160 /** recalculates the heights of all previous rows of the
161 specified paragraph. needed, if the last characters font
164 void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
166 /** insert a character, moves all the following breaks in the
167 same Paragraph one to the right and make a little rebreak
169 void insertChar(BufferView *, char c);
171 void insertInset(BufferView *, Inset * inset);
173 /** Completes the insertion with a full rebreak. */
174 void fullRebreak(BufferView *);
177 mutable Row * need_break_row;
179 mutable int refresh_y;
187 mutable Row * refresh_row;
189 lyx::pos_type refresh_pos;
191 /// give and set the LyXText status
192 text_status status() const;
194 void status(BufferView *, text_status) const;
197 /** wether the screen needs a refresh,
198 starting with refresh_y
200 mutable text_status status_;
203 /** returns a pointer to the row near the specified y-coordinate
204 (relative to the whole text). y is set to the real beginning
207 Row * getRowNearY(int & y) const;
209 /** returns the column near the specified x-coordinate of the row
210 x is set to the real beginning of this column
212 lyx::pos_type getColumnNearX(BufferView *, Row * row,
213 int & x, bool & boundary) const;
215 /** returns a pointer to a specified row. y is set to the beginning
218 Row * getRow(Paragraph * par,
219 lyx::pos_type pos, int & y) const;
220 /** returns the firstrow, this could be done with the above too but
221 IMO it's stupid to have to allocate a dummy y all the time I need
224 Row * firstRow() { return firstrow; }
226 /** returns the height of a default row, needed for scrollbar
228 int defaultHeight() const;
231 Later this variable has to be removed. There should be now internal
232 cursor in a text (and thus not in a buffer). By keeping this it is
233 (I think) impossible to have several views with the same buffer, but
234 the cursor placed at different places.
236 Since the LyXText now has been moved from Buffer to BufferView
237 it should not be absolutely needed to move the cursor...
239 mutable LyXCursor cursor; // actual cursor position
241 /** The structure that keeps track of the selections set. */
244 : set_(false), mark_(false)
258 LyXCursor cursor; // temporary cursor to hold a cursor position
259 // until setSelection is called!
260 LyXCursor start; // start of a REAL selection
261 LyXCursor end; // end of a REAL selection
263 bool set_; // former selection
264 bool mark_; // former mark_set
267 mutable Selection selection;
268 // this is used to handle XSelection events in the right manner
269 mutable Selection xsel_cache;
271 /// needed for the toggling (cursor position on last selection made)
272 mutable LyXCursor last_sel_cursor;
273 /// needed for toggling the selection in screen.C
274 mutable LyXCursor toggle_cursor;
275 /// needed for toggling the selection in screen.C
276 mutable LyXCursor toggle_end_cursor;
278 /// need the selection cursor:
279 void setSelection(BufferView *);
281 void clearSelection() const;
283 string const selectionAsString(Buffer const *, bool label) const;
285 /// select the word we need depending on word_location
286 void getWord(LyXCursor & from, LyXCursor & to,
287 word_location const) const;
288 /// just selects the word the cursor is in
289 void selectWord(BufferView *, word_location const);
290 /// returns the inset at cursor (if it exists), 0 otherwise
291 Inset * getInset() const;
293 /** 'selects" the next word, where the cursor is not in
294 and returns this word as string. THe cursor will be moved
295 to the beginning of this word.
296 With SelectSelectedWord can this be highlighted really
298 WordLangTuple selectNextWordToSpellcheck(BufferView *, float & value) const;
300 void selectSelectedWord(BufferView *);
301 /// returns true if par was empty and was removed
302 bool setCursor(BufferView *, Paragraph * par,
305 bool boundary = false) const;
307 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
309 bool boundary = false) const;
311 void setCursorIntern(BufferView *, Paragraph * par,
314 bool boundary = false) const;
316 void setCurrentFont(BufferView *) const;
319 bool isBoundary(Buffer const *, Paragraph * par,
320 lyx::pos_type pos) const;
322 bool isBoundary(Buffer const *, Paragraph * par,
324 LyXFont const & font) const;
327 void setCursorFromCoordinates(BufferView *, int x, int y) const;
329 void setCursorFromCoordinates(BufferView *, LyXCursor &,
332 void cursorUp(BufferView *, bool selecting = false) const;
334 void cursorDown(BufferView *, bool selecting = false) const;
336 void cursorLeft(BufferView *, bool internal = true) const;
338 void cursorRight(BufferView *, bool internal = true) const;
340 void cursorLeftOneWord(BufferView *) const;
342 void cursorLeftOneWord(LyXCursor &) const;
344 void cursorRightOneWord(BufferView *) const;
346 void cursorUpParagraph(BufferView *) const;
348 void cursorDownParagraph(BufferView *) const;
350 void cursorHome(BufferView *) const;
352 void cursorEnd(BufferView *) const;
354 void cursorTab(BufferView *) const;
356 void cursorTop(BufferView *) const;
358 void cursorBottom(BufferView *) const;
360 void Delete(BufferView *);
362 void backspace(BufferView *);
364 void deleteWordForward(BufferView *);
366 void deleteWordBackward(BufferView *);
368 void deleteLineForward(BufferView *);
370 bool selectWordWhenUnderCursor(BufferView *,
371 word_location const);
377 text_capitalization = 1,
381 /// Change the case of the word at cursor position.
382 void changeCase(BufferView *, TextCase action);
384 void transposeChars(BufferView &);
386 /** returns a printed row in a pixmap. The y value is needed to
387 decide, wether it is selected text or not. This is a strange
390 void getVisibleRow(BufferView *, int y_offset, int x_offset,
391 Row * row_ptr, int y, bool cleared=false);
394 void toggleInset(BufferView *);
396 void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
398 void copySelection(BufferView *);
400 void pasteSelection(BufferView *);
402 void copyEnvironmentType();
404 void pasteEnvironmentType(BufferView *);
406 /** the DTP switches for paragraphs. LyX will store the top settings
407 always in the first physical paragraph, the bottom settings in the
408 last. When a paragraph is broken, the top settings rest, the bottom
409 settings are given to the new one. So I can make shure, they do not
410 duplicate themself (and you cannnot make dirty things with them! )
412 void setParagraph(BufferView *,
413 bool line_top, bool line_bottom,
414 bool pagebreak_top, bool pagebreak_bottom,
415 VSpace const & space_top,
416 VSpace const & space_bottom,
417 Spacing const & spacing,
419 string labelwidthstring,
422 /* these things are for search and replace */
424 /** sets the selection over the number of characters of string,
427 void setSelectionOverString(BufferView *, string const & str);
429 /** simple replacing. The font of the first selected character
432 void replaceSelectionWithString(BufferView *, string const & str);
434 /// needed to insert the selection
435 void insertStringAsLines(BufferView *, string const & str);
436 /// needed to insert the selection
437 void insertStringAsParagraphs(BufferView *, string const & str);
439 /// Find next inset of some specified type.
440 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
441 string const & contents = string()) const;
444 /* for the greater insets */
446 /// returns false if inset wasn't found
447 bool updateInset(BufferView *, Inset *);
449 void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
451 void toggleAppendix(BufferView *);
453 int workWidth(BufferView *) const;
455 int workWidth(BufferView *, Inset * inset) const;
457 void computeBidiTables(Buffer const *, Row * row) const;
459 /// Maps positions in the visual string to positions in logical string.
461 lyx::pos_type log2vis(lyx::pos_type pos) const {
462 if (bidi_start == -1)
465 return log2vis_list[pos-bidi_start];
468 /// Maps positions in the logical string to positions in visual string.
470 lyx::pos_type vis2log(lyx::pos_type pos) const {
471 if (bidi_start == -1)
474 return vis2log_list[pos-bidi_start];
478 lyx::pos_type bidi_level(lyx::pos_type pos) const {
479 if (bidi_start == -1)
482 return bidi_levels[pos-bidi_start];
486 bool bidi_InRange(lyx::pos_type pos) const {
487 return bidi_start == -1 ||
488 (bidi_start <= pos && pos <= bidi_end);
492 mutable Row * firstrow;
495 mutable Row * lastrow;
498 float getCursorX(BufferView *, Row *, lyx::pos_type pos,
499 lyx::pos_type last, bool boundary) const;
501 void changeRegionCase(BufferView * bview,
502 LyXCursor const & from,
503 LyXCursor const & to,
504 LyXText::TextCase action);
505 /// used in setlayout
506 void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
508 /** forces the redrawing of a paragraph. Needed when manipulating a
511 void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
513 /** Copybuffer for copy environment type.
514 Asger has learned that this should be a buffer-property instead
515 Lgb has learned that 'char' is a lousy type for non-characters
517 string copylayouttype;
518 /** inserts a new row behind the specified row, increments
519 the touched counters */
520 void insertRow(Row * row, Paragraph * par, lyx::pos_type pos) const;
521 /** removes the row and reset the touched counters */
522 void removeRow(Row * row) const;
524 /** remove all following rows of the paragraph of the specified row. */
525 void removeParagraph(Row * row) const;
527 /** insert the specified paragraph behind the specified row */
528 void insertParagraph(BufferView *,
529 Paragraph * par, Row * row) const;
531 /** appends the implizit specified paragraph behind the specified row,
532 * start at the implizit given position */
533 void appendParagraph(BufferView *, Row * row) const;
536 void breakAgain(BufferView *, Row * row) const;
538 void breakAgainOneRow(BufferView *, Row * row);
539 /// Calculate and set the height of the row
540 void setHeightOfRow(BufferView *, Row * row_ptr) const;
542 /** this calculates the specified parameters. needed when setting
543 * the cursor and when creating a visible row */
544 void prepareToPrint(BufferView *, Row * row, float & x,
545 float & fill_separator,
547 float & fill_label_hfill,
548 bool bidi = true) const;
550 /// A struct used for drawing routines
551 struct DrawRowParams {
556 // the painter to use
558 // has the background been cleared
560 /// x offset (e.g. for insets)
562 /// y offset (e.g. for insets)
568 /// the inset/view full width
574 /// fill separator size
578 /// paint the background
579 bool paintRowBackground(DrawRowParams & p);
581 /// paint the selection background
582 void paintRowSelection(DrawRowParams & p);
584 /// paint appendix marker
585 void paintRowAppendix(DrawRowParams & p);
587 /// paint page break marker. Returns its height.
588 int paintPageBreak(string const & label, int y, DrawRowParams & p);
590 /// paint env depth bar
591 void paintRowDepthBar(DrawRowParams & p);
593 /// get the on-screen size of the length marker
594 int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
596 /// paint an added space marker
597 int drawLengthMarker(DrawRowParams & p, string const & str,
598 VSpace const & vsp, int start);
600 /// paint a first row in a paragraph
601 void paintFirstRow(DrawRowParams & p);
603 /// paint a last row in a paragraph
604 void paintLastRow(DrawRowParams & p);
607 void paintRowText(DrawRowParams & p);
609 // fix the cursor `cur' after a characters has been deleted at `where'
610 // position. Called by deleteEmptyParagraphMechanism
611 void fixCursorAfterDelete(BufferView * bview,
613 LyXCursor const & where) const;
615 /// delete double space (false) or empty paragraphs (true) around old_cursor
616 bool deleteEmptyParagraphMechanism(BufferView *,
617 LyXCursor const & old_cursor) const;
620 /** Updates all counters starting BEHIND the row. Changed paragraphs
621 * with a dynamic left margin will be rebroken. */
622 void updateCounters(BufferView *, Row * row) const;
625 void setCounter(Buffer const *, Paragraph * par) const;
628 * some low level functions
632 int singleWidth(BufferView *, Paragraph * par,
633 lyx::pos_type pos) const;
635 int singleWidth(BufferView *, Paragraph * par,
636 lyx::pos_type pos, char c) const;
639 /// draw normal chars
640 void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
641 bool hebrew, bool arabic);
642 /// draw from arabic composed char
643 void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
644 /// draw from hebrew composed char
645 void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
646 /// draw a mark for foreign language, starting from orig_x
647 void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
649 bool drawInset(DrawRowParams & p, lyx::pos_type const pos);
650 /// draw new line marker
651 void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
653 bool draw(DrawRowParams & p, lyx::pos_type & vpos);
655 /// get the next breakpoint in a given paragraph
656 lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
657 /// returns the minimum space a row needs on the screen in pixel
658 int fill(BufferView *, Row * row, int workwidth) const;
660 /** returns the minimum space a manual label needs on the
662 int labelFill(BufferView *, Row const * row) const;
665 lyx::pos_type beginningOfMainBody(Buffer const *, Paragraph const * par) const;
668 * Returns the left beginning of the text.
669 * This information cannot be taken from the layout object, because
670 * in LaTeX the beginning of the text fits in some cases
671 * (for example sections) exactly the label-width.
673 int leftMargin(BufferView *, Row const * row) const;
675 int rightMargin(Buffer const *, Row const * row) const;
677 int labelEnd (BufferView *, Row const * row) const;
679 /** returns the number of separators in the specified row.
680 The separator on the very last column doesnt count
682 int numberOfSeparators(Buffer const *, Row const * row) const;
684 /** returns the number of hfills in the specified row. The
685 LyX-Hfill is a LaTeX \hfill so that the hfills at the
686 beginning and at the end were ignored. This is {\em MUCH}
687 more usefull than not to ignore!
689 int numberOfHfills(Buffer const *, Row const * row) const;
691 /// like NumberOfHfills, but only those in the manual label!
692 int numberOfLabelHfills(Buffer const *, Row const * row) const;
693 /** returns true, if a expansion is needed. Rules are given by
696 bool hfillExpansion(Buffer const *, Row const * row_ptr,
697 lyx::pos_type pos) const;
699 LColor::color backgroundColor();
703 mutable std::vector<lyx::pos_type> log2vis_list;
706 mutable std::vector<lyx::pos_type> vis2log_list;
709 mutable std::vector<lyx::pos_type> bidi_levels;
712 mutable lyx::pos_type bidi_start;
715 mutable lyx::pos_type bidi_end;
718 mutable bool bidi_same_direction;
721 unsigned char transformChar(unsigned char c, Paragraph * par,
722 lyx::pos_type pos) const;
724 /** returns the paragraph position of the last character in the
727 lyx::pos_type rowLast(Row const * row) const;
729 lyx::pos_type rowLastPrintable(Row const * row) const;
735 // special owner functions
737 Paragraph * ownerParagraph() const;
739 void ownerParagraph(Paragraph *) const;
740 // set it searching first for the right owner using the paragraph id
741 void ownerParagraph(int id, Paragraph *) const;