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 /// accept selected change
285 void acceptChange(BufferView * bv);
287 /// reject selected change
288 void rejectChange(BufferView * bv);
290 /** 'selects" the next word, where the cursor is not in
291 and returns this word as string. THe cursor will be moved
292 to the beginning of this word.
293 With SelectSelectedWord can this be highlighted really
295 WordLangTuple const selectNextWordToSpellcheck(BufferView *, float & value) const;
297 void selectSelectedWord(BufferView *);
298 /// returns true if par was empty and was removed
299 bool setCursor(BufferView *, Paragraph * par,
302 bool boundary = false) const;
304 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
306 bool boundary = false) const;
308 void setCursorIntern(BufferView *, Paragraph * par,
311 bool boundary = false) const;
313 void setCurrentFont(BufferView *) const;
316 bool isBoundary(Buffer const *, Paragraph * par,
317 lyx::pos_type pos) const;
319 bool isBoundary(Buffer const *, Paragraph * par,
321 LyXFont const & font) const;
324 void setCursorFromCoordinates(BufferView *, int x, int y) const;
326 void setCursorFromCoordinates(BufferView *, LyXCursor &,
329 void cursorUp(BufferView *, bool selecting = false) const;
331 void cursorDown(BufferView *, bool selecting = false) const;
333 void cursorLeft(BufferView *, bool internal = true) const;
335 void cursorRight(BufferView *, bool internal = true) const;
337 void cursorLeftOneWord(BufferView *) const;
339 void cursorRightOneWord(BufferView *) const;
341 void cursorUpParagraph(BufferView *) const;
343 void cursorDownParagraph(BufferView *) const;
345 void cursorHome(BufferView *) const;
347 void cursorEnd(BufferView *) const;
349 void cursorPrevious(BufferView * bv);
351 void cursorNext(BufferView * bv);
353 void cursorTab(BufferView *) const;
355 void cursorTop(BufferView *) const;
357 void cursorBottom(BufferView *) const;
359 void Delete(BufferView *);
361 void backspace(BufferView *);
363 bool selectWordWhenUnderCursor(BufferView *,
364 word_location const);
370 text_capitalization = 1,
374 /// Change the case of the word at cursor position.
375 void changeCase(BufferView *, TextCase action);
377 void transposeChars(BufferView &);
379 /** returns a printed row in a pixmap. The y value is needed to
380 decide, wether it is selected text or not. This is a strange
383 void getVisibleRow(BufferView *, int y_offset, int x_offset,
384 Row * row_ptr, int y, bool cleared=false);
387 void toggleInset(BufferView *);
389 void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
391 void copySelection(BufferView *);
393 void pasteSelection(BufferView *);
395 void copyEnvironmentType();
397 void pasteEnvironmentType(BufferView *);
399 /** the DTP switches for paragraphs. LyX will store the top settings
400 always in the first physical paragraph, the bottom settings in the
401 last. When a paragraph is broken, the top settings rest, the bottom
402 settings are given to the new one. So I can make shure, they do not
403 duplicate themself (and you cannnot make dirty things with them! )
405 void setParagraph(BufferView *,
406 bool line_top, bool line_bottom,
407 bool pagebreak_top, bool pagebreak_bottom,
408 VSpace const & space_top,
409 VSpace const & space_bottom,
410 Spacing const & spacing,
412 string labelwidthstring,
415 /* these things are for search and replace */
418 * Sets the selection from the current cursor position to length
419 * characters to the right. No safety checks.
421 void setSelectionRange(BufferView *, lyx::pos_type length);
423 /** simple replacing. The font of the first selected character
426 void replaceSelectionWithString(BufferView *, string const & str);
428 /// needed to insert the selection
429 void insertStringAsLines(BufferView *, string const & str);
430 /// needed to insert the selection
431 void insertStringAsParagraphs(BufferView *, string const & str);
433 /// Find next inset of some specified type.
434 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
435 string const & contents = string()) const;
437 void gotoInset(BufferView * bv, std::vector<Inset::Code> const & codes,
440 void gotoInset(BufferView * bv, Inset::Code code, bool same_content);
443 /* for the greater insets */
445 /// returns false if inset wasn't found
446 bool updateInset(BufferView *, Inset *);
448 void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
450 int workWidth(BufferView *) const;
452 int workWidth(BufferView *, Inset * inset) const;
454 void computeBidiTables(Buffer const *, Row * row) const;
456 /// Maps positions in the visual string to positions in logical string.
458 lyx::pos_type log2vis(lyx::pos_type pos) const {
459 if (bidi_start == -1)
462 return log2vis_list[pos-bidi_start];
465 /// Maps positions in the logical string to positions in visual string.
467 lyx::pos_type vis2log(lyx::pos_type pos) const {
468 if (bidi_start == -1)
471 return vis2log_list[pos-bidi_start];
475 lyx::pos_type bidi_level(lyx::pos_type pos) const {
476 if (bidi_start == -1)
479 return bidi_levels[pos-bidi_start];
483 bool bidi_InRange(lyx::pos_type pos) const {
484 return bidi_start == -1 ||
485 (bidi_start <= pos && pos <= bidi_end);
489 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 * bv,
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;
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);
585 void paintChangeBar(DrawRowParams & p);
587 /// paint appendix marker
588 void paintRowAppendix(DrawRowParams & p);
590 /// paint page break marker. Returns its height.
591 int paintPageBreak(string const & label, int y, DrawRowParams & p);
593 /// paint env depth bar
594 void paintRowDepthBar(DrawRowParams & p);
596 /// get the on-screen size of the length marker
597 int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
599 /// paint an added space marker
600 int drawLengthMarker(DrawRowParams & p, string const & str,
601 VSpace const & vsp, int start);
603 /// paint a first row in a paragraph
604 void paintFirstRow(DrawRowParams & p);
606 /// paint a last row in a paragraph
607 void paintLastRow(DrawRowParams & p);
610 void paintRowText(DrawRowParams & p);
612 // fix the cursor `cur' after a characters has been deleted at `where'
613 // position. Called by deleteEmptyParagraphMechanism
614 void fixCursorAfterDelete(BufferView * bv,
616 LyXCursor const & where) const;
618 /// delete double space (false) or empty paragraphs (true) around old_cursor
619 bool deleteEmptyParagraphMechanism(BufferView *,
620 LyXCursor const & old_cursor) const;
623 /** Updates all counters starting BEHIND the row. Changed paragraphs
624 * with a dynamic left margin will be rebroken. */
625 void updateCounters(BufferView *) const;
627 void update(BufferView * bv, bool changed = true);
629 * Returns an inset if inset was hit, or 0 if not.
630 * If hit, the coordinates are changed relative to the inset.
632 Inset * checkInsetHit(BufferView * bv, int & x, int & y) const;
636 void setCounter(Buffer const *, Paragraph * par) const;
638 void deleteWordForward(BufferView *);
640 void deleteWordBackward(BufferView *);
642 void deleteLineForward(BufferView *);
645 * some low level functions
649 int singleWidth(BufferView *, Paragraph * par,
650 lyx::pos_type pos) const;
652 int singleWidth(BufferView *, Paragraph * par,
653 lyx::pos_type pos, char c) const;
656 /// draw normal chars
657 void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
658 bool hebrew, bool arabic);
659 /// draw from arabic composed char
660 void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
661 /// draw from hebrew composed char
662 void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
663 /// draw a mark for foreign language, starting from orig_x
664 void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
666 bool drawInset(DrawRowParams & p, lyx::pos_type const pos);
667 /// draw new line marker
668 void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
670 bool draw(DrawRowParams & p, lyx::pos_type & vpos);
672 /// get the next breakpoint in a given paragraph
673 lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
674 /// returns the minimum space a row needs on the screen in pixel
675 int fill(BufferView *, Row * row, int workwidth) const;
677 /** returns the minimum space a manual label needs on the
679 int labelFill(BufferView *, Row const * row) const;
682 lyx::pos_type beginningOfMainBody(Buffer const *, Paragraph const * par) const;
685 * Returns the left beginning of the text.
686 * This information cannot be taken from the layout object, because
687 * in LaTeX the beginning of the text fits in some cases
688 * (for example sections) exactly the label-width.
690 int leftMargin(BufferView *, Row const * row) const;
692 int rightMargin(Buffer const *, Row const * row) const;
694 int labelEnd (BufferView *, Row const * row) const;
696 /** returns the number of separators in the specified row.
697 The separator on the very last column doesnt count
699 int numberOfSeparators(Buffer const *, Row const * row) const;
701 /** returns the number of hfills in the specified row. The
702 LyX-Hfill is a LaTeX \hfill so that the hfills at the
703 beginning and at the end were ignored. This is {\em MUCH}
704 more usefull than not to ignore!
706 int numberOfHfills(Buffer const *, Row const * row) const;
708 /// like NumberOfHfills, but only those in the manual label!
709 int numberOfLabelHfills(Buffer const *, Row const * row) const;
710 /** returns true, if a expansion is needed. Rules are given by
713 bool hfillExpansion(Buffer const *, Row const * row_ptr,
714 lyx::pos_type pos) const;
716 LColor::color backgroundColor();
720 mutable std::vector<lyx::pos_type> log2vis_list;
723 mutable std::vector<lyx::pos_type> vis2log_list;
726 mutable std::vector<lyx::pos_type> bidi_levels;
729 mutable lyx::pos_type bidi_start;
732 mutable lyx::pos_type bidi_end;
735 mutable bool bidi_same_direction;
738 unsigned char transformChar(unsigned char c, Paragraph * par,
739 lyx::pos_type pos) const;
741 /** returns the paragraph position of the last character in the
744 lyx::pos_type rowLast(Row const * row) const;
746 lyx::pos_type rowLastPrintable(Row const * row) const;
752 // special owner functions
754 Paragraph * ownerParagraph() const;
756 void ownerParagraph(Paragraph *) const;
757 // set it searching first for the right owner using the paragraph id
758 void ownerParagraph(int id, Paragraph *) const;