// -*- 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
*
- * ====================================================== */
-
+ * Full author contact details are available in file CREDITS
+ */
+
#ifndef BUFFER_H
#define BUFFER_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
#include "LString.h"
#include "undo.h"
-#include "undostack.h"
+#include "support/limited_stack.h"
+
#include "lyxvc.h"
#include "bufferparams.h"
#include "texrow.h"
-#include "paragraph.h"
+#include "ParagraphList.h"
+#include "author.h"
+#include "iterators.h"
+#include "errorlist.h"
+
+#include <boost/scoped_ptr.hpp>
+#include <boost/signals/signal0.hpp>
+#include <boost/signals/signal1.hpp>
-class BufferView;
class LyXRC;
class TeXErrors;
class LaTeXFeatures;
+class LatexRunParams;
class Language;
class ParIterator;
+class ParConstIterator;
+class Messages;
-// 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 {
- ///
- bool clean;
- ///
- string master;
- ///
- DEPCLEAN * next;
-};
/** The buffer object.
This is the buffer object. It contains all the informations about
\param b optional \c false by default
*/
explicit Buffer(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(string const & command, bool * result = 0);
/// Maybe we know the function already by number...
- bool dispatch(int ac, string const & argument);
-
- ///
- 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(int ac, string const & argument, bool * result = 0);
/// Load the autosaved file.
void loadAutoSaveFile();
-
- /** Reads a file.
+
+ /** Inserts a file into a document
\param par if != 0 insert the file.
\return \c false if method fails.
*/
- bool readFile(LyXLex &, Paragraph * par = 0);
-
+ bool readFile(LyXLex &, string const &, ParagraphList::iterator pit);
+
+ // FIXME: it's very silly to pass a lex in here
+ /// load a new file
+ bool readFile(string const &);
+
+ /// 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 &);
- ///
- void insertStringAsLines(Paragraph *&, Paragraph::size_type &,
- LyXFont const &, string const &) const;
-#ifndef NO_COMPABILITY
+ bool readBody(LyXLex &, ParagraphList::iterator pit);
+
+ /// This parses a single token
+ int readParagraph(LyXLex &, string const & token,
+ ParagraphList & pars, ParagraphList::iterator & pit,
+ Paragraph::depth_type & depth);
+
///
- void insertErtContents(Paragraph * par, int & pos,
- LyXFont const & font,
- bool set_inactive = true);
-#endif
+ void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
+ LyXFont const &, string const &);
///
- Paragraph * getParFromID(int id) const;
-private:
- /// Parse a single inset.
- void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
+ ParIterator getParFromID(int id) const;
+ /// do we have a paragraph with this id?
+ bool hasParWithID(int id) const;
+
public:
+ /// This signal is emitted when a parsing error shows up.
+ boost::signal1<void, ErrorItem> error;
+ /// This signal is emitted when some message shows up.
+ boost::signal1<void, string> message;
+ /// This signal is emitted when the buffer busy status change.
+ boost::signal1<void, bool> busy;
+ /// This signal is emitted when the buffer readonly status change.
+ boost::signal1<void, bool> readonly;
+ /// Update window titles of all users.
+ boost::signal0<void> updateTitles;
+ /// Reset autosave timers for all users.
+ boost::signal0<void> resetAutosaveTimers;
+ /// This signal is emitting if the buffer is being closed.
+ boost::signal0<void> 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.
*/
bool save() const;
-
+
/// Write file. Returns \c false if unsuccesful.
- bool writeFile(string const &, bool) const;
-
+ bool writeFile(string const &) const;
+
///
void writeFileAscii(string const & , int);
///
void writeFileAscii(std::ostream &, int);
///
- string const asciiParagraph(Paragraph const *,
- unsigned int linelen) const;
- ///
+ string const asciiParagraph(Paragraph const &, unsigned int linelen,
+ bool noparbreak = false) 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);
- /** LaTeX all paragraphs from par to endpar.
- \param \a endpar if == 0 then to the end
- */
- void latexParagraphs(std::ostream & os, Paragraph * par,
- Paragraph * endpar, TexRow & texrow) const;
-
- ///
- void simpleDocBookOnePar(std::ostream &, string & extra,
- Paragraph * par, int & desc_on,
- Paragraph::depth_type depth) const ;
- ///
- void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
- Paragraph::depth_type depth);
-
+ LatexRunParams const &,
+ bool output_preamble = true,
+ bool output_body = true);
+ ///
+ void makeLaTeXFile(std::ostream & os,
+ string const & original_path,
+ LatexRunParams const &,
+ bool output_preamble = true,
+ bool output_body = true);
+ ///
+ void simpleDocBookOnePar(std::ostream &,
+ ParagraphList::iterator par, int & desc_on,
+ Paragraph::depth_type depth) const;
+ ///
+ void simpleLinuxDocOnePar(std::ostream & os,
+ ParagraphList::iterator par,
+ Paragraph::depth_type depth) const;
///
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;
+ /// get l10n translated to the buffers language
+ string const B_(string const & l10n) const;
+
///
int runChktex();
- ///
- bool isLyxClean() const;
+ /// return true if the main lyx file does not need saving
+ bool isClean() const;
///
bool isBakClean() const;
///
bool isDepClean(string const & name) const;
-
- ///
- void markLyxClean() const;
+
+ /// mark the main lyx file as not needing saving
+ void markClean() const;
///
void markBakClean();
-
+
///
void markDepClean(string const & name);
-
+
///
void setUnnamed(bool flag = true);
/// 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.
*/
/// Get the name and type of the log.
std::pair<LogType, string> const getLogName() const;
-
+
/// Change name of buffer. Updates "read-only" flag.
void setFileName(string const & newfile);
/** 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;
+ /// 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<string, string> > & keys) const;
///
- string const getIncludeonlyList(char delim = ',');
- ///
- std::vector<std::pair<string, string> > const getBibkeyList();
- ///
- struct TocItem {
- TocItem(Paragraph * p, int d, string const & s)
- : par(p), depth(d), str(s) {}
- ///
- Paragraph * par;
- ///
- int depth;
- ///
- string str;
- };
- ///
- typedef std::vector<TocItem> SingleList;
- ///
- typedef std::map<string, SingleList> Lists;
- ///
- Lists const getLists() const;
- ///
- std::vector<string> const getLabelList();
-
- /** This will clearly have to change later. Later we can have more
- than one user per buffer. */
- BufferView * getUser() const;
+ void getLabelList(std::vector<string> &) const;
///
void changeLanguage(Language const * from, Language const * to);
+
+ ///
+ void updateDocLang(Language const * nlang);
+
///
bool isMultiLingual();
/// Does this mean that this is buffer local?
- UndoStack undostack;
-
- /// Does this mean that this is buffer local?
- UndoStack redostack;
-
+ limited_stack<Undo> undostack;
+
+ /// Does this mean that this is buffer local?
+ limited_stack<Undo> redostack;
+
///
BufferParams params;
-
+
/** The list of paragraphs.
This is a linked list of paragraph, this list holds the
whole contents of the document.
*/
- Paragraph * paragraph;
+ ParagraphList paragraphs;
/// LyX version control object.
LyXVC lyxvc;
/// 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 */
/// Used when typesetting to place errorboxes.
TexRow texrow;
+
+ /// the author list for the document
+ AuthorList & authors();
+
private:
+ bool do_writeFile(std::ostream & ofs) const;
+
+ typedef std::map<string, bool> DepClean;
+
+ /// need to regenerate .tex ?
+ DepClean dep_clean_;
+
/// is save needed
mutable bool lyx_clean;
-
+
/// is autosave needed
mutable bool bak_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
- int file_format;
- /** A list of views using this buffer.
- Why not keep a list of the BufferViews that use this buffer?
+ string filename_;
- 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;
+ /// The path to the document file.
+ string filepath_;
+ ///
+ boost::scoped_ptr<Messages> messages_;
public:
///
class inset_iterator {
public:
typedef std::input_iterator_tag iterator_category;
- typedef Inset value_type;
+ typedef InsetOld value_type;
typedef ptrdiff_t difference_type;
- typedef Inset * pointer;
- typedef Inset & reference;
-
-
+ typedef InsetOld * pointer;
+ typedef InsetOld & reference;
+ typedef ParagraphList::iterator base_type;
+
///
- inset_iterator() : par(0) /*, it(0)*/ {}
- //
- inset_iterator(Paragraph * paragraph) : par(paragraph) {
- setParagraph();
- }
+ inset_iterator();
///
- inset_iterator(Paragraph * paragraph,
- Paragraph::size_type pos);
+ inset_iterator(base_type p, base_type e);
///
- inset_iterator & operator++() { // prefix ++
- if (par) {
- ++it;
- if (it == par->inset_iterator_end()) {
- par = par->next();
- setParagraph();
- }
- }
- return *this;
- }
+ inset_iterator(base_type p, lyx::pos_type pos, base_type e);
+
+ /// prefix ++
+ inset_iterator & operator++();
+ /// postfix ++
+ inset_iterator operator++(int);
///
- inset_iterator operator++(int) { // postfix ++
- inset_iterator tmp(par, it.getPos());
- if (par) {
- ++it;
- if (it == par->inset_iterator_end()) {
- par = par->next();
- setParagraph();
- }
- }
- return tmp;
- }
+ reference operator*();
///
- Inset * operator*() { return *it; }
-
+ pointer operator->();
+
///
- Paragraph * getPar() { return par; }
+ ParagraphList::iterator getPar() const;
///
- Paragraph::size_type getPos() const { return it.getPos(); }
+ lyx::pos_type getPos() const;
///
friend
bool operator==(inset_iterator const & iter1,
///
void setParagraph();
///
- Paragraph * par;
+ ParagraphList::iterator pit;
+ ///
+ ParagraphList::iterator pend;
///
- Paragraph::inset_iterator it;
+ InsetList::iterator it;
};
- ///
- inset_iterator inset_iterator_begin() {
- return inset_iterator(paragraph);
- }
- ///
- 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();
- }
+ /// return an iterator to all *top-level* insets in the buffer
+ inset_iterator inset_iterator_begin();
+
+ /// return the end of all *top-level* insets in the buffer
+ inset_iterator inset_iterator_end();
+
+ /// return a const iterator to all *top-level* insets in the buffer
+ inset_iterator inset_const_iterator_begin() const;
+
+ /// return the const end of all *top-level* insets in the buffer
+ inset_iterator inset_const_iterator_end() const;
///
ParIterator par_iterator_begin();
///
+ ParConstIterator par_iterator_begin() const;
+ ///
ParIterator par_iterator_end();
+ ///
+ ParConstIterator par_iterator_end() const;
///
- Inset * getInsetFromID(int id_arg) const;
+ InsetOld * getInsetFromID(int id_arg) const;
};
-
-inline
-void Buffer::addUser(BufferView * u)
-{
- users = u;
-}
-
-
-inline
-void Buffer::delUser(BufferView *)
-{
- users = 0;
-}
-
-
-inline
-Language const * Buffer::getLanguage() const
-{
- return params.language;
-}
-
-
-inline
-bool Buffer::isLyxClean() const
-{
- return lyx_clean;
-}
-
-
-inline
-bool Buffer::isBakClean() const
-{
- return bak_clean;
-}
-
-
-inline
-void Buffer::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;
-}
-
-
-inline
-void Buffer::markBakClean()
-{
- bak_clean = true;
-}
-
-
-inline
-void Buffer::setUnnamed(bool flag)
-{
- unnamed = flag;
-}
-
-
-inline
-bool Buffer::isUnnamed()
-{
- return unnamed;
-}
-
-
-inline
-void Buffer::markDirty()
-{
- if (lyx_clean) {
- lyx_clean = false;
- updateTitles();
- }
- bak_clean = false;
- DEPCLEAN * tmp = dep_clean;
- while (tmp) {
- tmp->clean = false;
- tmp = tmp->next;
- }
-}
-
-
-inline
-string const & Buffer::fileName() const
-{
- return filename;
-}
-
-
-inline
-bool Buffer::isReadonly() const
-{
- return read_only;
-}
-
-
-inline
-BufferView * Buffer::getUser() const
-{
- return users;
-}
-
-
-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);
-}
-
+ Buffer::inset_iterator const & iter2);
-///
-inline
bool operator!=(Buffer::inset_iterator const & iter1,
- Buffer::inset_iterator const & iter2) {
- return !(iter1 == iter2);
-}
-
+ Buffer::inset_iterator const & iter2);
#endif
projects / lyx.git / blobdiff