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