// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
+/**
+ * \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
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "changes.h"
+#include "dimension.h"
+#include "InsetList.h"
+#include "lyxlayout_ptr_fwd.h"
+#include "RowList_fwd.h"
-#include "LString.h"
+#include "insets/insetbase.h" // only for InsetBase::Code
-#include <vector>
-#include "insets/inset.h" // Just for Inset::Code
-#include "layout.h"
+namespace lyx {
-class ParagraphParameters;
+
+class Buffer;
class BufferParams;
-class TexRow;
-struct LaTeXFeatures;
-class InsetBibKey;
-class BufferView;
+class Counters;
+class InsetBase;
+class InsetBibitem;
+class LaTeXFeatures;
+class InsetBase_code;
class Language;
+class LyXFont;
+class LyXFont_size;
+class MetricsInfo;
+class OutputParams;
+class PainterInfo;
+class ParagraphParameters;
+class TexRow;
-// After 1.2.0 is released, during 1.3.0cvs, we enable this. And after
-// a while we verify that reading of 1.2.x files work perfectly we remove
-// this code completely. (Lgb)
-//#define NO_PEXTRA_REALLY 1
-// Define this if you want to try out the new storage container for
-// paragraphs. std::container instead of obfuscated homegrown
-// linked list. (Lgb)
-// This is non working and far from finished.
-// #define NO_NEXT 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:
-#ifndef NO_PEXTRA_REALLY
- ///
- enum PEXTRA_TYPE {
- ///
- PEXTRA_NONE,
- ///
- PEXTRA_INDENT,
- ///
- PEXTRA_MINIPAGE,
- ///
- PEXTRA_FLOATFLT
- };
///
- enum MINIPAGE_ALIGNMENT {
- ///
- MINIPAGE_ALIGN_TOP,
- ///
- MINIPAGE_ALIGN_MIDDLE,
- ///
- MINIPAGE_ALIGN_BOTTOM
- };
-#endif
- ///
- enum META_KIND {
- ///
- META_HFILL = 1,
- ///
- META_NEWLINE,
- ///
- META_INSET
+ 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 // 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;
- ///
- /* This should be TextContainer::size_type, but we need
- signed values for now.
- */
- typedef TextContainer::difference_type size_type;
///
Paragraph();
- /// this constructor inserts the new paragraph in a list
- explicit
- Paragraph(Paragraph * par);
///
- Paragraph(Paragraph const &, bool same_ids = false);
- /// the destructor removes the new paragraph from the list
+ Paragraph(Paragraph const &);
+ ///
+ 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);
- ///
- string const asString(Buffer const *, size_type beg, size_type end);
-
- ///
- void writeFile(Buffer const *, std::ostream &, BufferParams const &,
- depth_type) const;
- ///
- void validate(LaTeXFeatures &) const;
-
- ///
- int id() const;
///
- void id(int id_arg);
+ docstring const asString(Buffer const &, bool label) const;
///
- void read();
+ docstring const asString(Buffer const & buffer,
+ pos_type beg,
+ pos_type end,
+ bool label) const;
///
- Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
- std::ostream &, TexRow & texrow,
- bool moving_arg);
+ void write(Buffer const &, std::ostream &, BufferParams const &,
+ depth_type & depth) const;
///
- bool simpleTeXOnePar(Buffer const *, BufferParams const &,
- std::ostream &, TexRow & texrow, bool moving_arg);
+ void validate(LaTeXFeatures &) const;
///
- Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
- std::ostream &, TexRow & texrow);
- ///
- bool hasSameLayout(Paragraph const * par) const;
+ int startTeXParParams(BufferParams const &, odocstream &, bool) const;
///
- void makeSameLayout(Paragraph const * par);
+ int endTeXParParams(BufferParams const &, odocstream &, bool) const;
- /// Is it the first par with same depth and layout?
- bool isFirstInSequence() const;
- /** Check if the current paragraph is the last paragraph in a
- proof environment */
- int getEndLabel(BufferParams const &) const;
- ///
- Inset * inInset() const;
///
- void setInsetOwner(Inset * i);
+ 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;
+
///
- void deleteInsetsLyXText(BufferView *);
+ bool hasSameLayout(Paragraph const & par) const;
+
///
- void resizeInsetsLyXText(BufferView *);
+ void makeSameLayout(Paragraph const & par);
///
- size_type size() const;
+ void setInsetOwner(InsetBase * inset);
///
- void setContentsFromPar(Paragraph * par);
+ InsetBase * inInset() const;
///
- void clearContents();
-
+ InsetBase::Code ownerCode() const;
///
- LyXTextClass::LayoutList::size_type layout;
+ bool forceDefaultParagraphs() const;
///
- void setCounter(int i, int v);
+ pos_type size() const { return text_.size(); }
///
- int getCounter(int i) const;
+ bool empty() const { return text_.empty(); }
///
- void incCounter(int i);
+ void clearContents();
///
- char enumdepth;
-
+ LyXLayout_ptr const & layout() const;
///
- char itemdepth;
+ void layout(LyXLayout_ptr const & new_layout);
- ///
- InsetBibKey * bibkey; // ale970302
+ /// This is the item depth, only used by enumerate and itemize
+ signed char itemdepth;
///
- void next(Paragraph *);
- /** these function are able to hide closed footnotes
- */
- Paragraph * next();
- ///
- Paragraph const * next() const;
+ InsetBibitem * bibitem() const; // ale970302
- ///
- void previous(Paragraph *);
- ///
- Paragraph * previous();
- ///
- Paragraph const * previous() const;
+ /// look up change at given pos
+ Change const & lookupChange(pos_type pos) const;
+
+ /// is there a change within the given range ?
+ 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;
+ }
+
+ /// 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 for the entire par
+ void setChange(Change const & change);
+
+ /// set change at given pos
+ void setChange(pos_type pos, Change const & change);
+
+ /// accept changes within the given range
+ void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
+
+ /// 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.
+ pos_type beginOfBody() const;
+ /// recompute this value
+ void setBeginOfBody();
- /// 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;
///
- 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);
- ///
- LyXTextClass::LayoutList::size_type getLayout() const;
- ///
+ 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;
+ /// The maximal possible depth of a paragraph after this one
+ depth_type getMaxDepthAfter() const;
///
- void setLayout(LyXTextClass::LayoutList::size_type new_layout);
- ///
- void setOnlyLayout(LyXTextClass::LayoutList::size_type new_layout);
- ///
- int getFirstCounter(int i) const;
- ///
- void erase(size_type pos);
- /** the flag determines wether the layout should be copied
- */
- void breakParagraph(BufferParams const &, size_type pos, int flag);
- ///
- void breakParagraphConservative(BufferParams const &, size_type pos);
- /** Get unistantiated font setting. Returns the difference
+ void applyLayout(LyXLayout_ptr const & new_layout);
+
+ /// (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 &, size_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.
If pos == -2, use the label font of the layout attached here.
In all cases, the font is instantiated, i.e. does not have any
- attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
+ attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
LyXFont::TOGGLE.
*/
- LyXFont const getFont(BufferParams const &, size_type pos) const;
- ///
- value_type getChar(size_type pos) const;
- ///
- value_type getUChar(BufferParams const &, size_type pos) const;
- /// The position must already exist.
- void setChar(size_type pos, value_type c);
- ///
- void setFont(size_type pos, LyXFont const & font);
+ 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;
+ /**
+ * 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(pos_type pos, LyXFont const & font);
/// Returns the height of the highest font in range
- LyXFont::FONT_SIZE highestFontInRange(size_type startpos,
- size_type endpos) const;
- ///
- void insertChar(size_type pos, value_type c);
+ LyXFont_size highestFontInRange(pos_type startpos,
+ pos_type endpos, LyXFont_size def_size) const;
///
- void insertChar(size_type pos, value_type c, LyXFont const &);
+ 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(size_type pos, Inset * inset);
+ void insertChar(pos_type pos, value_type c,
+ LyXFont const &, bool trackChanges);
///
- void insertInset(size_type pos, Inset * inset, LyXFont const &);
+ 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(size_type pos);
+ void insertInset(pos_type pos, InsetBase * inset,
+ LyXFont const &, Change const & change);
///
- Inset const * getInset(size_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 &, size_type pos) const;
+ bool insetAllowed(InsetBase_code code);
///
- void cutIntoMinibuffer(BufferParams const &, size_type pos);
+ InsetBase * getInset(pos_type pos) {
+ return insetlist.get(pos);
+ }
///
- bool insertFromMinibuffer(size_type pos);
+ InsetBase const * getInset(pos_type pos) const {
+ return insetlist.get(pos);
+ }
///
- bool isHfill(size_type pos) const;
- ///
- bool isInset(size_type pos) const;
- ///
- bool isNewline(size_type pos) const;
- ///
- bool isSeparator(size_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 isLineSeparator(size_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 isKomma(size_type pos) const;
- /// Used by the spellchecker
- bool isLetter(size_type pos) const;
- ///
- bool isWord(size_type pos) const;
-
- /** This one resets all layout and dtp switches but not the font
- of the single characters
- */
- void clear();
-
- /** paste this paragraph with the next one
- be carefull, this doesent make any check at all
- */
- void pasteParagraph(BufferParams const &);
-
- /// used to remove the error messages
- int autoDeleteInsets();
+ 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 * inset) const;
+ int getPositionOfInset(InsetBase const * inset) const;
- /// some good comment here John?
- Paragraph * getParFromID(int id) const;
+ /// 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);
- ///
- int stripLeadingSpaces(LyXTextClassList::size_type tclass);
+ /// return true if we allow multiple spaces
+ bool isFreeSpacing() const;
-#ifndef NO_PEXTRA_REALLY
- /* If I set a PExtra Indent on one paragraph of a ENV_LIST-TYPE
- I have to set it on each of it's elements */
- ///
- void setPExtraType(BufferParams const &, int type,
- string const & width, string const & widthp);
+ /// return true if we allow this par to stay empty
+ bool allowEmpty() const;
///
- void unsetPExtraType(BufferParams const &);
-#endif
+ char_type transformChar(char_type c, pos_type pos) const;
///
- bool linuxDocConvertChar(char c, string & sgml_string);
-
ParagraphParameters & params();
- ParagraphParameters const & params() const;
-private:
-
- ///
- struct InsetTable {
- ///
- size_type pos;
- ///
- Inset * inset;
- ///
- InsetTable(size_type p, Inset * i) : pos(p), inset(i) {}
- };
-
///
- typedef std::vector<InsetTable> InsetList;
+ ParagraphParameters const & params() const;
///
- InsetList insetlist;
+ 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:
///
- class inset_iterator {
- public:
- ///
- inset_iterator() {}
- //
- inset_iterator(InsetList::iterator const & iter);
- ///
- inset_iterator & operator++() {
- ++it;
- return *this;
- }
- ///
- Inset * operator*() { return it->inset; }
- ///
- size_type getPos() const {return it->pos; }
- ///
- bool operator==(inset_iterator const & iter) const {
- return it == iter.it;
- }
- ///
- bool operator!=(inset_iterator const & iter) const {
- return it != iter.it;
- }
- private:
- ///
- InsetList::iterator it;
- };
- ///
- friend class inset_iterator;
-
- ///
- inset_iterator inset_iterator_begin();
- ///
- inset_iterator inset_iterator_end();
- ///
- inset_iterator InsetIterator(size_type pos);
+ InsetList insetlist;
private:
+
///
- Paragraph * next_;
- ///
- Paragraph * previous_;
+ LyXLayout_ptr layout_;
+ /**
+ * 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_;
};
-#endif
+} // namespace lyx
+
+#endif // PARAGRAPH_H
projects / lyx.git / blobdiff