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