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