2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
8 * This file is Copyleft 1996
11 * ====================================================== */
22 #include "undostack.h"
24 #include "bufferparams.h"
26 #include "paragraph.h"
35 // When lyx 1.3.x starts we should enable this
36 // btw. we should also test this with 1.2 so that we
37 // do not get any surprises. (Lgb)
38 #define NO_COMPABILITY 1
50 /** The buffer object.
51 This is the buffer object. It contains all the informations about
52 a document loaded into LyX. I am not sure if the class is complete or
53 minimal, probably not.
54 \author Lars Gullik Bjønnes
58 /// What type of log will \c getLogName() return?
60 latexlog, ///< LaTeX log
61 buildlog ///< Literate build log
66 \param b optional \c false by default
68 explicit Buffer(string const & file, bool b = false);
73 /** High-level interface to buffer functionality.
74 This function parses a command string and executes it
76 bool dispatch(string const & command);
78 /// Maybe we know the function already by number...
79 bool dispatch(int ac, string const & argument);
82 void resizeInsets(BufferView *);
84 /// Update window titles of all users.
85 void updateTitles() const;
87 /// Reset autosave timers for all users.
88 void resetAutosaveTimers() const;
90 /** Adds the BufferView to the users list.
91 Later this func will insert the \c BufferView into a real list,
92 not just setting a pointer.
94 void addUser(BufferView * u);
96 /** Removes the #BufferView# from the users list.
97 Since we only can have one at the moment, we just reset it.
99 void delUser(BufferView *);
104 /// Load the autosaved file.
105 void loadAutoSaveFile();
108 \param par if != 0 insert the file.
109 \return \c false if method fails.
111 bool readFile(LyXLex &, Paragraph * par = 0);
113 /** Reads a file without header.
114 \param par if != 0 insert the file.
115 \return \c false if file is not completely read.
117 bool readLyXformat2(LyXLex &, Paragraph * par = 0);
119 /// This parses a single LyXformat-Token.
120 bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
121 Paragraph *& return_par,
122 string const & token, int & pos,
123 Paragraph::depth_type & depth,
126 void insertStringAsLines(Paragraph *&, lyx::pos_type &,
127 LyXFont const &, string const &) const;
128 #ifndef NO_COMPABILITY
130 Inset * isErtInset(Paragraph * par, int pos) const;
132 void insertErtContents(Paragraph * par, int & pos,
133 bool set_inactive = true);
136 Paragraph * getParFromID(int id) const;
138 /// Parse a single inset.
139 void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
142 Takes care of auto-save files and backup file if requested.
143 Returns \c true if the save is successful, \c false otherwise.
147 /// Write file. Returns \c false if unsuccesful.
148 bool writeFile(string const &, bool) const;
151 void writeFileAscii(string const & , int);
153 void writeFileAscii(std::ostream &, int);
155 string const asciiParagraph(Paragraph const *, unsigned int linelen,
156 bool noparbreak = false) const;
158 void makeLaTeXFile(string const & filename,
159 string const & original_path,
160 bool nice, bool only_body = false);
161 /** LaTeX all paragraphs from par to endpar.
162 \param \a endpar if == 0 then to the end
164 void latexParagraphs(std::ostream & os, Paragraph * par,
165 Paragraph * endpar, TexRow & texrow, bool moving_arg = false) const;
167 void simpleDocBookOnePar(std::ostream &,
168 Paragraph * par, int & desc_on,
169 Paragraph::depth_type depth) const ;
171 void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
172 Paragraph::depth_type depth);
174 void makeLinuxDocFile(string const & filename,
175 bool nice, bool only_body = false);
177 void makeDocBookFile(string const & filename,
178 bool nice, bool only_body = false);
179 /// Open SGML/XML tag.
180 void sgmlOpenTag(std::ostream & os, Paragraph::depth_type depth,
181 string const & latexname) const;
182 /// Closes SGML/XML tag.
183 void sgmlCloseTag(std::ostream & os, Paragraph::depth_type depth,
184 string const & latexname) const;
186 void sgmlError(Paragraph * par, int pos, string const & message) const;
188 /// returns the main language for the buffer (document)
189 Language const * getLanguage() const;
193 bool isLyxClean() const;
195 bool isBakClean() const;
197 bool isDepClean(string const & name) const;
200 void markLyxClean() const;
206 void markDepClean(string const & name);
209 void setUnnamed(bool flag = true);
214 /// Mark this buffer as dirty.
217 /// Returns the buffer's filename. It is always an absolute path.
218 string const & fileName() const;
220 /// Returns the the path where the buffer lives.
221 /// It is always an absolute path.
222 string const & filePath() const;
224 /** A transformed version of the file name, adequate for LaTeX.
225 \param no_path optional if \c true then the path is stripped.
227 string const getLatexName(bool no_path = true) const;
229 /// Get the name and type of the log.
230 std::pair<LogType, string> const getLogName() const;
232 /// Change name of buffer. Updates "read-only" flag.
233 void setFileName(string const & newfile);
235 /// Name of the document's parent
236 void setParentName(string const &);
238 /// Is buffer read-only?
239 bool isReadonly() const;
241 /// Set buffer read-only flag
242 void setReadonly(bool flag = true);
244 /// returns \c true if the buffer contains a LaTeX document
245 bool isLatex() const;
246 /// returns \c true if the buffer contains a LinuxDoc document
247 bool isLinuxDoc() const;
248 /// returns \c true if the buffer contains a DocBook document
249 bool isDocBook() const;
250 /** returns \c true if the buffer contains either a LinuxDoc
251 or DocBook document */
253 /// returns \c true if the buffer contains a Wed document
254 bool isLiterate() const;
256 /** Validate a buffer for LaTeX.
257 This validates the buffer, and returns a struct for use by
258 #makeLaTeX# and others. Its main use is to figure out what
259 commands and packages need to be included in the LaTeX file.
260 It (should) also check that the needed constructs are there
261 (i.e. that the \refs points to coresponding \labels). It
262 should perhaps inset "error" insets to help the user correct
265 void validate(LaTeXFeatures &) const;
268 string const getIncludeonlyList(char delim = ',');
270 std::vector<std::pair<string, string> > const getBibkeyList() const;
273 TocItem(Paragraph * p, int d, string const & s)
274 : par(p), depth(d), str(s) {}
283 typedef std::vector<TocItem> SingleList;
285 typedef std::map<string, SingleList> Lists;
287 Lists const getLists() const;
289 std::vector<string> const getLabelList();
291 /** This will clearly have to change later. Later we can have more
292 than one user per buffer. */
293 BufferView * getUser() const;
296 void changeLanguage(Language const * from, Language const * to);
298 bool isMultiLingual();
300 /// Does this mean that this is buffer local?
303 /// Does this mean that this is buffer local?
309 /** The list of paragraphs.
310 This is a linked list of paragraph, this list holds the
311 whole contents of the document.
313 Paragraph * paragraph;
315 /// LyX version control object.
318 /// Where to put temporary files.
321 /** If we are writing a nice LaTeX file or not.
322 While writing as LaTeX, tells whether we are
323 doing a 'nice' LaTeX file */
326 /// Used when typesetting to place errorboxes.
330 mutable bool lyx_clean;
332 /// is autosave needed
333 mutable bool bak_clean;
335 /// is this a unnamed file (New...)
338 /// is regenerating #.tex# necessary
339 DEPCLEAN * dep_clean;
344 /// name of the file the buffer is associated with.
347 /// The path to the document file.
350 /// Format number of buffer
352 /** A list of views using this buffer.
353 Why not keep a list of the BufferViews that use this buffer?
355 At least then we don't have to do a lot of magic like:
356 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
357 of the buffers in the list of users to do a #updateLayoutChoice#.
363 class inset_iterator {
365 typedef std::input_iterator_tag iterator_category;
366 typedef Inset value_type;
367 typedef ptrdiff_t difference_type;
368 typedef Inset * pointer;
369 typedef Inset & reference;
373 inset_iterator() : par(0) /*, it(0)*/ {}
375 inset_iterator(Paragraph * paragraph) : par(paragraph) {
379 inset_iterator(Paragraph * paragraph, lyx::pos_type pos);
381 inset_iterator & operator++() { // prefix ++
384 if (it == par->inset_iterator_end()) {
392 inset_iterator operator++(int) { // postfix ++
393 inset_iterator tmp(par, it.getPos());
396 if (it == par->inset_iterator_end()) {
404 Inset * operator*() { return *it; }
407 Paragraph * getPar() { return par; }
409 lyx::pos_type getPos() const { return it.getPos(); }
412 bool operator==(inset_iterator const & iter1,
413 inset_iterator const & iter2);
420 Paragraph::inset_iterator it;
424 inset_iterator inset_iterator_begin() {
425 return inset_iterator(paragraph);
428 inset_iterator inset_iterator_end() {
429 return inset_iterator();
432 inset_iterator inset_const_iterator_begin() const {
433 return inset_iterator(paragraph);
436 inset_iterator inset_const_iterator_end() const {
437 return inset_iterator();
441 ParIterator par_iterator_begin();
443 ParIterator par_iterator_end();
446 Inset * getInsetFromID(int id_arg) const;
451 void Buffer::addUser(BufferView * u)
458 void Buffer::delUser(BufferView *)
465 Language const * Buffer::getLanguage() const
467 return params.language;
472 bool Buffer::isLyxClean() const
479 bool Buffer::isBakClean() const
486 void Buffer::markLyxClean() const
492 // if the .lyx file has been saved, we don't need an
499 void Buffer::markBakClean()
506 void Buffer::setUnnamed(bool flag)
513 bool Buffer::isUnnamed()
520 void Buffer::markDirty()
527 DEPCLEAN * tmp = dep_clean;
536 string const & Buffer::fileName() const
543 string const & Buffer::filePath() const
550 bool Buffer::isReadonly() const
557 BufferView * Buffer::getUser() const
564 void Buffer::setParentName(string const & name)
566 params.parentname = name;
572 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b)
574 return a.par == b.par && a.str == b.str;
575 // No need to compare depth.
581 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b)
584 // No need to compare depth.
590 bool operator==(Buffer::inset_iterator const & iter1,
591 Buffer::inset_iterator const & iter2)
593 return iter1.par == iter2.par
594 && (iter1.par == 0 || iter1.it == iter2.it);
600 bool operator!=(Buffer::inset_iterator const & iter1,
601 Buffer::inset_iterator const & iter2)
603 return !(iter1 == iter2);