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 *);
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;
185 mutable Row * refresh_row;
187 lyx::pos_type refresh_pos;
189 /// give and set the LyXText status
190 text_status status() const;
192 void status(BufferView *, text_status) const;
195 /** wether the screen needs a refresh,
196 starting with refresh_y
198 mutable text_status status_;
201 /** returns a pointer to the row near the specified y-coordinate
202 (relative to the whole text). y is set to the real beginning
205 Row * getRowNearY(int & y) const;
207 /** returns the column near the specified x-coordinate of the row
208 x is set to the real beginning of this column
210 lyx::pos_type getColumnNearX(BufferView *, Row * row,
211 int & x, bool & boundary) const;
213 /** returns a pointer to a specified row. y is set to the beginning
216 Row * getRow(Paragraph * par,
217 lyx::pos_type pos, int & y) const;
218 /** returns the firstrow, this could be done with the above too but
219 IMO it's stupid to have to allocate a dummy y all the time I need
222 Row * firstRow() { return firstrow; }
224 /** returns the height of a default row, needed for scrollbar
226 int defaultHeight() const;
229 Later this variable has to be removed. There should be now internal
230 cursor in a text (and thus not in a buffer). By keeping this it is
231 (I think) impossible to have several views with the same buffer, but
232 the cursor placed at different places.
234 Since the LyXText now has been moved from Buffer to BufferView
235 it should not be absolutely needed to move the cursor...
237 mutable LyXCursor cursor; // actual cursor position
239 /** The structure that keeps track of the selections set. */
242 : set_(false), mark_(false)
256 LyXCursor cursor; // temporary cursor to hold a cursor position
257 // until setSelection is called!
258 LyXCursor start; // start of a REAL selection
259 LyXCursor end; // end of a REAL selection
261 bool set_; // former selection
262 bool mark_; // former mark_set
265 mutable Selection selection;
266 // this is used to handle XSelection events in the right manner
267 mutable Selection xsel_cache;
269 /// needed for the toggling (cursor position on last selection made)
270 mutable LyXCursor last_sel_cursor;
271 /// needed for toggling the selection in screen.C
272 mutable LyXCursor toggle_cursor;
273 /// needed for toggling the selection in screen.C
274 mutable LyXCursor toggle_end_cursor;
276 /// need the selection cursor:
277 void setSelection(BufferView *);
279 void clearSelection() const;
281 string const selectionAsString(Buffer const *, bool label) const;
283 /// select the word we need depending on word_location
284 void getWord(LyXCursor & from, LyXCursor & to,
285 word_location const) const;
286 /// just selects the word the cursor is in
287 void selectWord(BufferView *, word_location const);
288 /// returns the inset at cursor (if it exists), 0 otherwise
289 Inset * getInset() const;
291 /** 'selects" the next word, where the cursor is not in
292 and returns this word as string. THe cursor will be moved
293 to the beginning of this word.
294 With SelectSelectedWord can this be highlighted really
296 WordLangTuple const selectNextWordToSpellcheck(BufferView *, float & value) const;
298 void selectSelectedWord(BufferView *);
299 /// returns true if par was empty and was removed
300 bool setCursor(BufferView *, Paragraph * par,
303 bool boundary = false) const;
305 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
307 bool boundary = false) const;
309 void setCursorIntern(BufferView *, Paragraph * par,
312 bool boundary = false) const;
314 void setCurrentFont(BufferView *) const;
317 bool isBoundary(Buffer const *, Paragraph * par,
318 lyx::pos_type pos) const;
320 bool isBoundary(Buffer const *, Paragraph * par,
322 LyXFont const & font) const;
325 void setCursorFromCoordinates(BufferView *, int x, int y) const;
327 void setCursorFromCoordinates(BufferView *, LyXCursor &,
330 void cursorUp(BufferView *, bool selecting = false) const;
332 void cursorDown(BufferView *, bool selecting = false) const;
334 void cursorLeft(BufferView *, bool internal = true) const;
336 void cursorRight(BufferView *, bool internal = true) const;
338 void cursorLeftOneWord(BufferView *) const;
340 void cursorRightOneWord(BufferView *) const;
342 void cursorUpParagraph(BufferView *) const;
344 void cursorDownParagraph(BufferView *) const;
346 void cursorHome(BufferView *) const;
348 void cursorEnd(BufferView *) const;
350 void cursorTab(BufferView *) const;
352 void cursorTop(BufferView *) const;
354 void cursorBottom(BufferView *) const;
356 void Delete(BufferView *);
358 void backspace(BufferView *);
360 void deleteWordForward(BufferView *);
362 void deleteWordBackward(BufferView *);
364 void deleteLineForward(BufferView *);
366 bool selectWordWhenUnderCursor(BufferView *,
367 word_location const);
373 text_capitalization = 1,
377 /// Change the case of the word at cursor position.
378 void changeCase(BufferView *, TextCase action);
380 void transposeChars(BufferView &);
382 /** returns a printed row in a pixmap. The y value is needed to
383 decide, wether it is selected text or not. This is a strange
386 void getVisibleRow(BufferView *, int y_offset, int x_offset,
387 Row * row_ptr, int y, bool cleared=false);
390 void toggleInset(BufferView *);
392 void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
394 void copySelection(BufferView *);
396 void pasteSelection(BufferView *);
398 void copyEnvironmentType();
400 void pasteEnvironmentType(BufferView *);
402 /** the DTP switches for paragraphs. LyX will store the top settings
403 always in the first physical paragraph, the bottom settings in the
404 last. When a paragraph is broken, the top settings rest, the bottom
405 settings are given to the new one. So I can make shure, they do not
406 duplicate themself (and you cannnot make dirty things with them! )
408 void setParagraph(BufferView *,
409 bool line_top, bool line_bottom,
410 bool pagebreak_top, bool pagebreak_bottom,
411 VSpace const & space_top,
412 VSpace const & space_bottom,
413 Spacing const & spacing,
415 string labelwidthstring,
418 /* these things are for search and replace */
420 /** sets the selection over the number of characters of string,
423 void setSelectionOverString(BufferView *, string const & str);
425 /** simple replacing. The font of the first selected character
428 void replaceSelectionWithString(BufferView *, string const & str);
430 /// needed to insert the selection
431 void insertStringAsLines(BufferView *, string const & str);
432 /// needed to insert the selection
433 void insertStringAsParagraphs(BufferView *, string const & str);
435 /// Find next inset of some specified type.
436 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
437 string const & contents = string()) const;
440 /* for the greater insets */
442 /// returns false if inset wasn't found
443 bool updateInset(BufferView *, Inset *);
445 void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
447 void toggleAppendix(BufferView *);
449 int workWidth(BufferView *) const;
451 int workWidth(BufferView *, Inset * inset) const;
453 void computeBidiTables(Buffer const *, Row * row) const;
455 /// Maps positions in the visual string to positions in logical string.
457 lyx::pos_type log2vis(lyx::pos_type pos) const {
458 if (bidi_start == -1)
461 return log2vis_list[pos-bidi_start];
464 /// Maps positions in the logical string to positions in visual string.
466 lyx::pos_type vis2log(lyx::pos_type pos) const {
467 if (bidi_start == -1)
470 return vis2log_list[pos-bidi_start];
474 lyx::pos_type bidi_level(lyx::pos_type pos) const {
475 if (bidi_start == -1)
478 return bidi_levels[pos-bidi_start];
482 bool bidi_InRange(lyx::pos_type pos) const {
483 return bidi_start == -1 ||
484 (bidi_start <= pos && pos <= bidi_end);
488 mutable Row * firstrow;
491 mutable Row * lastrow;
494 void cursorLeftOneWord(LyXCursor &) const;
497 float getCursorX(BufferView *, Row *, lyx::pos_type pos,
498 lyx::pos_type last, bool boundary) const;
500 void changeRegionCase(BufferView * bview,
501 LyXCursor const & from,
502 LyXCursor const & to,
503 LyXText::TextCase action);
504 /// used in setlayout
505 void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
507 /** forces the redrawing of a paragraph. Needed when manipulating a
510 void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
512 /** Copybuffer for copy environment type.
513 Asger has learned that this should be a buffer-property instead
514 Lgb has learned that 'char' is a lousy type for non-characters
516 string copylayouttype;
517 /** inserts a new row behind the specified row, increments
518 the touched counters */
519 void insertRow(Row * row, Paragraph * par, lyx::pos_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
559 /// x offset (e.g. for insets)
561 /// y offset (e.g. for insets)
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 page break marker. Returns its height.
587 int paintPageBreak(string const & label, int y, DrawRowParams & p);
589 /// paint env depth bar
590 void paintRowDepthBar(DrawRowParams & p);
592 /// get the on-screen size of the length marker
593 int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
595 /// paint an added space marker
596 int drawLengthMarker(DrawRowParams & p, string const & str,
597 VSpace const & vsp, int start);
599 /// paint a first row in a paragraph
600 void paintFirstRow(DrawRowParams & p);
602 /// paint a last row in a paragraph
603 void paintLastRow(DrawRowParams & p);
606 void paintRowText(DrawRowParams & p);
608 // fix the cursor `cur' after a characters has been deleted at `where'
609 // position. Called by deleteEmptyParagraphMechanism
610 void fixCursorAfterDelete(BufferView * bview,
612 LyXCursor const & where) const;
614 /// delete double space (false) or empty paragraphs (true) around old_cursor
615 bool deleteEmptyParagraphMechanism(BufferView *,
616 LyXCursor const & old_cursor) const;
619 /** Updates all counters starting BEHIND the row. Changed paragraphs
620 * with a dynamic left margin will be rebroken. */
621 void updateCounters(BufferView *) const;
624 void setCounter(Buffer const *, Paragraph * par) const;
627 * some low level functions
631 int singleWidth(BufferView *, Paragraph * par,
632 lyx::pos_type pos) const;
634 int singleWidth(BufferView *, Paragraph * par,
635 lyx::pos_type pos, char c) const;
638 /// draw normal chars
639 void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
640 bool hebrew, bool arabic);
641 /// draw from arabic composed char
642 void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
643 /// draw from hebrew composed char
644 void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
645 /// draw a mark for foreign language, starting from orig_x
646 void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
648 bool drawInset(DrawRowParams & p, lyx::pos_type const pos);
649 /// draw new line marker
650 void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
652 bool draw(DrawRowParams & p, lyx::pos_type & vpos);
654 /// get the next breakpoint in a given paragraph
655 lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
656 /// returns the minimum space a row needs on the screen in pixel
657 int fill(BufferView *, Row * row, int workwidth) const;
659 /** returns the minimum space a manual label needs on the
661 int labelFill(BufferView *, Row const * row) const;
664 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 layout object, 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;