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"
31 This class holds the mapping between buffer paragraphs and screen rows.
44 NEED_VERY_LITTLE_REFRESH
54 /// points to Buffer.params
55 BufferParams * parameters;
59 mutable int number_of_rows;
62 /// the current font settings
63 mutable LyXFont current_font;
65 mutable LyXFont real_current_font;
68 LyXText(BufferView *, int paperwidth, Buffer *);
74 void owner(BufferView *);
77 LyXFont GetFont(LyXParagraph * par,
78 LyXParagraph::size_type pos) const;
80 void SetCharFont(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(char keep_layout = 0);
89 /** set layout over selection and make a total rebreak of
92 void SetLayout(LyXTextClass::size_type layout);
95 void MakeFontEntriesLayoutSpecific(LyXParagraph * par);
97 /** increment depth over selection and make a total rebreak of those
102 /** decrement depth over selection and make a total rebreak of those
106 /** Get the depth at current cursor position
108 int GetDepth() const { return cursor.par->GetDepth(); }
110 /** set font over selection and make a total rebreak of those
112 toggleall defaults to false.
114 void SetFont(LyXFont const & font, bool toggleall = false);
116 /** deletes and inserts again all paragaphs between the cursor
117 and the specified par. The Cursor is needed to set the refreshing
119 This function is needed after SetLayout and SetFont etc.
121 void RedoParagraphs(LyXCursor const & cursor,
122 LyXParagraph const * end_par) const;
124 void RedoParagraph() const;
127 void ToggleFree(LyXFont const & font, bool toggleall = false);
129 /** recalculates the heights of all previous rows of the
130 specified paragraph. needed, if the last characters font
133 void RedoHeightOfParagraph(LyXCursor const & cursor);
135 /** forces the redrawing of a paragraph. Needed when manipulating a
138 void RedoDrawingOfParagraph(LyXCursor const & cursor);
140 /** insert a character, moves all the following breaks in the
141 same Paragraph one to the right and make a little rebreak
143 void InsertChar(char c);
145 void InsertInset(Inset * inset);
147 /// completes the insertion with a full rebreak
151 LyXParagraph::footnote_flag GetFootnoteFlag(int row);
153 Row * need_break_row;
155 mutable long refresh_y;
163 mutable Row * refresh_row;
167 /** wether the screen needs a refresh,
168 starting with refresh_y
170 mutable text_status status;
172 /** returns a pointer to the row near the specified y-coordinate
173 (relative to the whole text). y is set to the real beginning
176 Row * GetRowNearY(long & y) const;
178 /** returns the column near the specified x-coordinate of the row
179 x is set to the real beginning of this column
181 int GetColumnNearX(Row * row, int & x) const;
183 /** returns a pointer to a specified row. y is set to the beginning
186 Row * GetRow(LyXParagraph * par,
187 LyXParagraph::size_type pos, long & y) const;
188 /** returns the height of a default row, needed for scrollbar
190 int DefaultHeight() const;
193 Later this variable has to be removed. There should be now internal
194 cursor in a text (and thus not in a buffer). By keeping this it is
195 (I think) impossible to have several views with the same buffer, but
196 the cursor placed at different places.
198 Since the LyXText now has been moved from Buffer to BufferView
199 it should not be absolutely needed to move the cursor...
201 mutable LyXCursor cursor;
203 /* the selection cursor */
205 mutable bool selection;
207 mutable bool mark_set;
210 mutable LyXCursor sel_cursor;
212 LyXCursor sel_start_cursor;
214 mutable LyXCursor sel_end_cursor;
215 /// needed for the toggling
216 LyXCursor last_sel_cursor;
218 LyXCursor toggle_cursor;
220 LyXCursor toggle_end_cursor;
222 /// need the selection cursor:
225 void ClearSelection() const;
227 /// just selects the word the cursor is in
230 /** 'selects" the next word, where the cursor is not in
231 and returns this word as string. THe cursor will be moved
232 to the beginning of this word.
233 With SelectSelectedWord can this be highlighted really
235 char * SelectNextWord(float & value);
237 void SelectSelectedWord();
239 void SetCursor(LyXParagraph * par,
240 LyXParagraph::size_type pos,
241 bool setfont = true) const;
243 void SetCursorIntern(LyXParagraph * par,
244 LyXParagraph::size_type pos,
245 bool setfont = true) const;
247 void SetCursorFromCoordinates(int x, long y) const;
248 void SetCursorFromCoordinates(LyXCursor &, int x, long y) const;
250 void CursorUp() const;
252 void CursorDown() const;
254 void CursorLeft() const;
256 void CursorRight() const;
258 void CursorLeftOneWord() const;
260 void CursorRightOneWord() const;
262 void CursorUpParagraph() const;
264 void CursorDownParagraph() const;
266 void CursorHome() const;
268 void CursorEnd() const;
270 void CursorTab() const;
272 void CursorTop() const;
274 void CursorBottom() const;
280 void DeleteWordForward();
282 void DeleteWordBackward();
284 void DeleteLineForward();
286 int SelectWordWhenUnderCursor();
290 text_capitalization = 1,
293 /// Change the case of the word at cursor position.
294 void ChangeWordCase(TextCase action);
296 /** returns a printed row in a pixmap. The y value is needed to
297 decide, wether it is selected text or not. This is a strange
300 void GetVisibleRow(int offset, Row * row_ptr, long y);
304 void ToggleFootnote();
308 void OpenFootnotes();
312 void CloseFootnotes();
314 void CloseFootnote();
316 /** turn the selection into a new environment. If there is no
317 selection, create an empty environment
319 void InsertFootnoteEnvironment(LyXParagraph::footnote_kind kind);
321 void MeltFootnoteEnvironment();
323 void CutSelection(bool = true);
325 void CopySelection();
327 void PasteSelection();
329 void copyEnvironmentType();
331 void pasteEnvironmentType();
333 void InsertFootnote();
335 void InsertMarginpar();
339 void InsertTabular();
341 /** the DTP switches for paragraphs. LyX will store the top settings
342 always in the first physical paragraph, the bottom settings in the
343 last. When a paragraph is broken, the top settings rest, the bottom
344 settings are given to the new one. So I can make shure, they do not
345 duplicate themself (and you cannnot make dirty things with them! )
347 void SetParagraph(bool line_top, bool line_bottom,
348 bool pagebreak_top, bool pagebreak_bottom,
349 VSpace const & space_top,
350 VSpace const & space_bottom,
352 string labelwidthstring,
354 void SetParagraphExtraOpt(int type,
357 int alignment, bool hfill,
358 bool start_minipage);
360 /* these things are for search and replace */
362 /** returns true if the specified string is at the specified
365 bool IsStringInText(LyXParagraph * par,
366 LyXParagraph::size_type pos,
367 char const * str) const;
368 /** sets the selection over the number of characters of string,
371 void SetSelectionOverString(char const * str);
373 /** simple replacing. The font of the first selected character
376 void ReplaceSelectionWithString(char const * str);
378 /** if the string can be found: return true and set the cursor to
380 bool SearchForward(char const * str) const;
381 bool SearchBackward(char const * str) const;
383 /// needed to insert the selection
384 void InsertStringA(string const & str);
385 /// needed to insert the selection
386 void InsertStringB(string const & str);
388 /// usefull when texing from within LyX
389 bool GotoNextError() const;
391 /// just another feature :)
392 bool GotoNextNote() const;
394 /* for the greater insets */
396 /// returns 0 if inset wasn't found
397 int UpdateInset(Inset * inset);
399 void CheckParagraph(LyXParagraph * par,
400 LyXParagraph::size_type pos);
402 int NumberOfCell(LyXParagraph * par,
403 LyXParagraph::size_type pos) const;
404 /* table stuff -- begin*/
406 /** all table features of the text-class are put together in
407 this function. Possible values of feature are defined in table.h
409 void TableFeatures(int feature, string const & val) const;
411 void TableFeatures(int feature) const;
413 /** pos points at the beginning of the next cell (if there is one)
415 int WidthOfCell(LyXParagraph * par,
416 LyXParagraph::size_type & pos) const;
418 void CheckParagraphInTable(LyXParagraph * par,
419 LyXParagraph::size_type pos);
421 void InsertCharInTable(char c);
423 void BackspaceInTable();
425 bool HitInTable(Row * row, int x) const;
427 bool MouseHitInTable(int x, long y) const;
428 /* table stuff -- end*/
430 LyXParagraph * GetParFromID(int id);
433 /// returns false if no undo possible
435 /// returns false if no redo possible
437 /// used by TextUndo/TextRedo
438 bool TextHandleUndo(Undo * undo);
439 /// makes sure the next operation will be stored
441 /// this is dangerous and for internal use only
443 /// this is dangerous and for internal use only
445 /// the flag used by FinishUndo();
446 mutable bool undo_finished;
450 void SetUndo(Undo::undo_kind kind,
451 LyXParagraph const * before,
452 LyXParagraph const * end) const;
454 void SetRedo(Undo::undo_kind kind,
455 LyXParagraph const * before,
456 LyXParagraph const * end);
458 Undo * CreateUndo(Undo::undo_kind kind,
459 LyXParagraph const * before,
460 LyXParagraph const * end) const;
461 /// for external use in lyx_cb.C
462 void SetCursorParUndo();
464 void CursorLeftIntern() const;
466 void CursorRightIntern() const;
468 void RemoveTableRow(LyXCursor * cursor) const;
470 bool IsEmptyTableCell() const;
472 void toggleAppendix();
474 unsigned short paperWidth() const { return paperwidth; }
479 /// width of the paper
480 unsigned short paperwidth;
483 mutable Row * firstrow;
485 mutable Row * lastrow;
487 /** Copybuffer for copy environment type
488 Asger has learned that this should be a buffer-property instead
489 Lgb has learned that 'char' is a lousy type for non-characters
491 LyXTextClass::size_type copylayouttype;
493 /// the currentrow is needed to access rows faster*/
494 mutable Row * currentrow; // pointer to the current row
495 /// position in the text
496 mutable long currentrow_y;
498 /** inserts a new row behind the specified row, increments
499 * the touched counters */
500 void InsertRow(Row * row, LyXParagraph * par,
501 LyXParagraph::size_type pos) const;
502 /** removes the row and reset the touched counters */
503 void RemoveRow(Row * row) const;
505 /** remove all following rows of the paragraph of the specified row. */
506 void RemoveParagraph(Row * row) const;
508 /** insert the specified paragraph behind the specified row */
509 void InsertParagraph(LyXParagraph * par, Row * row) const;
511 /** appends the implizit specified paragraph behind the specified row,
512 * start at the implizit given position */
513 void AppendParagraph(Row * row) const;
516 void BreakAgain(Row * row) const;
518 void BreakAgainOneRow(Row * row);
519 /// Calculate and set the height of the row
520 void SetHeightOfRow(Row * row_ptr) const;
522 /** this calculates the specified parameters. needed when setting
523 * the cursor and when creating a visible row */
524 void PrepareToPrint(Row * row, float & x,
525 float & fill_separator,
527 float & fill_label_hfill,
528 bool bidi = true) const;
530 void DeleteEmptyParagraphMechanism(LyXCursor const & old_cursor) const;
532 /** Updates all counters starting BEHIND the row. Changed paragraphs
533 * with a dynamic left margin will be rebroken. */
534 void UpdateCounters(Row * row) const;
536 void SetCounter(LyXParagraph * par) const;
539 * some low level functions
543 int SingleWidth(LyXParagraph * par,
544 LyXParagraph::size_type pos) const;
546 int SingleWidth(LyXParagraph * par,
547 LyXParagraph::size_type pos, char c) const;
549 void draw(Row const * row,
550 LyXParagraph::size_type & pos,
551 int offset, float & x);
553 /// get the next breakpoint in a given paragraph
554 LyXParagraph::size_type NextBreakPoint(Row const * row,
556 /// returns the minimum space a row needs on the screen in pixel
557 int Fill(Row const * row, int paperwidth) const;
559 /** returns the minimum space a manual label needs on the
561 int LabelFill(Row const * row) const;
564 LyXParagraph::size_type BeginningOfMainBody(LyXParagraph * par) const;
566 /** Returns the left beginning of the text.
567 This information cannot be taken from the layouts-objekt, because
568 in LaTeX the beginning of the text fits in some cases
569 (for example sections) exactly the label-width.
571 int LeftMargin(Row const * row) const;
573 int RightMargin(Row const * row) const;
575 int LabelEnd (Row const * row) const;
577 /** returns the number of separators in the specified row.
578 The separator on the very last column doesnt count
580 int NumberOfSeparators(Row const * row) const;
582 /** returns the number of hfills in the specified row. The
583 LyX-Hfill is a LaTeX \hfill so that the hfills at the
584 beginning and at the end were ignored. This is {\em MUCH}
585 more usefull than not to ignore!
587 int NumberOfHfills(Row const * row) const;
589 /// like NumberOfHfills, but only those in the manual label!
590 int NumberOfLabelHfills(Row const * row) const;
592 /** returns true, if a expansion is needed. Rules are given by
595 bool HfillExpansion(Row const * row_ptr,
596 LyXParagraph::size_type pos) const;
599 mutable std::vector<LyXParagraph::size_type> log2vis_list;
602 mutable std::vector<LyXParagraph::size_type> vis2log_list;
605 mutable LyXParagraph::size_type bidi_start;
608 mutable bool bidi_same_direction;
611 void ComputeBidiTables(Row *row) const;
614 void ComputeBidiTablesFromTo(Row *row,
615 LyXParagraph::size_type from,
616 LyXParagraph::size_type to,
617 LyXParagraph::size_type offset) const;
619 /// Maps positions in the visual string to positions in logical string.
621 LyXParagraph::size_type log2vis(LyXParagraph::size_type pos) const {
622 if (bidi_start == -1)
625 return log2vis_list[pos-bidi_start];
628 /// Maps positions in the logical string to positions in visual string.
630 LyXParagraph::size_type vis2log(LyXParagraph::size_type pos) const {
631 if (bidi_start == -1)
634 return vis2log_list[pos-bidi_start];
638 unsigned char TransformChar(unsigned char c, Letter_Form form) const;
641 unsigned char TransformChar(unsigned char c, LyXParagraph * par,
642 LyXParagraph::size_type pos) const;
644 /** returns the paragraph position of the last character in the
647 LyXParagraph::size_type RowLast(Row const * row) const;