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"
21 #include "paragraph.h"
33 This class holds the mapping between buffer paragraphs and screen rows.
44 NEED_VERY_LITTLE_REFRESH = 2,
50 /// the word around the cursor
52 /// the word begining from the cursor position
54 /// the next word (not yet used)
59 LyXText(BufferView *);
66 void init(BufferView *);
68 mutable int number_of_rows;
72 mutable unsigned int width;
73 /// the current font settings
74 mutable LyXFont current_font;
76 mutable LyXFont real_current_font;
77 /// first visible pixel-row is set from LyXScreen!!!
78 // unsigned is wrong here for text-insets!
81 BufferView * bv_owner;
83 InsetText * inset_owner;
85 UpdatableInset * the_locking_inset;
88 int getRealCursorX(BufferView *) const;
90 LyXFont const getFont(Buffer const *, Paragraph * par,
91 Paragraph::size_type pos) const;
93 void setCharFont(Buffer const *, Paragraph * par,
94 Paragraph::size_type pos, LyXFont const & font);
95 void setCharFont(BufferView *, Paragraph * par,
96 Paragraph::size_type pos,
97 LyXFont const & font, bool toggleall);
98 /// returns a pointer to the very first Paragraph
99 Paragraph * firstParagraph() const;
101 /// what you expect when pressing <enter> at cursor position
102 void breakParagraph(BufferView *, char keep_layout = 0);
104 /** set layout over selection and make a total rebreak of
107 Paragraph * setLayout(BufferView *, LyXCursor & actual_cursor,
108 LyXCursor & selection_start,
109 LyXCursor & selection_end,
110 LyXTextClass::size_type layout);
111 void setLayout(BufferView *, LyXTextClass::size_type layout);
113 /// used in setlayout
114 void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
116 /** increment depth over selection and make a total rebreak of those
119 void incDepth(BufferView *);
121 /** decrement depth over selection and make a total rebreak of those
123 void decDepth(BufferView *);
125 /** Get the depth at current cursor position
127 int getDepth() const { return cursor.par()->getDepth(); }
129 /** set font over selection and make a total rebreak of those
131 toggleall defaults to false.
133 void setFont(BufferView *, LyXFont const &, bool toggleall = false);
135 /** deletes and inserts again all paragaphs between the cursor
136 and the specified par. The Cursor is needed to set the refreshing
138 This function is needed after SetLayout and SetFont etc.
140 void redoParagraphs(BufferView *, LyXCursor const & cursor,
141 Paragraph const * end_par) const;
143 void redoParagraph(BufferView *) const;
146 void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
148 /** recalculates the heights of all previous rows of the
149 specified paragraph. needed, if the last characters font
152 void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
154 /** forces the redrawing of a paragraph. Needed when manipulating a
157 void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
159 /** insert a character, moves all the following breaks in the
160 same Paragraph one to the right and make a little rebreak
162 void insertChar(BufferView *, char c);
164 void insertInset(BufferView *, Inset * inset);
166 /** Completes the insertion with a full rebreak.
167 Returns true if something was broken. */
168 bool fullRebreak(BufferView *);
171 Row * need_break_row;
173 mutable int refresh_y;
181 mutable Row * refresh_row;
185 /// give and set the LyXText status
186 text_status status() const;
187 void status(BufferView *, text_status) const;
190 /** wether the screen needs a refresh,
191 starting with refresh_y
193 mutable text_status status_;
196 /** returns a pointer to the row near the specified y-coordinate
197 (relative to the whole text). y is set to the real beginning
200 Row * getRowNearY(int & y) const;
202 /** returns the column near the specified x-coordinate of the row
203 x is set to the real beginning of this column
205 int getColumnNearX(BufferView *, Row * row,
206 int & x, bool & boundary) const;
208 /** returns a pointer to a specified row. y is set to the beginning
211 Row * getRow(Paragraph * par,
212 Paragraph::size_type pos, int & y) const;
214 /** returns the height of a default row, needed for scrollbar
216 int defaultHeight() const;
219 Later this variable has to be removed. There should be now internal
220 cursor in a text (and thus not in a buffer). By keeping this it is
221 (I think) impossible to have several views with the same buffer, but
222 the cursor placed at different places.
224 Since the LyXText now has been moved from Buffer to BufferView
225 it should not be absolutely needed to move the cursor...
227 mutable LyXCursor cursor;
229 /** The structrue that keeps track of the selections set. */
232 : set_(false), mark_(false)
250 bool set_; // former selection
251 bool mark_; // former mark_set
254 mutable Selection selection;
256 /// needed for the toggling
257 LyXCursor last_sel_cursor;
259 LyXCursor toggle_cursor;
261 LyXCursor toggle_end_cursor;
263 /// need the selection cursor:
264 void setSelection(BufferView *);
266 void clearSelection(BufferView *) const;
268 string const selectionAsString(Buffer const *) const;
270 /// select the word we need depending on word_location
271 void getWord(LyXCursor & from, LyXCursor & to, word_location) const;
272 /// just selects the word the cursor is in
273 void selectWord(BufferView *);
275 /** 'selects" the next word, where the cursor is not in
276 and returns this word as string. THe cursor will be moved
277 to the beginning of this word.
278 With SelectSelectedWord can this be highlighted really
280 string const selectNextWord(BufferView *, float & value) const;
282 void selectSelectedWord(BufferView *);
284 void setCursor(BufferView *, Paragraph * par,
285 Paragraph::size_type pos,
287 bool boundary = false) const;
289 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
290 Paragraph::size_type pos,
291 bool boundary = false) const;
293 void setCursorIntern(BufferView *, Paragraph * par,
294 Paragraph::size_type pos,
296 bool boundary = false) const;
298 void setCurrentFont(BufferView *) const;
301 bool isBoundary(Buffer const *, Paragraph * par,
302 Paragraph::size_type pos) const;
304 bool isBoundary(Buffer const *, Paragraph * par,
305 Paragraph::size_type pos,
306 LyXFont const & font) const;
309 void setCursorFromCoordinates(BufferView *, int x, int y) const;
311 void setCursorFromCoordinates(BufferView *, LyXCursor &,
314 void cursorUp(BufferView *) const;
316 void cursorDown(BufferView *) const;
318 void cursorLeft(BufferView *, bool internal = true) const;
320 void cursorRight(BufferView *, bool internal = true) const;
322 void cursorLeftOneWord(BufferView *) const;
324 void cursorLeftOneWord(LyXCursor &) const;
326 void cursorRightOneWord(BufferView *) const;
328 void cursorUpParagraph(BufferView *) const;
330 void cursorDownParagraph(BufferView *) const;
332 void cursorHome(BufferView *) const;
334 void cursorEnd(BufferView *) const;
336 void cursorTab(BufferView *) const;
338 void cursorTop(BufferView *) const;
340 void cursorBottom(BufferView *) const;
342 void Delete(BufferView *);
344 void backspace(BufferView *);
346 void deleteWordForward(BufferView *);
348 void deleteWordBackward(BufferView *);
350 void deleteLineForward(BufferView *);
352 bool selectWordWhenUnderCursor(BufferView *);
358 text_capitalization = 1,
362 /// Change the case of the word at cursor position.
363 void changeCase(BufferView *, TextCase action);
365 void changeRegionCase(BufferView * bview,
366 LyXCursor const & from,
367 LyXCursor const & to,
368 LyXText::TextCase action);
370 void transposeChars(BufferView &);
372 /** returns a printed row in a pixmap. The y value is needed to
373 decide, wether it is selected text or not. This is a strange
376 void getVisibleRow(BufferView *, int y_offset, int x_offset,
377 Row * row_ptr, int y, bool cleared=false);
380 void cutSelection(BufferView *, bool = true);
382 void copySelection(BufferView *);
384 void pasteSelection(BufferView *);
386 void copyEnvironmentType();
388 void pasteEnvironmentType(BufferView *);
390 void insertFootnote();
392 void insertMarginpar();
396 void insertTabular();
398 /** the DTP switches for paragraphs. LyX will store the top settings
399 always in the first physical paragraph, the bottom settings in the
400 last. When a paragraph is broken, the top settings rest, the bottom
401 settings are given to the new one. So I can make shure, they do not
402 duplicate themself (and you cannnot make dirty things with them! )
404 void setParagraph(BufferView *,
405 bool line_top, bool line_bottom,
406 bool pagebreak_top, bool pagebreak_bottom,
407 VSpace const & space_top,
408 VSpace const & space_bottom,
410 string labelwidthstring,
413 /* these things are for search and replace */
415 /** sets the selection over the number of characters of string,
418 void setSelectionOverString(BufferView *, string const & str);
420 /** simple replacing. The font of the first selected character
423 void replaceSelectionWithString(BufferView *, string const & str);
425 /// needed to insert the selection
426 void insertStringAsLines(BufferView *, string const & str);
427 /// needed to insert the selection
428 void insertStringAsParagraphs(BufferView *, string const & str);
430 /// Find next inset of some specified type.
431 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
432 string const & contents = string()) const;
435 /* for the greater insets */
437 /// returns false if inset wasn't found
438 bool updateInset(BufferView *, Inset *);
440 void checkParagraph(BufferView *, Paragraph * par,
441 Paragraph::size_type pos);
443 int numberOfCell(Paragraph * par,
444 Paragraph::size_type pos) const;
446 void removeTableRow(LyXCursor & cursor) const;
448 bool isEmptyTableCell() const;
450 void toggleAppendix(BufferView *);
452 int workWidth(BufferView *) const;
454 void computeBidiTables(Buffer const *, Row * row) const;
456 /// Maps positions in the visual string to positions in logical string.
458 Paragraph::size_type log2vis(Paragraph::size_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 Paragraph::size_type vis2log(Paragraph::size_type pos) const {
468 if (bidi_start == -1)
471 return vis2log_list[pos-bidi_start];
475 Paragraph::size_type bidi_level(Paragraph::size_type pos) const {
476 if (bidi_start == -1)
479 return bidi_levels[pos-bidi_start];
483 bool bidi_InRange(Paragraph::size_type pos) const {
484 return bidi_start == -1 ||
485 (bidi_start <= pos && pos <= bidi_end);
489 mutable Row * firstrow;
491 mutable Row * lastrow;
493 /** Copybuffer for copy environment type.
494 Asger has learned that this should be a buffer-property instead
495 Lgb has learned that 'char' is a lousy type for non-characters
497 LyXTextClass::size_type copylayouttype;
499 /** inserts a new row behind the specified row, increments
500 the touched counters */
501 void insertRow(Row * row, Paragraph * par,
502 Paragraph::size_type pos) const;
503 /** removes the row and reset the touched counters */
504 void removeRow(Row * row) const;
506 /** remove all following rows of the paragraph of the specified row. */
507 void removeParagraph(Row * row) const;
509 /** insert the specified paragraph behind the specified row */
510 void insertParagraph(BufferView *,
511 Paragraph * par, Row * row) const;
513 /** appends the implizit specified paragraph behind the specified row,
514 * start at the implizit given position */
515 void appendParagraph(BufferView *, Row * row) const;
518 void breakAgain(BufferView *, Row * row) const;
520 void breakAgainOneRow(BufferView *, Row * row);
521 /// Calculate and set the height of the row
522 void setHeightOfRow(BufferView *, Row * row_ptr) const;
524 /** this calculates the specified parameters. needed when setting
525 * the cursor and when creating a visible row */
526 void prepareToPrint(BufferView *, Row * row, float & x,
527 float & fill_separator,
529 float & fill_label_hfill,
530 bool bidi = true) const;
533 void deleteEmptyParagraphMechanism(BufferView *,
534 LyXCursor const & old_cursor) const;
537 /** Updates all counters starting BEHIND the row. Changed paragraphs
538 * with a dynamic left margin will be rebroken. */
539 void updateCounters(BufferView *, Row * row) const;
542 void setCounter(Buffer const *, Paragraph * par) const;
545 * some low level functions
549 int singleWidth(BufferView *, Paragraph * par,
550 Paragraph::size_type pos) const;
552 int singleWidth(BufferView *, Paragraph * par,
553 Paragraph::size_type pos, char c) const;
555 void draw(BufferView *, Row const * row,
556 Paragraph::size_type & pos,
557 int offset, float & x, bool cleared);
559 /// get the next breakpoint in a given paragraph
560 Paragraph::size_type nextBreakPoint(BufferView *, Row const * row,
562 /// returns the minimum space a row needs on the screen in pixel
563 int fill(BufferView *, Row * row, int workwidth) const;
565 /** returns the minimum space a manual label needs on the
567 int labelFill(BufferView *, Row const * row) const;
571 beginningOfMainBody(Buffer const *, Paragraph const * par) const;
573 /** Returns the left beginning of the text.
574 This information cannot be taken from the layouts-objekt, because
575 in LaTeX the beginning of the text fits in some cases
576 (for example sections) exactly the label-width.
578 int leftMargin(BufferView *, Row const * row) const;
580 int rightMargin(Buffer const *, Row const * row) const;
582 int labelEnd (BufferView *, Row const * row) const;
584 /** returns the number of separators in the specified row.
585 The separator on the very last column doesnt count
587 int numberOfSeparators(Buffer const *, Row const * row) const;
589 /** returns the number of hfills in the specified row. The
590 LyX-Hfill is a LaTeX \hfill so that the hfills at the
591 beginning and at the end were ignored. This is {\em MUCH}
592 more usefull than not to ignore!
594 int numberOfHfills(Buffer const *, Row const * row) const;
596 /// like NumberOfHfills, but only those in the manual label!
597 int numberOfLabelHfills(Buffer const *, Row const * row) const;
598 /** returns true, if a expansion is needed. Rules are given by
601 bool hfillExpansion(Buffer const *, Row const * row_ptr,
602 Paragraph::size_type pos) const;
606 mutable std::vector<Paragraph::size_type> log2vis_list;
609 mutable std::vector<Paragraph::size_type> vis2log_list;
612 mutable std::vector<Paragraph::size_type> bidi_levels;
615 mutable Paragraph::size_type bidi_start;
618 mutable Paragraph::size_type bidi_end;
621 mutable bool bidi_same_direction;
624 unsigned char transformChar(unsigned char c, Paragraph * par,
625 Paragraph::size_type pos) const;
627 /** returns the paragraph position of the last character in the
630 Paragraph::size_type rowLast(Row const * row) const;
632 Paragraph::size_type rowLastPrintable(Row const * row) const;
638 // special owner functions
640 Paragraph * ownerParagraph() const;
642 Paragraph * ownerParagraph(Paragraph *) const;
643 // set it searching first for the right owner using the paragraph id
644 Paragraph * ownerParagraph(int id, Paragraph *) const;
648 /* returns a pointer to the row near the specified y-coordinate
649 * (relative to the whole text). y is set to the real beginning
652 Row * LyXText::getRowNearY(int & y) const
654 // If possible we should optimize this method. (Lgb)
655 Row * tmprow = firstrow;
658 while (tmprow->next() && tmpy + tmprow->height() <= y) {
659 tmpy += tmprow->height();
660 tmprow = tmprow->next();
663 y = tmpy; // return the real y