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;
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.
59 /**@name Constructors and destructor */
62 explicit Buffer(string const & file, bool b = false);
71 /** save the buffer's parameters as user default
72 This function saves a file user_lyxdir/templates/defaults.lyx
73 which parameters are those of the current buffer. This file
74 is used as a default template when creating a new
75 file. Returns true on success.
77 bool saveParamsAsDefaults();
79 /** high-level interface to buffer functionality
80 This function parses a command string and executes it
82 bool Dispatch(string const & command);
84 /// Maybe we know the function already by number...
85 bool Dispatch(int ac, string const & argument);
87 /// and have an xtl buffer to work with.
88 bool Dispatch(int, auto_mem_buffer &);
90 /// should be changed to work for a list.
97 /// Update window titles of all users
98 void updateTitles() const;
100 /// Reset autosave timers for all users
101 void resetAutosaveTimers() const;
103 /** Adds the BufferView to the users list.
104 Later this func will insert the BufferView into a real list,
105 not just setting a pointer.
107 void addUser(BufferView * u) { users = u; }
109 /** Removes the BufferView from the users list.
110 Since we only can have one at the moment, we just reset it.
112 void delUser(BufferView *) { users = 0; }
118 //users->updateScrollbar();
122 void loadAutoSaveFile();
125 Returns false if it fails.
126 If par is given, the file is inserted. */
127 bool readFile(LyXLex &, LyXParagraph * par = 0);
129 /** Reads a file without header.
130 Returns false, if file is not completely read.
131 If par is given, the file is inserted. */
132 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
134 /* This parses a single LyXformat-Token */
135 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
136 LyXParagraph *& return_par,
137 string const & token, int & pos,
138 char & depth, LyXFont &,
139 LyXParagraph::footnote_flag &,
140 LyXParagraph::footnote_kind &);
143 Takes care of auto-save files and backup file if requested.
144 Returns true if the save is successful, false otherwise.
148 /// Write file. Returns false if unsuccesful.
149 bool writeFile(string const &, bool) const;
152 void writeFileAscii(string const & , int);
155 void makeLaTeXFile(string const & filename,
156 string const & original_path,
157 bool nice, bool only_body = false);
159 // LaTeX all paragraphs from par to endpar,
160 // if endpar == 0 then to the end
162 void latexParagraphs(std::ostream & os, LyXParagraph *par,
163 LyXParagraph *endpar, TexRow & texrow) const;
178 void makeLinuxDocFile(string const & filename, int column);
180 void makeDocBookFile(string const & filename, int column);
182 /// returns the main language for the buffer (document)
183 string GetLanguage() const {
184 return params.language;
188 bool isLyxClean() const { return lyx_clean; }
191 bool isNwClean() const { return nw_clean; }
194 bool isBakClean() const { return bak_clean; }
197 bool isDepClean(string const & name) const;
200 void markLyxClean() const {
205 // if the .lyx file has been saved, we don't need an
211 void markNwClean() { nw_clean = true; }
214 void markBakClean() { bak_clean = true; }
217 void markDepClean(string const & name);
220 void markNwDirty() { nw_clean = false; }
230 DEPCLEAN * tmp = dep_clean;
238 string const & fileName() const { return filename; }
240 /** A transformed version of the file name, adequate for LaTeX
241 The path is stripped if no_path is true (default) */
242 string getLatexName(bool no_path = true) const;
244 /// Change name of buffer. Updates "read-only" flag.
245 void fileName(string const & newfile);
247 /// Name of the document's parent
248 void setParentName(string const &);
250 /// Is buffer read-only?
251 bool isReadonly() const { return read_only; }
253 /// Set buffer read-only flag
254 void setReadonly(bool flag = true);
256 /// returns true if the buffer contains a LaTeX document
257 bool isLatex() const;
258 /// returns true if the buffer contains a LinuxDoc document
259 bool isLinuxDoc() const;
260 /// returns true if the buffer contains a DocBook document
261 bool isDocBook() const;
262 /** returns true if the buffer contains either a LinuxDoc
263 or DocBook document */
265 /// returns true if the buffer contains a Wed document
266 bool isLiterate() const;
269 void setPaperStuff();
271 /** Validate a buffer for LaTeX.
272 This validates the buffer, and returns a struct for use by
273 makeLaTeX and others. Its main use is to figure out what
274 commands and packages need to be included in the LaTeX file.
275 It (should) also check that the needed constructs are there
276 (i.e. that the \refs points to coresponding \labels). It
277 should perhaps inset "error" insets to help the user correct
280 void validate(LaTeXFeatures &) const;
283 string getIncludeonlyList(char delim = ',');
285 std::vector<std::pair<string,string> > getBibkeyList();
304 std::vector<std::vector<TocItem> > getTocList();
306 std::vector<string> getLabelList();
308 /** This will clearly have to change later. Later we can have more
309 than one user per buffer. */
310 BufferView * getUser() const { return users; }
313 void ChangeLanguage(Language const * from, Language const * to);
315 bool isMultiLingual();
319 /// Does this mean that this is buffer local?
322 /// Does this mean that this is buffer local?
328 /** is a list of paragraphs.
330 LyXParagraph * paragraph;
335 /// where the temporaries go if we want them
341 /** While writing as LaTeX, tells whether we are
342 doing a 'nice' LaTeX file */
345 /// Used when typesetting to place errorboxes.
349 void linuxDocHandleFootnote(std::ostream & os,
350 LyXParagraph * & par, int const depth);
352 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
353 int const depth, int desc_on,
354 LyXParagraph * & par);
356 void DocBookHandleFootnote(std::ostream & os,
357 LyXParagraph * & par, int const depth);
359 void sgmlOpenTag(std::ostream & os, int depth,
360 string const & latexname) const;
362 void sgmlCloseTag(std::ostream & os, int depth,
363 string const & latexname) const;
365 void LinuxDocError(LyXParagraph * par, int pos, char const * message);
367 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
368 int desc_on, int const depth);
370 void SimpleDocBookOnePar(std::ostream &, string & extra,
371 LyXParagraph * par, int & desc_on,
375 void push_tag(std::ostream & os, char const * tag,
376 int & pos, char stack[5][3]);
379 void pop_tag(std::ostream & os, char const * tag,
380 int & pos, char stack[5][3]);
384 void RoffAsciiTable(std::ostream &, LyXParagraph * par);
388 mutable bool lyx_clean;
390 /// is autosave needed
391 mutable bool bak_clean;
393 /// do we need to run weave/tangle
396 /// is regenerating .tex necessary
397 DEPCLEAN * dep_clean;
402 /// name of the file the buffer is associated with.
405 /// Format number of buffer
408 /** A list of views using this buffer.
409 Why not keep a list of the BufferViews that use this buffer?
411 At least then we don't have to do a lot of magic like:
412 buffer->lyx_gui->bufferview->updateLayoutChoice. Just ask each
413 of the buffers in the list of users to do a updateLayoutChoice.
418 class inset_iterator {
420 inset_iterator() : par(0) /*, it(0)*/ {}
421 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
424 inset_iterator(LyXParagraph * paragraph, LyXParagraph::size_type pos);
425 inset_iterator & operator++() {
428 if (it == par->inset_iterator_end()) {
435 Inset * operator*() {return *it; }
436 LyXParagraph * getPar() { return par; }
437 LyXParagraph::size_type getPos() {return it.getPos(); }
439 bool operator==(inset_iterator const & iter1,
440 inset_iterator const & iter2) {
441 return iter1.par == iter2.par
442 && (iter1.par == 0 || iter1.it == iter2.it);
445 bool operator!=(inset_iterator const & iter1,
446 inset_iterator const & iter2) {
447 return !(iter1 == iter2);
452 LyXParagraph::inset_iterator it;
456 inset_iterator inset_iterator_begin() {
457 return inset_iterator(paragraph);
460 inset_iterator inset_iterator_end() {
461 return inset_iterator();
467 void Buffer::setParentName(string const & name)
469 params.parentname = name;
473 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
474 return a.par == b.par && a.str == b.str;
475 // No need to compare depth.
480 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
482 // No need to compare depth.