src/paragraph.h

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