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