]> git.lyx.org Git - lyx.git/blob - src/buffer.C
Angus's FormBase patch with tiny cleanup
[lyx.git] / src / buffer.C
1 /* This file is part of
2  * ====================================================== 
3  * 
4  *           LyX, The Document Processor
5  *
6  *           Copyright 1995 Matthias Ettrich
7  *           Copyright 1995-2000 The LyX Team.
8  *
9  *           This file is Copyright 1996-1999
10  *           Lars Gullik Bjønnes
11  *
12  * ====================================================== 
13  */
14
15 #include <config.h>
16
17 #include <fstream>
18 #include <iomanip>
19
20 #include <cstdlib>
21 #include <unistd.h>
22 #include <sys/types.h>
23 #include <utime.h>
24
25 #include <algorithm>
26
27 #ifdef HAVE_LOCALE
28 #include <locale>
29 #endif
30
31 #ifdef __GNUG__
32 #pragma implementation "buffer.h"
33 #endif
34
35 #include "buffer.h"
36 #include "bufferlist.h"
37 #include "lyx_main.h"
38 #include "lyx_gui_misc.h"
39 #include "LyXAction.h"
40 #include "lyxrc.h"
41 #include "lyxlex.h"
42 #include "tex-strings.h"
43 #include "layout.h"
44 #include "bufferview_funcs.h"
45 #include "minibuffer.h"
46 #include "lyxfont.h"
47 #include "version.h"
48 #include "mathed/formulamacro.h"
49 #include "insets/lyxinset.h"
50 #include "insets/inseterror.h"
51 #include "insets/insetlabel.h"
52 #include "insets/insetref.h"
53 #include "insets/inseturl.h"
54 #include "insets/insetinfo.h"
55 #include "insets/insetquotes.h"
56 #include "insets/insetlatexaccent.h"
57 #include "insets/insetbib.h" 
58 #include "insets/insetcite.h" 
59 #include "insets/insetexternal.h"
60 #include "insets/insetindex.h" 
61 #include "insets/insetinclude.h"
62 #include "insets/insettoc.h"
63 #include "insets/insetparent.h"
64 #include "insets/insetspecialchar.h"
65 #include "insets/figinset.h"
66 #include "insets/insettext.h"
67 #include "insets/insetert.h"
68 #include "insets/insetgraphics.h"
69 #include "insets/insetfoot.h"
70 #include "insets/insetmarginal.h"
71 #include "insets/insetminipage.h"
72 #include "insets/insetfloat.h"
73 #include "insets/insetlist.h"
74 #include "insets/insettabular.h"
75 #include "insets/insettheorem.h"
76 #include "insets/insetcaption.h"
77 #include "support/filetools.h"
78 #include "support/path.h"
79 #include "LaTeX.h"
80 #include "Literate.h"
81 #include "Chktex.h"
82 #include "LyXView.h"
83 #include "debug.h"
84 #include "LaTeXFeatures.h"
85 #include "support/syscall.h"
86 #include "support/lyxlib.h"
87 #include "support/FileInfo.h"
88 #include "lyxtext.h"
89 #include "gettext.h"
90 #include "language.h"
91 #include "lyx_gui_misc.h"       // WarnReadonly()
92 #include "frontends/Dialogs.h"
93 #include "encoding.h"
94 #include "exporter.h"
95 #include "Lsstream.h"
96
97 using std::ostream;
98 using std::ofstream;
99 using std::ifstream;
100 using std::fstream;
101 using std::ios;
102 using std::setw;
103 using std::endl;
104 using std::pair;
105 using std::vector;
106 using std::max;
107 using std::set;
108 using std::istringstream;
109
110 // all these externs should eventually be removed.
111 extern BufferList bufferlist;
112
113 extern LyXAction lyxaction;
114
115
116 static const float LYX_FORMAT = 2.17;
117
118 extern int tex_code_break_column;
119
120
121 Buffer::Buffer(string const & file, bool ronly)
122 {
123         lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
124         filename = file;
125         filepath = OnlyPath(file);
126         paragraph = 0;
127         lyx_clean = true;
128         bak_clean = true;
129         dep_clean = 0;
130         read_only = ronly;
131         unnamed = false;
132         users = 0;
133         lyxvc.buffer(this);
134         if (read_only || (lyxrc.use_tempdir)) {
135                 tmppath = CreateBufferTmpDir();
136         } else tmppath.erase();
137 }
138
139
140 Buffer::~Buffer()
141 {
142         lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
143         // here the buffer should take care that it is
144         // saved properly, before it goes into the void.
145
146         // make sure that views using this buffer
147         // forgets it.
148         if (users)
149                 users->buffer(0);
150         
151         if (!tmppath.empty()) {
152                 DestroyBufferTmpDir(tmppath);
153         }
154         
155         LyXParagraph * par = paragraph;
156         LyXParagraph * tmppar;
157         while (par) {
158                 tmppar = par->next;
159                 delete par;
160                 par = tmppar;
161         }
162         paragraph = 0;
163 }
164
165
166 string const Buffer::getLatexName(bool no_path) const
167 {
168         if (no_path)
169                 return OnlyFilename(ChangeExtension(MakeLatexName(filename), 
170                                                     ".tex"));
171         else
172                 return ChangeExtension(MakeLatexName(filename), 
173                                        ".tex"); 
174 }
175
176
177 void Buffer::setReadonly(bool flag)
178 {
179         if (read_only != flag) {
180                 read_only = flag; 
181                 updateTitles();
182                 users->owner()->getDialogs()->updateBufferDependent();
183         }
184         if (read_only) {
185                 WarnReadonly(filename);
186         }
187 }
188
189
190 bool Buffer::saveParamsAsDefaults() // const
191 {
192         string const fname = AddName(AddPath(user_lyxdir, "templates/"),
193                                "defaults.lyx");
194         Buffer defaults = Buffer(fname);
195         
196         // Use the current buffer's parameters as default
197         defaults.params = params;
198         
199         // add an empty paragraph. Is this enough?
200         defaults.paragraph = new LyXParagraph;
201
202         return defaults.writeFile(defaults.filename, false);
203 }
204
205
206 /// Update window titles of all users
207 // Should work on a list
208 void Buffer::updateTitles() const
209 {
210         if (users) users->owner()->updateWindowTitle();
211 }
212
213
214 /// Reset autosave timer of all users
215 // Should work on a list
216 void Buffer::resetAutosaveTimers() const
217 {
218         if (users) users->owner()->resetAutosaveTimer();
219 }
220
221
222 void Buffer::fileName(string const & newfile)
223 {
224         filename = MakeAbsPath(newfile);
225         filepath = OnlyPath(filename);
226         setReadonly(IsFileWriteable(filename) == 0);
227         updateTitles();
228 }
229
230
231 // candidate for move to BufferView
232 // (at least some parts in the beginning of the func)
233 //
234 // Uwe C. Schroeder
235 // changed to be public and have one parameter
236 // if par = 0 normal behavior
237 // else insert behavior
238 // Returns false if "\the_end" is not read for formats >= 2.13. (Asger)
239 bool Buffer::readLyXformat2(LyXLex & lex, LyXParagraph * par)
240 {
241         int pos = 0;
242         char depth = 0; // signed or unsigned?
243 #ifndef NEW_INSETS
244         LyXParagraph::footnote_flag footnoteflag = LyXParagraph::NO_FOOTNOTE;
245         LyXParagraph::footnote_kind footnotekind = LyXParagraph::FOOTNOTE;
246 #endif
247         bool the_end_read = false;
248
249         LyXParagraph * return_par = 0;
250         LyXFont font(LyXFont::ALL_INHERIT, params.language_info);
251         if (format < 2.16 && params.language == "hebrew")
252                 font.setLanguage(default_language);
253
254         // If we are inserting, we cheat and get a token in advance
255         bool has_token = false;
256         string pretoken;
257
258         if(!par) {
259                 par = new LyXParagraph;
260         } else {
261                 users->text->BreakParagraph(users);
262                 return_par = users->text->FirstParagraph();
263                 pos = 0;
264                 markDirty();
265                 // We don't want to adopt the parameters from the
266                 // document we insert, so we skip until the text begins:
267                 while (lex.IsOK()) {
268                         lex.nextToken();
269                         pretoken = lex.GetString();
270                         if (pretoken == "\\layout") {
271                                 has_token = true;
272                                 break;
273                         }
274                 }
275         }
276
277         while (lex.IsOK()) {
278                 if (has_token) {
279                         has_token = false;
280                 } else {
281                         lex.nextToken();
282                         pretoken = lex.GetString();
283                 }
284
285                 if (pretoken.empty()) continue;
286                 
287                 the_end_read =
288                         parseSingleLyXformat2Token(lex, par, return_par,
289                                                    pretoken, pos, depth,
290                                                    font
291 #ifndef NEW_INSETS
292                                                    , footnoteflag,
293                                                    footnotekind
294 #endif
295                                 );
296         }
297    
298         if (!return_par)
299                 return_par = par;
300
301         paragraph = return_par;
302         
303         return the_end_read;
304 }
305
306
307 // We'll remove this later. (Lgb)
308 static string last_inset_read;
309
310
311 bool
312 Buffer::parseSingleLyXformat2Token(LyXLex & lex, LyXParagraph *& par,
313                                    LyXParagraph *& return_par,
314                                    string const & token, int & pos,
315                                    char & depth, LyXFont & font
316 #ifndef NEW_INSETS
317                                    , LyXParagraph::footnote_flag & footnoteflag,
318                                    LyXParagraph::footnote_kind & footnotekind
319 #endif
320         )
321 {
322         bool the_end_read = false;
323         
324         if (token[0] != '\\') {
325                 for (string::const_iterator cit = token.begin();
326                      cit != token.end(); ++cit) {
327                         par->InsertChar(pos, (*cit), font);
328                         ++pos;
329                 }
330         } else if (token == "\\i") {
331                 Inset * inset = new InsetLatexAccent;
332                 inset->Read(this, lex);
333                 par->InsertInset(pos, inset, font);
334                 ++pos;
335         } else if (token == "\\layout") {
336                 if (!return_par) 
337                         return_par = par;
338                 else {
339                         par->fitToSize();
340                         par = new LyXParagraph(par);
341                 }
342                 pos = 0;
343                 lex.EatLine();
344                 string const layoutname = lex.GetString();
345                 pair<bool, LyXTextClass::LayoutList::size_type> pp
346                         = textclasslist.NumberOfLayout(params.textclass,
347                                                        layoutname);
348                 if (pp.first) {
349                         par->layout = pp.second;
350                 } else { // layout not found
351                         // use default layout "Standard" (0)
352                         par->layout = 0;
353                 }
354                 // Test whether the layout is obsolete.
355                 LyXLayout const & layout =
356                         textclasslist.Style(params.textclass,
357                                             par->layout); 
358                 if (!layout.obsoleted_by().empty())
359                         par->layout = 
360                                 textclasslist.NumberOfLayout(params.textclass, 
361                                                              layout.obsoleted_by()).second;
362 #ifndef NEW_INSETS
363                 par->footnoteflag = footnoteflag;
364                 par->footnotekind = footnotekind;
365 #endif
366                 par->depth = depth;
367                 font = LyXFont(LyXFont::ALL_INHERIT, params.language_info);
368                 if (format < 2.16 && params.language == "hebrew")
369                         font.setLanguage(default_language);
370 #ifndef NEW_INSETS
371         } else if (token == "\\end_float") {
372                 if (!return_par) 
373                         return_par = par;
374                 else {
375                         par->fitToSize();
376                         par = new LyXParagraph(par);
377                 }
378                 footnotekind = LyXParagraph::FOOTNOTE;
379                 footnoteflag = LyXParagraph::NO_FOOTNOTE;
380                 pos = 0;
381                 lex.EatLine();
382                 par->layout = LYX_DUMMY_LAYOUT;
383                 font = LyXFont(LyXFont::ALL_INHERIT, params.language_info);
384                 if (format < 2.16 && params.language == "hebrew")
385                         font.setLanguage(default_language);
386         } else if (token == "\\begin_float") {
387                 int tmpret = lex.FindToken(string_footnotekinds);
388                 if (tmpret == -1) ++tmpret;
389                 if (tmpret != LYX_LAYOUT_DEFAULT) 
390                         footnotekind = static_cast<LyXParagraph::footnote_kind>(tmpret); // bad
391                 if (footnotekind == LyXParagraph::FOOTNOTE
392                     || footnotekind == LyXParagraph::MARGIN)
393                         footnoteflag = LyXParagraph::CLOSED_FOOTNOTE;
394                 else 
395                         footnoteflag = LyXParagraph::OPEN_FOOTNOTE;
396 #else
397         } else if (token == "\\begin_float") {
398                 // This is the compability reader, unfinished but tested.
399                 // (Lgb)
400                 lex.next();
401                 string const tmptok = lex.GetString();
402                 //lyxerr << "old float: " << tmptok << endl;
403                 
404                 Inset * inset = 0;
405                 string old_float;
406                 
407                 if (tmptok == "footnote") {
408                         inset = new InsetFoot;
409                 } else if (tmptok == "margin") {
410                         inset = new InsetMarginal;
411                 } else if (tmptok == "fig") {
412                         inset = new InsetFloat("figure");
413                         old_float += "placement htbp\n";
414                 } else if (tmptok == "tab") {
415                         inset = new InsetFloat("table");
416                         old_float += "placement htbp\n";
417                 } else if (tmptok == "alg") {
418                         inset = new InsetFloat("algorithm");
419                         old_float += "placement htbp\n";
420                 } else if (tmptok == "wide-fig") {
421                         InsetFloat * tmp = new InsetFloat("figure");
422                         tmp->wide(true);
423                         inset = tmp;
424                         old_float += "placement htbp\n";
425                 } else if (tmptok == "wide-tab") {
426                         InsetFloat * tmp = new InsetFloat("table");
427                         tmp->wide(true);
428                         inset = tmp;
429                         old_float += "placement htbp\n";
430                 }
431
432                 if (!inset) return false; // no end read yet
433                 
434                 old_float += "collapsed true\n";
435
436                 // Here we need to check for \end_deeper and handle that
437                 // before we do the footnote parsing.
438                 // This _is_ a hack! (Lgb)
439                 while(true) {
440                         lex.next();
441                         string const tmp = lex.GetString();
442                         if (tmp == "\\end_deeper") {
443                                 lyxerr << "\\end_deeper caught!" << endl;
444                                 if (!depth) {
445                                         lex.printError("\\end_deeper: "
446                                                        "depth is already null");
447                                 } else
448                                         --depth;
449                                 
450                         } else {
451                                 old_float += tmp;
452                                 old_float += ' ';
453                                 break;
454                         }
455                 }
456                 
457                 old_float += lex.getLongString("\\end_float");
458                 old_float += "\n\\end_inset\n";
459                 //lyxerr << "float body: " << old_float << endl;
460
461                 istringstream istr(old_float);
462                 
463                 LyXLex nylex(0, 0);
464                 nylex.setStream(istr);
465                 
466                 inset->Read(this, nylex);
467                 par->InsertInset(pos, inset, font);
468                 ++pos;
469 #endif
470         } else if (token == "\\begin_deeper") {
471                 ++depth;
472         } else if (token == "\\end_deeper") {
473                 if (!depth) {
474                         lex.printError("\\end_deeper: "
475                                        "depth is already null");
476                 }
477                 else
478                         --depth;
479         } else if (token == "\\begin_preamble") {
480                 params.readPreamble(lex);
481         } else if (token == "\\textclass") {
482                 lex.EatLine();
483                 pair<bool, LyXTextClassList::size_type> pp = 
484                         textclasslist.NumberOfClass(lex.GetString());
485                 if (pp.first) {
486                         params.textclass = pp.second;
487                 } else {
488                   lex.printError("Unknown textclass `$$Token'");
489                         params.textclass = 0;
490                 }
491                 if (!textclasslist.Load(params.textclass)) {
492                                 // if the textclass wasn't loaded properly
493                                 // we need to either substitute another
494                                 // or stop loading the file.
495                                 // I can substitute but I don't see how I can
496                                 // stop loading... ideas??  ARRae980418
497                         WriteAlert(_("Textclass Loading Error!"),
498                                    string(_("Can't load textclass ")) +
499                                    textclasslist.NameOfClass(params.textclass),
500                                    _("-- substituting default"));
501                         params.textclass = 0;
502                 }
503         } else if (token == "\\options") {
504                 lex.EatLine();
505                 params.options = lex.GetString();
506         } else if (token == "\\language") {
507                 params.readLanguage(lex);    
508         } else if (token == "\\fontencoding") {
509                 lex.EatLine();
510         } else if (token == "\\inputencoding") {
511                 lex.EatLine();
512                 params.inputenc = lex.GetString();
513         } else if (token == "\\graphics") {
514                 params.readGraphicsDriver(lex);
515         } else if (token == "\\fontscheme") {
516                 lex.EatLine();
517                 params.fonts = lex.GetString();
518         } else if (token == "\\noindent") {
519                 par->noindent = true;
520         } else if (token == "\\fill_top") {
521                 par->added_space_top = VSpace(VSpace::VFILL);
522         } else if (token == "\\fill_bottom") {
523                 par->added_space_bottom = VSpace(VSpace::VFILL);
524         } else if (token == "\\line_top") {
525                 par->line_top = true;
526         } else if (token == "\\line_bottom") {
527                 par->line_bottom = true;
528         } else if (token == "\\pagebreak_top") {
529                 par->pagebreak_top = true;
530         } else if (token == "\\pagebreak_bottom") {
531                 par->pagebreak_bottom = true;
532         } else if (token == "\\start_of_appendix") {
533                 par->start_of_appendix = true;
534         } else if (token == "\\paragraph_separation") {
535                 int tmpret = lex.FindToken(string_paragraph_separation);
536                 if (tmpret == -1) ++tmpret;
537                 if (tmpret != LYX_LAYOUT_DEFAULT) 
538                         params.paragraph_separation =
539                                 static_cast<BufferParams::PARSEP>(tmpret);
540         } else if (token == "\\defskip") {
541                 lex.nextToken();
542                 params.defskip = VSpace(lex.GetString());
543         } else if (token == "\\epsfig") { // obsolete
544                 // Indeed it is obsolete, but we HAVE to be backwards
545                 // compatible until 0.14, because otherwise all figures
546                 // in existing documents are irretrivably lost. (Asger)
547                 params.readGraphicsDriver(lex);
548         } else if (token == "\\quotes_language") {
549                 int tmpret = lex.FindToken(string_quotes_language);
550                 if (tmpret == -1) ++tmpret;
551                 if (tmpret != LYX_LAYOUT_DEFAULT) {
552                         InsetQuotes::quote_language tmpl = 
553                                 InsetQuotes::EnglishQ;
554                         switch(tmpret) {
555                         case 0:
556                                 tmpl = InsetQuotes::EnglishQ;
557                                 break;
558                         case 1:
559                                 tmpl = InsetQuotes::SwedishQ;
560                                 break;
561                         case 2:
562                                 tmpl = InsetQuotes::GermanQ;
563                                 break;
564                         case 3:
565                                 tmpl = InsetQuotes::PolishQ;
566                                 break;
567                         case 4:
568                                 tmpl = InsetQuotes::FrenchQ;
569                                 break;
570                         case 5:
571                                 tmpl = InsetQuotes::DanishQ;
572                                 break;  
573                         }
574                         params.quotes_language = tmpl;
575                 }
576         } else if (token == "\\quotes_times") {
577                 lex.nextToken();
578                 switch(lex.GetInteger()) {
579                 case 1: 
580                         params.quotes_times = InsetQuotes::SingleQ; 
581                         break;
582                 case 2: 
583                         params.quotes_times = InsetQuotes::DoubleQ; 
584                         break;
585                 }
586         } else if (token == "\\papersize") {
587                 int tmpret = lex.FindToken(string_papersize);
588                 if (tmpret == -1)
589                         ++tmpret;
590                 else
591                         params.papersize2 = tmpret;
592         } else if (token == "\\paperpackage") {
593                 int tmpret = lex.FindToken(string_paperpackages);
594                 if (tmpret == -1) {
595                         ++tmpret;
596                         params.paperpackage = BufferParams::PACKAGE_NONE;
597                 } else
598                         params.paperpackage = tmpret;
599         } else if (token == "\\use_geometry") {
600                 lex.nextToken();
601                 params.use_geometry = lex.GetInteger();
602         } else if (token == "\\use_amsmath") {
603                 lex.nextToken();
604                 params.use_amsmath = lex.GetInteger();
605         } else if (token == "\\paperorientation") {
606                 int tmpret = lex.FindToken(string_orientation);
607                 if (tmpret == -1) ++tmpret;
608                 if (tmpret != LYX_LAYOUT_DEFAULT) 
609                         params.orientation = static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
610         } else if (token == "\\paperwidth") {
611                 lex.next();
612                 params.paperwidth = lex.GetString();
613         } else if (token == "\\paperheight") {
614                 lex.next();
615                 params.paperheight = lex.GetString();
616         } else if (token == "\\leftmargin") {
617                 lex.next();
618                 params.leftmargin = lex.GetString();
619         } else if (token == "\\topmargin") {
620                 lex.next();
621                 params.topmargin = lex.GetString();
622         } else if (token == "\\rightmargin") {
623                 lex.next();
624                 params.rightmargin = lex.GetString();
625         } else if (token == "\\bottommargin") {
626                 lex.next();
627                 params.bottommargin = lex.GetString();
628         } else if (token == "\\headheight") {
629                 lex.next();
630                 params.headheight = lex.GetString();
631         } else if (token == "\\headsep") {
632                 lex.next();
633                 params.headsep = lex.GetString();
634         } else if (token == "\\footskip") {
635                 lex.next();
636                 params.footskip = lex.GetString();
637         } else if (token == "\\paperfontsize") {
638                 lex.nextToken();
639                 params.fontsize = strip(lex.GetString());
640         } else if (token == "\\papercolumns") {
641                 lex.nextToken();
642                 params.columns = lex.GetInteger();
643         } else if (token == "\\papersides") {
644                 lex.nextToken();
645                 switch(lex.GetInteger()) {
646                 default:
647                 case 1: params.sides = LyXTextClass::OneSide; break;
648                 case 2: params.sides = LyXTextClass::TwoSides; break;
649                 }
650         } else if (token == "\\paperpagestyle") {
651                 lex.nextToken();
652                 params.pagestyle = strip(lex.GetString());
653         } else if (token == "\\bullet") {
654                 lex.nextToken();
655                 int const index = lex.GetInteger();
656                 lex.nextToken();
657                 int temp_int = lex.GetInteger();
658                 params.user_defined_bullets[index].setFont(temp_int);
659                 params.temp_bullets[index].setFont(temp_int);
660                 lex.nextToken();
661                 temp_int = lex.GetInteger();
662                 params.user_defined_bullets[index].setCharacter(temp_int);
663                 params.temp_bullets[index].setCharacter(temp_int);
664                 lex.nextToken();
665                 temp_int = lex.GetInteger();
666                 params.user_defined_bullets[index].setSize(temp_int);
667                 params.temp_bullets[index].setSize(temp_int);
668                 lex.nextToken();
669                 string const temp_str = lex.GetString();
670                 if (temp_str != "\\end_bullet") {
671                                 // this element isn't really necessary for
672                                 // parsing but is easier for humans
673                                 // to understand bullets. Put it back and
674                                 // set a debug message?
675                         lex.printError("\\end_bullet expected, got" + temp_str);
676                                 //how can I put it back?
677                 }
678         } else if (token == "\\bulletLaTeX") {
679                 lex.nextToken();
680                 int const index = lex.GetInteger();
681                 lex.next();
682                 string temp_str = lex.GetString();
683                 string sum_str;
684                 while (temp_str != "\\end_bullet") {
685                                 // this loop structure is needed when user
686                                 // enters an empty string since the first
687                                 // thing returned will be the \\end_bullet
688                                 // OR
689                                 // if the LaTeX entry has spaces. Each element
690                                 // therefore needs to be read in turn
691                         sum_str += temp_str;
692                         lex.next();
693                         temp_str = lex.GetString();
694                 }
695                 params.user_defined_bullets[index].setText(sum_str);
696                 params.temp_bullets[index].setText(sum_str);
697         } else if (token == "\\secnumdepth") {
698                 lex.nextToken();
699                 params.secnumdepth = lex.GetInteger();
700         } else if (token == "\\tocdepth") {
701                 lex.nextToken();
702                 params.tocdepth = lex.GetInteger();
703         } else if (token == "\\spacing") {
704                 lex.next();
705                 string const tmp = strip(lex.GetString());
706                 Spacing::Space tmp_space = Spacing::Default;
707                 float tmp_val = 0.0;
708                 if (tmp == "single") {
709                         tmp_space = Spacing::Single;
710                 } else if (tmp == "onehalf") {
711                         tmp_space = Spacing::Onehalf;
712                 } else if (tmp == "double") {
713                         tmp_space = Spacing::Double;
714                 } else if (tmp == "other") {
715                         lex.next();
716                         tmp_space = Spacing::Other;
717                         tmp_val = lex.GetFloat();
718                 } else {
719                         lex.printError("Unknown spacing token: '$$Token'");
720                 }
721                 // Small hack so that files written with klyx will be
722                 // parsed correctly.
723                 if (return_par) {
724                         par->spacing.set(tmp_space, tmp_val);
725                 } else {
726                         params.spacing.set(tmp_space, tmp_val);
727                 }
728         } else if (token == "\\paragraph_spacing") {
729                 lex.next();
730                 string const tmp = strip(lex.GetString());
731                 if (tmp == "single") {
732                         par->spacing.set(Spacing::Single);
733                 } else if (tmp == "onehalf") {
734                         par->spacing.set(Spacing::Onehalf);
735                 } else if (tmp == "double") {
736                         par->spacing.set(Spacing::Double);
737                 } else if (tmp == "other") {
738                         lex.next();
739                         par->spacing.set(Spacing::Other,
740                                          lex.GetFloat());
741                 } else {
742                         lex.printError("Unknown spacing token: '$$Token'");
743                 }
744         } else if (token == "\\float_placement") {
745                 lex.nextToken();
746                 params.float_placement = lex.GetString();
747         } else if (token == "\\family") { 
748                 lex.next();
749                 font.setLyXFamily(lex.GetString());
750         } else if (token == "\\series") {
751                 lex.next();
752                 font.setLyXSeries(lex.GetString());
753         } else if (token == "\\shape") {
754                 lex.next();
755                 font.setLyXShape(lex.GetString());
756         } else if (token == "\\size") {
757                 lex.next();
758                 font.setLyXSize(lex.GetString());
759         } else if (token == "\\latex") {
760                 lex.next();
761                 string const tok = lex.GetString();
762                 // This is dirty, but gone with LyX3. (Asger)
763                 if (tok == "no_latex")
764                         font.setLatex(LyXFont::OFF);
765                 else if (tok == "latex")
766                         font.setLatex(LyXFont::ON);
767                 else if (tok == "default")
768                         font.setLatex(LyXFont::INHERIT);
769                 else
770                         lex.printError("Unknown LaTeX font flag "
771                                        "`$$Token'");
772         } else if (token == "\\lang") {
773                 lex.next();
774                 string const tok = lex.GetString();
775                 Languages::iterator lit = languages.find(tok);
776                 if (lit != languages.end()) {
777                         font.setLanguage(&(*lit).second);
778                 } else {
779                         font.setLanguage(params.language_info);
780                         lex.printError("Unknown language `$$Token'");
781                 }
782         } else if (token == "\\emph") {
783                 lex.next();
784                 font.setEmph(font.setLyXMisc(lex.GetString()));
785         } else if (token == "\\bar") {
786                 lex.next();
787                 string const tok = lex.GetString();
788                 // This is dirty, but gone with LyX3. (Asger)
789                 if (tok == "under")
790                         font.setUnderbar(LyXFont::ON);
791                 else if (tok == "no")
792                         font.setUnderbar(LyXFont::OFF);
793                 else if (tok == "default")
794                         font.setUnderbar(LyXFont::INHERIT);
795                 else
796                         lex.printError("Unknown bar font flag "
797                                        "`$$Token'");
798         } else if (token == "\\noun") {
799                 lex.next();
800                 font.setNoun(font.setLyXMisc(lex.GetString()));
801         } else if (token == "\\color") {
802                 lex.next();
803                 font.setLyXColor(lex.GetString());
804         } else if (token == "\\align") {
805                 int tmpret = lex.FindToken(string_align);
806                 if (tmpret == -1) ++tmpret;
807                 if (tmpret != LYX_LAYOUT_DEFAULT) { // tmpret != 99 ???
808                         int tmpret2 = 1;
809                         for (; tmpret > 0; --tmpret)
810                                 tmpret2 = tmpret2 * 2;
811                         par->align = LyXAlignment(tmpret2);
812                 }
813         } else if (token == "\\added_space_top") {
814                 lex.nextToken();
815                 par->added_space_top = VSpace(lex.GetString());
816         } else if (token == "\\added_space_bottom") {
817                 lex.nextToken();
818                 par->added_space_bottom = VSpace(lex.GetString());
819         } else if (token == "\\pextra_type") {
820                 lex.nextToken();
821                 par->pextra_type = lex.GetInteger();
822         } else if (token == "\\pextra_width") {
823                 lex.nextToken();
824                 par->pextra_width = lex.GetString();
825         } else if (token == "\\pextra_widthp") {
826                 lex.nextToken();
827                 par->pextra_widthp = lex.GetString();
828         } else if (token == "\\pextra_alignment") {
829                 lex.nextToken();
830                 par->pextra_alignment = lex.GetInteger();
831         } else if (token == "\\pextra_hfill") {
832                 lex.nextToken();
833                 par->pextra_hfill = lex.GetInteger();
834         } else if (token == "\\pextra_start_minipage") {
835                 lex.nextToken();
836                 par->pextra_start_minipage = lex.GetInteger();
837         } else if (token == "\\labelwidthstring") {
838                 lex.EatLine();
839                 par->labelwidthstring = lex.GetString();
840                 // do not delete this token, it is still needed!
841         } else if (token == "\\end_inset") {
842                 lyxerr << "Solitary \\end_inset. Missing \\begin_inset?.\n"
843                        << "Last inset read was: " << last_inset_read
844                        << endl;
845                 // Simply ignore this. The insets do not have
846                 // to read this.
847                 // But insets should read it, it is a part of
848                 // the inset isn't it? Lgb.
849         } else if (token == "\\begin_inset") {
850                 readInset(lex, par, pos, font);
851         } else if (token == "\\SpecialChar") {
852                 LyXLayout const & layout =
853                         textclasslist.Style(params.textclass, 
854                                             par->GetLayout());
855
856                 // Insets don't make sense in a free-spacing context! ---Kayvan
857                 if (layout.free_spacing) {
858                         if (lex.IsOK()) {
859                                 lex.next();
860                                 string next_token = lex.GetString();
861                                 if (next_token == "\\-") {
862                                         par->InsertChar(pos, '-', font);
863                                 } else if (next_token == "\\protected_separator"
864                                         || next_token == "~") {
865                                         par->InsertChar(pos, ' ', font);
866                                 } else {
867                                         lex.printError("Token `$$Token' "
868                                                        "is in free space "
869                                                        "paragraph layout!");
870                                         --pos;
871                                 }
872                         }
873                 } else {
874                         Inset * inset = new InsetSpecialChar;
875                         inset->Read(this, lex);
876                         par->InsertInset(pos, inset, font);
877                 }
878                 ++pos;
879         } else if (token == "\\newline") {
880                 par->InsertChar(pos, LyXParagraph::META_NEWLINE, font);
881                 ++pos;
882         } else if (token == "\\LyXTable") {
883                 Inset * inset = new InsetTabular(this);
884                 inset->Read(this, lex);
885                 par->InsertInset(pos, inset, font);
886                 ++pos;
887         } else if (token == "\\hfill") {
888                 par->InsertChar(pos, LyXParagraph::META_HFILL, font);
889                 ++pos;
890         } else if (token == "\\protected_separator") { // obsolete
891                 // This is a backward compability thingie. (Lgb)
892                 // Remove it later some time...introduced with fileformat
893                 // 2.16. (Lgb)
894                 LyXLayout const & layout =
895                         textclasslist.Style(params.textclass, 
896                                             par->GetLayout());
897
898                 if (layout.free_spacing) {
899                         par->InsertChar(pos, ' ', font);
900                 } else {
901                         Inset * inset = new InsetSpecialChar(InsetSpecialChar::PROTECTED_SEPARATOR);
902                         par->InsertInset(pos, inset, font);
903                 }
904                 ++pos;
905         } else if (token == "\\bibitem") {  // ale970302
906                 if (!par->bibkey) {
907                         InsetCommandParams p( "bibitem" );
908                         par->bibkey = new InsetBibKey(p);
909                 }
910                 par->bibkey->Read(this, lex);                   
911         } else if (token == "\\backslash") {
912                 par->InsertChar(pos, '\\', font);
913                 ++pos;
914         } else if (token == "\\the_end") {
915                 the_end_read = true;
916         } else {
917                 // This should be insurance for the future: (Asger)
918                 lex.printError("Unknown token `$$Token'. "
919                                "Inserting as text.");
920                 string::const_iterator cit = token.begin();
921                 string::const_iterator end = token.end();
922                 for(; cit != end; ++cit) {
923                         par->InsertChar(pos, (*cit), font);
924                         ++pos;
925                 }
926         }
927         return the_end_read;
928 }
929
930
931 void Buffer::readInset(LyXLex & lex, LyXParagraph *& par,
932                        int & pos, LyXFont & font)
933 {
934         // consistency check
935         if (lex.GetString() != "\\begin_inset") {
936                 lyxerr << "Buffer::readInset: Consistency check failed."
937                        << endl;
938         }
939         
940         Inset * inset = 0;
941
942         lex.next();
943         string const tmptok = lex.GetString();
944         last_inset_read = tmptok;
945
946         // test the different insets
947         if (tmptok == "LatexCommand") {
948                 InsetCommandParams inscmd;
949                 inscmd.Read(lex);
950
951                 if (inscmd.getCmdName() == "cite") {
952                         inset = new InsetCitation(inscmd);
953                 } else if (inscmd.getCmdName() == "bibitem") {
954                         lex.printError("Wrong place for bibitem");
955                         inset = new InsetBibKey(inscmd);
956                 } else if (inscmd.getCmdName() == "BibTeX") {
957                         inset = new InsetBibtex(inscmd, this);
958                 } else if (inscmd.getCmdName() == "index") {
959                         inset = new InsetIndex(inscmd);
960                 } else if (inscmd.getCmdName() == "include") {
961                         inset = new InsetInclude(inscmd, this);
962                 } else if (inscmd.getCmdName() == "label") {
963                         inset = new InsetLabel(inscmd);
964                 } else if (inscmd.getCmdName() == "url"
965                            || inscmd.getCmdName() == "htmlurl") {
966                         inset = new InsetUrl(inscmd);
967                 } else if (inscmd.getCmdName() == "ref"
968                            || inscmd.getCmdName() == "pageref"
969                            || inscmd.getCmdName() == "vref"
970                            || inscmd.getCmdName() == "vpageref"
971                            || inscmd.getCmdName() == "prettyref") {
972                         if (!inscmd.getOptions().empty()
973                             || !inscmd.getContents().empty()) {
974                                 inset = new InsetRef(inscmd);
975                         }
976                 } else if (inscmd.getCmdName() == "tableofcontents"
977                            || inscmd.getCmdName() == "listofalgorithms"
978                            || inscmd.getCmdName() == "listoffigures"
979                            || inscmd.getCmdName() == "listoftables") {
980                         inset = new InsetTOC(inscmd);
981                 } else if (inscmd.getCmdName() == "printindex") {
982                         inset = new InsetPrintIndex(inscmd);
983                 } else if (inscmd.getCmdName() == "lyxparent") {
984                         inset = new InsetParent(inscmd, this);
985                 }
986         } else {
987                 if (tmptok == "Quotes") {
988                         inset = new InsetQuotes;
989                 } else if (tmptok == "External") {
990                         inset = new InsetExternal;
991                 } else if (tmptok == "FormulaMacro") {
992                         inset = new InsetFormulaMacro;
993                 } else if (tmptok == "Formula") {
994                         inset = new InsetFormula;
995                 } else if (tmptok == "Figure") {
996                         inset = new InsetFig(100, 100, this);
997                 } else if (tmptok == "Info") {
998                         inset = new InsetInfo;
999                 } else if (tmptok == "Include") {
1000                         InsetCommandParams p( "Include" );
1001                         inset = new InsetInclude(p, this);
1002                 } else if (tmptok == "ERT") {
1003                         inset = new InsetERT;
1004                 } else if (tmptok == "Tabular") {
1005                         inset = new InsetTabular(this);
1006                 } else if (tmptok == "Text") {
1007                         inset = new InsetText;
1008                 } else if (tmptok == "Foot") {
1009                         inset = new InsetFoot;
1010                 } else if (tmptok == "Marginal") {
1011                         inset = new InsetMarginal;
1012                 } else if (tmptok == "Minipage") {
1013                         inset = new InsetMinipage;
1014                 } else if (tmptok == "Float") {
1015                         lex.next();
1016                         string tmptok = lex.GetString();
1017                         inset = new InsetFloat(tmptok);
1018                 } else if (tmptok == "List") {
1019                         inset = new InsetList;
1020                 } else if (tmptok == "Theorem") {
1021                         inset = new InsetList;
1022                 } else if (tmptok == "Caption") {
1023                         inset = new InsetCaption;
1024                 } else if (tmptok == "GRAPHICS") {
1025                         inset = new InsetGraphics;
1026                 }
1027                 
1028                 if (inset) inset->Read(this, lex);
1029         }
1030         
1031         if (inset) {
1032                 par->InsertInset(pos, inset, font);
1033                 ++pos;
1034         }
1035 }
1036
1037
1038 bool Buffer::readFile(LyXLex & lex, LyXParagraph * par)
1039 {
1040         if (lex.IsOK()) {
1041                 lex.next();
1042                 string const token(lex.GetString());
1043                 if (token == "\\lyxformat") { // the first token _must_ be...
1044                         lex.EatLine();
1045                         format = lex.GetFloat();
1046                         if (format > 1) {
1047                                 if (LYX_FORMAT - format > 0.05) {
1048                                         
1049                                         printf(_("Warning: need lyxformat %.2f but found %.2f\n"),
1050                                                LYX_FORMAT, format);
1051                                 }
1052                                 if (format - LYX_FORMAT > 0.05) {
1053                                         printf(_("ERROR: need lyxformat %.2f but found %.2f\n"),
1054                                                LYX_FORMAT, format);
1055                                 }
1056                                 bool the_end = readLyXformat2(lex, par);
1057                                 // Formats >= 2.13 support "\the_end" marker
1058                                 if (format < 2.13)
1059                                         the_end = true;
1060
1061                                 setPaperStuff();
1062
1063                                 if (!the_end)
1064                                         WriteAlert(_("Warning!"),
1065                                                    _("Reading of document is not complete"),
1066                                                    _("Maybe the document is truncated"));
1067                                 // We simulate a safe reading anyways to allow
1068                                 // users to take the chance... (Asger)
1069                                 return true;
1070                         } // format < 1
1071                         else {
1072                                 WriteAlert(_("ERROR!"),
1073                                            _("Old LyX file format found. "
1074                                              "Use LyX 0.10.x to read this!"));
1075                                 return false;
1076                         }
1077
1078                 } else { // "\\lyxformat" not found
1079                         WriteAlert(_("ERROR!"), _("Not a LyX file!"));
1080                 }
1081         } else
1082                 WriteAlert(_("ERROR!"), _("Unable to read file!"));
1083         return false;
1084 }
1085                     
1086
1087
1088 // Should probably be moved to somewhere else: BufferView? LyXView?
1089 bool Buffer::save() const
1090 {
1091         // We don't need autosaves in the immediate future. (Asger)
1092         resetAutosaveTimers();
1093
1094         // make a backup
1095         string s;
1096         if (lyxrc.make_backup) {
1097                 s = fileName() + '~';
1098                 if (!lyxrc.backupdir_path.empty())
1099                         s = AddName(lyxrc.backupdir_path,
1100                                     subst(CleanupPath(s),'/','!'));
1101
1102                 // Rename is the wrong way of making a backup,
1103                 // this is the correct way.
1104                 /* truss cp fil fil2:
1105                    lstat("LyXVC3.lyx", 0xEFFFF898)                 Err#2 ENOENT
1106                    stat("LyXVC.lyx", 0xEFFFF688)                   = 0
1107                    open("LyXVC.lyx", O_RDONLY)                     = 3
1108                    open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
1109                    fstat(4, 0xEFFFF508)                            = 0
1110                    fstat(3, 0xEFFFF508)                            = 0
1111                    read(3, " # T h i s   f i l e   w".., 8192)     = 5579
1112                    write(4, " # T h i s   f i l e   w".., 5579)    = 5579
1113                    read(3, 0xEFFFD4A0, 8192)                       = 0
1114                    close(4)                                        = 0
1115                    close(3)                                        = 0
1116                    chmod("LyXVC3.lyx", 0100644)                    = 0
1117                    lseek(0, 0, SEEK_CUR)                           = 46440
1118                    _exit(0)
1119                 */
1120
1121                 // Should proabaly have some more error checking here.
1122                 // Should be cleaned up in 0.13, at least a bit.
1123                 // Doing it this way, also makes the inodes stay the same.
1124                 // This is still not a very good solution, in particular we
1125                 // might loose the owner of the backup.
1126                 FileInfo finfo(fileName());
1127                 if (finfo.exist()) {
1128                         mode_t fmode = finfo.getMode();
1129                         struct utimbuf times = {
1130                                 finfo.getAccessTime(),
1131                                 finfo.getModificationTime() };
1132
1133                         ifstream ifs(fileName().c_str());
1134                         ofstream ofs(s.c_str(), ios::out|ios::trunc);
1135                         if (ifs && ofs) {
1136                                 ofs << ifs.rdbuf();
1137                                 ifs.close();
1138                                 ofs.close();
1139                                 ::chmod(s.c_str(), fmode);
1140                                 
1141                                 if (::utime(s.c_str(), &times)) {
1142                                         lyxerr << "utime error." << endl;
1143                                 }
1144                         } else {
1145                                 lyxerr << "LyX was not able to make "
1146                                         "backupcopy. Beware." << endl;
1147                         }
1148                 }
1149         }
1150         
1151         if (writeFile(fileName(), false)) {
1152                 markLyxClean();
1153                 removeAutosaveFile(fileName());
1154         } else {
1155                 // Saving failed, so backup is not backup
1156                 if (lyxrc.make_backup) {
1157                         lyx::rename(s, fileName());
1158                 }
1159                 return false;
1160         }
1161         return true;
1162 }
1163
1164
1165 // Returns false if unsuccesful
1166 bool Buffer::writeFile(string const & fname, bool flag) const
1167 {
1168         // if flag is false writeFile will not create any GUI
1169         // warnings, only cerr.
1170         // Needed for autosave in background or panic save (Matthias 120496)
1171
1172         if (read_only && (fname == filename)) {
1173                 // Here we should come with a question if we should
1174                 // perform the write anyway.
1175                 if (flag)
1176                         lyxerr << _("Error! Document is read-only: ")
1177                                << fname << endl;
1178                 else
1179                         WriteAlert(_("Error! Document is read-only: "),
1180                                    fname);
1181                 return false;
1182         }
1183
1184         FileInfo finfo(fname);
1185         if (finfo.exist() && !finfo.writable()) {
1186                 // Here we should come with a question if we should
1187                 // try to do the save anyway. (i.e. do a chmod first)
1188                 if (flag)
1189                         lyxerr << _("Error! Cannot write file: ")
1190                                << fname << endl;
1191                 else
1192                         WriteFSAlert(_("Error! Cannot write file: "),
1193                                      fname);
1194                 return false;
1195         }
1196
1197         ofstream ofs(fname.c_str());
1198         if (!ofs) {
1199                 if (flag)
1200                         lyxerr << _("Error! Cannot open file: ")
1201                                << fname << endl;
1202                 else
1203                         WriteFSAlert(_("Error! Cannot open file: "),
1204                                      fname);
1205                 return false;
1206         }
1207
1208 #ifdef HAVE_LOCALE
1209         // Use the standard "C" locale for file output.
1210         ofs.imbue(std::locale::classic());
1211 #endif
1212
1213         // The top of the file should not be written by params.
1214
1215         // write out a comment in the top of the file
1216         ofs << '#' << LYX_DOCVERSION 
1217             << " created this file. For more info see http://www.lyx.org/\n";
1218         ofs.setf(ios::showpoint|ios::fixed);
1219         ofs.precision(2);
1220 #ifndef HAVE_LOCALE
1221         char dummy_format[512];
1222         sprintf(dummy_format, "%.2f", LYX_FORMAT);
1223         ofs << "\\lyxformat " <<  dummy_format << "\n";
1224 #else
1225         ofs << "\\lyxformat " << setw(4) <<  LYX_FORMAT << "\n";
1226 #endif
1227         // now write out the buffer paramters.
1228         params.writeFile(ofs);
1229
1230         char footnoteflag = 0;
1231         char depth = 0;
1232
1233         // this will write out all the paragraphs
1234         // using recursive descent.
1235         paragraph->writeFile(this, ofs, params, footnoteflag, depth);
1236
1237         // Write marker that shows file is complete
1238         ofs << "\n\\the_end" << endl;
1239         ofs.close();
1240         // how to check if close went ok?
1241         return true;
1242 }
1243
1244
1245 #if 0
1246 void Buffer::writeFileAscii(string const & fname, int linelen) 
1247 {
1248         Inset * inset;
1249         char c;
1250         char footnoteflag = 0;
1251         char depth = 0;
1252         string tmp;
1253         LyXParagraph::size_type i;
1254         int j;
1255         int ltype = 0;
1256         int ltype_depth = 0;
1257         int actcell = 0;
1258         int actpos = 0;
1259         int currlinelen = 0;
1260         long fpos = 0;
1261         bool ref_printed = false;
1262
1263         ofstream ofs(fname.c_str());
1264         if (!ofs) {
1265                 WriteFSAlert(_("Error: Cannot write file:"), fname);
1266                 return;
1267         }
1268
1269         string const fname1 = TmpFileName();
1270         LyXParagraph * par = paragraph;
1271         while (par) {
1272                 int noparbreak = 0;
1273                 int islatex = 0;
1274                 if (
1275 #ifndef NEW_INSETS
1276                         par->footnoteflag != LyXParagraph::NO_FOOTNOTE ||
1277 #endif
1278                     !par->previous
1279 #ifndef NEW_INSETS
1280                     || par->previous->footnoteflag == LyXParagraph::NO_FOOTNOTE
1281 #endif
1282                         ){
1283
1284 #ifndef NEW_INSETS
1285                         /* begins a footnote environment ? */ 
1286                         if (footnoteflag != par->footnoteflag) {
1287                                 footnoteflag = par->footnoteflag;
1288                                 if (footnoteflag) {
1289                                         j = strlen(string_footnotekinds[par->footnotekind])+4;
1290                                         if (currlinelen + j > linelen)
1291                                                 ofs << "\n";
1292                                         ofs << "(["
1293                                             << string_footnotekinds[par->footnotekind] << "] ";
1294                                         currlinelen += j;
1295                                 }
1296                         }
1297 #endif
1298          
1299                         /* begins or ends a deeper area ?*/ 
1300                         if (depth != par->depth) {
1301                                 if (par->depth > depth) {
1302                                         while (par->depth > depth) {
1303                                                 ++depth;
1304                                         }
1305                                 }
1306                                 else {
1307                                         while (par->depth < depth) {
1308                                                 --depth;
1309                                         }
1310                                 }
1311                         }
1312          
1313                         /* First write the layout */
1314                         tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1315                         if (tmp == "Itemize") {
1316                                 ltype = 1;
1317                                 ltype_depth = depth+1;
1318                         } else if (tmp == "Enumerate") {
1319                                 ltype = 2;
1320                                 ltype_depth = depth+1;
1321                         } else if (contains(tmp, "ection")) {
1322                                 ltype = 3;
1323                                 ltype_depth = depth+1;
1324                         } else if (contains(tmp, "aragraph")) {
1325                                 ltype = 4;
1326                                 ltype_depth = depth+1;
1327                         } else if (tmp == "Description") {
1328                                 ltype = 5;
1329                                 ltype_depth = depth+1;
1330                         } else if (tmp == "Abstract") {
1331                                 ltype = 6;
1332                                 ltype_depth = 0;
1333                         } else if (tmp == "Bibliography") {
1334                                 ltype = 7;
1335                                 ltype_depth = 0;
1336                         } else {
1337                                 ltype = 0;
1338                                 ltype_depth = 0;
1339                         }
1340          
1341                         /* maybe some vertical spaces */ 
1342
1343                         /* the labelwidthstring used in lists */ 
1344          
1345                         /* some lines? */ 
1346          
1347                         /* some pagebreaks? */ 
1348          
1349                         /* noindent ? */ 
1350          
1351                         /* what about the alignment */ 
1352                 } else {
1353 #ifndef NEW_INSETS
1354                         /* dummy layout, that means a footnote ended */ 
1355                         footnoteflag = LyXParagraph::NO_FOOTNOTE;
1356                         ofs << ") ";
1357                         noparbreak = 1;
1358 #else
1359                         lyxerr << "Should this ever happen?" << endl;
1360 #endif
1361                 }
1362       
1363                 LyXFont font1 =
1364                         LyXFont(LyXFont::ALL_INHERIT, params.language_info);
1365                 actcell = 0;
1366                 for (i = 0, actpos = 1; i < par->size(); ++i, ++actpos) {
1367                         if (!i && !footnoteflag && !noparbreak){
1368                                 ofs << "\n\n";
1369                                 for(j = 0; j < depth; ++j)
1370                                         ofs << "  ";
1371                                 currlinelen = depth * 2;
1372                                 switch(ltype) {
1373                                 case 0: /* Standard */
1374                                 case 4: /* (Sub)Paragraph */
1375                                 case 5: /* Description */
1376                                         break;
1377                                 case 6: /* Abstract */
1378                                         ofs << "Abstract\n\n";
1379                                         break;
1380                                 case 7: /* Bibliography */
1381                                         if (!ref_printed) {
1382                                                 ofs << "References\n\n";
1383                                                 ref_printed = true;
1384                                         }
1385                                         break;
1386                                 default:
1387                                         ofs << par->labelstring << " ";
1388                                         break;
1389                                 }
1390                                 if (ltype_depth > depth) {
1391                                         for(j = ltype_depth - 1; j > depth; --j)
1392                                                 ofs << "  ";
1393                                         currlinelen += (ltype_depth-depth)*2;
1394                                 }
1395                         }
1396                         LyXFont font2 = par->GetFontSettings(params, i);
1397                         if (font1.latex() != font2.latex()) {
1398                                 if (font2.latex() == LyXFont::OFF)
1399                                         islatex = 0;
1400                                 else
1401                                         islatex = 1;
1402                         } else {
1403                                 islatex = 0;
1404                         }
1405                         c = par->GetChar(i);
1406                         if (islatex)
1407                                 continue;
1408                         switch (c) {
1409                         case LyXParagraph::META_INSET:
1410                                 if ((inset = par->GetInset(i))) {
1411                                         fpos = ofs.tellp();
1412                                         inset->Ascii(this, ofs);
1413                                         currlinelen += (ofs.tellp() - fpos);
1414                                         actpos += (ofs.tellp() - fpos) - 1;
1415                                 }
1416                                 break;
1417                         case LyXParagraph::META_NEWLINE:
1418                                 ofs << "\n";
1419                                 for(j = 0; j < depth; ++j)
1420                                         ofs << "  ";
1421                                 currlinelen = depth * 2;
1422                                 if (ltype_depth > depth) {
1423                                         for(j = ltype_depth;
1424                                             j > depth; --j)
1425                                                 ofs << "  ";
1426                                         currlinelen += (ltype_depth - depth) * 2;
1427                                 }
1428                                 break;
1429                         case LyXParagraph::META_HFILL: 
1430                                 ofs << "\t";
1431                                 break;
1432                         case '\\':
1433                                 ofs << "\\";
1434                                 break;
1435                         default:
1436                                 if (currlinelen > linelen - 10
1437                                     && c == ' ' && i + 2 < par->size()) {
1438                                         ofs << "\n";
1439                                         for(j = 0; j < depth; ++j)
1440                                                 ofs << "  ";
1441                                         currlinelen = depth * 2;
1442                                         if (ltype_depth > depth) {
1443                                                 for(j = ltype_depth;
1444                                                     j > depth; --j)
1445                                                         ofs << "  ";
1446                                                 currlinelen += (ltype_depth-depth)*2;
1447                                         }
1448                                 } else if (c != '\0')
1449                                         ofs << c;
1450                                 else if (c == '\0')
1451                                         lyxerr.debug() << "writeAsciiFile: NULL char in structure." << endl;
1452                                 ++currlinelen;
1453                                 break;
1454                         }
1455                 }
1456                 par = par->next;
1457         }
1458    
1459         ofs << "\n";
1460 }
1461 //----------------------------------------------------------------------------
1462 #else
1463 //----------------------------------------------------------------------------
1464 string const Buffer::asciiParagraph(LyXParagraph const * par, int linelen) const
1465 {
1466         ostringstream buffer;
1467         LyXFont font1, font2;
1468         Inset const * inset;
1469         char c, footnoteflag = 0, depth = 0;
1470         string tmp;
1471         LyXParagraph::size_type i;
1472         int j;
1473         int ltype = 0;
1474         int ltype_depth = 0;
1475         int actcell = 0;
1476         int currlinelen = 0;
1477         bool ref_printed = false;
1478
1479         string fname1 = TmpFileName();
1480
1481         int noparbreak = 0;
1482         int islatex = 0;
1483         if (
1484 #ifndef NEW_INSETS
1485                 par->footnoteflag != LyXParagraph::NO_FOOTNOTE ||
1486 #endif
1487                 !par->previous
1488 #ifndef NEW_INSETS
1489                 || par->previous->footnoteflag == LyXParagraph::NO_FOOTNOTE
1490 #endif
1491                 ){
1492 #ifndef NEW_INSETS
1493                 /* begins a footnote environment ? */ 
1494                 if (footnoteflag != par->footnoteflag) {
1495                         footnoteflag = par->footnoteflag;
1496                         if (footnoteflag) {
1497                                 j = strlen(string_footnotekinds[par->footnotekind])+4;
1498                                 if ((linelen > 0) &&
1499                                     ((currlinelen + j) > linelen)) {
1500                                         buffer << "\n";
1501                                         currlinelen = 0;
1502                                 }
1503                                 buffer <<
1504                                     "([" <<
1505                                     string_footnotekinds[par->footnotekind] <<
1506                                     "] ";
1507                                 currlinelen += j;
1508                         }
1509                 }
1510 #endif
1511                 /* begins or ends a deeper area ?*/ 
1512                 if (depth != par->depth) {
1513                         if (par->depth > depth) {
1514                                 while (par->depth > depth) {
1515                                         ++depth;
1516                                 }
1517                         }
1518                         else {
1519                                 while (par->depth < depth) {
1520                                         --depth;
1521                                 }
1522                         }
1523                 }
1524                 
1525                 /* First write the layout */
1526                 tmp = textclasslist.NameOfLayout(params.textclass, par->layout);
1527                 if (tmp == "Itemize") {
1528                         ltype = 1;
1529                         ltype_depth = depth+1;
1530                 } else if (tmp == "Enumerate") {
1531                         ltype = 2;
1532                         ltype_depth = depth+1;
1533                 } else if (strstr(tmp.c_str(), "ection")) {
1534                         ltype = 3;
1535                         ltype_depth = depth+1;
1536                 } else if (strstr(tmp.c_str(), "aragraph")) {
1537                         ltype = 4;
1538                         ltype_depth = depth+1;
1539                 } else if (tmp == "Description") {
1540                         ltype = 5;
1541                         ltype_depth = depth+1;
1542                 } else if (tmp == "Abstract") {
1543                         ltype = 6;
1544                         ltype_depth = 0;
1545                 } else if (tmp == "Bibliography") {
1546                         ltype = 7;
1547                         ltype_depth = 0;
1548                 } else {
1549                         ltype = 0;
1550                         ltype_depth = 0;
1551                 }
1552                 
1553                 /* maybe some vertical spaces */ 
1554                 
1555                 /* the labelwidthstring used in lists */ 
1556                 
1557                 /* some lines? */ 
1558                 
1559                 /* some pagebreaks? */ 
1560                 
1561                 /* noindent ? */ 
1562                 
1563                 /* what about the alignment */ 
1564         } else {
1565 #ifndef NEW_INSETS
1566                 /* dummy layout, that means a footnote ended */ 
1567                 footnoteflag = LyXParagraph::NO_FOOTNOTE;
1568                 buffer << ") ";
1569                 noparbreak = 1;
1570 #else
1571                 lyxerr << "Should this ever happen?" << endl;
1572 #endif
1573         }
1574       
1575         font1 = LyXFont(LyXFont::ALL_INHERIT, params.language_info);
1576         actcell = 0;
1577         for (i = 0; i < par->size(); ++i) {
1578                 if (!i && !footnoteflag && !noparbreak){
1579                         buffer << "\n\n";
1580                         for(j = 0; j < depth; ++j)
1581                                 buffer << "  ";
1582                         currlinelen = depth * 2;
1583                         switch(ltype) {
1584                         case 0: /* Standard */
1585                         case 4: /* (Sub)Paragraph */
1586                         case 5: /* Description */
1587                                 break;
1588                         case 6: /* Abstract */
1589                                 buffer << "Abstract\n\n";
1590                                 break;
1591                         case 7: /* Bibliography */
1592                                 if (!ref_printed) {
1593                                         buffer << "References\n\n";
1594                                         ref_printed = true;
1595                                 }
1596                                 break;
1597                         default:
1598                                 buffer << par->labelstring << " ";
1599                                 break;
1600                         }
1601                         if (ltype_depth > depth) {
1602                                 for(j = ltype_depth - 1; j > depth; --j)
1603                                         buffer << "  ";
1604                                 currlinelen += (ltype_depth-depth)*2;
1605                         }
1606                 }
1607                 font2 = par->GetFontSettings(params, i);
1608                 if (font1.latex() != font2.latex()) {
1609                         if (font2.latex() == LyXFont::OFF)
1610                                 islatex = 0;
1611                         else
1612                                 islatex = 1;
1613                 } else {
1614                         islatex = 0;
1615                 }
1616                 c = par->GetChar(i);
1617                 if (islatex)
1618                         continue;
1619                 switch (c) {
1620                 case LyXParagraph::META_INSET:
1621                         if ((inset = par->GetInset(i))) {
1622                                 if (!inset->Ascii(this, buffer)) {
1623                                         string dummy;
1624                                         string s = rsplit(buffer.str(),
1625                                                           dummy, '\n');
1626                                         currlinelen += s.length();
1627                                 } else {
1628                                         // to be sure it breaks paragraph
1629                                         currlinelen += linelen;
1630                                 }
1631                         }
1632                         break;
1633                 case LyXParagraph::META_NEWLINE:
1634                         buffer << "\n";
1635                         for(j = 0; j < depth; ++j)
1636                                 buffer << "  ";
1637                         currlinelen = depth * 2;
1638                         if (ltype_depth > depth) {
1639                                 for(j = ltype_depth;
1640                                     j > depth; --j)
1641                                         buffer << "  ";
1642                                 currlinelen += (ltype_depth - depth) * 2;
1643                         }
1644                         break;
1645                 case LyXParagraph::META_HFILL: 
1646                         buffer << "\t";
1647                         break;
1648                 case '\\':
1649                         buffer << "\\";
1650                         break;
1651                 default:
1652                         if ((linelen > 0) && (currlinelen > (linelen - 10)) &&
1653                             (c == ' ') && ((i + 2) < par->size()))
1654                         {
1655                                 buffer << "\n";
1656                                 for(j = 0; j < depth; ++j)
1657                                         buffer << "  ";
1658                                 currlinelen = depth * 2;
1659                                 if (ltype_depth > depth) {
1660                                         for(j = ltype_depth;
1661                                             j > depth; --j)
1662                                                 buffer << "  ";
1663                                         currlinelen += (ltype_depth-depth)*2;
1664                                 }
1665                         } else if (c != '\0')
1666                                 buffer << c;
1667                         else if (c == '\0')
1668                                 lyxerr.debug() << "writeAsciiFile: NULL char in structure." << endl;
1669                         ++currlinelen;
1670                         break;
1671                 }
1672         }
1673         return buffer.str();
1674 }
1675
1676
1677 void Buffer::writeFileAscii(string const & fname, int linelen) 
1678 {
1679         ofstream ofs(fname.c_str());
1680         if (!ofs) {
1681                 WriteFSAlert(_("Error: Cannot write file:"), fname);
1682                 return;
1683         }
1684         writeFileAscii(ofs, linelen);
1685 }
1686
1687
1688 void Buffer::writeFileAscii(ostream & ofs, int linelen) 
1689 {
1690         LyXParagraph * par = paragraph;
1691         while (par) {
1692                 ofs << asciiParagraph(par, linelen);
1693                 par = par->next;
1694         }
1695         ofs << "\n";
1696 }
1697 #endif
1698
1699 void Buffer::makeLaTeXFile(string const & fname, 
1700                            string const & original_path,
1701                            bool nice, bool only_body)
1702 {
1703         lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
1704         
1705         niceFile = nice; // this will be used by Insetincludes.
1706
1707         tex_code_break_column = lyxrc.ascii_linelen;
1708
1709         LyXTextClass const & tclass =
1710                 textclasslist.TextClass(params.textclass);
1711
1712         ofstream ofs(fname.c_str());
1713         if (!ofs) {
1714                 WriteFSAlert(_("Error: Cannot open file: "), fname);
1715                 return;
1716         }
1717         
1718         // validate the buffer.
1719         lyxerr[Debug::LATEX] << "  Validating buffer..." << endl;
1720         LaTeXFeatures features(params, tclass.numLayouts());
1721         validate(features);
1722         lyxerr[Debug::LATEX] << "  Buffer validation done." << endl;
1723         
1724         texrow.reset();
1725         // The starting paragraph of the coming rows is the 
1726         // first paragraph of the document. (Asger)
1727         texrow.start(paragraph, 0);
1728
1729         if (!only_body && nice) {
1730                 ofs << "%% " LYX_DOCVERSION " created this file.  "
1731                         "For more info, see http://www.lyx.org/.\n"
1732                         "%% Do not edit unless you really know what "
1733                         "you are doing.\n";
1734                 texrow.newline();
1735                 texrow.newline();
1736         }
1737         lyxerr.debug() << "lyx header finished" << endl;
1738         // There are a few differences between nice LaTeX and usual files:
1739         // usual is \batchmode and has a 
1740         // special input@path to allow the including of figures
1741         // with either \input or \includegraphics (what figinsets do).
1742         // batchmode is not set if there is a tex_code_break_column.
1743         // In this case somebody is interested in the generated LaTeX,
1744         // so this is OK. input@path is set when the actual parameter
1745         // original_path is set. This is done for usual tex-file, but not
1746         // for nice-latex-file. (Matthias 250696)
1747         if (!only_body) {
1748                 if (!nice){
1749                         // code for usual, NOT nice-latex-file
1750                         ofs << "\\batchmode\n"; // changed
1751                         // from \nonstopmode
1752                         texrow.newline();
1753                 }
1754                 if (!original_path.empty()) {
1755                         ofs << "\\makeatletter\n"
1756                             << "\\def\\input@path{{"
1757                             << original_path << "/}}\n"
1758                             << "\\makeatother\n";
1759                         texrow.newline();
1760                         texrow.newline();
1761                         texrow.newline();
1762                 }
1763                 
1764                 ofs << "\\documentclass";
1765                 
1766                 string options; // the document class options.
1767                 
1768                 if (tokenPos(tclass.opt_fontsize(),
1769                              '|', params.fontsize) >= 0) {
1770                         // only write if existing in list (and not default)
1771                         options += params.fontsize;
1772                         options += "pt,";
1773                 }
1774                 
1775                 
1776                 if (!params.use_geometry &&
1777                     (params.paperpackage == BufferParams::PACKAGE_NONE)) {
1778                         switch (params.papersize) {
1779                         case BufferParams::PAPER_A4PAPER:
1780                                 options += "a4paper,";
1781                                 break;
1782                         case BufferParams::PAPER_USLETTER:
1783                                 options += "letterpaper,";
1784                                 break;
1785                         case BufferParams::PAPER_A5PAPER:
1786                                 options += "a5paper,";
1787                                 break;
1788                         case BufferParams::PAPER_B5PAPER:
1789                                 options += "b5paper,";
1790                                 break;
1791                         case BufferParams::PAPER_EXECUTIVEPAPER:
1792                                 options += "executivepaper,";
1793                                 break;
1794                         case BufferParams::PAPER_LEGALPAPER:
1795                                 options += "legalpaper,";
1796                                 break;
1797                         }
1798                 }
1799
1800                 // if needed
1801                 if (params.sides != tclass.sides()) {
1802                         switch (params.sides) {
1803                         case LyXTextClass::OneSide:
1804                                 options += "oneside,";
1805                                 break;
1806                         case LyXTextClass::TwoSides:
1807                                 options += "twoside,";
1808                                 break;
1809                         }
1810
1811                 }
1812
1813                 // if needed
1814                 if (params.columns != tclass.columns()) {
1815                         if (params.columns == 2)
1816                                 options += "twocolumn,";
1817                         else
1818                                 options += "onecolumn,";
1819                 }
1820
1821                 if (!params.use_geometry 
1822                     && params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1823                         options += "landscape,";
1824                 
1825                 // language should be a parameter to \documentclass
1826                 bool use_babel = false;
1827                 if (params.language_info->lang() == "hebrew") // This seems necessary
1828                         features.UsedLanguages.insert(default_language);
1829                 if (params.language != "default" ||
1830                     !features.UsedLanguages.empty() ) {
1831                         use_babel = true;
1832                         for (LaTeXFeatures::LanguageList::const_iterator cit =
1833                                      features.UsedLanguages.begin();
1834                              cit != features.UsedLanguages.end(); ++cit)
1835                                 options += (*cit)->lang() + ",";
1836                         options += params.language_info->lang() + ',';
1837                 }
1838
1839                 // the user-defined options
1840                 if (!params.options.empty()) {
1841                         options += params.options + ',';
1842                 }
1843                 
1844                 if (!options.empty()){
1845                         options = strip(options, ',');
1846                         ofs << '[' << options << ']';
1847                 }
1848                 
1849                 ofs << '{'
1850                     << textclasslist.LatexnameOfClass(params.textclass)
1851                     << "}\n";
1852                 texrow.newline();
1853                 // end of \documentclass defs
1854                 
1855                 // font selection must be done before loading fontenc.sty
1856                 if (params.fonts != "default") {
1857                         ofs << "\\usepackage{" << params.fonts << "}\n";
1858                         texrow.newline();
1859                 }
1860                 // this one is not per buffer
1861                 if (lyxrc.fontenc != "default") {
1862                         ofs << "\\usepackage[" << lyxrc.fontenc
1863                             << "]{fontenc}\n";
1864                         texrow.newline();
1865                 }
1866
1867                 if (params.inputenc == "auto") {
1868                         string const doc_encoding =
1869                                 params.language_info->encoding()->LatexName();
1870
1871                         // Create a list with all the input encodings used 
1872                         // in the document
1873                         set<string> encodings;
1874                         for (LaTeXFeatures::LanguageList::const_iterator it =
1875                                      features.UsedLanguages.begin();
1876                              it != features.UsedLanguages.end(); ++it)
1877                                 if ((*it)->encoding()->LatexName() != doc_encoding)
1878                                         encodings.insert((*it)->encoding()->LatexName());
1879
1880                         ofs << "\\usepackage[";
1881                         for (set<string>::const_iterator it = encodings.begin();
1882                              it != encodings.end(); ++it)
1883                                 ofs << *it << ",";
1884                         ofs << doc_encoding << "]{inputenc}\n";
1885                         texrow.newline();
1886                 } else if (params.inputenc != "default") {
1887                         ofs << "\\usepackage[" << params.inputenc
1888                             << "]{inputenc}\n";
1889                         texrow.newline();
1890                 }
1891
1892                 // At the very beginning the text parameters.
1893                 if (params.paperpackage != BufferParams::PACKAGE_NONE) {
1894                         switch (params.paperpackage) {
1895                         case BufferParams::PACKAGE_A4:
1896                                 ofs << "\\usepackage{a4}\n";
1897                                 texrow.newline();
1898                                 break;
1899                         case BufferParams::PACKAGE_A4WIDE:
1900                                 ofs << "\\usepackage{a4wide}\n";
1901                                 texrow.newline();
1902                                 break;
1903                         case BufferParams::PACKAGE_WIDEMARGINSA4:
1904                                 ofs << "\\usepackage[widemargins]{a4}\n";
1905                                 texrow.newline();
1906                                 break;
1907                         }
1908                 }
1909                 if (params.use_geometry) {
1910                         ofs << "\\usepackage{geometry}\n";
1911                         texrow.newline();
1912                         ofs << "\\geometry{verbose";
1913                         if (params.orientation == BufferParams::ORIENTATION_LANDSCAPE)
1914                                 ofs << ",landscape";
1915                         switch (params.papersize2) {
1916                         case BufferParams::VM_PAPER_CUSTOM:
1917                                 if (!params.paperwidth.empty())
1918                                         ofs << ",paperwidth="
1919                                             << params.paperwidth;
1920                                 if (!params.paperheight.empty())
1921                                         ofs << ",paperheight="
1922                                             << params.paperheight;
1923                                 break;
1924                         case BufferParams::VM_PAPER_USLETTER:
1925                                 ofs << ",letterpaper";
1926                                 break;
1927                         case BufferParams::VM_PAPER_USLEGAL:
1928                                 ofs << ",legalpaper";
1929                                 break;
1930                         case BufferParams::VM_PAPER_USEXECUTIVE:
1931                                 ofs << ",executivepaper";
1932                                 break;
1933                         case BufferParams::VM_PAPER_A3:
1934                                 ofs << ",a3paper";
1935                                 break;
1936                         case BufferParams::VM_PAPER_A4:
1937                                 ofs << ",a4paper";
1938                                 break;
1939                         case BufferParams::VM_PAPER_A5:
1940                                 ofs << ",a5paper";
1941                                 break;
1942                         case BufferParams::VM_PAPER_B3:
1943                                 ofs << ",b3paper";
1944                                 break;
1945                         case BufferParams::VM_PAPER_B4:
1946                                 ofs << ",b4paper";
1947                                 break;
1948                         case BufferParams::VM_PAPER_B5:
1949                                 ofs << ",b5paper";
1950                                 break;
1951                         default:
1952                                 // default papersize ie BufferParams::VM_PAPER_DEFAULT
1953                                 switch (lyxrc.default_papersize) {
1954                                 case BufferParams::PAPER_DEFAULT: // keep compiler happy
1955                                 case BufferParams::PAPER_USLETTER:
1956                                         ofs << ",letterpaper";
1957                                         break;
1958                                 case BufferParams::PAPER_LEGALPAPER:
1959                                         ofs << ",legalpaper";
1960                                         break;
1961                                 case BufferParams::PAPER_EXECUTIVEPAPER:
1962                                         ofs << ",executivepaper";
1963                                         break;
1964                                 case BufferParams::PAPER_A3PAPER:
1965                                         ofs << ",a3paper";
1966                                         break;
1967                                 case BufferParams::PAPER_A4PAPER:
1968                                         ofs << ",a4paper";
1969                                         break;
1970                                 case BufferParams::PAPER_A5PAPER:
1971                                         ofs << ",a5paper";
1972                                         break;
1973                                 case BufferParams::PAPER_B5PAPER:
1974                                         ofs << ",b5paper";
1975                                         break;
1976                                 }
1977                         }
1978                         if (!params.topmargin.empty())
1979                                 ofs << ",tmargin=" << params.topmargin;
1980                         if (!params.bottommargin.empty())
1981                                 ofs << ",bmargin=" << params.bottommargin;
1982                         if (!params.leftmargin.empty())
1983                                 ofs << ",lmargin=" << params.leftmargin;
1984                         if (!params.rightmargin.empty())
1985                                 ofs << ",rmargin=" << params.rightmargin;
1986                         if (!params.headheight.empty())
1987                                 ofs << ",headheight=" << params.headheight;
1988                         if (!params.headsep.empty())
1989                                 ofs << ",headsep=" << params.headsep;
1990                         if (!params.footskip.empty())
1991                                 ofs << ",footskip=" << params.footskip;
1992                         ofs << "}\n";
1993                         texrow.newline();
1994                 }
1995                 if (params.use_amsmath
1996                     && !tclass.provides(LyXTextClass::amsmath)) {
1997                         ofs << "\\usepackage{amsmath}\n";
1998                         texrow.newline();
1999                 }
2000
2001                 if (tokenPos(tclass.opt_pagestyle(),
2002                              '|', params.pagestyle) >= 0) {
2003                         if (params.pagestyle == "fancy") {
2004                                 ofs << "\\usepackage{fancyhdr}\n";
2005                                 texrow.newline();
2006                         }
2007                         ofs << "\\pagestyle{" << params.pagestyle << "}\n";
2008                         texrow.newline();
2009                 }
2010
2011                 // We try to load babel late, in case it interferes
2012                 // with other packages.
2013                 if (use_babel) {
2014                         ofs << lyxrc.language_package << endl;
2015                         texrow.newline();
2016                 }
2017
2018                 if (params.secnumdepth != tclass.secnumdepth()) {
2019                         ofs << "\\setcounter{secnumdepth}{"
2020                             << params.secnumdepth
2021                             << "}\n";
2022                         texrow.newline();
2023                 }
2024                 if (params.tocdepth != tclass.tocdepth()) {
2025                         ofs << "\\setcounter{tocdepth}{"
2026                             << params.tocdepth
2027                             << "}\n";
2028                         texrow.newline();
2029                 }
2030                 
2031                 if (params.paragraph_separation) {
2032                         switch (params.defskip.kind()) {
2033                         case VSpace::SMALLSKIP: 
2034                                 ofs << "\\setlength\\parskip{\\smallskipamount}\n";
2035                                 break;
2036                         case VSpace::MEDSKIP:
2037                                 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2038                                 break;
2039                         case VSpace::BIGSKIP:
2040                                 ofs << "\\setlength\\parskip{\\bigskipamount}\n";
2041                                 break;
2042                         case VSpace::LENGTH:
2043                                 ofs << "\\setlength\\parskip{"
2044                                     << params.defskip.length().asLatexString()
2045                                     << "}\n";
2046                                 break;
2047                         default: // should never happen // Then delete it.
2048                                 ofs << "\\setlength\\parskip{\\medskipamount}\n";
2049                                 break;
2050                         }
2051                         texrow.newline();
2052                         
2053                         ofs << "\\setlength\\parindent{0pt}\n";
2054                         texrow.newline();
2055                 }
2056
2057                 // Now insert the LyX specific LaTeX commands...
2058
2059                 // The optional packages;
2060                 string preamble(features.getPackages());
2061
2062                 // this might be useful...
2063                 preamble += "\n\\makeatletter\n";
2064
2065                 // Some macros LyX will need
2066                 string tmppreamble(features.getMacros());
2067
2068                 if (!tmppreamble.empty()) {
2069                         preamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2070                                 "LyX specific LaTeX commands.\n"
2071                                 + tmppreamble + '\n';
2072                 }
2073
2074                 // the text class specific preamble 
2075                 tmppreamble = features.getTClassPreamble();
2076                 if (!tmppreamble.empty()) {
2077                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2078                                 "Textclass specific LaTeX commands.\n"
2079                                 + tmppreamble + '\n';
2080                 }
2081
2082                 /* the user-defined preamble */
2083                 if (!params.preamble.empty()) {
2084                         preamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2085                                 "User specified LaTeX commands.\n"
2086                                 + params.preamble + '\n';
2087                 }
2088
2089                 preamble += "\\makeatother\n";
2090
2091                 // Itemize bullet settings need to be last in case the user
2092                 // defines their own bullets that use a package included
2093                 // in the user-defined preamble -- ARRae
2094                 // Actually it has to be done much later than that
2095                 // since some packages like frenchb make modifications
2096                 // at \begin{document} time -- JMarc 
2097                 string bullets_def;
2098                 for (int i = 0; i < 4; ++i) {
2099                         if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2100                                 if (bullets_def.empty())
2101                                         bullets_def="\\AtBeginDocument{\n";
2102                                 bullets_def += "  \\renewcommand{\\labelitemi";
2103                                 switch (i) {
2104                                 // `i' is one less than the item to modify
2105                                 case 0:
2106                                         break;
2107                                 case 1:
2108                                         bullets_def += 'i';
2109                                         break;
2110                                 case 2:
2111                                         bullets_def += "ii";
2112                                         break;
2113                                 case 3:
2114                                         bullets_def += 'v';
2115                                         break;
2116                                 }
2117                                 bullets_def += "}{" + 
2118                                   params.user_defined_bullets[i].getText() 
2119                                   + "}\n";
2120                         }
2121                 }
2122
2123                 if (!bullets_def.empty())
2124                   preamble += bullets_def + "}\n\n";
2125
2126                 for (int j = countChar(preamble, '\n'); j-- ;) {
2127                         texrow.newline();
2128                 }
2129
2130                 ofs << preamble;
2131
2132                 // make the body.
2133                 ofs << "\\begin{document}\n";
2134                 texrow.newline();
2135         } // only_body
2136         lyxerr.debug() << "preamble finished, now the body." << endl;
2137         if (!lyxrc.language_auto_begin && params.language != "default") {
2138                 ofs << subst(lyxrc.language_command_begin, "$$lang",
2139                              params.language)
2140                     << endl;
2141                 texrow.newline();
2142         }
2143         
2144         latexParagraphs(ofs, paragraph, 0, texrow);
2145
2146         // add this just in case after all the paragraphs
2147         ofs << endl;
2148         texrow.newline();
2149
2150         if (!lyxrc.language_auto_end && params.language != "default") {
2151                 ofs << subst(lyxrc.language_command_end, "$$lang",
2152                              params.language)
2153                     << endl;
2154                 texrow.newline();
2155         }
2156
2157         if (!only_body) {
2158                 ofs << "\\end{document}\n";
2159                 texrow.newline();
2160         
2161                 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
2162         } else {
2163                 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
2164                                      << endl;
2165         }
2166
2167         // Just to be sure. (Asger)
2168         texrow.newline();
2169
2170         // tex_code_break_column's value is used to decide
2171         // if we are in batchmode or not (within mathed_write()
2172         // in math_write.C) so we must set it to a non-zero
2173         // value when we leave otherwise we save incorrect .lyx files.
2174         tex_code_break_column = lyxrc.ascii_linelen;
2175
2176         ofs.close();
2177         if (ofs.fail()) {
2178                 lyxerr << "File was not closed properly." << endl;
2179         }
2180         
2181         lyxerr.debug() << "Finished making latex file." << endl;
2182 }
2183
2184
2185 //
2186 // LaTeX all paragraphs from par to endpar, if endpar == 0 then to the end
2187 //
2188 void Buffer::latexParagraphs(ostream & ofs, LyXParagraph * par,
2189                              LyXParagraph * endpar, TexRow & texrow) const
2190 {
2191         bool was_title = false;
2192         bool already_title = false;
2193         std::ostringstream ftnote;
2194         TexRow ft_texrow;
2195         int ftcount = 0;
2196
2197         // if only_body
2198         while (par != endpar) {
2199 #ifndef NEW_INSETS
2200                 if (par->IsDummy())
2201                         lyxerr[Debug::LATEX] << "Error in latexParagraphs."
2202                                              << endl;
2203 #endif
2204                 LyXLayout const & layout =
2205                         textclasslist.Style(params.textclass,
2206                                             par->layout);
2207             
2208                 if (layout.intitle) {
2209                         if (already_title) {
2210                                 lyxerr <<"Error in latexParagraphs: You"
2211                                         " should not mix title layouts"
2212                                         " with normal ones." << endl;
2213                         } else
2214                                 was_title = true;
2215                 } else if (was_title && !already_title) {
2216                         ofs << "\\maketitle\n";
2217                         texrow.newline();
2218                         already_title = true;
2219                         was_title = false;                  
2220                 }
2221                 // We are at depth 0 so we can just use
2222                 // ordinary \footnote{} generation
2223                 // flag this with ftcount
2224                 ftcount = -1;
2225                 if (layout.isEnvironment()
2226                     || par->pextra_type != LyXParagraph::PEXTRA_NONE) {
2227                         par = par->TeXEnvironment(this, params, ofs, texrow
2228 #ifndef NEW_INSETS
2229                                                   ,ftnote, ft_texrow, ftcount
2230 #endif
2231                                 );
2232                 } else {
2233                         par = par->TeXOnePar(this, params, ofs, texrow, false
2234 #ifndef NEW_INSETS
2235                                              ,
2236                                              ftnote, ft_texrow, ftcount
2237 #endif
2238                                 );
2239                 }
2240
2241                 // Write out what we've generated...
2242                 if (ftcount >= 1) {
2243                         if (ftcount > 1) {
2244                                 ofs << "\\addtocounter{footnote}{-"
2245                                     << ftcount - 1
2246                                     << '}';
2247                         }
2248                         ofs << ftnote.str();
2249                         texrow += ft_texrow;
2250
2251                         // The extra .c_str() is needed when we use
2252                         // lyxstring instead of the STL string class. 
2253                         ftnote.str(string().c_str());
2254                         ft_texrow.reset();
2255                         ftcount = 0;
2256                 }
2257         }
2258         // It might be that we only have a title in this document
2259         if (was_title && !already_title) {
2260                 ofs << "\\maketitle\n";
2261                 texrow.newline();
2262         }
2263 }
2264
2265
2266 bool Buffer::isLatex() const
2267 {
2268         return textclasslist.TextClass(params.textclass).outputType() == LATEX;
2269 }
2270
2271
2272 bool Buffer::isLinuxDoc() const
2273 {
2274         return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC;
2275 }
2276
2277
2278 bool Buffer::isLiterate() const
2279 {
2280         return textclasslist.TextClass(params.textclass).outputType() == LITERATE;
2281 }
2282
2283
2284 bool Buffer::isDocBook() const
2285 {
2286         return textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2287 }
2288
2289
2290 bool Buffer::isSGML() const
2291 {
2292         return textclasslist.TextClass(params.textclass).outputType() == LINUXDOC ||
2293                textclasslist.TextClass(params.textclass).outputType() == DOCBOOK;
2294 }
2295
2296
2297 void Buffer::sgmlOpenTag(ostream & os, int depth,
2298                          string const & latexname) const
2299 {
2300         os << string(depth, ' ') << "<" << latexname << ">\n";
2301 }
2302
2303
2304 void Buffer::sgmlCloseTag(ostream & os, int depth,
2305                           string const & latexname) const
2306 {
2307         os << string(depth, ' ') << "</" << latexname << ">\n";
2308 }
2309
2310
2311 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
2312 {
2313         LyXParagraph * par = paragraph;
2314
2315         niceFile = nice; // this will be used by Insetincludes.
2316
2317         string top_element = textclasslist.LatexnameOfClass(params.textclass);
2318         string environment_stack[10];
2319         string item_name;
2320
2321         int depth = 0; // paragraph depth
2322
2323         ofstream ofs(fname.c_str());
2324
2325         if (!ofs) {
2326                 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2327                 return;
2328         }
2329
2330         LyXTextClass const & tclass =
2331                 textclasslist.TextClass(params.textclass);
2332
2333         LaTeXFeatures features(params, tclass.numLayouts());
2334         validate(features);
2335
2336         //if(nice)
2337         tex_code_break_column = lyxrc.ascii_linelen;
2338         //else
2339         //tex_code_break_column = 0;
2340
2341         texrow.reset();
2342
2343         if (!body_only) {
2344                 string sgml_includedfiles=features.getIncludedFiles();
2345
2346                 if (params.preamble.empty() && sgml_includedfiles.empty()) {
2347                         ofs << "<!doctype linuxdoc system>\n\n";
2348                 } else {
2349                         ofs << "<!doctype linuxdoc system [ "
2350                             << params.preamble << sgml_includedfiles << " \n]>\n\n";
2351                 }
2352
2353                 if(params.options.empty())
2354                         sgmlOpenTag(ofs, 0, top_element);
2355                 else {
2356                         string top = top_element;
2357                         top += " ";
2358                         top += params.options;
2359                         sgmlOpenTag(ofs, 0, top);
2360                 }
2361         }
2362
2363         ofs << "<!-- "  << LYX_DOCVERSION 
2364             << " created this file. For more info see http://www.lyx.org/"
2365             << " -->\n";
2366
2367         while (par) {
2368                 int desc_on = 0; // description mode
2369                 LyXLayout const & style =
2370                         textclasslist.Style(params.textclass,
2371                                             par->layout);
2372
2373                 // treat <toc> as a special case for compatibility with old code
2374                 if (par->GetChar(0) == LyXParagraph::META_INSET) {
2375                         Inset * inset = par->GetInset(0);
2376                         Inset::Code lyx_code = inset->LyxCode();
2377                         if (lyx_code == Inset::TOC_CODE){
2378                                 string const temp = "toc";
2379                                 sgmlOpenTag(ofs, depth, temp);
2380
2381                                 par = par->next;
2382 #ifndef NEW_INSETS
2383                                 linuxDocHandleFootnote(ofs, par, depth);
2384 #endif
2385                                 continue;
2386                         }
2387                 }
2388
2389                 // environment tag closing
2390                 for (; depth > par->depth; --depth) {
2391                         sgmlCloseTag(ofs, depth, environment_stack[depth]);
2392                         environment_stack[depth].erase();
2393                 }
2394
2395                 // write opening SGML tags
2396                 switch (style.latextype) {
2397                 case LATEX_PARAGRAPH:
2398                         if(depth == par->depth 
2399                            && !environment_stack[depth].empty()) {
2400                                 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2401                                 environment_stack[depth].erase();
2402                                 if(depth) 
2403                                         --depth;
2404                                 else
2405                                         ofs << "</p>";
2406                         }
2407                         sgmlOpenTag(ofs, depth, style.latexname());
2408                         break;
2409
2410                 case LATEX_COMMAND:
2411                         if (depth!= 0)
2412                                 LinuxDocError(par, 0,
2413                                               _("Error : Wrong depth for"
2414                                                 " LatexType Command.\n"));
2415
2416                         if (!environment_stack[depth].empty()){
2417                                 sgmlCloseTag(ofs, depth,
2418                                              environment_stack[depth]);
2419                                 ofs << "</p>";
2420                         }
2421
2422                         environment_stack[depth].erase();
2423                         sgmlOpenTag(ofs, depth, style.latexname());
2424                         break;
2425
2426                 case LATEX_ENVIRONMENT:
2427                 case LATEX_ITEM_ENVIRONMENT:
2428                         if (depth == par->depth 
2429                            && environment_stack[depth] != style.latexname()
2430                            && !environment_stack[depth].empty()) {
2431
2432                                 sgmlCloseTag(ofs, depth,
2433                                              environment_stack[depth]);
2434                                 environment_stack[depth].erase();
2435                         }
2436                         if (depth < par->depth) {
2437                                depth = par->depth;
2438                                environment_stack[depth].erase();
2439                         }
2440                         if (environment_stack[depth] != style.latexname()) {
2441                                 if(depth == 0) {
2442                                         string const temp = "p";
2443                                         sgmlOpenTag(ofs, depth, temp);
2444                                 }
2445                                 environment_stack[depth] = style.latexname();
2446                                 sgmlOpenTag(ofs, depth,
2447                                             environment_stack[depth]);
2448                         }
2449                         if(style.latextype == LATEX_ENVIRONMENT) break;
2450
2451                         desc_on = (style.labeltype == LABEL_MANUAL);
2452
2453                         if(desc_on)
2454                                 item_name = "tag";
2455                         else
2456                                 item_name = "item";
2457
2458                         sgmlOpenTag(ofs, depth + 1, item_name);
2459                         break;
2460                 default:
2461                         sgmlOpenTag(ofs, depth, style.latexname());
2462                         break;
2463                 }
2464
2465 #ifndef NEW_INSETS
2466                 do {
2467 #endif
2468                         SimpleLinuxDocOnePar(ofs, par, desc_on, depth);
2469
2470                         par = par->next;
2471 #ifndef NEW_INSETS
2472                         linuxDocHandleFootnote(ofs, par, depth);
2473                 }
2474                 while(par && par->IsDummy());
2475 #endif
2476
2477                 ofs << "\n";
2478                 // write closing SGML tags
2479                 switch(style.latextype) {
2480                 case LATEX_COMMAND:
2481                 case LATEX_ENVIRONMENT:
2482                 case LATEX_ITEM_ENVIRONMENT:
2483                         break;
2484                 default:
2485                         sgmlCloseTag(ofs, depth, style.latexname());
2486                         break;
2487                 }
2488         }
2489    
2490         // Close open tags
2491         for(; depth > 0; --depth)
2492                 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2493
2494         if(!environment_stack[depth].empty())
2495                 sgmlCloseTag(ofs, depth, environment_stack[depth]);
2496
2497         if (!body_only) {
2498                 ofs << "\n\n";
2499                 sgmlCloseTag(ofs, 0, top_element);
2500         }
2501
2502         ofs.close();
2503         // How to check for successful close
2504 }
2505
2506
2507 #ifndef NEW_INSETS
2508 void Buffer::linuxDocHandleFootnote(ostream & os, LyXParagraph * & par,
2509                                     int const depth)
2510 {
2511         string const tag = "footnote";
2512
2513         while (par && par->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
2514                 sgmlOpenTag(os, depth + 1, tag);
2515                 SimpleLinuxDocOnePar(os, par, 0, depth + 1);
2516                 sgmlCloseTag(os, depth + 1, tag);
2517                 par = par->next;
2518         }
2519 }
2520 #endif
2521
2522
2523 void Buffer::DocBookHandleCaption(ostream & os, string & inner_tag,
2524                                   int const depth, int desc_on,
2525                                   LyXParagraph * & par)
2526 {
2527         LyXParagraph * tpar = par;
2528         while (tpar
2529 #ifndef NEW_INSETS
2530                && (tpar->footnoteflag != LyXParagraph::NO_FOOTNOTE)
2531 #endif
2532                && (tpar->layout != textclasslist.NumberOfLayout(params.textclass,
2533                                                              "Caption").second))
2534                 tpar = tpar->next;
2535         if (tpar &&
2536             tpar->layout == textclasslist.NumberOfLayout(params.textclass,
2537                                                          "Caption").second) {
2538                 sgmlOpenTag(os, depth + 1, inner_tag);
2539                 string extra_par;
2540                 SimpleDocBookOnePar(os, extra_par, tpar,
2541                                     desc_on, depth + 2);
2542                 sgmlCloseTag(os, depth+1, inner_tag);
2543                 if(!extra_par.empty())
2544                         os << extra_par;
2545         }
2546 }
2547
2548
2549 #ifndef NEW_INSETS
2550 void Buffer::DocBookHandleFootnote(ostream & os, LyXParagraph * & par,
2551                                    int const depth)
2552 {
2553         string tag, inner_tag;
2554         string tmp_par, extra_par;
2555         bool inner_span = false;
2556         int desc_on = 4;
2557
2558         // Someone should give this enum a proper name (Lgb)
2559         enum SOME_ENUM {
2560                 NO_ONE,
2561                 FOOTNOTE_LIKE,
2562                 MARGIN_LIKE,
2563                 FIG_LIKE,
2564                 TAB_LIKE
2565         };
2566         SOME_ENUM last = NO_ONE;
2567         SOME_ENUM present = FOOTNOTE_LIKE;
2568
2569         while (par && par->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
2570                 if (last == present) {
2571                         if (inner_span) {
2572                                 if (!tmp_par.empty()) {
2573                                         os << tmp_par;
2574                                         tmp_par.erase();
2575                                         sgmlCloseTag(os, depth + 1, inner_tag);
2576                                         sgmlOpenTag(os, depth + 1, inner_tag);
2577                                 }
2578                         } else {
2579                                 os << "\n";
2580                         }
2581                 } else {
2582                         os << tmp_par;
2583                         if (!inner_tag.empty()) sgmlCloseTag(os, depth + 1,
2584                                                             inner_tag);
2585                         if (!extra_par.empty()) os << extra_par;
2586                         if (!tag.empty()) sgmlCloseTag(os, depth, tag);
2587                         extra_par.erase();
2588
2589                         switch (par->footnotekind) {
2590                         case LyXParagraph::FOOTNOTE:
2591                         case LyXParagraph::ALGORITHM:
2592                                 tag = "footnote";
2593                                 inner_tag = "para";
2594                                 present = FOOTNOTE_LIKE;
2595                                 inner_span = true;
2596                                 break;
2597                         case LyXParagraph::MARGIN:
2598                                 tag = "sidebar";
2599                                 inner_tag = "para";
2600                                 present = MARGIN_LIKE;
2601                                 inner_span = true;
2602                                 break;
2603                         case LyXParagraph::FIG:
2604                         case LyXParagraph::WIDE_FIG:
2605                                 tag = "figure";
2606                                 inner_tag = "title";
2607                                 present = FIG_LIKE;
2608                                 inner_span = false;
2609                                 break;
2610                         case LyXParagraph::TAB:
2611                         case LyXParagraph::WIDE_TAB:
2612                                 tag = "table";
2613                                 inner_tag = "title";
2614                                 present = TAB_LIKE;
2615                                 inner_span = false;
2616                                 break;
2617                         }
2618                         sgmlOpenTag(os, depth, tag);
2619                         if ((present == TAB_LIKE) || (present == FIG_LIKE)) {
2620                                 DocBookHandleCaption(os, inner_tag, depth,
2621                                                      desc_on, par);
2622                                 inner_tag.erase();
2623                         } else {
2624                                 sgmlOpenTag(os, depth + 1, inner_tag);
2625                         }
2626                 }
2627                 // ignore all caption here, we processed them above!!!
2628                 if (par->layout != textclasslist
2629                     .NumberOfLayout(params.textclass,
2630                                     "Caption").second) {
2631                         std::ostringstream ost;
2632                         SimpleDocBookOnePar(ost, extra_par, par,
2633                                             desc_on, depth + 2);
2634                         tmp_par += ost.str().c_str();
2635                 }
2636                 tmp_par = frontStrip(strip(tmp_par));
2637
2638                 last = present;
2639                 par = par->next;
2640         }
2641         os << tmp_par;
2642         if(!inner_tag.empty()) sgmlCloseTag(os, depth + 1, inner_tag);
2643         if(!extra_par.empty()) os << extra_par;
2644         if(!tag.empty()) sgmlCloseTag(os, depth, tag);
2645 }
2646 #endif
2647
2648
2649 // push a tag in a style stack
2650 void Buffer::push_tag(ostream & os, string const & tag,
2651                       int & pos, char stack[5][3])
2652 {
2653 #warning Use a real stack! (Lgb)
2654         // pop all previous tags
2655         for (int j = pos; j >= 0; --j)
2656                 os << "</" << stack[j] << ">";
2657
2658         // add new tag
2659         sprintf(stack[++pos], "%s", tag.c_str());
2660
2661         // push all tags
2662         for (int i = 0; i <= pos; ++i)
2663                 os << "<" << stack[i] << ">";
2664 }
2665
2666
2667 void Buffer::pop_tag(ostream & os, string const & tag,
2668                      int & pos, char stack[5][3])
2669 {
2670 #ifdef WITH_WARNINGS
2671 #warning Use a real stack! (Lgb)
2672 #endif
2673         // Please, Lars, do not remove the global variable. I already
2674         // had to reintroduce it twice! (JMarc) 
2675         int j;
2676         
2677         // pop all tags till specified one
2678         for (j = pos; (j >= 0) && (strcmp(stack[j], tag.c_str())); --j)
2679                 os << "</" << stack[j] << ">";
2680
2681         // closes the tag
2682         os << "</" << tag << ">";
2683         
2684         // push all tags, but the specified one
2685         for (j = j + 1; j <= pos; ++j) {
2686                 os << "<" << stack[j] << ">";
2687                 strcpy(stack[j-1], stack[j]);
2688         }
2689         --pos;
2690 }
2691
2692
2693 // Handle internal paragraph parsing -- layout already processed.
2694
2695 // checks, if newcol chars should be put into this line
2696 // writes newline, if necessary.
2697 static
2698 void linux_doc_line_break(ostream & os, unsigned int & colcount,
2699                           const unsigned int newcol)
2700 {
2701         colcount += newcol;
2702         if (colcount > lyxrc.ascii_linelen) {
2703                 os << "\n";
2704                 colcount = newcol; // assume write after this call
2705         }
2706 }
2707
2708
2709 void Buffer::SimpleLinuxDocOnePar(ostream & os, LyXParagraph * par,
2710                                   int desc_on, int const /*depth*/)
2711 {
2712         LyXFont font1;
2713         char c;
2714         Inset * inset;
2715         LyXParagraph::size_type main_body;
2716         int j;
2717         LyXLayout const & style = textclasslist.Style(params.textclass,
2718                                                       par->GetLayout());
2719
2720         char family_type = 0;               // family font flag 
2721         bool is_bold     = false;           // series font flag 
2722         char shape_type  = 0;               // shape font flag 
2723         bool is_em = false;                 // emphasis (italic) font flag 
2724
2725         int stack_num = -1;          // style stack position
2726         // Can this be rewritten to use a std::stack, please. (Lgb)
2727         char stack[5][3];            // style stack 
2728         unsigned int char_line_count = 5;     // Heuristic choice ;-) 
2729
2730         if (style.labeltype != LABEL_MANUAL)
2731                 main_body = 0;
2732         else
2733                 main_body = par->BeginningOfMainBody();
2734
2735         // gets paragraph main font
2736         if (main_body > 0)
2737                 font1 = style.labelfont;
2738         else
2739                 font1 = style.font;
2740
2741   
2742         // parsing main loop
2743         for (LyXParagraph::size_type i = 0;
2744              i < par->size(); ++i) {
2745
2746                 // handle quote tag
2747                 if (i == main_body
2748 #ifndef NEW_INSETS
2749                     && !par->IsDummy()
2750 #endif
2751                         ) {
2752                         if (main_body > 0)
2753                                 font1 = style.font;
2754                 }
2755
2756                 LyXFont const font2 = par->getFont(params, i);
2757
2758                 if (font1.family() != font2.family()) {
2759                         switch(family_type) {
2760                         case 0:
2761                                 if (font2.family() == LyXFont::TYPEWRITER_FAMILY) {
2762                                         push_tag(os, "tt", stack_num, stack);
2763                                         family_type = 1;
2764                                 }
2765                                 else if (font2.family() == LyXFont::SANS_FAMILY) {
2766                                         push_tag(os, "sf", stack_num, stack);
2767                                         family_type = 2;
2768                                 }
2769                                 break;
2770                         case 1:
2771                                 pop_tag(os, "tt", stack_num, stack);
2772                                 if (font2.family() == LyXFont::SANS_FAMILY) {
2773                                         push_tag(os, "sf", stack_num, stack);
2774                                         family_type = 2;
2775                                 } else {
2776                                         family_type = 0;
2777                                 }
2778                                 break;
2779                         case 2:
2780                                 pop_tag(os, "sf", stack_num, stack);
2781                                 if (font2.family() == LyXFont::TYPEWRITER_FAMILY) {
2782                                         push_tag(os, "tt", stack_num, stack);
2783                                         family_type = 1;
2784                                 } else {
2785                                         family_type = 0;
2786                                 }
2787                         }
2788                 }
2789
2790                 // handle bold face
2791                 if (font1.series() != font2.series()) {
2792                         if (font2.series() == LyXFont::BOLD_SERIES) {
2793                                 push_tag(os, "bf", stack_num, stack);
2794                                 is_bold = true;
2795                         } else if (is_bold) {
2796                                 pop_tag(os, "bf", stack_num, stack);
2797                                 is_bold = false;
2798                         }
2799                 }
2800
2801                 // handle italic and slanted fonts
2802                 if (font1.shape() != font2.shape()) {
2803                         switch(shape_type) {
2804                         case 0:
2805                                 if (font2.shape() == LyXFont::ITALIC_SHAPE) {
2806                                         push_tag(os, "it", stack_num, stack);
2807                                         shape_type = 1;
2808                                 } else if (font2.shape() == LyXFont::SLANTED_SHAPE) {
2809                                         push_tag(os, "sl", stack_num, stack);
2810                                         shape_type = 2;
2811                                 }
2812                                 break;
2813                         case 1:
2814                                 pop_tag(os, "it", stack_num, stack);
2815                                 if (font2.shape() == LyXFont::SLANTED_SHAPE) {
2816                                         push_tag(os, "sl", stack_num, stack);
2817                                         shape_type = 2;
2818                                 } else {
2819                                         shape_type = 0;
2820                                 }
2821                                 break;
2822                         case 2:
2823                                 pop_tag(os, "sl", stack_num, stack);
2824                                 if (font2.shape() == LyXFont::ITALIC_SHAPE) {
2825                                         push_tag(os, "it", stack_num, stack);
2826                                         shape_type = 1;
2827                                 } else {
2828                                         shape_type = 0;
2829                                 }
2830                         }
2831                 }
2832                 // handle <em> tag
2833                 if (font1.emph() != font2.emph()) {
2834                         if (font2.emph() == LyXFont::ON) {
2835                                 push_tag(os, "em", stack_num, stack);
2836                                 is_em = true;
2837                         } else if (is_em) {
2838                                 pop_tag(os, "em", stack_num, stack);
2839                                 is_em = false;
2840                         }
2841                 }
2842
2843                 c = par->GetChar(i);
2844
2845                 if (c == LyXParagraph::META_INSET) {
2846                         inset = par->GetInset(i);
2847                         inset->Linuxdoc(this, os);
2848                 }
2849
2850                 if (font2.latex() == LyXFont::ON) {
2851                         // "TeX"-Mode on == > SGML-Mode on.
2852                         if (c != '\0')
2853                                 os << c; // see LaTeX-Generation...
2854                         ++char_line_count;
2855                 } else {
2856                         string sgml_string;
2857                         if (par->linuxDocConvertChar(c, sgml_string)
2858                             && !style.free_spacing) { // in freespacing
2859                                                      // mode, spaces are
2860                                                      // non-breaking characters
2861                                 // char is ' '
2862                                 if (desc_on == 1) {
2863                                         ++char_line_count;
2864                                         linux_doc_line_break(os, char_line_count, 6);
2865                                         os << "</tag>";
2866                                         desc_on = 2;
2867                                 } else  {
2868                                         linux_doc_line_break(os, char_line_count, 1);
2869                                         os << c;
2870                                 }
2871                         } else {
2872                                 os << sgml_string;
2873                                 char_line_count += sgml_string.length();
2874                         }
2875                 }
2876                 font1 = font2;
2877         }
2878
2879         // needed if there is an optional argument but no contents
2880         if (main_body > 0 && main_body == par->size()) {
2881                 font1 = style.font;
2882         }
2883
2884         // pop all defined Styles
2885         for (j = stack_num; j >= 0; --j) {
2886                 linux_doc_line_break(os, 
2887                                      char_line_count, 
2888                                      3 + strlen(stack[j]));
2889                 os << "</" << stack[j] << ">";
2890         }
2891
2892         // resets description flag correctly
2893         switch(desc_on){
2894         case 1:
2895                 // <tag> not closed...
2896                 linux_doc_line_break(os, char_line_count, 6);
2897                 os << "</tag>";
2898                 break;
2899         case 2:
2900                 // fprintf(file, "</p>");
2901                 break;
2902         }
2903 }
2904
2905
2906 // Print an error message.
2907 void Buffer::LinuxDocError(LyXParagraph * par, int pos,
2908                            string const & message) 
2909 {
2910         // insert an error marker in text
2911         InsetError * new_inset = new InsetError(message);
2912         par->InsertInset(pos, new_inset);
2913 }
2914
2915 // This constant defines the maximum number of 
2916 // environment layouts that can be nesteded.
2917 // The same applies for command layouts.
2918 // These values should be more than enough.
2919 //           José Matos (1999/07/22)
2920
2921 enum { MAX_NEST_LEVEL = 25};
2922
2923 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
2924 {
2925         LyXParagraph * par = paragraph;
2926
2927         niceFile = nice; // this will be used by Insetincludes.
2928
2929         string top_element= textclasslist.LatexnameOfClass(params.textclass);
2930         // Please use a real stack.
2931         string environment_stack[MAX_NEST_LEVEL];
2932         string environment_inner[MAX_NEST_LEVEL];
2933         // Please use a real stack.
2934         string command_stack[MAX_NEST_LEVEL];
2935         bool command_flag= false;
2936         int command_depth= 0, command_base= 0, cmd_depth= 0;
2937
2938         string item_name, command_name;
2939         string c_depth, c_params, tmps;
2940
2941         int depth = 0; // paragraph depth
2942         LyXTextClass const & tclass =
2943                 textclasslist.TextClass(params.textclass);
2944
2945         LaTeXFeatures features(params, tclass.numLayouts());
2946         validate(features);
2947
2948         //if(nice)
2949         tex_code_break_column = lyxrc.ascii_linelen;
2950         //else
2951         //tex_code_break_column = 0;
2952
2953         ofstream ofs(fname.c_str());
2954         if (!ofs) {
2955                 WriteAlert(_("LYX_ERROR:"), _("Cannot write file"), fname);
2956                 return;
2957         }
2958    
2959         texrow.reset();
2960
2961         if(!only_body) {
2962                 string sgml_includedfiles=features.getIncludedFiles();
2963
2964                 ofs << "<!doctype " << top_element
2965                     << " public \"-//OASIS//DTD DocBook V3.1//EN\"";
2966
2967                 if (params.preamble.empty() && sgml_includedfiles.empty())
2968                         ofs << ">\n\n";
2969                 else
2970                         ofs << "\n [ " << params.preamble 
2971                             << sgml_includedfiles << " \n]>\n\n";
2972
2973                 if(params.options.empty())
2974                         sgmlOpenTag(ofs, 0, top_element);
2975                 else {
2976                         string top = top_element;
2977                         top += " ";
2978                         top += params.options;
2979                         sgmlOpenTag(ofs, 0, top);
2980                 }
2981         }
2982
2983         ofs << "<!-- DocBook file was created by " << LYX_DOCVERSION 
2984             << "\n  See http://www.lyx.org/ for more information -->\n";
2985
2986         while (par) {
2987                 int desc_on = 0; // description mode
2988                 LyXLayout const & style =
2989                         textclasslist.Style(params.textclass,
2990                                             par->layout);
2991
2992                 // environment tag closing
2993                 for( ; depth > par->depth; --depth) {
2994                         if(environment_inner[depth] != "!-- --") {
2995                                 item_name= "listitem";
2996                                 sgmlCloseTag(ofs, command_depth + depth,
2997                                              item_name);
2998                                 if( environment_inner[depth] == "varlistentry")
2999                                         sgmlCloseTag(ofs, depth+command_depth,
3000                                                      environment_inner[depth]);
3001                         }
3002                         sgmlCloseTag(ofs, depth + command_depth,
3003                                      environment_stack[depth]);
3004                         environment_stack[depth].erase();
3005                         environment_inner[depth].erase();
3006                 }
3007
3008                 if(depth == par->depth
3009                    && environment_stack[depth] != style.latexname()
3010                    && !environment_stack[depth].empty()) {
3011                         if(environment_inner[depth] != "!-- --") {
3012                                 item_name= "listitem";
3013                                 sgmlCloseTag(ofs, command_depth+depth,
3014                                              item_name);
3015                                 if( environment_inner[depth] == "varlistentry")
3016                                         sgmlCloseTag(ofs,
3017                                                      depth + command_depth,
3018                                                      environment_inner[depth]);
3019                         }
3020                         
3021                         sgmlCloseTag(ofs, depth + command_depth,
3022                                      environment_stack[depth]);
3023                         
3024                         environment_stack[depth].erase();
3025                         environment_inner[depth].erase();
3026                 }
3027
3028                 // Write opening SGML tags.
3029                 switch(style.latextype) {
3030                 case LATEX_PARAGRAPH:
3031                         if(style.latexname() != "dummy")
3032                                sgmlOpenTag(ofs, depth+command_depth,
3033                                            style.latexname());
3034                         break;
3035
3036                 case LATEX_COMMAND:
3037                         if (depth!= 0)
3038                                 LinuxDocError(par, 0,
3039                                               _("Error : Wrong depth for "
3040                                                 "LatexType Command.\n"));
3041                         
3042                         command_name = style.latexname();
3043                         
3044                         tmps = style.latexparam();
3045                         c_params = split(tmps, c_depth,'|');
3046                         
3047                         cmd_depth= lyx::atoi(c_depth);
3048                         
3049                         if(command_flag) {
3050                                 if(cmd_depth<command_base) {
3051                                         for(int j = command_depth;
3052                                             j >= command_base; --j)
3053                                                 if(!command_stack[j].empty())
3054                                                         sgmlCloseTag(ofs, j, command_stack[j]);
3055                                         command_depth= command_base= cmd_depth;
3056                                 } else if(cmd_depth <= command_depth) {
3057                                         for(int j = command_depth;
3058                                             j >= cmd_depth; --j)
3059
3060                                                 if(!command_stack[j].empty())
3061                                                         sgmlCloseTag(ofs, j, command_stack[j]);
3062                                         command_depth= cmd_depth;
3063                                 } else
3064                                         command_depth= cmd_depth;
3065                         } else {
3066                                 command_depth = command_base = cmd_depth;
3067                                 command_flag = true;
3068                         }
3069                         command_stack[command_depth]= command_name;
3070
3071                         // treat label as a special case for
3072                         // more WYSIWYM handling.
3073                         if (par->GetChar(0) == LyXParagraph::META_INSET) {
3074                                 Inset * inset = par->GetInset(0);
3075                                 Inset::Code lyx_code = inset->LyxCode();
3076                                 if (lyx_code == Inset::LABEL_CODE){
3077                                         command_name += " id=\"";
3078                                         command_name += (static_cast<InsetCommand *>(inset))->getContents();
3079                                         command_name += "\"";
3080                                         desc_on = 3;
3081                                 }
3082                         }
3083
3084                         sgmlOpenTag(ofs, depth + command_depth, command_name);
3085                         item_name = "title";
3086                         sgmlOpenTag(ofs, depth + 1 + command_depth, item_name);
3087                         break;
3088
3089                 case LATEX_ENVIRONMENT:
3090                 case LATEX_ITEM_ENVIRONMENT:
3091                         if (depth < par->depth) {
3092                                 depth = par->depth;
3093                                 environment_stack[depth].erase();
3094                         }
3095
3096                         if (environment_stack[depth] != style.latexname()) {
3097                                 environment_stack[depth] = style.latexname();
3098                                 environment_inner[depth] = "!-- --";
3099                                 sgmlOpenTag(ofs, depth + command_depth,
3100                                             environment_stack[depth]);
3101                         } else {
3102                                 if(environment_inner[depth] != "!-- --") {
3103                                         item_name= "listitem";
3104                                         sgmlCloseTag(ofs,
3105                                                      command_depth + depth,
3106                                                      item_name);
3107                                         if (environment_inner[depth] == "varlistentry")
3108                                                 sgmlCloseTag(ofs,
3109                                                              depth + command_depth,
3110                                                              environment_inner[depth]);
3111                                 }
3112                         }
3113                         
3114                         if(style.latextype == LATEX_ENVIRONMENT) {
3115                                 if(!style.latexparam().empty())
3116                                         sgmlOpenTag(ofs, depth + command_depth,
3117                                                     style.latexparam());
3118                                 break;
3119                         }
3120
3121                         desc_on = (style.labeltype == LABEL_MANUAL);
3122
3123                         if(desc_on)
3124                                 environment_inner[depth]= "varlistentry";
3125                         else
3126                                 environment_inner[depth]= "listitem";
3127
3128                         sgmlOpenTag(ofs, depth + 1 + command_depth,
3129                                     environment_inner[depth]);
3130
3131                         if(desc_on) {
3132                                 item_name= "term";
3133                                 sgmlOpenTag(ofs, depth + 1 + command_depth,
3134                                             item_name);
3135                         } else {
3136                                 item_name= "para";
3137                                 sgmlOpenTag(ofs, depth + 1 + command_depth,
3138                                             item_name);
3139                         }
3140                         break;
3141                 default:
3142                         sgmlOpenTag(ofs, depth + command_depth,
3143                                     style.latexname());
3144                         break;
3145                 }
3146
3147 #ifndef NEW_INSETS
3148                 do {
3149 #endif
3150                         string extra_par;
3151                         SimpleDocBookOnePar(ofs, extra_par, par, desc_on,
3152                                             depth + 1 + command_depth);
3153                         par = par->next;
3154 #ifndef NEW_INSETS
3155                         DocBookHandleFootnote(ofs, par,
3156                                               depth + 1 + command_depth);
3157                 }
3158                 while(par && par->IsDummy());
3159 #endif
3160                 string end_tag;
3161                 // write closing SGML tags
3162                 switch(style.latextype) {
3163                 case LATEX_COMMAND:
3164                         end_tag = "title";
3165                         sgmlCloseTag(ofs, depth + command_depth, end_tag);
3166                         break;
3167                 case LATEX_ENVIRONMENT:
3168                         if(!style.latexparam().empty())
3169                                 sgmlCloseTag(ofs, depth + command_depth,
3170                                              style.latexparam());
3171                         break;
3172                 case LATEX_ITEM_ENVIRONMENT:
3173                         if(desc_on == 1) break;
3174                         end_tag= "para";
3175                         sgmlCloseTag(ofs, depth + 1 + command_depth, end_tag);
3176                         break;
3177                 case LATEX_PARAGRAPH:
3178                         if(style.latexname() != "dummy")
3179                                 sgmlCloseTag(ofs, depth + command_depth,
3180                                              style.latexname());
3181                         break;
3182                 default:
3183                         sgmlCloseTag(ofs, depth + command_depth,
3184                                      style.latexname());
3185                         break;
3186                 }
3187         }
3188
3189         // Close open tags
3190         for(; depth >= 0; --depth) {
3191                 if(!environment_stack[depth].empty()) {
3192                         if(environment_inner[depth] != "!-- --") {
3193                                 item_name= "listitem";
3194                                 sgmlCloseTag(ofs, command_depth + depth,
3195                                              item_name);
3196                                if( environment_inner[depth] == "varlistentry")
3197                                        sgmlCloseTag(ofs, depth + command_depth,
3198                                                     environment_inner[depth]);
3199                         }
3200                         
3201                         sgmlCloseTag(ofs, depth + command_depth,
3202                                      environment_stack[depth]);
3203                 }
3204         }
3205         
3206         for(int j = command_depth; j >= command_base; --j)
3207                 if(!command_stack[j].empty())
3208                         sgmlCloseTag(ofs, j, command_stack[j]);
3209
3210         if (!only_body) {
3211                 ofs << "\n\n";
3212                 sgmlCloseTag(ofs, 0, top_element);
3213         }
3214
3215         ofs.close();
3216         // How to check for successful close
3217 }
3218
3219
3220 void Buffer::SimpleDocBookOnePar(ostream & os, string & extra,
3221                                  LyXParagraph * par, int & desc_on,
3222                                  int const depth) 
3223 {
3224         bool emph_flag = false;
3225
3226         LyXLayout const & style = textclasslist.Style(params.textclass,
3227                                                       par->GetLayout());
3228
3229         LyXParagraph::size_type main_body;
3230         if (style.labeltype != LABEL_MANUAL)
3231                 main_body = 0;
3232         else
3233                 main_body = par->BeginningOfMainBody();
3234
3235         // gets paragraph main font
3236         LyXFont font1 = main_body > 0 ? style.labelfont : style.font;
3237         
3238         int char_line_count = depth;
3239         if(!style.free_spacing)
3240                 for (int j = 0; j < depth; ++j)
3241                         os << ' ';
3242
3243         // parsing main loop
3244         for (LyXParagraph::size_type i = 0;
3245              i < par->size(); ++i) {
3246                 LyXFont font2 = par->getFont(params, i);
3247
3248                 // handle <emphasis> tag
3249                 if (font1.emph() != font2.emph() && i) {
3250                         if (font2.emph() == LyXFont::ON) {
3251                                 os << "<emphasis>";
3252                                 emph_flag = true;
3253                         }else {
3254                                 os << "</emphasis>";
3255                                 emph_flag = false;
3256                         }
3257                 }
3258       
3259                 char c = par->GetChar(i);
3260
3261                 if (c == LyXParagraph::META_INSET) {
3262                         Inset * inset = par->GetInset(i);
3263                         std::ostringstream ost;
3264                         inset->DocBook(this, ost);
3265                         string tmp_out = ost.str().c_str();
3266
3267                         //
3268                         // This code needs some explanation:
3269                         // Two insets are treated specially
3270                         //   label if it is the first element in a command paragraph
3271                         //         desc_on == 3
3272                         //   graphics inside tables or figure floats can't go on
3273                         //   title (the equivalente in latex for this case is caption
3274                         //   and title should come first
3275                         //         desc_on == 4
3276                         //
3277                         if(desc_on!= 3 || i!= 0) {
3278                                 if(!tmp_out.empty() && tmp_out[0] == '@') {
3279                                         if(desc_on == 4)
3280                                                 extra += frontStrip(tmp_out, '@');
3281                                         else
3282                                                 os << frontStrip(tmp_out, '@');
3283                                 }
3284                                 else
3285                                         os << tmp_out;
3286                         }
3287                 } else if (font2.latex() == LyXFont::ON) {
3288                         // "TeX"-Mode on ==> SGML-Mode on.
3289                         if (c != '\0')
3290                                 os << c;
3291                         ++char_line_count;
3292                 } else {
3293                         string sgml_string;
3294                         if (par->linuxDocConvertChar(c, sgml_string)
3295                             && !style.free_spacing) { // in freespacing
3296                                                      // mode, spaces are
3297                                                      // non-breaking characters
3298                                 // char is ' '
3299                                 if (desc_on == 1) {
3300                                         ++char_line_count;
3301                                         os << "\n</term><listitem><para>";
3302                                         desc_on = 2;
3303                                 } else {
3304                                         os << c;
3305                                 }
3306                         } else {
3307                                 os << sgml_string;
3308                         }
3309                 }
3310                 font1 = font2;
3311         }
3312
3313         // needed if there is an optional argument but no contents
3314         if (main_body > 0 && main_body == par->size()) {
3315                 font1 = style.font;
3316         }
3317         if (emph_flag) {
3318                 os << "</emphasis>";
3319         }
3320         
3321         // resets description flag correctly
3322         switch(desc_on){
3323         case 1:
3324                 // <term> not closed...
3325                 os << "</term>";
3326                 break;
3327         }
3328         os << '\n';
3329 }
3330
3331
3332 int Buffer::runLiterate()
3333 {
3334         if (!users->text) return 0;
3335
3336         ProhibitInput(users);
3337
3338         // get LaTeX-Filename
3339         string name = getLatexName();
3340         // get Literate-Filename
3341         string lit_name = OnlyFilename(ChangeExtension (getLatexName(), 
3342                                            lyxrc.literate_extension));
3343
3344         string path = OnlyPath(filename);
3345
3346         string org_path = path;
3347         if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1)) {
3348                 path = tmppath;  
3349         }
3350
3351         Path p(path); // path to Literate file
3352         users->owner()->getMiniBuffer()->Set(_("Running Literate..."));   
3353
3354         // Remove all error insets
3355         bool removedErrorInsets = users->removeAutoInsets();
3356
3357         // generate the Literate file if necessary
3358         makeLaTeXFile(lit_name, org_path, false);
3359
3360         string latex_command = lyxrc.pdf_mode ?
3361                 lyxrc.pdflatex_command : lyxrc.latex_command;
3362         Literate literate(latex_command, name, filepath, 
3363                           lit_name,
3364                           lyxrc.literate_command, lyxrc.literate_error_filter,
3365                           lyxrc.build_command, lyxrc.build_error_filter);
3366         TeXErrors terr;
3367         int res = literate.weave(terr, users->owner()->getMiniBuffer());
3368
3369         // check return value from literate.weave().
3370         if ((res & Literate::NO_LOGFILE)) {
3371                 WriteAlert(_("Literate command did not work!"),
3372                            _("Missing log file:"), name);
3373         } else if ((res & Literate::ERRORS)) {
3374                 users->owner()->getMiniBuffer()->Set(_("Done"));
3375                 // Insert all errors as errors boxes
3376                 users->insertErrors(terr);
3377                 
3378                 // Dvi should also be kept dirty if the latex run
3379                 // ends up with errors. However it should be possible
3380                 // to view a dirty dvi too.
3381         } else {
3382                 //no errors or any other things to think about so:
3383                 users->owner()->getMiniBuffer()->Set(_("Done"));
3384         }
3385
3386         // if we removed error insets before we ran LaTeX or if we inserted
3387         // error insets after we ran LaTeX this must be run:
3388         if (removedErrorInsets || (res & Literate::ERRORS)){
3389                 users->redraw();
3390                 users->fitCursor();
3391                 //users->updateScrollbar();
3392         }
3393         AllowInput(users);
3394  
3395         return literate.getNumErrors();
3396 }
3397
3398
3399 int Buffer::buildProgram()
3400 {
3401         if (!users->text) return 0;
3402  
3403         ProhibitInput(users);
3404  
3405         // get LaTeX-Filename
3406         string name = getLatexName();
3407         // get Literate-Filename
3408         string lit_name = OnlyFilename(ChangeExtension(getLatexName(), 
3409                                                        lyxrc.literate_extension));
3410  
3411         string path = OnlyPath(filename);
3412  
3413         string org_path = path;
3414         if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1)) {
3415                 path = tmppath;  
3416         }
3417  
3418         Path p(path); // path to Literate file
3419         users->owner()->getMiniBuffer()->Set(_("Building Program..."));   
3420  
3421         // Remove all error insets
3422         bool removedErrorInsets = users->removeAutoInsets();
3423  
3424         // generate the LaTeX file if necessary
3425         if (!isNwClean() || removedErrorInsets) {
3426                 makeLaTeXFile(lit_name, org_path, false);
3427                 markNwDirty();
3428         }
3429
3430         string latex_command = lyxrc.pdf_mode ?
3431                 lyxrc.pdflatex_command : lyxrc.latex_command;
3432         Literate literate(latex_command, name, filepath, 
3433                           lit_name,
3434                           lyxrc.literate_command, lyxrc.literate_error_filter,
3435                           lyxrc.build_command, lyxrc.build_error_filter);
3436         TeXErrors terr;
3437         int const res = literate.build(terr, users->owner()->getMiniBuffer());
3438  
3439         // check return value from literate.build().
3440         if ((res & Literate::NO_LOGFILE)) {
3441                 WriteAlert(_("Build did not work!"),
3442                            _("Missing log file:"), name);
3443         } else if ((res & Literate::ERRORS)) {
3444                 users->owner()->getMiniBuffer()->Set(_("Done"));
3445                 // Insert all errors as errors boxes
3446                 users->insertErrors(terr);
3447                 
3448                 // Literate files should also be kept dirty if the literate 
3449                 // command run ends up with errors.
3450         } else {
3451                 //no errors or any other things to think about so:
3452                 users->owner()->getMiniBuffer()->Set(_("Done"));
3453                 markNwClean();
3454         }
3455  
3456         // if we removed error insets before we ran Literate/Build or
3457         // if we inserted error insets after we ran Literate/Build this
3458         // must be run:
3459         if (removedErrorInsets || (res & Literate::ERRORS)){
3460                 users->redraw();
3461                 users->fitCursor();
3462                 //users->updateScrollbar();
3463         }
3464         AllowInput(users);
3465
3466         return literate.getNumErrors();
3467 }
3468
3469
3470 // This should be enabled when the Chktex class is implemented. (Asger)
3471 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
3472 // Other flags: -wall -v0 -x
3473 int Buffer::runChktex()
3474 {
3475         if (!users->text) return 0;
3476
3477         ProhibitInput(users);
3478
3479         // get LaTeX-Filename
3480         string const name = getLatexName();
3481         string path = OnlyPath(filename);
3482
3483         string const org_path = path;
3484         if (lyxrc.use_tempdir || (IsDirWriteable(path) < 1)) {
3485                 path = tmppath;  
3486         }
3487
3488         Path p(path); // path to LaTeX file
3489         users->owner()->getMiniBuffer()->Set(_("Running chktex..."));
3490
3491         // Remove all error insets
3492         bool const removedErrorInsets = users->removeAutoInsets();
3493
3494         // Generate the LaTeX file if neccessary
3495         makeLaTeXFile(name, org_path, false);
3496
3497         TeXErrors terr;
3498         Chktex chktex(lyxrc.chktex_command, name, filepath);
3499         int res = chktex.run(terr); // run chktex
3500
3501         if (res == -1) {
3502                 WriteAlert(_("chktex did not work!"),
3503                            _("Could not run with file:"), name);
3504         } else if (res > 0) {
3505                 // Insert all errors as errors boxes
3506                 users->insertErrors(terr);
3507         }
3508
3509         // if we removed error insets before we ran chktex or if we inserted
3510         // error insets after we ran chktex, this must be run:
3511         if (removedErrorInsets || res){
3512                 users->redraw();
3513                 users->fitCursor();
3514                 //users->updateScrollbar();
3515         }
3516         AllowInput(users);
3517
3518         return res;
3519 }
3520
3521
3522 void Buffer::validate(LaTeXFeatures & features) const
3523 {
3524         LyXParagraph * par = paragraph;
3525         LyXTextClass const & tclass = 
3526                 textclasslist.TextClass(params.textclass);
3527     
3528         // AMS Style is at document level
3529     
3530         features.amsstyle = (params.use_amsmath ||
3531                              tclass.provides(LyXTextClass::amsmath));
3532     
3533         while (par) {
3534                 // We don't use "lyxerr.debug" because of speed. (Asger)
3535                 if (lyxerr.debugging(Debug::LATEX))
3536                         lyxerr << "Paragraph: " <<  par << endl;
3537
3538                 // Now just follow the list of paragraphs and run
3539                 // validate on each of them.
3540                 par->validate(features);
3541
3542                 // and then the next paragraph
3543                 par = par->next;
3544         }
3545
3546         // the bullet shapes are buffer level not paragraph level
3547         // so they are tested here
3548         for (int i = 0; i < 4; ++i) {
3549                 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
3550                         int const font = params.user_defined_bullets[i].getFont();
3551                         if (font == 0) {
3552                                 int const c = params
3553                                         .user_defined_bullets[i]
3554                                         .getCharacter();
3555                                 if (c == 16
3556                                    || c == 17
3557                                    || c == 25
3558                                    || c == 26
3559                                    || c == 31) {
3560                                         features.latexsym = true;
3561                                 }
3562                         } else if (font == 1) {
3563                                 features.amssymb = true;
3564                         } else if ((font >= 2 && font <= 5)) {
3565                                 features.pifont = true;
3566                         }
3567                 }
3568         }
3569         
3570         if (lyxerr.debugging(Debug::LATEX)) {
3571                 features.showStruct();
3572         }
3573 }
3574
3575
3576 void Buffer::setPaperStuff()
3577 {
3578         params.papersize = BufferParams::PAPER_DEFAULT;
3579         char const c1 = params.paperpackage;
3580         if (c1 == BufferParams::PACKAGE_NONE) {
3581                 char const c2 = params.papersize2;
3582                 if (c2 == BufferParams::VM_PAPER_USLETTER)
3583                         params.papersize = BufferParams::PAPER_USLETTER;
3584                 else if (c2 == BufferParams::VM_PAPER_USLEGAL)
3585                         params.papersize = BufferParams::PAPER_LEGALPAPER;
3586                 else if (c2 == BufferParams::VM_PAPER_USEXECUTIVE)
3587                         params.papersize = BufferParams::PAPER_EXECUTIVEPAPER;
3588                 else if (c2 == BufferParams::VM_PAPER_A3)
3589                         params.papersize = BufferParams::PAPER_A3PAPER;
3590                 else if (c2 == BufferParams::VM_PAPER_A4)
3591                         params.papersize = BufferParams::PAPER_A4PAPER;
3592                 else if (c2 == BufferParams::VM_PAPER_A5)
3593                         params.papersize = BufferParams::PAPER_A5PAPER;
3594                 else if ((c2 == BufferParams::VM_PAPER_B3) || (c2 == BufferParams::VM_PAPER_B4) ||
3595                          (c2 == BufferParams::VM_PAPER_B5))
3596                         params.papersize = BufferParams::PAPER_B5PAPER;
3597         } else if ((c1 == BufferParams::PACKAGE_A4) || (c1 == BufferParams::PACKAGE_A4WIDE) ||
3598                    (c1 == BufferParams::PACKAGE_WIDEMARGINSA4))
3599                 params.papersize = BufferParams::PAPER_A4PAPER;
3600 }
3601
3602
3603 // This function should be in Buffer because it's a buffer's property (ale)
3604 string const Buffer::getIncludeonlyList(char delim)
3605 {
3606         string lst;
3607         for (inset_iterator it = inset_iterator_begin();
3608             it != inset_iterator_end(); ++it) {
3609                 if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3610                         InsetInclude * insetinc = 
3611                                 static_cast<InsetInclude *>(*it);
3612                         if (insetinc->isInclude() 
3613                             && insetinc->isNoLoad()) {
3614                                 if (!lst.empty())
3615                                         lst += delim;
3616                                 lst += OnlyFilename(ChangeExtension(insetinc->getContents(), string()));
3617                         }
3618                 }
3619         }
3620         lyxerr.debug() << "Includeonly(" << lst << ')' << endl;
3621         return lst;
3622 }
3623
3624
3625 vector<string> const Buffer::getLabelList()
3626 {
3627         /// if this is a child document and the parent is already loaded
3628         /// Use the parent's list instead  [ale990407]
3629         if (!params.parentname.empty()
3630             && bufferlist.exists(params.parentname)) {
3631                 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3632                 if (tmp)
3633                         return tmp->getLabelList();
3634         }
3635
3636         vector<string> label_list;
3637         for (inset_iterator it = inset_iterator_begin();
3638              it != inset_iterator_end(); ++it) {
3639                 vector<string> const l = (*it)->getLabelList();
3640                 label_list.insert(label_list.end(), l.begin(), l.end());
3641         }
3642         return label_list;
3643 }
3644
3645
3646 vector<vector<Buffer::TocItem> > const Buffer::getTocList()
3647 {
3648         vector<vector<TocItem> > l(4);
3649         LyXParagraph * par = paragraph;
3650         while (par) {
3651 #ifndef NEW_INSETS
3652                 if (par->footnoteflag != LyXParagraph::NO_FOOTNOTE) {
3653                         if (textclasslist.Style(params.textclass, 
3654                                                 par->GetLayout()).labeltype
3655                             == LABEL_SENSITIVE) {
3656                                 TocItem tmp;
3657                                 tmp.par = par;
3658                                 tmp.depth = 0;
3659                                 tmp.str =  par->String(this, false);
3660                                 switch (par->footnotekind) {
3661                                 case LyXParagraph::FIG:
3662                                 case LyXParagraph::WIDE_FIG:
3663                                         l[TOC_LOF].push_back(tmp);
3664                                         break;
3665                                 case LyXParagraph::TAB:
3666                                 case LyXParagraph::WIDE_TAB:
3667                                         l[TOC_LOT].push_back(tmp);
3668                                         break;
3669                                 case LyXParagraph::ALGORITHM:
3670                                         l[TOC_LOA].push_back(tmp);
3671                                         break;
3672                                 case LyXParagraph::FOOTNOTE:
3673                                 case LyXParagraph::MARGIN:
3674                                         break;
3675                                 }
3676                         }
3677                 } else if (!par->IsDummy()) {
3678 #endif
3679                         char const labeltype =
3680                                 textclasslist.Style(params.textclass, 
3681                                                     par->GetLayout()).labeltype;
3682       
3683                         if (labeltype >= LABEL_COUNTER_CHAPTER
3684                             && labeltype <= LABEL_COUNTER_CHAPTER + params.tocdepth) {
3685                                 // insert this into the table of contents
3686                                 TocItem tmp;
3687                                 tmp.par = par;
3688                                 tmp.depth = max(0,
3689                                                 labeltype - 
3690                                                 textclasslist.TextClass(params.textclass).maxcounter());
3691                                 tmp.str =  par->String(this, true);
3692                                 l[TOC_TOC].push_back(tmp);
3693                         }
3694 #ifndef NEW_INSETS
3695                 }
3696 #endif
3697                 par = par->next;
3698         }
3699         return l;
3700 }
3701
3702
3703 // This is also a buffer property (ale)
3704 vector<pair<string,string> > const Buffer::getBibkeyList()
3705 {
3706         /// if this is a child document and the parent is already loaded
3707         /// Use the parent's list instead  [ale990412]
3708         if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
3709                 Buffer * tmp = bufferlist.getBuffer(params.parentname);
3710                 if (tmp)
3711                         return tmp->getBibkeyList();
3712         }
3713
3714         vector<pair<string, string> > keys;
3715         LyXParagraph * par = paragraph;
3716         while (par) {
3717                 if (par->bibkey)
3718                         keys.push_back(pair<string, string>(par->bibkey->getContents(),
3719                                                            par->String(this, false)));
3720                 par = par->next;
3721         }
3722
3723         // Might be either using bibtex or a child has bibliography
3724         if (keys.empty()) {
3725                 for (inset_iterator it = inset_iterator_begin();
3726                         it != inset_iterator_end(); ++it) {
3727                         // Search for Bibtex or Include inset
3728                         if ((*it)->LyxCode() == Inset::BIBTEX_CODE) {
3729                                 vector<pair<string,string> > tmp =
3730                                         static_cast<InsetBibtex*>(*it)->getKeys();
3731                                 keys.insert(keys.end(), tmp.begin(), tmp.end());
3732                         } else if ((*it)->LyxCode() == Inset::INCLUDE_CODE) {
3733                                 vector<pair<string,string> > const tmp =
3734                                         static_cast<InsetInclude*>(*it)->getKeys();
3735                                 keys.insert(keys.end(), tmp.begin(), tmp.end());
3736                         }
3737                 }
3738         }
3739  
3740         return keys;
3741 }
3742
3743
3744 bool Buffer::isDepClean(string const & name) const
3745 {
3746         DEPCLEAN * item = dep_clean;
3747         while (item && item->master != name)
3748                 item = item->next;
3749         if (!item) return true;
3750         return item->clean;
3751 }
3752
3753
3754 void Buffer::markDepClean(string const & name)
3755 {
3756         if (!dep_clean) {
3757                 dep_clean = new DEPCLEAN;
3758                 dep_clean->clean = true;
3759                 dep_clean->master = name;
3760                 dep_clean->next = 0;
3761         } else {
3762                 DEPCLEAN * item = dep_clean;
3763                 while (item && item->master != name)
3764                         item = item->next;
3765                 if (item) {
3766                         item->clean = true;
3767                 } else {
3768                         item = new DEPCLEAN;
3769                         item->clean = true;
3770                         item->master = name;
3771                         item->next = 0;
3772                 }
3773         }
3774 }
3775
3776
3777 bool Buffer::Dispatch(string const & command)
3778 {
3779         // Split command string into command and argument
3780         string cmd;
3781         string line = frontStrip(command);
3782         string const arg = strip(frontStrip(split(line, cmd, ' ')));
3783
3784         return Dispatch(lyxaction.LookupFunc(cmd), arg);
3785 }
3786
3787
3788 bool Buffer::Dispatch(int action, string const & argument)
3789 {
3790         bool dispatched = true;
3791         switch (action) {
3792                 case LFUN_EXPORT: 
3793                         Exporter::Export(this, argument, false);
3794                         break;
3795
3796                 default:
3797                         dispatched = false;
3798         }
3799         return dispatched;
3800 }
3801
3802
3803 void Buffer::resize()
3804 {
3805         /// resize the BufferViews!
3806         if (users)
3807                 users->resize();
3808 }
3809
3810
3811 void Buffer::resizeInsets(BufferView * bv)
3812 {
3813         /// then remove all LyXText in text-insets
3814         LyXParagraph * par = paragraph;
3815         for(; par; par = par->next) {
3816             par->resizeInsetsLyXText(bv);
3817         }
3818 }
3819
3820 void Buffer::ChangeLanguage(Language const * from, Language const * to)
3821 {
3822
3823         LyXParagraph * par = paragraph;
3824         while (par) {
3825                 par->ChangeLanguage(params, from, to);
3826                 par = par->next;
3827         }
3828 }
3829
3830
3831 bool Buffer::isMultiLingual()
3832 {
3833         LyXParagraph * par = paragraph;
3834         while (par) {
3835                 if (par->isMultiLingual(params))
3836                         return true;
3837                 par = par->next;
3838         }
3839         return false;
3840 }
3841
3842
3843 Buffer::inset_iterator::inset_iterator(LyXParagraph * paragraph,
3844                                        LyXParagraph::size_type pos)
3845         : par(paragraph)
3846 {
3847         it = par->InsetIterator(pos);
3848         if (it == par->inset_iterator_end()) {
3849                 par = par->next;
3850                 SetParagraph();
3851         }
3852 }
3853
3854
3855 void Buffer::inset_iterator::SetParagraph()
3856 {
3857         while (par) {
3858                 it = par->inset_iterator_begin();
3859                 if (it != par->inset_iterator_end())
3860                         return;
3861                 par = par->next;
3862         }
3863         //it = 0;
3864         // We maintain an invariant that whenever par = 0 then it = 0
3865 }