X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fbuffer.h;h=880cff61b3d91dbbeb4706985e469e5747b8782e;hb=98c966c64594611e469313314abd1e59524adb4a;hp=4e1eeee2ea97a0f0251331d984b06a2ea8b72303;hpb=63de5b908f640f7e454be7d4dc34f0961c081f24;p=lyx.git diff --git a/src/buffer.h b/src/buffer.h index 4e1eeee2ea..880cff61b3 100644 --- a/src/buffer.h +++ b/src/buffer.h @@ -1,23 +1,14 @@ // -*- C++ -*- /* This file is part of - * ====================================================== - * - * LyX, The Document Processor + * ====================================================== + * + * LyX, The Document Processor * Copyright 1995 Matthias Ettrich * * This file is Copyleft 1996 * Lars Gullik Bjønnes * * ====================================================== */ - -// Change Log: -// =========== -// 23/03/98 Heinrich Bauer (heinrich.bauer@t-mobil.de) -// Spots marked "changed Heinrich Bauer, 23/03/98" modified due to the -// following bug: dvi file export did not work after printing (or previewing) -// and vice versa as long as the same file was concerned. This happened -// every time the LyX-file was left unchanged between the two actions mentioned -// above. #ifndef BUFFER_H #define BUFFER_H @@ -27,17 +18,24 @@ #endif #include "LString.h" - -#include "BufferView.h" +#include "undo.h" +#include "undostack.h" #include "lyxvc.h" #include "bufferparams.h" #include "texrow.h" +#include "paragraph.h" - +class BufferView; class LyXRC; class TeXErrors; class LaTeXFeatures; class Language; +class ParIterator; + +// When lyx 1.3.x starts we should enable this +// btw. we should also test this with 1.2 so that we +// do not get any surprises. (Lgb) +//#define NO_COMPABILITY 1 /// struct DEPCLEAN { @@ -50,7 +48,7 @@ struct DEPCLEAN { }; /** The buffer object. - The is is the buffer object. It contains all the informations about + This is the buffer object. It contains all the informations about a document loaded into LyX. I am not sure if the class is complete or minimal, probably not. \author Lars Gullik Bjønnes @@ -68,29 +66,19 @@ public: \param b optional \c false by default */ explicit Buffer(string const & file, bool b = false); - - /// Destrucotr - ~Buffer(); - /** Save the buffer's parameters as user default. - This function saves a file \c user_lyxdir/templates/defaults.lyx - which parameters are those of the current buffer. This file - is used as a default template when creating a new - file. Returns \c true on success. - */ - bool saveParamsAsDefaults(); + /// Destructor + ~Buffer(); /** High-level interface to buffer functionality. This function parses a command string and executes it */ - bool Dispatch(string const & command); + bool dispatch(string const & command); /// Maybe we know the function already by number... - bool Dispatch(int ac, string const & argument); + bool dispatch(int ac, string const & argument); - /// Should be changed to work for a list. - void resize(); - /// + /// void resizeInsets(BufferView *); /// Update window titles of all users. @@ -109,55 +97,61 @@ public: Since we only can have one at the moment, we just reset it. */ void delUser(BufferView *); - + /// void redraw(); /// Load the autosaved file. void loadAutoSaveFile(); - - /** Reads a file. + + /** Reads a file. \param par if != 0 insert the file. \return \c false if method fails. */ - bool readFile(LyXLex &, LyXParagraph * par = 0); - + bool readFile(LyXLex &, Paragraph * par = 0); + /** Reads a file without header. \param par if != 0 insert the file. \return \c false if file is not completely read. */ - bool readLyXformat2(LyXLex &, LyXParagraph * par = 0); + bool readLyXformat2(LyXLex &, Paragraph * par = 0); /// This parses a single LyXformat-Token. - bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par, - LyXParagraph *& return_par, + bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par, + Paragraph *& return_par, string const & token, int & pos, - char & depth, LyXFont & -#ifndef NEW_INSETS - ,LyXParagraph::footnote_flag &, - LyXParagraph::footnote_kind & + Paragraph::depth_type & depth, + LyXFont &); + /// + void insertStringAsLines(Paragraph *&, lyx::pos_type &, + LyXFont const &, string const &) const; +#ifndef NO_COMPABILITY + /// + void insertErtContents(Paragraph * par, int & pos, + bool set_inactive = true); #endif - ); + /// + Paragraph * getParFromID(int id) const; private: /// Parse a single inset. - void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &); + void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &); public: /** Save file. Takes care of auto-save files and backup file if requested. Returns \c true if the save is successful, \c false otherwise. */ bool save() const; - + /// Write file. Returns \c false if unsuccesful. bool writeFile(string const &, bool) const; - + /// void writeFileAscii(string const & , int); /// void writeFileAscii(std::ostream &, int); /// - string const asciiParagraph(LyXParagraph const *, - unsigned int linelen) const; + string const asciiParagraph(Paragraph const *, unsigned int linelen, + bool noparbreak = false) const; /// void makeLaTeXFile(string const & filename, string const & original_path, @@ -165,44 +159,52 @@ public: /** LaTeX all paragraphs from par to endpar. \param \a endpar if == 0 then to the end */ - void latexParagraphs(std::ostream & os, LyXParagraph * par, - LyXParagraph * endpar, TexRow & texrow) const; - - /// - void SimpleDocBookOnePar(std::ostream &, string & extra, - LyXParagraph * par, int & desc_on, - int depth) const ; - + void latexParagraphs(std::ostream & os, Paragraph * par, + Paragraph * endpar, TexRow & texrow) const; /// - int runChktex(); - + void simpleDocBookOnePar(std::ostream &, + Paragraph * par, int & desc_on, + Paragraph::depth_type depth) const ; + /// + void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par, + Paragraph::depth_type depth); /// void makeLinuxDocFile(string const & filename, bool nice, bool only_body = false); /// void makeDocBookFile(string const & filename, bool nice, bool only_body = false); + /// Open SGML/XML tag. + void sgmlOpenTag(std::ostream & os, Paragraph::depth_type depth, + string const & latexname) const; + /// Closes SGML/XML tag. + void sgmlCloseTag(std::ostream & os, Paragraph::depth_type depth, + string const & latexname) const; + /// + void sgmlError(Paragraph * par, int pos, string const & message) const; /// returns the main language for the buffer (document) - Language const * GetLanguage() const; + Language const * getLanguage() const; + /// + int runChktex(); /// bool isLyxClean() const; /// bool isBakClean() const; /// bool isDepClean(string const & name) const; - + /// void markLyxClean() const; /// void markBakClean(); - + /// void markDepClean(string const & name); - + /// - void setUnnamed(bool flag=true); + void setUnnamed(bool flag = true); /// bool isUnnamed(); @@ -210,9 +212,13 @@ public: /// Mark this buffer as dirty. void markDirty(); - /// Returns the buffers filename. + /// Returns the buffer's filename. It is always an absolute path. string const & fileName() const; + /// Returns the the path where the buffer lives. + /// It is always an absolute path. + string const & filePath() const; + /** A transformed version of the file name, adequate for LaTeX. \param no_path optional if \c true then the path is stripped. */ @@ -220,7 +226,7 @@ public: /// Get the name and type of the log. std::pair const getLogName() const; - + /// Change name of buffer. Updates "read-only" flag. void setFileName(string const & newfile); @@ -242,11 +248,8 @@ public: /** returns \c true if the buffer contains either a LinuxDoc or DocBook document */ bool isSGML() const; - /// returns \c true if the buffer contains a Wed document - bool isLiterate() const; - - /// - void setPaperStuff(); + /// returns \c true if the buffer contains a Wed document + bool isLiterate() const; /** Validate a buffer for LaTeX. This validates the buffer, and returns a struct for use by @@ -265,15 +268,21 @@ public: std::vector > const getBibkeyList(); /// struct TocItem { + TocItem(Paragraph * p, int d, string const & s) + : par(p), depth(d), str(s) {} /// - LyXParagraph * par; + Paragraph * par; /// int depth; /// string str; }; /// - std::map > const getTocList() const; + typedef std::vector SingleList; + /// + typedef std::map Lists; + /// + Lists const getLists() const; /// std::vector const getLabelList(); @@ -282,24 +291,24 @@ public: BufferView * getUser() const; /// - void ChangeLanguage(Language const * from, Language const * to); + void changeLanguage(Language const * from, Language const * to); /// bool isMultiLingual(); /// Does this mean that this is buffer local? - UndoStack undostack; - - /// Does this mean that this is buffer local? - UndoStack redostack; - + UndoStack undostack; + + /// Does this mean that this is buffer local? + UndoStack redostack; + /// BufferParams params; - + /** The list of paragraphs. This is a linked list of paragraph, this list holds the whole contents of the document. */ - LyXParagraph * paragraph; + Paragraph * paragraph; /// LyX version control object. LyXVC lyxvc; @@ -307,9 +316,6 @@ public: /// Where to put temporary files. string tmppath; - /// The path to the document file. - string filepath; - /** If we are writing a nice LaTeX file or not. While writing as LaTeX, tells whether we are doing a 'nice' LaTeX file */ @@ -318,47 +324,12 @@ public: /// Used when typesetting to place errorboxes. TexRow texrow; private: -#ifndef NEW_INSETS - /// - void linuxDocHandleFootnote(std::ostream & os, - LyXParagraph * & par, int depth); -#endif - /// - void DocBookHandleCaption(std::ostream & os, string & inner_tag, - int depth, int desc_on, - LyXParagraph * & par); -#ifndef NEW_INSETS - /// - void DocBookHandleFootnote(std::ostream & os, - LyXParagraph * & par, int depth); -#endif - /// - void sgmlOpenTag(std::ostream & os, int depth, - string const & latexname) const; - /// - void sgmlCloseTag(std::ostream & os, int depth, - string const & latexname) const; - /// - void LinuxDocError(LyXParagraph * par, int pos, - string const & message); - /// - void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par, - int desc_on, int depth); - - /// LinuxDoc. - void push_tag(std::ostream & os, string const & tag, - int & pos, char stack[5][3]); - - /// LinuxDoc. - void pop_tag(std::ostream & os, string const & tag, - int & pos, char stack[5][3]); - /// is save needed mutable bool lyx_clean; - + /// is autosave needed mutable bool bak_clean; - + /// is this a unnamed file (New...) bool unnamed; @@ -369,7 +340,10 @@ private: bool read_only; /// name of the file the buffer is associated with. - string filename; + string filename_; + + /// The path to the document file. + string filepath_; /// Format number of buffer int file_format; @@ -391,28 +365,23 @@ public: typedef ptrdiff_t difference_type; typedef Inset * pointer; typedef Inset & reference; - - + + /// inset_iterator() : par(0) /*, it(0)*/ {} // - inset_iterator(LyXParagraph * paragraph) : par(paragraph) { - SetParagraph(); + inset_iterator(Paragraph * paragraph) : par(paragraph) { + setParagraph(); } /// - inset_iterator(LyXParagraph * paragraph, - LyXParagraph::size_type pos); + inset_iterator(Paragraph * paragraph, lyx::pos_type pos); /// inset_iterator & operator++() { // prefix ++ if (par) { ++it; if (it == par->inset_iterator_end()) { -#ifndef NEW_INSETS - par = par->next_; -#else par = par->next(); -#endif - SetParagraph(); + setParagraph(); } } return *this; @@ -423,34 +392,30 @@ public: if (par) { ++it; if (it == par->inset_iterator_end()) { -#ifndef NEW_INSETS - par = par->next_; -#else par = par->next(); -#endif - SetParagraph(); + setParagraph(); } } return tmp; } /// Inset * operator*() { return *it; } - + /// - LyXParagraph * getPar() { return par; } + Paragraph * getPar() { return par; } /// - LyXParagraph::size_type getPos() const { return it.getPos(); } + lyx::pos_type getPos() const { return it.getPos(); } /// friend bool operator==(inset_iterator const & iter1, inset_iterator const & iter2); private: /// - void SetParagraph(); + void setParagraph(); /// - LyXParagraph * par; + Paragraph * par; /// - LyXParagraph::inset_iterator it; + Paragraph::inset_iterator it; }; /// @@ -461,6 +426,22 @@ public: inset_iterator inset_iterator_end() { return inset_iterator(); } + /// + inset_iterator inset_const_iterator_begin() const { + return inset_iterator(paragraph); + } + /// + inset_iterator inset_const_iterator_end() const { + return inset_iterator(); + } + + /// + ParIterator par_iterator_begin(); + /// + ParIterator par_iterator_end(); + + /// + Inset * getInsetFromID(int id_arg) const; }; @@ -476,29 +457,21 @@ void Buffer::delUser(BufferView *) { users = 0; } - - -inline -void Buffer::redraw() -{ - users->redraw(); - users->fitCursor(users->text); -} inline -Language const * Buffer::GetLanguage() const +Language const * Buffer::getLanguage() const { return params.language; } - + inline bool Buffer::isLyxClean() const { return lyx_clean; } - + inline bool Buffer::isBakClean() const @@ -509,13 +482,13 @@ bool Buffer::isBakClean() const inline void Buffer::markLyxClean() const -{ +{ if (!lyx_clean) { - lyx_clean = true; + lyx_clean = true; updateTitles(); } // if the .lyx file has been saved, we don't need an - // autosave + // autosave bak_clean = true; } @@ -560,7 +533,14 @@ void Buffer::markDirty() inline string const & Buffer::fileName() const { - return filename; + return filename_; +} + + +inline +string const & Buffer::filePath() const +{ + return filepath_; } @@ -578,16 +558,17 @@ BufferView * Buffer::getUser() const } -inline +inline void Buffer::setParentName(string const & name) { - params.parentname = name; + params.parentname = name; } /// inline -bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) { +bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) +{ return a.par == b.par && a.str == b.str; // No need to compare depth. } @@ -595,24 +576,29 @@ bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) { /// inline -bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) { +bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) +{ return !(a == b); // No need to compare depth. } + /// inline bool operator==(Buffer::inset_iterator const & iter1, - Buffer::inset_iterator const & iter2) { + Buffer::inset_iterator const & iter2) +{ return iter1.par == iter2.par && (iter1.par == 0 || iter1.it == iter2.it); } + /// inline bool operator!=(Buffer::inset_iterator const & iter1, - Buffer::inset_iterator const & iter2) { + Buffer::inset_iterator const & iter2) +{ return !(iter1 == iter2); } -#endif +#endif