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         ///
  97         int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
  98
  99         ///
 100         int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
 101
 102
 103         ///
 104         bool simpleTeXOnePar(Buffer const *, BufferParams const &,
 105                              LyXFont const & outerfont, std::ostream &,
 106                              TexRow & texrow, bool moving_arg);
 107
 108         ///
 109         bool hasSameLayout(Paragraph const & par) const;
 110
 111         ///
 112         void makeSameLayout(Paragraph const & par);
 113
 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 const & 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         /// Paragraphs can contain "manual labels", for example, Description environment.
 197         /// The text for this user-editable label is stored in the paragraph alongside
 198         /// the text of the rest of the paragraph (the body). This function returns
 199         /// the starting position of the body of the text in the paragraph.
 200         int beginningOfBody() const;
 201
 202         ///
 203         string const & getLabelstring() const;
 204
 205         /// the next two functions are for the manual labels
 206         string const getLabelWidthString() const;
 207         ///
 208         void setLabelWidthString(string const & s);
 209         ///
 210         char getAlign() const;
 211         /// The nesting depth of a paragraph
 212         depth_type getDepth() const;
 213         /// The maximal possible depth of a paragraph after this one
 214         depth_type getMaxDepthAfter() const;
 215         ///
 216         void applyLayout(LyXLayout_ptr const & new_layout);
 217
 218         /// definite erase
 219         void eraseIntern(lyx::pos_type pos);
 220         /// erase the char at the given position
 221         bool erase(lyx::pos_type pos);
 222         /// erase the given range. Returns the number of chars actually erased
 223         int erase(lyx::pos_type start, lyx::pos_type end);
 224
 225         /** Get uninstantiated font setting. Returns the difference
 226             between the characters font and the layoutfont.
 227             This is what is stored in the fonttable
 228         */
 229         LyXFont const
 230         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 231         ///
 232         LyXFont const getFirstFontSettings() const;
 233
 234         /** Get fully instantiated font. If pos == -1, use the layout
 235             font attached to this paragraph.
 236             If pos == -2, use the label font of the layout attached here.
 237             In all cases, the font is instantiated, i.e. does not have any
 238             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 239             LyXFont::TOGGLE.
 240         */
 241         LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
 242                               LyXFont const & outerfont) const;
 243         LyXFont const getLayoutFont(BufferParams const &,
 244                                     LyXFont const & outerfont) const;
 245         LyXFont const getLabelFont(BufferParams const &,
 246                                    LyXFont const & outerfont) const;
 247         ///
 248         value_type getChar(lyx::pos_type pos) const;
 249         ///
 250         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 251         /// The position must already exist.
 252         void setChar(lyx::pos_type pos, value_type c);
 253         /// pos <= size() (there is a dummy font change at the end of each par)
 254         void setFont(lyx::pos_type pos, LyXFont const & font);
 255         /// Returns the height of the highest font in range
 256         LyXFont::FONT_SIZE
 257         highestFontInRange(lyx::pos_type startpos,
 258                            lyx::pos_type endpos,
 259                            LyXFont::FONT_SIZE const def_size) const;
 260         ///
 261         void insertChar(lyx::pos_type pos, value_type c);
 262         ///
 263         void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
 264         ///
 265         bool checkInsertChar(LyXFont &);
 266         ///
 267         void insertInset(lyx::pos_type pos, Inset * inset);
 268         ///
 269         void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
 270         ///
 271         bool insetAllowed(Inset::Code code);
 272         ///
 273         Inset * getInset(lyx::pos_type pos);
 274         ///
 275         Inset const * getInset(lyx::pos_type pos) const;
 276         /** important for cut and paste
 277             Temporary change from BufferParams to Buffer. Will revert when we
 278             get rid of the argument to Inset::clone(Buffer const &) */
 279         void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
 280         ///
 281         void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
 282         ///
 283         bool insertFromMinibuffer(lyx::pos_type pos);
 284
 285         ///
 286         bool isHfill(lyx::pos_type pos) const;
 287         ///
 288         bool isInset(lyx::pos_type pos) const;
 289         ///
 290         bool isNewline(lyx::pos_type pos) const;
 291         ///
 292         bool isSeparator(lyx::pos_type pos) const;
 293         ///
 294         bool isLineSeparator(lyx::pos_type pos) const;
 295         ///
 296         bool isKomma(lyx::pos_type pos) const;
 297         /// Used by the spellchecker
 298         bool isLetter(lyx::pos_type pos) const;
 299         ///
 300         bool isWord(lyx::pos_type pos) const;
 301
 302         /// returns -1 if inset not found
 303         int getPositionOfInset(Inset const * inset) const;
 304
 305         ///
 306         int stripLeadingSpaces();
 307
 308         ///
 309         bool isFreeSpacing() const;
 310
 311         ///
 312         ParagraphParameters & params();
 313         ///
 314         ParagraphParameters const & params() const;
 315         ///
 316         InsetList insetlist;
 317         ///
 318         //Counters & counters();
 319 private:
 320         ///
 321         LyXLayout_ptr layout_;
 322         /// if anything uses this we don't want it to.
 323         Paragraph(Paragraph const &);
 324 #ifndef NO_NEXT
 325         ///
 326         Paragraph * next_;
 327         ///
 328         Paragraph * previous_;
 329 #else
 330         Paragraph * next_par_;
 331         Paragraph * prev_par_;
 332 #endif
 333         struct Pimpl;
 334         ///
 335         friend struct Paragraph::Pimpl;
 336         ///
 337         Pimpl * pimpl_;
 338
 339         /// unimplemented
 340         void operator=(Paragraph const &);
 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