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"
40 class auto_mem_buffer;
53 /** The buffer object.
54 The is is the buffer object. It contains all the informations about
55 a document loaded into LyX. I am not sure if the class is complete or
56 minimal, probably not.
60 /// what type of log will getLogName() return ?
62 latexlog, /**< LaTeX log */
63 buildlog /**< Literate build log */
67 explicit Buffer(string const & file, bool b = false);
72 /** save the buffer's parameters as user default
73 This function saves a file #user_lyxdir/templates/defaults.lyx#
74 which parameters are those of the current buffer. This file
75 is used as a default template when creating a new
76 file. Returns #true# on success.
78 bool saveParamsAsDefaults();
80 /** High-level interface to buffer functionality.
81 This function parses a command string and executes it
83 bool Dispatch(string const & command);
85 /// Maybe we know the function already by number...
86 bool Dispatch(int ac, string const & argument);
88 /// and have an xtl buffer to work with.
89 bool Dispatch(int, auto_mem_buffer &);
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 #BufferView# into a real list,
104 not just setting a pointer.
106 void addUser(BufferView * u) { users = 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 *) { users = 0; }
116 users->fitCursor(users->text);
117 //users->updateScrollbar();
121 void loadAutoSaveFile();
124 @param par if != 0 insert the file.
125 @return #false# if method fails.
127 bool readFile(LyXLex &, LyXParagraph * par = 0);
129 /** Reads a file without header.
130 @param par if != 0 insert the file.
131 @return false if file is not completely read.
133 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
135 /// This parses a single LyXformat-Token.
136 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
137 LyXParagraph *& return_par,
138 string const & token, int & pos,
139 char & depth, LyXFont &
141 ,LyXParagraph::footnote_flag &,
142 LyXParagraph::footnote_kind &
146 /// Parse a single inset.
147 void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
150 Takes care of auto-save files and backup file if requested.
151 Returns #true# if the save is successful, #false# otherwise.
155 /// Write file. Returns #false# if unsuccesful.
156 bool writeFile(string const &, bool) const;
159 void writeFileAscii(string const & , int);
161 void writeFileAscii(std::ostream &, int);
163 string const asciiParagraph(LyXParagraph const *,
164 unsigned int linelen) const;
166 void makeLaTeXFile(string const & filename,
167 string const & original_path,
168 bool nice, bool only_body = false);
169 /** LaTeX all paragraphs from par to endpar.
170 @param endpar if == 0 then to the end
172 void latexParagraphs(std::ostream & os, LyXParagraph * par,
173 LyXParagraph * endpar, TexRow & texrow) const;
176 void SimpleDocBookOnePar(std::ostream &, string & extra,
177 LyXParagraph * par, int & desc_on,
184 void makeLinuxDocFile(string const & filename,
185 bool nice, bool only_body = false);
187 void makeDocBookFile(string const & filename,
188 bool nice, bool only_body = false);
190 /// returns the main language for the buffer (document)
191 Language const * GetLanguage() const {
192 return params.language;
196 bool isLyxClean() const { return lyx_clean; }
199 bool isBakClean() const { return bak_clean; }
202 bool isDepClean(string const & name) const;
205 void markLyxClean() const {
210 // if the .lyx file has been saved, we don't need an
216 void markBakClean() { bak_clean = true; }
219 void markDepClean(string const & name);
222 void setUnnamed(bool flag=true) { unnamed = flag; }
225 bool isUnnamed() { return unnamed; }
234 DEPCLEAN * tmp = dep_clean;
242 string const & fileName() const { return filename; }
244 /** A transformed version of the file name, adequate for LaTeX
245 The path is stripped if no_path is true (default)
247 string const getLatexName(bool no_path = true) const;
249 /// get the name and type of the log
250 std::pair<LogType, string> const getLogName(void) const;
252 /// Change name of buffer. Updates "read-only" flag.
253 void setFileName(string const & newfile);
255 /// Name of the document's parent
256 void setParentName(string const &);
258 /// Is buffer read-only?
259 bool isReadonly() const { return read_only; }
261 /// Set buffer read-only flag
262 void setReadonly(bool flag = true);
264 /// returns #true# if the buffer contains a LaTeX document
265 bool isLatex() const;
266 /// returns #true# if the buffer contains a LinuxDoc document
267 bool isLinuxDoc() const;
268 /// returns #true# if the buffer contains a DocBook document
269 bool isDocBook() const;
270 /** returns #true# if the buffer contains either a LinuxDoc
271 or DocBook document */
273 /// returns #true# if the buffer contains a Wed document
274 bool isLiterate() const;
277 void setPaperStuff();
279 /** Validate a buffer for LaTeX.
280 This validates the buffer, and returns a struct for use by
281 #makeLaTeX# and others. Its main use is to figure out what
282 commands and packages need to be included in the LaTeX file.
283 It (should) also check that the needed constructs are there
284 (i.e. that the \refs points to coresponding \labels). It
285 should perhaps inset "error" insets to help the user correct
288 void validate(LaTeXFeatures &) const;
291 string const getIncludeonlyList(char delim = ',');
293 std::vector<std::pair<string,string> > const getBibkeyList();
315 std::vector<std::vector<TocItem> > const getTocList() const;
317 std::vector<string> const getLabelList();
319 /** This will clearly have to change later. Later we can have more
320 than one user per buffer. */
321 BufferView * getUser() const { return users; }
324 void ChangeLanguage(Language const * from, Language const * to);
326 bool isMultiLingual();
328 /// Does this mean that this is buffer local?
331 /// Does this mean that this is buffer local?
337 /** is a list of paragraphs.
339 LyXParagraph * paragraph;
344 /// where the temporaries go if we want them
350 /** While writing as LaTeX, tells whether we are
351 doing a 'nice' LaTeX file */
354 /// Used when typesetting to place errorboxes.
359 void linuxDocHandleFootnote(std::ostream & os,
360 LyXParagraph * & par, int depth);
363 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
364 int depth, int desc_on,
365 LyXParagraph * & par);
368 void DocBookHandleFootnote(std::ostream & os,
369 LyXParagraph * & par, int depth);
372 void sgmlOpenTag(std::ostream & os, int depth,
373 string const & latexname) const;
375 void sgmlCloseTag(std::ostream & os, int depth,
376 string const & latexname) const;
378 void LinuxDocError(LyXParagraph * par, int pos,
379 string const & message);
381 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
382 int desc_on, int depth);
385 void push_tag(std::ostream & os, string const & tag,
386 int & pos, char stack[5][3]);
389 void pop_tag(std::ostream & os, string const & tag,
390 int & pos, char stack[5][3]);
393 mutable bool lyx_clean;
395 /// is autosave needed
396 mutable bool bak_clean;
398 /// is this a unnamed file (New...)
401 /// is regenerating #.tex# necessary
402 DEPCLEAN * dep_clean;
407 /// name of the file the buffer is associated with.
410 /// Format number of buffer
416 /** A list of views using this buffer.
417 Why not keep a list of the BufferViews that use this buffer?
419 At least then we don't have to do a lot of magic like:
420 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
421 of the buffers in the list of users to do a #updateLayoutChoice#.
427 class inset_iterator {
429 typedef std::input_iterator_tag iterator_category;
430 typedef Inset value_type;
431 typedef ptrdiff_t difference_type;
432 typedef Inset * pointer;
433 typedef Inset & reference;
437 inset_iterator() : par(0) /*, it(0)*/ {}
439 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
443 inset_iterator(LyXParagraph * paragraph,
444 LyXParagraph::size_type pos);
446 inset_iterator & operator++() { // prefix ++
449 if (it == par->inset_iterator_end()) {
457 inset_iterator operator++(int) { // postfix ++
458 inset_iterator tmp(par, it.getPos());
461 if (it == par->inset_iterator_end()) {
469 Inset * operator*() { return *it; }
472 LyXParagraph * getPar() { return par; }
474 LyXParagraph::size_type getPos() const { return it.getPos(); }
477 bool operator==(inset_iterator const & iter1,
478 inset_iterator const & iter2);
481 //bool operator!=(inset_iterator const & iter1,
482 // inset_iterator const & iter2);
489 LyXParagraph::inset_iterator it;
493 inset_iterator inset_iterator_begin() {
494 return inset_iterator(paragraph);
497 inset_iterator inset_iterator_end() {
498 return inset_iterator();
504 void Buffer::setParentName(string const & name)
506 params.parentname = name;
511 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
512 return a.par == b.par && a.str == b.str;
513 // No need to compare depth.
519 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
521 // No need to compare depth.
526 bool operator==(Buffer::inset_iterator const & iter1,
527 Buffer::inset_iterator const & iter2) {
528 return iter1.par == iter2.par
529 && (iter1.par == 0 || iter1.it == iter2.it);
534 bool operator!=(Buffer::inset_iterator const & iter1,
535 Buffer::inset_iterator const & iter2) {
536 return !(iter1 == iter2);