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