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