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 *);
57 void init(BufferView *);
59 mutable int number_of_rows;
63 mutable unsigned int width;
64 /// the current font settings
65 mutable LyXFont current_font;
67 mutable LyXFont real_current_font;
68 /// first visible pixel-row is set from LyXScreen!!!
71 BufferView * bv_owner;
73 InsetText * inset_owner;
76 LyXFont const GetFont(Buffer const *, LyXParagraph * par,
77 LyXParagraph::size_type pos) const;
79 void SetCharFont(Buffer const *, LyXParagraph * par,
80 LyXParagraph::size_type pos,
81 LyXFont const & font);
82 /// returns a pointer to the very first LyXParagraph
83 LyXParagraph * FirstParagraph() const;
85 /// what you expect when pressing <enter> at cursor position
86 void BreakParagraph(BufferView *, char keep_layout = 0);
88 /** set layout over selection and make a total rebreak of
91 LyXParagraph * SetLayout(BufferView *, LyXCursor & actual_cursor,
92 LyXCursor & selection_start,
93 LyXCursor & selection_end,
94 LyXTextClass::size_type layout);
95 void SetLayout(BufferView *, LyXTextClass::size_type layout);
98 void MakeFontEntriesLayoutSpecific(Buffer const *, LyXParagraph * par);
100 /** increment depth over selection and make a total rebreak of those
103 void IncDepth(BufferView *);
105 /** decrement depth over selection and make a total rebreak of those
107 void DecDepth(BufferView *);
109 /** Get the depth at current cursor position
111 int GetDepth() const { return cursor.par()->GetDepth(); }
113 /** set font over selection and make a total rebreak of those
115 toggleall defaults to false.
117 void SetFont(BufferView *, LyXFont const &, bool toggleall = false);
119 /** deletes and inserts again all paragaphs between the cursor
120 and the specified par. The Cursor is needed to set the refreshing
122 This function is needed after SetLayout and SetFont etc.
124 void RedoParagraphs(BufferView *, LyXCursor const & cursor,
125 LyXParagraph const * end_par) const;
127 void RedoParagraph(BufferView *) const;
130 void ToggleFree(BufferView *, LyXFont const &, bool toggleall = false);
132 /** recalculates the heights of all previous rows of the
133 specified paragraph. needed, if the last characters font
136 void RedoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
138 /** forces the redrawing of a paragraph. Needed when manipulating a
141 void RedoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
143 /** insert a character, moves all the following breaks in the
144 same Paragraph one to the right and make a little rebreak
146 void InsertChar(BufferView *, char c);
148 void InsertInset(BufferView *, Inset * inset);
150 /** Completes the insertion with a full rebreak.
151 Returns true if something was broken. */
152 bool FullRebreak(BufferView *);
156 LyXParagraph::footnote_flag GetFootnoteFlag(int row);
159 Row * need_break_row;
161 mutable long refresh_y;
169 mutable Row * refresh_row;
173 /** wether the screen needs a refresh,
174 starting with refresh_y
176 mutable text_status status;
178 /** returns a pointer to the row near the specified y-coordinate
179 (relative to the whole text). y is set to the real beginning
182 Row * GetRowNearY(long & y) const;
184 /** returns the column near the specified x-coordinate of the row
185 x is set to the real beginning of this column
187 int GetColumnNearX(BufferView *, Row * row,
188 int & x, bool & boundary) const;
190 /** returns a pointer to a specified row. y is set to the beginning
193 Row * GetRow(LyXParagraph * par,
194 LyXParagraph::size_type pos, long & y) const;
196 /** returns the height of a default row, needed for scrollbar
198 int DefaultHeight() const;
201 Later this variable has to be removed. There should be now internal
202 cursor in a text (and thus not in a buffer). By keeping this it is
203 (I think) impossible to have several views with the same buffer, but
204 the cursor placed at different places.
206 Since the LyXText now has been moved from Buffer to BufferView
207 it should not be absolutely needed to move the cursor...
209 mutable LyXCursor cursor;
211 /* the selection cursor */
213 mutable bool selection;
215 mutable bool mark_set;
218 mutable LyXCursor sel_cursor;
220 LyXCursor sel_start_cursor;
222 mutable LyXCursor sel_end_cursor;
223 /// needed for the toggling
224 LyXCursor last_sel_cursor;
226 LyXCursor toggle_cursor;
228 LyXCursor toggle_end_cursor;
230 /// need the selection cursor:
233 void ClearSelection() const;
235 string const selectionAsString(Buffer const *) const;
237 /// just selects the word the cursor is in
238 void SelectWord(BufferView *);
240 /** 'selects" the next word, where the cursor is not in
241 and returns this word as string. THe cursor will be moved
242 to the beginning of this word.
243 With SelectSelectedWord can this be highlighted really
245 string const SelectNextWord(BufferView *, float & value) const;
247 void SelectSelectedWord(BufferView *);
249 void SetCursor(BufferView *, LyXParagraph * par,
250 LyXParagraph::size_type pos,
252 bool boundary = false) const;
254 void SetCursor(BufferView *, LyXCursor &, LyXParagraph * par,
255 LyXParagraph::size_type pos,
256 bool boundary = false) const;
258 void SetCursorIntern(BufferView *, LyXParagraph * par,
259 LyXParagraph::size_type pos,
261 bool boundary = false) const;
263 void SetCurrentFont(BufferView *) const;
266 bool IsBoundary(Buffer const *, LyXParagraph * par,
267 LyXParagraph::size_type pos) const;
269 bool IsBoundary(Buffer const *, LyXParagraph * par,
270 LyXParagraph::size_type pos,
271 LyXFont const & font) const;
274 void SetCursorFromCoordinates(BufferView *, int x, long y) const;
276 void SetCursorFromCoordinates(BufferView *, LyXCursor &,
277 int x, long y) const;
279 void CursorUp(BufferView *) const;
281 void CursorDown(BufferView *) const;
283 void CursorLeft(BufferView *, bool internal = true) const;
285 void CursorRight(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 *);
321 text_capitalization = 1,
325 /// Change the case of the word at cursor position.
326 void ChangeWordCase(BufferView *, TextCase action);
328 /** returns a printed row in a pixmap. The y value is needed to
329 decide, wether it is selected text or not. This is a strange
332 void GetVisibleRow(BufferView *, int y_offset, int x_offset,
333 Row * row_ptr, long y, bool cleared=false);
338 void ToggleFootnote(BufferView *);
340 void OpenStuff(BufferView *);
342 void OpenFootnotes();
344 void OpenFootnote(BufferView *);
346 void CloseFootnotes();
348 void CloseFootnote(BufferView *);
350 /** turn the selection into a new environment. If there is no
351 selection, create an empty environment
353 void InsertFootnoteEnvironment(BufferView *,
354 LyXParagraph::footnote_kind kind);
356 void MeltFootnoteEnvironment(BufferView *);
359 void CutSelection(BufferView *, bool = true);
361 void CopySelection(BufferView *);
363 void PasteSelection(BufferView *);
365 void copyEnvironmentType();
367 void pasteEnvironmentType(BufferView *);
369 void InsertFootnote();
371 void InsertMarginpar();
375 void InsertTabular();
377 /** the DTP switches for paragraphs. LyX will store the top settings
378 always in the first physical paragraph, the bottom settings in the
379 last. When a paragraph is broken, the top settings rest, the bottom
380 settings are given to the new one. So I can make shure, they do not
381 duplicate themself (and you cannnot make dirty things with them! )
383 void SetParagraph(BufferView *,
384 bool line_top, bool line_bottom,
385 bool pagebreak_top, bool pagebreak_bottom,
386 VSpace const & space_top,
387 VSpace const & space_bottom,
389 string labelwidthstring,
392 void SetParagraphExtraOpt(BufferView *, int type,
393 string const & width,
394 string const & widthp,
395 int alignment, bool hfill,
396 bool start_minipage);
398 /* these things are for search and replace */
400 /** returns true if the specified string is at the specified
403 bool IsStringInText(LyXParagraph * par,
404 LyXParagraph::size_type pos,
405 string const & str) const;
406 /** sets the selection over the number of characters of string,
409 void SetSelectionOverString(BufferView *, string const & str);
411 /** simple replacing. The font of the first selected character
414 void ReplaceSelectionWithString(BufferView *, string const & str);
416 /** if the string can be found: return true and set the cursor to
418 bool SearchForward(BufferView *, string const & str) const;
420 bool SearchBackward(BufferView *, string const & str) const;
422 /// needed to insert the selection
423 void InsertStringA(BufferView *, string const & str);
424 /// needed to insert the selection
425 void InsertStringB(BufferView *, string const & str);
427 /// usefull when texing from within LyX
428 bool GotoNextError(BufferView *) const;
430 /// just another feature :)
431 bool GotoNextNote(BufferView *) const;
433 /* for the greater insets */
435 /// returns false if inset wasn't found
436 bool UpdateInset(BufferView *, Inset *);
438 void CheckParagraph(BufferView *, LyXParagraph * par,
439 LyXParagraph::size_type pos);
441 int NumberOfCell(LyXParagraph * par,
442 LyXParagraph::size_type pos) const;
444 LyXParagraph * GetParFromID(int id);
447 /// returns false if no undo possible
448 bool TextUndo(BufferView *);
449 /// returns false if no redo possible
450 bool TextRedo(BufferView *);
451 /// used by TextUndo/TextRedo
452 bool TextHandleUndo(BufferView *, Undo * undo);
453 /// makes sure the next operation will be stored
455 /// this is dangerous and for internal use only
457 /// this is dangerous and for internal use only
459 /// the flag used by FinishUndo();
460 mutable bool undo_finished;
464 void SetUndo(Buffer *, Undo::undo_kind kind,
465 LyXParagraph const * before,
466 LyXParagraph const * end) const;
468 void SetRedo(Buffer *, Undo::undo_kind kind,
469 LyXParagraph const * before,
470 LyXParagraph const * end);
472 Undo * CreateUndo(Buffer *, Undo::undo_kind kind,
473 LyXParagraph const * before,
474 LyXParagraph const * end) const;
475 /// for external use in lyx_cb.C
476 void SetCursorParUndo(Buffer *);
478 void RemoveTableRow(LyXCursor & cursor) const;
480 bool IsEmptyTableCell() const;
482 void toggleAppendix(BufferView *);
484 int workWidth(BufferView *) const;
486 void ComputeBidiTables(Buffer const *, Row * row) const;
488 /// Maps positions in the visual string to positions in logical string.
490 LyXParagraph::size_type log2vis(LyXParagraph::size_type pos) const {
491 if (bidi_start == -1)
494 return log2vis_list[pos-bidi_start];
497 /// Maps positions in the logical string to positions in visual string.
499 LyXParagraph::size_type vis2log(LyXParagraph::size_type pos) const {
500 if (bidi_start == -1)
503 return vis2log_list[pos-bidi_start];
507 int bidi_level(LyXParagraph::size_type pos) const {
508 if (bidi_start == -1)
511 return bidi_levels[pos-bidi_start];
515 bool bidi_InRange(LyXParagraph::size_type pos) const {
516 return bidi_start == -1 ||
517 (bidi_start <= pos && pos <= bidi_end);
523 mutable Row * firstrow;
525 mutable Row * lastrow;
527 /** Copybuffer for copy environment type.
528 Asger has learned that this should be a buffer-property instead
529 Lgb has learned that 'char' is a lousy type for non-characters
531 LyXTextClass::size_type copylayouttype;
533 /** inserts a new row behind the specified row, increments
534 the touched counters */
535 void InsertRow(Row * row, LyXParagraph * par,
536 LyXParagraph::size_type pos) const;
537 /** removes the row and reset the touched counters */
538 void RemoveRow(Row * row) const;
540 /** remove all following rows of the paragraph of the specified row. */
541 void RemoveParagraph(Row * row) const;
543 /** insert the specified paragraph behind the specified row */
544 void InsertParagraph(BufferView *,
545 LyXParagraph * par, Row * row) const;
547 /** appends the implizit specified paragraph behind the specified row,
548 * start at the implizit given position */
549 void AppendParagraph(BufferView *, Row * row) const;
552 void BreakAgain(BufferView *, Row * row) const;
554 void BreakAgainOneRow(BufferView *, Row * row);
555 /// Calculate and set the height of the row
556 void SetHeightOfRow(BufferView *, Row * row_ptr) const;
558 /** this calculates the specified parameters. needed when setting
559 * the cursor and when creating a visible row */
560 void PrepareToPrint(BufferView *, Row * row, float & x,
561 float & fill_separator,
563 float & fill_label_hfill,
564 bool bidi = true) const;
567 void DeleteEmptyParagraphMechanism(BufferView *,
568 LyXCursor const & old_cursor) const;
570 /** Updates all counters starting BEHIND the row. Changed paragraphs
571 * with a dynamic left margin will be rebroken. */
572 void UpdateCounters(BufferView *, Row * row) const;
574 void SetCounter(Buffer const *, LyXParagraph * par) const;
577 * some low level functions
581 int SingleWidth(BufferView *, LyXParagraph * par,
582 LyXParagraph::size_type pos) const;
584 int SingleWidth(BufferView *, LyXParagraph * par,
585 LyXParagraph::size_type pos, char c) const;
587 void draw(BufferView *, Row const * row,
588 LyXParagraph::size_type & pos,
589 int offset, float & x, bool cleared);
591 /// get the next breakpoint in a given paragraph
592 LyXParagraph::size_type NextBreakPoint(BufferView *, Row const * row,
594 /// returns the minimum space a row needs on the screen in pixel
595 int Fill(BufferView *, Row * row, int workwidth) const;
597 /** returns the minimum space a manual label needs on the
599 int LabelFill(BufferView *, Row const * row) const;
602 LyXParagraph::size_type
603 BeginningOfMainBody(Buffer const *, LyXParagraph const * par) const;
605 /** Returns the left beginning of the text.
606 This information cannot be taken from the layouts-objekt, because
607 in LaTeX the beginning of the text fits in some cases
608 (for example sections) exactly the label-width.
610 int LeftMargin(BufferView *, Row const * row) const;
612 int RightMargin(Buffer const *, Row const * row) const;
614 int LabelEnd (BufferView *, Row const * row) const;
616 /** returns the number of separators in the specified row.
617 The separator on the very last column doesnt count
619 int NumberOfSeparators(Buffer const *, Row const * row) const;
621 /** returns the number of hfills in the specified row. The
622 LyX-Hfill is a LaTeX \hfill so that the hfills at the
623 beginning and at the end were ignored. This is {\em MUCH}
624 more usefull than not to ignore!
626 int NumberOfHfills(Buffer const *, Row const * row) const;
628 /// like NumberOfHfills, but only those in the manual label!
629 int NumberOfLabelHfills(Buffer const *, Row const * row) const;
630 /** returns true, if a expansion is needed. Rules are given by
633 bool HfillExpansion(Buffer const *, Row const * row_ptr,
634 LyXParagraph::size_type pos) const;
638 mutable std::vector<LyXParagraph::size_type> log2vis_list;
641 mutable std::vector<LyXParagraph::size_type> vis2log_list;
644 mutable std::vector<LyXParagraph::size_type> bidi_levels;
647 mutable LyXParagraph::size_type bidi_start;
650 mutable LyXParagraph::size_type bidi_end;
653 mutable bool bidi_same_direction;
656 unsigned char TransformChar(unsigned char c, LyXParagraph * par,
657 LyXParagraph::size_type pos) const;
659 /** returns the paragraph position of the last character in the
662 LyXParagraph::size_type RowLast(Row const * row) const;
664 LyXParagraph::size_type RowLastPrintable(Row const * row) const;
669 // special owner functions
671 LyXParagraph * OwnerParagraph() const;
673 LyXParagraph * OwnerParagraph(LyXParagraph *) const;