// -*- 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 "dimension.h"
#include "InsetList.h"
+#include "lyxlayout_ptr_fwd.h"
+#include "RowList_fwd.h"
-#include "insets/inset.h" // Just for Inset::Code
+#include "insets/insetbase.h" // only for InsetBase::Code
-#include "support/types.h"
-#include "changes.h"
-#include "ParagraphList.h"
-#include "LString.h"
+namespace lyx {
-#include <boost/optional.hpp>
+class Buffer;
class BufferParams;
-class BufferView;
class Counters;
+class InsetBase;
class InsetBibitem;
-class Language;
class LaTeXFeatures;
-class LatexRunParams;
+class InsetBase_code;
+class Language;
+class LyXFont;
+class LyXFont_size;
+class MetricsInfo;
+class OutputParams;
+class PainterInfo;
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_STD_LIST 1
+
+class FontSpan {
+public:
+ /// Invalid font span containing no character
+ FontSpan() : first(0), last(-1) {}
+ /// Span including first and last
+ FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
+
+public:
+ /// Range including first and last.
+ pos_type first, last;
+};
+
/// A Paragraph holds all text, attributes and insets in a text paragraph
+/// \todo FIXME: any reference to ParagraphMetrics (including inheritance)
+/// should go in order to complete the Model/View separation of this class.
class Paragraph {
public:
-#ifdef NO_STD_LIST
- // Remove this whan ParagraphList transition is over. (Lgb)
- friend class ParagraphList;
- friend class ParagraphList::iterator;
-#endif
///
- enum META_KIND {
+ enum {
/// 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
+ //META_INSET = 1 // as in trunk
+ META_INSET = 0x200001 // above 0x10ffff, for ucs-4
};
///
- typedef char value_type;
- /// The same as ParameterStruct::depth_type
- typedef unsigned int depth_type;
+ typedef char_type value_type;
+ ///
+ typedef std::vector<value_type> TextContainer;
///
Paragraph();
-
///
Paragraph(Paragraph const &);
///
- //void operator=(Paragraph const &);
- /// the destructor removes the new paragraph from the list
+ Paragraph & operator=(Paragraph const &);
+ ///
~Paragraph();
+ ///
+ int id() const;
+
///
Language const * getParLanguage(BufferParams const &) const;
void changeLanguage(BufferParams const & bparams,
Language const * from, Language const * to);
///
- bool isMultiLingual(BufferParams const &);
+ bool isMultiLingual(BufferParams const &) const;
///
- string const asString(Buffer const *, bool label) const;
+ docstring const asString(Buffer const &, bool label) const;
///
- string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end,
- bool label) const;
+ docstring const asString(Buffer const & buffer,
+ pos_type beg,
+ pos_type end,
+ bool label) const;
///
- void write(Buffer const *, std::ostream &, BufferParams const &,
- depth_type & depth) const;
+ void write(Buffer const &, std::ostream &, BufferParams const &,
+ depth_type & depth) const;
///
void validate(LaTeXFeatures &) const;
- /// return the unique ID of this paragraph
- int id() const;
- /// Set the Id of this paragraph.
- void id(int);
-
///
- int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
+ int startTeXParParams(BufferParams const &, odocstream &, bool) const;
///
- int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
+ int endTeXParParams(BufferParams const &, odocstream &, bool) const;
///
- bool simpleTeXOnePar(Buffer const *, BufferParams const &,
- LyXFont const & outerfont, std::ostream &,
- TexRow & texrow, LatexRunParams const &);
+ bool simpleTeXOnePar(Buffer const &, BufferParams const &,
+ LyXFont const & outerfont, odocstream &,
+ TexRow & texrow, OutputParams const &) const;
+
+ /// Can we drop the standard paragraph wrapper?
+ bool emptyTag() const;
+
+ /// Get the id of the paragraph, usefull for docbook
+ std::string getID(Buffer const & buf,
+ OutputParams const & runparams) const;
+
+ /// Get the first word of a paragraph, return the position where it left
+ pos_type getFirstWord(Buffer const & buf,
+ odocstream & os,
+ OutputParams const & runparams) const;
+
+ /// Checks if the paragraph contains only text and no inset or font change.
+ bool onlyText(Buffer const & buf, LyXFont const & outerfont,
+ pos_type initial) const;
+
+ /// Writes to stream the docbook representation
+ void simpleDocBookOnePar(Buffer const & buf,
+ odocstream &,
+ OutputParams const & runparams,
+ LyXFont const & outerfont,
+ pos_type initial = 0) const;
///
bool hasSameLayout(Paragraph const & par) const;
void makeSameLayout(Paragraph const & par);
///
- Inset * inInset() const;
+ void setInsetOwner(InsetBase * inset);
///
- void setInsetOwner(Inset * i);
+ InsetBase * inInset() const;
///
- void deleteInsetsLyXText(BufferView *);
+ InsetBase::Code ownerCode() const;
///
- void resizeInsetsLyXText(BufferView *);
+ bool forceDefaultParagraphs() const;
///
- lyx::pos_type size() const;
- ///
- bool empty() const;
+ pos_type size() const { return text_.size(); }
///
- void setContentsFromPar(Paragraph const & par);
+ bool empty() const { return text_.empty(); }
///
void clearContents();
///
void layout(LyXLayout_ptr const & new_layout);
- ///
- char enumdepth;
-
- ///
- char itemdepth;
+ /// This is the item depth, only used by enumerate and itemize
+ signed char itemdepth;
///
- InsetBibitem * bibitem(); // ale970302
-
- /// initialise tracking for this par
- void trackChanges(Change::Type = Change::UNCHANGED);
-
- /// stop tracking
- void untrackChanges();
-
- /// set entire paragraph to new text for change tracking
- void cleanChanges();
-
- /// look up change type at given pos
- Change::Type lookupChange(lyx::pos_type pos) const;
+ InsetBibitem * bibitem() const; // ale970302
/// look up change at given pos
- Change const lookupChangeFull(lyx::pos_type pos) const;
+ Change const & lookupChange(pos_type pos) const;
/// is there a change within the given range ?
- bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
+ bool isChanged(pos_type start, pos_type end) const;
+ /// is there an unchanged char at the given pos ?
+ bool isUnchanged(pos_type pos) const {
+ return lookupChange(pos).type == Change::UNCHANGED;
+ }
+ /// is there an insertion at the given pos ?
+ bool isInserted(pos_type pos) const {
+ return lookupChange(pos).type == Change::INSERTED;
+ }
+ /// is there a deletion at the given pos ?
+ bool isDeleted(pos_type pos) const {
+ return lookupChange(pos).type == Change::DELETED;
+ }
- /// is there a non-addition in this range ?
- bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
+ /// will the paragraph be physically merged with the next
+ /// one if the imaginary end-of-par character is logically deleted?
+ bool isMergedOnEndOfParDeletion(bool trackChanges) const;
- /// set change at pos
- void setChange(lyx::pos_type pos, Change::Type type);
+ /// set change for the entire par
+ void setChange(Change const & change);
- /// accept change
- void acceptChange(lyx::pos_type start, lyx::pos_type end);
+ /// set change at given pos
+ void setChange(pos_type pos, Change const & change);
- /// reject change
- void rejectChange(lyx::pos_type start, lyx::pos_type end);
+ /// accept changes within the given range
+ void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
- /// mark whole par as erased
- void markErased();
+ /// reject changes within the given range
+ void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
- /// 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 beginningOfBody() 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.
+ pos_type beginOfBody() const;
+ /// recompute this value
+ void setBeginOfBody();
///
- string const & getLabelstring() const;
+ docstring const & getLabelstring() const;
/// the next two functions are for the manual labels
- string const getLabelWidthString() const;
- ///
- void setLabelWidthString(string const & s);
- ///
+ docstring const getLabelWidthString() const;
+ /// Set label width string.
+ void setLabelWidthString(docstring const & s);
+ /// translate \p label to the paragraph language if possible.
+ docstring const translateIfPossible(docstring const & label,
+ BufferParams const & bparams) const;
+ /// Expand the counters for the labelstring of \c layout
+ docstring expandLabel(LyXLayout_ptr const &, BufferParams const &,
+ bool process_appendix = true) const;
+ /// Actual paragraph alignment used
char getAlign() const;
/// The nesting depth of a paragraph
depth_type getDepth() const;
///
void applyLayout(LyXLayout_ptr const & new_layout);
- /// definite erase
- void eraseIntern(lyx::pos_type pos);
- /// erase the char at the given position
- 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);
+ /// (logically) erase the char at pos; return true if it was actually erased
+ bool eraseChar(pos_type pos, bool trackChanges);
+ /// (logically) erase the given range; return the number of chars actually erased
+ int eraseChars(pos_type start, pos_type end, bool trackChanges);
/** Get uninstantiated font setting. Returns the difference
between the characters font and the layoutfont.
This is what is stored in the fonttable
*/
LyXFont const
- getFontSettings(BufferParams const &, lyx::pos_type pos) const;
+ getFontSettings(BufferParams const &, pos_type pos) const;
///
- LyXFont const getFirstFontSettings() const;
+ LyXFont const getFirstFontSettings(BufferParams const &) const;
/** Get fully instantiated font. If pos == -1, use the layout
font attached to this paragraph.
attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
LyXFont::TOGGLE.
*/
- LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
+ LyXFont const getFont(BufferParams const &, 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;
- ///
- value_type getChar(lyx::pos_type pos) const;
- ///
- value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
- /// The position must already exist.
- void setChar(lyx::pos_type pos, value_type c);
+ /**
+ * The font returned by the above functions is the same in a
+ * span of characters. This method will return the first and
+ * the last positions in the paragraph for which that font is
+ * the same. This can be used to avoid unnecessary calls to getFont.
+ */
+ FontSpan fontSpan(pos_type pos) const;
+ ///
+ /// this is a bottleneck.
+ value_type getChar(pos_type pos) const { return text_[pos]; }
+ /// Get the char, but mirror all bracket characters if it is right-to-left
+ value_type getUChar(BufferParams const &, 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);
+ void setFont(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;
- ///
- void insertChar(lyx::pos_type pos, value_type c);
+ LyXFont_size highestFontInRange(pos_type startpos,
+ pos_type endpos, LyXFont_size def_size) const;
///
- void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
+ void insert(pos_type pos, docstring const & str,
+ LyXFont const & font, Change const & change);
///
- bool checkInsertChar(LyXFont &);
+ void insertChar(pos_type pos, value_type c, bool trackChanges);
///
- void insertInset(lyx::pos_type pos, Inset * inset);
+ void insertChar(pos_type pos, value_type c,
+ LyXFont const &, bool trackChanges);
///
- void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED));
+ void insertChar(pos_type pos, value_type c,
+ LyXFont const &, Change const & change);
///
- bool insetAllowed(Inset::Code code);
+ void insertInset(pos_type pos, InsetBase * inset,
+ Change const & change);
///
- Inset * getInset(lyx::pos_type pos);
+ void insertInset(pos_type pos, InsetBase * inset,
+ LyXFont const &, Change const & change);
///
- 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;
+ bool insetAllowed(InsetBase_code code);
///
- void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos);
+ InsetBase * getInset(pos_type pos) {
+ return insetlist.get(pos);
+ }
///
- bool insertFromMinibuffer(lyx::pos_type pos);
+ InsetBase const * getInset(pos_type pos) const {
+ return insetlist.get(pos);
+ }
///
- bool isHfill(lyx::pos_type pos) const;
- ///
- bool isInset(lyx::pos_type pos) const;
- ///
- bool isNewline(lyx::pos_type pos) const;
- ///
- bool isSeparator(lyx::pos_type pos) const;
- ///
- bool isLineSeparator(lyx::pos_type pos) const;
+ bool isHfill(pos_type pos) const {
+ return isInset(pos)
+ && getInset(pos)->lyxCode() == InsetBase::HFILL_CODE;
+ }
+ /// hinted by profiler
+ bool isInset(pos_type pos) const {
+ return getChar(pos) == static_cast<value_type>(META_INSET);
+ }
///
- bool isKomma(lyx::pos_type pos) const;
- /// Used by the spellchecker
- bool isLetter(lyx::pos_type pos) const;
+ bool isNewline(pos_type pos) const;
+ /// return true if the char is a word separator
+ bool isSeparator(pos_type pos) const { return getChar(pos) == ' '; }
///
- bool isWord(lyx::pos_type pos) const;
+ bool isLineSeparator(pos_type pos) const;
+ /// True if the character/inset at this point can be part of a word.
+ /// Note that digits in particular are considered as letters
+ bool isLetter(pos_type pos) const;
/// returns -1 if inset not found
- int getPositionOfInset(Inset const * inset) const;
+ int getPositionOfInset(InsetBase const * inset) const;
- ///
- int stripLeadingSpaces();
+ /// returns true if at least one line break or line separator has been deleted
+ /// at the beginning of the paragraph (either physically or logically)
+ bool stripLeadingSpaces(bool trackChanges);
- ///
+ /// return true if we allow multiple spaces
bool isFreeSpacing() const;
+ /// return true if we allow this par to stay empty
+ bool allowEmpty() const;
+ ///
+ char_type transformChar(char_type c, pos_type pos) const;
///
ParagraphParameters & params();
///
ParagraphParameters const & params() const;
///
- InsetList insetlist;
- ///
- //Counters & counters();
+ bool hfillExpansion(Row const & row, pos_type pos) const;
+
+ /// Check if we are in a Biblio environment.
+ /// \retval true if the cursor needs to be moved right.
+ bool checkBiblio(bool track_changes);
+
+public:
///
- void owningBuffer(Buffer const & b) {
- buffer_.reset(&b);
- }
+ InsetList insetlist;
+
private:
+
///
LyXLayout_ptr layout_;
-#ifdef NO_STD_LIST
- Paragraph * next_par_;
- Paragraph * prev_par_;
-#endif
- ///
- boost::optional<Buffer const *> buffer_;
+ /**
+ * 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
+ pos_type begin_of_body_;
- struct Pimpl;
+ /// Pimpl away stuff
+ class Pimpl;
///
- friend struct Paragraph::Pimpl;
+ friend class Paragraph::Pimpl;
///
Pimpl * pimpl_;
-
};
-
-inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
-{
- return par.lookupChange(pos) == Change::INSERTED;
-}
-
-
-inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
-{
- return par.lookupChange(pos) == Change::DELETED;
-}
-
-bool operator==(Paragraph const & lhs, Paragraph const & rhs);
+} // namespace lyx
#endif // PARAGRAPH_H
projects / lyx.git / blobdiff