X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fbuffer.h;h=ba3ec7c40c752569b620f5aad9b9cc11a6bd8aa4;hb=9ee46b846e5e84ad40ceda4f4af94aeb86cd90a2;hp=e03e9015fb1622ce2b443baf586657507403bcf5;hpb=63e1ebc3127c87e02c9a2060e5c7adceda1f44c2;p=lyx.git diff --git a/src/buffer.h b/src/buffer.h index e03e9015fb..ba3ec7c40c 100644 --- a/src/buffer.h +++ b/src/buffer.h @@ -1,45 +1,66 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== +/** + * \file buffer.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor - * Copyright 1995 Matthias Ettrich + * \author Lars Gullik Bjønnes * - * This file is Copyleft 1996 - * Lars Gullik Bjønnes - * - * ====================================================== */ + * Full author contact details are available in file CREDITS. + */ #ifndef BUFFER_H #define BUFFER_H -#include "LString.h" -#include "undo.h" +#include "InsetList.h" + +#include "dociterator.h" + #include "support/limited_stack.h" +#include "support/types.h" -#include "lyxvc.h" -#include "bufferparams.h" -#include "texrow.h" -#include "ParagraphList.h" -#include "paragraph.h" -#include "author.h" +#include +#include -#include +#include +#include +#include +#include -class BufferView; + +class BufferParams; +class ErrorItem; +class FuncRequest; +class InsetBase; +class InsetText; +class LyXFont; +class LyXLex; class LyXRC; -class TeXErrors; +class LyXText; +class LyXVC; class LaTeXFeatures; class Language; -class ParIterator; +class MacroData; +class OutputParams; +class ParagraphList; class ParConstIterator; +class ParIterator; +class TeXErrors; +class TexRow; +class Undo; +class StableDocIterator; /** The buffer object. - 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 + * This is the buffer object. It contains all the informations about + * a document loaded into LyX. + * The buffer object owns the LyXText (wrapped in an InsetText), which + * contains the individual paragraphs of the document. + * + * + * I am not sure if the class is complete or + * minimal, probably not. + * \author Lars Gullik Bjønnes */ class Buffer { public: @@ -53,7 +74,7 @@ public: \param file \param b optional \c false by default */ - explicit Buffer(string const & file, bool b = false); + explicit Buffer(std::string const & file, bool b = false); /// Destructor ~Buffer(); @@ -61,64 +82,51 @@ public: /** High-level interface to buffer functionality. This function parses a command string and executes it */ - bool dispatch(string const & command, bool * result = 0); + bool dispatch(std::string const & command, bool * result = 0); /// Maybe we know the function already by number... - bool dispatch(int ac, string const & argument, bool * result = 0); - - /// - void resizeInsets(BufferView *); - - /// Update window titles of all users. - void updateTitles() const; - - /// Reset autosave timers for all users. - void resetAutosaveTimers() const; - - /** Adds the BufferView to the users list. - Later this func will insert the \c BufferView into a real list, - not just setting a pointer. - */ - void addUser(BufferView * u); - - /** Removes the #BufferView# from the users list. - Since we only can have one at the moment, we just reset it. - */ - void delUser(BufferView *); - - /// - void redraw(); + bool dispatch(FuncRequest const & func, bool * result = 0); /// Load the autosaved file. void loadAutoSaveFile(); - /** Reads a file. - \param par if != 0 insert the file. - \return \c false if method fails. - */ - bool readFile(LyXLex &, string const &, Paragraph * par = 0); + /// load a new file + bool readFile(std::string const & filename); + + /// read the header, returns number of unknown tokens + int readHeader(LyXLex & lex); /** Reads a file without header. \param par if != 0 insert the file. \return \c false if file is not completely read. */ - bool readLyXformat2(LyXLex &, Paragraph * par = 0); - - /// This parses a single LyXformat-Token. - bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par, - Paragraph *& return_par, - string const & token, int & pos, - Paragraph::depth_type & depth, - LyXFont &); + bool readDocument(LyXLex &); + /// - void insertStringAsLines(Paragraph *&, lyx::pos_type &, - LyXFont const &, string const &) const; + void insertStringAsLines(ParagraphList & plist, + lyx::pit_type &, lyx::pos_type &, + LyXFont const &, std::string const &, bool); /// - Paragraph * getParFromID(int id) const; -private: - /// Parse a single inset. - void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &); -public: + ParIterator getParFromID(int id) const; + /// do we have a paragraph with this id? + bool hasParWithID(int id) const; + + /// This signal is emitted when a parsing error shows up. + boost::signal error; + /// This signal is emitted when some message shows up. + boost::signal message; + /// This signal is emitted when the buffer busy status change. + boost::signal busy; + /// This signal is emitted when the buffer readonly status change. + boost::signal readonly; + /// Update window titles of all users. + boost::signal updateTitles; + /// Reset autosave timers for all users. + boost::signal resetAutosaveTimers; + /// This signal is emitting if the buffer is being closed. + boost::signal closing; + + /** Save file. Takes care of auto-save files and backup file if requested. Returns \c true if the save is successful, \c false otherwise. @@ -126,52 +134,37 @@ public: bool save() const; /// Write file. Returns \c false if unsuccesful. - bool writeFile(string const &) const; + bool writeFile(std::string const &) const; /// - void writeFileAscii(string const & , int); - /// - void writeFileAscii(std::ostream &, int); + void writeFileAscii(std::string const &, OutputParams const &); /// - string const asciiParagraph(Paragraph const &, unsigned int linelen, - bool noparbreak = false) const; + void writeFileAscii(std::ostream &, OutputParams const &); /// Just a wrapper for the method below, first creating the ofstream. - void makeLaTeXFile(string const & filename, - string const & original_path, - bool nice, - bool only_body = false, - bool only_preamble = false); + void makeLaTeXFile(std::string const & filename, + std::string const & original_path, + OutputParams const &, + bool output_preamble = true, + bool output_body = true); /// void makeLaTeXFile(std::ostream & os, - string const & original_path, - bool nice, - bool only_body = false, - bool only_preamble = false); - /** LaTeX all paragraphs from par to endpar. - \param \a endpar if == 0 then to the end - */ - void latexParagraphs(std::ostream & os, - ParagraphList::iterator par, - ParagraphList::iterator endpar, - TexRow & texrow, bool moving_arg = false) const; - /// - 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); - /// - void sgmlError(Paragraph * par, int pos, string const & message) const; - + std::string const & original_path, + OutputParams const &, + bool output_preamble = true, + bool output_body = true); + /// + void makeLinuxDocFile(std::string const & filename, + OutputParams const & runparams_in, + bool only_body = false); + /// + void makeDocBookFile(std::string const & filename, + OutputParams const & runparams_in, + bool only_body = false); /// returns the main language for the buffer (document) Language const * getLanguage() const; + /// get l10n translated to the buffers language + std::string const B_(std::string const & l10n) const; + /// int runChktex(); /// return true if the main lyx file does not need saving @@ -179,7 +172,7 @@ public: /// bool isBakClean() const; /// - bool isDepClean(string const & name) const; + bool isDepClean(std::string const & name) const; /// mark the main lyx file as not needing saving void markClean() const; @@ -188,37 +181,42 @@ public: void markBakClean(); /// - void markDepClean(string const & name); + void markDepClean(std::string const & name); /// void setUnnamed(bool flag = true); /// - bool isUnnamed(); + bool isUnnamed() const; /// Mark this buffer as dirty. void markDirty(); /// Returns the buffer's filename. It is always an absolute path. - string const & fileName() const; + std::string const & fileName() const; /// Returns the the path where the buffer lives. /// It is always an absolute path. - string const & filePath() const; + std::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. */ - string const getLatexName(bool no_path = true) const; + std::string const getLatexName(bool no_path = true) const; /// Get the name and type of the log. - std::pair const getLogName() const; + std::pair const getLogName() const; /// Change name of buffer. Updates "read-only" flag. - void setFileName(string const & newfile); + void setFileName(std::string const & newfile); /// Name of the document's parent - void setParentName(string const &); + void setParentName(std::string const &); + + /** Get the document's master (or \c this if this is not a + child document) + */ + Buffer const * getMasterBuffer() const; /// Is buffer read-only? bool isReadonly() const; @@ -250,170 +248,110 @@ public: void validate(LaTeXFeatures &) const; /// return all bibkeys from buffer and its childs - void fillWithBibKeys(std::vector > & keys) const; + void fillWithBibKeys(std::vector > & keys) const; /// - std::vector const getLabelList() const; - - /** This will clearly have to change later. Later we can have more - than one user per buffer. */ - BufferView * getUser() const; + void getLabelList(std::vector &) const; /// void changeLanguage(Language const * from, Language const * to); + /// - bool isMultiLingual(); + void updateDocLang(Language const * nlang); + + /// + bool isMultiLingual() const; /// Does this mean that this is buffer local? - limited_stack > undostack; + limited_stack & undostack(); + limited_stack const & undostack() const; /// Does this mean that this is buffer local? - limited_stack > redostack; + limited_stack & redostack(); + limited_stack const & redostack() const; /// - BufferParams params; + BufferParams & params(); + BufferParams const & params() const; /** The list of paragraphs. This is a linked list of paragraph, this list holds the whole contents of the document. */ - ParagraphList paragraphs; + ParagraphList & paragraphs(); + ParagraphList const & paragraphs() const; /// LyX version control object. - LyXVC lyxvc; + LyXVC & lyxvc(); + LyXVC const & lyxvc() const; /// Where to put temporary files. - string tmppath; - - /** If we are writing a nice LaTeX file or not. - While writing as LaTeX, tells whether we are - doing a 'nice' LaTeX file */ - bool niceFile; + std::string const & temppath() const; /// Used when typesetting to place errorboxes. - TexRow texrow; - - /// the author list for the document - AuthorList & authors(); - -private: - typedef std::map DepClean; - - /// need to regenerate .tex ? - DepClean dep_clean_; - - /// the author list - AuthorList authorlist; + TexRow & texrow(); + TexRow const & texrow() const; - /// is save needed - mutable bool lyx_clean; - - /// is autosave needed - mutable bool bak_clean; - - /// is this a unnamed file (New...) - bool unnamed; - - /// buffer is r/o - bool read_only; - - /// name of the file the buffer is associated with. - string filename_; + /// + ParIterator par_iterator_begin(); + /// + ParConstIterator par_iterator_begin() const; + /// + ParIterator par_iterator_end(); + /// + ParConstIterator par_iterator_end() const; - /// The path to the document file. - string filepath_; + /** \returns true only when the file is fully loaded. + * Used to prevent the premature generation of previews + * and by the citation inset. + */ + bool fully_loaded() const; + /// Set by buffer_funcs' newFile. + void fully_loaded(bool); - /// Format number of buffer - int file_format; - /** A list of views using this buffer. - Why not keep a list of the BufferViews that use this buffer? + /// Our main text (inside the top InsetText) + LyXText & text() const; - At least then we don't have to do a lot of magic like: - #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each - of the buffers in the list of users to do a #updateLayoutChoice#. - */ - BufferView * users; -public: - /// - class inset_iterator { - public: - typedef std::input_iterator_tag iterator_category; - typedef Inset value_type; - typedef ptrdiff_t difference_type; - typedef Inset * pointer; - typedef Inset & reference; - typedef ParagraphList::iterator base_type; - - /// - inset_iterator(); - /// - inset_iterator(base_type p, base_type e); - /// - inset_iterator(base_type p, lyx::pos_type pos, base_type e); - - /// prefix ++ - inset_iterator & operator++(); - /// postfix ++ - inset_iterator operator++(int); - /// - reference operator*(); - /// - pointer operator->(); - - /// - Paragraph * getPar(); - /// - lyx::pos_type getPos() const; - /// - friend - bool operator==(inset_iterator const & iter1, - inset_iterator const & iter2); - private: - /// - void setParagraph(); - /// - ParagraphList::iterator pit; - /// - ParagraphList::iterator pend; - /// - InsetList::iterator it; - }; + /// Our top InsetText! + InsetBase & inset() const; + // + // Macro handling + // /// - inset_iterator inset_iterator_begin() { - return inset_iterator(paragraphs.begin(), paragraphs.end()); - } - + void buildMacros(); /// - inset_iterator inset_iterator_end() { - return inset_iterator(); - } - + bool hasMacro(std::string const & name) const; /// - inset_iterator inset_const_iterator_begin() const { - return inset_iterator(paragraphs.begin(), paragraphs.end()); - } - + MacroData const & getMacro(std::string const & name) const; /// - inset_iterator inset_const_iterator_end() const { - return inset_iterator(); - } - + void insertMacro(std::string const & name, MacroData const & data); /// - ParIterator par_iterator_begin(); + void saveCursor(StableDocIterator cursor, StableDocIterator anchor); /// - ParConstIterator par_iterator_begin() const; + StableDocIterator getCursor() const { return cursor_; } /// - ParIterator par_iterator_end(); + StableDocIterator getAnchor() const { return anchor_; } /// - ParConstIterator par_iterator_end() const; + void changeRefsIfUnique(std::string const & from, std::string const & to); - /// - Inset * getInsetFromID(int id_arg) const; -}; +private: + /** Inserts a file into a document + \return \c false if method fails. + */ + bool readFile(LyXLex &, std::string const & filename); + + bool do_writeFile(std::ostream & ofs) const; -bool operator==(Buffer::inset_iterator const & iter1, - Buffer::inset_iterator const & iter2); + /// Use the Pimpl idiom to hide the internals. + class Impl; + /// The pointer never changes although *pimpl_'s contents may. + boost::scoped_ptr const pimpl_; + + /// Save the cursor Position on Buffer switch + /// this would not be needed if every Buffer would have + /// it's BufferView, this should be FIXED in future. + StableDocIterator cursor_; + StableDocIterator anchor_; +}; -bool operator!=(Buffer::inset_iterator const & iter1, - Buffer::inset_iterator const & iter2); #endif