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 "Layout.h"
  21
  22 #include "insets/InsetCode.h"
  23
  24 #include "support/strfwd.h"
  25 #include "support/types.h"
  26
  27 namespace lyx {
  28
  29 class AuthorList;
  30 class Buffer;
  31 class BufferParams;
  32 class Change;
  33 class Counters;
  34 class Cursor;
  35 class CursorSlice;
  36 class DocIterator;
  37 class DocumentClass;
  38 class Inset;
  39 class InsetBibitem;
  40 class LaTeXFeatures;
  41 class Inset_code;
  42 class InsetList;
  43 class Language;
  44 class Font;
  45 class Font_size;
  46 class MetricsInfo;
  47 class OutputParams;
  48 class PainterInfo;
  49 class ParagraphParameters;
  50 class TexRow;
  51 class Toc;
  52
  53 class FontSpan {
  54 public:
  55         /// Invalid font span containing no character
  56         FontSpan() : first(0), last(-1) {}
  57         /// Span including first and last
  58         FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
  59
  60 public:
  61         /// Range including first and last.
  62         pos_type first, last;
  63 };
  64
  65 ///
  66 enum TextCase {
  67         ///
  68         text_lowercase = 0,
  69         ///
  70         text_capitalization = 1,
  71         ///
  72         text_uppercase = 2
  73 };
  74
  75
  76 ///
  77 enum AsStringParameter
  78 {
  79         AS_STR_NONE = 0, ///< No option, only printable characters.
  80         AS_STR_LABEL = 1, ///< Prefix with paragraph label.
  81         AS_STR_INSETS = 2, ///< Go into insets.
  82         AS_STR_NEWLINES = 4 ///< Get also newline characters.
  83 };
  84
  85
  86 /// A Paragraph holds all text, attributes and insets in a text paragraph
  87 class Paragraph
  88 {
  89 public:
  90         ///
  91         Paragraph();
  92         ///
  93         Paragraph(Paragraph const &);
  94         /// Partial copy constructor.
  95         /// Copy the Paragraph contents from \p beg to \p end (without end).
  96         Paragraph(Paragraph const & par, pos_type beg, pos_type end);
  97         ///
  98         Paragraph & operator=(Paragraph const &);
  99         ///
 100         ~Paragraph();
 101         ///
 102         int id() const;
 103
 104         ///
 105         void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const;
 106         ///
 107         Language const * getParLanguage(BufferParams const &) const;
 108         ///
 109         bool isRTL(BufferParams const &) const;
 110         ///
 111         void changeLanguage(BufferParams const & bparams,
 112                             Language const * from, Language const * to);
 113         ///
 114         bool isMultiLingual(BufferParams const &) const;
 115
 116         /// Convert the paragraph to a string.
 117         /// \param AsStringParameter options. This can contain any combination of
 118         /// asStringParameter values. Valid examples:
 119         ///             asString(AS_STR_LABEL)
 120         ///             asString(AS_STR_LABEL | AS_STR_INSETS)
 121         ///             asString(AS_STR_INSETS)
 122         docstring asString(int options = AS_STR_NONE) const;
 123         ///
 124         docstring asString(pos_type beg, pos_type end,
 125                 int options = AS_STR_NONE) const;
 126
 127         /// Extract only the explicitly visible text (without any formatting),
 128         /// descending into insets
 129         docstring stringify(pos_type beg, pos_type end, int options, OutputParams & runparams) const;
 130
 131         ///
 132         void write(std::ostream &, BufferParams const &,
 133                    depth_type & depth) const;
 134         ///
 135         void validate(LaTeXFeatures &) const;
 136
 137         ///
 138         bool latex(BufferParams const &, Font const & outerfont, odocstream &,
 139                    TexRow & texrow, OutputParams const &,
 140                    int start_pos = 0, int end_pos = -1) const;
 141
 142         /// Can we drop the standard paragraph wrapper?
 143         bool emptyTag() const;
 144
 145         /// Get the id of the paragraph, usefull for docbook
 146         std::string getID(Buffer const & buf, OutputParams const & runparams) const;
 147
 148         /// Get the first word of a paragraph, return the position where it left
 149         pos_type firstWord(odocstream & os, OutputParams const & runparams) const;
 150
 151         /// Writes to stream the docbook representation
 152         void simpleDocBookOnePar(Buffer const & buf,
 153                                  odocstream &,
 154                                  OutputParams const & runparams,
 155                                  Font const & outerfont,
 156                                  pos_type initial = 0) const;
 157
 158         ///
 159         bool hasSameLayout(Paragraph const & par) const;
 160
 161         ///
 162         void makeSameLayout(Paragraph const & par);
 163
 164         ///
 165         void setInsetOwner(Inset const * inset);
 166         ///
 167         Inset const & inInset() const;
 168         ///
 169         InsetCode ownerCode() const;
 170         ///
 171         bool forcePlainLayout() const;
 172         ///
 173         bool allowParagraphCustomization() const;
 174         ///
 175         bool usePlainLayout() const;
 176         ///
 177         pos_type size() const;
 178         ///
 179         bool empty() const;
 180
 181         ///
 182         Layout const & layout() const;
 183         /// Do not pass a temporary to this!
 184         void setLayout(Layout const & layout);
 185         ///
 186         void setPlainOrDefaultLayout(DocumentClass const & tc);
 187         ///
 188         void setDefaultLayout(DocumentClass const & tc);
 189         ///
 190         void setPlainLayout(DocumentClass const & tc);
 191
 192         /// This is the item depth, only used by enumerate and itemize
 193         signed char itemdepth;
 194
 195         /// look up change at given pos
 196         Change const & lookupChange(pos_type pos) const;
 197
 198         /// is there a change within the given range ?
 199         bool isChanged(pos_type start, pos_type end) const;
 200         /// is there an unchanged char at the given pos ?
 201         bool isUnchanged(pos_type pos) const;
 202         /// is there an insertion at the given pos ?
 203         bool isInserted(pos_type pos) const;
 204         /// is there a deletion at the given pos ?
 205         bool isDeleted(pos_type pos) const;
 206
 207         /// will the paragraph be physically merged with the next
 208         /// one if the imaginary end-of-par character is logically deleted?
 209         bool isMergedOnEndOfParDeletion(bool trackChanges) const;
 210
 211         /// set change for the entire par
 212         void setChange(Change const & change);
 213
 214         /// set change at given pos
 215         void setChange(pos_type pos, Change const & change);
 216
 217         /// accept changes within the given range
 218         void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
 219
 220         /// reject changes within the given range
 221         void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
 222
 223         /// Paragraphs can contain "manual labels", for example, Description
 224         /// environment. The text for this user-editable label is stored in
 225         /// the paragraph alongside the text of the rest of the paragraph
 226         /// (the body). This function returns the starting position of the
 227         /// body of the text in the paragraph.
 228         pos_type beginOfBody() const;
 229         /// recompute this value
 230         void setBeginOfBody();
 231
 232         ///
 233         docstring const & labelString() const;
 234
 235         /// the next two functions are for the manual labels
 236         docstring const getLabelWidthString() const;
 237         /// Set label width string.
 238         void setLabelWidthString(docstring const & s);
 239         /// translate \p label to the paragraph language if possible.
 240         docstring const translateIfPossible(docstring const & label,
 241                 BufferParams const & bparams) const;
 242         /// Expand the counters for the labelstring of \c layout
 243         docstring expandLabel(Layout const &, BufferParams const &,
 244                 bool process_appendix = true) const;
 245         /// Actual paragraph alignment used
 246         char getAlign() const;
 247         /// The nesting depth of a paragraph
 248         depth_type getDepth() const;
 249         /// The maximal possible depth of a paragraph after this one
 250         depth_type getMaxDepthAfter() const;
 251         ///
 252         void applyLayout(Layout const & new_layout);
 253
 254         /// (logically) erase the char at pos; return true if it was actually erased
 255         bool eraseChar(pos_type pos, bool trackChanges);
 256         /// (logically) erase the given range; return the number of chars actually erased
 257         int eraseChars(pos_type start, pos_type end, bool trackChanges);
 258
 259         ///
 260         void resetFonts(Font const & font);
 261
 262         /** Get uninstantiated font setting. Returns the difference
 263             between the characters font and the layoutfont.
 264             This is what is stored in the fonttable
 265         */
 266         Font const &
 267         getFontSettings(BufferParams const &, pos_type pos) const;
 268         ///
 269         Font const & getFirstFontSettings(BufferParams const &) const;
 270
 271         /** Get fully instantiated font. If pos == -1, use the layout
 272             font attached to this paragraph.
 273             If pos == -2, use the label font of the layout attached here.
 274             In all cases, the font is instantiated, i.e. does not have any
 275             attributes with values FONT_INHERIT, FONT_IGNORE or
 276             FONT_TOGGLE.
 277         */
 278         Font const getFont(BufferParams const &, pos_type pos,
 279                               Font const & outerfont) const;
 280         Font const getLayoutFont(BufferParams const &,
 281                                     Font const & outerfont) const;
 282         Font const getLabelFont(BufferParams const &,
 283                                    Font const & outerfont) const;
 284         /**
 285          * The font returned by the above functions is the same in a
 286          * span of characters. This method will return the first and
 287          * the last positions in the paragraph for which that font is
 288          * the same. This can be used to avoid unnecessary calls to getFont.
 289          */
 290         FontSpan fontSpan(pos_type pos) const;
 291         ///
 292         char_type getChar(pos_type pos) const;
 293         /// Get the char, but mirror all bracket characters if it is right-to-left
 294         char_type getUChar(BufferParams const &, pos_type pos) const;
 295         /// pos <= size() (there is a dummy font change at the end of each par)
 296         void setFont(pos_type pos, Font const & font);
 297         /// Returns the height of the highest font in range
 298         FontSize highestFontInRange(pos_type startpos,
 299                                         pos_type endpos, FontSize def_size) const;
 300         ///
 301         void insert(pos_type pos, docstring const & str,
 302                     Font const & font, Change const & change);
 303
 304         ///
 305         void appendString(docstring const & s, Font const & font,
 306                 Change const & change);
 307         ///
 308         void appendChar(char_type c, Font const & font, Change const & change);
 309         ///
 310         void insertChar(pos_type pos, char_type c, bool trackChanges);
 311         ///
 312         void insertChar(pos_type pos, char_type c,
 313                         Font const &, bool trackChanges);
 314         ///
 315         void insertChar(pos_type pos, char_type c,
 316                         Font const &, Change const & change);
 317         /// Insert \p inset at position \p pos with \p change traking status.
 318         /// \return true if successful.
 319         bool insertInset(pos_type pos, Inset * inset,
 320                          Change const & change);
 321         /// Insert \p inset at position \p pos with \p change traking status and
 322         /// \p font.
 323         /// \return true if successful.
 324         bool insertInset(pos_type pos, Inset * inset,
 325                          Font const & font, Change const & change);
 326         ///
 327         Inset * getInset(pos_type pos);
 328         ///
 329         Inset const * getInset(pos_type pos) const;
 330
 331         /// Release inset at given position.
 332         /// \warning does not honour change tracking!
 333         /// Therefore, it should only be used for breaking and merging
 334         /// paragraphs
 335         Inset * releaseInset(pos_type pos);
 336
 337         ///
 338         InsetList const & insetList() const;
 339         ///
 340         void setBuffer(Buffer &);
 341
 342         ///
 343         bool isHfill(pos_type pos) const;
 344
 345         /// hinted by profiler
 346         bool isInset(pos_type pos) const;
 347         ///
 348         bool isNewline(pos_type pos) const;
 349         /// return true if the char is a word separator
 350         bool isSeparator(pos_type pos) const;
 351         ///
 352         bool isLineSeparator(pos_type pos) const;
 353         /// True if the character/inset at this point can be part of a word.
 354         /// Note that digits in particular are considered as letters
 355         bool isLetter(pos_type pos) const;
 356         /// True if the element at this point is a character that is not a letter.
 357         bool isChar(pos_type pos) const;
 358         /// True if the element at this point is a space
 359         bool isSpace(pos_type pos) const;
 360
 361         /// returns true if at least one line break or line separator has been deleted
 362         /// at the beginning of the paragraph (either physically or logically)
 363         bool stripLeadingSpaces(bool trackChanges);
 364
 365         /// return true if we allow multiple spaces
 366         bool isFreeSpacing() const;
 367
 368         /// return true if we allow this par to stay empty
 369         bool allowEmpty() const;
 370         ///
 371         char_type transformChar(char_type c, pos_type pos) const;
 372         ///
 373         ParagraphParameters & params();
 374         ///
 375         ParagraphParameters const & params() const;
 376
 377         /// Check if we are in a Biblio environment and insert or
 378         /// delete InsetBibitems as necessary.
 379         /// \retval int 1, if we had to add an inset, in which case
 380         /// the cursor will need to move cursor forward; -pos, if we deleted
 381         /// an inset, in which case pos is the position from which the inset
 382         /// was deleted, and the cursor will need to be moved back one if it
 383         /// was previously past that position. Return 0 otherwise.
 384         int checkBiblio(Buffer const & buffer);
 385
 386         /// For each author, set 'used' to true if there is a change
 387         /// by this author in the paragraph.
 388         void checkAuthors(AuthorList const & authorList);
 389
 390         ///
 391         void changeCase(BufferParams const & bparams, pos_type pos,
 392                 pos_type & right, TextCase action);
 393
 394         /// find \param str string inside Paragraph.
 395         /// \return true if the specified string is at the specified position
 396         /// \param del specifies whether deleted strings in ct mode will be considered
 397         bool find(
 398                 docstring const & str, ///< string to search
 399                 bool cs, ///<
 400                 bool mw, ///<
 401                 pos_type pos, ///< start from here.
 402                 bool del = true) const;
 403
 404         void locateWord(pos_type & from, pos_type & to,
 405                 word_location const loc) const;
 406         ///
 407         void updateWords(CursorSlice const & sl);
 408
 409 private:
 410         ///
 411         void deregisterWords();
 412         ///
 413         void collectWords(CursorSlice const & sl);
 414         ///
 415         void registerWords();
 416
 417         /// Pimpl away stuff
 418         class Private;
 419         ///
 420         friend class Paragraph::Private;
 421         ///
 422         Private * d;
 423 };
 424
 425 } // namespace lyx
 426
 427 #endif // PARAGRAPH_H