src/paragraph.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *          Copyright 1995 Matthias Ettrich
   8  *          Copyright 1995-2001 The LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef PARAGRAPH_H
  13 #define PARAGRAPH_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include "LString.h"
  20
  21 #include "insets/inset.h" // Just for Inset::Code
  22 #include "layout.h"
  23 #include "support/types.h"
  24
  25 class ParagraphParameters;
  26 class BufferParams;
  27 class TexRow;
  28 struct LaTeXFeatures;
  29 class InsetBibKey;
  30 class BufferView;
  31 class Language;
  32
  33 // After 1.2.0 is released, during 1.3.0cvs, we enable this. And after
  34 // a while we verify that reading of 1.2.x files work perfectly we remove
  35 // this code completely. (Lgb)
  36 //#define NO_PEXTRA_REALLY 1
  37
  38 // Define this if you want to try out the new storage container for
  39 // paragraphs. std::container instead of obfuscated homegrown
  40 // linked list. (Lgb)
  41 // This is non working and far from finished.
  42 // #define NO_NEXT 1
  43
  44 /// A Paragraph holds all text, attributes and insets in a text paragraph
  45 class Paragraph  {
  46 public:
  47 #ifndef NO_PEXTRA_REALLY
  48         ///
  49         enum PEXTRA_TYPE {
  50                 ///
  51                 PEXTRA_NONE,
  52                 ///
  53                 PEXTRA_INDENT,
  54                 ///
  55                 PEXTRA_MINIPAGE,
  56                 ///
  57                 PEXTRA_FLOATFLT
  58         };
  59         ///
  60         enum MINIPAGE_ALIGNMENT {
  61                 ///
  62                 MINIPAGE_ALIGN_TOP,
  63                 ///
  64                 MINIPAGE_ALIGN_MIDDLE,
  65                 ///
  66                 MINIPAGE_ALIGN_BOTTOM
  67         };
  68 #endif
  69         ///
  70         enum META_KIND {
  71                 ///
  72                 META_HFILL = 1,
  73                 ///
  74                 META_NEWLINE,
  75                 ///
  76                 META_INSET
  77         };
  78         ///
  79         typedef char value_type;
  80         /// The same as ParameterStruct::depth_type
  81         typedef unsigned int depth_type;
  82
  83         ///
  84         Paragraph();
  85         /// this constructor inserts the new paragraph in a list
  86         explicit
  87         Paragraph(Paragraph * par);
  88         ///
  89         Paragraph(Paragraph const &, bool same_ids);
  90         /// the destructor removes the new paragraph from the list
  91         ~Paragraph();
  92
  93         ///
  94         Language const * getParLanguage(BufferParams const &) const;
  95         ///
  96         bool isRightToLeftPar(BufferParams const &) const;
  97         ///
  98         void changeLanguage(BufferParams const & bparams,
  99                             Language const * from, Language const * to);
 100         ///
 101         bool isMultiLingual(BufferParams const &);
 102
 103         ///
 104         string const asString(Buffer const *, bool label);
 105         ///
 106         string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
 107                               bool label);
 108
 109         ///
 110         void writeFile(Buffer const *, std::ostream &, BufferParams const &,
 111                        depth_type) const;
 112         ///
 113         void validate(LaTeXFeatures &) const;
 114
 115         ///
 116         int id() const;
 117         ///
 118         void id(int id_arg);
 119         ///
 120         void read();
 121
 122         ///
 123         Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
 124                                  std::ostream &, TexRow & texrow,
 125                                  bool moving_arg);
 126         ///
 127         bool simpleTeXOnePar(Buffer const *, BufferParams const &,
 128                              std::ostream &, TexRow & texrow, bool moving_arg);
 129
 130         ///
 131         Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
 132                                       std::ostream &, TexRow & texrow);
 133         ///
 134         bool hasSameLayout(Paragraph const * par) const;
 135
 136         ///
 137         void makeSameLayout(Paragraph const * par);
 138
 139         /// Is it the first par with same depth and layout?
 140         bool isFirstInSequence() const;
 141
 142         /** Check if the current paragraph is the last paragraph in a
 143             proof environment */
 144         int getEndLabel(BufferParams const &) const;
 145         ///
 146         Inset * inInset() const;
 147         ///
 148         void setInsetOwner(Inset * i);
 149         ///
 150         void deleteInsetsLyXText(BufferView *);
 151         ///
 152         void resizeInsetsLyXText(BufferView *);
 153
 154         ///
 155         lyx::pos_type size() const;
 156         ///
 157         void setContentsFromPar(Paragraph * par);
 158         ///
 159         void clearContents();
 160
 161         ///
 162         lyx::layout_type layout;
 163
 164         ///
 165         void setCounter(int i, int v);
 166         ///
 167         int getCounter(int i) const;
 168         ///
 169         void incCounter(int i);
 170
 171         ///
 172         char enumdepth;
 173
 174         ///
 175         char itemdepth;
 176
 177         ///
 178         InsetBibKey * bibkey;  // ale970302
 179
 180         ///
 181         void next(Paragraph *);
 182         /** these function are able to hide closed footnotes
 183          */
 184         Paragraph * next();
 185         ///
 186         Paragraph const * next() const;
 187
 188         ///
 189         void previous(Paragraph *);
 190         ///
 191         Paragraph * previous();
 192         ///
 193         Paragraph const * previous() const;
 194
 195         /// for the environments
 196         Paragraph * depthHook(depth_type depth);
 197         /// for the environments
 198         Paragraph const * depthHook(depth_type depth) const;
 199         ///
 200         Paragraph * outerHook();
 201         ///
 202         Paragraph const * outerHook() const;
 203         ///
 204         int beginningOfMainBody() const;
 205         ///
 206         string const & getLabelstring() const;
 207
 208         /// the next two functions are for the manual labels
 209         string const getLabelWidthString() const;
 210         ///
 211         void setLabelWidthString(string const & s);
 212         ///
 213         lyx::layout_type getLayout() const;
 214         ///
 215         char getAlign() const;
 216         ///
 217         depth_type getDepth() const;
 218         ///
 219         void setLayout(lyx::layout_type new_layout);
 220         ///
 221         void setOnlyLayout(lyx::layout_type new_layout);
 222         ///
 223         int getFirstCounter(int i) const;
 224         ///
 225         void erase(lyx::pos_type pos);
 226         /** the flag determines wether the layout should be copied
 227          */
 228         void breakParagraph(BufferParams const &, lyx::pos_type pos, int flag);
 229         ///
 230         void breakParagraphConservative(BufferParams const &, lyx::pos_type pos);
 231         /** Get unistantiated font setting. Returns the difference
 232             between the characters font and the layoutfont.
 233             This is what is stored in the fonttable
 234         */
 235         LyXFont const
 236         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 237         ///
 238         LyXFont const getFirstFontSettings() const;
 239
 240         /** Get fully instantiated font. If pos == -1, use the layout
 241             font attached to this paragraph.
 242             If pos == -2, use the label font of the layout attached here.
 243             In all cases, the font is instantiated, i.e. does not have any
 244             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 245             LyXFont::TOGGLE.
 246         */
 247         LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
 248         LyXFont const getLayoutFont(BufferParams const &) const;
 249         LyXFont const getLabelFont(BufferParams const &) const;
 250         ///
 251         value_type getChar(lyx::pos_type pos) const;
 252         ///
 253         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 254         /// The position must already exist.
 255         void setChar(lyx::pos_type pos, value_type c);
 256         ///
 257         void setFont(lyx::pos_type pos, LyXFont const & font);
 258         /// Returns the height of the highest font in range
 259         LyXFont::FONT_SIZE highestFontInRange(lyx::pos_type startpos,
 260                                               lyx::pos_type endpos,
 261                                                                                   LyXFont::FONT_SIZE const def_size) const;
 262         ///
 263         void insertChar(lyx::pos_type pos, value_type c);
 264         ///
 265         void insertChar(lyx::pos_type pos, value_type c, LyXFont const &);
 266         ///
 267         bool checkInsertChar(LyXFont &);
 268         ///
 269         void insertInset(lyx::pos_type pos, Inset * inset);
 270         ///
 271         void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &);
 272         ///
 273         bool insetAllowed(Inset::Code code);
 274         ///
 275         Inset * getInset(lyx::pos_type pos);
 276         ///
 277         Inset const * getInset(lyx::pos_type pos) const;
 278         /** important for cut and paste
 279             Temporary change from BufferParams to Buffer. Will revert when we
 280             get rid of the argument to Inset::clone(Buffer const &) */
 281         void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
 282         ///
 283         void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
 284         ///
 285         bool insertFromMinibuffer(lyx::pos_type pos);
 286
 287         ///
 288         bool isHfill(lyx::pos_type pos) const;
 289         ///
 290         bool isInset(lyx::pos_type pos) const;
 291         ///
 292         bool isNewline(lyx::pos_type pos) const;
 293         ///
 294         bool isSeparator(lyx::pos_type pos) const;
 295         ///
 296         bool isLineSeparator(lyx::pos_type pos) const;
 297         ///
 298         bool isKomma(lyx::pos_type pos) const;
 299         /// Used by the spellchecker
 300         bool isLetter(lyx::pos_type pos) const;
 301         ///
 302         bool isWord(lyx::pos_type pos) const;
 303
 304         /** This one resets all layout and dtp switches but not the font
 305             of the single characters
 306         */
 307         void clear();
 308
 309         /** paste this paragraph with the next one
 310             be carefull, this doesent make any check at all
 311         */
 312         void pasteParagraph(BufferParams const &);
 313
 314         /// used to remove the error messages
 315         int autoDeleteInsets();
 316
 317         /// returns -1 if inset not found
 318         int getPositionOfInset(Inset * inset) const;
 319
 320         /// some good comment here John?
 321         Paragraph * getParFromID(int id) const;
 322
 323         ///
 324         int stripLeadingSpaces(LyXTextClassList::size_type tclass);
 325
 326 #ifndef NO_PEXTRA_REALLY
 327         /* If I set a PExtra Indent on one paragraph of a ENV_LIST-TYPE
 328            I have to set it on each of it's elements */
 329         ///
 330         void setPExtraType(BufferParams const &, int type,
 331                            string const & width, string const & widthp);
 332         ///
 333         void unsetPExtraType(BufferParams const &);
 334 #endif
 335         ///
 336         bool sgmlConvertChar(char c, string & sgml_string);
 337         ///
 338         bool isFreeSpacing() const;
 339
 340         ParagraphParameters & params();
 341         ParagraphParameters const & params() const;
 342 private:
 343
 344         ///
 345         struct InsetTable {
 346                 ///
 347                 lyx::pos_type pos;
 348                 ///
 349                 Inset * inset;
 350                 ///
 351                 InsetTable(lyx::pos_type p, Inset * i) : pos(p), inset(i) {}
 352         };
 353
 354         ///
 355         typedef std::vector<InsetTable> InsetList;
 356         ///
 357         InsetList insetlist;
 358 public:
 359         ///
 360         class inset_iterator {
 361         public:
 362                 ///
 363                 inset_iterator() {}
 364                 //
 365                 inset_iterator(InsetList::iterator const & iter);
 366                 ///
 367                 inset_iterator & operator++() {
 368                         ++it;
 369                         return *this;
 370                 }
 371                 ///
 372                 Inset * operator*() { return it->inset; }
 373                 ///
 374                 lyx::pos_type getPos() const { return it->pos; }
 375                 ///
 376                 bool operator==(inset_iterator const & iter) const {
 377                         return it == iter.it;
 378                 }
 379                 ///
 380                 bool operator!=(inset_iterator const & iter) const {
 381                         return it != iter.it;
 382                 }
 383         private:
 384                 ///
 385                 InsetList::iterator it;
 386         };
 387         ///
 388         friend class inset_iterator;
 389
 390         ///
 391         inset_iterator inset_iterator_begin();
 392         ///
 393         inset_iterator inset_iterator_end();
 394         ///
 395         inset_iterator InsetIterator(lyx::pos_type pos);
 396
 397 private:
 398         /// if anything uses this we don't want it to.
 399         Paragraph(Paragraph const &);
 400         ///
 401         Paragraph * next_;
 402         ///
 403         Paragraph * previous_;
 404
 405         struct Pimpl;
 406         ///
 407         friend struct Paragraph::Pimpl;
 408         ///
 409         Pimpl * pimpl_;
 410 };
 411
 412 #endif