]> git.lyx.org Git - lyx.git/blob - src/lyxtext.h
remove unneeded LyXText::workWidth(InsetOld const *)
[lyx.git] / src / lyxtext.h
1 // -*- C++ -*-
2 /**
3  * \file lyxtext.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author unknown
8  * \author Lars Gullik Bjønnes
9  * \author John Levon
10  *
11  * Full author contact details are available in file CREDITS
12  */
13
14 #ifndef LYXTEXT_H
15 #define LYXTEXT_H
16
17 #include "lyxfont.h"
18 #include "lyxcursor.h"
19 #include "layout.h"
20 #include "LColor.h"
21 #include "insets/inset.h"
22 #include "RowList.h"
23 #include "bufferview_funcs.h"
24 #include "textcursor.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 class WordLangTuple;
36 class ParagraphList;
37 class MetricsInfo;
38 class Dimension;
39
40
41 /**
42   This class holds the mapping between buffer paragraphs and screen rows.
43   */
44
45 // The inheritance from TextCursor should go. It's just there to ease
46 // transition...
47 class LyXText : public TextCursor {
48 public:
49         /// Constructor
50         LyXText(BufferView *);
51         /// sets inset as owner
52         LyXText(BufferView *, InsetText *);
53
54         void init(BufferView *);
55         ///
56         int height;
57         ///
58         unsigned int width;
59         /// the current font settings
60         LyXFont current_font;
61         /// the current font
62         LyXFont real_current_font;
63         /// our buffer's default layout font
64         LyXFont defaultfont_;
65 private:
66         /** the 'anchor' row: the position of this row remains constant
67          *  with respect to the top of the screen
68          */
69         RowList::iterator anchor_row_;
70         /** the pixel offset with respect to this row of top_y
71          */
72         int anchor_row_offset_;
73 public:
74         /// update all cached row positions
75         void updateRowPositions();
76         /// get the y coord. of the top of the screen (relative to doc start)
77         int top_y() const;
78         /// set the y coord. of the top of the screen (relative to doc start)
79         void top_y(int newy);
80         /// set the anchoring row. top_y will be computed relative to this
81         void anchor_row(RowList::iterator rit);
82         ///
83         InsetText * inset_owner;
84         ///
85         UpdatableInset * the_locking_inset;
86
87         ///
88         int getRealCursorX() const;
89         ///
90         LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const;
91         ///
92         LyXFont getLayoutFont(ParagraphList::iterator pit) const;
93         ///
94         LyXFont getLabelFont(ParagraphList::iterator pit) const;
95         ///
96         void setCharFont(ParagraphList::iterator pit,
97                          lyx::pos_type pos, LyXFont const & font);
98         void setCharFont(ParagraphList::iterator pit,
99                          lyx::pos_type pos,
100                          LyXFont const & font, bool toggleall);
101
102         ///
103         void breakAgainOneRow(RowList::iterator rit);
104         /// what you expect when pressing <enter> at cursor position
105         void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
106
107         /** set layout over selection and make a total rebreak of
108           those paragraphs
109           */
110         ParagraphList::iterator
111         setLayout(LyXCursor & actual_cursor,
112                   LyXCursor & selection_start,
113                   LyXCursor & selection_end,
114                   string const & layout);
115         ///
116         void setLayout(string const & layout);
117
118         /**
119          * Increase or decrease the nesting depth of the selected paragraph(s)
120          * if test_only, don't change any depths. Returns whether something
121          * (would have) changed
122          */
123         bool changeDepth(bv_funcs::DEPTH_CHANGE type, bool test_only);
124
125         /// get the depth at current cursor position
126         int getDepth() const;
127
128         /** set font over selection and make a total rebreak of those
129           paragraphs.
130           toggleall defaults to false.
131           */
132         void setFont(LyXFont const &, bool toggleall = false);
133
134         /** deletes and inserts again all paragaphs between the cursor
135           and the specified par. The Cursor is needed to set the refreshing
136           parameters.
137           This function is needed after SetLayout and SetFont etc.
138           */
139         void redoParagraphs(LyXCursor const & cursor,
140                             ParagraphList::iterator endpit);
141         ///
142         void redoParagraph();
143
144         ///
145         void toggleFree(LyXFont const &, bool toggleall = false);
146
147         ///
148         string getStringToIndex();
149
150         /** recalculates the heights of all previous rows of the
151             specified paragraph.  needed, if the last characters font
152             has changed.
153             */
154         void redoHeightOfParagraph();
155
156         /** insert a character, moves all the following breaks in the
157           same Paragraph one to the right and make a little rebreak
158           */
159         void insertChar(char c);
160         ///
161         void insertInset(InsetOld * inset);
162
163         /// Completes the insertion with a rebreak
164         void partialRebreak();
165         /// a full rebreak of the whole text
166         void fullRebreak();
167         /// compute text metrics
168         void metrics(MetricsInfo & mi, Dimension & dim);
169
170         /// clear any pending paints
171         void clearPaint();
172
173         /// submit repaint request
174         void postPaint();
175
176         ///
177         InsetOld::RESULT dispatch(FuncRequest const & cmd);
178
179         BufferView * bv();
180
181         BufferView * bv() const;
182
183         friend class LyXScreen;
184
185         /**
186          * Return the status. This represents what repaints are
187          * pending after some operation (e.g. inserting a char).
188          */
189         bool needRefresh() const;
190
191 private:
192         // do we need a refresh?
193         bool need_refresh_;
194
195 public:
196         /// only the top-level LyXText has this non-zero
197         BufferView * bv_owner;
198
199 private:
200         /// returns a pointer to a specified row.
201         RowList::iterator
202         getRow(ParagraphList::iterator pit, lyx::pos_type pos) const;
203 public:
204         /// returns a pointer cursor row
205         RowList::iterator getRow(LyXCursor const & cursor) const;
206         /// convenience
207         RowList::iterator cursorRow() const;
208         /**
209          * Return the next row, when cursor is at the end of the
210          * previous row, for insets that take a full row.
211          *
212          * FIXME: explain why we need this ? especially for y...
213          */
214         RowList::iterator cursorIRow() const;
215
216         /** returns a pointer to the row near the specified y-coordinate
217           (relative to the whole text). y is set to the real beginning
218           of this row
219           */
220         RowList::iterator getRowNearY(int & y) const;
221
222         /** returns the column near the specified x-coordinate of the row
223          x is set to the real beginning of this column
224          */
225         lyx::pos_type getColumnNearX(RowList::iterator rit,
226                                      int & x, bool & boundary) const;
227
228         /** returns a pointer to a specified row. y is set to the beginning
229          of the row
230          */
231         RowList::iterator
232         getRow(ParagraphList::iterator pit, lyx::pos_type pos, int & y) const;
233
234         RowList & rows() const {
235                 return rowlist_;
236         }
237
238
239         /// need the selection cursor:
240         void setSelection();
241         ///
242         void clearSelection();
243
244         /// select the word we need depending on word_location
245         void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
246         /// just selects the word the cursor is in
247         void selectWord(lyx::word_location loc);
248         /// returns the inset at cursor (if it exists), 0 otherwise
249         InsetOld * getInset() const;
250
251         /// accept selected change
252         void acceptChange();
253
254         /// reject selected change
255         void rejectChange();
256
257         /** 'selects" the next word, where the cursor is not in
258          and returns this word as string. THe cursor will be moved
259          to the beginning of this word.
260          With SelectSelectedWord can this be highlighted really
261          */
262         WordLangTuple const selectNextWordToSpellcheck(float & value);
263         ///
264         void selectSelectedWord();
265         /// returns true if par was empty and was removed
266         bool setCursor(ParagraphList::iterator pit,
267                        lyx::pos_type pos,
268                        bool setfont = true,
269                        bool boundary = false);
270         ///
271         void setCursor(LyXCursor &, ParagraphList::iterator pit,
272                        lyx::pos_type pos,
273                        bool boundary = false);
274         ///
275         void setCursorIntern(ParagraphList::iterator pit,
276                              lyx::pos_type pos,
277                              bool setfont = true,
278                              bool boundary = false);
279         ///
280         void setCurrentFont();
281
282         ///
283         bool isBoundary(Buffer const *, Paragraph const & par,
284                         lyx::pos_type pos) const;
285         ///
286         bool isBoundary(Buffer const *, Paragraph const & par,
287                          lyx::pos_type pos,
288                          LyXFont const & font) const;
289
290         ///
291         void setCursorFromCoordinates(int x, int y);
292         ///
293         void setCursorFromCoordinates(LyXCursor &,
294                                       int x, int y);
295         ///
296         void cursorUp(bool selecting = false);
297         ///
298         void cursorDown(bool selecting = false);
299         ///
300         void cursorLeft(bool internal = true);
301         ///
302         void cursorRight(bool internal = true);
303         ///
304         void cursorLeftOneWord();
305         ///
306         void cursorRightOneWord();
307         ///
308         void cursorUpParagraph();
309         ///
310         void cursorDownParagraph();
311         ///
312         void cursorHome();
313         ///
314         void cursorEnd();
315         ///
316         void cursorPrevious();
317         ///
318         void cursorNext();
319         ///
320         void cursorTop();
321         ///
322         void cursorBottom();
323         ///
324         void Delete();
325         ///
326         void backspace();
327         ///
328         bool selectWordWhenUnderCursor(lyx::word_location);
329         ///
330         enum TextCase {
331                 ///
332                 text_lowercase = 0,
333                 ///
334                 text_capitalization = 1,
335                 ///
336                 text_uppercase = 2
337         };
338         /// Change the case of the word at cursor position.
339         void changeCase(TextCase action);
340
341         ///
342         void toggleInset();
343         ///
344         void cutSelection(bool doclear = true, bool realcut = true);
345         ///
346         void copySelection();
347         ///
348         void pasteSelection(size_t sel_index = 0);
349
350         /** the DTP switches for paragraphs. LyX will store the top settings
351          always in the first physical paragraph, the bottom settings in the
352          last. When a paragraph is broken, the top settings rest, the bottom
353          settings are given to the new one. So I can make shure, they do not
354          duplicate themself (and you cannnot make dirty things with them! )
355          */
356         void setParagraph(bool line_top, bool line_bottom,
357                           bool pagebreak_top, bool pagebreak_bottom,
358                           VSpace const & space_top,
359                           VSpace const & space_bottom,
360                           Spacing const & spacing,
361                           LyXAlignment align,
362                           string const & labelwidthstring,
363                           bool noindent);
364
365         /* these things are for search and replace */
366
367         /**
368          * Sets the selection from the current cursor position to length
369          * characters to the right. No safety checks.
370          */
371         void setSelectionRange(lyx::pos_type length);
372
373         /** simple replacing. The font of the first selected character
374           is used
375           */
376         void replaceSelectionWithString(string const & str);
377
378         /// needed to insert the selection
379         void insertStringAsLines(string const & str);
380         /// needed to insert the selection
381         void insertStringAsParagraphs(string const & str);
382
383         /// Find next inset of some specified type.
384         bool gotoNextInset(std::vector<InsetOld::Code> const & codes,
385                            string const & contents = string());
386         ///
387         void gotoInset(std::vector<InsetOld::Code> const & codes,
388                        bool same_content);
389         ///
390         void gotoInset(InsetOld::Code code, bool same_content);
391         ///
392
393         /* for the greater insets */
394
395         /// returns false if inset wasn't found
396         bool updateInset(InsetOld *);
397         ///
398         void checkParagraph(ParagraphList::iterator pit, lyx::pos_type pos);
399         ///
400         int workWidth() const;
401
402         ///
403         void computeBidiTables(Buffer const *, RowList::iterator row) const;
404         /// Maps positions in the visual string to positions in logical string.
405         lyx::pos_type log2vis(lyx::pos_type pos) const;
406         /// Maps positions in the logical string to positions in visual string.
407         lyx::pos_type vis2log(lyx::pos_type pos) const;
408         ///
409         lyx::pos_type bidi_level(lyx::pos_type pos) const;
410         ///
411         bool bidi_InRange(lyx::pos_type pos) const;
412 private:
413         ///
414         mutable RowList rowlist_;
415
416         ///
417         float getCursorX(RowList::iterator rit, lyx::pos_type pos,
418                          lyx::pos_type last, bool boundary) const;
419         /// used in setlayout
420         void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
421
422         /** forces the redrawing of a paragraph. Needed when manipulating a
423             right address box
424             */
425         void redoDrawingOfParagraph(LyXCursor const & cursor);
426
427         /// removes the row and reset the touched counters
428         void removeRow(RowList::iterator rit);
429
430         /// remove all following rows of the paragraph of the specified row.
431         void removeParagraph(RowList::iterator rit);
432
433         /// insert the specified paragraph behind the specified row
434         void insertParagraph(ParagraphList::iterator pit,
435                              RowList::iterator rowit);
436
437         /** appends  the implizit specified paragraph behind the specified row,
438          * start at the implizit given position */
439         void appendParagraph(RowList::iterator rowit);
440
441         ///
442         void breakAgain(RowList::iterator rit);
443         /// Calculate and set the height of the row
444         void setHeightOfRow(RowList::iterator rit);
445
446         // fix the cursor `cur' after a characters has been deleted at `where'
447         // position. Called by deleteEmptyParagraphMechanism
448         void fixCursorAfterDelete(LyXCursor & cur,
449                                   LyXCursor const & where);
450
451         /// delete double space (false) or empty paragraphs (true) around old_cursor
452         bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
453
454 public:
455         /** Updates all counters starting BEHIND the row. Changed paragraphs
456          * with a dynamic left margin will be rebroken. */
457         void updateCounters();
458         ///
459         void update();
460         /**
461          * Returns an inset if inset was hit, or 0 if not.
462          * If hit, the coordinates are changed relative to the inset.
463          */
464         InsetOld * checkInsetHit(int & x, int & y);
465
466         ///
467         int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
468         ///
469         int singleWidth(ParagraphList::iterator pit,
470                 lyx::pos_type pos, char c) const;
471         /// rebuild row cache
472         void rebuildRows(ParagraphList::iterator pit);
473
474         /// return the color of the canvas
475         LColor::color backgroundColor() const;
476
477         ///
478         mutable bool bidi_same_direction;
479
480         unsigned char transformChar(unsigned char c, Paragraph const & par,
481                                     lyx::pos_type pos) const;
482
483         /**
484          * Returns the left beginning of the text.
485          * This information cannot be taken from the layout object, because
486          * in LaTeX the beginning of the text fits in some cases
487          * (for example sections) exactly the label-width.
488          */
489         int leftMargin(Row const & row) const;
490         ///
491         int rightMargin(Buffer const &, Row const & row) const;
492
493         /** this calculates the specified parameters. needed when setting
494          * the cursor and when creating a visible row */
495         void prepareToPrint(RowList::iterator row, double & x,
496                             double & fill_separator,
497                             double & fill_hfill,
498                             double & fill_label_hfill,
499                             bool bidi = true) const;
500
501 private:
502         ///
503         void setCounter(Buffer const *, ParagraphList::iterator pit);
504         ///
505         void deleteWordForward();
506         ///
507         void deleteWordBackward();
508         ///
509         void deleteLineForward();
510
511         /*
512          * some low level functions
513          */
514
515
516         /// return the pos value *before* which a row should break.
517         /// for example, the pos at which IsNewLine(pos) == true
518         lyx::pos_type rowBreakPoint(Row const & row) const;
519
520         /// returns the minimum space a row needs on the screen in pixel
521         int fill(RowList::iterator row, int workwidth) const;
522
523         /**
524          * returns the minimum space a manual label needs on the
525          * screen in pixels
526          */
527         int labelFill(Row const & row) const;
528
529         /// FIXME
530         int labelEnd(Row const & row) const;
531
532         ///
533         mutable std::vector<lyx::pos_type> log2vis_list;
534         ///
535         mutable std::vector<lyx::pos_type> vis2log_list;
536         ///
537         mutable std::vector<lyx::pos_type> bidi_levels;
538         ///
539         mutable lyx::pos_type bidi_start;
540         ///
541         mutable lyx::pos_type bidi_end;
542
543         ///
544         void charInserted();
545 public:
546         //
547         // special owner functions
548         ///
549         ParagraphList & ownerParagraphs() const;
550
551         /// return true if this is owned by an inset.
552         bool isInInset() const;
553
554 private:
555         /** Cursor related data.
556           Later this variable has to be removed. There should be now internal
557           cursor in a text */
558         ///
559         ///TextCursor cursor_;
560 };
561
562 /// return the default height of a row in pixels, considering font zoom
563 extern int defaultRowHeight();
564
565 #endif // LYXTEXT_H