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