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_HFILL = 1,
  44                 ///
  45                 META_NEWLINE,
  46                 ///
  47                 META_INSET
  48         };
  49         ///
  50         typedef char value_type;
  51         /// The same as ParameterStruct::depth_type
  52         typedef unsigned int depth_type;
  53
  54         ///
  55         Paragraph();
  56 #ifndef NO_NEXT
  57         /// this constructor inserts the new paragraph in a list
  58         explicit
  59         Paragraph(Paragraph * par);
  60 #endif
  61         ///
  62         Paragraph(Paragraph const &, bool same_ids);
  63         /// the destructor removes the new paragraph from the list
  64         ~Paragraph();
  65
  66         ///
  67         Language const * getParLanguage(BufferParams const &) const;
  68         ///
  69         bool isRightToLeftPar(BufferParams const &) const;
  70         ///
  71         void changeLanguage(BufferParams const & bparams,
  72                             Language const * from, Language const * to);
  73         ///
  74         bool isMultiLingual(BufferParams const &);
  75
  76         ///
  77         string const asString(Buffer const *, bool label) const;
  78         ///
  79         string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
  80                               bool label) const;
  81
  82         ///
  83         void write(Buffer const *, std::ostream &, BufferParams const &,
  84                        depth_type & depth) const;
  85         ///
  86         void validate(LaTeXFeatures &) const;
  87
  88         /// return the unique ID of this paragraph
  89         int id() const;
  90         ///
  91         void read();
  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                              std::ostream &, TexRow & texrow, bool moving_arg);
 103
 104         ///
 105         bool hasSameLayout(Paragraph const * par) const;
 106
 107         ///
 108         void makeSameLayout(Paragraph const * par);
 109
 110         /// Is it the first par with same depth and layout?
 111         bool isFirstInSequence() const;
 112
 113         /** Check if the current paragraph is the last paragraph in a
 114             proof environment */
 115         int getEndLabel() const;
 116         ///
 117         Inset * inInset() const;
 118         ///
 119         void setInsetOwner(Inset * i);
 120         ///
 121         void deleteInsetsLyXText(BufferView *);
 122         ///
 123         void resizeInsetsLyXText(BufferView *);
 124
 125         ///
 126         lyx::pos_type size() const;
 127         ///
 128         bool empty() const;
 129         ///
 130         void setContentsFromPar(Paragraph * par);
 131         ///
 132         void clearContents();
 133
 134         ///
 135         LyXLayout_ptr const & layout() const;
 136         ///
 137         void layout(LyXLayout_ptr const & new_layout);
 138
 139         ///
 140         char enumdepth;
 141
 142         ///
 143         char itemdepth;
 144
 145         ///
 146         InsetBibitem * bibitem();  // ale970302
 147
 148 #ifndef NO_NEXT
 149         ///
 150         void next(Paragraph *);
 151         /** these function are able to hide closed footnotes
 152          */
 153         Paragraph * next();
 154         ///
 155         Paragraph const * next() const;
 156
 157         /// initialise tracking for this par
 158         void trackChanges(Change::Type = Change::UNCHANGED);
 159
 160         /// stop tracking
 161         void untrackChanges();
 162
 163         /// set entire paragraph to new text for change tracking
 164         void cleanChanges();
 165
 166         /// look up change type at given pos
 167         Change::Type lookupChange(lyx::pos_type pos) const;
 168
 169         /// look up change at given pos
 170         Change const lookupChangeFull(lyx::pos_type pos) const;
 171
 172         /// is there a change within the given range ?
 173         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
 174
 175         /// is there a non-addition in this range ?
 176         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
 177
 178         /// accept change
 179         void acceptChange(lyx::pos_type start, lyx::pos_type end);
 180
 181         /// reject change
 182         void rejectChange(lyx::pos_type start, lyx::pos_type end);
 183
 184         /// mark whole par as erased
 185         void markErased();
 186
 187         ///
 188         void previous(Paragraph *);
 189         ///
 190         Paragraph * previous();
 191         ///
 192         Paragraph const * previous() const;
 193 #endif
 194         /// for the environments
 195         Paragraph * depthHook(depth_type depth);
 196         /// for the environments
 197         Paragraph const * depthHook(depth_type depth) const;
 198         ///
 199         Paragraph * outerHook();
 200         ///
 201         Paragraph const * outerHook() const;
 202         ///
 203         int beginningOfMainBody() const;
 204         ///
 205         string const & getLabelstring() const;
 206
 207         /// the next two functions are for the manual labels
 208         string const getLabelWidthString() const;
 209         ///
 210         void setLabelWidthString(string const & s);
 211         ///
 212         char getAlign() const;
 213         /// The nesting depth of a paragraph
 214         depth_type getDepth() const;
 215         /// The maximal possible depth of a paragraph after this one
 216         depth_type getMaxDepthAfter() const;
 217         ///
 218         void applyLayout(LyXLayout_ptr const & new_layout);
 219
 220         /// erase the char at the given position
 221         void erase(lyx::pos_type pos);
 222         /// erase the given range. Returns true if actually erased.
 223         bool 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) const;
 242         LyXFont const getLayoutFont(BufferParams const &) const;
 243         LyXFont const getLabelFont(BufferParams const &) 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
 317         friend void breakParagraph(BufferParams const & bparams,
 318                     Paragraph * par, lyx::pos_type pos, int flag);
 319
 320 private:
 321         ///
 322         LyXLayout_ptr layout_;
 323         /// if anything uses this we don't want it to.
 324         Paragraph(Paragraph const &);
 325 #ifndef NO_NEXT
 326         ///
 327         Paragraph * next_;
 328         ///
 329         Paragraph * previous_;
 330 #endif
 331         struct Pimpl;
 332         ///
 333         friend struct Paragraph::Pimpl;
 334         ///
 335         Pimpl * pimpl_;
 336 };
 337
 338
 339 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
 340 {
 341         return par.lookupChange(pos) == Change::INSERTED;
 342 }
 343
 344
 345 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
 346 {
 347         return par.lookupChange(pos) == Change::DELETED;
 348 }
 349
 350 #endif // PARAGRAPH_H