// -*- C++ -*-
/* This file is part of
-* ======================================================
-*
-* LyX, The Document Processor
-* Copyright (C) 1995 Matthias Ettrich
-*
-* This file is Copyleft (C) 1996
-* Lars Gullik Bjønnes
-*
-* ====================================================== */
+ * ======================================================
+ *
+ * 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
#pragma interface
#endif
+#include "LString.h"
#include "undo.h"
-#include "BufferView.h"
+#include "undostack.h"
#include "lyxvc.h"
#include "bufferparams.h"
#include "texrow.h"
-#include "lyxtext.h"
+#include "paragraph.h"
+class BufferView;
class LyXRC;
class TeXErrors;
class LaTeXFeatures;
+class Language;
+class ParIterator;
-extern void updateAllVisibleBufferRelatedPopups();
-extern void WarnReadonly();
+// 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 {
///
string master;
///
- DEPCLEAN *next;
+ DEPCLEAN * next;
};
/** 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
*/
class Buffer {
public:
- /**@name Constructors and destructor */
- //@{
- ///
- Buffer(string const & file, LyXRC * lyxrc = 0, bool b = false);
+ /// What type of log will \c getLogName() return?
+ enum LogType {
+ latexlog, ///< LaTeX log
+ buildlog ///< Literate build log
+ };
+
+ /** Constructor
+ \param file
+ \param b optional \c false by default
+ */
+ explicit Buffer(string const & file, bool b = false);
- ///
+ /// Destructor
~Buffer();
- //@}
-
- /**@name Methods */
- //@{
-
- /** 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.
- */
- bool saveParamsAsDefaults();
-
- /// should be changed to work for a list.
- void resize()
- {
- if (users) {
- users->resize();
- } else if (text) {
- delete text;
- text = 0;
- }
- }
- /// Update window titles of all users
- void updateTitles();
+ /** High-level interface to buffer functionality.
+ This function parses a command string and executes it
+ */
+ bool dispatch(string const & command);
- /// Reset autosave timers for all users
- void resetAutosaveTimers();
+ /// Maybe we know the function already by number...
+ bool dispatch(int ac, string const & argument);
- /** 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; }
+ ///
+ void resizeInsets(BufferView *);
- /** 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; }
+ /// Update window titles of all users.
+ void updateTitles() const;
- ///
- void update(signed char f);
+ /// 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() {
- users->redraw();
- users->fitCursor();
- users->updateScrollbar();
- }
-
- /// Open and lock an updatable inset
- void open_new_inset(UpdatableInset *);
+ void redraw();
- ///
+ /// Load the autosaved file.
void loadAutoSaveFile();
/** Reads a file.
- Returns false if it fails.
- If par is given, the file is inserted. */
- bool readFile(LyXLex &, LyXParagraph * par = 0);
+ \param par if != 0 insert the file.
+ \return \c false if method fails.
+ */
+ bool readFile(LyXLex &, Paragraph * par = 0);
/** Reads a file without header.
- Returns false, if file is not completely read.
- If par is given, the file is inserted. */
- bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
-
- /// Inserts a lyx file at cursor position. Returns false if it fails.
- bool insertLyXFile(string const & filename);
-
- /// Write file. Returns false if unsuccesful.
- bool writeFile(string const &, bool);
+ \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
+ ///
+ void insertErtContents(Paragraph * par, int & pos,
+ LyXFont const & font,
+ bool set_inactive = true);
+#endif
+ ///
+ Paragraph * getParFromID(int id) const;
+private:
+ /// Parse a single inset.
+ 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(Paragraph const *,
+ unsigned int linelen) const;
///
void makeLaTeXFile(string const & filename,
string const & original_path,
bool nice, bool only_body = false);
-
- ///
- int runLaTeX();
+ /** 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;
///
- int runLiterate();
-
+ void simpleDocBookOnePar(std::ostream &,
+ Paragraph * par, int & desc_on,
+ Paragraph::depth_type depth) const ;
///
- int buildProgram();
+ void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
+ Paragraph::depth_type depth);
///
- int runChktex();
-
+ void makeLinuxDocFile(string const & filename,
+ bool nice, bool only_body = false);
///
- void makeLinuxDocFile(string const & filename, int column);
+ 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 makeDocBookFile(string const & filename, int column);
+ void sgmlError(Paragraph * par, int pos,
+ string const & message) const;
/// returns the main language for the buffer (document)
- string GetLanguage() const {
- return params.language;
- }
-
+ Language const * getLanguage() const;
///
- bool isLyxClean() const { return lyx_clean; }
-
- /// changed Heinrich Bauer, 23/03/98
- bool isDviClean();
-
- ///
- bool isNwClean() const { return nw_clean; }
-
+ int runChktex();
///
- bool isBakClean() const { return bak_clean; }
-
+ bool isLyxClean() const;
+ ///
+ bool isBakClean() const;
///
bool isDepClean(string const & name) const;
///
- void markLyxClean() {
- if (!lyx_clean) {
- lyx_clean = true;
- updateTitles();
- }
- // if the .lyx file has been saved, we don't need an
- // autosave
- bak_clean = true;
- }
+ void markLyxClean() const;
- /// changed Heinrich Bauer, 23/03/98
- void markDviClean();
-
- ///
- void markNwClean() { nw_clean = true; }
-
///
- void markBakClean() { bak_clean = true; }
+ void markBakClean();
///
void markDepClean(string const & name);
///
- void markDviDirty();
-
- ///
- void markNwDirty() { nw_clean = false; }
-
- ///
- void markDirty() {
- if (lyx_clean) {
- lyx_clean = false;
- updateTitles();
- }
- dvi_clean_tmpd = false;
- dvi_clean_orgd = false;
- nw_clean = false;
- bak_clean = false;
- DEPCLEAN* tmp = dep_clean;
- while (tmp) {
- tmp->clean = false;
- tmp = tmp->next;
- }
- }
+ void setUnnamed(bool flag = true);
///
- string getFileName() const { return filename; }
+ bool isUnnamed();
+ /// Mark this buffer as dirty.
+ void markDirty();
+
+ /// Returns the buffers filename.
+ string const & fileName() 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;
+
+ /// 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);
void setParentName(string const &);
/// Is buffer read-only?
- bool isReadonly() { return read_only; }
+ bool isReadonly() const;
/// Set buffer read-only flag
- void setReadonly(bool flag = true)
- {
- if (read_only != flag) {
- read_only = flag;
- updateTitles();
- updateAllVisibleBufferRelatedPopups();
- }
- if (read_only) {
- WarnReadonly();
- }
- }
+ 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 or DocBook document
+ /** 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
+ /// returns \c true if the buffer contains a Wed document
bool isLiterate() const;
- ///
- void setPaperStuff();
-
-#if 0
- ///
- void setOldPaperStuff();
-#endif
-
/** Validate a buffer for LaTeX.
- This validates the buffer, and returns a struct for use by
- makeLaTeX and others. Its main use is to figure out what commands
- and packages need to be included in the LaTeX file. It (should)
- also check that the needed constructs are there (i.e. that the \refs
- points to coresponding \labels). It should perhaps inset "error"
- insets to help the user correct obvious mistakes.
- */
- void validate(LaTeXFeatures &); //the correct parameters to be
- //included later
-
- /** Insert an inset into the buffer
- Insert inset into buffer, placing it in a layout of lout,
- if no_table make sure that it doesn't end up in a table. */
- void insertInset(Inset *, string const & lout = string(),
- bool no_table = false);
-
- ///
- void setCursorFromRow (int);
+ This validates the buffer, and returns a struct for use by
+ #makeLaTeX# and others. Its main use is to figure out what
+ commands and packages need to be included in the LaTeX file.
+ It (should) also check that the needed constructs are there
+ (i.e. that the \refs points to coresponding \labels). It
+ should perhaps inset "error" insets to help the user correct
+ obvious mistakes.
+ */
+ void validate(LaTeXFeatures &) const;
///
- string getIncludeonlyList(char delim = ',');
+ string const getIncludeonlyList(char delim = ',');
///
- string getReferenceList(char delim = '|');
+ std::vector<std::pair<string, string> > const getBibkeyList();
///
- string getBibkeyList(char delim = '|');
+ struct TocItem {
+ TocItem(Paragraph * p, int d, string const & s)
+ : par(p), depth(d), str(s) {}
+ ///
+ Paragraph * par;
+ ///
+ int depth;
+ ///
+ string str;
+ };
///
- bool gotoLabel(string const &);
-
- /// removes all autodeletable insets
- bool removeAutoInsets();
+ 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 { return users; }
+ than one user per buffer. */
+ BufferView * getUser() const;
- //@}
+ ///
+ void changeLanguage(Language const * from, Language const * to);
+ ///
+ bool isMultiLingual();
/// Does this mean that this is buffer local?
UndoStack undostack;
///
BufferParams params;
- /** is a list of paragraphs.
- */
- LyXParagraph * paragraph;
-
- /** This holds the mapping between buffer paragraphs and screen rows.
- Should be moved to BufferView. (Asger)
+ /** The list of paragraphs.
+ This is a linked list of paragraph, this list holds the
+ whole contents of the document.
*/
- LyXText * text;
-
- ///
- UpdatableInset * the_locking_inset;
+ Paragraph * paragraph;
- /// RCS object
+ /// LyX version control object.
LyXVC lyxvc;
- /// where the temporaries go if we want them
+ /// Where to put temporary files.
string tmppath;
- ///
+ /// The path to the document file.
string filepath;
- /** While writing as LaTeX, tells whether we are
+ /** 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;
-protected:
- ///
- void InsetUnlock();
-
- ///
- inline void InsetSleep();
-
- ///
- inline void InsetWakeup();
-
- ///
- bool inset_slept;
-
- ///
- int slx;
- ///
- int sly;
-private:
- ///
- void insertErrors(TeXErrors &);
-
- ///
- void linuxDocHandleFootnote(FILE * file,
- LyXParagraph * & par, int const depth);
- ///
- void DocBookHandleCaption(FILE * file, string & inner_tag,
- int const depth, int desc_on,
- LyXParagraph * &par);
- ///
- void DocBookHandleFootnote(FILE * file,
- LyXParagraph * & par, int const depth);
- ///
- void sgmlOpenTag(FILE * file, int depth,
- string const & latexname) const;
- ///
- void sgmlCloseTag(FILE * file, int depth,
- string const & latexname) const;
- ///
- void LinuxDocError(LyXParagraph * par, int pos, char const * message);
- ///
- void SimpleLinuxDocOnePar(FILE * file, LyXParagraph * par,
- int desc_on, int const depth);
- ///
- void SimpleDocBookOnePar(string & file, string & extra,
- LyXParagraph * par, int & desc_on,
- int const depth);
-
- /// LinuxDoc.
- void push_tag(FILE * file, char const * tag,
- int & pos, char stack[5][3]);
-
- /// LinuxDoc.
- void pop_tag(FILE * file, char const * tag,
- int & pos, char stack[5][3]);
-
- ///
- void RoffAsciiTable(FILE * file, LyXParagraph * par);
+ /// Used when typesetting to place errorboxes.
+ TexRow texrow;
+private:
/// is save needed
- bool lyx_clean;
+ mutable bool lyx_clean;
/// is autosave needed
- bool bak_clean;
+ mutable bool bak_clean;
- /** do we need to run LaTeX, changed 23/03/98, Heinrich Bauer
- We have to distinguish between TeX-runs executed in the original
- directory (in which the original LyX-file resides) and TeX-runs
- executed in a temporary directory. The first situation is valid
- for a dvi-export, the latter one for printing or previewing. */
- bool dvi_clean_orgd;
- bool dvi_clean_tmpd;
-
- /// do we need to run weave/tangle
- bool nw_clean;
-
- /// is regenerating .tex necessary
+ /// is this a unnamed file (New...)
+ bool unnamed;
+
+ /// is regenerating #.tex# necessary
DEPCLEAN * dep_clean;
/// buffer is r/o
string filename;
/// Format number of buffer
- float format;
-
+ int file_format;
/** A list of views using this buffer.
- Why not keep a list of the BufferViews that use 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.
- */
+ 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;
+
+
+ ///
+ inset_iterator() : par(0) /*, it(0)*/ {}
+ //
+ inset_iterator(Paragraph * paragraph) : par(paragraph) {
+ setParagraph();
+ }
+ ///
+ inset_iterator(Paragraph * paragraph,
+ Paragraph::size_type pos);
+ ///
+ inset_iterator & operator++() { // prefix ++
+ if (par) {
+ ++it;
+ if (it == par->inset_iterator_end()) {
+ par = par->next();
+ setParagraph();
+ }
+ }
+ return *this;
+ }
+ ///
+ 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;
+ }
+ ///
+ Inset * operator*() { return *it; }
+
+ ///
+ Paragraph * getPar() { return par; }
+ ///
+ Paragraph::size_type getPos() const { return it.getPos(); }
+ ///
+ friend
+ bool operator==(inset_iterator const & iter1,
+ inset_iterator const & iter2);
+ private:
+ ///
+ void setParagraph();
+ ///
+ Paragraph * par;
+ ///
+ Paragraph::inset_iterator it;
+ };
+
+ ///
+ inset_iterator inset_iterator_begin() {
+ return inset_iterator(paragraph);
+ }
+ ///
+ inset_iterator inset_iterator_end() {
+ return inset_iterator();
+ }
///
- friend class BufferList;
+ inset_iterator inset_const_iterator_begin() const {
+ return inset_iterator(paragraph);
+ }
///
- friend class BufferView;
+ inset_iterator inset_const_iterator_end() const {
+ return inset_iterator();
+ }
- /// Used when typesetting to place errorboxes.
- TexRow texrow;
+ ///
+ ParIterator par_iterator_begin();
+ ///
+ ParIterator par_iterator_end();
+
+ ///
+ Inset * getInsetFromID(int id_arg) const;
};
-inline
-void Buffer::InsetSleep()
+inline
+void Buffer::addUser(BufferView * u)
{
- if (the_locking_inset && !inset_slept) {
- the_locking_inset->GetCursorPos(slx, sly);
- the_locking_inset->InsetUnlock();
- inset_slept = true;
- }
+ users = u;
}
-inline
-void Buffer::InsetWakeup()
+inline
+void Buffer::delUser(BufferView *)
+{
+ users = 0;
+}
+
+
+inline
+Language const * Buffer::getLanguage() const
{
- if (the_locking_inset && inset_slept) {
- the_locking_inset->Edit(slx, sly);
- inset_slept = false;
- }
+ 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;
+ 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
projects / lyx.git / blobdiff