src/paragraph.h

   1 // -*- C++ -*-
   2 /**
   3  * \file paragraph.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Jürgen Vigna
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #ifndef PARAGRAPH_H
  17 #define PARAGRAPH_H
  18
  19 #include "changes.h"
  20 #include "InsetList.h"
  21 #include "lyxlayout_ptr_fwd.h"
  22 #include "RowList_fwd.h"
  23
  24 #include "insets/insetbase.h" // only for InsetBase::Code
  25
  26 #include "support/types.h"
  27
  28 #include <boost/assert.hpp>
  29
  30 #include <string>
  31
  32 class Buffer;
  33 class BufferParams;
  34 class BufferView;
  35 class Counters;
  36 class InsetBase;
  37 class InsetBibitem;
  38 class InsetOld_code;
  39 class Language;
  40 class LaTeXFeatures;
  41 class OutputParams;
  42 class LyXFont;
  43 class LyXFont_size;
  44 class ParagraphParameters;
  45 class TexRow;
  46 class UpdatableInset;
  47
  48 /// A Paragraph holds all text, attributes and insets in a text paragraph
  49 class Paragraph  {
  50 public:
  51         ///
  52         enum {
  53                 /// Note that this is 1 right now to avoid
  54                 /// crashes where getChar() is called wrongly
  55                 /// (returning 0) - if this was 0, then we'd
  56                 /// try getInset() and crash. We should fix
  57                 /// all these places.
  58                 META_INSET = 1
  59         };
  60         ///
  61         typedef char value_type;
  62         ///
  63         typedef lyx::depth_type depth_type;
  64         ///
  65         typedef std::vector<value_type> TextContainer;
  66
  67         ///
  68         Paragraph();
  69         ///
  70         Paragraph(Paragraph const &);
  71         ///
  72         Paragraph & operator=(Paragraph const &);
  73         ///
  74         ~Paragraph();
  75
  76         ///
  77         int id() const;
  78
  79         ///
  80         Language const * getParLanguage(BufferParams const &) const;
  81         ///
  82         bool isRightToLeftPar(BufferParams const &) const;
  83         ///
  84         void changeLanguage(BufferParams const & bparams,
  85                             Language const * from, Language const * to);
  86         ///
  87         bool isMultiLingual(BufferParams const &) const;
  88
  89         ///
  90         std::string const asString(Buffer const &,
  91                                    OutputParams const & runparams,
  92                                    bool label) const;
  93         ///
  94         std::string const asString(Buffer const &, bool label) const;
  95         ///
  96         std::string const Paragraph::asString(Buffer const & buffer,
  97                                               lyx::pos_type beg,
  98                                               lyx::pos_type end,
  99                                               bool label) const;
 100         ///
 101         std::string const asString(Buffer const &,
 102                                    OutputParams const & runparams,
 103                                    lyx::pos_type beg,
 104                                    lyx::pos_type end,
 105                                    bool label) const;
 106
 107         ///
 108         void write(Buffer const &, std::ostream &, BufferParams const &,
 109                    depth_type & depth) const;
 110         ///
 111         void validate(LaTeXFeatures &) const;
 112
 113         ///
 114         int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
 115
 116         ///
 117         int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
 118
 119
 120         ///
 121         bool simpleTeXOnePar(Buffer const &, BufferParams const &,
 122                              LyXFont const & outerfont, std::ostream &,
 123                              TexRow & texrow, OutputParams const &) const;
 124
 125         /// Writes to stream the content of the paragraph for linuxdoc
 126         void simpleLinuxDocOnePar(Buffer const & buf,
 127                                   std::ostream & os,
 128                                   LyXFont const & outerfont,
 129                                   OutputParams const & runparams,
 130                                   lyx::depth_type depth) const;
 131
 132         /// Can we drop the standard paragraph wrapper?
 133         bool Paragraph::emptyTag() const;
 134
 135         /// Get the id of the paragraph, usefull for docbook and linuxdoc
 136         std::string getID() const;
 137
 138         // Get the first word of a paragraph, return the position where it left
 139         lyx::pos_type getFirstWord(Buffer const & buf,
 140                                    std::ostream & os,
 141                                    OutputParams const & runparams) const;
 142
 143         /// Writes to stream the docbook representation
 144         void simpleDocBookOnePar(Buffer const & buf,
 145                                  std::ostream &,
 146                                  OutputParams const & runparams,
 147                                  LyXFont const & outerfont,
 148                                  lyx::pos_type initial = 0) const;
 149
 150         ///
 151         bool hasSameLayout(Paragraph const & par) const;
 152
 153         ///
 154         void makeSameLayout(Paragraph const & par);
 155
 156         ///
 157         void setInsetOwner(UpdatableInset * inset);
 158         ///
 159         UpdatableInset * inInset() const;
 160         ///
 161         InsetBase::Code ownerCode() const;
 162         ///
 163         bool autoBreakRows() const;
 164         ///
 165         bool forceDefaultParagraphs() const;
 166
 167         ///
 168         lyx::pos_type size() const { return text_.size(); }
 169         ///
 170         bool empty() const { return text_.empty(); }
 171         ///
 172         void setContentsFromPar(Paragraph const & par);
 173         ///
 174         void clearContents();
 175
 176         ///
 177         LyXLayout_ptr const & layout() const;
 178         ///
 179         void layout(LyXLayout_ptr const & new_layout);
 180
 181         /// This is the item depth, only used by enumerate and itemize
 182         signed char itemdepth;
 183
 184         ///
 185         InsetBibitem * bibitem() const;  // ale970302
 186
 187         /// initialise tracking for this par
 188         void trackChanges(Change::Type = Change::UNCHANGED);
 189
 190         /// stop tracking
 191         void untrackChanges();
 192
 193         /// set entire paragraph to new text for change tracking
 194         void cleanChanges();
 195
 196         /// look up change type at given pos
 197         Change::Type lookupChange(lyx::pos_type pos) const;
 198
 199         /// look up change at given pos
 200         Change const lookupChangeFull(lyx::pos_type pos) const;
 201
 202         /// is there a change within the given range ?
 203         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
 204
 205         /// is there a non-addition in this range ?
 206         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
 207
 208         /// set change at pos
 209         void setChange(lyx::pos_type pos, Change::Type type);
 210
 211         /// accept change
 212         void acceptChange(lyx::pos_type start, lyx::pos_type end);
 213
 214         /// reject change
 215         void rejectChange(lyx::pos_type start, lyx::pos_type end);
 216
 217         /// mark whole par as erased
 218         void markErased();
 219
 220         /// Paragraphs can contain "manual labels", for example, Description
 221         /// environment. The text for this user-editable label is stored in
 222         /// the paragraph alongside the text of the rest of the paragraph
 223         /// (the body). This function returns the starting position of the
 224         /// body of the text in the paragraph.
 225         lyx::pos_type beginOfBody() const;
 226         /// recompute this value
 227         void setBeginOfBody();
 228
 229         ///
 230         std::string const & getLabelstring() const;
 231
 232         /// the next two functions are for the manual labels
 233         std::string const getLabelWidthString() const;
 234         ///
 235         void setLabelWidthString(std::string const & s);
 236         ///
 237         char getAlign() const;
 238         /// The nesting depth of a paragraph
 239         depth_type getDepth() const;
 240         /// The maximal possible depth of a paragraph after this one
 241         depth_type getMaxDepthAfter() const;
 242         ///
 243         void applyLayout(LyXLayout_ptr const & new_layout);
 244
 245         /// definite erase
 246         void eraseIntern(lyx::pos_type pos);
 247         /// erase the char at the given position
 248         bool erase(lyx::pos_type pos);
 249         /// erase the given range. Returns the number of chars actually erased
 250         int erase(lyx::pos_type start, lyx::pos_type end);
 251
 252         /** Get uninstantiated font setting. Returns the difference
 253             between the characters font and the layoutfont.
 254             This is what is stored in the fonttable
 255         */
 256         LyXFont const
 257         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 258         ///
 259         LyXFont const getFirstFontSettings() const;
 260
 261         /** Get fully instantiated font. If pos == -1, use the layout
 262             font attached to this paragraph.
 263             If pos == -2, use the label font of the layout attached here.
 264             In all cases, the font is instantiated, i.e. does not have any
 265             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 266             LyXFont::TOGGLE.
 267         */
 268         LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
 269                               LyXFont const & outerfont) const;
 270         LyXFont const getLayoutFont(BufferParams const &,
 271                                     LyXFont const & outerfont) const;
 272         LyXFont const getLabelFont(BufferParams const &,
 273                                    LyXFont const & outerfont) const;
 274         /**
 275          * The font returned by the above functions is the same in a
 276          * span of characters. This method will return the last position
 277          * in the paragraph for which that font is the same.
 278          * This can be used to avoid unnecessary calls to getFont.
 279          */
 280         lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
 281         ///
 282         /// this is a bottleneck.
 283         value_type getChar(lyx::pos_type pos) const
 284         {
 285                 BOOST_ASSERT(pos >= 0);
 286                 BOOST_ASSERT(pos < int(text_.size()));
 287                 return text_[pos];
 288         }
 289         ///
 290         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 291         /// The position must already exist.
 292         void setChar(lyx::pos_type pos, value_type c);
 293         /// pos <= size() (there is a dummy font change at the end of each par)
 294         void setFont(lyx::pos_type pos, LyXFont const & font);
 295         /// Returns the height of the highest font in range
 296         LyXFont_size highestFontInRange(lyx::pos_type startpos,
 297                                         lyx::pos_type endpos,
 298                                         LyXFont_size def_size) const;
 299         ///
 300         void insert(lyx::pos_type pos, std::string const & str,
 301                     LyXFont const & font);
 302         ///
 303         void insertChar(lyx::pos_type pos, value_type c,
 304                         Change change = Change(Change::INSERTED));
 305         ///
 306         void insertChar(lyx::pos_type pos, value_type c,
 307                 LyXFont const &, Change change = Change(Change::INSERTED));
 308         ///
 309         bool checkInsertChar(LyXFont &);
 310         ///
 311         void insertInset(lyx::pos_type pos, InsetBase * inset,
 312                          Change change = Change(Change::INSERTED));
 313         ///
 314         void insertInset(lyx::pos_type pos, InsetBase * inset,
 315                 LyXFont const &, Change change = Change(Change::INSERTED));
 316         ///
 317         bool insetAllowed(InsetOld_code code);
 318         ///
 319         InsetBase * getInset(lyx::pos_type pos);
 320         ///
 321         InsetBase const * getInset(lyx::pos_type pos) const;
 322
 323         ///
 324         bool isHfill(lyx::pos_type pos) const;
 325         /// hinted by profiler
 326         bool isInset(lyx::pos_type pos) const { return getChar(pos) == META_INSET; }
 327         ///
 328         bool isNewline(lyx::pos_type pos) const;
 329         ///
 330         bool isSeparator(lyx::pos_type pos) const;
 331         ///
 332         bool isLineSeparator(lyx::pos_type pos) const;
 333         ///
 334         bool isKomma(lyx::pos_type pos) const;
 335         /// Used by the spellchecker
 336         bool isLetter(lyx::pos_type pos) const;
 337         ///
 338         bool isWord(lyx::pos_type pos) const;
 339
 340         /// returns -1 if inset not found
 341         int getPositionOfInset(InsetBase const * inset) const;
 342
 343         ///
 344         int stripLeadingSpaces();
 345
 346         /// return true if we allow multiple spaces
 347         bool isFreeSpacing() const;
 348
 349         /// return true if we allow this par to stay empty
 350         bool allowEmpty() const;
 351         ////
 352         unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
 353         ///
 354         ParagraphParameters & params();
 355         ///
 356         ParagraphParameters const & params() const;
 357
 358         ///
 359         RowList::iterator getRow(lyx::pos_type pos);
 360         ///
 361         RowList::const_iterator getRow(lyx::pos_type pos) const;
 362         ///
 363         size_t row(lyx::pos_type pos) const;
 364
 365         ///
 366         InsetList insetlist;
 367
 368         ///
 369         mutable RowList rows;
 370         /// last draw y position (baseline of top row)
 371         int y;
 372         /// total height of paragraph
 373         unsigned int height;
 374         /// total width of paragraph, may differ from workwidth
 375         unsigned int width;
 376
 377 private:
 378         ///
 379         LyXLayout_ptr layout_;
 380         /// keeping this here instead of in the pimpl makes LyX >10% faster
 381         // for average tasks as buffer loading/switching etc.
 382         TextContainer text_;
 383         /// end of label
 384         lyx::pos_type begin_of_body_;
 385
 386         struct Pimpl;
 387         ///
 388         friend struct Paragraph::Pimpl;
 389         ///
 390         Pimpl * pimpl_;
 391
 392 };
 393
 394
 395 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
 396 {
 397         return par.lookupChange(pos) == Change::INSERTED;
 398 }
 399
 400
 401 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
 402 {
 403         return par.lookupChange(pos) == Change::DELETED;
 404 }
 405
 406 #endif // PARAGRAPH_H