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