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