src/paragraph_pimpl.h

   1 // -*- C++ -*-
   2 /**
   3  * \file paragraph_pimpl.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef PARAGRAPH_PIMPL_H
  16 #define PARAGRAPH_PIMPL_H
  17
  18 #include "paragraph.h"
  19
  20 #include "changes.h"
  21 #include "lyxfont.h"
  22 #include "ParagraphParameters.h"
  23 #include "ShareContainer.h"
  24
  25 #include <boost/scoped_ptr.hpp>
  26
  27 class LyXLayout;
  28
  29
  30 struct Paragraph::Pimpl {
  31         ///
  32         Pimpl(Paragraph * owner);
  33         /// "Copy constructor"
  34         Pimpl(Pimpl const &, Paragraph * owner);
  35         ///
  36         void setContentsFromPar(Paragraph const & par);
  37
  38         //
  39         // Change tracking
  40         //
  41         /// set tracking mode
  42         void trackChanges(Change::Type type = Change::UNCHANGED);
  43         /// stop tracking
  44         void untrackChanges();
  45         /// set all text as new for change mode
  46         void cleanChanges();
  47         /// look up change type at given pos
  48         Change::Type lookupChange(lyx::pos_type pos) const;
  49         /// look up change at given pos
  50         Change const lookupChangeFull(lyx::pos_type pos) const;
  51         /// is there a change in the given range ?
  52         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
  53         /// is there a non-addition in this range ?
  54         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
  55         /// set change at pos
  56         void setChange(lyx::pos_type pos, Change::Type type);
  57         /// mark as erased
  58         void markErased();
  59         /// accept change
  60         void acceptChange(lyx::pos_type start, lyx::pos_type end);
  61         /// reject change
  62         void rejectChange(lyx::pos_type start, lyx::pos_type end);
  63         /// are we tracking changes ?
  64         bool tracking() const { return changes_.get(); }
  65
  66         ///
  67         value_type getChar(lyx::pos_type pos) const;
  68         ///
  69         void setChar(lyx::pos_type pos, value_type c);
  70         ///
  71         void insertChar(lyx::pos_type pos, value_type c, Change change);
  72         ///
  73         void insertInset(lyx::pos_type pos, InsetBase * inset, Change change);
  74         /// definite erase
  75         void eraseIntern(lyx::pos_type pos);
  76         /// erase the given position. Returns true if it was actually erased
  77         bool erase(lyx::pos_type pos);
  78         /// erase the given range
  79         int erase(lyx::pos_type start, lyx::pos_type end);
  80         ///
  81         UpdatableInset * inset_owner;
  82
  83         /** A font entry covers a range of positions. Notice that the
  84             entries in the list are inserted in random order.
  85             I don't think it's worth the effort to implement a more effective
  86             datastructure, because the number of different fonts in a paragraph
  87             is limited. (Asger)
  88             Nevertheless, I decided to store fontlist using a sorted vector:
  89             fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
  90             pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
  91             and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
  92             (font_1 covers the chars 0,...,pos_1) (Dekel)
  93         */
  94         struct FontTable  {
  95                 ///
  96                 FontTable(lyx::pos_type p, LyXFont const & f)
  97                         : pos_(p)
  98                 {
  99                         font_ = container.get(f);
 100                 }
 101                 ///
 102                 lyx::pos_type pos() const { return pos_; }
 103                 ///
 104                 void pos(lyx::pos_type p) { pos_ = p; }
 105                 ///
 106                 LyXFont const & font() const { return *font_; }
 107                 ///
 108                 void font(LyXFont const & f) { font_ = container.get(f);}
 109         private:
 110                 /// End position of paragraph this font attribute covers
 111                 lyx::pos_type pos_;
 112                 /** Font. Interpretation of the font values:
 113                     If a value is LyXFont::INHERIT_*, it means that the font
 114                     attribute is inherited from either the layout of this
 115                     paragraph or, in the case of nested paragraphs, from the
 116                     layout in the environment one level up until completely
 117                     resolved.
 118                     The values LyXFont::IGNORE_* and LyXFont::TOGGLE are NOT
 119                     allowed in these font tables.
 120                 */
 121                 boost::shared_ptr<LyXFont> font_;
 122                 ///
 123                 static ShareContainer<LyXFont> container;
 124         };
 125         ///
 126         friend struct matchFT;
 127         ///
 128         struct matchFT {
 129                 /// used by lower_bound and upper_bound
 130                 inline
 131                 int operator()(FontTable const & a, FontTable const & b) const {
 132                         return a.pos() < b.pos();
 133                 }
 134         };
 135
 136         ///
 137         typedef std::vector<FontTable> FontList;
 138         ///
 139         FontList fontlist;
 140
 141         ///
 142         void simpleTeXBlanks(std::ostream &, TexRow & texrow,
 143                              lyx::pos_type const i,
 144                              unsigned int & column,
 145                              LyXFont const & font,
 146                              LyXLayout const & style);
 147         ///
 148         void simpleTeXSpecialChars(Buffer const &, BufferParams const &,
 149                                    std::ostream &, TexRow & texrow,
 150                                    OutputParams const &,
 151                                    LyXFont & font, LyXFont & running_font,
 152                                    LyXFont & basefont,
 153                                    LyXFont const & outerfont,
 154                                    bool & open_font,
 155                                    Change::Type & running_change,
 156                                    LyXLayout const & style,
 157                                    lyx::pos_type & i,
 158                                    unsigned int & column, value_type const c);
 159
 160         ///
 161         void validate(LaTeXFeatures & features,
 162                       LyXLayout const & layout) const;
 163
 164         ///
 165         unsigned int id_;
 166         ///
 167         static unsigned int paragraph_id;
 168         ///
 169         ParagraphParameters params;
 170
 171 private:
 172         ///
 173         lyx::pos_type size() const { return owner_->size(); }
 174         /// match a string against a particular point in the paragraph
 175         bool isTextAt(std::string const & str, lyx::pos_type pos) const;
 176
 177         /// for recording and looking up changes in revision tracking mode
 178         boost::scoped_ptr<Changes> changes_;
 179
 180         /// Who owns us?
 181         Paragraph * owner_;
 182 };
 183
 184 #endif