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