2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-1999 The LyX Team.
10 * ====================================================== */
21 #include "lyxcursor.h"
22 #include "lyxparagraph.h"
32 This class holds the mapping between buffer paragraphs and screen rows.
45 NEED_VERY_LITTLE_REFRESH
48 /// points to Buffer.params
49 BufferParams * parameters;
53 mutable int number_of_rows;
56 /// the current font settings
57 mutable LyXFont current_font;
59 mutable LyXFont real_current_font;
62 LyXText(BufferView *, int paperwidth, Buffer *);
68 void owner(BufferView *);
71 LyXFont GetFont(LyXParagraph * par,
72 LyXParagraph::size_type pos) const;
74 void SetCharFont(LyXParagraph * par,
75 LyXParagraph::size_type pos,
76 LyXFont const & font);
77 /// returns a pointer to the very first LyXParagraph
78 LyXParagraph * FirstParagraph() const;
80 /// what you expect when pressing <enter> at cursor position
81 void BreakParagraph(char keep_layout = 0);
83 /** set layout over selection and make a total rebreak of
86 void SetLayout(char layout);
89 void MakeFontEntriesLayoutSpecific(LyXParagraph * par);
91 /** increment depth over selection and make a total rebreak of those
96 /** decrement depth over selection and make a total rebreak of those
100 /** Get the depth at current cursor position
102 int GetDepth() const { return cursor.par->GetDepth(); }
104 /** set font over selection and make a total rebreak of those
106 toggleall defaults to false.
108 void SetFont(LyXFont const & font, bool toggleall = false);
110 /** deletes and inserts again all paragaphs between the cursor
111 and the specified par. The Cursor is needed to set the refreshing
113 This function is needed after SetLayout and SetFont etc.
115 void RedoParagraphs(LyXCursor const & cursor,
116 LyXParagraph const * end_par) const;
118 void RedoParagraph() const;
121 void ToggleFree(LyXFont const & font, bool toggleall = false);
123 /** recalculates the heights of all previous rows of the
124 specified paragraph. needed, if the last characters font
127 void RedoHeightOfParagraph(LyXCursor const & cursor);
129 /** forces the redrawing of a paragraph. Needed when manipulating a
132 void RedoDrawingOfParagraph(LyXCursor const & cursor);
134 /** insert a character, moves all the following breaks in the
135 same Paragraph one to the right and make a little rebreak
137 void InsertChar(char c);
139 void InsertInset(Inset * inset);
141 /// completes the insertion with a full rebreak
145 LyXParagraph::footnote_flag GetFootnoteFlag(int row);
147 Row * need_break_row;
149 mutable long refresh_y;
157 mutable Row * refresh_row;
161 /** wether the screen needs a refresh,
162 starting with refresh_y
164 mutable text_status status;
166 /** returns a pointer to the row near the specified y-coordinate
167 (relative to the whole text). y is set to the real beginning
170 Row * GetRowNearY(long & y) const;
172 /** returns the column near the specified x-coordinate of the row
173 x is set to the real beginning of this column
175 int GetColumnNearX(Row * row, int & x) const;
177 /** returns a pointer to a specified row. y is set to the beginning
180 Row * GetRow(LyXParagraph * par,
181 LyXParagraph::size_type pos, long & y) const;
182 /** returns the height of a default row, needed for scrollbar
184 int DefaultHeight() const;
187 Later this variable has to be removed. There should be now internal
188 cursor in a text (and thus not in a buffer). By keeping this it is
189 (I think) impossible to have several views with the same buffer, but
190 the cursor placed at different places.
192 Since the LyXText now has been moved from Buffer to BufferView
193 it should not be absolutely needed to move the cursor...
195 mutable LyXCursor cursor;
197 /* the selection cursor */
199 mutable bool selection;
201 mutable bool mark_set;
204 mutable LyXCursor sel_cursor;
206 LyXCursor sel_start_cursor;
208 mutable LyXCursor sel_end_cursor;
209 /// needed for the toggling
210 LyXCursor last_sel_cursor;
212 LyXCursor toggle_cursor;
214 LyXCursor toggle_end_cursor;
216 /// need the selection cursor:
219 void ClearSelection() const;
221 /// just selects the word the cursor is in
224 /** 'selects" the next word, where the cursor is not in
225 and returns this word as string. THe cursor will be moved
226 to the beginning of this word.
227 With SelectSelectedWord can this be highlighted really
229 char * SelectNextWord(float & value);
231 void SelectSelectedWord();
233 void SetCursor(LyXParagraph * par,
234 LyXParagraph::size_type pos,
235 bool setfont = true) const;
237 void SetCursorIntern(LyXParagraph * par,
238 LyXParagraph::size_type pos,
239 bool setfont = true) const;
241 void SetCursorFromCoordinates(int x, long y) const;
243 void CursorUp() const;
245 void CursorDown() const;
247 void CursorLeft() const;
249 void CursorRight() const;
251 void CursorLeftOneWord() const;
253 void CursorRightOneWord() const;
255 void CursorUpParagraph() const;
257 void CursorDownParagraph() const;
259 void CursorHome() const;
261 void CursorEnd() const;
263 void CursorTab() const;
265 void CursorTop() const;
267 void CursorBottom() const;
273 void DeleteWordForward();
275 void DeleteWordBackward();
277 void DeleteLineForward();
279 int SelectWordWhenUnderCursor();
283 text_capitalization = 1,
286 /// Change the case of the word at cursor position.
287 void ChangeWordCase(TextCase action);
289 /** returns a printed row in a pixmap. The y value is needed to
290 decide, wether it is selected text or not. This is a strange
294 void GetVisibleRow(int offset,
295 Row * row_ptr, long y);
297 void GetVisibleRow(LyXScreen & scr, int offset,
298 Row * row_ptr, long y);
303 void ToggleFootnote();
307 void OpenFootnotes();
311 void CloseFootnotes();
313 void CloseFootnote();
315 /** turn the selection into a new environment. If there is no
316 selection, create an empty environment
318 void InsertFootnoteEnvironment(LyXParagraph::footnote_kind kind);
320 void MeltFootnoteEnvironment();
322 void CutSelection(bool = true);
324 void CopySelection();
326 void PasteSelection();
328 void copyEnvironmentType();
330 void pasteEnvironmentType();
332 void InsertFootnote();
334 void InsertMarginpar();
338 void InsertTabular();
340 /** the DTP switches for paragraphs. LyX will store the top settings
341 always in the first physical paragraph, the bottom settings in the
342 last. When a paragraph is broken, the top settings rest, the bottom
343 settings are given to the new one. So I can make shure, they do not
344 duplicate themself (and you cannnot make dirty things with them! )
346 void SetParagraph(bool line_top, bool line_bottom,
347 bool pagebreak_top, bool pagebreak_bottom,
348 VSpace const & space_top,
349 VSpace const & space_bottom,
351 string labelwidthstring,
353 void SetParagraphExtraOpt(int type,
356 int alignment, bool hfill,
357 bool start_minipage);
359 /* these things are for search and replace */
361 /** returns true if the specified string is at the specified
364 bool IsStringInText(LyXParagraph * par,
365 LyXParagraph::size_type pos,
366 char const * str) const;
367 /** sets the selection over the number of characters of string,
370 void SetSelectionOverString(char const * str);
372 /** simple replacing. The font of the first selected character
375 void ReplaceSelectionWithString(char const * str);
377 /** if the string can be found: return true and set the cursor to
379 bool SearchForward(char const * str) const;
380 bool SearchBackward(char const * str) const;
382 /// needed to insert the selection
383 void InsertStringA(LyXParagraph::TextContainer const & text);
384 /// needed to insert the selection
385 void InsertStringB(LyXParagraph::TextContainer const & text);
386 /// needed to insert the selection
387 void InsertStringA(char const * str);
388 /// needed to insert the selection
389 void InsertStringB(char const * str);
391 /// usefull when texing from within LyX
392 bool GotoNextError() const;
394 /// just another feature :)
395 bool GotoNextNote() const;
397 /** needed to switch between different classes this works
398 for a list of paragraphs beginning with the specified par
399 return value is the number of wrong conversions
401 int SwitchLayoutsBetweenClasses(char class1, char 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
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;
560 void draw(Row const * row,
561 LyXParagraph::size_type & pos,
562 int offset, float & x);
565 void Draw(Row const * row, LyXParagraph::size_type & pos,
567 int offset, float & x);
569 /// get the next breakpoint in a given paragraph
570 LyXParagraph::size_type NextBreakPoint(Row const * row,
572 /// returns the minimum space a row needs on the screen in pixel
573 int Fill(Row const * row, int paperwidth) const;
575 /** returns the minimum space a manual label needs on the
577 int LabelFill(Row const * row) const;
580 LyXParagraph::size_type BeginningOfMainBody(LyXParagraph * par) const;
581 /** Returns the left beginning of the text.
582 This information cannot be taken from the layouts-objekt, because
583 in LaTeX the beginning of the text fits in some cases
584 (for example sections) exactly the label-width.
586 int LeftMargin(Row const * row) const;
588 int RightMargin(Row const * row) const;
590 int LabelEnd (Row const * row) const;
592 /** returns the number of separators in the specified row.
593 The separator on the very last column doesnt count
595 int NumberOfSeparators(Row const * row) const;
597 /** returns the number of hfills in the specified row. The
598 LyX-Hfill is a LaTeX \hfill so that the hfills at the
599 beginning and at the end were ignored. This is {\em MUCH}
600 more usefull than not to ignore!
602 int NumberOfHfills(Row const * row) const;
604 /// like NumberOfHfills, but only those in the manual label!
605 int NumberOfLabelHfills(Row const * row) const;
607 /** returns true, if a expansion is needed. Rules are given by
610 bool HfillExpansion(Row const * row_ptr,
611 LyXParagraph::size_type pos) const;
614 mutable vector<LyXParagraph::size_type> log2vis_list;
617 mutable vector<LyXParagraph::size_type> vis2log_list;
620 mutable LyXParagraph::size_type bidi_start;
623 void ComputeBidiTables(Row *row) const;
626 void ComputeBidiTablesFromTo(Row *row,
627 LyXParagraph::size_type from,
628 LyXParagraph::size_type to,
629 LyXParagraph::size_type offset) const;
631 /// Maps positions in the visual string to positions in logical string.
633 LyXParagraph::size_type log2vis(LyXParagraph::size_type pos) const {
634 if (bidi_start == -1)
637 return log2vis_list[pos-bidi_start];
640 /// Maps positions in the logical string to positions in visual string.
642 LyXParagraph::size_type vis2log(LyXParagraph::size_type pos) const {
643 if (bidi_start == -1)
646 return vis2log_list[pos-bidi_start];
649 /** returns the paragraph position of the last character in the
652 LyXParagraph::size_type RowLast(Row const * row) const;