X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fparagraph.h;h=5c9ba843c3858caae9f60fad1929e90adcdea7cd;hb=fe390e9da1538e20eabbc98977d845295f8e563d;hp=b6666b6043e3f46465808317c8d04d39d202d75f;hpb=85a5ea7bfc80e179a61a99f2955455e84d3384cc;p=lyx.git diff --git a/src/paragraph.h b/src/paragraph.h index b6666b6043..5c9ba843c3 100644 --- a/src/paragraph.h +++ b/src/paragraph.h @@ -1,100 +1,62 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 The LyX Team. - * - * ====================================================== */ +/** + * \file paragraph.h + * Copyright 1995 Matthias Ettrich + * Copyright 2002 the LyX Team + * Read the file COPYING + */ #ifndef PARAGRAPH_H #define PARAGRAPH_H -#ifdef __GNUG__ -#pragma interface -#endif +#include "lyxlayout_ptr_fwd.h" +#include "lyxfont.h" // Just for LyXFont::FONT_SIZE +#include "InsetList.h" -#include "LString.h" +#include "insets/inset.h" // Just for Inset::Code -#include +#include "support/types.h" +#include "changes.h" -#include "insets/inset.h" -#include "layout.h" +#include "LString.h" -class ParagraphParameters; +class Buffer; class BufferParams; -class TexRow; -struct LaTeXFeatures; -class InsetBibKey; class BufferView; +class Counters; +class InsetBibitem; 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 LatexRunParams; +class ParagraphParameters; +class TexRow; +class ParagraphList; +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 + /// The same as ParameterStruct::depth_type typedef unsigned int depth_type; - /// - typedef std::vector 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 &); + /// + void operator=(Paragraph const &); /// the destructor removes the new paragraph from the list ~Paragraph(); @@ -107,141 +69,143 @@ public: Language const * from, Language const * to); /// bool isMultiLingual(BufferParams const &); - /// - string const asString(Buffer const *, bool label); /// - string const asString(Buffer const *, size_type beg, size_type end); - + string const asString(Buffer const *, bool label) const; /// - void writeFile(Buffer const *, std::ostream &, BufferParams const &, - depth_type) const; + string const asString(Buffer const *, lyx::pos_type beg, lyx::pos_type end, + bool label) const; + /// - void validate(LaTeXFeatures &) 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); + /// - void id(int id_arg); - /// - void read(); + int startTeXParParams(BufferParams const &, std::ostream &, bool) const; /// - Paragraph * TeXOnePar(Buffer const *, BufferParams const &, - std::ostream &, TexRow & texrow, - bool moving_arg); + int endTeXParParams(BufferParams const &, std::ostream &, bool) const; + + /// bool simpleTeXOnePar(Buffer const *, BufferParams const &, - std::ostream &, TexRow & texrow, bool moving_arg); + LyXFont const & outerfont, std::ostream &, + TexRow & texrow, LatexRunParams const &); /// - Paragraph * TeXEnvironment(Buffer const *, BufferParams const &, - std::ostream &, TexRow & texrow); - /// - bool hasSameLayout(Paragraph const * par) const; - - /// - void makeSameLayout(Paragraph const * par); + bool hasSameLayout(Paragraph const & par) const; - /// Is it the first par with same depth and layout? - bool isFirstInSequence() const; + /// + void makeSameLayout(Paragraph const & par); - /** Check if the current paragraph is the last paragraph in a - proof environment */ - int getEndLabel(BufferParams const &) const; /// - Inset * InInset(); + UpdatableInset * inInset() const; /// - void setInsetOwner(Inset * i); + void setInsetOwner(UpdatableInset * inset); /// void deleteInsetsLyXText(BufferView *); /// void resizeInsetsLyXText(BufferView *); /// - size_type size() const; + lyx::pos_type size() const; /// - void setContentsFromPar(Paragraph * par); + bool empty() const; /// - void clearContents(); - + void setContentsFromPar(Paragraph const & par); /// - LyXTextClass::LayoutList::size_type layout; + void clearContents(); /// - void setCounter(int i, int v); - /// - int getCounter(int i) const; + LyXLayout_ptr const & layout() const; /// - void incCounter(int i); + void layout(LyXLayout_ptr const & new_layout); /// char enumdepth; - + /// char itemdepth; - /// - InsetBibKey * bibkey; // ale970302 - /// - 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; + /// 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; + + /// 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 beginningOfBody() const; - /// 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; - + /// the next two functions are for the manual labels string const getLabelWidthString() const; /// void setLabelWidthString(string const & s); /// - inline - LyXTextClass::LayoutList::size_type getLayout() const; - /// 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); + + /// 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 */ LyXFont const - getFontSettings(BufferParams const &, size_type pos) const; + getFontSettings(BufferParams const &, lyx::pos_type pos) const; /// LyXFont const getFirstFontSettings() const; @@ -249,159 +213,114 @@ public: 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; + 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; /// - value_type getChar(size_type pos) const; + value_type getChar(lyx::pos_type pos) const; /// - value_type getUChar(BufferParams const &, size_type pos) const; + value_type getUChar(BufferParams const &, lyx::pos_type pos) const; /// The position must already exist. - void setChar(size_type pos, value_type c); - /// - void setFont(size_type pos, LyXFont const & font); - /// - string const getWord(size_type &) const; + void setChar(lyx::pos_type pos, value_type c); + /// 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(size_type startpos, - size_type endpos) const; + 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); /// - void insertChar(size_type pos, value_type c); + void insertChar(lyx::pos_type pos, value_type c, LyXFont const &, Change change = Change(Change::INSERTED)); /// - void insertChar(size_type pos, value_type c, LyXFont const &); + bool checkInsertChar(LyXFont &); /// - void insertInset(size_type pos, Inset * inset); + void insertInset(lyx::pos_type pos, Inset * inset); /// - void insertInset(size_type pos, Inset * inset, LyXFont const &); + void insertInset(lyx::pos_type pos, Inset * inset, LyXFont const &, Change change = Change(Change::INSERTED)); /// - bool insertInsetAllowed(Inset * inset); + bool insetAllowed(Inset::Code code); /// - Inset * getInset(size_type pos); + Inset * getInset(lyx::pos_type pos); /// - Inset const * getInset(size_type pos) const; + 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 &, size_type pos) const; + void copyIntoMinibuffer(Buffer const &, lyx::pos_type pos) const; /// - void cutIntoMinibuffer(BufferParams const &, size_type pos); + void cutIntoMinibuffer(BufferParams const &, lyx::pos_type pos); /// - bool insertFromMinibuffer(size_type pos); + bool insertFromMinibuffer(lyx::pos_type pos); /// - bool isHfill(size_type pos) const; + bool isHfill(lyx::pos_type pos) const; /// - bool isInset(size_type pos) const; + bool isInset(lyx::pos_type pos) const; /// - bool isNewline(size_type pos) const; + bool isNewline(lyx::pos_type pos) const; /// - bool isSeparator(size_type pos) const; + bool isSeparator(lyx::pos_type pos) const; /// - bool isLineSeparator(size_type pos) const; + bool isLineSeparator(lyx::pos_type pos) const; /// - bool isKomma(size_type pos) const; + bool isKomma(lyx::pos_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 isLetter(lyx::pos_type pos) const; + /// + bool isWord(lyx::pos_type pos) const; /// returns -1 if inset not found - int getPositionOfInset(Inset * inset) const; + int getPositionOfInset(Inset const * inset) const; /// - int stripLeadingSpaces(LyXTextClassList::size_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 linuxDocConvertChar(char c, string & sgml_string); + /// return true if we allow multiple spaces + bool isFreeSpacing() const; - ParagraphParameters & params(); - ParagraphParameters const & params() const; -private: - - /// - struct InsetTable { - /// - size_type pos; - /// - Inset * inset; - /// - InsetTable(size_type p, Inset * i) : pos(p), inset(i) {} - }; + /// return true if we allow this par to stay empty + bool allowEmpty() const; /// - typedef std::vector InsetList; - /// - 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; } - /// - 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; - }; - /// - inset_iterator inset_iterator_begin(); + ParagraphParameters & params(); /// - inset_iterator inset_iterator_end(); + ParagraphParameters const & params() const; /// - inset_iterator InsetIterator(size_type pos); + InsetList insetlist; private: /// - Paragraph * next_; - /// - Paragraph * previous_; + LyXLayout_ptr layout_; 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; +} + + +bool operator==(Paragraph const & lhs, Paragraph const & rhs); + +#endif // PARAGRAPH_H