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