src/Paragraph.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Paragraph.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Jürgen Vigna
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #ifndef PARAGRAPH_H
  17 #define PARAGRAPH_H
  18
  19 #include "FontEnums.h"
  20 #include "LayoutEnums.h"
  21 #include "SpellChecker.h"
  22
  23 #include "support/strfwd.h"
  24 #include "support/types.h"
  25
  26 #include <set>
  27
  28 namespace lyx {
  29
  30 class AuthorList;
  31 class Buffer;
  32 class BufferParams;
  33 class Change;
  34 class Counters;
  35 class Cursor;
  36 class CursorSlice;
  37 class DocIterator;
  38 class docstring_list;
  39 class DocumentClass;
  40 class Inset;
  41 class InsetBibitem;
  42 class LaTeXFeatures;
  43 class InsetList;
  44 class Language;
  45 class Layout;
  46 class Font;
  47 class MetricsInfo;
  48 class OutputParams;
  49 class PainterInfo;
  50 class ParagraphParameters;
  51 class TocBackend;
  52 class WordLangTuple;
  53 class XMLStream;
  54 class otexstream;
  55
  56 class FontSpan {
  57 public:
  58         /// Invalid font span containing no character
  59         FontSpan() : first(0), last(-1) {}
  60         /// Span including first and last
  61         FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
  62
  63 public:
  64         /// Range including first and last.
  65         pos_type first, last;
  66
  67         inline bool operator<(FontSpan const & s) const
  68         {
  69                 return first < s.first;
  70         }
  71
  72         inline bool operator==(FontSpan const & s) const
  73         {
  74                 return first == s.first && last == s.last;
  75         }
  76
  77         inline bool contains(pos_type p) const
  78         {
  79                 return first <= p && p <= last;
  80         }
  81
  82         inline size_t size() const
  83         {
  84                 return empty() ? 0 : last - first;
  85         }
  86
  87
  88         inline FontSpan intersect(FontSpan const & f) const
  89         {
  90                 FontSpan result = FontSpan();
  91                 if (contains(f.first))
  92                         result.first = f.first;
  93                 else if (f.contains(first))
  94                         result.first = first;
  95                 else
  96                         return result;
  97                 if (contains(f.last))
  98                         result.last = f.last;
  99                 else if (f.contains(last))
 100                         result.last = last;
 101                 return result;
 102         }
 103
 104         inline bool empty() const
 105         {
 106                 return first > last;
 107         }
 108 };
 109
 110 ///
 111 enum TextCase {
 112         ///
 113         text_lowercase = 0,
 114         ///
 115         text_capitalization = 1,
 116         ///
 117         text_uppercase = 2
 118 };
 119
 120
 121 ///
 122 enum AsStringParameter
 123 {
 124         AS_STR_NONE = 0, ///< No option, only printable characters.
 125         AS_STR_LABEL = 1, ///< Prefix with paragraph label.
 126         AS_STR_INSETS = 2, ///< Go into insets.
 127         AS_STR_NEWLINES = 4, ///< Get also newline characters.
 128         AS_STR_SKIPDELETE = 8, ///< Skip deleted text in change tracking.
 129         AS_STR_PLAINTEXT = 16 ///< Don't export formatting when descending into insets.
 130 };
 131
 132
 133 /// A Paragraph holds all text, attributes and insets in a text paragraph
 134 class Paragraph
 135 {
 136 public:
 137         ///
 138         Paragraph();
 139         /// Copy constructor.
 140         Paragraph(Paragraph const &);
 141         /// Partial copy constructor.
 142         /// Copy the Paragraph contents from \p beg to \p end (without end).
 143         Paragraph(Paragraph const & par, pos_type beg, pos_type end);
 144         ///
 145         Paragraph & operator=(Paragraph const &);
 146         ///
 147         ~Paragraph();
 148         ///
 149         int id() const;
 150         ///
 151         void setId(int id);
 152
 153         ///
 154         void addChangesToToc(DocIterator const & cdit, Buffer const & buf,
 155                              bool output_active, TocBackend & backend) const;
 156         ///
 157         Language const * getParLanguage(BufferParams const &) const;
 158         ///
 159         bool isRTL(BufferParams const &) const;
 160         ///
 161         void changeLanguage(BufferParams const & bparams,
 162                             Language const * from, Language const * to);
 163         ///
 164         bool isMultiLingual(BufferParams const &) const;
 165         ///
 166         void getLanguages(std::set<Language const *> &) const;
 167
 168         /// Convert the paragraph to a string.
 169         /// \param AsStringParameter options. This can contain any combination of
 170         /// asStringParameter values. Valid examples:
 171         ///             asString(AS_STR_LABEL)
 172         ///             asString(AS_STR_LABEL | AS_STR_INSETS)
 173         ///             asString(AS_STR_INSETS)
 174         docstring asString(int options = AS_STR_NONE) const;
 175
 176         /// Convert the paragraph to a string.
 177         /// \note If options includes AS_STR_PLAINTEXT, then runparams must be != 0
 178         docstring asString(pos_type beg, pos_type end,
 179                            int options = AS_STR_NONE,
 180                            const OutputParams *runparams = 0) const;
 181         ///
 182         void forOutliner(docstring &, size_t maxlen, bool shorten = true,
 183                          bool label = true) const;
 184
 185         ///
 186         void write(std::ostream &, BufferParams const &,
 187                 depth_type & depth) const;
 188         ///
 189         void validate(LaTeXFeatures &) const;
 190
 191         /// \param force means: output even if layout.inpreamble is true.
 192         void latex(BufferParams const &, Font const & outerfont, otexstream &,
 193                 OutputParams const &, int start_pos = 0, int end_pos = -1,
 194                 bool force = false) const;
 195
 196         /// Can we drop the standard paragraph wrapper?
 197         bool emptyTag() const;
 198
 199         /// Get the id of the paragraph, usefull for docbook
 200         std::string getID(Buffer const & buf, OutputParams const & runparams) const;
 201
 202         /// Output the first word of a paragraph, return the position where it left.
 203         pos_type firstWordDocBook(XMLStream & xs, OutputParams const & runparams) const;
 204
 205         /// Output the first word of a paragraph, return the position where it left.
 206         pos_type firstWordLyXHTML(XMLStream & xs, OutputParams const & runparams) const;
 207
 208         /// Writes to stream the DocBook representation
 209         void simpleDocBookOnePar(Buffer const & buf,
 210                                                          XMLStream &,
 211                                                          OutputParams const & runparams,
 212                                                          Font const & outerfont,
 213                                                          bool start_paragraph = true,
 214                                                          bool close_paragraph = true,
 215                                                          pos_type initial = 0) const;
 216
 217         /// \return any material that has had to be deferred until after the
 218         /// paragraph has closed.
 219         docstring simpleLyXHTMLOnePar(Buffer const & buf,
 220                                                                   XMLStream & xs,
 221                                                                   OutputParams const & runparams,
 222                                                                   Font const & outerfont,
 223                                                                   bool start_paragraph = true,
 224                                                                   bool close_paragraph = true,
 225                                                                   pos_type initial = 0) const;
 226
 227         ///
 228         bool hasSameLayout(Paragraph const & par) const;
 229
 230         ///
 231         void makeSameLayout(Paragraph const & par);
 232
 233         ///
 234         void setInsetOwner(Inset const * inset);
 235         ///
 236         Inset const & inInset() const;
 237         ///
 238         bool allowParagraphCustomization() const;
 239         ///
 240         bool usePlainLayout() const;
 241         ///
 242         bool isPassThru() const;
 243         ///
 244         pos_type size() const;
 245         ///
 246         bool empty() const;
 247
 248         ///
 249         Layout const & layout() const;
 250         /// Do not pass a temporary to this!
 251         void setLayout(Layout const & layout);
 252         ///
 253         void setPlainOrDefaultLayout(DocumentClass const & tc);
 254         ///
 255         void setDefaultLayout(DocumentClass const & tc);
 256         ///
 257         void setPlainLayout(DocumentClass const & tc);
 258
 259         /// This is the item depth, only used by enumerate and itemize
 260         signed char itemdepth;
 261
 262         /// look up change at given pos
 263         Change const & lookupChange(pos_type pos) const;
 264
 265         /// is there a change within the given range (does not
 266         /// check contained paragraphs)
 267         bool isChanged(pos_type start, pos_type end) const;
 268         /// Are there insets containing changes in the range?
 269         bool hasChangedInsets(pos_type start, pos_type end) const;
 270         /// is there an unchanged char at the given pos ?
 271         bool isChanged(pos_type pos) const;
 272         /// is there a change in the paragraph ?
 273         bool isChanged() const;
 274
 275         /// is there an insertion at the given pos ?
 276         bool isInserted(pos_type pos) const;
 277         /// is there a deletion at the given pos ?
 278         bool isDeleted(pos_type pos) const;
 279         /// is the whole paragraph deleted ?
 280         bool isDeleted(pos_type start, pos_type end) const;
 281
 282         /// will the paragraph be physically merged with the next
 283         /// one if the imaginary end-of-par character is logically deleted?
 284         bool isMergedOnEndOfParDeletion(bool trackChanges) const;
 285         /// Return Change form of paragraph break
 286         Change parEndChange() const;
 287
 288         /// set change for the entire par
 289         void setChange(Change const & change);
 290
 291         /// set change at given pos
 292         void setChange(pos_type pos, Change const & change);
 293
 294         /// accept changes within the given range
 295         void acceptChanges(pos_type start, pos_type end);
 296
 297         /// reject changes within the given range
 298         void rejectChanges(pos_type start, pos_type end);
 299
 300         /// Paragraphs can contain "manual labels", for example, Description
 301         /// environment. The text for this user-editable label is stored in
 302         /// the paragraph alongside the text of the rest of the paragraph
 303         /// (the body). This function returns the starting position of the
 304         /// body of the text in the paragraph.
 305         pos_type beginOfBody() const;
 306         /// recompute this value
 307         void setBeginOfBody();
 308
 309         ///
 310         docstring expandLabel(Layout const &, BufferParams const &) const;
 311         ///
 312         docstring const & labelString() const;
 313         /// the next two functions are for the manual labels
 314         docstring const getLabelWidthString() const;
 315         /// Set label width string.
 316         void setLabelWidthString(docstring const & s);
 317         /// Actual paragraph alignment used
 318         LyXAlignment getAlign(BufferParams const &) const;
 319         /// Default paragraph alignment as determined by layout
 320         LyXAlignment getDefaultAlign(BufferParams const &) const;
 321         /// The nesting depth of a paragraph
 322         depth_type getDepth() const;
 323         /// The maximal possible depth of a paragraph after this one
 324         depth_type getMaxDepthAfter() const;
 325         ///
 326         void applyLayout(Layout const & new_layout);
 327
 328         /// (logically) erase the char at pos; return true if it was actually erased
 329         bool eraseChar(pos_type pos, bool trackChanges);
 330         /// (logically) erase the given range; return the number of chars actually erased
 331         int eraseChars(pos_type start, pos_type end, bool trackChanges);
 332
 333         ///
 334         void resetFonts(Font const & font);
 335
 336         /** Get uninstantiated font setting. Returns the difference
 337             between the characters font and the layoutfont.
 338             This is what is stored in the fonttable
 339         */
 340         Font const &
 341         getFontSettings(BufferParams const &, pos_type pos) const;
 342         ///
 343         Font const & getFirstFontSettings(BufferParams const &) const;
 344
 345         /** Get fully instantiated font, i.e., one that does not have any
 346             attributes with values FONT_INHERIT, FONT_IGNORE or FONT_TOGGLE.
 347         */
 348         Font const getFont(BufferParams const &, pos_type pos,
 349                               Font const & outerfont) const;
 350         Font const getLayoutFont(BufferParams const &,
 351                                     Font const & outerfont) const;
 352         Font const getLabelFont(BufferParams const &,
 353                                    Font const & outerfont) const;
 354         /**
 355          * The font returned by the above functions is the same in a
 356          * span of characters. This method will return the first and
 357          * the last positions in the paragraph for which that font is
 358          * the same. This can be used to avoid unnecessary calls to getFont.
 359          */
 360         FontSpan fontSpan(pos_type pos) const;
 361         ///
 362         char_type getChar(pos_type pos) const;
 363         /// Get the char, but mirror all bracket characters if it is right-to-left
 364         char_type getUChar(BufferParams const &, OutputParams const &,
 365                            pos_type pos) const;
 366         /// pos <= size() (there is a dummy font change at the end of each par)
 367         void setFont(pos_type pos, Font const & font);
 368         ///
 369         void insert(pos_type pos, docstring const & str,
 370                     Font const & font, Change const & change);
 371
 372         ///
 373         void appendString(docstring const & s, Font const & font,
 374                 Change const & change);
 375         ///
 376         void appendChar(char_type c, Font const & font, Change const & change);
 377         ///
 378         void insertChar(pos_type pos, char_type c, bool trackChanges);
 379         ///
 380         void insertChar(pos_type pos, char_type c,
 381                         Font const &, bool trackChanges);
 382         ///
 383         void insertChar(pos_type pos, char_type c,
 384                         Font const &, Change const & change);
 385         /// Insert \p inset at position \p pos with \p change traking status and
 386         /// \p font.
 387         /// \return true if successful.
 388         bool insertInset(pos_type pos, Inset * inset,
 389                          Font const & font, Change const & change);
 390         ///
 391         Inset * getInset(pos_type pos);
 392         ///
 393         Inset const * getInset(pos_type pos) const;
 394
 395         /// Release inset at given position.
 396         /// \warning does not honour change tracking!
 397         /// Therefore, it should only be used for breaking and merging
 398         /// paragraphs
 399         Inset * releaseInset(pos_type pos);
 400
 401         ///
 402         InsetList const & insetList() const;
 403         ///
 404         void setInsetBuffers(Buffer &);
 405         ///
 406         void resetBuffer();
 407
 408         ///
 409         bool isHfill(pos_type pos) const;
 410
 411         /// hinted by profiler
 412         bool isInset(pos_type pos) const;
 413         ///
 414         bool isNewline(pos_type pos) const;
 415         ///
 416         bool isEnvSeparator(pos_type pos) const;
 417         /// return true if the char is a word separator
 418         bool isSeparator(pos_type pos) const;
 419         ///
 420         bool isLineSeparator(pos_type pos) const;
 421         /// True if the character/inset at this point is a word separator.
 422         /// Note that digits in particular are not considered as word separator.
 423         bool isWordSeparator(pos_type pos, bool const ignore_deleted = false) const;
 424         /// True if the element at this point is a character that is not a letter.
 425         bool isChar(pos_type pos) const;
 426         /// True if the element at this point is a space
 427         bool isSpace(pos_type pos) const;
 428         /// True if the element at this point is a hard hyphen or a apostrophe
 429         /// If it is enclosed by spaces return false
 430         bool isHardHyphenOrApostrophe(pos_type pos) const;
 431         /// Return true if this paragraph has verbatim content that needs to be
 432         /// protected by \cprotect
 433         bool needsCProtection(bool const fragile = false) const;
 434
 435         /// returns true if at least one line break or line separator has been deleted
 436         /// at the beginning of the paragraph (either physically or logically)
 437         bool stripLeadingSpaces(bool trackChanges);
 438
 439         /// return true if we allow multiple spaces
 440         bool isFreeSpacing() const;
 441
 442         /// return true if we allow this par to stay empty
 443         bool allowEmpty() const;
 444         ///
 445         ParagraphParameters & params();
 446         ///
 447         ParagraphParameters const & params() const;
 448
 449         /// Check whether a call to fixBiblio is needed.
 450         bool brokenBiblio() const;
 451         /// Check if we are in a Biblio environment and insert or
 452         /// delete InsetBibitems as necessary.
 453         /// \retval int 1, if we had to add an inset, in which case
 454         /// the cursor will need to move cursor forward; -pos, if we deleted
 455         /// an inset, in which case pos is the position from which the inset
 456         /// was deleted, and the cursor will need to be moved back one if it
 457         /// was previously past that position. Return 0 otherwise.
 458         int fixBiblio(Buffer const & buffer);
 459
 460         /// For each author, set 'used' to true if there is a change
 461         /// by this author in the paragraph.
 462         void checkAuthors(AuthorList const & authorList);
 463
 464         ///
 465         void changeCase(BufferParams const & bparams, pos_type pos,
 466                 pos_type & right, TextCase action);
 467
 468         /// find \param str string inside Paragraph.
 469         /// \return non-zero if the specified string is at the specified
 470         ///     position; returned value is the actual match length in positions
 471         /// \param del specifies whether deleted strings in ct mode will be considered
 472         int find(
 473                 docstring const & str, ///< string to search
 474                 bool cs, ///<
 475                 bool mw, ///<
 476                 pos_type pos, ///< start from here.
 477                 bool del = true) const;
 478
 479         void locateWord(pos_type & from, pos_type & to,
 480                 word_location const loc, bool const ignore_deleted = false) const;
 481         ///
 482         void updateWords();
 483
 484         /// Spellcheck word at position \p from and fill in found misspelled word
 485         /// and \p suggestions if \p do_suggestion is true.
 486         /// \return result from spell checker, SpellChecker::UNKNOWN_WORD when misspelled.
 487         SpellChecker::Result spellCheck(pos_type & from, pos_type & to, WordLangTuple & wl,
 488                 docstring_list & suggestions, bool do_suggestion =  true,
 489                 bool check_learned = false) const;
 490
 491         /// Spell checker status at position \p pos.
 492         /// If \p check_boundary is true the status of position immediately
 493         /// before \p pos is tested too if it is at word boundary.
 494         /// \return true if one of the tested positions is misspelled.
 495         bool isMisspelled(pos_type pos, bool check_boundary = false) const;
 496
 497         /// \return the spell range (misspelled area) around position.
 498         /// Range is empty if word at position is correctly spelled.
 499         FontSpan const & getSpellRange(pos_type pos) const;
 500
 501         /// spell check of whole paragraph
 502         /// remember results until call of requestSpellCheck()
 503         void spellCheck() const;
 504
 505         /// query state of spell checker results
 506         bool needsSpellCheck() const;
 507         /// mark position of text manipulation to inform the spell checker
 508         /// default value -1 marks the whole paragraph to be checked (again)
 509         void requestSpellCheck(pos_type pos = -1);
 510
 511         /// an automatically generated identifying label for this paragraph.
 512         /// presently used only in the XHTML output routines.
 513         std::string magicLabel() const;
 514
 515         /// anonymizes the paragraph contents (but not the paragraphs
 516         /// contained inside it. Does not handle undo.
 517         void anonymize();
 518
 519 private:
 520         /// Expand the counters for the labelstring of \c layout
 521         docstring expandParagraphLabel(Layout const &, BufferParams const &,
 522                 bool process_appendix) const;
 523         ///
 524         void deregisterWords();
 525         ///
 526         void collectWords();
 527         ///
 528         void registerWords();
 529
 530         /// Pimpl away stuff
 531         class Private;
 532         ///
 533         friend class Paragraph::Private;
 534         ///
 535         Private * d;
 536 };
 537
 538 } // namespace lyx
 539
 540 #endif // PARAGRAPH_H