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"
37 This class holds the mapping between buffer paragraphs and screen rows.
48 NEED_VERY_LITTLE_REFRESH = 2,
54 // the word around the cursor, only if the cursor is
57 // the word around the cursor
59 /// the word begining from the cursor position
61 /// the word around the cursor or before the cursor
63 /// the next word (not yet used)
68 LyXText(BufferView *);
75 void init(BufferView *, bool reinit = false);
77 mutable int number_of_rows;
81 mutable unsigned int width;
82 /// the current font settings
83 mutable LyXFont current_font;
85 mutable LyXFont real_current_font;
86 /// first visible pixel-row is set from LyXScreen!!!
87 // unsigned is wrong here for text-insets!
90 BufferView * bv_owner;
92 InsetText * inset_owner;
94 UpdatableInset * the_locking_inset;
97 int getRealCursorX(BufferView *) const;
99 LyXFont const getFont(Buffer const *, Paragraph * par,
100 lyx::pos_type pos) const;
102 LyXFont const getLayoutFont(Buffer const *, Paragraph * par) const;
104 LyXFont const getLabelFont(Buffer const *, Paragraph * par) const;
106 void setCharFont(Buffer const *, Paragraph * par,
107 lyx::pos_type pos, LyXFont const & font);
108 void setCharFont(BufferView *, Paragraph * par,
109 lyx::pos_type pos, LyXFont const & font, bool toggleall);
110 /// returns a pointer to the very first Paragraph
111 Paragraph * firstParagraph() const;
113 /// what you expect when pressing <enter> at cursor position
114 void breakParagraph(BufferView *, char keep_layout = 0);
116 /** set layout over selection and make a total rebreak of
119 Paragraph * setLayout(BufferView *, LyXCursor & actual_cursor,
120 LyXCursor & selection_start,
121 LyXCursor & selection_end,
122 lyx::layout_type layout);
124 void setLayout(BufferView *, lyx::layout_type layout);
126 /// used in setlayout
127 void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
129 /** increment depth over selection and make a total rebreak of those
132 void incDepth(BufferView *);
134 /** decrement depth over selection and make a total rebreak of those
136 void decDepth(BufferView *);
138 /** Get the depth at current cursor position
140 int getDepth() const;
142 /** set font over selection and make a total rebreak of those
144 toggleall defaults to false.
146 void setFont(BufferView *, LyXFont const &, bool toggleall = false);
148 /** deletes and inserts again all paragaphs between the cursor
149 and the specified par. The Cursor is needed to set the refreshing
151 This function is needed after SetLayout and SetFont etc.
153 void redoParagraphs(BufferView *, LyXCursor const & cursor,
154 Paragraph const * end_par) const;
156 void redoParagraph(BufferView *) const;
159 void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
162 string getStringToIndex(BufferView *);
164 /** recalculates the heights of all previous rows of the
165 specified paragraph. needed, if the last characters font
168 void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
170 /** forces the redrawing of a paragraph. Needed when manipulating a
173 void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
175 /** insert a character, moves all the following breaks in the
176 same Paragraph one to the right and make a little rebreak
178 void insertChar(BufferView *, char c);
180 void insertInset(BufferView *, Inset * inset);
182 /** Completes the insertion with a full rebreak.
183 Returns true if something was broken. */
184 bool fullRebreak(BufferView *);
187 mutable Row * need_break_row;
189 mutable int refresh_y;
197 mutable Row * refresh_row;
199 lyx::pos_type refresh_pos;
201 /// give and set the LyXText status
202 text_status status() const;
204 void status(BufferView *, text_status) const;
207 /** wether the screen needs a refresh,
208 starting with refresh_y
210 mutable text_status status_;
213 /** returns a pointer to the row near the specified y-coordinate
214 (relative to the whole text). y is set to the real beginning
217 Row * getRowNearY(int & y) const;
219 /** returns the column near the specified x-coordinate of the row
220 x is set to the real beginning of this column
222 lyx::pos_type getColumnNearX(BufferView *, Row * row,
223 int & x, bool & boundary) const;
225 /** returns a pointer to a specified row. y is set to the beginning
228 Row * getRow(Paragraph * par,
229 lyx::pos_type pos, int & y) const;
230 /** returns the firstrow, this could be done with the above too but
231 IMO it's stupid to have to allocate a dummy y all the time I need
234 Row * firstRow() { return firstrow; }
236 /** returns the height of a default row, needed for scrollbar
238 int defaultHeight() const;
241 Later this variable has to be removed. There should be now internal
242 cursor in a text (and thus not in a buffer). By keeping this it is
243 (I think) impossible to have several views with the same buffer, but
244 the cursor placed at different places.
246 Since the LyXText now has been moved from Buffer to BufferView
247 it should not be absolutely needed to move the cursor...
249 mutable LyXCursor cursor; // actual cursor position
251 /** The structure that keeps track of the selections set. */
254 : set_(false), mark_(false)
268 LyXCursor cursor; // temporary cursor to hold a cursor position
269 // until setSelection is called!
270 LyXCursor start; // start of a REAL selection
271 LyXCursor end; // end of a REAL selection
273 bool set_; // former selection
274 bool mark_; // former mark_set
277 mutable Selection selection;
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 string const selectNextWordToSpellcheck(BufferView *, float & value) const;
308 void selectSelectedWord(BufferView *);
310 void 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 void setCurrentFont(BufferView *) const;
327 bool isBoundary(Buffer const *, Paragraph * par,
328 lyx::pos_type pos) const;
330 bool isBoundary(Buffer const *, Paragraph * par,
332 LyXFont const & font) const;
335 void setCursorFromCoordinates(BufferView *, int x, int y) const;
337 void setCursorFromCoordinates(BufferView *, LyXCursor &,
340 void cursorUp(BufferView *) const;
342 void cursorDown(BufferView *) const;
344 void cursorLeft(BufferView *, bool internal = true) const;
346 void cursorRight(BufferView *, bool internal = true) const;
348 void cursorLeftOneWord(BufferView *) const;
350 void cursorLeftOneWord(LyXCursor &) const;
352 void cursorRightOneWord(BufferView *) const;
354 void cursorUpParagraph(BufferView *) const;
356 void cursorDownParagraph(BufferView *) const;
358 void cursorHome(BufferView *) const;
360 void cursorEnd(BufferView *) const;
362 void cursorTab(BufferView *) const;
364 void cursorTop(BufferView *) const;
366 void cursorBottom(BufferView *) const;
368 void Delete(BufferView *);
370 void backspace(BufferView *);
372 void deleteWordForward(BufferView *);
374 void deleteWordBackward(BufferView *);
376 void deleteLineForward(BufferView *);
378 bool selectWordWhenUnderCursor(BufferView *,
379 word_location const);
385 text_capitalization = 1,
389 /// Change the case of the word at cursor position.
390 void changeCase(BufferView *, TextCase action);
392 void changeRegionCase(BufferView * bview,
393 LyXCursor const & from,
394 LyXCursor const & to,
395 LyXText::TextCase action);
397 void transposeChars(BufferView &);
399 /** returns a printed row in a pixmap. The y value is needed to
400 decide, wether it is selected text or not. This is a strange
403 void getVisibleRow(BufferView *, int y_offset, int x_offset,
404 Row * row_ptr, int y, bool cleared=false);
407 void toggleInset(BufferView *);
409 void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
411 void copySelection(BufferView *);
413 void pasteSelection(BufferView *);
415 void copyEnvironmentType();
417 void pasteEnvironmentType(BufferView *);
419 /** the DTP switches for paragraphs. LyX will store the top settings
420 always in the first physical paragraph, the bottom settings in the
421 last. When a paragraph is broken, the top settings rest, the bottom
422 settings are given to the new one. So I can make shure, they do not
423 duplicate themself (and you cannnot make dirty things with them! )
425 void setParagraph(BufferView *,
426 bool line_top, bool line_bottom,
427 bool pagebreak_top, bool pagebreak_bottom,
428 VSpace const & space_top,
429 VSpace const & space_bottom,
430 Spacing const & spacing,
432 string labelwidthstring,
435 /* these things are for search and replace */
437 /** sets the selection over the number of characters of string,
440 void setSelectionOverString(BufferView *, string const & str);
442 /** simple replacing. The font of the first selected character
445 void replaceSelectionWithString(BufferView *, string const & str);
447 /// needed to insert the selection
448 void insertStringAsLines(BufferView *, string const & str);
449 /// needed to insert the selection
450 void insertStringAsParagraphs(BufferView *, string const & str);
452 /// Find next inset of some specified type.
453 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
454 string const & contents = string()) const;
457 /* for the greater insets */
459 /// returns false if inset wasn't found
460 bool updateInset(BufferView *, Inset *);
462 void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
464 int numberOfCell(Paragraph * par, lyx::pos_type pos) const;
466 void removeTableRow(LyXCursor & cursor) const;
468 bool isEmptyTableCell() const;
470 void toggleAppendix(BufferView *);
472 int workWidth(BufferView *) const;
474 int workWidth(BufferView *, Inset * inset) const;
476 void computeBidiTables(Buffer const *, Row * row) const;
478 /// Maps positions in the visual string to positions in logical string.
480 lyx::pos_type log2vis(lyx::pos_type pos) const {
481 if (bidi_start == -1)
484 return log2vis_list[pos-bidi_start];
487 /// Maps positions in the logical string to positions in visual string.
489 lyx::pos_type vis2log(lyx::pos_type pos) const {
490 if (bidi_start == -1)
493 return vis2log_list[pos-bidi_start];
497 lyx::pos_type bidi_level(lyx::pos_type pos) const {
498 if (bidi_start == -1)
501 return bidi_levels[pos-bidi_start];
505 bool bidi_InRange(lyx::pos_type pos) const {
506 return bidi_start == -1 ||
507 (bidi_start <= pos && pos <= bidi_end);
511 mutable Row * firstrow;
513 mutable Row * lastrow;
515 /** Copybuffer for copy environment type.
516 Asger has learned that this should be a buffer-property instead
517 Lgb has learned that 'char' is a lousy type for non-characters
519 lyx::layout_type copylayouttype;
521 /** inserts a new row behind the specified row, increments
522 the touched counters */
523 void insertRow(Row * row, Paragraph * par, lyx::pos_type pos) const;
524 /** removes the row and reset the touched counters */
525 void removeRow(Row * row) const;
527 /** remove all following rows of the paragraph of the specified row. */
528 void removeParagraph(Row * row) const;
530 /** insert the specified paragraph behind the specified row */
531 void insertParagraph(BufferView *,
532 Paragraph * par, Row * row) const;
534 /** appends the implizit specified paragraph behind the specified row,
535 * start at the implizit given position */
536 void appendParagraph(BufferView *, Row * row) const;
539 void breakAgain(BufferView *, Row * row) const;
541 void breakAgainOneRow(BufferView *, Row * row);
542 /// Calculate and set the height of the row
543 void setHeightOfRow(BufferView *, Row * row_ptr) const;
545 /** this calculates the specified parameters. needed when setting
546 * the cursor and when creating a visible row */
547 void prepareToPrint(BufferView *, Row * row, float & x,
548 float & fill_separator,
550 float & fill_label_hfill,
551 bool bidi = true) const;
553 /// A struct used for drawing routines
554 struct DrawRowParams {
559 // the painter to use
561 // has the background been cleared
563 /// x offset (e.g. for insets)
565 /// y offset (e.g. for insets)
571 /// the inset/view full width
577 /// fill separator size
581 /// paint the background
582 bool paintRowBackground(DrawRowParams & p);
584 /// paint the selection background
585 void paintRowSelection(DrawRowParams & p);
587 /// paint appendix marker
588 void paintRowAppendix(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 or empty paragraphs around old_cursor
616 void 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 void drawInset(DrawRowParams & p, lyx::pos_type const pos);
650 /// draw new line marker
651 void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
653 void 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;
667 /** Returns the left beginning of the text.
668 This information cannot be taken from the layouts-objekt, because
669 in LaTeX the beginning of the text fits in some cases
670 (for example sections) exactly the label-width.
672 int leftMargin(BufferView *, Row const * row) const;
674 int rightMargin(Buffer const *, Row const * row) const;
676 int labelEnd (BufferView *, Row const * row) const;
678 /** returns the number of separators in the specified row.
679 The separator on the very last column doesnt count
681 int numberOfSeparators(Buffer const *, Row const * row) const;
683 /** returns the number of hfills in the specified row. The
684 LyX-Hfill is a LaTeX \hfill so that the hfills at the
685 beginning and at the end were ignored. This is {\em MUCH}
686 more usefull than not to ignore!
688 int numberOfHfills(Buffer const *, Row const * row) const;
690 /// like NumberOfHfills, but only those in the manual label!
691 int numberOfLabelHfills(Buffer const *, Row const * row) const;
692 /** returns true, if a expansion is needed. Rules are given by
695 bool hfillExpansion(Buffer const *, Row const * row_ptr,
696 lyx::pos_type pos) const;
698 LColor::color backgroundColor();
702 mutable std::vector<lyx::pos_type> log2vis_list;
705 mutable std::vector<lyx::pos_type> vis2log_list;
708 mutable std::vector<lyx::pos_type> bidi_levels;
711 mutable lyx::pos_type bidi_start;
714 mutable lyx::pos_type bidi_end;
717 mutable bool bidi_same_direction;
720 unsigned char transformChar(unsigned char c, Paragraph * par,
721 lyx::pos_type pos) const;
723 /** returns the paragraph position of the last character in the
726 lyx::pos_type rowLast(Row const * row) const;
728 lyx::pos_type rowLastPrintable(Row const * row) const;
734 // special owner functions
736 Paragraph * ownerParagraph() const;
738 void ownerParagraph(Paragraph *) const;
739 // set it searching first for the right owner using the paragraph id
740 void ownerParagraph(int id, Paragraph *) const;