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"
41 extern void updateAllVisibleBufferRelatedPopups();
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 /**@name Constructors and destructor */
63 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 void Dispatch(string const & command);
85 /// Maybe we know the function already by number...
86 void Dispatch(int ac, string const & argument);
88 /// should be changed to work for a list.
95 /// Update window titles of all users
96 void updateTitles() const;
98 /// Reset autosave timers for all users
99 void resetAutosaveTimers() const;
101 /** Adds the BufferView to the users list.
102 Later this func will insert the BufferView into a real list,
103 not just setting a pointer.
105 void addUser(BufferView * u) { users = u; }
107 /** Removes the BufferView from the users list.
108 Since we only can have one at the moment, we just reset it.
110 void delUser(BufferView *) { users = 0; }
116 //users->updateScrollbar();
120 void loadAutoSaveFile();
123 Returns false if it fails.
124 If par is given, the file is inserted. */
125 bool readFile(LyXLex &, LyXParagraph * par = 0);
127 /** Reads a file without header.
128 Returns false, if file is not completely read.
129 If par is given, the file is inserted. */
130 bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
132 /* This parses a single LyXformat-Token */
133 bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
134 LyXParagraph *& return_par,
135 string const & token, int & pos,
136 char & depth, LyXFont &,
137 LyXParagraph::footnote_flag &,
138 LyXParagraph::footnote_kind &);
141 Takes care of auto-save files and backup file if requested.
142 Returns true if the save is successful, false otherwise.
146 /// Write file. Returns false if unsuccesful.
147 bool writeFile(string const &, bool) const;
150 void writeFileAscii(string const & , int);
153 void makeLaTeXFile(string const & filename,
154 string const & original_path,
155 bool nice, bool only_body = false);
170 void makeLinuxDocFile(string const & filename, int column);
172 void makeDocBookFile(string const & filename, int column);
174 /// returns the main language for the buffer (document)
175 string GetLanguage() const {
176 return params.language;
180 bool isLyxClean() const { return lyx_clean; }
182 /// changed Heinrich Bauer, 23/03/98
183 bool isDviClean() const;
186 bool isNwClean() const { return nw_clean; }
189 bool isBakClean() const { return bak_clean; }
192 bool isDepClean(string const & name) const;
195 void markLyxClean() const {
200 // if the .lyx file has been saved, we don't need an
205 /// changed Heinrich Bauer, 23/03/98
209 void markNwClean() { nw_clean = true; }
212 void markBakClean() { bak_clean = true; }
215 void markDepClean(string const & name);
221 void markNwDirty() { nw_clean = false; }
229 dvi_clean_tmpd = false;
230 dvi_clean_orgd = false;
233 DEPCLEAN * tmp = dep_clean;
241 string const & fileName() const { return filename; }
243 /** A transformed version of the file name, adequate for LaTeX
244 The path is stripped if no_path is true (default) */
245 string getLatexName(bool no_path = true) const;
247 /// Change name of buffer. Updates "read-only" flag.
248 void fileName(string const & newfile);
250 /// Name of the document's parent
251 void setParentName(string const &);
253 /// Is buffer read-only?
254 bool isReadonly() const { return read_only; }
256 /// Set buffer read-only flag
257 void setReadonly(bool flag = true);
259 /// returns true if the buffer contains a LaTeX document
260 bool isLatex() const;
261 /// returns true if the buffer contains a LinuxDoc document
262 bool isLinuxDoc() const;
263 /// returns true if the buffer contains a DocBook document
264 bool isDocBook() const;
265 /** returns true if the buffer contains either a LinuxDoc
266 or DocBook document */
268 /// returns true if the buffer contains a Wed document
269 bool isLiterate() const;
272 void setPaperStuff();
274 /** Validate a buffer for LaTeX.
275 This validates the buffer, and returns a struct for use by
276 makeLaTeX and others. Its main use is to figure out what
277 commands and packages need to be included in the LaTeX file.
278 It (should) also check that the needed constructs are there
279 (i.e. that the \refs points to coresponding \labels). It
280 should perhaps inset "error" insets to help the user correct
283 void validate(LaTeXFeatures &) const;
286 string getIncludeonlyList(char delim = ',');
288 string getReferenceList(char delim = '|');
290 string getBibkeyList(char delim = '|');
292 /** This will clearly have to change later. Later we can have more
293 than one user per buffer. */
294 BufferView * getUser() const { return users; }
297 void ChangeLanguage(Language const * from, Language const * to);
299 bool isMultiLingual();
303 /// Does this mean that this is buffer local?
306 /// Does this mean that this is buffer local?
312 /** is a list of paragraphs.
314 LyXParagraph * paragraph;
319 /// where the temporaries go if we want them
325 /** While writing as LaTeX, tells whether we are
326 doing a 'nice' LaTeX file */
329 /// Used when typesetting to place errorboxes.
333 void linuxDocHandleFootnote(std::ostream & os,
334 LyXParagraph * & par, int const depth);
336 void DocBookHandleCaption(std::ostream & os, string & inner_tag,
337 int const depth, int desc_on,
338 LyXParagraph * & par);
340 void DocBookHandleFootnote(std::ostream & os,
341 LyXParagraph * & par, int const depth);
343 void sgmlOpenTag(std::ostream & os, int depth,
344 string const & latexname) const;
346 void sgmlCloseTag(std::ostream & os, int depth,
347 string const & latexname) const;
349 void LinuxDocError(LyXParagraph * par, int pos, char const * message);
351 void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
352 int desc_on, int const depth);
354 void SimpleDocBookOnePar(std::ostream &, string & extra,
355 LyXParagraph * par, int & desc_on,
359 void push_tag(std::ostream & os, char const * tag,
360 int & pos, char stack[5][3]);
363 void pop_tag(std::ostream & os, char const * tag,
364 int & pos, char stack[5][3]);
368 void RoffAsciiTable(std::ostream &, LyXParagraph * par);
372 mutable bool lyx_clean;
374 /// is autosave needed
375 mutable bool bak_clean;
377 /** do we need to run LaTeX, changed 23/03/98, Heinrich Bauer
378 We have to distinguish between TeX-runs executed in the original
379 directory (in which the original LyX-file resides) and TeX-runs
380 executed in a temporary directory. The first situation is valid
381 for a dvi-export, the latter one for printing or previewing. */
385 /// do we need to run weave/tangle
388 /// is regenerating .tex necessary
389 DEPCLEAN * dep_clean;
394 /// name of the file the buffer is associated with.
397 /// Format number of buffer
400 /** A list of views using this buffer.
401 Why not keep a list of the BufferViews that use this buffer?
403 At least then we don't have to do a lot of magic like:
404 buffer->lyx_gui->bufferview->updateLayoutChoice. Just ask each
405 of the buffers in the list of users to do a updateLayoutChoice.
412 void Buffer::setParentName(string const & name)
414 params.parentname = name;