]> git.lyx.org Git - lyx.git/blob - src/lyxtext.h
layout as string
[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;
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
277         /// needed for the toggling (cursor position on last selection made)
278         mutable LyXCursor last_sel_cursor; 
279         /// needed for toggling the selection in screen.C
280         mutable LyXCursor toggle_cursor;
281         /// needed for toggling the selection in screen.C
282         mutable LyXCursor toggle_end_cursor;
283    
284         /// need the selection cursor:
285         void setSelection(BufferView *);
286         ///
287         void clearSelection() const;
288         ///
289         string const selectionAsString(Buffer const *, bool label) const;
290         
291         /// select the word we need depending on word_location
292         void getWord(LyXCursor & from, LyXCursor & to, 
293                      word_location const) const;
294         /// just selects the word the cursor is in
295         void selectWord(BufferView *, word_location const);
296         /// returns the inset at cursor (if it exists), 0 otherwise
297         Inset * getInset() const;
298
299         /** 'selects" the next word, where the cursor is not in 
300          and returns this word as string. THe cursor will be moved 
301          to the beginning of this word. 
302          With SelectSelectedWord can this be highlighted really
303          */ 
304         string const selectNextWordToSpellcheck(BufferView *, float & value) const;
305         ///
306         void selectSelectedWord(BufferView *);
307         /// returns true if par was empty and was removed
308         bool setCursor(BufferView *, Paragraph * par,
309                        lyx::pos_type pos,
310                        bool setfont = true,
311                        bool boundary = false) const;
312         ///
313         void setCursor(BufferView *, LyXCursor &, Paragraph * par,
314                        lyx::pos_type pos,
315                        bool boundary = false) const;
316         ///
317         void setCursorIntern(BufferView *, Paragraph * par,
318                              lyx::pos_type pos,
319                              bool setfont = true,
320                              bool boundary = false) const;
321         ///
322         void setCurrentFont(BufferView *) const;
323
324         ///
325         bool isBoundary(Buffer const *, Paragraph * par,
326                         lyx::pos_type pos) const;
327         ///
328         bool isBoundary(Buffer const *, Paragraph * par,
329                          lyx::pos_type pos,
330                          LyXFont const & font) const;
331
332         ///
333         void setCursorFromCoordinates(BufferView *, int x, int y) const;
334         ///
335         void setCursorFromCoordinates(BufferView *, LyXCursor &,
336                                       int x, int y) const;
337         ///
338         void cursorUp(BufferView *) const;
339         ///
340         void cursorDown(BufferView *) const;
341         ///
342         void cursorLeft(BufferView *, bool internal = true) const;
343         ///
344         void cursorRight(BufferView *, bool internal = true) const;
345         ///
346         void cursorLeftOneWord(BufferView *) const;
347         ///
348         void cursorLeftOneWord(LyXCursor &) const;
349         ///
350         void cursorRightOneWord(BufferView *) const;
351         ///
352         void cursorUpParagraph(BufferView *) const;
353         ///
354         void cursorDownParagraph(BufferView *) const;
355         ///
356         void cursorHome(BufferView *) const;
357         ///
358         void cursorEnd(BufferView *) const;
359         ///
360         void cursorTab(BufferView *) const;
361         ///
362         void cursorTop(BufferView *) const;
363         ///
364         void cursorBottom(BufferView *) const;
365         ///
366         void Delete(BufferView *);
367         ///
368         void backspace(BufferView *);
369         ///
370         void deleteWordForward(BufferView *);
371         ///
372         void deleteWordBackward(BufferView *);
373         ///
374         void deleteLineForward(BufferView *);
375         ///
376         bool selectWordWhenUnderCursor(BufferView *, 
377                                        word_location const);
378         ///
379         enum TextCase {
380                 ///
381                 text_lowercase = 0,
382                 ///
383                 text_capitalization = 1,
384                 ///
385                 text_uppercase = 2
386         };
387         /// Change the case of the word at cursor position.
388         void changeCase(BufferView *, TextCase action);
389         ///
390         void changeRegionCase(BufferView * bview,
391                                        LyXCursor const & from,
392                                        LyXCursor const & to,
393                                        LyXText::TextCase action);
394         ///
395         void transposeChars(BufferView &);
396         
397         /** returns a printed row in a pixmap. The y value is needed to
398           decide, wether it is selected text or not. This is a strange
399           solution but faster.
400          */
401         void getVisibleRow(BufferView *, int y_offset, int x_offset,
402                            Row * row_ptr, int y, bool cleared=false);
403
404         /// 
405         void toggleInset(BufferView *);
406         ///
407         void cutSelection(BufferView *, bool doclear = true, bool realcut = true);
408         ///
409         void copySelection(BufferView *);
410         ///
411         void pasteSelection(BufferView *);
412         ///
413         void copyEnvironmentType();
414         ///
415         void pasteEnvironmentType(BufferView *);
416
417         /** the DTP switches for paragraphs. LyX will store the top settings
418          always in the first physical paragraph, the bottom settings in the
419          last. When a paragraph is broken, the top settings rest, the bottom 
420          settings are given to the new one. So I can make shure, they do not
421          duplicate themself (and you cannnot make dirty things with them! )
422          */ 
423         void setParagraph(BufferView *,
424                           bool line_top, bool line_bottom,
425                           bool pagebreak_top, bool pagebreak_bottom,
426                           VSpace const & space_top,
427                           VSpace const & space_bottom,
428                           Spacing const & spacing,
429                           LyXAlignment align, 
430                           string labelwidthstring,
431                           bool noindent);
432
433         /* these things are for search and replace */
434
435         /** sets the selection over the number of characters of string,
436           no check!!
437           */
438         void setSelectionOverString(BufferView *, string const & str);
439
440         /** simple replacing. The font of the first selected character
441           is used
442           */
443         void replaceSelectionWithString(BufferView *, string const & str);
444
445         /// needed to insert the selection
446         void insertStringAsLines(BufferView *, string const & str);
447         /// needed to insert the selection
448         void insertStringAsParagraphs(BufferView *, string const & str);
449
450         /// Find next inset of some specified type.
451         bool gotoNextInset(BufferView *, std::vector<Inset::Code> const & codes,
452                            string const & contents = string()) const;
453         ///
454
455         /* for the greater insets */
456   
457         /// returns false if inset wasn't found
458         bool updateInset(BufferView *, Inset *);
459         ///
460         void checkParagraph(BufferView *, Paragraph * par, lyx::pos_type pos);
461         ///
462         int numberOfCell(Paragraph * par, lyx::pos_type pos) const;
463         ///
464         void removeTableRow(LyXCursor & cursor) const;
465         ///
466         bool isEmptyTableCell() const;
467         ///
468         void toggleAppendix(BufferView *);
469         ///
470         int workWidth(BufferView *) const;
471         ///
472         int workWidth(BufferView *, Inset * inset) const;
473         ///
474         void computeBidiTables(Buffer const *, Row * row) const;
475
476         /// Maps positions in the visual string to positions in logical string.
477         inline
478         lyx::pos_type log2vis(lyx::pos_type pos) const {
479                 if (bidi_start == -1)
480                         return pos;
481                 else
482                         return log2vis_list[pos-bidi_start];
483         }
484
485         /// Maps positions in the logical string to positions in visual string.
486         inline
487         lyx::pos_type vis2log(lyx::pos_type pos) const {
488                 if (bidi_start == -1)
489                         return pos;
490                 else
491                         return vis2log_list[pos-bidi_start];
492         }
493         ///
494         inline
495         lyx::pos_type bidi_level(lyx::pos_type pos) const {
496                 if (bidi_start == -1)
497                         return 0;
498                 else
499                         return bidi_levels[pos-bidi_start];
500         }       
501         ///
502         inline
503         bool bidi_InRange(lyx::pos_type pos) const {
504                 return bidi_start == -1 ||
505                         (bidi_start <= pos && pos <= bidi_end);
506         }
507 private:
508         ///
509         mutable Row * firstrow;
510         ///
511         mutable Row * lastrow;
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 env depth bar 
588         void paintRowDepthBar(DrawRowParams & p);
589  
590         /// get the on-screen size of the length marker
591         int getLengthMarkerHeight(BufferView * bv, VSpace const & vsp) const;
592  
593         /// paint an added space marker
594         int drawLengthMarker(DrawRowParams & p, string const & str,
595                 VSpace const & vsp, int start); 
596  
597         /// paint a first row in a paragraph
598         void paintFirstRow(DrawRowParams & p);
599  
600         /// paint a last row in a paragraph
601         void paintLastRow(DrawRowParams & p);
602  
603         /// paint text
604         void paintRowText(DrawRowParams & p);
605  
606         // fix the cursor `cur' after a characters has been deleted at `where'
607         // position. Called by deleteEmptyParagraphMechanism
608         void fixCursorAfterDelete(BufferView * bview,
609                                   LyXCursor & cur,
610                                   LyXCursor const & where) const;
611         
612         /// delete double space (false) or empty paragraphs (true) around old_cursor 
613         bool deleteEmptyParagraphMechanism(BufferView *,
614                                            LyXCursor const & old_cursor) const;
615
616 public:
617         /** Updates all counters starting BEHIND the row. Changed paragraphs
618          * with a dynamic left margin will be rebroken. */ 
619         void updateCounters(BufferView *, Row * row) const;
620 private:
621         ///
622         void setCounter(Buffer const *, Paragraph * par) const;
623    
624         /*
625          * some low level functions
626          */
627         
628         ///
629         int singleWidth(BufferView *, Paragraph * par,
630                 lyx::pos_type pos) const;
631         ///
632         int singleWidth(BufferView *, Paragraph * par,
633                 lyx::pos_type pos, char c) const;
634
635  
636         /// draw normal chars
637         void drawChars(DrawRowParams & p, lyx::pos_type & vpos,
638                 bool hebrew, bool arabic);
639         /// draw from arabic composed char
640         void drawArabicComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
641         /// draw from hebrew composed char
642         void drawHebrewComposeChar(DrawRowParams & p, lyx::pos_type & vpos);
643         /// draw a mark for foreign language, starting from orig_x
644         void drawForeignMark(DrawRowParams & p, float const orig_x, LyXFont const & orig_font);
645         /// draw an inset 
646         void drawInset(DrawRowParams & p, lyx::pos_type const pos);
647         /// draw new line marker
648         void drawNewline(DrawRowParams & p, lyx::pos_type const pos);
649         /// draw text
650         void draw(DrawRowParams & p, lyx::pos_type & vpos);
651
652         /// get the next breakpoint in a given paragraph
653         lyx::pos_type nextBreakPoint(BufferView *, Row const * row, int width) const;
654         /// returns the minimum space a row needs on the screen in pixel
655         int fill(BufferView *, Row * row, int workwidth) const;
656         
657         /** returns the minimum space a manual label needs on the
658           screen in pixel */ 
659         int labelFill(BufferView *, Row const * row) const;
660
661         ///
662         lyx::pos_type beginningOfMainBody(Buffer const *, Paragraph const * par) const;
663         
664         /** Returns the left beginning of the text.
665           This information cannot be taken from the layouts-objekt, because
666           in LaTeX the beginning of the text fits in some cases
667           (for example sections) exactly the label-width.
668           */
669         int leftMargin(BufferView *, Row const * row) const;
670         ///
671         int rightMargin(Buffer const *, Row const * row) const;
672         ///
673         int labelEnd (BufferView *, Row const * row) const;
674
675         /** returns the number of separators in the specified row.
676           The separator on the very last column doesnt count
677           */ 
678         int numberOfSeparators(Buffer const *, Row const * row) const;
679
680         /** returns the number of hfills in the specified row. The
681           LyX-Hfill is a LaTeX \hfill so that the hfills at the
682           beginning and at the end were ignored. This is {\em MUCH}
683           more usefull than not to ignore!
684           */
685         int numberOfHfills(Buffer const *, Row const * row) const;
686    
687         /// like NumberOfHfills, but only those in the manual label!
688         int numberOfLabelHfills(Buffer const *, Row const * row) const;
689         /** returns true, if a expansion is needed. Rules are given by 
690           LaTeX
691           */
692         bool hfillExpansion(Buffer const *, Row const * row_ptr,
693                             lyx::pos_type pos) const;
694         /// 
695         LColor::color backgroundColor();
696
697
698         ///
699         mutable std::vector<lyx::pos_type> log2vis_list;
700
701         ///
702         mutable std::vector<lyx::pos_type> vis2log_list;
703
704         ///
705         mutable std::vector<lyx::pos_type> bidi_levels;
706
707         ///
708         mutable lyx::pos_type bidi_start;
709
710         ///
711         mutable lyx::pos_type bidi_end;
712
713         ///
714         mutable bool bidi_same_direction;
715
716         ///
717         unsigned char transformChar(unsigned char c, Paragraph * par,
718                                     lyx::pos_type pos) const;
719
720         /** returns the paragraph position of the last character in the 
721           specified row
722           */
723         lyx::pos_type rowLast(Row const * row) const;
724         ///
725         lyx::pos_type rowLastPrintable(Row const * row) const;
726
727         ///
728         void charInserted();
729 public:
730         //
731         // special owner functions
732         ///
733         Paragraph * ownerParagraph() const;
734         //
735         void ownerParagraph(Paragraph *) const;
736         // set it searching first for the right owner using the paragraph id
737         void ownerParagraph(int id, Paragraph *) const;
738 };
739
740 #endif