// -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file paragraph.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * LyX, The Document Processor
+ * \author Asger Alstrup
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ * \author André Pönitz
+ * \author Jürgen Vigna
*
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef PARAGRAPH_H
#define PARAGRAPH_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "LString.h"
+#include "changes.h"
+#include "InsetList.h"
+#include "lyxlayout_ptr_fwd.h"
+#include "RowList_fwd.h"
-#include "insets/inset.h" // Just for Inset::Code
-#include "lyxfont.h" // Just for LyXFont::FONT_SIZE
#include "support/types.h"
-class ParagraphParameters;
+#include <string>
+
+class Buffer;
class BufferParams;
-class TexRow;
-class LaTeXFeatures;
-class InsetBibKey;
class BufferView;
+class Counters;
+class InsetBibitem;
+class InsetOld_code;
class Language;
-
-// 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 LaTeXFeatures;
+class OutputParams;
+class LyXFont;
+class LyXFont_size;
+class ParagraphParameters;
+class TexRow;
+class UpdatableInset;
/// A Paragraph holds all text, attributes and insets in a text paragraph
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
+ /// 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();
- /// this constructor inserts the new paragraph in a list
- explicit
- Paragraph(Paragraph * par);
+
+ ///
+ 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);
+ 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);
-
+ std::string const asString(Buffer const &, bool label) const;
///
- void writeFile(Buffer const *, std::ostream &, BufferParams const &,
- depth_type) 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;
///
- int id() const;
- ///
- void id(int id_arg);
- ///
- void read();
-
+ void write(Buffer const &, std::ostream &, BufferParams const &,
+ depth_type & depth) const;
///
- Paragraph * TeXOnePar(Buffer const *, BufferParams const &,
- std::ostream &, TexRow & texrow,
- bool moving_arg);
+ void validate(LaTeXFeatures &) const;
///
- int startTeXParParams(BufferParams const &, std::ostream &) const;
+ int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
///
- int endTeXParParams(BufferParams const &, std::ostream &) const;
+ int endTeXParParams(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 &);
///
- Paragraph * TeXEnvironment(Buffer const *, BufferParams const &,
- std::ostream &, TexRow & texrow);
- ///
- 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);
+ void simpleDocBookOnePar(Buffer const & buf,
+ std::ostream &,
+ LyXFont const & outerfont,
+ OutputParams const & runparams,
+ lyx::depth_type depth,
+ bool labelid) 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;
+ 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(); }
///
- void setContentsFromPar(Paragraph * par);
+ bool empty() const { return text_.empty(); }
+ ///
+ void setContentsFromPar(Paragraph const & par);
///
void clearContents();
///
- string const & layout() const;
+ LyXLayout_ptr const & layout() const;
///
- void layout(string const & new_layout);
+ void layout(LyXLayout_ptr const & new_layout);
- ///
- void setCounter(int i, int v);
- ///
- int getCounter(int i) const;
- ///
- void incCounter(int i);
+ /// This is the item depth, only used by enumerate and itemize
+ signed char itemdepth;
///
- char enumdepth;
+ InsetBibitem * bibitem() const; // ale970302
- ///
- char itemdepth;
+ /// initialise tracking for this par
+ void trackChanges(Change::Type = Change::UNCHANGED);
- ///
- InsetBibKey * bibkey; // ale970302
+ /// stop tracking
+ void untrackChanges();
- ///
- void next(Paragraph *);
- /** these function are able to hide closed footnotes
- */
- Paragraph * next();
- ///
- Paragraph const * next() const;
+ /// set entire paragraph to new text for change tracking
+ void cleanChanges();
- ///
- void previous(Paragraph *);
- ///
- Paragraph * previous();
- ///
- Paragraph const * previous() const;
+ /// look up change type at given pos
+ Change::Type lookupChange(lyx::pos_type pos) const;
+
+ /// look up change at given pos
+ Change const lookupChangeFull(lyx::pos_type pos) const;
+
+ /// is there a change within the given range ?
+ bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
+
+ /// is there a non-addition in this range ?
+ bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
+
+ /// set change at pos
+ void setChange(lyx::pos_type pos, Change::Type type);
+
+ /// accept change
+ void acceptChange(lyx::pos_type start, lyx::pos_type end);
+
+ /// reject change
+ void rejectChange(lyx::pos_type start, lyx::pos_type end);
+
+ /// mark whole par as erased
+ void markErased();
+
+ /// 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();
- /// 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;
+ 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
depth_type getDepth() const;
/// The maximal possible depth of a paragraph after this one
- depth_type getMaxDepthAfter(Buffer const *) const;
+ depth_type getMaxDepthAfter() const;
///
- void applyLayout(string const & new_layout);
- ///
- int getFirstCounter(int i) const;
- ///
- void erase(lyx::pos_type pos);
- /** the flag determines wether the layout should be copied
- */
- void breakParagraph(BufferParams const &, lyx::pos_type pos, int flag);
- ///
- void breakParagraphConservative(BufferParams const &, lyx::pos_type pos);
- /** Get unistantiated font setting. Returns the difference
+ 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);
+
+ /** Get uninstantiated font setting. Returns the difference
between the characters font and the layoutfont.
This is what is stored in the fonttable
*/
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);
///
- void insertChar(lyx::pos_type pos, value_type c, LyXFont const &);
+ void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED));
///
bool checkInsertChar(LyXFont &);
///
- void insertInset(lyx::pos_type pos, Inset * inset);
- ///
- void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &);
+ void insertInset(lyx::pos_type pos, InsetOld * inset);
///
- bool insetAllowed(Inset::Code code);
+ void insertInset(lyx::pos_type pos, InsetOld * inset, LyXFont const &, Change change = Change(Change::INSERTED));
///
- Inset * getInset(lyx::pos_type pos);
+ bool insetAllowed(InsetOld_code code);
///
- 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;
+ InsetOld * getInset(lyx::pos_type pos);
///
- 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;
- /** paste this paragraph with the next one
- be carefull, this doesent make any check at all
- */
- void pasteParagraph(BufferParams const &);
-
/// returns -1 if inset not found
- int getPositionOfInset(Inset const * inset) const;
-
- /// some good comment here John?
- Paragraph * getParFromID(int id) const;
+ int getPositionOfInset(InsetOld const * inset) const;
///
- int stripLeadingSpaces(lyx::textclass_type tclass);
+ int stripLeadingSpaces();
-#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);
- ///
- void unsetPExtraType(BufferParams const &);
-#endif
- ///
- bool sgmlConvertChar(char c, string & sgml_string);
- ///
+ /// return true if we allow multiple spaces
bool isFreeSpacing() const;
- ParagraphParameters & params();
- ParagraphParameters const & params() const;
-private:
+ /// return true if we allow this par to stay empty
+ bool allowEmpty() const;
+ ////
+ unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
///
- string layout_;
+ ParagraphParameters & params();
///
- struct InsetTable {
- ///
- lyx::pos_type pos;
- ///
- Inset * inset;
- ///
- InsetTable(lyx::pos_type p, Inset * i) : pos(p), inset(i) {}
- };
+ ParagraphParameters const & params() const;
///
- typedef std::vector<InsetTable> InsetList;
+ RowList::iterator getRow(lyx::pos_type pos);
+
///
InsetList insetlist;
-public:
- ///
- class inset_iterator {
- public:
- ///
- inset_iterator() {}
- //
- inset_iterator(InsetList::iterator const & iter);
- ///
- inset_iterator & operator++() {
- ++it;
- return *this;
- }
- ///
- Inset * operator*() { return it->inset; }
- ///
- Inset * operator->() { return it->inset; }
-
- ///
- lyx::pos_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(lyx::pos_type pos);
+ 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:
- /// if anything uses this we don't want it to.
- Paragraph(Paragraph const &);
- ///
- 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
+ int begin_of_body_;
struct Pimpl;
///
friend struct Paragraph::Pimpl;
///
Pimpl * pimpl_;
+
};
-#endif
+
+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;
+}
+
+#endif // PARAGRAPH_H
projects / lyx.git / blobdiff