// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- * Copyright 1995 Matthias Ettrich
+/**
+ * \file buffer.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * This file is Copyleft 1996
- * Lars Gullik Bjønnes
+ * \author 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.
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef BUFFER_H
#define BUFFER_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "InsetList.h"
+
+#include "dociterator.h"
+
+#include "support/limited_stack.h"
+#include "support/types.h"
-#include "LString.h"
+#include <boost/scoped_ptr.hpp>
+#include <boost/signal.hpp>
-#include "BufferView.h"
-#include "lyxvc.h"
-#include "bufferparams.h"
-#include "texrow.h"
+#include <iosfwd>
+#include <map>
+#include <utility>
+#include <vector>
+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 auto_mem_buffer;
+class Language;
+class MacroData;
+class OutputParams;
+class ParagraphList;
+class ParConstIterator;
+class ParIterator;
+class TeXErrors;
+class TexRow;
+class Undo;
+class StableDocIterator;
-///
-struct DEPCLEAN {
- ///
- bool clean;
- ///
- string master;
- ///
- DEPCLEAN * next;
-};
/** The buffer object.
- The is 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.
+ * 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:
- ///
- explicit Buffer(string const & file, bool b = false);
-
- ///
- ~Buffer();
+ /// What type of log will \c getLogName() return?
+ enum LogType {
+ latexlog, ///< LaTeX log
+ buildlog ///< Literate build log
+ };
- /** save the buffer's parameters as user default
- This function saves a file #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 #true# on success.
+ /** Constructor
+ \param file
+ \param b optional \c false by default
*/
- bool saveParamsAsDefaults();
+ explicit Buffer(std::string const & file, bool b = false);
+
+ /// Destructor
+ ~Buffer();
/** High-level interface to buffer functionality.
This function parses a command string and executes it
*/
- bool Dispatch(string const & command);
+ bool dispatch(std::string const & command, bool * result = 0);
/// Maybe we know the function already by number...
- bool Dispatch(int ac, string const & argument);
-
- /// and have an xtl buffer to work with.
- bool Dispatch(int, auto_mem_buffer &);
+ bool dispatch(FuncRequest const & func, bool * result = 0);
- /// should be changed to work for a list.
- void resize();
- ///
- void resizeInsets(BufferView *);
-
- /// Update window titles of all users
- void updateTitles() const;
-
- /// Reset autosave timers for all users
- void resetAutosaveTimers() const;
+ /// Load the autosaved file.
+ void loadAutoSaveFile();
- /** Adds the BufferView to the users list.
- Later this func will insert the #BufferView# into a real list,
- not just setting a pointer.
- */
- void addUser(BufferView * u) { users = u; }
+ /// load a new file
+ bool readFile(std::string const & filename);
- /** Removes the #BufferView# from the users list.
- Since we only can have one at the moment, we just reset it.
- */
- void delUser(BufferView *) { users = 0; }
-
- ///
- void redraw() {
- users->redraw();
- users->fitCursor();
- //users->updateScrollbar();
- }
+ /// read the header, returns number of unknown tokens
+ int readHeader(LyXLex & lex);
- ///
- void loadAutoSaveFile();
-
- /** Reads a file.
- @param par if != 0 insert the file.
- @return #false# if method fails.
- */
- bool readFile(LyXLex &, LyXParagraph * par = 0);
-
/** Reads a file without header.
- @param par if != 0 insert the file.
- @return false if file is not completely read.
+ \param par if != 0 insert the file.
+ \return \c false if file is not completely read.
*/
- bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
-
- /// This parses a single LyXformat-Token.
- bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
- LyXParagraph *& return_par,
- string const & token, int & pos,
- char & depth, LyXFont &
-#ifndef NEW_INSETS
- ,LyXParagraph::footnote_flag &,
- LyXParagraph::footnote_kind &
-#endif
- );
-private:
- /// Parse a single inset.
- void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
-public:
- /** Save file
+ bool readDocument(LyXLex &);
+
+ ///
+ void insertStringAsLines(ParagraphList & plist,
+ lyx::pit_type &, lyx::pos_type &,
+ LyXFont const &, std::string const &, bool);
+ ///
+ 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<void(ErrorItem)> error;
+ /// This signal is emitted when some message shows up.
+ boost::signal<void(std::string)> message;
+ /// This signal is emitted when the buffer busy status change.
+ boost::signal<void(bool)> busy;
+ /// This signal is emitted when the buffer readonly status change.
+ boost::signal<void(bool)> readonly;
+ /// Update window titles of all users.
+ boost::signal<void()> updateTitles;
+ /// Reset autosave timers for all users.
+ boost::signal<void()> resetAutosaveTimers;
+ /// This signal is emitting if the buffer is being closed.
+ boost::signal<void()> closing;
+
+
+ /** Save file.
Takes care of auto-save files and backup file if requested.
- Returns #true# if the save is successful, #false# otherwise.
+ Returns \c true if the save is successful, \c false otherwise.
*/
bool save() const;
-
- /// Write file. Returns #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;
- ///
- void makeLaTeXFile(string const & filename,
- string const & original_path,
- bool nice, bool only_body = false);
- /** LaTeX all paragraphs from par to endpar.
- @param endpar if == 0 then to the end
- */
- void latexParagraphs(std::ostream & os, LyXParagraph * par,
- LyXParagraph * endpar, TexRow & texrow) const;
- ///
- int runLiterate();
-
- ///
- int buildProgram();
-
- ///
- int runChktex();
+ /// Write file. Returns \c false if unsuccesful.
+ bool writeFile(std::string const &) const;
///
- void makeLinuxDocFile(string const & filename,
- bool nice, bool only_body = false);
+ void writeFileAscii(std::string const &, OutputParams const &);
///
- void makeDocBookFile(string const & filename,
- bool nice, bool only_body = false);
-
- /// returns the main language for the buffer (document)
- string const GetLanguage() const {
- return params.language;
- }
-
+ void writeFileAscii(std::ostream &, OutputParams const &);
+ /// Just a wrapper for the method below, first creating the ofstream.
+ void makeLaTeXFile(std::string const & filename,
+ std::string const & original_path,
+ OutputParams const &,
+ bool output_preamble = true,
+ bool output_body = true);
///
- bool isLyxClean() const { return lyx_clean; }
-
- ///
- bool isNwClean() const { return nw_clean; }
-
+ void makeLaTeXFile(std::ostream & os,
+ std::string const & original_path,
+ OutputParams const &,
+ bool output_preamble = true,
+ bool output_body = true);
///
- bool isBakClean() const { return bak_clean; }
-
+ void makeLinuxDocFile(std::string const & filename,
+ OutputParams const & runparams_in,
+ bool only_body = false);
///
- bool isDepClean(string const & name) const;
-
+ 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;
+
///
- void markLyxClean() const {
- if (!lyx_clean) {
- lyx_clean = true;
- updateTitles();
- }
- // if the .lyx file has been saved, we don't need an
- // autosave
- bak_clean = true;
- }
-
- ///
- void markNwClean() { nw_clean = true; }
-
+ int runChktex();
+ /// return true if the main lyx file does not need saving
+ bool isClean() const;
///
- void markBakClean() { bak_clean = true; }
-
+ bool isBakClean() const;
///
- void markDepClean(string const & name);
-
- ///
- void markNwDirty() { nw_clean = false; }
+ bool isDepClean(std::string const & name) const;
+
+ /// mark the main lyx file as not needing saving
+ void markClean() const;
///
- void setUnnamed(bool flag=true) { unnamed = flag; }
+ void markBakClean();
///
- bool isUnnamed() { return unnamed; }
+ void markDepClean(std::string const & name);
///
- void markDirty() {
- if (lyx_clean) {
- lyx_clean = false;
- updateTitles();
- }
- nw_clean = false;
- bak_clean = false;
- DEPCLEAN * tmp = dep_clean;
- while (tmp) {
- tmp->clean = false;
- tmp = tmp->next;
- }
- }
+ void setUnnamed(bool flag = true);
///
- string const & fileName() const { return filename; }
+ bool isUnnamed() const;
+
+ /// Mark this buffer as dirty.
+ void markDirty();
+
+ /// Returns the buffer's filename. It is always an absolute path.
+ std::string const & fileName() const;
- /** A transformed version of the file name, adequate for LaTeX
- The path is stripped if no_path is true (default)
+ /// Returns the the path where the buffer lives.
+ /// It is always an absolute path.
+ 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<LogType, std::string> const getLogName() const;
/// Change name of buffer. Updates "read-only" flag.
- void fileName(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 { return read_only; }
+ bool isReadonly() const;
/// Set buffer read-only flag
void setReadonly(bool flag = true);
- /// returns #true# if the buffer contains a LaTeX document
+ /// returns \c true if the buffer contains a LaTeX document
bool isLatex() const;
- /// returns #true# if the buffer contains a LinuxDoc document
+ /// returns \c true if the buffer contains a LinuxDoc document
bool isLinuxDoc() const;
- /// returns #true# if the buffer contains a DocBook document
+ /// returns \c true if the buffer contains a DocBook document
bool isDocBook() const;
- /** returns #true# if the buffer contains either a LinuxDoc
+ /** returns \c true if the buffer contains either a LinuxDoc
or DocBook document */
bool isSGML() const;
- /// returns #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
*/
void validate(LaTeXFeatures &) const;
+ /// return all bibkeys from buffer and its childs
+ void fillWithBibKeys(std::vector<std::pair<std::string, std::string> > & keys) const;
///
- string const getIncludeonlyList(char delim = ',');
- ///
- std::vector<std::pair<string,string> > const getBibkeyList();
- ///
- struct TocItem {
- ///
- LyXParagraph * par;
- ///
- int depth;
- ///
- string str;
- };
- ///
- enum TocType {
- ///
- TOC_TOC = 0,
- ///
- TOC_LOF,
- ///
- TOC_LOT,
- ///
- TOC_LOA
- };
- ///
- std::vector<std::vector<TocItem> > const getTocList();
- ///
- std::vector<string> const getLabelList();
+ void getLabelList(std::vector<std::string> &) const;
- /** This will clearly have to change later. Later we can have more
- than one user per buffer. */
- BufferView * getUser() const { return users; }
+ ///
+ void changeLanguage(Language const * from, Language const * to);
///
- void ChangeLanguage(Language const * from, Language const * to);
+ void updateDocLang(Language const * nlang);
+
///
- bool isMultiLingual();
+ bool isMultiLingual() const;
/// Does this mean that this is buffer local?
- UndoStack undostack;
-
- /// Does this mean that this is buffer local?
- UndoStack redostack;
-
+ limited_stack<Undo> & undostack();
+ limited_stack<Undo> const & undostack() const;
+
+ /// Does this mean that this is buffer local?
+ limited_stack<Undo> & redostack();
+ limited_stack<Undo> const & redostack() const;
+
///
- BufferParams params;
-
- /** is a list of paragraphs.
+ 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.
*/
- LyXParagraph * paragraph;
+ ParagraphList & paragraphs();
+ ParagraphList const & paragraphs() const;
+
+ /// LyX version control object.
+ LyXVC & lyxvc();
+ LyXVC const & lyxvc() const;
- /// RCS object
- LyXVC lyxvc;
+ /// Where to put temporary files.
+ std::string const & temppath() const;
- /// where the temporaries go if we want them
- string tmppath;
+ /// Used when typesetting to place errorboxes.
+ TexRow & texrow();
+ TexRow const & texrow() const;
///
- string filepath;
+ ParIterator par_iterator_begin();
+ ///
+ ParConstIterator par_iterator_begin() const;
+ ///
+ ParIterator par_iterator_end();
+ ///
+ ParConstIterator par_iterator_end() const;
- /** While writing as LaTeX, tells whether we are
- doing a 'nice' LaTeX file */
- bool niceFile;
+ /** \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);
- /// Used when typesetting to place errorboxes.
- TexRow texrow;
-private:
-#ifndef NEW_INSETS
- ///
- void linuxDocHandleFootnote(std::ostream & os,
- LyXParagraph * & par, int const depth);
-#endif
- ///
- void DocBookHandleCaption(std::ostream & os, string & inner_tag,
- int const depth, int desc_on,
- LyXParagraph * & par);
-#ifndef NEW_INSETS
- ///
- void DocBookHandleFootnote(std::ostream & os,
- LyXParagraph * & par, int const depth);
-#endif
+ /// Our main text (inside the top InsetText)
+ LyXText & text() const;
+
+ /// Our top InsetText!
+ InsetBase & inset() const;
+
+ //
+ // Macro handling
+ //
///
- void sgmlOpenTag(std::ostream & os, int depth,
- string const & latexname) const;
- ///
- void sgmlCloseTag(std::ostream & os, int depth,
- string const & latexname) const;
+ void buildMacros();
///
- void LinuxDocError(LyXParagraph * par, int pos,
- string const & message);
- ///
- void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
- int desc_on, int const depth);
- ///
- void SimpleDocBookOnePar(std::ostream &, string & extra,
- LyXParagraph * par, int & desc_on,
- int const 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;
-
- /// do we need to run weave/tangle
- bool nw_clean;
-
- /// is this a unnamed file (New...)
- bool unnamed;
-
- /// is regenerating #.tex# necessary
- DEPCLEAN * dep_clean;
-
- /// buffer is r/o
- bool read_only;
-
- /// name of the file the buffer is associated with.
- string filename;
-
- /// Format number of buffer
- float format;
-
- /** A list of views using this buffer.
- Why not keep a list of the BufferViews that use this buffer?
-
- 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:
+ bool hasMacro(std::string const & name) const;
///
- class inset_iterator {
- public:
- ///
- inset_iterator() : par(0) /*, it(0)*/ {}
- //
- inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
- SetParagraph();
- }
- ///
- inset_iterator(LyXParagraph * paragraph,
- LyXParagraph::size_type pos);
- ///
- inset_iterator & operator++() {
- if (par) {
- ++it;
- if (it == par->inset_iterator_end()) {
- par = par->next;
- SetParagraph();
- }
- }
- return *this;
- }
- ///
- Inset * operator*() {return *it; }
- ///
- LyXParagraph * getPar() { return par; }
- ///
- LyXParagraph::size_type getPos() {return it.getPos(); }
- ///
- friend
- bool operator==(inset_iterator const & iter1,
- inset_iterator const & iter2);
- //
- //friend
- //bool operator!=(inset_iterator const & iter1,
- // inset_iterator const & iter2);
- private:
- ///
- void SetParagraph();
- ///
- LyXParagraph * par;
- ///
- LyXParagraph::inset_iterator it;
- };
-
+ MacroData const & getMacro(std::string const & name) const;
///
- inset_iterator inset_iterator_begin() {
- return inset_iterator(paragraph);
- }
+ void insertMacro(std::string const & name, MacroData const & data);
///
- inset_iterator inset_iterator_end() {
- return inset_iterator();
- }
-};
+ void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
+ ///
+ StableDocIterator getCursor() const { return cursor_; }
+ ///
+ StableDocIterator getAnchor() const { return anchor_; }
+ ///
+ void changeRefsIfUnique(std::string const & from, std::string const & to);
+private:
+ /** Inserts a file into a document
+ \return \c false if method fails.
+ */
+ bool readFile(LyXLex &, std::string const & filename);
-inline
-void Buffer::setParentName(string const & name)
-{
- params.parentname = name;
-}
-
-///
-inline
-bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
- return a.par == b.par && a.str == b.str;
- // No need to compare depth.
-}
-
-
-///
-inline
-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) {
- 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) {
- return !(iter1 == iter2);
-}
-#endif
+ bool do_writeFile(std::ostream & ofs) const;
+
+ /// Use the Pimpl idiom to hide the internals.
+ class Impl;
+ /// The pointer never changes although *pimpl_'s contents may.
+ boost::scoped_ptr<Impl> 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_;
+};
+
+#endif
projects / lyx.git / blobdiff