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.
60 explicit Buffer(string const & file, bool b = false);
65 /** save the buffer's parameters as user default
66 This function saves a file #user_lyxdir/templates/defaults.lyx#
67 which parameters are those of the current buffer. This file
68 is used as a default template when creating a new
69 file. Returns #true# on success.
71 bool saveParamsAsDefaults();
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);
81 /// and have an xtl buffer to work with.
82 bool Dispatch(int, auto_mem_buffer &);
84 /// should be changed to work for a list.
87 void resizeInsets(BufferView *);
89 /// Update window titles of all users
90 void updateTitles() const;
92 /// Reset autosave timers for all users
93 void resetAutosaveTimers() const;
95 /** Adds the BufferView to the users list.
96 Later this func will insert the #BufferView# into a real list,
97 not just setting a pointer.
99 void addUser(BufferView * u) { users = u; }
101 /** Removes the #BufferView# from the users list.
102 Since we only can have one at the moment, we just reset it.
104 void delUser(BufferView *) { users = 0; }
110 //users->updateScrollbar();
114 void loadAutoSaveFile();
117 @param par if != 0 insert the file.
118 @return #false# if method fails.
120 bool readFile(LyXLex &, LyXParagraph * par = 0);
122 /** Reads a file without header.
123 @param par if != 0 insert the file.
124 @return false if file is not completely read.
126 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
128 /// This parses a single LyXformat-Token.
129 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
130 LyXParagraph *& return_par,
131 string const & token, int & pos,
132 char & depth, LyXFont &
134 ,LyXParagraph::footnote_flag &,
135 LyXParagraph::footnote_kind &
139 /// Parse a single inset.
140 void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
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);
154 void writeFileAscii(std::ostream &, int);
156 string const asciiParagraph(LyXParagraph const *,
157 unsigned int linelen) const;
159 void makeLaTeXFile(string const & filename,
160 string const & original_path,
161 bool nice, bool only_body = false);
162 /** LaTeX all paragraphs from par to endpar.
163 @param endpar if == 0 then to the end
165 void latexParagraphs(std::ostream & os, LyXParagraph * par,
166 LyXParagraph * endpar, TexRow & texrow) const;
178 void makeLinuxDocFile(string const & filename,
179 bool nice, bool only_body = false);
181 void makeDocBookFile(string const & filename,
182 bool nice, bool only_body = false);
184 /// returns the main language for the buffer (document)
185 string const GetLanguage() const {
186 return params.language;
190 bool isLyxClean() const { return lyx_clean; }
193 bool isNwClean() const { return nw_clean; }
196 bool isBakClean() const { return bak_clean; }
199 bool isDepClean(string const & name) const;
202 void markLyxClean() const {
207 // if the .lyx file has been saved, we don't need an
213 void markNwClean() { nw_clean = true; }
216 void markBakClean() { bak_clean = true; }
219 void markDepClean(string const & name);
222 void markNwDirty() { nw_clean = false; }
225 void setUnnamed(bool flag=true) { unnamed = flag; }
228 bool isUnnamed() { return unnamed; }
238 DEPCLEAN * tmp = dep_clean;
246 string const & fileName() const { return filename; }
248 /** A transformed version of the file name, adequate for LaTeX
249 The path is stripped if no_path is true (default)
251 string const getLatexName(bool no_path = true) const;
253 /// Change name of buffer. Updates "read-only" flag.
254 void fileName(string const & newfile);
256 /// Name of the document's parent
257 void setParentName(string const &);
259 /// Is buffer read-only?
260 bool isReadonly() const { return read_only; }
262 /// Set buffer read-only flag
263 void setReadonly(bool flag = true);
265 /// returns #true# if the buffer contains a LaTeX document
266 bool isLatex() const;
267 /// returns #true# if the buffer contains a LinuxDoc document
268 bool isLinuxDoc() const;
269 /// returns #true# if the buffer contains a DocBook document
270 bool isDocBook() const;
271 /** returns #true# if the buffer contains either a LinuxDoc
272 or DocBook document */
274 /// returns #true# if the buffer contains a Wed document
275 bool isLiterate() const;
278 void setPaperStuff();
280 /** Validate a buffer for LaTeX.
281 This validates the buffer, and returns a struct for use by
282 #makeLaTeX# and others. Its main use is to figure out what
283 commands and packages need to be included in the LaTeX file.
284 It (should) also check that the needed constructs are there
285 (i.e. that the \refs points to coresponding \labels). It
286 should perhaps inset "error" insets to help the user correct
289 void validate(LaTeXFeatures &) const;
292 string const getIncludeonlyList(char delim = ',');
294 std::vector<std::pair<string,string> > const getBibkeyList();
316 std::vector<std::vector<TocItem> > const getTocList();
318 std::vector<string> const getLabelList();
320 /** This will clearly have to change later. Later we can have more
321 than one user per buffer. */
322 BufferView * getUser() const { return users; }
325 void ChangeLanguage(Language const * from, Language const * to);
327 bool isMultiLingual();
329 /// Does this mean that this is buffer local?
332 /// Does this mean that this is buffer local?
338 /** is a list of paragraphs.
340 LyXParagraph * paragraph;
345 /// where the temporaries go if we want them
351 /** While writing as LaTeX, tells whether we are
352 doing a 'nice' LaTeX file */
355 /// Used when typesetting to place errorboxes.
360 void linuxDocHandleFootnote(std::ostream & os,
361 LyXParagraph * & par, int const depth);
364 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
365 int const depth, int desc_on,
366 LyXParagraph * & par);
369 void DocBookHandleFootnote(std::ostream & os,
370 LyXParagraph * & par, int const depth);
373 void sgmlOpenTag(std::ostream & os, int depth,
374 string const & latexname) const;
376 void sgmlCloseTag(std::ostream & os, int depth,
377 string const & latexname) const;
379 void LinuxDocError(LyXParagraph * par, int pos,
380 string const & message);
382 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
383 int desc_on, int const depth);
385 void SimpleDocBookOnePar(std::ostream &, string & extra,
386 LyXParagraph * par, int & desc_on,
390 void push_tag(std::ostream & os, string const & tag,
391 int & pos, char stack[5][3]);
394 void pop_tag(std::ostream & os, string const & tag,
395 int & pos, char stack[5][3]);
398 mutable bool lyx_clean;
400 /// is autosave needed
401 mutable bool bak_clean;
403 /// do we need to run weave/tangle
406 /// is this a unnamed file (New...)
409 /// is regenerating #.tex# necessary
410 DEPCLEAN * dep_clean;
415 /// name of the file the buffer is associated with.
418 /// Format number of buffer
421 /** A list of views using this buffer.
422 Why not keep a list of the BufferViews that use this buffer?
424 At least then we don't have to do a lot of magic like:
425 #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
426 of the buffers in the list of users to do a #updateLayoutChoice#.
432 class inset_iterator {
435 inset_iterator() : par(0) /*, it(0)*/ {}
437 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
441 inset_iterator(LyXParagraph * paragraph,
442 LyXParagraph::size_type pos);
444 inset_iterator & operator++() {
447 if (it == par->inset_iterator_end()) {
455 Inset * operator*() {return *it; }
457 LyXParagraph * getPar() { return par; }
459 LyXParagraph::size_type getPos() {return it.getPos(); }
462 bool operator==(inset_iterator const & iter1,
463 inset_iterator const & iter2);
466 //bool operator!=(inset_iterator const & iter1,
467 // inset_iterator const & iter2);
474 LyXParagraph::inset_iterator it;
478 inset_iterator inset_iterator_begin() {
479 return inset_iterator(paragraph);
482 inset_iterator inset_iterator_end() {
483 return inset_iterator();
489 void Buffer::setParentName(string const & name)
491 params.parentname = name;
496 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
497 return a.par == b.par && a.str == b.str;
498 // No need to compare depth.
504 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
506 // No need to compare depth.
511 bool operator==(Buffer::inset_iterator const & iter1,
512 Buffer::inset_iterator const & iter2) {
513 return iter1.par == iter2.par
514 && (iter1.par == 0 || iter1.it == iter2.it);
519 bool operator!=(Buffer::inset_iterator const & iter1,
520 Buffer::inset_iterator const & iter2) {
521 return !(iter1 == iter2);