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