// -*- C++ -*-
/**
- * \file paragraph.h
- * Copyright 1995 Matthias Ettrich
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * \file paragraph.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Asger Alstrup
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ * \author André Pönitz
+ * \author Jürgen Vigna
+ *
+ * Full author contact details are available in file CREDITS.
*/
#ifndef PARAGRAPH_H
#define PARAGRAPH_H
-#include "lyxlayout_ptr_fwd.h"
-#include "lyxfont.h" // Just for LyXFont::FONT_SIZE
+#include "changes.h"
#include "InsetList.h"
-
-#include "insets/inset.h" // Just for Inset::Code
+#include "lyxlayout_ptr_fwd.h"
+#include "RowList_fwd.h"
#include "support/types.h"
-#include "changes.h"
-#include "LString.h"
+#include <string>
+class Buffer;
class BufferParams;
class BufferView;
class Counters;
class InsetBibitem;
+class InsetOld_code;
class Language;
class LaTeXFeatures;
+class OutputParams;
+class LyXFont;
+class LyXFont_size;
class ParagraphParameters;
class TexRow;
-
-// Define this if you want to try out the new storage container for
-// paragraphs. (Lgb)
-// This is non working and far from finished.
-// #define NO_NEXT 1
+class UpdatableInset;
/// A Paragraph holds all text, attributes and insets in a text paragraph
class Paragraph {
public:
///
enum META_KIND {
- ///
- META_HFILL = 1,
- ///
- META_NEWLINE,
- ///
- META_INSET
+ /// Note that this is 1 right now to avoid
+ /// crashes where getChar() is called wrongly
+ /// (returning 0) - if this was 0, then we'd
+ /// try getInset() and crash. We should fix
+ /// all these places.
+ META_INSET = 1
};
///
typedef char value_type;
- /// The same as ParameterStruct::depth_type
- typedef unsigned int depth_type;
+ ///
+ typedef lyx::depth_type depth_type;
+ ///
+ typedef std::vector<value_type> TextContainer;
///
Paragraph();
-#ifndef NO_NEXT
- /// this constructor inserts the new paragraph in a list
- explicit
- Paragraph(Paragraph * par);
-#endif
+
+ ///
+ Paragraph(Paragraph const &);
///
- Paragraph(Paragraph const &, bool same_ids);
+ void operator=(Paragraph const &);
/// the destructor removes the new paragraph from the list
~Paragraph();
+ ///
+ int id() const;
+
///
Language const * getParLanguage(BufferParams const &) const;
///
bool isMultiLingual(BufferParams const &);
///
- string const asString(Buffer const *, bool label) const;
+ std::string const asString(Buffer const &,
+ OutputParams const & runparams,
+ bool label) const;
///
- string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
- bool label) const;
-
+ std::string const asString(Buffer const &, bool label) const;
///
- void write(Buffer const *, std::ostream &, BufferParams const &,
- depth_type & depth) const;
+ std::string const Paragraph::asString(Buffer const & buffer,
+ lyx::pos_type beg,
+ lyx::pos_type end,
+ bool label) const;
///
- void validate(LaTeXFeatures &) const;
+ std::string const asString(Buffer const &,
+ OutputParams const & runparams,
+ lyx::pos_type beg,
+ lyx::pos_type end,
+ bool label) const;
- /// return the unique ID of this paragraph
- int id() const;
///
- void read();
+ void write(Buffer const &, std::ostream &, BufferParams const &,
+ depth_type & depth) const;
+ ///
+ void validate(LaTeXFeatures &) const;
///
int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
///
- bool simpleTeXOnePar(Buffer const *, BufferParams const &,
- std::ostream &, TexRow & texrow, bool moving_arg);
+ bool simpleTeXOnePar(Buffer const &, BufferParams const &,
+ LyXFont const & outerfont, std::ostream &,
+ TexRow & texrow, OutputParams const &);
///
- bool hasSameLayout(Paragraph const * par) const;
+ void simpleLinuxDocOnePar(Buffer const & buf,
+ std::ostream & os,
+ LyXFont const & outerfont,
+ OutputParams const & runparams,
+ lyx::depth_type depth) const;
///
- void makeSameLayout(Paragraph const * par);
-
- /// Is it the first par with same depth and layout?
- bool isFirstInSequence() const;
+ void simpleDocBookOnePar(Buffer const & buf,
+ std::ostream &,
+ LyXFont const & outerfont,
+ OutputParams const & runparams,
+ lyx::depth_type depth,
+ bool labelid) const;
- /** Check if the current paragraph is the last paragraph in a
- proof environment */
- int getEndLabel() const;
///
- Inset * inInset() const;
+ bool hasSameLayout(Paragraph const & par) const;
+
///
- void setInsetOwner(Inset * i);
+ void makeSameLayout(Paragraph const & par);
+
///
- void deleteInsetsLyXText(BufferView *);
+ UpdatableInset * inInset() const;
///
- void resizeInsetsLyXText(BufferView *);
+ void setInsetOwner(UpdatableInset * inset);
///
- lyx::pos_type size() const;
+ lyx::pos_type size() const { return text_.size(); }
///
- bool empty() const;
+ bool empty() const { return text_.empty(); }
///
- void setContentsFromPar(Paragraph * par);
+ void setContentsFromPar(Paragraph const & par);
///
void clearContents();
///
void layout(LyXLayout_ptr const & new_layout);
- ///
- char enumdepth;
-
- ///
- char itemdepth;
-
- ///
- InsetBibitem * bibitem(); // ale970302
+ /// This is the item depth, only used by enumerate and itemize
+ signed char itemdepth;
-#ifndef NO_NEXT
- ///
- void next(Paragraph *);
- /** these function are able to hide closed footnotes
- */
- Paragraph * next();
- ///
- Paragraph const * next() const;
-
- ///
- void previous(Paragraph *);
- ///
- Paragraph * previous();
///
- Paragraph const * previous() const;
-#endif
+ InsetBibitem * bibitem() const; // ale970302
/// initialise tracking for this par
void trackChanges(Change::Type = Change::UNCHANGED);
/// mark whole par as erased
void markErased();
- /// for the environments
- Paragraph * depthHook(depth_type depth);
- /// for the environments
- Paragraph const * depthHook(depth_type depth) const;
- ///
- Paragraph * outerHook();
- ///
- Paragraph const * outerHook() const;
- ///
- int beginningOfMainBody() const;
+ /// Paragraphs can contain "manual labels", for example, Description
+ /// environment. The text for this user-editable label is stored in
+ /// the paragraph alongside the text of the rest of the paragraph
+ /// (the body). This function returns the starting position of the
+ /// body of the text in the paragraph.
+ int beginOfBody() const;
+ /// recompute this value
+ void setBeginOfBody();
+
///
- string const & getLabelstring() const;
+ std::string const & getLabelstring() const;
/// the next two functions are for the manual labels
- string const getLabelWidthString() const;
+ std::string const getLabelWidthString() const;
///
- void setLabelWidthString(string const & s);
+ void setLabelWidthString(std::string const & s);
///
char getAlign() const;
/// The nesting depth of a paragraph
/// definite erase
void eraseIntern(lyx::pos_type pos);
/// erase the char at the given position
- void erase(lyx::pos_type pos);
- /// erase the given range. Returns true if actually erased.
- bool erase(lyx::pos_type start, lyx::pos_type end);
+ bool erase(lyx::pos_type pos);
+ /// erase the given range. Returns the number of chars actually erased
+ int erase(lyx::pos_type start, lyx::pos_type end);
/** Get uninstantiated font setting. Returns the difference
between the characters font and the layoutfont.
attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
LyXFont::TOGGLE.
*/
- LyXFont const getFont(BufferParams const &, lyx::pos_type pos) const;
- LyXFont const getLayoutFont(BufferParams const &) const;
- LyXFont const getLabelFont(BufferParams const &) const;
+ LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
+ LyXFont const & outerfont) const;
+ LyXFont const getLayoutFont(BufferParams const &,
+ LyXFont const & outerfont) const;
+ LyXFont const getLabelFont(BufferParams const &,
+ LyXFont const & outerfont) const;
+ /**
+ * The font returned by the above functions is the same in a
+ * span of characters. This method will return the last position
+ * in the paragraph for which that font is the same.
+ * This can be used to avoid unnecessary calls to getFont.
+ */
+ lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
///
value_type getChar(lyx::pos_type pos) const;
///
/// pos <= size() (there is a dummy font change at the end of each par)
void setFont(lyx::pos_type pos, LyXFont const & font);
/// Returns the height of the highest font in range
- LyXFont::FONT_SIZE
- highestFontInRange(lyx::pos_type startpos,
- lyx::pos_type endpos,
- LyXFont::FONT_SIZE const def_size) const;
+ LyXFont_size highestFontInRange(lyx::pos_type startpos,
+ lyx::pos_type endpos,
+ LyXFont_size def_size) const;
+ ///
+ void insert(lyx::pos_type pos, std::string const & str,
+ LyXFont const & font);
///
void insertChar(lyx::pos_type pos, value_type c);
///
///
bool checkInsertChar(LyXFont &);
///
- void insertInset(lyx::pos_type pos, Inset * inset);
+ void insertInset(lyx::pos_type pos, InsetOld * inset);
///
- void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
+ void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
///
- bool insetAllowed(Inset::Code code);
+ bool insetAllowed(InsetOld_code code);
///
- Inset * getInset(lyx::pos_type pos);
+ InsetOld * getInset(lyx::pos_type pos);
///
- Inset const * getInset(lyx::pos_type pos) const;
- /** important for cut and paste
- Temporary change from BufferParams to Buffer. Will revert when we
- get rid of the argument to Inset::clone(Buffer const &) */
- void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const;
- ///
- void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
- ///
- bool insertFromMinibuffer(lyx::pos_type pos);
+ InsetOld const * getInset(lyx::pos_type pos) const;
///
bool isHfill(lyx::pos_type pos) const;
bool isWord(lyx::pos_type pos) const;
/// returns -1 if inset not found
- int getPositionOfInset(Inset const * inset) const;
+ int getPositionOfInset(InsetOld const * inset) const;
///
int stripLeadingSpaces();
- ///
+ /// return true if we allow multiple spaces
bool isFreeSpacing() const;
+ /// return true if we allow this par to stay empty
+ bool allowEmpty() const;
+ ////
+ unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
///
ParagraphParameters & params();
///
ParagraphParameters const & params() const;
+
+ ///
+ RowList::iterator getRow(lyx::pos_type pos);
+
///
InsetList insetlist;
+
///
- //Counters & counters();
+ mutable RowList rows;
+ /// last draw y position (baseline of top row)
+ int y;
+ /// total height of paragraph
+ unsigned int height;
+ /// total width of paragraph, may differ from workwidth
+ unsigned int width;
+
private:
///
LyXLayout_ptr layout_;
- /// if anything uses this we don't want it to.
- Paragraph(Paragraph const &);
-#ifndef NO_NEXT
- ///
- Paragraph * next_;
- ///
- Paragraph * previous_;
-#endif
+ /// keeping this here instead of in the pimpl makes LyX >10% faster
+ // for average tasks as buffer loading/switching etc.
+ TextContainer text_;
+ /// end of label
+ int begin_of_body_;
+
struct Pimpl;
///
friend struct Paragraph::Pimpl;
///
Pimpl * pimpl_;
+
};
projects / lyx.git / blobdiff