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