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