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,
  72                 LyXFont const & font, Change change = Change(Change::INSERTED));
  73         ///
  74         void insertInset(lyx::pos_type pos, InsetBase * inset,
  75                 LyXFont const & font, Change change = Change(Change::INSERTED));
  76         /// definite erase
  77         void eraseIntern(lyx::pos_type pos);
  78         /// erase the given position. Returns true if it was actually erased
  79         bool erase(lyx::pos_type pos);
  80         /// erase the given range
  81         int erase(lyx::pos_type start, lyx::pos_type end);
  82         ///
  83         UpdatableInset * inset_owner;
  84
  85         /** A font entry covers a range of positions. Notice that the
  86             entries in the list are inserted in random order.
  87             I don't think it's worth the effort to implement a more effective
  88             datastructure, because the number of different fonts in a paragraph
  89             is limited. (Asger)
  90             Nevertheless, I decided to store fontlist using a sorted vector:
  91             fontlist = { {pos_1,font_1} , {pos_2,font_2} , ... } where
  92             pos_1 < pos_2 < ..., font_{i-1} != font_i for all i,
  93             and font_i covers the chars in positions pos_{i-1}+1,...,pos_i
  94             (font_1 covers the chars 0,...,pos_1) (Dekel)
  95         */
  96         struct FontTable  {
  97                 ///
  98                 FontTable(lyx::pos_type p, LyXFont const & f)
  99                         : pos_(p)
 100                 {
 101                         font_ = container.get(f);
 102                 }
 103                 ///
 104                 lyx::pos_type pos() const { return pos_; }
 105                 ///
 106                 void pos(lyx::pos_type p) { pos_ = p; }
 107                 ///
 108                 LyXFont const & font() const { return *font_; }
 109                 ///
 110                 void font(LyXFont const & f) { font_ = container.get(f);}
 111         private:
 112                 /// End position of paragraph this font attribute covers
 113                 lyx::pos_type pos_;
 114                 /** Font. Interpretation of the font values:
 115                     If a value is LyXFont::INHERIT_*, it means that the font
 116                     attribute is inherited from either the layout of this
 117                     paragraph or, in the case of nested paragraphs, from the
 118                     layout in the environment one level up until completely
 119                     resolved.
 120                     The values LyXFont::IGNORE_* and LyXFont::TOGGLE are NOT
 121                     allowed in these font tables.
 122                 */
 123                 boost::shared_ptr<LyXFont> font_;
 124                 ///
 125                 static ShareContainer<LyXFont> container;
 126         };
 127         ///
 128         friend struct matchFT;
 129         ///
 130         struct matchFT {
 131                 /// used by lower_bound and upper_bound
 132                 inline
 133                 int operator()(FontTable const & a, FontTable const & b) const {
 134                         return a.pos() < b.pos();
 135                 }
 136         };
 137
 138         ///
 139         typedef std::vector<FontTable> FontList;
 140         ///
 141         FontList fontlist;
 142
 143         ///
 144         void simpleTeXBlanks(std::ostream &, TexRow & texrow,
 145                              lyx::pos_type const i,
 146                              unsigned int & column,
 147                              LyXFont const & font,
 148                              LyXLayout const & style);
 149         ///
 150         void simpleTeXSpecialChars(Buffer const &, BufferParams const &,
 151                                    std::ostream &, TexRow & texrow,
 152                                    OutputParams const &,
 153                                    LyXFont & font, LyXFont & running_font,
 154                                    LyXFont & basefont,
 155                                    LyXFont const & outerfont,
 156                                    bool & open_font,
 157                                    Change::Type & running_change,
 158                                    LyXLayout const & style,
 159                                    lyx::pos_type & i,
 160                                    unsigned int & column, value_type const c);
 161
 162         ///
 163         void validate(LaTeXFeatures & features,
 164                       LyXLayout const & layout) const;
 165
 166         ///
 167         unsigned int id_;
 168         ///
 169         static unsigned int paragraph_id;
 170         ///
 171         ParagraphParameters params;
 172
 173 private:
 174         ///
 175         lyx::pos_type size() const { return owner_->size(); }
 176         /// match a string against a particular point in the paragraph
 177         bool isTextAt(std::string const & str, lyx::pos_type pos) const;
 178
 179         /// for recording and looking up changes in revision tracking mode
 180         boost::scoped_ptr<Changes> changes_;
 181
 182         /// Who owns us?
 183         Paragraph * owner_;
 184 };
 185
 186 #endif