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 void insertErtContents(Paragraph * par, int & pos,
131 bool set_inactive = true);
134 Paragraph * getParFromID(int id) const;
136 /// Parse a single inset.
137 void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
140 Takes care of auto-save files and backup file if requested.
141 Returns \c true if the save is successful, \c false otherwise.
145 /// Write file. Returns \c false if unsuccesful.
146 bool writeFile(string const &, bool) const;
149 void writeFileAscii(string const & , int);
151 void writeFileAscii(std::ostream &, int);
153 string const asciiParagraph(Paragraph const *, unsigned int linelen,
154 bool noparbreak = false) const;
156 void makeLaTeXFile(string const & filename,
157 string const & original_path,
158 bool nice, bool only_body = false);
159 /** LaTeX all paragraphs from par to endpar.
160 \param \a endpar if == 0 then to the end
162 void latexParagraphs(std::ostream & os, Paragraph * par,
163 Paragraph * endpar, TexRow & texrow) const;
165 void simpleDocBookOnePar(std::ostream &,
166 Paragraph * par, int & desc_on,
167 Paragraph::depth_type depth) const ;
169 void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
170 Paragraph::depth_type depth);
172 void makeLinuxDocFile(string const & filename,
173 bool nice, bool only_body = false);
175 void makeDocBookFile(string const & filename,
176 bool nice, bool only_body = false);
177 /// Open SGML/XML tag.
178 void sgmlOpenTag(std::ostream & os, Paragraph::depth_type depth,
179 string const & latexname) const;
180 /// Closes SGML/XML tag.
181 void sgmlCloseTag(std::ostream & os, Paragraph::depth_type depth,
182 string const & latexname) const;
184 void sgmlError(Paragraph * par, int pos, string const & message) const;
186 /// returns the main language for the buffer (document)
187 Language const * getLanguage() const;
191 bool isLyxClean() const;
193 bool isBakClean() const;
195 bool isDepClean(string const & name) const;
198 void markLyxClean() const;
204 void markDepClean(string const & name);
207 void setUnnamed(bool flag = true);
212 /// Mark this buffer as dirty.
215 /// Returns the buffer's filename. It is always an absolute path.
216 string const & fileName() const;
218 /// Returns the the path where the buffer lives.
219 /// It is always an absolute path.
220 string const & filePath() const;
222 /** A transformed version of the file name, adequate for LaTeX.
223 \param no_path optional if \c true then the path is stripped.
225 string const getLatexName(bool no_path = true) const;
227 /// Get the name and type of the log.
228 std::pair<LogType, string> const getLogName() const;
230 /// Change name of buffer. Updates "read-only" flag.
231 void setFileName(string const & newfile);
233 /// Name of the document's parent
234 void setParentName(string const &);
236 /// Is buffer read-only?
237 bool isReadonly() const;
239 /// Set buffer read-only flag
240 void setReadonly(bool flag = true);
242 /// returns \c true if the buffer contains a LaTeX document
243 bool isLatex() const;
244 /// returns \c true if the buffer contains a LinuxDoc document
245 bool isLinuxDoc() const;
246 /// returns \c true if the buffer contains a DocBook document
247 bool isDocBook() const;
248 /** returns \c true if the buffer contains either a LinuxDoc
249 or DocBook document */
251 /// returns \c true if the buffer contains a Wed document
252 bool isLiterate() const;
254 /** Validate a buffer for LaTeX.
255 This validates the buffer, and returns a struct for use by
256 #makeLaTeX# and others. Its main use is to figure out what
257 commands and packages need to be included in the LaTeX file.
258 It (should) also check that the needed constructs are there
259 (i.e. that the \refs points to coresponding \labels). It
260 should perhaps inset "error" insets to help the user correct
263 void validate(LaTeXFeatures &) const;
266 string const getIncludeonlyList(char delim = ',');
268 std::vector<std::pair<string, string> > const getBibkeyList();
271 TocItem(Paragraph * p, int d, string const & s)
272 : par(p), depth(d), str(s) {}
281 typedef std::vector<TocItem> SingleList;
283 typedef std::map<string, SingleList> Lists;
285 Lists const getLists() const;
287 std::vector<string> const getLabelList();
289 /** This will clearly have to change later. Later we can have more
290 than one user per buffer. */
291 BufferView * getUser() const;
294 void changeLanguage(Language const * from, Language const * to);
296 bool isMultiLingual();
298 /// Does this mean that this is buffer local?
301 /// Does this mean that this is buffer local?
307 /** The list of paragraphs.
308 This is a linked list of paragraph, this list holds the
309 whole contents of the document.
311 Paragraph * paragraph;
313 /// LyX version control object.
316 /// Where to put temporary files.
319 /** If we are writing a nice LaTeX file or not.
320 While writing as LaTeX, tells whether we are
321 doing a 'nice' LaTeX file */
324 /// Used when typesetting to place errorboxes.
328 mutable bool lyx_clean;
330 /// is autosave needed
331 mutable bool bak_clean;
333 /// is this a unnamed file (New...)
336 /// is regenerating #.tex# necessary
337 DEPCLEAN * dep_clean;
342 /// name of the file the buffer is associated with.
345 /// The path to the document file.
348 /// Format number of buffer
350 /** A list of views using this buffer.
351 Why not keep a list of the BufferViews that use this buffer?
353 At least then we don't have to do a lot of magic like:
354 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
355 of the buffers in the list of users to do a #updateLayoutChoice#.
361 class inset_iterator {
363 typedef std::input_iterator_tag iterator_category;
364 typedef Inset value_type;
365 typedef ptrdiff_t difference_type;
366 typedef Inset * pointer;
367 typedef Inset & reference;
371 inset_iterator() : par(0) /*, it(0)*/ {}
373 inset_iterator(Paragraph * paragraph) : par(paragraph) {
377 inset_iterator(Paragraph * paragraph, lyx::pos_type pos);
379 inset_iterator & operator++() { // prefix ++
382 if (it == par->inset_iterator_end()) {
390 inset_iterator operator++(int) { // postfix ++
391 inset_iterator tmp(par, it.getPos());
394 if (it == par->inset_iterator_end()) {
402 Inset * operator*() { return *it; }
405 Paragraph * getPar() { return par; }
407 lyx::pos_type getPos() const { return it.getPos(); }
410 bool operator==(inset_iterator const & iter1,
411 inset_iterator const & iter2);
418 Paragraph::inset_iterator it;
422 inset_iterator inset_iterator_begin() {
423 return inset_iterator(paragraph);
426 inset_iterator inset_iterator_end() {
427 return inset_iterator();
430 inset_iterator inset_const_iterator_begin() const {
431 return inset_iterator(paragraph);
434 inset_iterator inset_const_iterator_end() const {
435 return inset_iterator();
439 ParIterator par_iterator_begin();
441 ParIterator par_iterator_end();
444 Inset * getInsetFromID(int id_arg) const;
449 void Buffer::addUser(BufferView * u)
456 void Buffer::delUser(BufferView *)
463 Language const * Buffer::getLanguage() const
465 return params.language;
470 bool Buffer::isLyxClean() const
477 bool Buffer::isBakClean() const
484 void Buffer::markLyxClean() const
490 // if the .lyx file has been saved, we don't need an
497 void Buffer::markBakClean()
504 void Buffer::setUnnamed(bool flag)
511 bool Buffer::isUnnamed()
518 void Buffer::markDirty()
525 DEPCLEAN * tmp = dep_clean;
534 string const & Buffer::fileName() const
541 string const & Buffer::filePath() const
548 bool Buffer::isReadonly() const
555 BufferView * Buffer::getUser() const
562 void Buffer::setParentName(string const & name)
564 params.parentname = name;
570 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b)
572 return a.par == b.par && a.str == b.str;
573 // No need to compare depth.
579 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b)
582 // No need to compare depth.
588 bool operator==(Buffer::inset_iterator const & iter1,
589 Buffer::inset_iterator const & iter2)
591 return iter1.par == iter2.par
592 && (iter1.par == 0 || iter1.it == iter2.it);
598 bool operator!=(Buffer::inset_iterator const & iter1,
599 Buffer::inset_iterator const & iter2)
601 return !(iter1 == iter2);