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 LyXFont GetFont(Buffer const *, LyXParagraph * par,
75 LyXParagraph::size_type pos) const;
77 void SetCharFont(Buffer const *, LyXParagraph * par,
78 LyXParagraph::size_type pos,
79 LyXFont const & font);
80 /// returns a pointer to the very first LyXParagraph
81 LyXParagraph * FirstParagraph() const;
83 /// what you expect when pressing <enter> at cursor position
84 void BreakParagraph(BufferView *, char keep_layout = 0);
86 /** set layout over selection and make a total rebreak of
89 LyXParagraph * SetLayout(BufferView *, LyXCursor & actual_cursor,
90 LyXCursor & selection_start,
91 LyXCursor & selection_end,
92 LyXTextClass::size_type layout);
93 void SetLayout(BufferView *, LyXTextClass::size_type layout);
96 void MakeFontEntriesLayoutSpecific(Buffer const *, LyXParagraph * par);
98 /** increment depth over selection and make a total rebreak of those
101 void IncDepth(BufferView *);
103 /** decrement depth over selection and make a total rebreak of those
105 void DecDepth(BufferView *);
107 /** Get the depth at current cursor position
109 int GetDepth() const { return cursor.par()->GetDepth(); }
111 /** set font over selection and make a total rebreak of those
113 toggleall defaults to false.
115 void SetFont(BufferView *, LyXFont const &, bool toggleall = false);
117 /** deletes and inserts again all paragaphs between the cursor
118 and the specified par. The Cursor is needed to set the refreshing
120 This function is needed after SetLayout and SetFont etc.
122 void RedoParagraphs(BufferView *, LyXCursor const & cursor,
123 LyXParagraph const * end_par) const;
125 void RedoParagraph(BufferView *) const;
128 void ToggleFree(BufferView *, LyXFont const &, bool toggleall = false);
130 /** recalculates the heights of all previous rows of the
131 specified paragraph. needed, if the last characters font
134 void RedoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
136 /** forces the redrawing of a paragraph. Needed when manipulating a
139 void RedoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
141 /** insert a character, moves all the following breaks in the
142 same Paragraph one to the right and make a little rebreak
144 void InsertChar(BufferView *, char c);
146 void InsertInset(BufferView *, Inset * inset);
148 /** Completes the insertion with a full rebreak.
149 Returns true if something was broken. */
150 bool FullRebreak(BufferView *);
154 LyXParagraph::footnote_flag GetFootnoteFlag(int row);
157 Row * need_break_row;
159 mutable long refresh_y;
167 mutable Row * refresh_row;
171 /** wether the screen needs a refresh,
172 starting with refresh_y
174 mutable text_status status;
176 /** returns a pointer to the row near the specified y-coordinate
177 (relative to the whole text). y is set to the real beginning
180 Row * GetRowNearY(long & y) const;
182 /** returns the column near the specified x-coordinate of the row
183 x is set to the real beginning of this column
185 int GetColumnNearX(BufferView *, Row * row, int & x, bool & boundary) const;
187 /** returns a pointer to a specified row. y is set to the beginning
190 Row * GetRow(LyXParagraph * par,
191 LyXParagraph::size_type pos, long & y) const;
193 /** returns the height of a default row, needed for scrollbar
195 int DefaultHeight() const;
198 Later this variable has to be removed. There should be now internal
199 cursor in a text (and thus not in a buffer). By keeping this it is
200 (I think) impossible to have several views with the same buffer, but
201 the cursor placed at different places.
203 Since the LyXText now has been moved from Buffer to BufferView
204 it should not be absolutely needed to move the cursor...
206 mutable LyXCursor cursor;
208 /* the selection cursor */
210 mutable bool selection;
212 mutable bool mark_set;
215 mutable LyXCursor sel_cursor;
217 LyXCursor sel_start_cursor;
219 mutable LyXCursor sel_end_cursor;
220 /// needed for the toggling
221 LyXCursor last_sel_cursor;
223 LyXCursor toggle_cursor;
225 LyXCursor toggle_end_cursor;
227 /// need the selection cursor:
230 void ClearSelection() const;
232 string selectionAsString(Buffer const *) const;
234 /// just selects the word the cursor is in
235 void SelectWord(BufferView *);
237 /** 'selects" the next word, where the cursor is not in
238 and returns this word as string. THe cursor will be moved
239 to the beginning of this word.
240 With SelectSelectedWord can this be highlighted really
242 char * SelectNextWord(BufferView *, float & value);
244 void SelectSelectedWord(BufferView *);
246 void SetCursor(BufferView *, LyXParagraph * par,
247 LyXParagraph::size_type pos,
249 bool boundary = false) const;
251 void SetCursor(BufferView *, LyXCursor &, LyXParagraph * par,
252 LyXParagraph::size_type pos,
253 bool boundary = false) const;
255 void SetCursorIntern(BufferView *, LyXParagraph * par,
256 LyXParagraph::size_type pos,
258 bool boundary = false) const;
260 void SetCurrentFont(BufferView *) const;
263 bool IsBoundary(Buffer const *, LyXParagraph * par,
264 LyXParagraph::size_type pos) const;
266 bool IsBoundary(Buffer const *, LyXParagraph * par,
267 LyXParagraph::size_type pos,
268 LyXFont const & font) const;
271 void SetCursorFromCoordinates(BufferView *, int x, long y) const;
272 void SetCursorFromCoordinates(BufferView *, LyXCursor &,
273 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);
335 void ToggleFootnote(BufferView *);
337 void OpenStuff(BufferView *);
339 void OpenFootnotes();
341 void OpenFootnote(BufferView *);
343 void CloseFootnotes();
345 void CloseFootnote(BufferView *);
347 /** turn the selection into a new environment. If there is no
348 selection, create an empty environment
350 void InsertFootnoteEnvironment(BufferView *,
351 LyXParagraph::footnote_kind kind);
353 void MeltFootnoteEnvironment(BufferView *);
356 void CutSelection(BufferView *, bool = true);
358 void CopySelection(BufferView *);
360 void PasteSelection(BufferView *);
362 void copyEnvironmentType();
364 void pasteEnvironmentType(BufferView *);
366 void InsertFootnote();
368 void InsertMarginpar();
372 void InsertTabular();
374 /** the DTP switches for paragraphs. LyX will store the top settings
375 always in the first physical paragraph, the bottom settings in the
376 last. When a paragraph is broken, the top settings rest, the bottom
377 settings are given to the new one. So I can make shure, they do not
378 duplicate themself (and you cannnot make dirty things with them! )
380 void SetParagraph(BufferView *,
381 bool line_top, bool line_bottom,
382 bool pagebreak_top, bool pagebreak_bottom,
383 VSpace const & space_top,
384 VSpace const & space_bottom,
386 string labelwidthstring,
388 void SetParagraphExtraOpt(BufferView *, int type,
391 int alignment, bool hfill,
392 bool start_minipage);
394 /* these things are for search and replace */
396 /** returns true if the specified string is at the specified
399 bool IsStringInText(LyXParagraph * par,
400 LyXParagraph::size_type pos,
401 char const * str) const;
402 /** sets the selection over the number of characters of string,
405 void SetSelectionOverString(BufferView *, char const * str);
407 /** simple replacing. The font of the first selected character
410 void ReplaceSelectionWithString(BufferView *, char const * str);
412 /** if the string can be found: return true and set the cursor to
414 bool SearchForward(BufferView *, char const * str) const;
415 bool SearchBackward(BufferView *, char const * str) const;
417 /// needed to insert the selection
418 void InsertStringA(BufferView *, string const & str);
419 /// needed to insert the selection
420 void InsertStringB(BufferView *, string const & str);
422 /// usefull when texing from within LyX
423 bool GotoNextError(BufferView *) const;
425 /// just another feature :)
426 bool GotoNextNote(BufferView *) const;
428 /* for the greater insets */
430 /// returns false if inset wasn't found
431 bool UpdateInset(BufferView *, Inset *);
433 void CheckParagraph(BufferView *, LyXParagraph * par,
434 LyXParagraph::size_type pos);
436 int NumberOfCell(LyXParagraph * par,
437 LyXParagraph::size_type pos) const;
438 /* table stuff -- begin*/
440 /** all table features of the text-class are put together in
441 this function. Possible values of feature are defined in table.h
443 void TableFeatures(BufferView *, int feature, string const & val) const;
445 void TableFeatures(BufferView *, int feature) const;
447 /** pos points at the beginning of the next cell (if there is one)
449 int WidthOfCell(BufferView *, LyXParagraph * par,
450 LyXParagraph::size_type & pos) const;
452 void CheckParagraphInTable(BufferView *, LyXParagraph * par,
453 LyXParagraph::size_type pos);
455 void InsertCharInTable(BufferView *, char c);
457 void BackspaceInTable(BufferView *);
459 bool HitInTable(BufferView *, Row * row, int x) const;
461 bool MouseHitInTable(BufferView *, int x, long y) const;
462 /* table stuff -- end*/
464 LyXParagraph * GetParFromID(int id);
467 /// returns false if no undo possible
468 bool TextUndo(BufferView *);
469 /// returns false if no redo possible
470 bool TextRedo(BufferView *);
471 /// used by TextUndo/TextRedo
472 bool TextHandleUndo(BufferView *, Undo * undo);
473 /// makes sure the next operation will be stored
475 /// this is dangerous and for internal use only
477 /// this is dangerous and for internal use only
479 /// the flag used by FinishUndo();
480 mutable bool undo_finished;
484 void SetUndo(Buffer *, Undo::undo_kind kind,
485 LyXParagraph const * before,
486 LyXParagraph const * end) const;
488 void SetRedo(Buffer *, Undo::undo_kind kind,
489 LyXParagraph const * before,
490 LyXParagraph const * end);
492 Undo * CreateUndo(Buffer *, Undo::undo_kind kind,
493 LyXParagraph const * before,
494 LyXParagraph const * end) const;
495 /// for external use in lyx_cb.C
496 void SetCursorParUndo(Buffer *);
498 void RemoveTableRow(LyXCursor & cursor) const;
500 bool IsEmptyTableCell() const;
502 void toggleAppendix(BufferView *);
504 int workWidth(BufferView *) 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;