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