2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
8 * This file is Copyleft 1996
11 * ====================================================== */
15 // 23/03/98 Heinrich Bauer (heinrich.bauer@t-mobil.de)
16 // Spots marked "changed Heinrich Bauer, 23/03/98" modified due to the
17 // following bug: dvi file export did not work after printing (or previewing)
18 // and vice versa as long as the same file was concerned. This happened
19 // every time the LyX-file was left unchanged between the two actions mentioned
31 #include "BufferView.h"
33 #include "bufferparams.h"
52 /** The buffer object.
53 The is is the buffer object. It contains all the informations about
54 a document loaded into LyX. I am not sure if the class is complete or
55 minimal, probably not.
56 \author Lars Gullik Bjønnes
60 /// What type of log will \c getLogName() return?
62 latexlog, ///< LaTeX log
63 buildlog ///< Literate build log
68 \param b optional \c false by default
70 explicit Buffer(string const & file, bool b = false);
75 /** Save the buffer's parameters as user default.
76 This function saves a file \c user_lyxdir/templates/defaults.lyx
77 which parameters are those of the current buffer. This file
78 is used as a default template when creating a new
79 file. Returns \c true on success.
81 bool saveParamsAsDefaults();
83 /** High-level interface to buffer functionality.
84 This function parses a command string and executes it
86 bool Dispatch(string const & command);
88 /// Maybe we know the function already by number...
89 bool Dispatch(int ac, string const & argument);
91 /// Should be changed to work for a list.
94 void resizeInsets(BufferView *);
96 /// Update window titles of all users.
97 void updateTitles() const;
99 /// Reset autosave timers for all users.
100 void resetAutosaveTimers() const;
102 /** Adds the BufferView to the users list.
103 Later this func will insert the \c BufferView into a real list,
104 not just setting a pointer.
106 void addUser(BufferView * u);
108 /** Removes the #BufferView# from the users list.
109 Since we only can have one at the moment, we just reset it.
111 void delUser(BufferView *);
116 /// Load the autosaved file.
117 void loadAutoSaveFile();
120 \param par if != 0 insert the file.
121 \return \c false if method fails.
123 bool readFile(LyXLex &, LyXParagraph * par = 0);
125 /** Reads a file without header.
126 \param par if != 0 insert the file.
127 \return \c false if file is not completely read.
129 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
131 /// This parses a single LyXformat-Token.
132 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
133 LyXParagraph *& return_par,
134 string const & token, int & pos,
135 char & depth, LyXFont &);
137 /// Parse a single inset.
138 void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
141 Takes care of auto-save files and backup file if requested.
142 Returns \c true if the save is successful, \c false otherwise.
146 /// Write file. Returns \c false if unsuccesful.
147 bool writeFile(string const &, bool) const;
150 void writeFileAscii(string const & , int);
152 void writeFileAscii(std::ostream &, int);
154 string const asciiParagraph(LyXParagraph const *,
155 unsigned int linelen) const;
157 void makeLaTeXFile(string const & filename,
158 string const & original_path,
159 bool nice, bool only_body = false);
160 /** LaTeX all paragraphs from par to endpar.
161 \param \a endpar if == 0 then to the end
163 void latexParagraphs(std::ostream & os, LyXParagraph * par,
164 LyXParagraph * endpar, TexRow & texrow) const;
167 void SimpleDocBookOnePar(std::ostream &, string & extra,
168 LyXParagraph * par, int & desc_on,
175 void makeLinuxDocFile(string const & filename,
176 bool nice, bool only_body = false);
178 void makeDocBookFile(string const & filename,
179 bool nice, bool only_body = false);
181 /// returns the main language for the buffer (document)
182 Language const * GetLanguage() const;
184 bool isLyxClean() const;
186 bool isBakClean() const;
188 bool isDepClean(string const & name) const;
191 void markLyxClean() const;
197 void markDepClean(string const & name);
200 void setUnnamed(bool flag=true);
205 /// Mark this buffer as dirty.
208 /// Returns the buffers filename.
209 string const & fileName() const;
211 /** A transformed version of the file name, adequate for LaTeX.
212 \param no_path optional if \c true then the path is stripped.
214 string const getLatexName(bool no_path = true) const;
216 /// Get the name and type of the log.
217 std::pair<LogType, string> const getLogName() const;
219 /// Change name of buffer. Updates "read-only" flag.
220 void setFileName(string const & newfile);
222 /// Name of the document's parent
223 void setParentName(string const &);
225 /// Is buffer read-only?
226 bool isReadonly() const;
228 /// Set buffer read-only flag
229 void setReadonly(bool flag = true);
231 /// returns \c true if the buffer contains a LaTeX document
232 bool isLatex() const;
233 /// returns \c true if the buffer contains a LinuxDoc document
234 bool isLinuxDoc() const;
235 /// returns \c true if the buffer contains a DocBook document
236 bool isDocBook() const;
237 /** returns \c true if the buffer contains either a LinuxDoc
238 or DocBook document */
240 /// returns \c true if the buffer contains a Wed document
241 bool isLiterate() const;
244 void setPaperStuff();
246 /** Validate a buffer for LaTeX.
247 This validates the buffer, and returns a struct for use by
248 #makeLaTeX# and others. Its main use is to figure out what
249 commands and packages need to be included in the LaTeX file.
250 It (should) also check that the needed constructs are there
251 (i.e. that the \refs points to coresponding \labels). It
252 should perhaps inset "error" insets to help the user correct
255 void validate(LaTeXFeatures &) const;
258 string const getIncludeonlyList(char delim = ',');
260 std::vector<std::pair<string, string> > const getBibkeyList();
263 TocItem(LyXParagraph * p, int d, string const & s)
264 : par(p), depth(d), str(s) {}
273 typedef std::vector<TocItem> SingleList;
275 typedef std::map<string, SingleList> Lists;
277 Lists const getLists() const;
279 std::vector<string> const getLabelList();
281 /** This will clearly have to change later. Later we can have more
282 than one user per buffer. */
283 BufferView * getUser() const;
286 void ChangeLanguage(Language const * from, Language const * to);
288 bool isMultiLingual();
290 /// Does this mean that this is buffer local?
293 /// Does this mean that this is buffer local?
299 /** The list of paragraphs.
300 This is a linked list of paragraph, this list holds the
301 whole contents of the document.
303 LyXParagraph * paragraph;
305 /// LyX version control object.
308 /// Where to put temporary files.
311 /// The path to the document file.
314 /** If we are writing a nice LaTeX file or not.
315 While writing as LaTeX, tells whether we are
316 doing a 'nice' LaTeX file */
319 /// Used when typesetting to place errorboxes.
323 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
324 int depth, int desc_on,
325 LyXParagraph * & par);
326 /// Open SGML/XML tag.
327 void sgmlOpenTag(std::ostream & os, int depth,
328 string const & latexname) const;
329 /// Closes SGML/XML tag.
330 void sgmlCloseTag(std::ostream & os, int depth,
331 string const & latexname) const;
333 void LinuxDocError(LyXParagraph * par, int pos,
334 string const & message);
336 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par, int depth);
339 mutable bool lyx_clean;
341 /// is autosave needed
342 mutable bool bak_clean;
344 /// is this a unnamed file (New...)
347 /// is regenerating #.tex# necessary
348 DEPCLEAN * dep_clean;
353 /// name of the file the buffer is associated with.
356 /// Format number of buffer
358 /** A list of views using this buffer.
359 Why not keep a list of the BufferViews that use this buffer?
361 At least then we don't have to do a lot of magic like:
362 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
363 of the buffers in the list of users to do a #updateLayoutChoice#.
369 class inset_iterator {
371 typedef std::input_iterator_tag iterator_category;
372 typedef Inset value_type;
373 typedef ptrdiff_t difference_type;
374 typedef Inset * pointer;
375 typedef Inset & reference;
379 inset_iterator() : par(0) /*, it(0)*/ {}
381 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
385 inset_iterator(LyXParagraph * paragraph,
386 LyXParagraph::size_type pos);
388 inset_iterator & operator++() { // prefix ++
391 if (it == par->inset_iterator_end()) {
399 inset_iterator operator++(int) { // postfix ++
400 inset_iterator tmp(par, it.getPos());
403 if (it == par->inset_iterator_end()) {
411 Inset * operator*() { return *it; }
414 LyXParagraph * getPar() { return par; }
416 LyXParagraph::size_type getPos() const { return it.getPos(); }
419 bool operator==(inset_iterator const & iter1,
420 inset_iterator const & iter2);
427 LyXParagraph::inset_iterator it;
431 inset_iterator inset_iterator_begin() {
432 return inset_iterator(paragraph);
435 inset_iterator inset_iterator_end() {
436 return inset_iterator();
442 void Buffer::addUser(BufferView * u)
449 void Buffer::delUser(BufferView *)
456 void Buffer::redraw()
459 users->fitCursor(users->text);
464 Language const * Buffer::GetLanguage() const
466 return params.language;
471 bool Buffer::isLyxClean() const
478 bool Buffer::isBakClean() const
485 void Buffer::markLyxClean() const
491 // if the .lyx file has been saved, we don't need an
498 void Buffer::markBakClean()
505 void Buffer::setUnnamed(bool flag)
512 bool Buffer::isUnnamed()
519 void Buffer::markDirty()
526 DEPCLEAN * tmp = dep_clean;
535 string const & Buffer::fileName() const
542 bool Buffer::isReadonly() const
549 BufferView * Buffer::getUser() const
556 void Buffer::setParentName(string const & name)
558 params.parentname = name;
564 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
565 return a.par == b.par && a.str == b.str;
566 // No need to compare depth.
572 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
574 // No need to compare depth.
579 bool operator==(Buffer::inset_iterator const & iter1,
580 Buffer::inset_iterator const & iter2) {
581 return iter1.par == iter2.par
582 && (iter1.par == 0 || iter1.it == iter2.it);
587 bool operator!=(Buffer::inset_iterator const & iter1,
588 Buffer::inset_iterator const & iter2) {
589 return !(iter1 == iter2);