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