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.
92 void resizeInsets(BufferView *);
94 /// Update window titles of all users
95 void updateTitles() const;
97 /// Reset autosave timers for all users
98 void resetAutosaveTimers() const;
100 /** Adds the BufferView to the users list.
101 Later this func will insert the BufferView into a real list,
102 not just setting a pointer.
104 void addUser(BufferView * u) { users = u; }
106 /** Removes the BufferView from the users list.
107 Since we only can have one at the moment, we just reset it.
109 void delUser(BufferView *) { users = 0; }
115 //users->updateScrollbar();
119 void loadAutoSaveFile();
122 Returns false if it fails.
123 If par is given, the file is inserted. */
124 bool readFile(LyXLex &, LyXParagraph * par = 0);
126 /** Reads a file without header.
127 Returns false, if file is not completely read.
128 If par is given, the file is inserted. */
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 ,LyXParagraph::footnote_flag &,
138 LyXParagraph::footnote_kind &
142 // Parse a single inset.
143 void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
146 Takes care of auto-save files and backup file if requested.
147 Returns true if the save is successful, false otherwise.
151 /// Write file. Returns false if unsuccesful.
152 bool writeFile(string const &, bool) const;
155 void writeFileAscii(string const & , int);
158 void makeLaTeXFile(string const & filename,
159 string const & original_path,
160 bool nice, bool only_body = false);
162 // LaTeX all paragraphs from par to endpar,
163 // if endpar == 0 then to the end
165 void latexParagraphs(std::ostream & os, LyXParagraph *par,
166 LyXParagraph *endpar, TexRow & texrow) const;
181 void makeLinuxDocFile(string const & filename,
182 bool nice, bool only_body = false);
184 void makeDocBookFile(string const & filename,
185 bool nice, bool only_body = false);
187 /// returns the main language for the buffer (document)
188 string GetLanguage() const {
189 return params.language;
193 bool isLyxClean() const { return lyx_clean; }
196 bool isNwClean() const { return nw_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 markNwClean() { nw_clean = true; }
219 void markBakClean() { bak_clean = true; }
222 void markDepClean(string const & name);
225 void markNwDirty() { nw_clean = false; }
228 void setUnnamed(bool flag=true) { unnamed = flag; }
231 bool isUnnamed() { return unnamed; }
241 DEPCLEAN * tmp = dep_clean;
249 string const & fileName() const { return filename; }
251 /** A transformed version of the file name, adequate for LaTeX
252 The path is stripped if no_path is true (default) */
253 string getLatexName(bool no_path = true) const;
255 /// Change name of buffer. Updates "read-only" flag.
256 void fileName(string const & newfile);
258 /// Name of the document's parent
259 void setParentName(string const &);
261 /// Is buffer read-only?
262 bool isReadonly() const { return read_only; }
264 /// Set buffer read-only flag
265 void setReadonly(bool flag = true);
267 /// returns true if the buffer contains a LaTeX document
268 bool isLatex() const;
269 /// returns true if the buffer contains a LinuxDoc document
270 bool isLinuxDoc() const;
271 /// returns true if the buffer contains a DocBook document
272 bool isDocBook() const;
273 /** returns true if the buffer contains either a LinuxDoc
274 or DocBook document */
276 /// returns true if the buffer contains a Wed document
277 bool isLiterate() const;
280 void setPaperStuff();
282 /** Validate a buffer for LaTeX.
283 This validates the buffer, and returns a struct for use by
284 makeLaTeX and others. Its main use is to figure out what
285 commands and packages need to be included in the LaTeX file.
286 It (should) also check that the needed constructs are there
287 (i.e. that the \refs points to coresponding \labels). It
288 should perhaps inset "error" insets to help the user correct
291 void validate(LaTeXFeatures &) const;
294 string getIncludeonlyList(char delim = ',');
296 std::vector<std::pair<string,string> > getBibkeyList();
315 std::vector<std::vector<TocItem> > getTocList();
317 std::vector<string> 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();
330 /// Does this mean that this is buffer local?
333 /// Does this mean that this is buffer local?
339 /** is a list of paragraphs.
341 LyXParagraph * paragraph;
346 /// where the temporaries go if we want them
352 /** While writing as LaTeX, tells whether we are
353 doing a 'nice' LaTeX file */
356 /// Used when typesetting to place errorboxes.
361 void linuxDocHandleFootnote(std::ostream & os,
362 LyXParagraph * & par, int const depth);
365 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
366 int const depth, int desc_on,
367 LyXParagraph * & par);
370 void DocBookHandleFootnote(std::ostream & os,
371 LyXParagraph * & par, int const depth);
374 void sgmlOpenTag(std::ostream & os, int depth,
375 string const & latexname) const;
377 void sgmlCloseTag(std::ostream & os, int depth,
378 string const & latexname) const;
380 void LinuxDocError(LyXParagraph * par, int pos, char 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, char const * tag,
391 int & pos, char stack[5][3]);
394 void pop_tag(std::ostream & os, char 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.
431 class inset_iterator {
433 inset_iterator() : par(0) /*, it(0)*/ {}
434 inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
437 inset_iterator(LyXParagraph * paragraph, LyXParagraph::size_type pos);
438 inset_iterator & operator++() {
441 if (it == par->inset_iterator_end()) {
448 Inset * operator*() {return *it; }
449 LyXParagraph * getPar() { return par; }
450 LyXParagraph::size_type getPos() {return it.getPos(); }
452 bool operator==(inset_iterator const & iter1,
453 inset_iterator const & iter2) {
454 return iter1.par == iter2.par
455 && (iter1.par == 0 || iter1.it == iter2.it);
458 bool operator!=(inset_iterator const & iter1,
459 inset_iterator const & iter2) {
460 return !(iter1 == iter2);
465 LyXParagraph::inset_iterator it;
469 inset_iterator inset_iterator_begin() {
470 return inset_iterator(paragraph);
473 inset_iterator inset_iterator_end() {
474 return inset_iterator();
480 void Buffer::setParentName(string const & name)
482 params.parentname = name;
486 bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
487 return a.par == b.par && a.str == b.str;
488 // No need to compare depth.
493 bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
495 // No need to compare depth.