2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2000 The LyX Team.
10 * ====================================================== */
21 #include "lyxcursor.h"
22 #include "lyxparagraph.h"
33 This class holds the mapping between buffer paragraphs and screen rows.
44 NEED_VERY_LITTLE_REFRESH,
50 LyXText(BufferView *);
56 void init(BufferView *);
58 mutable int number_of_rows;
61 mutable unsigned int width;
62 /// the current font settings
63 mutable LyXFont current_font;
65 mutable LyXFont real_current_font;
66 /// first visible pixel-row is set from LyXScreen!!!
69 BufferView * bv_owner;
71 InsetText * inset_owner;
74 // void owner(BufferView *);
77 LyXFont GetFont(Buffer const *, LyXParagraph * par,
78 LyXParagraph::size_type pos) const;
80 void SetCharFont(Buffer const *, LyXParagraph * par,
81 LyXParagraph::size_type pos,
82 LyXFont const & font);
83 /// returns a pointer to the very first LyXParagraph
84 LyXParagraph * FirstParagraph() const;
86 /// what you expect when pressing <enter> at cursor position
87 void BreakParagraph(BufferView *, char keep_layout = 0);
89 /** set layout over selection and make a total rebreak of
92 LyXParagraph * SetLayout(BufferView *, LyXCursor & actual_cursor,
93 LyXCursor & selection_start,
94 LyXCursor & selection_end,
95 LyXTextClass::size_type layout);
96 void SetLayout(BufferView *, LyXTextClass::size_type layout);
99 void MakeFontEntriesLayoutSpecific(Buffer const *, LyXParagraph * par);
101 /** increment depth over selection and make a total rebreak of those
104 void IncDepth(BufferView *);
106 /** decrement depth over selection and make a total rebreak of those
108 void DecDepth(BufferView *);
110 /** Get the depth at current cursor position
112 int GetDepth() const { return cursor.par()->GetDepth(); }
114 /** set font over selection and make a total rebreak of those
116 toggleall defaults to false.
118 void SetFont(BufferView *, LyXFont const &, bool toggleall = false);
120 /** deletes and inserts again all paragaphs between the cursor
121 and the specified par. The Cursor is needed to set the refreshing
123 This function is needed after SetLayout and SetFont etc.
125 void RedoParagraphs(BufferView *, LyXCursor const & cursor,
126 LyXParagraph const * end_par) const;
128 void RedoParagraph(BufferView *) const;
131 void ToggleFree(BufferView *, LyXFont const &, bool toggleall = false);
133 /** recalculates the heights of all previous rows of the
134 specified paragraph. needed, if the last characters font
137 void RedoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
139 /** forces the redrawing of a paragraph. Needed when manipulating a
142 void RedoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
144 /** insert a character, moves all the following breaks in the
145 same Paragraph one to the right and make a little rebreak
147 void InsertChar(BufferView *, char c);
149 void InsertInset(BufferView *, Inset * inset);
151 /** Completes the insertion with a full rebreak.
152 Returns true if something was broken. */
153 bool FullRebreak(BufferView *);
156 LyXParagraph::footnote_flag GetFootnoteFlag(int row);
158 Row * need_break_row;
160 mutable long refresh_y;
168 mutable Row * refresh_row;
172 /** wether the screen needs a refresh,
173 starting with refresh_y
175 mutable text_status status;
177 /** returns a pointer to the row near the specified y-coordinate
178 (relative to the whole text). y is set to the real beginning
181 Row * GetRowNearY(long & y) const;
183 /** returns the column near the specified x-coordinate of the row
184 x is set to the real beginning of this column
186 int GetColumnNearX(BufferView *, Row * row, int & x, bool & boundary) const;
188 /** returns a pointer to a specified row. y is set to the beginning
191 Row * GetRow(LyXParagraph * par,
192 LyXParagraph::size_type pos, long & y) const;
194 /** returns the height of a default row, needed for scrollbar
196 int DefaultHeight() const;
199 Later this variable has to be removed. There should be now internal
200 cursor in a text (and thus not in a buffer). By keeping this it is
201 (I think) impossible to have several views with the same buffer, but
202 the cursor placed at different places.
204 Since the LyXText now has been moved from Buffer to BufferView
205 it should not be absolutely needed to move the cursor...
207 mutable LyXCursor cursor;
209 /* the selection cursor */
211 mutable bool selection;
213 mutable bool mark_set;
216 mutable LyXCursor sel_cursor;
218 LyXCursor sel_start_cursor;
220 mutable LyXCursor sel_end_cursor;
221 /// needed for the toggling
222 LyXCursor last_sel_cursor;
224 LyXCursor toggle_cursor;
226 LyXCursor toggle_end_cursor;
228 /// need the selection cursor:
231 void ClearSelection() const;
233 string selectionAsString(Buffer const *) const;
235 /// just selects the word the cursor is in
236 void SelectWord(BufferView *);
238 /** 'selects" the next word, where the cursor is not in
239 and returns this word as string. THe cursor will be moved
240 to the beginning of this word.
241 With SelectSelectedWord can this be highlighted really
243 char * SelectNextWord(BufferView *, float & value);
245 void SelectSelectedWord(BufferView *);
247 void SetCursor(BufferView *, LyXParagraph * par,
248 LyXParagraph::size_type pos,
250 bool boundary = false) const;
252 void SetCursor(BufferView *, LyXCursor &, LyXParagraph * par,
253 LyXParagraph::size_type pos,
254 bool boundary = false) const;
256 void SetCursorIntern(BufferView *, LyXParagraph * par,
257 LyXParagraph::size_type pos,
259 bool boundary = false) const;
261 void SetCurrentFont(BufferView *) const;
264 bool IsBoundary(Buffer const *, LyXParagraph * par,
265 LyXParagraph::size_type pos) const;
267 bool IsBoundary(Buffer const *, LyXParagraph * par,
268 LyXParagraph::size_type pos,
269 LyXFont const & font) const;
272 void SetCursorFromCoordinates(BufferView *, int x, long y) const;
273 void SetCursorFromCoordinates(BufferView *, LyXCursor &, int x, long y) const;
275 void CursorUp(BufferView *) const;
277 void CursorDown(BufferView *) const;
279 void CursorLeft(BufferView *, bool internal = true) const;
281 void CursorRight(BufferView *, bool internal = true) const;
283 void CursorLeftIntern(BufferView *, bool internal = true) const;
285 void CursorRightIntern(BufferView *, bool internal = true) const;
287 void CursorLeftOneWord(BufferView *) const;
289 void CursorRightOneWord(BufferView *) const;
291 void CursorUpParagraph(BufferView *) const;
293 void CursorDownParagraph(BufferView *) const;
295 void CursorHome(BufferView *) const;
297 void CursorEnd(BufferView *) const;
299 void CursorTab(BufferView *) const;
301 void CursorTop(BufferView *) const;
303 void CursorBottom(BufferView *) const;
305 void Delete(BufferView *);
307 void Backspace(BufferView *);
309 void DeleteWordForward(BufferView *);
311 void DeleteWordBackward(BufferView *);
313 void DeleteLineForward(BufferView *);
315 bool SelectWordWhenUnderCursor(BufferView *);
319 text_capitalization = 1,
322 /// Change the case of the word at cursor position.
323 void ChangeWordCase(BufferView *, TextCase action);
325 /** returns a printed row in a pixmap. The y value is needed to
326 decide, wether it is selected text or not. This is a strange
329 void GetVisibleRow(BufferView *, int y_offset, int x_offset,
330 Row * row_ptr, long y, bool cleared=false);
334 void ToggleFootnote(BufferView *);
336 void OpenStuff(BufferView *);
338 void OpenFootnotes();
340 void OpenFootnote(BufferView *);
342 void CloseFootnotes();
344 void CloseFootnote(BufferView *);
346 /** turn the selection into a new environment. If there is no
347 selection, create an empty environment
349 void InsertFootnoteEnvironment(BufferView *,
350 LyXParagraph::footnote_kind kind);
352 void MeltFootnoteEnvironment(BufferView *);
354 void CutSelection(BufferView *, bool = true);
356 void CopySelection(BufferView *);
358 void PasteSelection(BufferView *);
360 void copyEnvironmentType();
362 void pasteEnvironmentType(BufferView *);
364 void InsertFootnote();
366 void InsertMarginpar();
370 void InsertTabular();
372 /** the DTP switches for paragraphs. LyX will store the top settings
373 always in the first physical paragraph, the bottom settings in the
374 last. When a paragraph is broken, the top settings rest, the bottom
375 settings are given to the new one. So I can make shure, they do not
376 duplicate themself (and you cannnot make dirty things with them! )
378 void SetParagraph(BufferView *,
379 bool line_top, bool line_bottom,
380 bool pagebreak_top, bool pagebreak_bottom,
381 VSpace const & space_top,
382 VSpace const & space_bottom,
384 string labelwidthstring,
386 void SetParagraphExtraOpt(BufferView *, int type,
389 int alignment, bool hfill,
390 bool start_minipage);
392 /* these things are for search and replace */
394 /** returns true if the specified string is at the specified
397 bool IsStringInText(LyXParagraph * par,
398 LyXParagraph::size_type pos,
399 char const * str) const;
400 /** sets the selection over the number of characters of string,
403 void SetSelectionOverString(BufferView *, char const * str);
405 /** simple replacing. The font of the first selected character
408 void ReplaceSelectionWithString(BufferView *, char const * str);
410 /** if the string can be found: return true and set the cursor to
412 bool SearchForward(BufferView *, char const * str) const;
413 bool SearchBackward(BufferView *, char const * str) const;
415 /// needed to insert the selection
416 void InsertStringA(BufferView *, string const & str);
417 /// needed to insert the selection
418 void InsertStringB(BufferView *, string const & str);
420 /// usefull when texing from within LyX
421 bool GotoNextError(BufferView *) const;
423 /// just another feature :)
424 bool GotoNextNote(BufferView *) const;
426 /* for the greater insets */
428 /// returns false if inset wasn't found
429 bool UpdateInset(BufferView *, Inset *);
431 void CheckParagraph(BufferView *, LyXParagraph * par,
432 LyXParagraph::size_type pos);
434 int NumberOfCell(LyXParagraph * par,
435 LyXParagraph::size_type pos) const;
436 /* table stuff -- begin*/
438 /** all table features of the text-class are put together in
439 this function. Possible values of feature are defined in table.h
441 void TableFeatures(BufferView *, int feature, string const & val) const;
443 void TableFeatures(BufferView *, int feature) const;
445 /** pos points at the beginning of the next cell (if there is one)
447 int WidthOfCell(BufferView *, LyXParagraph * par,
448 LyXParagraph::size_type & pos) const;
450 void CheckParagraphInTable(BufferView *, LyXParagraph * par,
451 LyXParagraph::size_type pos);
453 void InsertCharInTable(BufferView *, char c);
455 void BackspaceInTable(BufferView *);
457 bool HitInTable(BufferView *, Row * row, int x) const;
459 bool MouseHitInTable(BufferView *, int x, long y) const;
460 /* table stuff -- end*/
462 LyXParagraph * GetParFromID(int id);
465 /// returns false if no undo possible
466 bool TextUndo(BufferView *);
467 /// returns false if no redo possible
468 bool TextRedo(BufferView *);
469 /// used by TextUndo/TextRedo
470 bool TextHandleUndo(BufferView *, Undo * undo);
471 /// makes sure the next operation will be stored
473 /// this is dangerous and for internal use only
475 /// this is dangerous and for internal use only
477 /// the flag used by FinishUndo();
478 mutable bool undo_finished;
482 void SetUndo(Buffer *, Undo::undo_kind kind,
483 LyXParagraph const * before,
484 LyXParagraph const * end) const;
486 void SetRedo(Buffer *, Undo::undo_kind kind,
487 LyXParagraph const * before,
488 LyXParagraph const * end);
490 Undo * CreateUndo(Buffer *, Undo::undo_kind kind,
491 LyXParagraph const * before,
492 LyXParagraph const * end) const;
493 /// for external use in lyx_cb.C
494 void SetCursorParUndo(Buffer *);
496 void RemoveTableRow(LyXCursor & cursor) const;
498 bool IsEmptyTableCell() const;
500 void toggleAppendix(BufferView *);
502 int workWidth(BufferView *) const;
504 // Buffer * buffer() const;
506 void ComputeBidiTables(Buffer const *, Row * row) const;
508 /// Maps positions in the visual string to positions in logical string.
510 LyXParagraph::size_type log2vis(LyXParagraph::size_type pos) const {
511 if (bidi_start == -1)
514 return log2vis_list[pos-bidi_start];
517 /// Maps positions in the logical string to positions in visual string.
519 LyXParagraph::size_type vis2log(LyXParagraph::size_type pos) const {
520 if (bidi_start == -1)
523 return vis2log_list[pos-bidi_start];
527 int bidi_level(LyXParagraph::size_type pos) const {
528 if (bidi_start == -1)
531 return bidi_levels[pos-bidi_start];
535 bool bidi_InRange(LyXParagraph::size_type pos) const {
536 return bidi_start == -1 ||
537 (bidi_start <= pos && pos <= bidi_end);
543 mutable Row * firstrow;
545 mutable Row * lastrow;
547 /** Copybuffer for copy environment type
548 Asger has learned that this should be a buffer-property instead
549 Lgb has learned that 'char' is a lousy type for non-characters
551 LyXTextClass::size_type copylayouttype;
553 /** inserts a new row behind the specified row, increments
554 * the touched counters */
555 void InsertRow(Row * row, LyXParagraph * par,
556 LyXParagraph::size_type pos) const;
557 /** removes the row and reset the touched counters */
558 void RemoveRow(Row * row) const;
560 /** remove all following rows of the paragraph of the specified row. */
561 void RemoveParagraph(Row * row) const;
563 /** insert the specified paragraph behind the specified row */
564 void InsertParagraph(BufferView *, LyXParagraph * par, Row * row) const;
566 /** appends the implizit specified paragraph behind the specified row,
567 * start at the implizit given position */
568 void AppendParagraph(BufferView *, Row * row) const;
571 void BreakAgain(BufferView *, Row * row) const;
573 void BreakAgainOneRow(BufferView *, Row * row);
574 /// Calculate and set the height of the row
575 void SetHeightOfRow(BufferView *, Row * row_ptr) const;
577 /** this calculates the specified parameters. needed when setting
578 * the cursor and when creating a visible row */
579 void PrepareToPrint(BufferView *, Row * row, float & x,
580 float & fill_separator,
582 float & fill_label_hfill,
583 bool bidi = true) const;
586 void DeleteEmptyParagraphMechanism(BufferView *,
587 LyXCursor const & old_cursor) const;
589 /** Updates all counters starting BEHIND the row. Changed paragraphs
590 * with a dynamic left margin will be rebroken. */
591 void UpdateCounters(BufferView *, Row * row) const;
593 void SetCounter(Buffer const *, LyXParagraph * par) const;
596 * some low level functions
600 int SingleWidth(BufferView *, LyXParagraph * par,
601 LyXParagraph::size_type pos) const;
603 int SingleWidth(BufferView *, LyXParagraph * par,
604 LyXParagraph::size_type pos, char c) const;
606 void draw(BufferView *, Row const * row,
607 LyXParagraph::size_type & pos,
608 int offset, float & x, bool cleared);
610 /// get the next breakpoint in a given paragraph
611 LyXParagraph::size_type NextBreakPoint(BufferView *, Row const * row,
613 /// returns the minimum space a row needs on the screen in pixel
614 int Fill(BufferView *, Row * row, int workwidth) const;
616 /** returns the minimum space a manual label needs on the
618 int LabelFill(BufferView *, Row const * row) const;
621 LyXParagraph::size_type
622 BeginningOfMainBody(Buffer const *, LyXParagraph const * par) const;
624 /** Returns the left beginning of the text.
625 This information cannot be taken from the layouts-objekt, because
626 in LaTeX the beginning of the text fits in some cases
627 (for example sections) exactly the label-width.
629 int LeftMargin(BufferView *, Row const * row) const;
631 int RightMargin(Buffer const *, Row const * row) const;
633 int LabelEnd (BufferView *, Row const * row) const;
635 /** returns the number of separators in the specified row.
636 The separator on the very last column doesnt count
638 int NumberOfSeparators(Buffer const *, Row const * row) const;
640 /** returns the number of hfills in the specified row. The
641 LyX-Hfill is a LaTeX \hfill so that the hfills at the
642 beginning and at the end were ignored. This is {\em MUCH}
643 more usefull than not to ignore!
645 int NumberOfHfills(Buffer const *, Row const * row) const;
647 /// like NumberOfHfills, but only those in the manual label!
648 int NumberOfLabelHfills(Buffer const *, Row const * row) const;
649 /** returns true, if a expansion is needed. Rules are given by
652 bool HfillExpansion(Buffer const *, Row const * row_ptr,
653 LyXParagraph::size_type pos) const;
657 mutable std::vector<LyXParagraph::size_type> log2vis_list;
660 mutable std::vector<LyXParagraph::size_type> vis2log_list;
663 mutable std::vector<LyXParagraph::size_type> bidi_levels;
666 mutable LyXParagraph::size_type bidi_start;
669 mutable LyXParagraph::size_type bidi_end;
672 mutable bool bidi_same_direction;
675 unsigned char TransformChar(unsigned char c, LyXParagraph * par,
676 LyXParagraph::size_type pos) const;
678 /** returns the paragraph position of the last character in the
681 LyXParagraph::size_type RowLast(Row const * row) const;
683 LyXParagraph::size_type RowLastPrintable(Row const * row) const;
688 /// special owner functions
690 LyXParagraph * OwnerParagraph() const;
692 LyXParagraph * OwnerParagraph(LyXParagraph *) const;