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(Buffer const & buf,
 137                           OutputParams const & runparams) const;
 138
 139         // Get the first word of a paragraph, return the position where it left
 140         lyx::pos_type getFirstWord(Buffer const & buf,
 141                                    std::ostream & os,
 142                                    OutputParams const & runparams) const;
 143
 144         /// Checks if the paragraph contains only text and no inset or font change.
 145         bool onlyText(Buffer const & buf, LyXFont const & outerfont,
 146                       lyx::pos_type initial) const;
 147
 148         /// Writes to stream the docbook representation
 149         void simpleDocBookOnePar(Buffer const & buf,
 150                                  std::ostream &,
 151                                  OutputParams const & runparams,
 152                                  LyXFont const & outerfont,
 153                                  lyx::pos_type initial = 0) const;
 154
 155         ///
 156         bool hasSameLayout(Paragraph const & par) const;
 157
 158         ///
 159         void makeSameLayout(Paragraph const & par);
 160
 161         ///
 162         void setInsetOwner(UpdatableInset * inset);
 163         ///
 164         UpdatableInset * inInset() const;
 165         ///
 166         InsetBase::Code ownerCode() const;
 167         ///
 168         bool autoBreakRows() const;
 169         ///
 170         bool forceDefaultParagraphs() const;
 171
 172         ///
 173         lyx::pos_type size() const { return text_.size(); }
 174         ///
 175         bool empty() const { return text_.empty(); }
 176         ///
 177         void setContentsFromPar(Paragraph const & par);
 178         ///
 179         void clearContents();
 180
 181         ///
 182         LyXLayout_ptr const & layout() const;
 183         ///
 184         void layout(LyXLayout_ptr const & new_layout);
 185
 186         /// This is the item depth, only used by enumerate and itemize
 187         signed char itemdepth;
 188
 189         ///
 190         InsetBibitem * bibitem() const;  // ale970302
 191
 192         /// initialise tracking for this par
 193         void trackChanges(Change::Type = Change::UNCHANGED);
 194
 195         /// stop tracking
 196         void untrackChanges();
 197
 198         /// set entire paragraph to new text for change tracking
 199         void cleanChanges();
 200
 201         /// look up change type at given pos
 202         Change::Type lookupChange(lyx::pos_type pos) const;
 203
 204         /// look up change at given pos
 205         Change const lookupChangeFull(lyx::pos_type pos) const;
 206
 207         /// is there a change within the given range ?
 208         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
 209
 210         /// is there a non-addition in this range ?
 211         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
 212
 213         /// set change at pos
 214         void setChange(lyx::pos_type pos, Change::Type type);
 215
 216         /// accept change
 217         void acceptChange(lyx::pos_type start, lyx::pos_type end);
 218
 219         /// reject change
 220         void rejectChange(lyx::pos_type start, lyx::pos_type end);
 221
 222         /// mark whole par as erased
 223         void markErased();
 224
 225         /// Paragraphs can contain "manual labels", for example, Description
 226         /// environment. The text for this user-editable label is stored in
 227         /// the paragraph alongside the text of the rest of the paragraph
 228         /// (the body). This function returns the starting position of the
 229         /// body of the text in the paragraph.
 230         lyx::pos_type beginOfBody() const;
 231         /// recompute this value
 232         void setBeginOfBody();
 233
 234         ///
 235         std::string const & getLabelstring() const;
 236
 237         /// the next two functions are for the manual labels
 238         std::string const getLabelWidthString() const;
 239         ///
 240         void setLabelWidthString(std::string const & s);
 241         ///
 242         char getAlign() const;
 243         /// The nesting depth of a paragraph
 244         depth_type getDepth() const;
 245         /// The maximal possible depth of a paragraph after this one
 246         depth_type getMaxDepthAfter() const;
 247         ///
 248         void applyLayout(LyXLayout_ptr const & new_layout);
 249
 250         /// definite erase
 251         void eraseIntern(lyx::pos_type pos);
 252         /// erase the char at the given position
 253         bool erase(lyx::pos_type pos);
 254         /// erase the given range. Returns the number of chars actually erased
 255         int erase(lyx::pos_type start, lyx::pos_type end);
 256
 257         /** Get uninstantiated font setting. Returns the difference
 258             between the characters font and the layoutfont.
 259             This is what is stored in the fonttable
 260         */
 261         LyXFont const
 262         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 263         ///
 264         LyXFont const getFirstFontSettings() const;
 265
 266         /** Get fully instantiated font. If pos == -1, use the layout
 267             font attached to this paragraph.
 268             If pos == -2, use the label font of the layout attached here.
 269             In all cases, the font is instantiated, i.e. does not have any
 270             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 271             LyXFont::TOGGLE.
 272         */
 273         LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
 274                               LyXFont const & outerfont) const;
 275         LyXFont const getLayoutFont(BufferParams const &,
 276                                     LyXFont const & outerfont) const;
 277         LyXFont const getLabelFont(BufferParams const &,
 278                                    LyXFont const & outerfont) const;
 279         /**
 280          * The font returned by the above functions is the same in a
 281          * span of characters. This method will return the last position
 282          * in the paragraph for which that font is the same.
 283          * This can be used to avoid unnecessary calls to getFont.
 284          */
 285         lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
 286         ///
 287         /// this is a bottleneck.
 288         value_type getChar(lyx::pos_type pos) const
 289         {
 290                 BOOST_ASSERT(pos >= 0);
 291                 BOOST_ASSERT(pos < int(text_.size()));
 292                 return text_[pos];
 293         }
 294         ///
 295         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 296         /// The position must already exist.
 297         void setChar(lyx::pos_type pos, value_type c);
 298         /// pos <= size() (there is a dummy font change at the end of each par)
 299         void setFont(lyx::pos_type pos, LyXFont const & font);
 300         /// Returns the height of the highest font in range
 301         LyXFont_size highestFontInRange(lyx::pos_type startpos,
 302                                         lyx::pos_type endpos,
 303                                         LyXFont_size def_size) const;
 304         ///
 305         void insert(lyx::pos_type pos, std::string const & str,
 306                     LyXFont const & font);
 307         ///
 308         void insertChar(lyx::pos_type pos, value_type c,
 309                         Change change = Change(Change::INSERTED));
 310         ///
 311         void insertChar(lyx::pos_type pos, value_type c,
 312                 LyXFont const &, Change change = Change(Change::INSERTED));
 313         ///
 314         bool checkInsertChar(LyXFont &);
 315         ///
 316         void insertInset(lyx::pos_type pos, InsetBase * inset,
 317                          Change change = Change(Change::INSERTED));
 318         ///
 319         void insertInset(lyx::pos_type pos, InsetBase * inset,
 320                 LyXFont const &, Change change = Change(Change::INSERTED));
 321         ///
 322         bool insetAllowed(InsetOld_code code);
 323         ///
 324         InsetBase * getInset(lyx::pos_type pos);
 325         ///
 326         InsetBase const * getInset(lyx::pos_type pos) const;
 327
 328         ///
 329         bool isHfill(lyx::pos_type pos) const;
 330         /// hinted by profiler
 331         bool isInset(lyx::pos_type pos) const { return getChar(pos) == static_cast<value_type>(META_INSET); }
 332         ///
 333         bool isNewline(lyx::pos_type pos) const;
 334         ///
 335         bool isSeparator(lyx::pos_type pos) const;
 336         ///
 337         bool isLineSeparator(lyx::pos_type pos) const;
 338         /// True if the character/inset at this point can be part of a word
 339         // Note that digits in particular are considered as letters
 340         bool isLetter(lyx::pos_type pos) const;
 341
 342         /// returns -1 if inset not found
 343         int getPositionOfInset(InsetBase const * inset) const;
 344
 345         ///
 346         int stripLeadingSpaces();
 347
 348         /// return true if we allow multiple spaces
 349         bool isFreeSpacing() const;
 350
 351         /// return true if we allow this par to stay empty
 352         bool allowEmpty() const;
 353         ////
 354         unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
 355         ///
 356         ParagraphParameters & params();
 357         ///
 358         ParagraphParameters const & params() const;
 359
 360         ///
 361         RowList::iterator getRow(lyx::pos_type pos);
 362         ///
 363         RowList::const_iterator getRow(lyx::pos_type pos) const;
 364         ///
 365         size_t row(lyx::pos_type pos) const;
 366
 367         ///
 368         InsetList insetlist;
 369
 370         ///
 371         mutable RowList rows;
 372         /// last draw y position (baseline of top row)
 373         int y;
 374         /// total height of paragraph
 375         unsigned int height;
 376         /// total width of paragraph, may differ from workwidth
 377         unsigned int width;
 378
 379 private:
 380         ///
 381         LyXLayout_ptr layout_;
 382         /// keeping this here instead of in the pimpl makes LyX >10% faster
 383         // for average tasks as buffer loading/switching etc.
 384         TextContainer text_;
 385         /// end of label
 386         lyx::pos_type begin_of_body_;
 387
 388         struct Pimpl;
 389         ///
 390         friend struct Paragraph::Pimpl;
 391         ///
 392         Pimpl * pimpl_;
 393
 394 };
 395
 396
 397 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
 398 {
 399         return par.lookupChange(pos) == Change::INSERTED;
 400 }
 401
 402
 403 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
 404 {
 405         return par.lookupChange(pos) == Change::DELETED;
 406 }
 407
 408 #endif // PARAGRAPH_H