]> git.lyx.org Git - lyx.git/blob - src/lyxtext.h
Call an update before setting the_locking_inset = 0 as otherwise we
[lyx.git] / src / lyxtext.h
1 // -*- C++ -*-
2 /* This file is part of
3  * ======================================================
4  *
5  *           LyX, The Document Processor
6  *
7  *           Copyright 1995 Matthias Ettrich
8  *           Copyright 1995-2001 The LyX Team.
9  *
10  * ====================================================== */
11
12 #ifndef LYXTEXT_H
13 #define LYXTEXT_H
14
15 #ifdef __GNUG__
16 #pragma interface
17 #endif
18
19 #include "lyxfont.h"
20 #include "lyxcursor.h"
21 #include "layout.h"
22 #include "LColor.h"
23 #include "insets/inset.h"
24
25 class Buffer;
26 class BufferParams;
27 class BufferView;
28 class InsetText;
29 class Paragraph;
30 class Row;
31 class Spacing;
32 class UpdatableInset;
33 class VSpace;
34
35
36 /**
37   This class holds the mapping between buffer paragraphs and screen rows.
38   */
39 class LyXText {
40 public:
41         ///
42         enum text_status {
43                 ///
44                 UNCHANGED = 0,
45                 ///
46                 CHANGED_IN_DRAW = 1,
47                 ///
48                 NEED_VERY_LITTLE_REFRESH = 2,
49                 ///
50                 NEED_MORE_REFRESH = 3
51         };
52         ///
53         enum word_location {
54                 // the word around the cursor, only if the cursor is
55                 //not at a boundary
56                 WHOLE_WORD_STRICT,
57                 // the word around the cursor
58                 WHOLE_WORD,
59                 /// the word begining from the cursor position
60                 PARTIAL_WORD,
61                 /// the word around the cursor or before the cursor
62                 PREVIOUS_WORD,
63                 /// the next word (not yet used)
64                 NEXT_WORD
65         };
66
67         /// Constructor
68         LyXText(BufferView *);
69         ///
70         LyXText(InsetText *);
71
72         /// Destructor
73         ~LyXText();
74
75         void init(BufferView *, bool reinit = false);
76         ///
77         mutable int number_of_rows;
78         ///
79         mutable int height;
80         ///
81         mutable unsigned int width;
82         /// the current font settings
83         mutable LyXFont current_font;
84         /// the current font
85         mutable LyXFont real_current_font;
86         /// first visible pixel-row is set from LyXScreen!!!
87         // unsigned is wrong here for text-insets!
88         int first_y;
89         ///
90         BufferView * bv_owner;
91         ///
92         InsetText * inset_owner;
93         ///
94         UpdatableInset * the_locking_inset;
95
96         ///
97         int getRealCursorX(BufferView *) const;
98         ///
99         LyXFont const getFont(Buffer const *, Paragraph * par,
100                 lyx::pos_type pos) const;
101         ///
102         LyXFont const getLayoutFont(Buffer const *, Paragraph * par) const;
103         ///
104         LyXFont const getLabelFont(Buffer const *, Paragraph * par) const;
105         ///
106         void setCharFont(Buffer const *, Paragraph * par,
107                          lyx::pos_type pos, LyXFont const & font);
108         void setCharFont(BufferView *, Paragraph * par,
109                          lyx::pos_type pos, LyXFont const & font, bool toggleall);
110
111         /// what you expect when pressing <enter> at cursor position
112         void breakParagraph(BufferView *, char keep_layout = 0);
113
114         /** set layout over selection and make a total rebreak of
115           those paragraphs
116           */
117         Paragraph * setLayout(BufferView *, LyXCursor & actual_cursor,
118                               LyXCursor & selection_start,
119                               LyXCursor & selection_end,
120                               string const & layout);
121         ///
122         void setLayout(BufferView *, string const & layout);
123
124         /// used in setlayout
125         void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
126
127         /** increment depth over selection and make a total rebreak of those
128           paragraphs
129           */
130         void incDepth(BufferView *);
131
132         /** decrement depth over selection and make a total rebreak of those
133           paragraphs */
134         void decDepth(BufferView *);
135
136         /** Get the depth at current cursor position
137          */
138         int getDepth() const;
139
140         /** set font over selection and make a total rebreak of those
141           paragraphs.
142           toggleall defaults to false.
143           */
144         void setFont(BufferView *, LyXFont const &, bool toggleall = false);
145
146         /** deletes and inserts again all paragaphs between the cursor
147           and the specified par. The Cursor is needed to set the refreshing
148           parameters.
149           This function is needed after SetLayout and SetFont etc.
150           */
151         void redoParagraphs(BufferView *, LyXCursor const & cursor,
152                             Paragraph const * end_par) const;
153         ///
154         void redoParagraph(BufferView *) const;
155
156         ///
157         void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
158
159         ///
160         string getStringToIndex(BufferView *);
161
162         /** recalculates the heights of all previous rows of the
163             specified paragraph.  needed, if the last characters font
164             has changed.
165             */
166         void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
167
168         /** forces the redrawing of a paragraph. Needed when manipulating a
169             right address box
170             */
171         void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
172
173         /** insert a character, moves all the following breaks in the
174           same Paragraph one to the right and make a little rebreak
175           */
176         void insertChar(BufferView *, char c);
177         ///
178         void insertInset(BufferView *, Inset * inset);
179
180         /** Completes the insertion with a full rebreak.
181             Returns true if something was broken. */
182         bool fullRebreak(BufferView *);
183
184         ///
185         mutable Row * need_break_row;
186         ///
187         mutable int refresh_y;
188         ///
189         int refresh_height;
190         ///
191         int refresh_width;
192         ///
193         int refresh_x;
194         ///
195         mutable Row * refresh_row;
196         ///
197         lyx::pos_type refresh_pos;
198
199         /// give and set the LyXText status
200         text_status status() const;
201         ///
202         void status(BufferView *, text_status) const;
203
204 private:
205         /** wether the screen needs a refresh,
206            starting with refresh_y
207            */
208         mutable text_status status_;
209
210 public:
211         /** returns a pointer to the row near the specified y-coordinate
212           (relative to the whole text). y is set to the real beginning
213           of this row
214           */
215         Row * getRowNearY(int & y) const;
216
217         /** returns the column near the specified x-coordinate of the row
218          x is set to the real beginning of this column
219          */
220         lyx::pos_type getColumnNearX(BufferView *, Row * row,
221                                             int & x, bool & boundary) const;
222
223         /** returns a pointer to a specified row. y is set to the beginning
224          of the row
225          */
226         Row * getRow(Paragraph * par,
227                      lyx::pos_type pos, int & y) const;
228         /** returns the firstrow, this could be done with the above too but
229             IMO it's stupid to have to allocate a dummy y all the time I need
230             the first row
231         */
232         Row * firstRow() { return firstrow; }
233
234         /** returns the height of a default row, needed  for scrollbar
235          */
236         int defaultHeight() const;
237
238         /** The cursor.
239           Later this variable has to be removed. There should be now internal
240           cursor in a text (and thus not in a buffer). By keeping this it is
241           (I think) impossible to have several views with the same buffer, but
242           the cursor placed at different places.
243           [later]
244           Since the LyXText now has been moved from Buffer to BufferView
245           it should not be absolutely needed to move the cursor...
246           */
247         mutable LyXCursor cursor; // actual cursor position
248
249         /** The structure that keeps track of the selections set. */
250         struct Selection {
251                 Selection()
252                         : set_(false), mark_(false)
253                         {}
254                 bool set() const {
255                         return set_;
256                 }
257                 void set(bool s) {
258                         set_ = s;
259                 }
260                 bool mark() const {
261                         return mark_;
262                 }
263                 void mark(bool m) {
264                         mark_ = m;
265                 }
266                 LyXCursor cursor; // temporary cursor to hold a cursor position
267                                   // until setSelection is called!
268                 LyXCursor start;  // start of a REAL selection
269                 LyXCursor end;    // end of a REAL selection
270         private:
271                 bool set_; // former selection
272                 bool mark_; // former mark_set
273
274         };
275         mutable Selection selection;
276         // this is used to handle XSelection events in the right manner
277         mutable Selection xsel_cache;
278
279         /// needed for the toggling (cursor position on last selection made)
280         mutable LyXCursor last_sel_cursor;
281         /// needed for toggling the selection in screen.C
282         mutable LyXCursor toggle_cursor;
283         /// needed for toggling the selection in screen.C
284         mutable LyXCursor toggle_end_cursor;
285
286         /// need the selection cursor:
287         void setSelection(BufferView *);
288         ///
289         void clearSelection() const;
290         ///
291         string const selectionAsString(Buffer const *, bool label) const;
292
293         /// select the word we need depending on word_location
294         void getWord(LyXCursor & from, LyXCursor & to,
295                      word_location const) const;
296         /// just selects the word the cursor is in
297         void selectWord(BufferView *, word_location const);
298         /// returns the inset at cursor (if it exists), 0 otherwise
299         Inset * getInset() const;
300
301         /** 'selects" the next word, where the cursor is not in
302          and returns this word as string. THe cursor will be moved
303          to the beginning of this word.
304          With SelectSelectedWord can this be highlighted really
305          */
306         string const selectNextWordToSpellcheck(BufferView *, float & value) const;
307         ///
308         void selectSelectedWord(BufferView *);
309         /// returns true if par was empty and was removed
310         bool setCursor(BufferView *, Paragraph * par,
311                        lyx::pos_type pos,
312                        bool setfont = true,
313                        bool boundary = false) const;
314         ///
315         void setCursor(BufferView *, LyXCursor &, Paragraph * par,
316                        lyx::pos_type pos,
317                        bool boundary = false) const;
318         ///
319         void setCursorIntern(BufferView *, Paragraph * par,
320                              lyx::pos_type pos,
321                              bool setfont = true,
322                              bool boundary = false) const;
323         ///
324         float getCursorX(BufferView *, Row *, lyx::pos_type pos,
325                                          lyx::pos_type last, bool boundary) const;
326         ///
327         void setCurrentFont(BufferView *) const;
328
329         ///
330         bool isBoundary(Buffer const *, Paragraph * par,
331                         lyx::pos_type pos) const;
332         ///
333         bool isBoundary(Buffer const *, Paragraph * par,
334                          lyx::pos_type pos,
335                          LyXFont const & font) const;
336
337         ///
338         void setCursorFromCoordinates(BufferView *, int x, int y) const;
339         ///
340         void setCursorFromCoordinates(BufferView *, LyXCursor &,
341                                       int x, int y) const;
342         ///
343         void cursorUp(BufferView *, bool selecting = false) const;
344         ///
345         void cursorDown(BufferView *, bool selecting = false) const;
346         ///
347         void cursorLeft(BufferView *, bool internal = true) const;
348         ///
349         void cursorRight(BufferView *, bool internal = true) const;
350         ///
351         void cursorLeftOneWord(BufferView *) const;
352         ///
353         void cursorLeftOneWord(LyXCursor &) const;
354         ///
355         void cursorRightOneWord(BufferView *) const;
356         ///
357         void cursorUpParagraph(BufferView *) const;
358         ///
359         void cursorDownParagraph(BufferView *) const;
360         ///
361         void cursorHome(BufferView *) const;
362         ///
363         void cursorEnd(BufferView *) const;
364         ///
365         void cursorTab(BufferView *) const;
366         ///
367         void cursorTop(BufferView *) const;
368         ///
369         void cursorBottom(BufferView *) const;
370         ///
371         void Delete(BufferView *);
372         ///
373         void backspace(BufferView *);
374         ///
375         void deleteWordForward(BufferView *);
376         ///
377         void deleteWordBackward(BufferView *);
378         ///
379         void deleteLineForward(BufferView *);
380         ///
381         bool selectWordWhenUnderCursor(BufferView *,
382                                        word_location const);
383         ///
384         enum TextCase {
385                 ///
386                 text_lowercase = 0,
387                 ///
388                 text_capitalization = 1,
389                 ///
390                 text_uppercase = 2
391         };
392         /// Change the case of the word at cursor position.
393         void changeCase(BufferView *, TextCase action);
394         ///
395         void changeRegionCase(BufferView * bview,
396                                        LyXCursor const & from,
397                                        LyXCursor const & to,
398                                        LyXText::TextCase action);
399         ///
400         void transposeChars(BufferView &);
401
402         /** returns a printed row in a pixmap. The y value is needed to
403           decide, wether it is selected text or not. This is a strange
404           solution but faster.
405          */
406         void getVisibleRow(BufferView *, int y_offset, int x_offset,
407                            Row * row_ptr, int y, bool cleared=false);
408
409         ///
410         void toggleInset(BufferView *);
411         ///
412         void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
413         ///
414         void copySelection(BufferView *);
415         ///
416         void pasteSelection(BufferView *);
417         ///
418         void copyEnvironmentType();
419         ///
420         void pasteEnvironmentType(BufferView *);
421
422         /** the DTP switches for paragraphs. LyX will store the top settings
423          always in the first physical paragraph, the bottom settings in the
424          last. When a paragraph is broken, the top settings rest, the bottom
425          settings are given to the new one. So I can make shure, they do not
426          duplicate themself (and you cannnot make dirty things with them! )
427          */
428         void setParagraph(BufferView *,
429                           bool line_top, bool line_bottom,
430                           bool pagebreak_top, bool pagebreak_bottom,
431                           VSpace const & space_top,
432                           VSpace const & space_bottom,
433                           Spacing const & spacing,
434                           LyXAlignment align,
435                           string labelwidthstring,
436                           bool noindent);
437
438         /* these things are for search and replace */
439
440         /** sets the selection over the number of characters of string,
441           no check!!
442           */
443         void setSelectionOverString(BufferView *, string const & str);
444
445         /** simple replacing. The font of the first selected character
446           is used
447           */
448         void replaceSelectionWithString(BufferView *, string const & str);
449
450         /// needed to insert the selection
451         void insertStringAsLines(BufferView *, string const & str);
452         /// needed to insert the selection
453         void insertStringAsParagraphs(BufferView *, string const & str);
454
455         /// Find next inset of some specified type.
456         bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
457                            string const & contents = string()) const;
458         ///
459
460         /* for the greater insets */
461
462         /// returns false if inset wasn't found
463         bool updateInset(BufferView *, Inset *);
464         ///
465         void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
466         ///
467         int numberOfCell(Paragraph * par, lyx::pos_type pos) const;
468         ///
469         void removeTableRow(LyXCursor & cursor) const;
470         ///
471         bool isEmptyTableCell() const;
472         ///
473         void toggleAppendix(BufferView *);
474         ///
475         int workWidth(BufferView *) const;
476         ///
477         int workWidth(BufferView *, Inset * inset) const;
478         ///
479         void computeBidiTables(Buffer const *, Row * row) const;
480
481         /// Maps positions in the visual string to positions in logical string.
482         inline
483         lyx::pos_type log2vis(lyx::pos_type pos) const {
484                 if (bidi_start == -1)
485                         return pos;
486                 else
487                         return log2vis_list[pos-bidi_start];
488         }
489
490         /// Maps positions in the logical string to positions in visual string.
491         inline
492         lyx::pos_type vis2log(lyx::pos_type pos) const {
493                 if (bidi_start == -1)
494                         return pos;
495                 else
496                         return vis2log_list[pos-bidi_start];
497         }
498         ///
499         inline
500         lyx::pos_type bidi_level(lyx::pos_type pos) const {
501                 if (bidi_start == -1)
502                         return 0;
503                 else
504                         return bidi_levels[pos-bidi_start];
505         }
506         ///
507         inline
508         bool bidi_InRange(lyx::pos_type pos) const {
509                 return bidi_start == -1 ||
510                         (bidi_start <= pos && pos <= bidi_end);
511         }
512 private:
513         ///
514         mutable Row * firstrow;
515
516         ///
517         mutable Row * lastrow;
518
519         /** Copybuffer for copy environment type.
520           Asger has learned that this should be a buffer-property instead
521           Lgb has learned that 'char' is a lousy type for non-characters
522           */
523         string copylayouttype;
524         /** inserts a new row behind the specified row, increments
525             the touched counters */
526         void insertRow(Row * row, Paragraph * par, lyx::pos_type pos) const;
527         /** removes the row and reset the touched counters */
528         void removeRow(Row * row) const;
529
530         /** remove all following rows of the paragraph of the specified row. */
531         void removeParagraph(Row * row) const;
532
533         /** insert the specified paragraph behind the specified row */
534         void insertParagraph(BufferView *,
535                              Paragraph * par, Row * row) const;
536
537         /** appends  the implizit specified paragraph behind the specified row,
538          * start at the implizit given position */
539         void appendParagraph(BufferView *, Row * row) const;
540
541         ///
542         void breakAgain(BufferView *, Row * row) const;
543         ///
544         void breakAgainOneRow(BufferView *, Row * row);
545         /// Calculate and set the height of the row
546         void setHeightOfRow(BufferView *, Row * row_ptr) const;
547
548         /** this calculates the specified parameters. needed when setting
549          * the cursor and when creating a visible row */
550         void prepareToPrint(BufferView *, Row * row, float & x,
551                             float & fill_separator,
552                             float & fill_hfill,
553                             float & fill_label_hfill,
554                             bool bidi = true) const;
555
556         /// A struct used for drawing routines
557         struct DrawRowParams {
558                 // the bufferview
559                 BufferView * bv;
560                 // the row
561                 Row * row;
562                 // the painter to use
563                 Painter * pain;
564                 // has the background been cleared
565                 bool cleared;
566                 /// x offset (e.g. for insets)
567                 int xo;
568                 /// y offset (e.g. for insets)
569                 int yo;
570                 /// FIXME
571                 float x;
572                 /// FIXME
573                 int y;
574                 /// the inset/view full width
575                 int width;
576                 /// hfill size
577                 float hfill;
578                 /// label hfill size
579                 float label_hfill;
580                 /// fill separator size
581                 float separator;
582         };
583
584         /// paint the background
585         bool paintRowBackground(DrawRowParams & p);
586
587         /// paint the selection background
588         void paintRowSelection(DrawRowParams & p);
589
590         /// paint appendix marker
591         void paintRowAppendix(DrawRowParams & p);
592
593         /// paint env depth bar
594         void paintRowDepthBar(DrawRowParams & p);
595
596         /// get the on-screen size of the length marker
597         int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
598
599         /// paint an added space marker
600         int drawLengthMarker(DrawRowParams & p, string const & str,
601                 VSpace const & vsp, int start);
602
603         /// paint a first row in a paragraph
604         void paintFirstRow(DrawRowParams & p);
605
606         /// paint a last row in a paragraph
607         void paintLastRow(DrawRowParams & p);
608
609         /// paint text
610         void paintRowText(DrawRowParams & p);
611
612         // fix the cursor `cur' after a characters has been deleted at `where'
613         // position. Called by deleteEmptyParagraphMechanism
614         void fixCursorAfterDelete(BufferView * bview,
615                                   LyXCursor & cur,
616                                   LyXCursor const & where) const;
617
618         /// delete double space (false) or empty paragraphs (true) around old_cursor
619         bool deleteEmptyParagraphMechanism(BufferView *,
620                                            LyXCursor const & old_cursor) const;
621
622 public:
623         /** Updates all counters starting BEHIND the row. Changed paragraphs
624          * with a dynamic left margin will be rebroken. */
625         void updateCounters(BufferView *, Row * row) const;
626 private:
627         ///
628         void setCounter(Buffer const *, Paragraph * par) const;
629
630         /*
631          * some low level functions
632          */
633
634         ///
635         int singleWidth(BufferView *, Paragraph * par,
636                 lyx::pos_type pos) const;
637         ///
638         int singleWidth(BufferView *, Paragraph * par,
639                 lyx::pos_type pos, char c) const;
640
641
642         /// draw normal chars
643         void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
644                 bool hebrew, bool arabic);
645         /// draw from arabic composed char
646         void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
647         /// draw from hebrew composed char
648         void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
649         /// draw a mark for foreign language, starting from orig_x
650         void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
651         /// draw an inset
652         void drawInset(DrawRowParams & p, lyx::pos_type const pos);
653         /// draw new line marker
654         void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
655         /// draw text
656         void draw(DrawRowParams & p, lyx::pos_type & vpos);
657
658         /// get the next breakpoint in a given paragraph
659         lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
660         /// returns the minimum space a row needs on the screen in pixel
661         int fill(BufferView *, Row * row, int workwidth) const;
662
663         /** returns the minimum space a manual label needs on the
664           screen in pixel */
665         int labelFill(BufferView *, Row const * row) const;
666
667         ///
668         lyx::pos_type beginningOfMainBody(Buffer const *, Paragraph const * par) const;
669
670         /** Returns the left beginning of the text.
671           This information cannot be taken from the layouts-objekt, because
672           in LaTeX the beginning of the text fits in some cases
673           (for example sections) exactly the label-width.
674           */
675         int leftMargin(BufferView *, Row const * row) const;
676         ///
677         int rightMargin(Buffer const *, Row const * row) const;
678         ///
679         int labelEnd (BufferView *, Row const * row) const;
680
681         /** returns the number of separators in the specified row.
682           The separator on the very last column doesnt count
683           */
684         int numberOfSeparators(Buffer const *, Row const * row) const;
685
686         /** returns the number of hfills in the specified row. The
687           LyX-Hfill is a LaTeX \hfill so that the hfills at the
688           beginning and at the end were ignored. This is {\em MUCH}
689           more usefull than not to ignore!
690           */
691         int numberOfHfills(Buffer const *, Row const * row) const;
692
693         /// like NumberOfHfills, but only those in the manual label!
694         int numberOfLabelHfills(Buffer const *, Row const * row) const;
695         /** returns true, if a expansion is needed. Rules are given by
696           LaTeX
697           */
698         bool hfillExpansion(Buffer const *, Row const * row_ptr,
699                             lyx::pos_type pos) const;
700         ///
701         LColor::color backgroundColor();
702
703
704         ///
705         mutable std::vector<lyx::pos_type> log2vis_list;
706
707         ///
708         mutable std::vector<lyx::pos_type> vis2log_list;
709
710         ///
711         mutable std::vector<lyx::pos_type> bidi_levels;
712
713         ///
714         mutable lyx::pos_type bidi_start;
715
716         ///
717         mutable lyx::pos_type bidi_end;
718
719         ///
720         mutable bool bidi_same_direction;
721
722         ///
723         unsigned char transformChar(unsigned char c, Paragraph * par,
724                                     lyx::pos_type pos) const;
725
726         /** returns the paragraph position of the last character in the
727           specified row
728           */
729         lyx::pos_type rowLast(Row const * row) const;
730         ///
731         lyx::pos_type rowLastPrintable(Row const * row) const;
732
733         ///
734         void charInserted();
735 public:
736         //
737         // special owner functions
738         ///
739         Paragraph * ownerParagraph() const;
740         //
741         void ownerParagraph(Paragraph *) const;
742         // set it searching first for the right owner using the paragraph id
743         void ownerParagraph(int id, Paragraph *) const;
744 };
745
746 #endif