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 "changes.h"
  20 #include "InsetList.h"
  21 #include "lyxlayout_ptr_fwd.h"
  22 #include "RowList_fwd.h"
  23
  24 #include "support/types.h"
  25
  26 #include "support/std_string.h"
  27
  28 class Buffer;
  29 class BufferParams;
  30 class BufferView;
  31 class Counters;
  32 class InsetBibitem;
  33 class InsetOld_code;
  34 class Language;
  35 class LaTeXFeatures;
  36 class LatexRunParams;
  37 class LyXFont;
  38 class LyXFont_size;
  39 class ParagraphParameters;
  40 class TexRow;
  41 class UpdatableInset;
  42
  43 /// A Paragraph holds all text, attributes and insets in a text paragraph
  44 class Paragraph  {
  45 public:
  46         ///
  47         enum META_KIND {
  48                 /// Note that this is 1 right now to avoid
  49                 /// crashes where getChar() is called wrongly
  50                 /// (returning 0) - if this was 0, then we'd
  51                 /// try getInset() and crash. We should fix
  52                 /// all these places.
  53                 META_INSET = 1
  54         };
  55         ///
  56         typedef char value_type;
  57         ///
  58         typedef lyx::depth_type depth_type;
  59         ///
  60         typedef std::vector<value_type> TextContainer;
  61
  62         ///
  63         Paragraph();
  64
  65         ///
  66         Paragraph(Paragraph const &);
  67         ///
  68         void operator=(Paragraph const &);
  69         /// the destructor removes the new paragraph from the list
  70         ~Paragraph();
  71
  72         ///
  73         Language const * getParLanguage(BufferParams const &) const;
  74         ///
  75         bool isRightToLeftPar(BufferParams const &) const;
  76         ///
  77         void changeLanguage(BufferParams const & bparams,
  78                             Language const * from, Language const * to);
  79         ///
  80         bool isMultiLingual(BufferParams const &);
  81
  82         ///
  83         string const asString(Buffer const &, bool label) const;
  84         ///
  85         string const asString(Buffer const &, lyx::pos_type beg, lyx::pos_type end,
  86                               bool label) const;
  87
  88         ///
  89         void write(Buffer const &, std::ostream &, BufferParams const &,
  90                    depth_type & depth) const;
  91         ///
  92         void validate(LaTeXFeatures &) const;
  93
  94         /// return the unique ID of this paragraph
  95         int id() const;
  96         /// Set the Id of this paragraph.
  97         void id(int);
  98
  99         ///
 100         int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
 101
 102         ///
 103         int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
 104
 105
 106         ///
 107         bool simpleTeXOnePar(Buffer const &, BufferParams const &,
 108                              LyXFont const & outerfont, std::ostream &,
 109                              TexRow & texrow, LatexRunParams const &);
 110
 111         ///
 112         bool hasSameLayout(Paragraph const & par) const;
 113
 114         ///
 115         void makeSameLayout(Paragraph const & par);
 116
 117         ///
 118         UpdatableInset * inInset() const;
 119         ///
 120         void setInsetOwner(UpdatableInset * inset);
 121         ///
 122         void deleteInsetsLyXText(BufferView *);
 123
 124         ///
 125         lyx::pos_type size() const { return text_.size(); }
 126         ///
 127         bool empty() const { return text_.empty(); }
 128         ///
 129         void setContentsFromPar(Paragraph const & par);
 130         ///
 131         void clearContents();
 132
 133         ///
 134         LyXLayout_ptr const & layout() const;
 135         ///
 136         void layout(LyXLayout_ptr const & new_layout);
 137
 138         ///
 139         char enumdepth;
 140
 141         ///
 142         char itemdepth;
 143
 144         ///
 145         InsetBibitem * bibitem() const;  // ale970302
 146
 147         /// initialise tracking for this par
 148         void trackChanges(Change::Type = Change::UNCHANGED);
 149
 150         /// stop tracking
 151         void untrackChanges();
 152
 153         /// set entire paragraph to new text for change tracking
 154         void cleanChanges();
 155
 156         /// look up change type at given pos
 157         Change::Type lookupChange(lyx::pos_type pos) const;
 158
 159         /// look up change at given pos
 160         Change const lookupChangeFull(lyx::pos_type pos) const;
 161
 162         /// is there a change within the given range ?
 163         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
 164
 165         /// is there a non-addition in this range ?
 166         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
 167
 168         /// set change at pos
 169         void setChange(lyx::pos_type pos, Change::Type type);
 170
 171         /// accept change
 172         void acceptChange(lyx::pos_type start, lyx::pos_type end);
 173
 174         /// reject change
 175         void rejectChange(lyx::pos_type start, lyx::pos_type end);
 176
 177         /// mark whole par as erased
 178         void markErased();
 179
 180         /// Paragraphs can contain "manual labels", for example, Description
 181         /// environment. The text for this user-editable label is stored in
 182         /// the paragraph alongside the text of the rest of the paragraph
 183         /// (the body). This function returns the starting position of the
 184         /// body of the text in the paragraph.
 185         int beginningOfBody() const;
 186
 187         ///
 188         string const & getLabelstring() const;
 189
 190         /// the next two functions are for the manual labels
 191         string const getLabelWidthString() const;
 192         ///
 193         void setLabelWidthString(string const & s);
 194         ///
 195         char getAlign() const;
 196         /// The nesting depth of a paragraph
 197         depth_type getDepth() const;
 198         /// The maximal possible depth of a paragraph after this one
 199         depth_type getMaxDepthAfter() const;
 200         ///
 201         void applyLayout(LyXLayout_ptr const & new_layout);
 202
 203         /// definite erase
 204         void eraseIntern(lyx::pos_type pos);
 205         /// erase the char at the given position
 206         bool erase(lyx::pos_type pos);
 207         /// erase the given range. Returns the number of chars actually erased
 208         int erase(lyx::pos_type start, lyx::pos_type end);
 209
 210         /** Get uninstantiated font setting. Returns the difference
 211             between the characters font and the layoutfont.
 212             This is what is stored in the fonttable
 213         */
 214         LyXFont const
 215         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 216         ///
 217         LyXFont const getFirstFontSettings() const;
 218
 219         /** Get fully instantiated font. If pos == -1, use the layout
 220             font attached to this paragraph.
 221             If pos == -2, use the label font of the layout attached here.
 222             In all cases, the font is instantiated, i.e. does not have any
 223             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 224             LyXFont::TOGGLE.
 225         */
 226         LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
 227                               LyXFont const & outerfont) const;
 228         LyXFont const getLayoutFont(BufferParams const &,
 229                                     LyXFont const & outerfont) const;
 230         LyXFont const getLabelFont(BufferParams const &,
 231                                    LyXFont const & outerfont) const;
 232         /**
 233          * The font returned by the above functions is the same in a
 234          * span of characters. This method will return the last position
 235          * in the paragraph for which that font is the same.
 236          * This can be used to avoid unnecessary calls to getFont.
 237          */
 238         lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
 239         ///
 240         value_type getChar(lyx::pos_type pos) const;
 241         ///
 242         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 243         /// The position must already exist.
 244         void setChar(lyx::pos_type pos, value_type c);
 245         /// pos <= size() (there is a dummy font change at the end of each par)
 246         void setFont(lyx::pos_type pos, LyXFont const & font);
 247         /// Returns the height of the highest font in range
 248         LyXFont_size highestFontInRange(lyx::pos_type startpos,
 249                                         lyx::pos_type endpos,
 250                                         LyXFont_size def_size) const;
 251         ///
 252         void insertChar(lyx::pos_type pos, value_type c);
 253         ///
 254         void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
 255         ///
 256         bool checkInsertChar(LyXFont &);
 257         ///
 258         void insertInset(lyx::pos_type pos, InsetOld * inset);
 259         ///
 260         void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
 261         ///
 262         bool insetAllowed(InsetOld_code code);
 263         ///
 264         InsetOld * getInset(lyx::pos_type pos);
 265         ///
 266         InsetOld const * getInset(lyx::pos_type pos) const;
 267
 268         ///
 269         bool isHfill(lyx::pos_type pos) const;
 270         ///
 271         bool isInset(lyx::pos_type pos) const;
 272         ///
 273         bool isNewline(lyx::pos_type pos) const;
 274         ///
 275         bool isSeparator(lyx::pos_type pos) const;
 276         ///
 277         bool isLineSeparator(lyx::pos_type pos) const;
 278         ///
 279         bool isKomma(lyx::pos_type pos) const;
 280         /// Used by the spellchecker
 281         bool isLetter(lyx::pos_type pos) const;
 282         ///
 283         bool isWord(lyx::pos_type pos) const;
 284
 285         /// returns -1 if inset not found
 286         int getPositionOfInset(InsetOld const * inset) const;
 287
 288         ///
 289         int stripLeadingSpaces();
 290
 291         /// return true if we allow multiple spaces
 292         bool isFreeSpacing() const;
 293
 294         /// return true if we allow this par to stay empty
 295         bool allowEmpty() const;
 296
 297         ///
 298         ParagraphParameters & params();
 299         ///
 300         ParagraphParameters const & params() const;
 301         ///
 302         InsetList insetlist;
 303
 304         ///
 305         mutable RowList rows;
 306         /// last draw y position (baseline of top row)
 307         int y;
 308
 309 private:
 310         ///
 311         LyXLayout_ptr layout_;
 312         /// keeping this here instead of in the pimpl makes LyX >10% faster
 313         // for average tasks as buffer loading/switching etc.
 314         TextContainer text_;
 315
 316         struct Pimpl;
 317         ///
 318         friend struct Paragraph::Pimpl;
 319         ///
 320         Pimpl * pimpl_;
 321
 322 };
 323
 324
 325 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
 326 {
 327         return par.lookupChange(pos) == Change::INSERTED;
 328 }
 329
 330
 331 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
 332 {
 333         return par.lookupChange(pos) == Change::DELETED;
 334 }
 335
 336 #endif // PARAGRAPH_H