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 /// used in setlayout
126 void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
128 /** increment depth over selection and make a total rebreak of those
131 void incDepth(BufferView *);
133 /** decrement depth over selection and make a total rebreak of those
135 void decDepth(BufferView *);
137 /** Get the depth at current cursor position
139 int getDepth() const;
141 /** set font over selection and make a total rebreak of those
143 toggleall defaults to false.
145 void setFont(BufferView *, LyXFont const &, bool toggleall = false);
147 /** deletes and inserts again all paragaphs between the cursor
148 and the specified par. The Cursor is needed to set the refreshing
150 This function is needed after SetLayout and SetFont etc.
152 void redoParagraphs(BufferView *, LyXCursor const & cursor,
153 Paragraph const * end_par) const;
155 void redoParagraph(BufferView *) const;
158 void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
161 string getStringToIndex(BufferView *);
163 /** recalculates the heights of all previous rows of the
164 specified paragraph. needed, if the last characters font
167 void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
169 /** forces the redrawing of a paragraph. Needed when manipulating a
172 void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
174 /** insert a character, moves all the following breaks in the
175 same Paragraph one to the right and make a little rebreak
177 void insertChar(BufferView *, char c);
179 void insertInset(BufferView *, Inset * inset);
181 /** Completes the insertion with a full rebreak. */
182 void fullRebreak(BufferView *);
185 mutable Row * need_break_row;
187 mutable int refresh_y;
195 mutable Row * refresh_row;
197 lyx::pos_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 lyx::pos_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 lyx::pos_type pos, int & y) const;
228 /** returns the firstrow, this could be done with the above too but
229 IMO it's stupid to have to allocate a dummy y all the time I need
232 Row * firstRow() { return firstrow; }
234 /** returns the height of a default row, needed for scrollbar
236 int defaultHeight() const;
239 Later this variable has to be removed. There should be now internal
240 cursor in a text (and thus not in a buffer). By keeping this it is
241 (I think) impossible to have several views with the same buffer, but
242 the cursor placed at different places.
244 Since the LyXText now has been moved from Buffer to BufferView
245 it should not be absolutely needed to move the cursor...
247 mutable LyXCursor cursor; // actual cursor position
249 /** The structure that keeps track of the selections set. */
252 : set_(false), mark_(false)
266 LyXCursor cursor; // temporary cursor to hold a cursor position
267 // until setSelection is called!
268 LyXCursor start; // start of a REAL selection
269 LyXCursor end; // end of a REAL selection
271 bool set_; // former selection
272 bool mark_; // former mark_set
275 mutable Selection selection;
276 // this is used to handle XSelection events in the right manner
277 mutable Selection xsel_cache;
279 /// needed for the toggling (cursor position on last selection made)
280 mutable LyXCursor last_sel_cursor;
281 /// needed for toggling the selection in screen.C
282 mutable LyXCursor toggle_cursor;
283 /// needed for toggling the selection in screen.C
284 mutable LyXCursor toggle_end_cursor;
286 /// need the selection cursor:
287 void setSelection(BufferView *);
289 void clearSelection() const;
291 string const selectionAsString(Buffer const *, bool label) const;
293 /// select the word we need depending on word_location
294 void getWord(LyXCursor & from, LyXCursor & to,
295 word_location const) const;
296 /// just selects the word the cursor is in
297 void selectWord(BufferView *, word_location const);
298 /// returns the inset at cursor (if it exists), 0 otherwise
299 Inset * getInset() const;
301 /** 'selects" the next word, where the cursor is not in
302 and returns this word as string. THe cursor will be moved
303 to the beginning of this word.
304 With SelectSelectedWord can this be highlighted really
306 WordLangTuple selectNextWordToSpellcheck(BufferView *, float & value) const;
308 void selectSelectedWord(BufferView *);
309 /// returns true if par was empty and was removed
310 bool setCursor(BufferView *, Paragraph * par,
313 bool boundary = false) const;
315 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
317 bool boundary = false) const;
319 void setCursorIntern(BufferView *, Paragraph * par,
322 bool boundary = false) const;
324 float getCursorX(BufferView *, Row *, lyx::pos_type pos,
325 lyx::pos_type last, bool boundary) const;
327 void setCurrentFont(BufferView *) const;
330 bool isBoundary(Buffer const *, Paragraph * par,
331 lyx::pos_type pos) const;
333 bool isBoundary(Buffer const *, Paragraph * par,
335 LyXFont const & font) const;
338 void setCursorFromCoordinates(BufferView *, int x, int y) const;
340 void setCursorFromCoordinates(BufferView *, LyXCursor &,
343 void cursorUp(BufferView *, bool selecting = false) const;
345 void cursorDown(BufferView *, bool selecting = false) const;
347 void cursorLeft(BufferView *, bool internal = true) const;
349 void cursorRight(BufferView *, bool internal = true) const;
351 void cursorLeftOneWord(BufferView *) const;
353 void cursorLeftOneWord(LyXCursor &) const;
355 void cursorRightOneWord(BufferView *) const;
357 void cursorUpParagraph(BufferView *) const;
359 void cursorDownParagraph(BufferView *) const;
361 void cursorHome(BufferView *) const;
363 void cursorEnd(BufferView *) const;
365 void cursorTab(BufferView *) const;
367 void cursorTop(BufferView *) const;
369 void cursorBottom(BufferView *) const;
371 void Delete(BufferView *);
373 void backspace(BufferView *);
375 void deleteWordForward(BufferView *);
377 void deleteWordBackward(BufferView *);
379 void deleteLineForward(BufferView *);
381 bool selectWordWhenUnderCursor(BufferView *,
382 word_location const);
388 text_capitalization = 1,
392 /// Change the case of the word at cursor position.
393 void changeCase(BufferView *, TextCase action);
395 void changeRegionCase(BufferView * bview,
396 LyXCursor const & from,
397 LyXCursor const & to,
398 LyXText::TextCase action);
400 void transposeChars(BufferView &);
402 /** returns a printed row in a pixmap. The y value is needed to
403 decide, wether it is selected text or not. This is a strange
406 void getVisibleRow(BufferView *, int y_offset, int x_offset,
407 Row * row_ptr, int y, bool cleared=false);
410 void toggleInset(BufferView *);
412 void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
414 void copySelection(BufferView *);
416 void pasteSelection(BufferView *);
418 void copyEnvironmentType();
420 void pasteEnvironmentType(BufferView *);
422 /** the DTP switches for paragraphs. LyX will store the top settings
423 always in the first physical paragraph, the bottom settings in the
424 last. When a paragraph is broken, the top settings rest, the bottom
425 settings are given to the new one. So I can make shure, they do not
426 duplicate themself (and you cannnot make dirty things with them! )
428 void setParagraph(BufferView *,
429 bool line_top, bool line_bottom,
430 bool pagebreak_top, bool pagebreak_bottom,
431 VSpace const & space_top,
432 VSpace const & space_bottom,
433 Spacing const & spacing,
435 string labelwidthstring,
438 /* these things are for search and replace */
440 /** sets the selection over the number of characters of string,
443 void setSelectionOverString(BufferView *, string const & str);
445 /** simple replacing. The font of the first selected character
448 void replaceSelectionWithString(BufferView *, string const & str);
450 /// needed to insert the selection
451 void insertStringAsLines(BufferView *, string const & str);
452 /// needed to insert the selection
453 void insertStringAsParagraphs(BufferView *, string const & str);
455 /// Find next inset of some specified type.
456 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
457 string const & contents = string()) const;
460 /* for the greater insets */
462 /// returns false if inset wasn't found
463 bool updateInset(BufferView *, Inset *);
465 void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
467 int numberOfCell(Paragraph * par, lyx::pos_type pos) const;
469 void removeTableRow(LyXCursor & cursor) const;
471 bool isEmptyTableCell() const;
473 void toggleAppendix(BufferView *);
475 int workWidth(BufferView *) const;
477 int workWidth(BufferView *, Inset * inset) const;
479 void computeBidiTables(Buffer const *, Row * row) const;
481 /// Maps positions in the visual string to positions in logical string.
483 lyx::pos_type log2vis(lyx::pos_type pos) const {
484 if (bidi_start == -1)
487 return log2vis_list[pos-bidi_start];
490 /// Maps positions in the logical string to positions in visual string.
492 lyx::pos_type vis2log(lyx::pos_type pos) const {
493 if (bidi_start == -1)
496 return vis2log_list[pos-bidi_start];
500 lyx::pos_type bidi_level(lyx::pos_type pos) const {
501 if (bidi_start == -1)
504 return bidi_levels[pos-bidi_start];
508 bool bidi_InRange(lyx::pos_type pos) const {
509 return bidi_start == -1 ||
510 (bidi_start <= pos && pos <= bidi_end);
514 mutable Row * firstrow;
517 mutable Row * lastrow;
519 /** Copybuffer for copy environment type.
520 Asger has learned that this should be a buffer-property instead
521 Lgb has learned that 'char' is a lousy type for non-characters
523 string copylayouttype;
524 /** inserts a new row behind the specified row, increments
525 the touched counters */
526 void insertRow(Row * row, Paragraph * par, lyx::pos_type pos) const;
527 /** removes the row and reset the touched counters */
528 void removeRow(Row * row) const;
530 /** remove all following rows of the paragraph of the specified row. */
531 void removeParagraph(Row * row) const;
533 /** insert the specified paragraph behind the specified row */
534 void insertParagraph(BufferView *,
535 Paragraph * par, Row * row) const;
537 /** appends the implizit specified paragraph behind the specified row,
538 * start at the implizit given position */
539 void appendParagraph(BufferView *, Row * row) const;
542 void breakAgain(BufferView *, Row * row) const;
544 void breakAgainOneRow(BufferView *, Row * row);
545 /// Calculate and set the height of the row
546 void setHeightOfRow(BufferView *, Row * row_ptr) const;
548 /** this calculates the specified parameters. needed when setting
549 * the cursor and when creating a visible row */
550 void prepareToPrint(BufferView *, Row * row, float & x,
551 float & fill_separator,
553 float & fill_label_hfill,
554 bool bidi = true) const;
556 /// A struct used for drawing routines
557 struct DrawRowParams {
562 // the painter to use
564 // has the background been cleared
566 /// x offset (e.g. for insets)
568 /// y offset (e.g. for insets)
574 /// the inset/view full width
580 /// fill separator size
584 /// paint the background
585 bool paintRowBackground(DrawRowParams & p);
587 /// paint the selection background
588 void paintRowSelection(DrawRowParams & p);
590 /// paint appendix marker
591 void paintRowAppendix(DrawRowParams & p);
593 /// paint page break marker. Returns its height.
594 int paintPageBreak(string const & label, int y, DrawRowParams & p);
596 /// paint env depth bar
597 void paintRowDepthBar(DrawRowParams & p);
599 /// get the on-screen size of the length marker
600 int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
602 /// paint an added space marker
603 int drawLengthMarker(DrawRowParams & p, string const & str,
604 VSpace const & vsp, int start);
606 /// paint a first row in a paragraph
607 void paintFirstRow(DrawRowParams & p);
609 /// paint a last row in a paragraph
610 void paintLastRow(DrawRowParams & p);
613 void paintRowText(DrawRowParams & p);
615 // fix the cursor `cur' after a characters has been deleted at `where'
616 // position. Called by deleteEmptyParagraphMechanism
617 void fixCursorAfterDelete(BufferView * bview,
619 LyXCursor const & where) const;
621 /// delete double space (false) or empty paragraphs (true) around old_cursor
622 bool deleteEmptyParagraphMechanism(BufferView *,
623 LyXCursor const & old_cursor) const;
626 /** Updates all counters starting BEHIND the row. Changed paragraphs
627 * with a dynamic left margin will be rebroken. */
628 void updateCounters(BufferView *, Row * row) const;
631 void setCounter(Buffer const *, Paragraph * par) const;
634 * some low level functions
638 int singleWidth(BufferView *, Paragraph * par,
639 lyx::pos_type pos) const;
641 int singleWidth(BufferView *, Paragraph * par,
642 lyx::pos_type pos, char c) const;
645 /// draw normal chars
646 void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
647 bool hebrew, bool arabic);
648 /// draw from arabic composed char
649 void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
650 /// draw from hebrew composed char
651 void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
652 /// draw a mark for foreign language, starting from orig_x
653 void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
655 bool drawInset(DrawRowParams & p, lyx::pos_type const pos);
656 /// draw new line marker
657 void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
659 bool draw(DrawRowParams & p, lyx::pos_type & vpos);
661 /// get the next breakpoint in a given paragraph
662 lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
663 /// returns the minimum space a row needs on the screen in pixel
664 int fill(BufferView *, Row * row, int workwidth) const;
666 /** returns the minimum space a manual label needs on the
668 int labelFill(BufferView *, Row const * row) const;
671 lyx::pos_type beginningOfMainBody(Buffer const *, Paragraph const * par) const;
674 * Returns the left beginning of the text.
675 * This information cannot be taken from the layout object, because
676 * in LaTeX the beginning of the text fits in some cases
677 * (for example sections) exactly the label-width.
679 int leftMargin(BufferView *, Row const * row) const;
681 int rightMargin(Buffer const *, Row const * row) const;
683 int labelEnd (BufferView *, Row const * row) const;
685 /** returns the number of separators in the specified row.
686 The separator on the very last column doesnt count
688 int numberOfSeparators(Buffer const *, Row const * row) const;
690 /** returns the number of hfills in the specified row. The
691 LyX-Hfill is a LaTeX \hfill so that the hfills at the
692 beginning and at the end were ignored. This is {\em MUCH}
693 more usefull than not to ignore!
695 int numberOfHfills(Buffer const *, Row const * row) const;
697 /// like NumberOfHfills, but only those in the manual label!
698 int numberOfLabelHfills(Buffer const *, Row const * row) const;
699 /** returns true, if a expansion is needed. Rules are given by
702 bool hfillExpansion(Buffer const *, Row const * row_ptr,
703 lyx::pos_type pos) const;
705 LColor::color backgroundColor();
709 mutable std::vector<lyx::pos_type> log2vis_list;
712 mutable std::vector<lyx::pos_type> vis2log_list;
715 mutable std::vector<lyx::pos_type> bidi_levels;
718 mutable lyx::pos_type bidi_start;
721 mutable lyx::pos_type bidi_end;
724 mutable bool bidi_same_direction;
727 unsigned char transformChar(unsigned char c, Paragraph * par,
728 lyx::pos_type pos) const;
730 /** returns the paragraph position of the last character in the
733 lyx::pos_type rowLast(Row const * row) const;
735 lyx::pos_type rowLastPrintable(Row const * row) const;
741 // special owner functions
743 Paragraph * ownerParagraph() const;
745 void ownerParagraph(Paragraph *) const;
746 // set it searching first for the right owner using the paragraph id
747 void ownerParagraph(int id, Paragraph *) const;