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