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 "LString.h"
  22
  23 class BufferParams;
  24 class BufferView;
  25 class Counters;
  26 class InsetBibitem;
  27 class Language;
  28 class LaTeXFeatures;
  29 class ParagraphParameters;
  30 class TexRow;
  31
  32 // Define this if you want to try out the new storage container for
  33 // paragraphs. (Lgb)
  34 // This is non working and far from finished.
  35 // #define NO_NEXT 1
  36
  37 /// A Paragraph holds all text, attributes and insets in a text paragraph
  38 class Paragraph  {
  39 public:
  40         ///
  41         enum META_KIND {
  42                 ///
  43                 META_HFILL = 1,
  44                 ///
  45                 META_NEWLINE,
  46                 ///
  47                 META_INSET
  48         };
  49         ///
  50         typedef char value_type;
  51         /// The same as ParameterStruct::depth_type
  52         typedef unsigned int depth_type;
  53
  54         ///
  55         Paragraph();
  56 #ifndef NO_NEXT
  57         /// this constructor inserts the new paragraph in a list
  58         explicit
  59         Paragraph(Paragraph * par);
  60 #endif
  61         ///
  62         Paragraph(Paragraph const &, bool same_ids);
  63         /// the destructor removes the new paragraph from the list
  64         ~Paragraph();
  65
  66         ///
  67         Language const * getParLanguage(BufferParams const &) const;
  68         ///
  69         bool isRightToLeftPar(BufferParams const &) const;
  70         ///
  71         void changeLanguage(BufferParams const & bparams,
  72                             Language const * from, Language const * to);
  73         ///
  74         bool isMultiLingual(BufferParams const &);
  75
  76         ///
  77         string const asString(Buffer const *, bool label) const;
  78         ///
  79         string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
  80                               bool label) const;
  81
  82         ///
  83         void write(Buffer const *, std::ostream &, BufferParams const &,
  84                        depth_type & depth) const;
  85         ///
  86         void validate(LaTeXFeatures &) const;
  87
  88         /// return the unique ID of this paragraph
  89         int id() const;
  90         ///
  91         void read();
  92
  93         ///
  94         Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
  95                                  std::ostream &, TexRow & texrow,
  96                                  bool moving_arg);
  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                              std::ostream &, TexRow & texrow, bool moving_arg);
 108
 109         ///
 110         Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
 111                                       std::ostream &, TexRow & texrow);
 112         ///
 113         bool hasSameLayout(Paragraph const * par) const;
 114
 115         ///
 116         void makeSameLayout(Paragraph const * par);
 117
 118         /// Is it the first par with same depth and layout?
 119         bool isFirstInSequence() const;
 120
 121         /** Check if the current paragraph is the last paragraph in a
 122             proof environment */
 123         int getEndLabel() const;
 124         ///
 125         Inset * inInset() const;
 126         ///
 127         void setInsetOwner(Inset * i);
 128         ///
 129         void deleteInsetsLyXText(BufferView *);
 130         ///
 131         void resizeInsetsLyXText(BufferView *);
 132
 133         ///
 134         lyx::pos_type size() const;
 135         ///
 136         bool empty() const;
 137         ///
 138         void setContentsFromPar(Paragraph * par);
 139         ///
 140         void clearContents();
 141
 142         ///
 143         LyXLayout_ptr const & layout() const;
 144         ///
 145         void layout(LyXLayout_ptr const & new_layout);
 146
 147         ///
 148         char enumdepth;
 149
 150         ///
 151         char itemdepth;
 152
 153         ///
 154         InsetBibitem * bibitem();  // ale970302
 155
 156 #ifndef NO_NEXT
 157         ///
 158         void next(Paragraph *);
 159         /** these function are able to hide closed footnotes
 160          */
 161         Paragraph * next();
 162         ///
 163         Paragraph const * next() const;
 164
 165         /// initialise tracking for this par
 166         void trackChanges(Change::Type = Change::UNCHANGED);
 167
 168         /// stop tracking
 169         void untrackChanges();
 170
 171         /// set entire paragraph to new text for change tracking
 172         void cleanChanges();
 173
 174         /// look up change type at given pos
 175         Change::Type lookupChange(lyx::pos_type pos) const;
 176
 177         /// look up change at given pos
 178         Change const lookupChangeFull(lyx::pos_type pos) const;
 179
 180         /// is there a change within the given range ?
 181         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
 182
 183         /// is there a non-addition in this range ?
 184         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
 185
 186         /// accept change
 187         void acceptChange(lyx::pos_type start, lyx::pos_type end);
 188
 189         /// reject change
 190         void rejectChange(lyx::pos_type start, lyx::pos_type end);
 191
 192         /// mark whole par as erased
 193         void markErased();
 194
 195         ///
 196         void previous(Paragraph *);
 197         ///
 198         Paragraph * previous();
 199         ///
 200         Paragraph const * previous() const;
 201 #endif
 202         /// for the environments
 203         Paragraph * depthHook(depth_type depth);
 204         /// for the environments
 205         Paragraph const * depthHook(depth_type depth) const;
 206         ///
 207         Paragraph * outerHook();
 208         ///
 209         Paragraph const * outerHook() const;
 210         ///
 211         int beginningOfMainBody() const;
 212         ///
 213         string const & getLabelstring() const;
 214
 215         /// the next two functions are for the manual labels
 216         string const getLabelWidthString() const;
 217         ///
 218         void setLabelWidthString(string const & s);
 219         ///
 220         char getAlign() const;
 221         /// The nesting depth of a paragraph
 222         depth_type getDepth() const;
 223         /// The maximal possible depth of a paragraph after this one
 224         depth_type getMaxDepthAfter() const;
 225         ///
 226         void applyLayout(LyXLayout_ptr const & new_layout);
 227
 228         /// erase the char at the given position
 229         void erase(lyx::pos_type pos);
 230         /// erase the given range. Returns true if actually erased.
 231         bool erase(lyx::pos_type start, lyx::pos_type end);
 232
 233         /** Get uninstantiated font setting. Returns the difference
 234             between the characters font and the layoutfont.
 235             This is what is stored in the fonttable
 236         */
 237         LyXFont const
 238         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 239         ///
 240         LyXFont const getFirstFontSettings() const;
 241
 242         /** Get fully instantiated font. If pos == -1, use the layout
 243             font attached to this paragraph.
 244             If pos == -2, use the label font of the layout attached here.
 245             In all cases, the font is instantiated, i.e. does not have any
 246             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 247             LyXFont::TOGGLE.
 248         */
 249         LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
 250         LyXFont const getLayoutFont(BufferParams const &) const;
 251         LyXFont const getLabelFont(BufferParams const &) const;
 252         ///
 253         value_type getChar(lyx::pos_type pos) const;
 254         ///
 255         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 256         /// The position must already exist.
 257         void setChar(lyx::pos_type pos, value_type c);
 258         /// pos <= size() (there is a dummy font change at the end of each par)
 259         void setFont(lyx::pos_type pos, LyXFont const & font);
 260         /// Returns the height of the highest font in range
 261         LyXFont::FONT_SIZE
 262         highestFontInRange(lyx::pos_type startpos,
 263                            lyx::pos_type endpos,
 264                            LyXFont::FONT_SIZE const def_size) const;
 265         ///
 266         void insertChar(lyx::pos_type pos, value_type c);
 267         ///
 268         void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
 269         ///
 270         bool checkInsertChar(LyXFont &);
 271         ///
 272         void insertInset(lyx::pos_type pos, Inset * inset);
 273         ///
 274         void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
 275         ///
 276         bool insetAllowed(Inset::Code code);
 277         ///
 278         Inset * getInset(lyx::pos_type pos);
 279         ///
 280         Inset const * getInset(lyx::pos_type pos) const;
 281         /** important for cut and paste
 282             Temporary change from BufferParams to Buffer. Will revert when we
 283             get rid of the argument to Inset::clone(Buffer const &) */
 284         void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
 285         ///
 286         void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
 287         ///
 288         bool insertFromMinibuffer(lyx::pos_type pos);
 289
 290         ///
 291         bool isHfill(lyx::pos_type pos) const;
 292         ///
 293         bool isInset(lyx::pos_type pos) const;
 294         ///
 295         bool isNewline(lyx::pos_type pos) const;
 296         ///
 297         bool isSeparator(lyx::pos_type pos) const;
 298         ///
 299         bool isLineSeparator(lyx::pos_type pos) const;
 300         ///
 301         bool isKomma(lyx::pos_type pos) const;
 302         /// Used by the spellchecker
 303         bool isLetter(lyx::pos_type pos) const;
 304         ///
 305         bool isWord(lyx::pos_type pos) const;
 306
 307         /// returns -1 if inset not found
 308         int getPositionOfInset(Inset const * inset) const;
 309
 310         ///
 311         int stripLeadingSpaces();
 312
 313         ///
 314         bool isFreeSpacing() const;
 315
 316         ///
 317         ParagraphParameters & params();
 318         ///
 319         ParagraphParameters const & params() const;
 320         ///
 321         InsetList insetlist;
 322         ///
 323         //Counters & counters();
 324
 325         friend void breakParagraph(BufferParams const & bparams,
 326                     Paragraph * par, lyx::pos_type pos, int flag);
 327
 328 private:
 329         ///
 330         LyXLayout_ptr layout_;
 331         /// if anything uses this we don't want it to.
 332         Paragraph(Paragraph const &);
 333 #ifndef NO_NEXT
 334         ///
 335         Paragraph * next_;
 336         ///
 337         Paragraph * previous_;
 338 #endif
 339         struct Pimpl;
 340         ///
 341         friend struct Paragraph::Pimpl;
 342         ///
 343         Pimpl * pimpl_;
 344 };
 345
 346
 347 inline bool isInsertedText(Paragraph const * par, lyx::pos_type pos)
 348 {
 349         return par->lookupChange(pos) == Change::INSERTED;
 350 }
 351
 352
 353 inline bool isDeletedText(Paragraph const * par, lyx::pos_type pos)
 354 {
 355         return par->lookupChange(pos) == Change::DELETED;
 356 }
 357
 358 #endif // PARAGRAPH_H