]> git.lyx.org Git - lyx.git/blob - src/lyxtext.h
more ws
[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         ///
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         int getDepth() const;
136
137         /** set font over selection and make a total rebreak of those
138           paragraphs.
139           toggleall defaults to false.
140           */
141         void setFont(BufferView *, LyXFont const &, bool toggleall = false);
142
143         /** deletes and inserts again all paragaphs between the cursor
144           and the specified par. The Cursor is needed to set the refreshing
145           parameters.
146           This function is needed after SetLayout and SetFont etc.
147           */
148         void redoParagraphs(BufferView *, LyXCursor const & cursor,
149                             Paragraph const * end_par) const;
150         ///
151         void redoParagraph(BufferView *) const;
152
153         ///
154         void toggleFree(BufferView *, LyXFont const &, bool toggleall = false);
155
156         ///
157         string getStringToIndex(BufferView *);
158
159         /** recalculates the heights of all previous rows of the
160             specified paragraph.  needed, if the last characters font
161             has changed.
162             */
163         void redoHeightOfParagraph(BufferView *, LyXCursor const & cursor);
164
165         /** insert a character, moves all the following breaks in the
166           same Paragraph one to the right and make a little rebreak
167           */
168         void insertChar(BufferView *, char c);
169         ///
170         void insertInset(BufferView *, Inset * inset);
171
172         /// Completes the insertion with a full rebreak
173         void fullRebreak(BufferView *);
174
175         ///
176         mutable Row * need_break_row;
177         ///
178         mutable int refresh_y;
179         ///
180         int refresh_width;
181         ///
182         int refresh_x;
183         ///
184         mutable Row * refresh_row;
185         ///
186         lyx::pos_type refresh_pos;
187
188         /// give and set the LyXText status
189         text_status status() const;
190         ///
191         void status(BufferView *, text_status) const;
192
193         ///
194         Inset::RESULT dispatch(FuncRequest const & cmd);
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 const 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 cursorRightOneWord(BufferView *) const;
343         ///
344         void cursorUpParagraph(BufferView *) const;
345         ///
346         void cursorDownParagraph(BufferView *) const;
347         ///
348         void cursorHome(BufferView *) const;
349         ///
350         void cursorEnd(BufferView *) const;
351         ///
352         void cursorTab(BufferView *) const;
353         ///
354         void cursorTop(BufferView *) const;
355         ///
356         void cursorBottom(BufferView *) const;
357         ///
358         void Delete(BufferView *);
359         ///
360         void backspace(BufferView *);
361         ///
362         bool selectWordWhenUnderCursor(BufferView *,
363                                        word_location const);
364         ///
365         enum TextCase {
366                 ///
367                 text_lowercase = 0,
368                 ///
369                 text_capitalization = 1,
370                 ///
371                 text_uppercase = 2
372         };
373         /// Change the case of the word at cursor position.
374         void changeCase(BufferView *, TextCase action);
375         ///
376         void transposeChars(BufferView &);
377
378         /** returns a printed row in a pixmap. The y value is needed to
379           decide, wether it is selected text or not. This is a strange
380           solution but faster.
381          */
382         void getVisibleRow(BufferView *, int y_offset, int x_offset,
383                            Row * row_ptr, int y, bool cleared=false);
384
385         ///
386         void toggleInset(BufferView *);
387         ///
388         void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
389         ///
390         void copySelection(BufferView *);
391         ///
392         void pasteSelection(BufferView *);
393         ///
394         void copyEnvironmentType();
395         ///
396         void pasteEnvironmentType(BufferView *);
397
398         /** the DTP switches for paragraphs. LyX will store the top settings
399          always in the first physical paragraph, the bottom settings in the
400          last. When a paragraph is broken, the top settings rest, the bottom
401          settings are given to the new one. So I can make shure, they do not
402          duplicate themself (and you cannnot make dirty things with them! )
403          */
404         void setParagraph(BufferView *,
405                           bool line_top, bool line_bottom,
406                           bool pagebreak_top, bool pagebreak_bottom,
407                           VSpace const & space_top,
408                           VSpace const & space_bottom,
409                           Spacing const & spacing,
410                           LyXAlignment align,
411                           string labelwidthstring,
412                           bool noindent);
413
414         /* these things are for search and replace */
415
416         /** sets the selection over the number of characters of string,
417           no check!!
418           */
419         void setSelectionOverString(BufferView *, string const & str);
420
421         /** simple replacing. The font of the first selected character
422           is used
423           */
424         void replaceSelectionWithString(BufferView *, string const & str);
425
426         /// needed to insert the selection
427         void insertStringAsLines(BufferView *, string const & str);
428         /// needed to insert the selection
429         void insertStringAsParagraphs(BufferView *, string const & str);
430
431         /// Find next inset of some specified type.
432         bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
433                            string const & contents = string()) const;
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         ///
485         mutable Row * lastrow;
486
487         ///
488         void cursorLeftOneWord(LyXCursor &) const;
489  
490         ///
491         float getCursorX(BufferView *, Row *, lyx::pos_type pos,
492                                          lyx::pos_type last, bool boundary) const;
493         ///
494         void changeRegionCase(BufferView * bview,
495                                        LyXCursor const & from,
496                                        LyXCursor const & to,
497                                        LyXText::TextCase action);
498         /// used in setlayout
499         void makeFontEntriesLayoutSpecific(Buffer const *, Paragraph * par);
500
501         /** forces the redrawing of a paragraph. Needed when manipulating a
502             right address box
503             */
504         void redoDrawingOfParagraph(BufferView *, LyXCursor const & cursor);
505
506         /** Copybuffer for copy environment type.
507           Asger has learned that this should be a buffer-property instead
508           Lgb has learned that 'char' is a lousy type for non-characters
509           */
510         string copylayouttype;
511
512         /** inserts a new row behind the specified row, increments
513             the touched counters */
514         void insertRow(Row * row, Paragraph * par, lyx::pos_type pos) const;
515         /// removes the row and reset the touched counters 
516         void removeRow(Row * row) const;
517
518         /// remove all following rows of the paragraph of the specified row.
519         void removeParagraph(Row * row) const;
520
521         /// insert the specified paragraph behind the specified row 
522         void insertParagraph(BufferView *,
523                              Paragraph * par, Row * row) const;
524
525         /** appends  the implizit specified paragraph behind the specified row,
526          * start at the implizit given position */
527         void appendParagraph(BufferView *, Row * row) const;
528
529         ///
530         void breakAgain(BufferView *, Row * row) const;
531         ///
532         void breakAgainOneRow(BufferView *, Row * row);
533         /// Calculate and set the height of the row
534         void setHeightOfRow(BufferView *, Row * row_ptr) const;
535
536         /** this calculates the specified parameters. needed when setting
537          * the cursor and when creating a visible row */
538         void prepareToPrint(BufferView *, Row * row, float & x,
539                             float & fill_separator,
540                             float & fill_hfill,
541                             float & fill_label_hfill,
542                             bool bidi = true) const;
543
544         /// A struct used for drawing routines
545         struct DrawRowParams {
546                 // the bufferview
547                 BufferView * bv;
548                 // the row
549                 Row * row;
550                 // the painter to use
551                 Painter * pain;
552                 // has the background been cleared
553                 bool cleared;
554                 /// x offset (e.g. for insets)
555                 int xo;
556                 /// y offset (e.g. for insets)
557                 int yo;
558                 /// FIXME
559                 float x;
560                 /// FIXME
561                 int y;
562                 /// the inset/view full width
563                 int width;
564                 /// hfill size
565                 float hfill;
566                 /// label hfill size
567                 float label_hfill;
568                 /// fill separator size
569                 float separator;
570         };
571
572         /// paint the background
573         bool paintRowBackground(DrawRowParams & p);
574
575         /// paint the selection background
576         void paintRowSelection(DrawRowParams & p);
577
578         /// paint appendix marker
579         void paintRowAppendix(DrawRowParams & p);
580
581         /// paint page break marker. Returns its height.
582         int paintPageBreak(string const & label, int y, DrawRowParams & p);
583  
584         /// paint env depth bar
585         void paintRowDepthBar(DrawRowParams & p);
586
587         /// get the on-screen size of the length marker
588         int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
589
590         /// paint an added space marker
591         int drawLengthMarker(DrawRowParams & p, string const & str,
592                 VSpace const & vsp, int start);
593
594         /// paint a first row in a paragraph
595         void paintFirstRow(DrawRowParams & p);
596
597         /// paint a last row in a paragraph
598         void paintLastRow(DrawRowParams & p);
599
600         /// paint text
601         void paintRowText(DrawRowParams & p);
602
603         // fix the cursor `cur' after a characters has been deleted at `where'
604         // position. Called by deleteEmptyParagraphMechanism
605         void fixCursorAfterDelete(BufferView * bview,
606                                   LyXCursor & cur,
607                                   LyXCursor const & where) const;
608
609         /// delete double space (false) or empty paragraphs (true) around old_cursor
610         bool deleteEmptyParagraphMechanism(BufferView *,
611                                            LyXCursor const & old_cursor) const;
612
613 public:
614         /** Updates all counters starting BEHIND the row. Changed paragraphs
615          * with a dynamic left margin will be rebroken. */
616         void updateCounters(BufferView *) const;
617         /// 
618         void update(BufferView * bv, bool changed = true);
619 private:
620         ///
621         void setCounter(Buffer const *, Paragraph * par) const;
622         ///
623         void deleteWordForward(BufferView *);
624         ///
625         void deleteWordBackward(BufferView *);
626         ///
627         void deleteLineForward(BufferView *);
628
629         /*
630          * some low level functions
631          */
632
633         ///
634         int singleWidth(BufferView *, Paragraph * par,
635                 lyx::pos_type pos) const;
636         ///
637         int singleWidth(BufferView *, Paragraph * par,
638                 lyx::pos_type pos, char c) const;
639
640
641         /// draw normal chars
642         void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
643                 bool hebrew, bool arabic);
644         /// draw from arabic composed char
645         void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
646         /// draw from hebrew composed char
647         void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
648         /// draw a mark for foreign language, starting from orig_x
649         void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
650         /// draw an inset
651         bool drawInset(DrawRowParams & p, lyx::pos_type const pos);
652         /// draw new line marker
653         void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
654         /// draw text
655         bool draw(DrawRowParams & p, lyx::pos_type & vpos);
656
657         /// get the next breakpoint in a given paragraph
658         lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
659         /// returns the minimum space a row needs on the screen in pixel
660         int fill(BufferView *, Row * row, int workwidth) const;
661
662         /** returns the minimum space a manual label needs on the
663           screen in pixel */
664         int labelFill(BufferView *, Row const * row) const;
665
666         ///
667         lyx::pos_type beginningOfMainBody(Buffer const *, Paragraph const * par) const;
668
669         /** 
670          * Returns the left beginning of the text.
671          * This information cannot be taken from the layout object, 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