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 *);
274 /// returns the inset at cursor (if it exists), 0 otherwise
275 Inset * getInset() const;
277 /** 'selects" the next word, where the cursor is not in
278 and returns this word as string. THe cursor will be moved
279 to the beginning of this word.
280 With SelectSelectedWord can this be highlighted really
282 string const selectNextWord(BufferView *, float & value) const;
284 void selectSelectedWord(BufferView *);
286 void setCursor(BufferView *, Paragraph * par,
287 Paragraph::size_type pos,
289 bool boundary = false) const;
291 void setCursor(BufferView *, LyXCursor &, Paragraph * par,
292 Paragraph::size_type pos,
293 bool boundary = false) const;
295 void setCursorIntern(BufferView *, Paragraph * par,
296 Paragraph::size_type pos,
298 bool boundary = false) const;
300 void setCurrentFont(BufferView *) const;
303 bool isBoundary(Buffer const *, Paragraph * par,
304 Paragraph::size_type pos) const;
306 bool isBoundary(Buffer const *, Paragraph * par,
307 Paragraph::size_type pos,
308 LyXFont const & font) const;
311 void setCursorFromCoordinates(BufferView *, int x, int y) const;
313 void setCursorFromCoordinates(BufferView *, LyXCursor &,
316 void cursorUp(BufferView *) const;
318 void cursorDown(BufferView *) const;
320 void cursorLeft(BufferView *, bool internal = true) const;
322 void cursorRight(BufferView *, bool internal = true) const;
324 void cursorLeftOneWord(BufferView *) const;
326 void cursorLeftOneWord(LyXCursor &) const;
328 void cursorRightOneWord(BufferView *) const;
330 void cursorUpParagraph(BufferView *) const;
332 void cursorDownParagraph(BufferView *) const;
334 void cursorHome(BufferView *) const;
336 void cursorEnd(BufferView *) const;
338 void cursorTab(BufferView *) const;
340 void cursorTop(BufferView *) const;
342 void cursorBottom(BufferView *) const;
344 void Delete(BufferView *);
346 void backspace(BufferView *);
348 void deleteWordForward(BufferView *);
350 void deleteWordBackward(BufferView *);
352 void deleteLineForward(BufferView *);
354 bool selectWordWhenUnderCursor(BufferView *);
360 text_capitalization = 1,
364 /// Change the case of the word at cursor position.
365 void changeCase(BufferView *, TextCase action);
367 void changeRegionCase(BufferView * bview,
368 LyXCursor const & from,
369 LyXCursor const & to,
370 LyXText::TextCase action);
372 void transposeChars(BufferView &);
374 /** returns a printed row in a pixmap. The y value is needed to
375 decide, wether it is selected text or not. This is a strange
378 void getVisibleRow(BufferView *, int y_offset, int x_offset,
379 Row * row_ptr, int y, bool cleared=false);
382 void toggleInset(BufferView *);
384 void cutSelection(BufferView *, bool = true);
386 void copySelection(BufferView *);
388 void pasteSelection(BufferView *);
390 void copyEnvironmentType();
392 void pasteEnvironmentType(BufferView *);
394 void insertFootnote();
396 void insertMarginpar();
400 void insertTabular();
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,
414 string labelwidthstring,
417 /* these things are for search and replace */
419 /** sets the selection over the number of characters of string,
422 void setSelectionOverString(BufferView *, string const & str);
424 /** simple replacing. The font of the first selected character
427 void replaceSelectionWithString(BufferView *, string const & str);
429 /// needed to insert the selection
430 void insertStringAsLines(BufferView *, string const & str);
431 /// needed to insert the selection
432 void insertStringAsParagraphs(BufferView *, string const & str);
434 /// Find next inset of some specified type.
435 bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
436 string const & contents = string()) const;
439 /* for the greater insets */
441 /// returns false if inset wasn't found
442 bool updateInset(BufferView *, Inset *);
444 void checkParagraph(BufferView *, Paragraph * par,
445 Paragraph::size_type pos);
447 int numberOfCell(Paragraph * par,
448 Paragraph::size_type pos) const;
450 void removeTableRow(LyXCursor & cursor) const;
452 bool isEmptyTableCell() const;
454 void toggleAppendix(BufferView *);
456 int workWidth(BufferView *) const;
458 void computeBidiTables(Buffer const *, Row * row) const;
460 /// Maps positions in the visual string to positions in logical string.
462 Paragraph::size_type log2vis(Paragraph::size_type pos) const {
463 if (bidi_start == -1)
466 return log2vis_list[pos-bidi_start];
469 /// Maps positions in the logical string to positions in visual string.
471 Paragraph::size_type vis2log(Paragraph::size_type pos) const {
472 if (bidi_start == -1)
475 return vis2log_list[pos-bidi_start];
479 Paragraph::size_type bidi_level(Paragraph::size_type pos) const {
480 if (bidi_start == -1)
483 return bidi_levels[pos-bidi_start];
487 bool bidi_InRange(Paragraph::size_type pos) const {
488 return bidi_start == -1 ||
489 (bidi_start <= pos && pos <= bidi_end);
493 mutable Row * firstrow;
495 mutable Row * lastrow;
497 /** Copybuffer for copy environment type.
498 Asger has learned that this should be a buffer-property instead
499 Lgb has learned that 'char' is a lousy type for non-characters
501 LyXTextClass::size_type copylayouttype;
503 /** inserts a new row behind the specified row, increments
504 the touched counters */
505 void insertRow(Row * row, Paragraph * par,
506 Paragraph::size_type pos) const;
507 /** removes the row and reset the touched counters */
508 void removeRow(Row * row) const;
510 /** remove all following rows of the paragraph of the specified row. */
511 void removeParagraph(Row * row) const;
513 /** insert the specified paragraph behind the specified row */
514 void insertParagraph(BufferView *,
515 Paragraph * par, Row * row) const;
517 /** appends the implizit specified paragraph behind the specified row,
518 * start at the implizit given position */
519 void appendParagraph(BufferView *, Row * row) const;
522 void breakAgain(BufferView *, Row * row) const;
524 void breakAgainOneRow(BufferView *, Row * row);
525 /// Calculate and set the height of the row
526 void setHeightOfRow(BufferView *, Row * row_ptr) const;
528 /** this calculates the specified parameters. needed when setting
529 * the cursor and when creating a visible row */
530 void prepareToPrint(BufferView *, Row * row, float & x,
531 float & fill_separator,
533 float & fill_label_hfill,
534 bool bidi = true) const;
537 void deleteEmptyParagraphMechanism(BufferView *,
538 LyXCursor const & old_cursor) const;
541 /** Updates all counters starting BEHIND the row. Changed paragraphs
542 * with a dynamic left margin will be rebroken. */
543 void updateCounters(BufferView *, Row * row) const;
546 void setCounter(Buffer const *, Paragraph * par) const;
549 * some low level functions
553 int singleWidth(BufferView *, Paragraph * par,
554 Paragraph::size_type pos) const;
556 int singleWidth(BufferView *, Paragraph * par,
557 Paragraph::size_type pos, char c) const;
559 void draw(BufferView *, Row const * row,
560 Paragraph::size_type & pos,
561 int offset, float & x, bool cleared);
563 /// get the next breakpoint in a given paragraph
564 Paragraph::size_type nextBreakPoint(BufferView *, Row const * row,
566 /// returns the minimum space a row needs on the screen in pixel
567 int fill(BufferView *, Row * row, int workwidth) const;
569 /** returns the minimum space a manual label needs on the
571 int labelFill(BufferView *, Row const * row) const;
575 beginningOfMainBody(Buffer const *, Paragraph const * par) const;
577 /** Returns the left beginning of the text.
578 This information cannot be taken from the layouts-objekt, because
579 in LaTeX the beginning of the text fits in some cases
580 (for example sections) exactly the label-width.
582 int leftMargin(BufferView *, Row const * row) const;
584 int rightMargin(Buffer const *, Row const * row) const;
586 int labelEnd (BufferView *, Row const * row) const;
588 /** returns the number of separators in the specified row.
589 The separator on the very last column doesnt count
591 int numberOfSeparators(Buffer const *, Row const * row) const;
593 /** returns the number of hfills in the specified row. The
594 LyX-Hfill is a LaTeX \hfill so that the hfills at the
595 beginning and at the end were ignored. This is {\em MUCH}
596 more usefull than not to ignore!
598 int numberOfHfills(Buffer const *, Row const * row) const;
600 /// like NumberOfHfills, but only those in the manual label!
601 int numberOfLabelHfills(Buffer const *, Row const * row) const;
602 /** returns true, if a expansion is needed. Rules are given by
605 bool hfillExpansion(Buffer const *, Row const * row_ptr,
606 Paragraph::size_type pos) const;
610 mutable std::vector<Paragraph::size_type> log2vis_list;
613 mutable std::vector<Paragraph::size_type> vis2log_list;
616 mutable std::vector<Paragraph::size_type> bidi_levels;
619 mutable Paragraph::size_type bidi_start;
622 mutable Paragraph::size_type bidi_end;
625 mutable bool bidi_same_direction;
628 unsigned char transformChar(unsigned char c, Paragraph * par,
629 Paragraph::size_type pos) const;
631 /** returns the paragraph position of the last character in the
634 Paragraph::size_type rowLast(Row const * row) const;
636 Paragraph::size_type rowLastPrintable(Row const * row) const;
642 // special owner functions
644 Paragraph * ownerParagraph() const;
646 Paragraph * ownerParagraph(Paragraph *) const;
647 // set it searching first for the right owner using the paragraph id
648 Paragraph * ownerParagraph(int id, Paragraph *) const;
652 /* returns a pointer to the row near the specified y-coordinate
653 * (relative to the whole text). y is set to the real beginning
656 Row * LyXText::getRowNearY(int & y) const
658 // If possible we should optimize this method. (Lgb)
659 Row * tmprow = firstrow;
662 while (tmprow->next() && tmpy + tmprow->height() <= y) {
663 tmpy += tmprow->height();
664 tmprow = tmprow->next();
667 y = tmpy; // return the real y