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.
46 NEED_VERY_LITTLE_REFRESH
56 /// points to Buffer.params
57 BufferParams * parameters;
61 mutable int number_of_rows;
64 /// the current font settings
65 mutable LyXFont current_font;
67 mutable LyXFont real_current_font;
70 LyXText(BufferView *, int paperwidth, Buffer *);
76 void owner(BufferView *);
79 LyXFont GetFont(LyXParagraph * par,
80 LyXParagraph::size_type pos) const;
82 void SetCharFont(LyXParagraph * par,
83 LyXParagraph::size_type pos,
84 LyXFont const & font);
85 /// returns a pointer to the very first LyXParagraph
86 LyXParagraph * FirstParagraph() const;
88 /// what you expect when pressing <enter> at cursor position
89 void BreakParagraph(char keep_layout = 0);
91 /** set layout over selection and make a total rebreak of
94 void SetLayout(LyXTextClass::size_type layout);
97 void MakeFontEntriesLayoutSpecific(LyXParagraph * par);
99 /** increment depth over selection and make a total rebreak of those
104 /** decrement depth over selection and make a total rebreak of those
108 /** Get the depth at current cursor position
110 int GetDepth() const { return cursor.par->GetDepth(); }
112 /** set font over selection and make a total rebreak of those
114 toggleall defaults to false.
116 void SetFont(LyXFont const & font, bool toggleall = false);
118 /** deletes and inserts again all paragaphs between the cursor
119 and the specified par. The Cursor is needed to set the refreshing
121 This function is needed after SetLayout and SetFont etc.
123 void RedoParagraphs(LyXCursor const & cursor,
124 LyXParagraph const * end_par) const;
126 void RedoParagraph() const;
129 void ToggleFree(LyXFont const & font, bool toggleall = false);
131 /** recalculates the heights of all previous rows of the
132 specified paragraph. needed, if the last characters font
135 void RedoHeightOfParagraph(LyXCursor const & cursor);
137 /** forces the redrawing of a paragraph. Needed when manipulating a
140 void RedoDrawingOfParagraph(LyXCursor const & cursor);
142 /** insert a character, moves all the following breaks in the
143 same Paragraph one to the right and make a little rebreak
145 void InsertChar(char c);
147 void InsertInset(Inset * inset);
149 /// completes the insertion with a full rebreak
153 LyXParagraph::footnote_flag GetFootnoteFlag(int row);
155 Row * need_break_row;
157 mutable long refresh_y;
165 mutable Row * refresh_row;
169 /** wether the screen needs a refresh,
170 starting with refresh_y
172 mutable text_status status;
174 /** returns a pointer to the row near the specified y-coordinate
175 (relative to the whole text). y is set to the real beginning
178 Row * GetRowNearY(long & y) const;
180 /** returns the column near the specified x-coordinate of the row
181 x is set to the real beginning of this column
183 int GetColumnNearX(Row * row, int & x) const;
185 /** returns a pointer to a specified row. y is set to the beginning
188 Row * GetRow(LyXParagraph * par,
189 LyXParagraph::size_type pos, long & y) const;
190 /** returns the height of a default row, needed for scrollbar
192 int DefaultHeight() const;
195 Later this variable has to be removed. There should be now internal
196 cursor in a text (and thus not in a buffer). By keeping this it is
197 (I think) impossible to have several views with the same buffer, but
198 the cursor placed at different places.
200 Since the LyXText now has been moved from Buffer to BufferView
201 it should not be absolutely needed to move the cursor...
203 mutable LyXCursor cursor;
205 /* the selection cursor */
207 mutable bool selection;
209 mutable bool mark_set;
212 mutable LyXCursor sel_cursor;
214 LyXCursor sel_start_cursor;
216 mutable LyXCursor sel_end_cursor;
217 /// needed for the toggling
218 LyXCursor last_sel_cursor;
220 LyXCursor toggle_cursor;
222 LyXCursor toggle_end_cursor;
224 /// need the selection cursor:
227 void ClearSelection() const;
229 /// just selects the word the cursor is in
232 /** 'selects" the next word, where the cursor is not in
233 and returns this word as string. THe cursor will be moved
234 to the beginning of this word.
235 With SelectSelectedWord can this be highlighted really
237 char * SelectNextWord(float & value);
239 void SelectSelectedWord();
241 void SetCursor(LyXParagraph * par,
242 LyXParagraph::size_type pos,
243 bool setfont = true) const;
245 void SetCursorIntern(LyXParagraph * par,
246 LyXParagraph::size_type pos,
247 bool setfont = true) const;
249 void SetCursorFromCoordinates(int x, long y) const;
250 void SetCursorFromCoordinates(LyXCursor &, int x, long y) const;
252 void CursorUp() const;
254 void CursorDown() const;
256 void CursorLeft() const;
258 void CursorRight() const;
260 void CursorLeftOneWord() const;
262 void CursorRightOneWord() const;
264 void CursorUpParagraph() const;
266 void CursorDownParagraph() const;
268 void CursorHome() const;
270 void CursorEnd() const;
272 void CursorTab() const;
274 void CursorTop() const;
276 void CursorBottom() const;
282 void DeleteWordForward();
284 void DeleteWordBackward();
286 void DeleteLineForward();
288 int SelectWordWhenUnderCursor();
292 text_capitalization = 1,
295 /// Change the case of the word at cursor position.
296 void ChangeWordCase(TextCase action);
298 /** returns a printed row in a pixmap. The y value is needed to
299 decide, wether it is selected text or not. This is a strange
302 void GetVisibleRow(int offset, Row * row_ptr, long y);
306 void ToggleFootnote();
310 void OpenFootnotes();
314 void CloseFootnotes();
316 void CloseFootnote();
318 /** turn the selection into a new environment. If there is no
319 selection, create an empty environment
321 void InsertFootnoteEnvironment(LyXParagraph::footnote_kind kind);
323 void MeltFootnoteEnvironment();
325 void CutSelection(bool = true);
327 void CopySelection();
329 void PasteSelection();
331 void copyEnvironmentType();
333 void pasteEnvironmentType();
335 void InsertFootnote();
337 void InsertMarginpar();
341 void InsertTabular();
343 /** the DTP switches for paragraphs. LyX will store the top settings
344 always in the first physical paragraph, the bottom settings in the
345 last. When a paragraph is broken, the top settings rest, the bottom
346 settings are given to the new one. So I can make shure, they do not
347 duplicate themself (and you cannnot make dirty things with them! )
349 void SetParagraph(bool line_top, bool line_bottom,
350 bool pagebreak_top, bool pagebreak_bottom,
351 VSpace const & space_top,
352 VSpace const & space_bottom,
354 string labelwidthstring,
356 void SetParagraphExtraOpt(int type,
359 int alignment, bool hfill,
360 bool start_minipage);
362 /* these things are for search and replace */
364 /** returns true if the specified string is at the specified
367 bool IsStringInText(LyXParagraph * par,
368 LyXParagraph::size_type pos,
369 char const * str) const;
370 /** sets the selection over the number of characters of string,
373 void SetSelectionOverString(char const * str);
375 /** simple replacing. The font of the first selected character
378 void ReplaceSelectionWithString(char const * str);
380 /** if the string can be found: return true and set the cursor to
382 bool SearchForward(char const * str) const;
383 bool SearchBackward(char const * str) const;
385 /// needed to insert the selection
386 void InsertStringA(string const & str);
387 /// needed to insert the selection
388 void InsertStringB(string const & str);
390 /// usefull when texing from within LyX
391 bool GotoNextError() const;
393 /// just another feature :)
394 bool GotoNextNote() const;
396 /** needed to switch between different classes this works
397 for a list of paragraphs beginning with the specified par
398 return value is the number of wrong conversions
400 int SwitchLayoutsBetweenClasses(LyXTextClassList::size_type class1,
401 LyXTextClassList::size_type class2,
404 /* for the greater insets */
406 /// returns 0 if inset wasn't found
407 int UpdateInset(Inset * inset);
409 void CheckParagraph(LyXParagraph * par,
410 LyXParagraph::size_type pos);
412 int NumberOfCell(LyXParagraph * par,
413 LyXParagraph::size_type pos) const;
414 /* table stuff -- begin*/
416 /** all table features of the text-class are put together in
417 this function. Possible values of feature are defined in table.h
419 void TableFeatures(int feature, string const & val) const;
421 void TableFeatures(int feature) const;
423 /** pos points at the beginning of the next cell (if there is one)
425 int WidthOfCell(LyXParagraph * par,
426 LyXParagraph::size_type & pos) const;
428 void CheckParagraphInTable(LyXParagraph * par,
429 LyXParagraph::size_type pos);
431 void InsertCharInTable(char c);
433 void BackspaceInTable();
435 bool HitInTable(Row * row, int x) const;
437 bool MouseHitInTable(int x, long y) const;
438 /* table stuff -- end*/
440 LyXParagraph * GetParFromID(int id);
443 /// returns false if no undo possible
445 /// returns false if no redo possible
447 /// used by TextUndo/TextRedo
448 bool TextHandleUndo(Undo * undo);
449 /// makes sure the next operation will be stored
451 /// this is dangerous and for internal use only
453 /// this is dangerous and for internal use only
455 /// the flag used by FinishUndo();
456 mutable bool undo_finished;
460 void SetUndo(Undo::undo_kind kind,
461 LyXParagraph const * before,
462 LyXParagraph const * end) const;
464 void SetRedo(Undo::undo_kind kind,
465 LyXParagraph const * before,
466 LyXParagraph const * end);
468 Undo * CreateUndo(Undo::undo_kind kind,
469 LyXParagraph const * before,
470 LyXParagraph const * end) const;
471 /// for external use in lyx_cb.C
472 void SetCursorParUndo();
474 void CursorLeftIntern() const;
476 void CursorRightIntern() const;
478 void RemoveTableRow(LyXCursor * cursor) const;
480 bool IsEmptyTableCell() const;
482 void toggleAppendix();
484 unsigned short paperWidth() const { return paperwidth; }
489 /// width of the paper
490 unsigned short paperwidth;
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 /// the currentrow is needed to access rows faster*/
504 mutable Row * currentrow; // pointer to the current row
505 /// position in the text
506 mutable long currentrow_y;
508 /** inserts a new row behind the specified row, increments
509 * the touched counters */
510 void InsertRow(Row * row, LyXParagraph * par,
511 LyXParagraph::size_type pos) const;
512 /** removes the row and reset the touched counters */
513 void RemoveRow(Row * row) const;
515 /** remove all following rows of the paragraph of the specified row. */
516 void RemoveParagraph(Row * row) const;
518 /** insert the specified paragraph behind the specified row */
519 void InsertParagraph(LyXParagraph * par, Row * row) const;
521 /** appends the implizit specified paragraph behind the specified row,
522 * start at the implizit given position */
523 void AppendParagraph(Row * row) const;
526 void BreakAgain(Row * row) const;
528 void BreakAgainOneRow(Row * row);
529 /// Calculate and set the height of the row
530 void SetHeightOfRow(Row * row_ptr) const;
532 /** this calculates the specified parameters. needed when setting
533 * the cursor and when creating a visible row */
534 void PrepareToPrint(Row * row, float & x,
535 float & fill_separator,
537 float & fill_label_hfill,
538 bool bidi = true) const;
540 void DeleteEmptyParagraphMechanism(LyXCursor const & old_cursor) const;
542 /** Updates all counters starting BEHIND the row. Changed paragraphs
543 * with a dynamic left margin will be rebroken. */
544 void UpdateCounters(Row * row) const;
546 void SetCounter(LyXParagraph * par) const;
549 * some low level functions
553 int SingleWidth(LyXParagraph * par,
554 LyXParagraph::size_type pos) const;
556 int SingleWidth(LyXParagraph * par,
557 LyXParagraph::size_type pos, char c) const;
559 void draw(Row const * row,
560 LyXParagraph::size_type & pos,
561 int offset, float & x);
563 /// get the next breakpoint in a given paragraph
564 LyXParagraph::size_type NextBreakPoint(Row const * row,
566 /// returns the minimum space a row needs on the screen in pixel
567 int Fill(Row const * row, int paperwidth) const;
569 /** returns the minimum space a manual label needs on the
571 int LabelFill(Row const * row) const;
574 LyXParagraph::size_type BeginningOfMainBody(LyXParagraph * par) const;
576 /** Returns the left beginning of the text.
577 This information cannot be taken from the layouts-objekt, because
578 in LaTeX the beginning of the text fits in some cases
579 (for example sections) exactly the label-width.
581 int LeftMargin(Row const * row) const;
583 int RightMargin(Row const * row) const;
585 int LabelEnd (Row const * row) const;
587 /** returns the number of separators in the specified row.
588 The separator on the very last column doesnt count
590 int NumberOfSeparators(Row const * row) const;
592 /** returns the number of hfills in the specified row. The
593 LyX-Hfill is a LaTeX \hfill so that the hfills at the
594 beginning and at the end were ignored. This is {\em MUCH}
595 more usefull than not to ignore!
597 int NumberOfHfills(Row const * row) const;
599 /// like NumberOfHfills, but only those in the manual label!
600 int NumberOfLabelHfills(Row const * row) const;
602 /** returns true, if a expansion is needed. Rules are given by
605 bool HfillExpansion(Row const * row_ptr,
606 LyXParagraph::size_type pos) const;
609 mutable vector<LyXParagraph::size_type> log2vis_list;
612 mutable vector<LyXParagraph::size_type> vis2log_list;
615 mutable LyXParagraph::size_type bidi_start;
618 mutable bool bidi_same_direction;
621 void ComputeBidiTables(Row *row) const;
624 void ComputeBidiTablesFromTo(Row *row,
625 LyXParagraph::size_type from,
626 LyXParagraph::size_type to,
627 LyXParagraph::size_type offset) const;
629 /// Maps positions in the visual string to positions in logical string.
631 LyXParagraph::size_type log2vis(LyXParagraph::size_type pos) const {
632 if (bidi_start == -1)
635 return log2vis_list[pos-bidi_start];
638 /// Maps positions in the logical string to positions in visual string.
640 LyXParagraph::size_type vis2log(LyXParagraph::size_type pos) const {
641 if (bidi_start == -1)
644 return vis2log_list[pos-bidi_start];
648 unsigned char TransformChar(unsigned char c, Letter_Form form) const;
651 unsigned char TransformChar(unsigned char c, LyXParagraph * par,
652 LyXParagraph::size_type pos) const;
654 /** returns the paragraph position of the last character in the
657 LyXParagraph::size_type RowLast(Row const * row) const;