4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Lars Gullik Bjønnes
11 * Full author contact details are available in file CREDITS.
18 #include "lyxcursor.h"
21 #include "insets/inset.h"
23 #include "bufferview_funcs.h"
24 #include "textcursor.h"
42 This class used to hold the mapping between buffer paragraphs and
43 screen rows. Nowadays, the Paragraphs take care of their rows
44 themselves and this contains just most of the code for manipulating
45 them and interaction with the Cursor.
48 // The inheritance from TextCursor should go. It's just there to ease
50 class LyXText : public TextCursor {
53 LyXText(BufferView *, InsetText *, bool ininset,
54 ParagraphList & paragraphs);
56 void init(BufferView *);
61 /// the current font settings
64 LyXFont real_current_font;
65 /// our buffer's default layout font
68 /// offset of dran area to document start.
71 /// update all cached row positions
72 void updateRowPositions();
74 InsetText * inset_owner;
76 UpdatableInset * the_locking_inset;
79 int getRealCursorX() const;
81 LyXFont getFont(ParagraphList::iterator pit, lyx::pos_type pos) const;
83 LyXFont getLayoutFont(ParagraphList::iterator pit) const;
85 LyXFont getLabelFont(ParagraphList::iterator pit) const;
87 void setCharFont(ParagraphList::iterator pit,
88 lyx::pos_type pos, LyXFont const & font);
89 void setCharFont(ParagraphList::iterator pit,
91 LyXFont const & font, bool toggleall);
93 /// what you expect when pressing <enter> at cursor position
94 void breakParagraph(ParagraphList & paragraphs, char keep_layout = 0);
96 /** set layout over selection and make a total rebreak of
99 ParagraphList::iterator
100 setLayout(LyXCursor & actual_cursor,
101 LyXCursor & selection_start,
102 LyXCursor & selection_end,
103 string const & layout);
105 void setLayout(string const & layout);
108 * Increase or decrease the nesting depth of the selected paragraph(s)
109 * if test_only, don't change any depths. Returns whether something
110 * (would have) changed
112 bool changeDepth(bv_funcs::DEPTH_CHANGE type, bool test_only);
114 /// get the depth at current cursor position
115 int getDepth() const;
117 /** set font over selection and make a total rebreak of those
119 toggleall defaults to false.
121 void setFont(LyXFont const &, bool toggleall = false);
123 /// rebreaks all paragaphs between the given pars.
124 int redoParagraphs(ParagraphList::iterator begin,
125 ParagraphList::iterator end);
126 /// rebreaks the given par
127 void redoParagraph(ParagraphList::iterator pit);
129 /// rebreaks the cursor par
130 void redoParagraph();
132 /// rebreaks the given par, return max row width
133 int redoParagraphInternal(ParagraphList::iterator pit);
137 void toggleFree(LyXFont const &, bool toggleall = false);
140 string getStringToIndex();
142 /** insert a character, moves all the following breaks in the
143 same Paragraph one to the right and make a little rebreak
145 void insertChar(char c);
147 void insertInset(InsetOld * inset);
149 /// a full rebreak of the whole text
151 /// compute text metrics
152 void metrics(MetricsInfo & mi, Dimension & dim);
155 InsetOld::RESULT dispatch(FuncRequest const & cmd);
159 BufferView * bv() const;
161 friend class LyXScreen;
164 /// only the top-level LyXText has this non-zero
165 BufferView * bv_owner;
168 /// returns a pointer to a specified row.
170 getRow(ParagraphList::iterator pit, lyx::pos_type pos) const;
172 /// returns a pointer cursor row
173 RowList::iterator getRow(LyXCursor const & cursor) const;
175 RowList::iterator cursorRow() const;
177 * Return the next row, when cursor is at the end of the
178 * previous row, for insets that take a full row.
180 * FIXME: explain why we need this ? especially for y...
182 RowList::iterator cursorIRow() const;
184 /** returns a pointer to the row near the specified y-coordinate
185 (relative to the whole text). y is set to the real beginning
188 RowList::iterator getRowNearY(int y,
189 ParagraphList::iterator & pit) const;
191 /** returns the column near the specified x-coordinate of the row
192 x is set to the real beginning of this column
194 lyx::pos_type getColumnNearX(ParagraphList::iterator pit,
195 RowList::iterator rit, int & x, bool & boundary) const;
197 /// need the selection cursor:
200 void clearSelection();
202 /// select the word we need depending on word_location
203 void getWord(LyXCursor & from, LyXCursor & to, lyx::word_location const);
204 /// just selects the word the cursor is in
205 void selectWord(lyx::word_location loc);
206 /// returns the inset at cursor (if it exists), 0 otherwise
207 InsetOld * getInset() const;
209 /// accept selected change
212 /// reject selected change
215 /** 'selects" the next word, where the cursor is not in
216 and returns this word as string. THe cursor will be moved
217 to the beginning of this word.
218 With SelectSelectedWord can this be highlighted really
220 WordLangTuple const selectNextWordToSpellcheck(float & value);
222 void selectSelectedWord();
223 /// re-computes the cached coordinates in the cursor
225 /// returns true if par was empty and was removed
226 bool setCursor(ParagraphList::iterator pit,
229 bool boundary = false);
231 void setCursor(LyXCursor &, ParagraphList::iterator pit,
233 bool boundary = false);
235 void setCursorIntern(ParagraphList::iterator pit,
238 bool boundary = false);
240 void setCurrentFont();
243 bool isBoundary(Buffer const &, Paragraph const & par,
244 lyx::pos_type pos) const;
246 bool isBoundary(Buffer const &, Paragraph const & par,
248 LyXFont const & font) const;
251 void setCursorFromCoordinates(int x, int y);
253 void setCursorFromCoordinates(LyXCursor &,
256 void cursorUp(bool selecting = false);
258 void cursorDown(bool selecting = false);
260 void cursorLeft(bool internal = true);
262 void cursorRight(bool internal = true);
264 void cursorLeftOneWord();
266 void cursorRightOneWord();
268 void cursorUpParagraph();
270 void cursorDownParagraph();
276 void cursorPrevious();
288 bool selectWordWhenUnderCursor(lyx::word_location);
294 text_capitalization = 1,
298 /// Change the case of the word at cursor position.
299 void changeCase(TextCase action);
304 void cutSelection(bool doclear = true, bool realcut = true);
306 void copySelection();
308 void pasteSelection(size_t sel_index = 0);
310 /** the DTP switches for paragraphs. LyX will store the top settings
311 always in the first physical paragraph, the bottom settings in the
312 last. When a paragraph is broken, the top settings rest, the bottom
313 settings are given to the new one. So I can make shure, they do not
314 duplicate themself (and you cannnot make dirty things with them! )
316 void setParagraph(bool line_top, bool line_bottom,
317 bool pagebreak_top, bool pagebreak_bottom,
318 VSpace const & space_top,
319 VSpace const & space_bottom,
320 Spacing const & spacing,
322 string const & labelwidthstring,
325 /* these things are for search and replace */
328 * Sets the selection from the current cursor position to length
329 * characters to the right. No safety checks.
331 void setSelectionRange(lyx::pos_type length);
333 /** simple replacing. The font of the first selected character
336 void replaceSelectionWithString(string const & str);
338 /// needed to insert the selection
339 void insertStringAsLines(string const & str);
340 /// needed to insert the selection
341 void insertStringAsParagraphs(string const & str);
343 /// Find next inset of some specified type.
344 bool gotoNextInset(std::vector<InsetOld::Code> const & codes,
345 string const & contents = string());
347 void gotoInset(std::vector<InsetOld::Code> const & codes,
350 void gotoInset(InsetOld::Code code, bool same_content);
353 int workWidth() const;
356 void computeBidiTables(ParagraphList::iterator pit,
357 Buffer const &, RowList::iterator row) const;
358 /// Maps positions in the visual string to positions in logical string.
359 lyx::pos_type log2vis(lyx::pos_type pos) const;
360 /// Maps positions in the logical string to positions in visual string.
361 lyx::pos_type vis2log(lyx::pos_type pos) const;
363 lyx::pos_type bidi_level(lyx::pos_type pos) const;
365 bool bidi_InRange(lyx::pos_type pos) const;
368 float getCursorX(ParagraphList::iterator pit,
369 RowList::iterator rit, lyx::pos_type pos,
370 lyx::pos_type last, bool boundary) const;
371 /// used in setlayout
372 void makeFontEntriesLayoutSpecific(BufferParams const &, Paragraph & par);
374 /// Calculate and set the height of the row
375 void setHeightOfRow(ParagraphList::iterator, RowList::iterator rit);
377 // fix the cursor `cur' after a characters has been deleted at `where'
378 // position. Called by deleteEmptyParagraphMechanism
379 void fixCursorAfterDelete(LyXCursor & cur, LyXCursor const & where);
381 /// delete double space (false) or empty paragraphs (true) around old_cursor
382 bool deleteEmptyParagraphMechanism(LyXCursor const & old_cursor);
385 /** Updates all counters starting BEHIND the row. Changed paragraphs
386 * with a dynamic left margin will be rebroken. */
387 void updateCounters();
389 * Returns an inset if inset was hit, or 0 if not.
390 * If hit, the coordinates are changed relative to the inset.
392 InsetOld * checkInsetHit(int & x, int & y);
395 int singleWidth(ParagraphList::iterator pit, lyx::pos_type pos) const;
397 int singleWidth(ParagraphList::iterator pit,
398 lyx::pos_type pos, char c, LyXFont const & Font) const;
400 /// return the color of the canvas
401 LColor::color backgroundColor() const;
404 mutable bool bidi_same_direction;
406 unsigned char transformChar(unsigned char c, Paragraph const & par,
407 lyx::pos_type pos) const;
410 * Returns the left beginning of the text.
411 * This information cannot be taken from the layout object, because
412 * in LaTeX the beginning of the text fits in some cases
413 * (for example sections) exactly the label-width.
415 int leftMargin(ParagraphList::iterator pit, Row const & row) const;
417 int rightMargin(ParagraphList::iterator pit, Buffer const &, Row const & row) const;
419 /** this calculates the specified parameters. needed when setting
420 * the cursor and when creating a visible row */
421 void prepareToPrint(ParagraphList::iterator pit,
422 RowList::iterator row) const;
426 void setCounter(Buffer const &, ParagraphList::iterator pit);
428 void deleteWordForward();
430 void deleteWordBackward();
432 void deleteLineForward();
435 * some low level functions
439 /// sets row.end to the pos value *after* which a row should break.
440 /// for example, the pos after which isNewLine(pos) == true
441 lyx::pos_type rowBreakPoint(ParagraphList::iterator pit,
442 Row const & row) const;
444 /// returns the minimum space a row needs on the screen in pixel
445 int fill(ParagraphList::iterator pit,
446 RowList::iterator row, int workwidth) const;
449 * returns the minimum space a manual label needs on the
452 int labelFill(ParagraphList::iterator pit, Row const & row) const;
455 int labelEnd(ParagraphList::iterator pit, Row const & row) const;
458 mutable std::vector<lyx::pos_type> log2vis_list;
460 mutable std::vector<lyx::pos_type> vis2log_list;
462 mutable std::vector<lyx::pos_type> bidi_levels;
464 mutable lyx::pos_type bidi_start;
466 mutable lyx::pos_type bidi_end;
469 const bool in_inset_;
471 ParagraphList & paragraphs_;
477 // special owner functions
479 ParagraphList & ownerParagraphs() const;
481 /// return true if this is owned by an inset.
482 bool isInInset() const;
484 /// return first row of text
485 RowList::iterator firstRow() const;
486 /// return last row of text
487 RowList::iterator lastRow() const;
488 /// return row "behind" last row of text
489 RowList::iterator endRow() const;
490 /// return next row crossing paragraph boundaries
491 void nextRow(ParagraphList::iterator & pit,
492 RowList::iterator & rit) const;
493 /// return previous row crossing paragraph boundaries
494 void previousRow(ParagraphList::iterator & pit,
495 RowList::iterator & rit) const;
501 /** Cursor related data.
502 Later this variable has to be removed. There should be now internal
505 ///TextCursor cursor_;
508 /// return the default height of a row in pixels, considering font zoom
509 extern int defaultRowHeight();