src/buffer.C

   1 /**
   2  * \file buffer.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS
   9  */
  10
  11 #include <config.h>
  12
  13 #include "buffer.h"
  14 #include "bufferlist.h"
  15 #include "LyXAction.h"
  16 #include "lyxrc.h"
  17 #include "lyxlex.h"
  18 #include "tex-strings.h"
  19 #include "layout.h"
  20 #include "bufferview_funcs.h"
  21 #include "lyxfont.h"
  22 #include "version.h"
  23 #include "LaTeX.h"
  24 #include "Chktex.h"
  25 #include "debug.h"
  26 #include "LaTeXFeatures.h"
  27 #include "lyxtext.h"
  28 #include "gettext.h"
  29 #include "language.h"
  30 #include "exporter.h"
  31 #include "errorlist.h"
  32 #include "Lsstream.h"
  33 #include "format.h"
  34 #include "BufferView.h"
  35 #include "ParagraphParameters.h"
  36 #include "iterators.h"
  37 #include "lyxtextclasslist.h"
  38 #include "sgml.h"
  39 #include "paragraph_funcs.h"
  40 #include "messages.h"
  41 #include "author.h"
  42
  43 #include "frontends/LyXView.h"
  44
  45 #include "mathed/formulamacro.h"
  46 #include "mathed/formula.h"
  47
  48 #include "insets/inseterror.h"
  49 #include "insets/insetbibitem.h"
  50 #include "insets/insetbibtex.h"
  51 #include "insets/insetinclude.h"
  52 #include "insets/insettext.h"
  53
  54 #include "frontends/Dialogs.h"
  55 #include "frontends/Alert.h"
  56
  57 #include "graphics/Previews.h"
  58
  59 #include "support/textutils.h"
  60 #include "support/filetools.h"
  61 #include "support/path.h"
  62 #include "support/os.h"
  63 #include "support/tostr.h"
  64 #include "support/lyxlib.h"
  65 #include "support/FileInfo.h"
  66 #include "support/lyxmanip.h"
  67 #include "support/lyxtime.h"
  68
  69 #include <boost/bind.hpp>
  70 #include <boost/tuple/tuple.hpp>
  71
  72 #include <fstream>
  73 #include <iomanip>
  74 #include <map>
  75 #include <stack>
  76 #include <list>
  77 #include <algorithm>
  78
  79 #include <cstdlib>
  80 #include <cmath>
  81 #include <unistd.h>
  82 #include <sys/types.h>
  83 #include <utime.h>
  84
  85 #ifdef HAVE_LOCALE
  86 #include <locale>
  87 #endif
  88
  89 #ifndef CXX_GLOBAL_CSTD
  90 using std::pow;
  91 #endif
  92
  93 using std::ostream;
  94 using std::ofstream;
  95 using std::ifstream;
  96 using std::fstream;
  97 using std::ios;
  98 using std::setw;
  99 using std::endl;
 100 using std::pair;
 101 using std::make_pair;
 102 using std::vector;
 103 using std::map;
 104 using std::stack;
 105 using std::list;
 106 using std::for_each;
 107
 108 using lyx::pos_type;
 109 using lyx::textclass_type;
 110
 111 // all these externs should eventually be removed.
 112 extern BufferList bufferlist;
 113
 114 namespace {
 115
 116 const int LYX_FORMAT = 223;
 117
 118 } // namespace anon
 119
 120 Buffer::Buffer(string const & file, bool ronly)
 121         : niceFile(true), lyx_clean(true), bak_clean(true),
 122           unnamed(false), read_only(ronly),
 123           filename_(file), users(0)
 124 {
 125         lyxerr[Debug::INFO] << "Buffer::Buffer()" << endl;
 126         filepath_ = OnlyPath(file);
 127         lyxvc.buffer(this);
 128         if (read_only || lyxrc.use_tempdir) {
 129                 tmppath = CreateBufferTmpDir();
 130         } else {
 131                 tmppath.erase();
 132         }
 133
 134         // set initial author
 135         authors().record(Author(lyxrc.user_name, lyxrc.user_email));
 136 }
 137
 138
 139 Buffer::~Buffer()
 140 {
 141         lyxerr[Debug::INFO] << "Buffer::~Buffer()" << endl;
 142         // here the buffer should take care that it is
 143         // saved properly, before it goes into the void.
 144
 145         // make sure that views using this buffer
 146         // forgets it.
 147         if (users)
 148                 users->buffer(0);
 149
 150         if (!tmppath.empty() && destroyDir(tmppath) != 0) {
 151                 Alert::warning(_("Could not remove temporary directory"),
 152                         bformat(_("Could not remove the temporary directory %1$s"), tmppath));
 153         }
 154
 155         paragraphs.clear();
 156
 157         // Remove any previewed LaTeX snippets assocoated with this buffer.
 158         grfx::Previews::get().removeLoader(this);
 159 }
 160
 161
 162 string const Buffer::getLatexName(bool no_path) const
 163 {
 164         string const name = ChangeExtension(MakeLatexName(fileName()), ".tex");
 165         return no_path ? OnlyFilename(name) : name;
 166 }
 167
 168
 169 pair<Buffer::LogType, string> const Buffer::getLogName() const
 170 {
 171         string const filename = getLatexName(false);
 172
 173         if (filename.empty())
 174                 return make_pair(Buffer::latexlog, string());
 175
 176         string path = OnlyPath(filename);
 177
 178         if (lyxrc.use_tempdir || !IsDirWriteable(path))
 179                 path = tmppath;
 180
 181         string const fname = AddName(path,
 182                                      OnlyFilename(ChangeExtension(filename,
 183                                                                   ".log")));
 184         string const bname =
 185                 AddName(path, OnlyFilename(
 186                         ChangeExtension(filename,
 187                                         formats.extension("literate") + ".out")));
 188
 189         // If no Latex log or Build log is newer, show Build log
 190
 191         FileInfo const f_fi(fname);
 192         FileInfo const b_fi(bname);
 193
 194         if (b_fi.exist() &&
 195             (!f_fi.exist() || f_fi.getModificationTime() < b_fi.getModificationTime())) {
 196                 lyxerr[Debug::FILES] << "Log name calculated as: " << bname << endl;
 197                 return make_pair(Buffer::buildlog, bname);
 198         }
 199         lyxerr[Debug::FILES] << "Log name calculated as: " << fname << endl;
 200         return make_pair(Buffer::latexlog, fname);
 201 }
 202
 203
 204 void Buffer::setReadonly(bool flag)
 205 {
 206         if (read_only != flag) {
 207                 read_only = flag;
 208                 updateTitles();
 209                 users->owner()->getDialogs().updateBufferDependent(false);
 210         }
 211 }
 212
 213
 214 AuthorList & Buffer::authors()
 215 {
 216         return params.authorlist;
 217 }
 218
 219
 220 /// Update window titles of all users
 221 // Should work on a list
 222 void Buffer::updateTitles() const
 223 {
 224         if (users)
 225                 users->owner()->updateWindowTitle();
 226 }
 227
 228
 229 /// Reset autosave timer of all users
 230 // Should work on a list
 231 void Buffer::resetAutosaveTimers() const
 232 {
 233         if (users)
 234                 users->owner()->resetAutosaveTimer();
 235 }
 236
 237
 238 void Buffer::setFileName(string const & newfile)
 239 {
 240         filename_ = MakeAbsPath(newfile);
 241         filepath_ = OnlyPath(filename_);
 242         setReadonly(IsFileWriteable(filename_) == 0);
 243         updateTitles();
 244 }
 245
 246
 247 // We'll remove this later. (Lgb)
 248 namespace {
 249
 250 void unknownClass(string const & unknown)
 251 {
 252         Alert::warning(_("Unknown document class"),
 253                 bformat(_("Using the default document class, because the "
 254                         " class %1$s is unknown."), unknown));
 255 }
 256
 257 } // anon
 258
 259 int Buffer::readHeader(LyXLex & lex)
 260 {
 261         int unknown_tokens = 0;
 262
 263         while (lex.isOK()) {
 264                 lex.nextToken();
 265                 string const token = lex.getString();
 266
 267                 if (token.empty())
 268                         continue;
 269
 270                 if (token == "\\end_header")
 271                         break;
 272
 273                 lyxerr[Debug::PARSER] << "Handling header token: `"
 274                                       << token << '\'' << endl;
 275
 276                 string unknown = params.readToken(lex, token);
 277                 if (!unknown.empty()) {
 278                         if (unknown[0] != '\\') {
 279                                 unknownClass(unknown);
 280                         } else {
 281                                 ++unknown_tokens;
 282                         }
 283                 }
 284         }
 285         return unknown_tokens;
 286 }
 287
 288
 289 // candidate for move to BufferView
 290 // (at least some parts in the beginning of the func)
 291 //
 292 // Uwe C. Schroeder
 293 // changed to be public and have one parameter
 294 // if par = 0 normal behavior
 295 // else insert behavior
 296 // Returns false if "\the_end" is not read (Asger)
 297 bool Buffer::readBody(LyXLex & lex, ParagraphList::iterator pit)
 298 {
 299         int unknown_tokens = 0;
 300
 301         Paragraph::depth_type depth = 0;
 302         bool the_end_read = false;
 303
 304         if (paragraphs.empty()) {
 305                 unknown_tokens += readHeader(lex);
 306
 307                 if (!params.getLyXTextClass().load()) {
 308                         string theclass = params.getLyXTextClass().name();
 309                         Alert::error(_("Can't load document class"), bformat(
 310                                         "Using the default document class, because the "
 311                                         " class %1$s could not be loaded.", theclass));
 312                         params.textclass = 0;
 313                 }
 314         } else {
 315                 // We are inserting into an existing document
 316                 users->text->breakParagraph(paragraphs);
 317
 318                 // We don't want to adopt the parameters from the
 319                 // document we insert, so read them into a temporary buffer
 320                 // and then discard it
 321
 322                 Buffer tmpbuf("", false);
 323                 tmpbuf.readHeader(lex);
 324         }
 325
 326         while (lex.isOK()) {
 327                 lex.nextToken();
 328                 string const token = lex.getString();
 329
 330                 if (token.empty())
 331                         continue;
 332
 333                 lyxerr[Debug::PARSER] << "Handling token: `"
 334                                       << token << '\'' << endl;
 335
 336                 if (token == "\\the_end") {
 337                         the_end_read = true;
 338                         continue;
 339                 }
 340
 341                 unknown_tokens += readParagraph(lex, token, paragraphs, pit, depth);
 342         }
 343
 344
 345         if (unknown_tokens > 0) {
 346                 string s;
 347                 if (unknown_tokens == 1) {
 348                         s = bformat(_("Encountered one unknown token when reading "
 349                                 "the document %1$s."), fileName());
 350                 } else {
 351                         s = bformat(_("Encountered %1$s unknown tokens when reading "
 352                                 "the document %2$s."), tostr(unknown_tokens), fileName());
 353                 }
 354                 Alert::warning(_("Document format failure"), s);
 355         }
 356
 357         return the_end_read;
 358 }
 359
 360
 361 int Buffer::readParagraph(LyXLex & lex, string const & token,
 362                       ParagraphList & pars, ParagraphList::iterator & pit,
 363                       Paragraph::depth_type & depth)
 364 {
 365         static Change current_change;
 366         int unknown = 0;
 367
 368         if (token == "\\layout") {
 369                 lex.pushToken(token);
 370
 371                 Paragraph * par = new Paragraph();
 372                 par->params().depth(depth);
 373                 if (params.tracking_changes)
 374                         par->trackChanges();
 375                 LyXFont f(LyXFont::ALL_INHERIT, params.language);
 376                 par->setFont(0, f);
 377
 378                 // FIXME: goddamn InsetTabular makes us pass a Buffer
 379                 // not BufferParams
 380                 unknown += ::readParagraph(*this, *par, lex);
 381
 382                 // insert after
 383                 if (pit != pars.end())
 384                         ++pit;
 385                 pit = pars.insert(pit, par);
 386         } else if (token == "\\begin_deeper") {
 387                 ++depth;
 388         } else if (token == "\\end_deeper") {
 389                 if (!depth) {
 390                         lex.printError("\\end_deeper: " "depth is already null");
 391                 } else {
 392                         --depth;
 393                 }
 394         } else {
 395                 ++unknown;
 396         }
 397         return unknown;
 398 }
 399
 400
 401 // needed to insert the selection
 402 void Buffer::insertStringAsLines(ParagraphList::iterator & par, pos_type & pos,
 403                                  LyXFont const & fn,string const & str)
 404 {
 405         LyXLayout_ptr const & layout = par->layout();
 406
 407         LyXFont font = fn;
 408
 409         par->checkInsertChar(font);
 410         // insert the string, don't insert doublespace
 411         bool space_inserted = true;
 412         bool autobreakrows = !par->inInset() ||
 413                 static_cast<InsetText *>(par->inInset())->getAutoBreakRows();
 414         for(string::const_iterator cit = str.begin();
 415             cit != str.end(); ++cit) {
 416                 if (*cit == '\n') {
 417                         if (autobreakrows && (!par->empty() || layout->keepempty)) {
 418                                 breakParagraph(params, paragraphs, par, pos,
 419                                                layout->isEnvironment());
 420                                 ++par;
 421                                 pos = 0;
 422                                 space_inserted = true;
 423                         } else {
 424                                 continue;
 425                         }
 426                         // do not insert consecutive spaces if !free_spacing
 427                 } else if ((*cit == ' ' || *cit == '\t') &&
 428                            space_inserted && !layout->free_spacing &&
 429                                    !par->isFreeSpacing())
 430                 {
 431                         continue;
 432                 } else if (*cit == '\t') {
 433                         if (!layout->free_spacing && !par->isFreeSpacing()) {
 434                                 // tabs are like spaces here
 435                                 par->insertChar(pos, ' ', font);
 436                                 ++pos;
 437                                 space_inserted = true;
 438                         } else {
 439                                 const pos_type nb = 8 - pos % 8;
 440                                 for (pos_type a = 0; a < nb ; ++a) {
 441                                         par->insertChar(pos, ' ', font);
 442                                         ++pos;
 443                                 }
 444                                 space_inserted = true;
 445                         }
 446                 } else if (!IsPrintable(*cit)) {
 447                         // Ignore unprintables
 448                         continue;
 449                 } else {
 450                         // just insert the character
 451                         par->insertChar(pos, *cit, font);
 452                         ++pos;
 453                         space_inserted = (*cit == ' ');
 454                 }
 455
 456         }
 457 }
 458
 459
 460 bool Buffer::readFile(LyXLex & lex, string const & filename)
 461 {
 462         bool ret = readFile(lex, filename, paragraphs.begin());
 463
 464         // After we have read a file, we must ensure that the buffer
 465         // language is set and used in the gui.
 466         // If you know of a better place to put this, please tell me. (Lgb)
 467         updateDocLang(params.language);
 468
 469         return ret;
 470 }
 471
 472
 473 // FIXME: all the below Alerts should give the filename..
 474 bool Buffer::readFile(LyXLex & lex, string const & filename,
 475                       ParagraphList::iterator pit)
 476 {
 477         if (!lex.isOK()) {
 478                 Alert::error(_("Document could not be read"),
 479                         _("The specified document could not be read."));
 480                 return false;
 481         }
 482
 483         lex.next();
 484         string const token(lex.getString());
 485
 486         if (!lex.isOK()) {
 487                 Alert::error(_("Document could not be read"),
 488                         _("The specified document could not be read."));
 489                 return false;
 490         }
 491
 492         // the first token _must_ be...
 493         if (token != "\\lyxformat") {
 494                 Alert::error(_("Document format failure"),
 495                         _("The specified document is not a LyX document."));
 496                 return false;
 497         }
 498
 499         lex.eatLine();
 500         string tmp_format = lex.getString();
 501         //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
 502         // if present remove ".," from string.
 503         string::size_type dot = tmp_format.find_first_of(".,");
 504         //lyxerr << "           dot found at " << dot << endl;
 505         if (dot != string::npos)
 506                         tmp_format.erase(dot, 1);
 507         file_format = strToInt(tmp_format);
 508         //lyxerr << "format: " << file_format << endl;
 509         if (file_format == LYX_FORMAT) {
 510                 // current format
 511         } else if (file_format > LYX_FORMAT) {
 512                 Alert::warning(_("Document format failure"),
 513                         _("This document was created with a newer version of "
 514                         "LyX. This is likely to cause problems."));
 515         } else if (file_format < LYX_FORMAT) {
 516                 // old formats
 517                 if (file_format < 200) {
 518                         Alert::error(_("Document format failure"),
 519                                 _("This LyX document is too old to be read "
 520                                 "by this version of LyX. Try LyX 0.10."));
 521                         return false;
 522                 } else if (!filename.empty()) {
 523                         string command =
 524                                 LibFileSearch("lyx2lyx", "lyx2lyx");
 525                         if (command.empty()) {
 526                                 Alert::error(_("Conversion script not found"),
 527                                         _("The document is from an earlier version "
 528                                           "of LyX, but the conversion script lyx2lyx "
 529                                           "could not be found."));
 530                                 return false;
 531                         }
 532                         command += " -t"
 533                                 +tostr(LYX_FORMAT) + ' '
 534                                 + QuoteName(filename);
 535                         lyxerr[Debug::INFO] << "Running '"
 536                                             << command << '\''
 537                                             << endl;
 538                         cmd_ret const ret = RunCommand(command);
 539                         if (ret.first) {
 540                                 Alert::error(_("Conversion script failed"),
 541                                         _("The document is from an earlier version "
 542                                           "of LyX, but the lyx2lyx script failed "
 543                                           "to convert it."));
 544                                 return false;
 545                         }
 546                         istringstream is(STRCONV(ret.second));
 547                         LyXLex tmplex(0, 0);
 548                         tmplex.setStream(is);
 549                         return readFile(tmplex, string(), pit);
 550                 } else {
 551                         // This code is reached if lyx2lyx failed (for
 552                         // some reason) to change the file format of
 553                         // the file.
 554                         lyx::Assert(false);
 555                         return false;
 556                 }
 557         }
 558         bool the_end = readBody(lex, pit);
 559         params.setPaperStuff();
 560
 561         if (!the_end) {
 562                 Alert::error(_("Document format failure"),
 563                         _("The document ended unexpectedly, which means "
 564                           "that it is probably corrupted."));
 565         }
 566         return true;
 567 }
 568
 569
 570 // Should probably be moved to somewhere else: BufferView? LyXView?
 571 bool Buffer::save() const
 572 {
 573         // We don't need autosaves in the immediate future. (Asger)
 574         resetAutosaveTimers();
 575
 576         // make a backup
 577         string s;
 578         if (lyxrc.make_backup) {
 579                 s = fileName() + '~';
 580                 if (!lyxrc.backupdir_path.empty())
 581                         s = AddName(lyxrc.backupdir_path,
 582                                     subst(os::slashify_path(s),'/','!'));
 583
 584                 // Rename is the wrong way of making a backup,
 585                 // this is the correct way.
 586                 /* truss cp fil fil2:
 587                    lstat("LyXVC3.lyx", 0xEFFFF898)                 Err#2 ENOENT
 588                    stat("LyXVC.lyx", 0xEFFFF688)                   = 0
 589                    open("LyXVC.lyx", O_RDONLY)                     = 3
 590                    open("LyXVC3.lyx", O_WRONLY|O_CREAT|O_TRUNC, 0600) = 4
 591                    fstat(4, 0xEFFFF508)                            = 0
 592                    fstat(3, 0xEFFFF508)                            = 0
 593                    read(3, " # T h i s   f i l e   w".., 8192)     = 5579
 594                    write(4, " # T h i s   f i l e   w".., 5579)    = 5579
 595                    read(3, 0xEFFFD4A0, 8192)                       = 0
 596                    close(4)                                        = 0
 597                    close(3)                                        = 0
 598                    chmod("LyXVC3.lyx", 0100644)                    = 0
 599                    lseek(0, 0, SEEK_CUR)                           = 46440
 600                    _exit(0)
 601                 */
 602
 603                 // Should probably have some more error checking here.
 604                 // Doing it this way, also makes the inodes stay the same.
 605                 // This is still not a very good solution, in particular we
 606                 // might loose the owner of the backup.
 607                 FileInfo finfo(fileName());
 608                 if (finfo.exist()) {
 609                         mode_t fmode = finfo.getMode();
 610                         struct utimbuf times = {
 611                                 finfo.getAccessTime(),
 612                                 finfo.getModificationTime() };
 613
 614                         ifstream ifs(fileName().c_str());
 615                         ofstream ofs(s.c_str(), ios::out|ios::trunc);
 616                         if (ifs && ofs) {
 617                                 ofs << ifs.rdbuf();
 618                                 ifs.close();
 619                                 ofs.close();
 620                                 ::chmod(s.c_str(), fmode);
 621
 622                                 if (::utime(s.c_str(), &times)) {
 623                                         lyxerr << "utime error." << endl;
 624                                 }
 625                         } else {
 626                                 lyxerr << "LyX was not able to make "
 627                                         "backup copy. Beware." << endl;
 628                         }
 629                 }
 630         }
 631
 632         if (writeFile(fileName())) {
 633                 markClean();
 634                 removeAutosaveFile(fileName());
 635         } else {
 636                 // Saving failed, so backup is not backup
 637                 if (lyxrc.make_backup) {
 638                         lyx::rename(s, fileName());
 639                 }
 640                 return false;
 641         }
 642         return true;
 643 }
 644
 645
 646 bool Buffer::writeFile(string const & fname) const
 647 {
 648         if (read_only && (fname == fileName())) {
 649                 return false;
 650         }
 651
 652         FileInfo finfo(fname);
 653         if (finfo.exist() && !finfo.writable()) {
 654                 return false;
 655         }
 656
 657         ofstream ofs(fname.c_str());
 658         if (!ofs) {
 659                 return false;
 660         }
 661
 662 #ifdef HAVE_LOCALE
 663         // Use the standard "C" locale for file output.
 664         ofs.imbue(std::locale::classic());
 665 #endif
 666
 667         // The top of the file should not be written by params.
 668
 669         // write out a comment in the top of the file
 670         ofs << '#' << lyx_docversion
 671             << " created this file. For more info see http://www.lyx.org/\n"
 672             << "\\lyxformat " << LYX_FORMAT << "\n";
 673
 674         // now write out the buffer paramters.
 675         params.writeFile(ofs);
 676
 677         ofs << "\\end_header\n";
 678
 679         Paragraph::depth_type depth = 0;
 680
 681         // this will write out all the paragraphs
 682         // using recursive descent.
 683         ParagraphList::iterator pit = paragraphs.begin();
 684         ParagraphList::iterator pend = paragraphs.end();
 685         for (; pit != pend; ++pit)
 686                 pit->write(this, ofs, params, depth);
 687
 688         // Write marker that shows file is complete
 689         ofs << "\n\\the_end" << endl;
 690
 691         ofs.close();
 692
 693         // how to check if close went ok?
 694         // Following is an attempt... (BE 20001011)
 695
 696         // good() returns false if any error occured, including some
 697         //        formatting error.
 698         // bad()  returns true if something bad happened in the buffer,
 699         //        which should include file system full errors.
 700
 701         bool status = true;
 702         if (!ofs.good()) {
 703                 status = false;
 704 #if 0
 705                 if (ofs.bad()) {
 706                         lyxerr << "Buffer::writeFile: BAD ERROR!" << endl;
 707                 } else {
 708                         lyxerr << "Buffer::writeFile: NOT SO BAD ERROR!"
 709                                << endl;
 710                 }
 711 #endif
 712         }
 713
 714         return status;
 715 }
 716
 717
 718 namespace {
 719
 720 pair<int, string> const addDepth(int depth, int ldepth)
 721 {
 722         int d = depth * 2;
 723         if (ldepth > depth)
 724                 d += (ldepth - depth) * 2;
 725         return make_pair(d, string(d, ' '));
 726 }
 727
 728 }
 729
 730
 731 string const Buffer::asciiParagraph(Paragraph const & par,
 732                                     unsigned int linelen,
 733                                     bool noparbreak) const
 734 {
 735         ostringstream buffer;
 736         Paragraph::depth_type depth = 0;
 737         int ltype = 0;
 738         Paragraph::depth_type ltype_depth = 0;
 739         bool ref_printed = false;
 740 //      if (!par->previous()) {
 741 #if 0
 742         // begins or ends a deeper area ?
 743         if (depth != par->params().depth()) {
 744                 if (par->params().depth() > depth) {
 745                         while (par->params().depth() > depth) {
 746                                 ++depth;
 747                         }
 748                 } else {
 749                         while (par->params().depth() < depth) {
 750                                 --depth;
 751                         }
 752                 }
 753         }
 754 #else
 755         depth = par.params().depth();
 756 #endif
 757
 758         // First write the layout
 759         string const & tmp = par.layout()->name();
 760         if (compare_no_case(tmp, "itemize") == 0) {
 761                 ltype = 1;
 762                 ltype_depth = depth + 1;
 763         } else if (compare_ascii_no_case(tmp, "enumerate") == 0) {
 764                 ltype = 2;
 765                 ltype_depth = depth + 1;
 766         } else if (contains(ascii_lowercase(tmp), "ection")) {
 767                 ltype = 3;
 768                 ltype_depth = depth + 1;
 769         } else if (contains(ascii_lowercase(tmp), "aragraph")) {
 770                 ltype = 4;
 771                 ltype_depth = depth + 1;
 772         } else if (compare_ascii_no_case(tmp, "description") == 0) {
 773                 ltype = 5;
 774                 ltype_depth = depth + 1;
 775         } else if (compare_ascii_no_case(tmp, "abstract") == 0) {
 776                 ltype = 6;
 777                 ltype_depth = 0;
 778         } else if (compare_ascii_no_case(tmp, "bibliography") == 0) {
 779                 ltype = 7;
 780                 ltype_depth = 0;
 781         } else {
 782                 ltype = 0;
 783                 ltype_depth = 0;
 784         }
 785
 786         /* maybe some vertical spaces */
 787
 788         /* the labelwidthstring used in lists */
 789
 790         /* some lines? */
 791
 792         /* some pagebreaks? */
 793
 794         /* noindent ? */
 795
 796         /* what about the alignment */
 797
 798         // linelen <= 0 is special and means we don't have paragraph breaks
 799
 800         string::size_type currlinelen = 0;
 801
 802         if (!noparbreak) {
 803                 if (linelen > 0)
 804                         buffer << "\n\n";
 805
 806                 buffer << string(depth * 2, ' ');
 807                 currlinelen += depth * 2;
 808
 809                 //--
 810                 // we should probably change to the paragraph language in the
 811                 // gettext here (if possible) so that strings are outputted in
 812                 // the correct language! (20012712 Jug)
 813                 //--
 814                 switch (ltype) {
 815                 case 0: // Standard
 816                 case 4: // (Sub)Paragraph
 817                 case 5: // Description
 818                         break;
 819                 case 6: // Abstract
 820                         if (linelen > 0) {
 821                                 buffer << _("Abstract") << "\n\n";
 822                                 currlinelen = 0;
 823                         } else {
 824                                 string const abst = _("Abstract: ");
 825                                 buffer << abst;
 826                                 currlinelen += abst.length();
 827                         }
 828                         break;
 829                 case 7: // Bibliography
 830                         if (!ref_printed) {
 831                                 if (linelen > 0) {
 832                                         buffer << _("References") << "\n\n";
 833                                         currlinelen = 0;
 834                                 } else {
 835                                         string const refs = _("References: ");
 836                                         buffer << refs;
 837                                         currlinelen += refs.length();
 838                                 }
 839
 840                                 ref_printed = true;
 841                         }
 842                         break;
 843                 default:
 844                 {
 845                         string const parlab = par.params().labelString();
 846                         buffer << parlab << ' ';
 847                         currlinelen += parlab.length() + 1;
 848                 }
 849                 break;
 850
 851                 }
 852         }
 853
 854         if (!currlinelen) {
 855                 pair<int, string> p = addDepth(depth, ltype_depth);
 856                 buffer << p.second;
 857                 currlinelen += p.first;
 858         }
 859
 860         // this is to change the linebreak to do it by word a bit more
 861         // intelligent hopefully! (only in the case where we have a
 862         // max linelength!) (Jug)
 863
 864         string word;
 865
 866         for (pos_type i = 0; i < par.size(); ++i) {
 867                 char c = par.getUChar(params, i);
 868                 switch (c) {
 869                 case Paragraph::META_INSET:
 870                 {
 871                         Inset const * inset = par.getInset(i);
 872                         if (inset) {
 873                                 if (linelen > 0) {
 874                                         buffer << word;
 875                                         currlinelen += word.length();
 876                                         word.erase();
 877                                 }
 878                                 if (inset->ascii(this, buffer, linelen)) {
 879                                         // to be sure it breaks paragraph
 880                                         currlinelen += linelen;
 881                                 }
 882                         }
 883                 }
 884                 break;
 885
 886                 default:
 887                         if (c == ' ') {
 888                                 if (linelen > 0 &&
 889                                     currlinelen + word.length() > linelen - 10) {
 890                                         buffer << "\n";
 891                                         pair<int, string> p = addDepth(depth, ltype_depth);
 892                                         buffer << p.second;
 893                                         currlinelen = p.first;
 894                                 }
 895
 896                                 buffer << word << ' ';
 897                                 currlinelen += word.length() + 1;
 898                                 word.erase();
 899
 900                         } else {
 901                                 if (c != '\0') {
 902                                         word += c;
 903                                 } else {
 904                                         lyxerr[Debug::INFO] <<
 905                                                 "writeAsciiFile: NULL char in structure." << endl;
 906                                 }
 907                                 if ((linelen > 0) &&
 908                                         (currlinelen + word.length()) > linelen)
 909                                 {
 910                                         buffer << "\n";
 911
 912                                         pair<int, string> p =
 913                                                 addDepth(depth, ltype_depth);
 914                                         buffer << p.second;
 915                                         currlinelen = p.first;
 916                                 }
 917                         }
 918                         break;
 919                 }
 920         }
 921         buffer << word;
 922         return STRCONV(buffer.str());
 923 }
 924
 925
 926 void Buffer::writeFileAscii(string const & fname, int linelen)
 927 {
 928         ofstream ofs(fname.c_str());
 929         if (!ofs) {
 930                 string const file = MakeDisplayPath(fname, 50);
 931                 string text = bformat(_("Could not save the document\n%1$s."), file);
 932                 Alert::error(_("Could not save document"), text);
 933                 return;
 934         }
 935         writeFileAscii(ofs, linelen);
 936 }
 937
 938
 939 void Buffer::writeFileAscii(ostream & os, int linelen)
 940 {
 941         ParagraphList::iterator beg = paragraphs.begin();
 942         ParagraphList::iterator end = paragraphs.end();
 943         ParagraphList::iterator it = beg;
 944         for (; it != end; ++it) {
 945                 os << asciiParagraph(*it, linelen, it == beg);
 946         }
 947         os << "\n";
 948 }
 949
 950
 951
 952 void Buffer::makeLaTeXFile(string const & fname,
 953                            string const & original_path,
 954                            bool nice, bool only_body, bool only_preamble)
 955 {
 956         lyxerr[Debug::LATEX] << "makeLaTeXFile..." << endl;
 957
 958         ofstream ofs(fname.c_str());
 959         if (!ofs) {
 960                 string const file = MakeDisplayPath(fname, 50);
 961                 string text = bformat(_("Could not open the specified document\n%1$s."),
 962                         file);
 963                 Alert::error(_("Could not open file"), text);
 964                 return;
 965         }
 966
 967         makeLaTeXFile(ofs, original_path, nice, only_body, only_preamble);
 968
 969         ofs.close();
 970         if (ofs.fail()) {
 971                 lyxerr << "File was not closed properly." << endl;
 972         }
 973 }
 974
 975
 976 void Buffer::makeLaTeXFile(ostream & os,
 977                            string const & original_path,
 978                            bool nice, bool only_body, bool only_preamble)
 979 {
 980         niceFile = nice; // this will be used by Insetincludes.
 981
 982         // validate the buffer.
 983         lyxerr[Debug::LATEX] << "  Validating buffer..." << endl;
 984         LaTeXFeatures features(params);
 985         validate(features);
 986         lyxerr[Debug::LATEX] << "  Buffer validation done." << endl;
 987
 988         texrow.reset();
 989         // The starting paragraph of the coming rows is the
 990         // first paragraph of the document. (Asger)
 991         texrow.start(paragraphs.begin()->id(), 0);
 992
 993         if (!only_body && nice) {
 994                 os << "%% " << lyx_docversion << " created this file.  "
 995                         "For more info, see http://www.lyx.org/.\n"
 996                         "%% Do not edit unless you really know what "
 997                         "you are doing.\n";
 998                 texrow.newline();
 999                 texrow.newline();
1000         }
1001         lyxerr[Debug::INFO] << "lyx header finished" << endl;
1002         // There are a few differences between nice LaTeX and usual files:
1003         // usual is \batchmode and has a
1004         // special input@path to allow the including of figures
1005         // with either \input or \includegraphics (what figinsets do).
1006         // input@path is set when the actual parameter
1007         // original_path is set. This is done for usual tex-file, but not
1008         // for nice-latex-file. (Matthias 250696)
1009         if (!only_body) {
1010                 if (!nice) {
1011                         // code for usual, NOT nice-latex-file
1012                         os << "\\batchmode\n"; // changed
1013                         // from \nonstopmode
1014                         texrow.newline();
1015                 }
1016                 if (!original_path.empty()) {
1017                         string inputpath = os::external_path(original_path);
1018                         subst(inputpath, "~", "\\string~");
1019                         os << "\\makeatletter\n"
1020                             << "\\def\\input@path{{"
1021                             << inputpath << "/}}\n"
1022                             << "\\makeatother\n";
1023                         texrow.newline();
1024                         texrow.newline();
1025                         texrow.newline();
1026                 }
1027
1028                 // Write the preamble
1029                 params.writeLaTeX(os, features, texrow);
1030
1031                 if (only_preamble)
1032                         return;
1033
1034                 // make the body.
1035                 os << "\\begin{document}\n";
1036                 texrow.newline();
1037         } // only_body
1038         lyxerr[Debug::INFO] << "preamble finished, now the body." << endl;
1039
1040         if (!lyxrc.language_auto_begin) {
1041                 os << subst(lyxrc.language_command_begin, "$$lang",
1042                              params.language->babel())
1043                     << endl;
1044                 texrow.newline();
1045         }
1046
1047         latexParagraphs(this, paragraphs, os, texrow, false);
1048
1049         // add this just in case after all the paragraphs
1050         os << endl;
1051         texrow.newline();
1052
1053         if (!lyxrc.language_auto_end) {
1054                 os << subst(lyxrc.language_command_end, "$$lang",
1055                              params.language->babel())
1056                     << endl;
1057                 texrow.newline();
1058         }
1059
1060         if (!only_body) {
1061                 os << "\\end{document}\n";
1062                 texrow.newline();
1063
1064                 lyxerr[Debug::LATEX] << "makeLaTeXFile...done" << endl;
1065         } else {
1066                 lyxerr[Debug::LATEX] << "LaTeXFile for inclusion made."
1067                                      << endl;
1068         }
1069
1070         // Just to be sure. (Asger)
1071         texrow.newline();
1072
1073         lyxerr[Debug::INFO] << "Finished making LaTeX file." << endl;
1074         lyxerr[Debug::INFO] << "Row count was " << texrow.rows() - 1
1075                             << '.' << endl;
1076
1077         // we want this to be true outside previews (for insetexternal)
1078         niceFile = true;
1079 }
1080
1081
1082 bool Buffer::isLatex() const
1083 {
1084         return params.getLyXTextClass().outputType() == LATEX;
1085 }
1086
1087
1088 bool Buffer::isLinuxDoc() const
1089 {
1090         return params.getLyXTextClass().outputType() == LINUXDOC;
1091 }
1092
1093
1094 bool Buffer::isLiterate() const
1095 {
1096         return params.getLyXTextClass().outputType() == LITERATE;
1097 }
1098
1099
1100 bool Buffer::isDocBook() const
1101 {
1102         return params.getLyXTextClass().outputType() == DOCBOOK;
1103 }
1104
1105
1106 bool Buffer::isSGML() const
1107 {
1108         LyXTextClass const & tclass = params.getLyXTextClass();
1109
1110         return tclass.outputType() == LINUXDOC ||
1111                tclass.outputType() == DOCBOOK;
1112 }
1113
1114
1115 void Buffer::makeLinuxDocFile(string const & fname, bool nice, bool body_only)
1116 {
1117         ofstream ofs(fname.c_str());
1118
1119         if (!ofs) {
1120                 string const file = MakeDisplayPath(fname, 50);
1121                 string text = bformat(_("Could not save the specified document\n%1$s.\n"),
1122                         file);
1123                 Alert::error(_("Could not save document"), text);
1124                 return;
1125         }
1126
1127         niceFile = nice; // this will be used by included files.
1128
1129         LaTeXFeatures features(params);
1130
1131         validate(features);
1132
1133         texrow.reset();
1134
1135         LyXTextClass const & tclass = params.getLyXTextClass();
1136
1137         string top_element = tclass.latexname();
1138
1139         if (!body_only) {
1140                 ofs << "<!doctype linuxdoc system";
1141
1142                 string preamble = params.preamble;
1143                 const string name = nice ? ChangeExtension(filename_, ".sgml")
1144                          : fname;
1145                 preamble += features.getIncludedFiles(name);
1146                 preamble += features.getLyXSGMLEntities();
1147
1148                 if (!preamble.empty()) {
1149                         ofs << " [ " << preamble << " ]";
1150                 }
1151                 ofs << ">\n\n";
1152
1153                 if (params.options.empty())
1154                         sgml::openTag(ofs, 0, false, top_element);
1155                 else {
1156                         string top = top_element;
1157                         top += ' ';
1158                         top += params.options;
1159                         sgml::openTag(ofs, 0, false, top);
1160                 }
1161         }
1162
1163         ofs << "<!-- "  << lyx_docversion
1164             << " created this file. For more info see http://www.lyx.org/"
1165             << " -->\n";
1166
1167         Paragraph::depth_type depth = 0; // paragraph depth
1168         string item_name;
1169         vector<string> environment_stack(5);
1170
1171         users->resetErrorList();
1172
1173         ParagraphList::iterator pit = paragraphs.begin();
1174         ParagraphList::iterator pend = paragraphs.end();
1175         for (; pit != pend; ++pit) {
1176                 LyXLayout_ptr const & style = pit->layout();
1177                 // treat <toc> as a special case for compatibility with old code
1178                 if (pit->isInset(0)) {
1179                         Inset * inset = pit->getInset(0);
1180                         Inset::Code lyx_code = inset->lyxCode();
1181                         if (lyx_code == Inset::TOC_CODE) {
1182                                 string const temp = "toc";
1183                                 sgml::openTag(ofs, depth, false, temp);
1184                                 continue;
1185                         }
1186                 }
1187
1188                 // environment tag closing
1189                 for (; depth > pit->params().depth(); --depth) {
1190                         sgml::closeTag(ofs, depth, false, environment_stack[depth]);
1191                         environment_stack[depth].erase();
1192                 }
1193
1194                 // write opening SGML tags
1195                 switch (style->latextype) {
1196                 case LATEX_PARAGRAPH:
1197                         if (depth == pit->params().depth()
1198                            && !environment_stack[depth].empty()) {
1199                                 sgml::closeTag(ofs, depth, false, environment_stack[depth]);
1200                                 environment_stack[depth].erase();
1201                                 if (depth)
1202                                         --depth;
1203                                 else
1204                                         ofs << "</p>";
1205                         }
1206                         sgml::openTag(ofs, depth, false, style->latexname());
1207                         break;
1208
1209                 case LATEX_COMMAND:
1210                         if (depth != 0)
1211                                 sgmlError(pit, 0,
1212                                           _("Error: Wrong depth for LatexType Command.\n"));
1213
1214                         if (!environment_stack[depth].empty()) {
1215                                 sgml::closeTag(ofs, depth, false, environment_stack[depth]);
1216                                 ofs << "</p>";
1217                         }
1218
1219                         environment_stack[depth].erase();
1220                         sgml::openTag(ofs, depth, false, style->latexname());
1221                         break;
1222
1223                 case LATEX_ENVIRONMENT:
1224                 case LATEX_ITEM_ENVIRONMENT:
1225                 case LATEX_BIB_ENVIRONMENT:
1226                 {
1227                         string const & latexname = style->latexname();
1228
1229                         if (depth == pit->params().depth()
1230                             && environment_stack[depth] != latexname) {
1231                                 sgml::closeTag(ofs, depth, false,
1232                                              environment_stack[depth]);
1233                                 environment_stack[depth].erase();
1234                         }
1235                         if (depth < pit->params().depth()) {
1236                                depth = pit->params().depth();
1237                                environment_stack[depth].erase();
1238                         }
1239                         if (environment_stack[depth] != latexname) {
1240                                 if (depth == 0) {
1241                                         sgml::openTag(ofs, depth, false, "p");
1242                                 }
1243                                 sgml::openTag(ofs, depth, false, latexname);
1244
1245                                 if (environment_stack.size() == depth + 1)
1246                                         environment_stack.push_back("!-- --");
1247                                 environment_stack[depth] = latexname;
1248                         }
1249
1250                         if (style->latexparam() == "CDATA")
1251                                 ofs << "<![CDATA[";
1252
1253                         if (style->latextype == LATEX_ENVIRONMENT) break;
1254
1255                         if (style->labeltype == LABEL_MANUAL)
1256                                 item_name = "tag";
1257                         else
1258                                 item_name = "item";
1259
1260                         sgml::openTag(ofs, depth + 1, false, item_name);
1261                 }
1262                 break;
1263
1264                 default:
1265                         sgml::openTag(ofs, depth, false, style->latexname());
1266                         break;
1267                 }
1268
1269                 simpleLinuxDocOnePar(ofs, pit, depth);
1270
1271                 ofs << "\n";
1272                 // write closing SGML tags
1273                 switch (style->latextype) {
1274                 case LATEX_COMMAND:
1275                         break;
1276                 case LATEX_ENVIRONMENT:
1277                 case LATEX_ITEM_ENVIRONMENT:
1278                 case LATEX_BIB_ENVIRONMENT:
1279                         if (style->latexparam() == "CDATA")
1280                                 ofs << "]]>";
1281                         break;
1282                 default:
1283                         sgml::closeTag(ofs, depth, false, style->latexname());
1284                         break;
1285                 }
1286         }
1287
1288         // Close open tags
1289         for (int i = depth; i >= 0; --i)
1290                 sgml::closeTag(ofs, depth, false, environment_stack[i]);
1291
1292         if (!body_only) {
1293                 ofs << "\n\n";
1294                 sgml::closeTag(ofs, 0, false, top_element);
1295         }
1296
1297         ofs.close();
1298         // How to check for successful close
1299
1300         // we want this to be true outside previews (for insetexternal)
1301         niceFile = true;
1302
1303         users->showErrorList(_("LinuxDoc"));
1304 }
1305
1306
1307 // checks, if newcol chars should be put into this line
1308 // writes newline, if necessary.
1309 namespace {
1310
1311 void sgmlLineBreak(ostream & os, string::size_type & colcount,
1312                           string::size_type newcol)
1313 {
1314         colcount += newcol;
1315         if (colcount > lyxrc.ascii_linelen) {
1316                 os << "\n";
1317                 colcount = newcol; // assume write after this call
1318         }
1319 }
1320
1321 enum PAR_TAG {
1322         NONE=0,
1323         TT = 1,
1324         SF = 2,
1325         BF = 4,
1326         IT = 8,
1327         SL = 16,
1328         EM = 32
1329 };
1330
1331
1332 string tag_name(PAR_TAG const & pt) {
1333         switch (pt) {
1334         case NONE: return "!-- --";
1335         case TT: return "tt";
1336         case SF: return "sf";
1337         case BF: return "bf";
1338         case IT: return "it";
1339         case SL: return "sl";
1340         case EM: return "em";
1341         }
1342         return "";
1343 }
1344
1345
1346 inline
1347 void operator|=(PAR_TAG & p1, PAR_TAG const & p2)
1348 {
1349         p1 = static_cast<PAR_TAG>(p1 | p2);
1350 }
1351
1352
1353 inline
1354 void reset(PAR_TAG & p1, PAR_TAG const & p2)
1355 {
1356         p1 = static_cast<PAR_TAG>(p1 & ~p2);
1357 }
1358
1359 } // anon
1360
1361
1362 // Handle internal paragraph parsing -- layout already processed.
1363 void Buffer::simpleLinuxDocOnePar(ostream & os,
1364         ParagraphList::iterator par,
1365         Paragraph::depth_type /*depth*/) const
1366 {
1367         LyXLayout_ptr const & style = par->layout();
1368
1369         string::size_type char_line_count = 5;     // Heuristic choice ;-)
1370
1371         // gets paragraph main font
1372         LyXFont font_old;
1373         bool desc_on;
1374         if (style->labeltype == LABEL_MANUAL) {
1375                 font_old = style->labelfont;
1376                 desc_on = true;
1377         } else {
1378                 font_old = style->font;
1379                 desc_on = false;
1380         }
1381
1382         LyXFont::FONT_FAMILY family_type = LyXFont::ROMAN_FAMILY;
1383         LyXFont::FONT_SERIES series_type = LyXFont::MEDIUM_SERIES;
1384         LyXFont::FONT_SHAPE  shape_type  = LyXFont::UP_SHAPE;
1385         bool is_em = false;
1386
1387         stack<PAR_TAG> tag_state;
1388         // parsing main loop
1389         for (pos_type i = 0; i < par->size(); ++i) {
1390
1391                 PAR_TAG tag_close = NONE;
1392                 list < PAR_TAG > tag_open;
1393
1394                 LyXFont const font = par->getFont(params, i, outerFont(par, paragraphs));
1395
1396                 if (font_old.family() != font.family()) {
1397                         switch (family_type) {
1398                         case LyXFont::SANS_FAMILY:
1399                                 tag_close |= SF;
1400                                 break;
1401                         case LyXFont::TYPEWRITER_FAMILY:
1402                                 tag_close |= TT;
1403                                 break;
1404                         default:
1405                                 break;
1406                         }
1407
1408                         family_type = font.family();
1409
1410                         switch (family_type) {
1411                         case LyXFont::SANS_FAMILY:
1412                                 tag_open.push_back(SF);
1413                                 break;
1414                         case LyXFont::TYPEWRITER_FAMILY:
1415                                 tag_open.push_back(TT);
1416                                 break;
1417                         default:
1418                                 break;
1419                         }
1420                 }
1421
1422                 if (font_old.series() != font.series()) {
1423                         switch (series_type) {
1424                         case LyXFont::BOLD_SERIES:
1425                                 tag_close |= BF;
1426                                 break;
1427                         default:
1428                                 break;
1429                         }
1430
1431                         series_type = font.series();
1432
1433                         switch (series_type) {
1434                         case LyXFont::BOLD_SERIES:
1435                                 tag_open.push_back(BF);
1436                                 break;
1437                         default:
1438                                 break;
1439                         }
1440
1441                 }
1442
1443                 if (font_old.shape() != font.shape()) {
1444                         switch (shape_type) {
1445                         case LyXFont::ITALIC_SHAPE:
1446                                 tag_close |= IT;
1447                                 break;
1448                         case LyXFont::SLANTED_SHAPE:
1449                                 tag_close |= SL;
1450                                 break;
1451                         default:
1452                                 break;
1453                         }
1454
1455                         shape_type = font.shape();
1456
1457                         switch (shape_type) {
1458                         case LyXFont::ITALIC_SHAPE:
1459                                 tag_open.push_back(IT);
1460                                 break;
1461                         case LyXFont::SLANTED_SHAPE:
1462                                 tag_open.push_back(SL);
1463                                 break;
1464                         default:
1465                                 break;
1466                         }
1467                 }
1468                 // handle <em> tag
1469                 if (font_old.emph() != font.emph()) {
1470                         if (font.emph() == LyXFont::ON) {
1471                                 tag_open.push_back(EM);
1472                                 is_em = true;
1473                         }
1474                         else if (is_em) {
1475                                 tag_close |= EM;
1476                                 is_em = false;
1477                         }
1478                 }
1479
1480                 list < PAR_TAG > temp;
1481                 while (!tag_state.empty() && tag_close) {
1482                         PAR_TAG k =  tag_state.top();
1483                         tag_state.pop();
1484                         os << "</" << tag_name(k) << '>';
1485                         if (tag_close & k)
1486                                 reset(tag_close,k);
1487                         else
1488                                 temp.push_back(k);
1489                 }
1490
1491                 for(list< PAR_TAG >::const_iterator j = temp.begin();
1492                     j != temp.end(); ++j) {
1493                         tag_state.push(*j);
1494                         os << '<' << tag_name(*j) << '>';
1495                 }
1496
1497                 for(list< PAR_TAG >::const_iterator j = tag_open.begin();
1498                     j != tag_open.end(); ++j) {
1499                         tag_state.push(*j);
1500                         os << '<' << tag_name(*j) << '>';
1501                 }
1502
1503                 char c = par->getChar(i);
1504
1505                 if (c == Paragraph::META_INSET) {
1506                         Inset * inset = par->getInset(i);
1507                         inset->linuxdoc(this, os);
1508                         font_old = font;
1509                         continue;
1510                 }
1511
1512                 if (style->latexparam() == "CDATA") {
1513                         // "TeX"-Mode on == > SGML-Mode on.
1514                         if (c != '\0')
1515                                 os << c;
1516                         ++char_line_count;
1517                 } else {
1518                         bool ws;
1519                         string str;
1520                         boost::tie(ws, str) = sgml::escapeChar(c);
1521                         if (ws && !style->free_spacing && !par->isFreeSpacing()) {
1522                                 // in freespacing mode, spaces are
1523                                 // non-breaking characters
1524                                 if (desc_on) {// if char is ' ' then...
1525
1526                                         ++char_line_count;
1527                                         sgmlLineBreak(os, char_line_count, 6);
1528                                         os << "</tag>";
1529                                         desc_on = false;
1530                                 } else  {
1531                                         sgmlLineBreak(os, char_line_count, 1);
1532                                         os << c;
1533                                 }
1534                         } else {
1535                                 os << str;
1536                                 char_line_count += str.length();
1537                         }
1538                 }
1539                 font_old = font;
1540         }
1541
1542         while (!tag_state.empty()) {
1543                 os << "</" << tag_name(tag_state.top()) << '>';
1544                 tag_state.pop();
1545         }
1546
1547         // resets description flag correctly
1548         if (desc_on) {
1549                 // <tag> not closed...
1550                 sgmlLineBreak(os, char_line_count, 6);
1551                 os << "</tag>";
1552         }
1553 }
1554
1555
1556 // Print an error message.
1557 void Buffer::sgmlError(ParagraphList::iterator pit, int pos,
1558                        string const & message) const
1559 {
1560         users->addError(ErrorItem(message, string(), pit->id(), pos, pos));
1561 }
1562
1563
1564 void Buffer::makeDocBookFile(string const & fname, bool nice, bool only_body)
1565 {
1566         ofstream ofs(fname.c_str());
1567         if (!ofs) {
1568                 string const file = MakeDisplayPath(fname, 50);
1569                 string text = bformat(_("Could not save the specified document\n%1$s.\n"),
1570                         file);
1571                 Alert::error(_("Could not save document"), text);
1572                 return;
1573         }
1574
1575         niceFile = nice; // this will be used by Insetincludes.
1576
1577         LaTeXFeatures features(params);
1578         validate(features);
1579
1580         texrow.reset();
1581
1582         LyXTextClass const & tclass = params.getLyXTextClass();
1583         string top_element = tclass.latexname();
1584
1585         if (!only_body) {
1586                 ofs << "<!DOCTYPE " << top_element
1587                     << "  PUBLIC \"-//OASIS//DTD DocBook V4.1//EN\"";
1588
1589                 string preamble = params.preamble;
1590                 const string name = nice ? ChangeExtension(filename_, ".sgml")
1591                          : fname;
1592                 preamble += features.getIncludedFiles(name);
1593                 preamble += features.getLyXSGMLEntities();
1594
1595                 if (!preamble.empty()) {
1596                         ofs << "\n [ " << preamble << " ]";
1597                 }
1598                 ofs << ">\n\n";
1599         }
1600
1601         string top = top_element;
1602         top += " lang=\"";
1603         top += params.language->code();
1604         top += '"';
1605
1606         if (!params.options.empty()) {
1607                 top += ' ';
1608                 top += params.options;
1609         }
1610         sgml::openTag(ofs, 0, false, top);
1611
1612         ofs << "<!-- DocBook file was created by " << lyx_docversion
1613             << "\n  See http://www.lyx.org/ for more information -->\n";
1614
1615         vector<string> environment_stack(10);
1616         vector<string> environment_inner(10);
1617         vector<string> command_stack(10);
1618
1619         bool command_flag = false;
1620         Paragraph::depth_type command_depth = 0;
1621         Paragraph::depth_type command_base = 0;
1622         Paragraph::depth_type cmd_depth = 0;
1623         Paragraph::depth_type depth = 0; // paragraph depth
1624
1625         string item_name;
1626         string command_name;
1627
1628         users->resetErrorList();
1629
1630         ParagraphList::iterator par = paragraphs.begin();
1631         ParagraphList::iterator pend = paragraphs.end();
1632
1633         for (; par != pend; ++par) {
1634                 string sgmlparam;
1635                 string c_depth;
1636                 string c_params;
1637                 int desc_on = 0; // description mode
1638
1639                 LyXLayout_ptr const & style = par->layout();
1640
1641                 // environment tag closing
1642                 for (; depth > par->params().depth(); --depth) {
1643                         if (environment_inner[depth] != "!-- --") {
1644                                 item_name = "listitem";
1645                                 sgml::closeTag(ofs, command_depth + depth, false, item_name);
1646                                 if (environment_inner[depth] == "varlistentry")
1647                                         sgml::closeTag(ofs, depth+command_depth, false, environment_inner[depth]);
1648                         }
1649                         sgml::closeTag(ofs, depth + command_depth, false, environment_stack[depth]);
1650                         environment_stack[depth].erase();
1651                         environment_inner[depth].erase();
1652                 }
1653
1654                 if (depth == par->params().depth()
1655                    && environment_stack[depth] != style->latexname()
1656                    && !environment_stack[depth].empty()) {
1657                         if (environment_inner[depth] != "!-- --") {
1658                                 item_name= "listitem";
1659                                 sgml::closeTag(ofs, command_depth+depth, false, item_name);
1660                                 if (environment_inner[depth] == "varlistentry")
1661                                         sgml::closeTag(ofs, depth + command_depth, false, environment_inner[depth]);
1662                         }
1663
1664                         sgml::closeTag(ofs, depth + command_depth, false, environment_stack[depth]);
1665
1666                         environment_stack[depth].erase();
1667                         environment_inner[depth].erase();
1668                 }
1669
1670                 // Write opening SGML tags.
1671                 switch (style->latextype) {
1672                 case LATEX_PARAGRAPH:
1673                         sgml::openTag(ofs, depth + command_depth,
1674                                     false, style->latexname());
1675                         break;
1676
1677                 case LATEX_COMMAND:
1678                         if (depth != 0)
1679                                 sgmlError(par, 0,
1680                                           _("Error: Wrong depth for LatexType Command.\n"));
1681
1682                         command_name = style->latexname();
1683
1684                         sgmlparam = style->latexparam();
1685                         c_params = split(sgmlparam, c_depth,'|');
1686
1687                         cmd_depth = lyx::atoi(c_depth);
1688
1689                         if (command_flag) {
1690                                 if (cmd_depth < command_base) {
1691                                         for (Paragraph::depth_type j = command_depth;
1692                                              j >= command_base; --j) {
1693                                                 sgml::closeTag(ofs, j, false, command_stack[j]);
1694                                                 ofs << endl;
1695                                         }
1696                                         command_depth = command_base = cmd_depth;
1697                                 } else if (cmd_depth <= command_depth) {
1698                                         for (int j = command_depth;
1699                                              j >= int(cmd_depth); --j) {
1700                                                 sgml::closeTag(ofs, j, false, command_stack[j]);
1701                                                 ofs << endl;
1702                                         }
1703                                         command_depth = cmd_depth;
1704                                 } else
1705                                         command_depth = cmd_depth;
1706                         } else {
1707                                 command_depth = command_base = cmd_depth;
1708                                 command_flag = true;
1709                         }
1710                         if (command_stack.size() == command_depth + 1)
1711                                 command_stack.push_back(string());
1712                         command_stack[command_depth] = command_name;
1713
1714                         // treat label as a special case for
1715                         // more WYSIWYM handling.
1716                         // This is a hack while paragraphs can't have
1717                         // attributes, like id in this case.
1718                         if (par->isInset(0)) {
1719                                 Inset * inset = par->getInset(0);
1720                                 Inset::Code lyx_code = inset->lyxCode();
1721                                 if (lyx_code == Inset::LABEL_CODE) {
1722                                         command_name += " id=\"";
1723                                         command_name += (static_cast<InsetCommand *>(inset))->getContents();
1724                                         command_name += '"';
1725                                         desc_on = 3;
1726                                 }
1727                         }
1728
1729                         sgml::openTag(ofs, depth + command_depth, false, command_name);
1730
1731                         item_name = c_params.empty() ? "title" : c_params;
1732                         sgml::openTag(ofs, depth + 1 + command_depth, false, item_name);
1733                         break;
1734
1735                 case LATEX_ENVIRONMENT:
1736                 case LATEX_ITEM_ENVIRONMENT:
1737                         if (depth < par->params().depth()) {
1738                                 depth = par->params().depth();
1739                                 environment_stack[depth].erase();
1740                         }
1741
1742                         if (environment_stack[depth] != style->latexname()) {
1743                                 if (environment_stack.size() == depth + 1) {
1744                                         environment_stack.push_back("!-- --");
1745                                         environment_inner.push_back("!-- --");
1746                                 }
1747                                 environment_stack[depth] = style->latexname();
1748                                 environment_inner[depth] = "!-- --";
1749                                 sgml::openTag(ofs, depth + command_depth, false, environment_stack[depth]);
1750                         } else {
1751                                 if (environment_inner[depth] != "!-- --") {
1752                                         item_name= "listitem";
1753                                         sgml::closeTag(ofs, command_depth + depth, false, item_name);
1754                                         if (environment_inner[depth] == "varlistentry")
1755                                                 sgml::closeTag(ofs, depth + command_depth, false, environment_inner[depth]);
1756                                 }
1757                         }
1758
1759                         if (style->latextype == LATEX_ENVIRONMENT) {
1760                                 if (!style->latexparam().empty()) {
1761                                         if (style->latexparam() == "CDATA")
1762                                                 ofs << "<![CDATA[";
1763                                         else
1764                                                 sgml::openTag(ofs, depth + command_depth, false, style->latexparam());
1765                                 }
1766                                 break;
1767                         }
1768
1769                         desc_on = (style->labeltype == LABEL_MANUAL);
1770
1771                         environment_inner[depth] = desc_on ? "varlistentry" : "listitem";
1772                         sgml::openTag(ofs, depth + 1 + command_depth,
1773                                     false, environment_inner[depth]);
1774
1775                         item_name = desc_on ? "term" : "para";
1776                         sgml::openTag(ofs, depth + 1 + command_depth,
1777                                     false, item_name);
1778                         break;
1779                 default:
1780                         sgml::openTag(ofs, depth + command_depth,
1781                                     false, style->latexname());
1782                         break;
1783                 }
1784
1785                 simpleDocBookOnePar(ofs, par, desc_on,
1786                                     depth + 1 + command_depth);
1787
1788                 string end_tag;
1789                 // write closing SGML tags
1790                 switch (style->latextype) {
1791                 case LATEX_COMMAND:
1792                         end_tag = c_params.empty() ? "title" : c_params;
1793                         sgml::closeTag(ofs, depth + command_depth,
1794                                      false, end_tag);
1795                         break;
1796                 case LATEX_ENVIRONMENT:
1797                         if (!style->latexparam().empty()) {
1798                                 if (style->latexparam() == "CDATA")
1799                                         ofs << "]]>";
1800                                 else
1801                                         sgml::closeTag(ofs, depth + command_depth, false, style->latexparam());
1802                         }
1803                         break;
1804                 case LATEX_ITEM_ENVIRONMENT:
1805                         if (desc_on == 1) break;
1806                         end_tag = "para";
1807                         sgml::closeTag(ofs, depth + 1 + command_depth, false, end_tag);
1808                         break;
1809                 case LATEX_PARAGRAPH:
1810                         sgml::closeTag(ofs, depth + command_depth, false, style->latexname());
1811                         break;
1812                 default:
1813                         sgml::closeTag(ofs, depth + command_depth, false, style->latexname());
1814                         break;
1815                 }
1816         }
1817
1818         // Close open tags
1819         for (int d = depth; d >= 0; --d) {
1820                 if (!environment_stack[depth].empty()) {
1821                         if (environment_inner[depth] != "!-- --") {
1822                                 item_name = "listitem";
1823                                 sgml::closeTag(ofs, command_depth + depth, false, item_name);
1824                                if (environment_inner[depth] == "varlistentry")
1825                                        sgml::closeTag(ofs, depth + command_depth, false, environment_inner[depth]);
1826                         }
1827
1828                         sgml::closeTag(ofs, depth + command_depth, false, environment_stack[depth]);
1829                 }
1830         }
1831
1832         for (int j = command_depth; j >= 0 ; --j)
1833                 if (!command_stack[j].empty()) {
1834                         sgml::closeTag(ofs, j, false, command_stack[j]);
1835                         ofs << endl;
1836                 }
1837
1838         ofs << "\n\n";
1839         sgml::closeTag(ofs, 0, false, top_element);
1840
1841         ofs.close();
1842         // How to check for successful close
1843
1844         // we want this to be true outside previews (for insetexternal)
1845         niceFile = true;
1846         users->showErrorList(_("DocBook"));
1847 }
1848
1849
1850 void Buffer::simpleDocBookOnePar(ostream & os,
1851                                  ParagraphList::iterator par, int & desc_on,
1852                                  Paragraph::depth_type depth) const
1853 {
1854         bool emph_flag = false;
1855
1856         LyXLayout_ptr const & style = par->layout();
1857
1858         LyXFont font_old = (style->labeltype == LABEL_MANUAL ? style->labelfont : style->font);
1859
1860         int char_line_count = depth;
1861         //if (!style.free_spacing)
1862         //      os << string(depth,' ');
1863
1864         // parsing main loop
1865         for (pos_type i = 0; i < par->size(); ++i) {
1866                 LyXFont font = par->getFont(params, i, outerFont(par, paragraphs));
1867
1868                 // handle <emphasis> tag
1869                 if (font_old.emph() != font.emph()) {
1870                         if (font.emph() == LyXFont::ON) {
1871                                 if (style->latexparam() == "CDATA")
1872                                         os << "]]>";
1873                                 os << "<emphasis>";
1874                                 if (style->latexparam() == "CDATA")
1875                                         os << "<![CDATA[";
1876                                 emph_flag = true;
1877                         } else if (i) {
1878                                 if (style->latexparam() == "CDATA")
1879                                         os << "]]>";
1880                                 os << "</emphasis>";
1881                                 if (style->latexparam() == "CDATA")
1882                                         os << "<![CDATA[";
1883                                 emph_flag = false;
1884                         }
1885                 }
1886
1887
1888                 if (par->isInset(i)) {
1889                         Inset * inset = par->getInset(i);
1890                         // don't print the inset in position 0 if desc_on == 3 (label)
1891                         if (i || desc_on != 3) {
1892                                 if (style->latexparam() == "CDATA")
1893                                         os << "]]>";
1894                                 inset->docbook(this, os, false);
1895                                 if (style->latexparam() == "CDATA")
1896                                         os << "<![CDATA[";
1897                         }
1898                 } else {
1899                         char c = par->getChar(i);
1900                         bool ws;
1901                         string str;
1902                         boost::tie(ws, str) = sgml::escapeChar(c);
1903
1904                         if (style->pass_thru) {
1905                                 os << c;
1906                         } else if (style->free_spacing || par->isFreeSpacing() || c != ' ') {
1907                                         os << str;
1908                         } else if (desc_on ==1) {
1909                                 ++char_line_count;
1910                                 os << "\n</term><listitem><para>";
1911                                 desc_on = 2;
1912                         } else {
1913                                 os << ' ';
1914                         }
1915                 }
1916                 font_old = font;
1917         }
1918
1919         if (emph_flag) {
1920                 if (style->latexparam() == "CDATA")
1921                         os << "]]>";
1922                 os << "</emphasis>";
1923                 if (style->latexparam() == "CDATA")
1924                         os << "<![CDATA[";
1925         }
1926
1927         // resets description flag correctly
1928         if (desc_on == 1) {
1929                 // <term> not closed...
1930                 os << "</term>\n<listitem><para>&nbsp;</para>";
1931         }
1932         if (style->free_spacing)
1933                 os << '\n';
1934 }
1935
1936
1937 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1938 // Other flags: -wall -v0 -x
1939 int Buffer::runChktex()
1940 {
1941         if (!users->text) return 0;
1942
1943         users->owner()->busy(true);
1944
1945         // get LaTeX-Filename
1946         string const name = getLatexName();
1947         string path = filePath();
1948
1949         string const org_path = path;
1950         if (lyxrc.use_tempdir || !IsDirWriteable(path)) {
1951                 path = tmppath;
1952         }
1953
1954         Path p(path); // path to LaTeX file
1955         users->owner()->message(_("Running chktex..."));
1956
1957         // Remove all error insets
1958         bool const removedErrorInsets = users->removeAutoInsets();
1959
1960         // Generate the LaTeX file if neccessary
1961         makeLaTeXFile(name, org_path, false);
1962
1963         TeXErrors terr;
1964         Chktex chktex(lyxrc.chktex_command, name, filePath());
1965         int res = chktex.run(terr); // run chktex
1966
1967         if (res == -1) {
1968                 Alert::error(_("chktex failure"),
1969                         _("Could not run chktex successfully."));
1970         } else if (res > 0) {
1971                 // Insert all errors as errors boxes
1972                 ErrorList el (*this, terr);
1973                 users->setErrorList(el);
1974                 users->showErrorList(_("ChkTeX"));
1975         }
1976
1977         // if we removed error insets before we ran chktex or if we inserted
1978         // error insets after we ran chktex, this must be run:
1979         if (removedErrorInsets || res) {
1980 #warning repaint needed here, or do you mean update() ?
1981                 users->repaint();
1982                 users->fitCursor();
1983         }
1984         users->owner()->busy(false);
1985
1986         return res;
1987 }
1988
1989
1990 void Buffer::validate(LaTeXFeatures & features) const
1991 {
1992         LyXTextClass const & tclass = params.getLyXTextClass();
1993
1994         if (params.tracking_changes) {
1995                 features.require("dvipost");
1996                 features.require("color");
1997         }
1998
1999         // AMS Style is at document level
2000         if (params.use_amsmath == BufferParams::AMS_ON
2001             || tclass.provides(LyXTextClass::amsmath))
2002                 features.require("amsmath");
2003
2004         for_each(paragraphs.begin(), paragraphs.end(),
2005                  boost::bind(&Paragraph::validate, _1, boost::ref(features)));
2006
2007         // the bullet shapes are buffer level not paragraph level
2008         // so they are tested here
2009         for (int i = 0; i < 4; ++i) {
2010                 if (params.user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
2011                         int const font = params.user_defined_bullets[i].getFont();
2012                         if (font == 0) {
2013                                 int const c = params
2014                                         .user_defined_bullets[i]
2015                                         .getCharacter();
2016                                 if (c == 16
2017                                    || c == 17
2018                                    || c == 25
2019                                    || c == 26
2020                                    || c == 31) {
2021                                         features.require("latexsym");
2022                                 }
2023                         } else if (font == 1) {
2024                                 features.require("amssymb");
2025                         } else if ((font >= 2 && font <= 5)) {
2026                                 features.require("pifont");
2027                         }
2028                 }
2029         }
2030
2031         if (lyxerr.debugging(Debug::LATEX)) {
2032                 features.showStruct();
2033         }
2034 }
2035
2036
2037 vector<string> const Buffer::getLabelList() const
2038 {
2039         /// if this is a child document and the parent is already loaded
2040         /// Use the parent's list instead  [ale990407]
2041         if (!params.parentname.empty()
2042             && bufferlist.exists(params.parentname)) {
2043                 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
2044                 if (tmp)
2045                         return tmp->getLabelList();
2046         }
2047
2048         vector<string> label_list;
2049         for (inset_iterator it = inset_const_iterator_begin();
2050              it != inset_const_iterator_end(); ++it) {
2051                 vector<string> const l = it->getLabelList();
2052                 label_list.insert(label_list.end(), l.begin(), l.end());
2053         }
2054         return label_list;
2055 }
2056
2057
2058 // This is also a buffer property (ale)
2059 void Buffer::fillWithBibKeys(vector<pair<string, string> > & keys) const
2060 {
2061         /// if this is a child document and the parent is already loaded
2062         /// use the parent's list instead  [ale990412]
2063         if (!params.parentname.empty() && bufferlist.exists(params.parentname)) {
2064                 Buffer const * tmp = bufferlist.getBuffer(params.parentname);
2065                 if (tmp) {
2066                         tmp->fillWithBibKeys(keys);
2067                         return;
2068                 }
2069         }
2070
2071         for (inset_iterator it = inset_const_iterator_begin();
2072                 it != inset_const_iterator_end(); ++it) {
2073                 if (it->lyxCode() == Inset::BIBTEX_CODE)
2074                         static_cast<InsetBibtex &>(*it).fillWithBibKeys(this, keys);
2075                 else if (it->lyxCode() == Inset::INCLUDE_CODE)
2076                         static_cast<InsetInclude &>(*it).fillWithBibKeys(keys);
2077                 else if (it->lyxCode() == Inset::BIBITEM_CODE) {
2078                         InsetBibitem & bib = static_cast<InsetBibitem &>(*it);
2079                         string const key = bib.getContents();
2080                         string const opt = bib.getOptions();
2081                         string const ref; // = pit->asString(this, false);
2082                         string const info = opt + "TheBibliographyRef" + ref;
2083                         keys.push_back(pair<string, string>(key, info));
2084                 }
2085         }
2086 }
2087
2088
2089 bool Buffer::isDepClean(string const & name) const
2090 {
2091         DepClean::const_iterator it = dep_clean_.find(name);
2092         if (it == dep_clean_.end())
2093                 return true;
2094         return it->second;
2095 }
2096
2097
2098 void Buffer::markDepClean(string const & name)
2099 {
2100         dep_clean_[name] = true;
2101 }
2102
2103
2104 bool Buffer::dispatch(string const & command, bool * result)
2105 {
2106         // Split command string into command and argument
2107         string cmd;
2108         string line = ltrim(command);
2109         string const arg = trim(split(line, cmd, ' '));
2110
2111         return dispatch(lyxaction.LookupFunc(cmd), arg, result);
2112 }
2113
2114
2115 bool Buffer::dispatch(int action, string const & argument, bool * result)
2116 {
2117         bool dispatched = true;
2118
2119         switch (action) {
2120                 case LFUN_EXPORT: {
2121                         bool const tmp = Exporter::Export(this, argument, false);
2122                         if (result)
2123                                 *result = tmp;
2124                         break;
2125                 }
2126
2127                 default:
2128                         dispatched = false;
2129         }
2130         return dispatched;
2131 }
2132
2133
2134 void Buffer::resizeInsets(BufferView * bv)
2135 {
2136         /// then remove all LyXText in text-insets
2137         for_each(paragraphs.begin(), paragraphs.end(),
2138                  boost::bind(&Paragraph::resizeInsetsLyXText, _1, bv));
2139 }
2140
2141
2142 void Buffer::redraw()
2143 {
2144 #warning repaint needed here, or do you mean update() ?
2145         users->repaint();
2146         users->fitCursor();
2147 }
2148
2149
2150 void Buffer::changeLanguage(Language const * from, Language const * to)
2151 {
2152         lyxerr << "Changing Language!" << endl;
2153
2154         // Take care of l10n/i18n
2155         updateDocLang(to);
2156
2157         ParIterator end = par_iterator_end();
2158         for (ParIterator it = par_iterator_begin(); it != end; ++it)
2159                 (*it)->changeLanguage(params, from, to);
2160 }
2161
2162
2163 void Buffer::updateDocLang(Language const * nlang)
2164 {
2165         messages_.reset(new Messages(nlang->code()));
2166 }
2167
2168
2169 bool Buffer::isMultiLingual()
2170 {
2171         ParIterator end = par_iterator_end();
2172         for (ParIterator it = par_iterator_begin(); it != end; ++it)
2173                 if ((*it)->isMultiLingual(params))
2174                         return true;
2175
2176         return false;
2177 }
2178
2179
2180 void Buffer::inset_iterator::setParagraph()
2181 {
2182         while (pit != pend) {
2183                 it = pit->insetlist.begin();
2184                 if (it != pit->insetlist.end())
2185                         return;
2186                 ++pit;
2187         }
2188 }
2189
2190
2191 Inset * Buffer::getInsetFromID(int id_arg) const
2192 {
2193         for (inset_iterator it = inset_const_iterator_begin();
2194                  it != inset_const_iterator_end(); ++it)
2195         {
2196                 if (it->id() == id_arg)
2197                         return &(*it);
2198                 Inset * in = it->getInsetFromID(id_arg);
2199                 if (in)
2200                         return in;
2201         }
2202         return 0;
2203 }
2204
2205
2206 ParIterator Buffer::getParFromID(int id) const
2207 {
2208 #warning FIXME: const correctness! (Andre)
2209         ParIterator it(const_cast<Buffer*>(this)->par_iterator_begin());
2210         ParIterator end(const_cast<Buffer*>(this)->par_iterator_end());
2211
2212 #warning FIXME, perhaps this func should return a ParIterator? (Lgb)
2213         if (id < 0) {
2214                 // John says this is called with id == -1 from undo
2215                 lyxerr << "getParFromID(), id: " << id << endl;
2216                 return end;
2217         }
2218
2219         for (; it != end; ++it)
2220                 if ((*it)->id() == id)
2221                         return it;
2222
2223         return end;
2224 }
2225
2226
2227 bool Buffer::hasParWithID(int id) const
2228 {
2229         ParIterator it(const_cast<Buffer*>(this)->par_iterator_begin());
2230         ParIterator end(const_cast<Buffer*>(this)->par_iterator_end());
2231
2232         if (id < 0) {
2233                 // John says this is called with id == -1 from undo
2234                 lyxerr << "hasParWithID(), id: " << id << endl;
2235                 return 0;
2236         }
2237
2238         for (; it != end; ++it)
2239                 if ((*it)->id() == id)
2240                         return true;
2241
2242         return false;
2243 }
2244
2245
2246 ParIterator Buffer::par_iterator_begin()
2247 {
2248         return ParIterator(paragraphs.begin(), paragraphs);
2249 }
2250
2251
2252 ParIterator Buffer::par_iterator_end()
2253 {
2254         return ParIterator(paragraphs.end(), paragraphs);
2255 }
2256
2257 ParConstIterator Buffer::par_iterator_begin() const
2258 {
2259         return ParConstIterator(paragraphs.begin(), paragraphs);
2260 }
2261
2262
2263 ParConstIterator Buffer::par_iterator_end() const
2264 {
2265         return ParConstIterator(paragraphs.end(), paragraphs);
2266 }
2267
2268
2269
2270 void Buffer::addUser(BufferView * u)
2271 {
2272         users = u;
2273 }
2274
2275
2276 void Buffer::delUser(BufferView *)
2277 {
2278         users = 0;
2279 }
2280
2281
2282 Language const * Buffer::getLanguage() const
2283 {
2284         return params.language;
2285 }
2286
2287
2288 string const Buffer::B_(string const & l10n) const
2289 {
2290         if (messages_.get()) {
2291                 return messages_->get(l10n);
2292         }
2293
2294         return _(l10n);
2295 }
2296
2297
2298 bool Buffer::isClean() const
2299 {
2300         return lyx_clean;
2301 }
2302
2303
2304 bool Buffer::isBakClean() const
2305 {
2306         return bak_clean;
2307 }
2308
2309
2310 void Buffer::markClean() const
2311 {
2312         if (!lyx_clean) {
2313                 lyx_clean = true;
2314                 updateTitles();
2315         }
2316         // if the .lyx file has been saved, we don't need an
2317         // autosave
2318         bak_clean = true;
2319 }
2320
2321
2322 void Buffer::markBakClean()
2323 {
2324         bak_clean = true;
2325 }
2326
2327
2328 void Buffer::setUnnamed(bool flag)
2329 {
2330         unnamed = flag;
2331 }
2332
2333
2334 bool Buffer::isUnnamed()
2335 {
2336         return unnamed;
2337 }
2338
2339
2340 void Buffer::markDirty()
2341 {
2342         if (lyx_clean) {
2343                 lyx_clean = false;
2344                 updateTitles();
2345         }
2346         bak_clean = false;
2347
2348         DepClean::iterator it = dep_clean_.begin();
2349         DepClean::const_iterator const end = dep_clean_.end();
2350
2351         for (; it != end; ++it) {
2352                 it->second = false;
2353         }
2354 }
2355
2356
2357 string const & Buffer::fileName() const
2358 {
2359         return filename_;
2360 }
2361
2362
2363 string const & Buffer::filePath() const
2364 {
2365         return filepath_;
2366 }
2367
2368
2369 bool Buffer::isReadonly() const
2370 {
2371         return read_only;
2372 }
2373
2374
2375 BufferView * Buffer::getUser() const
2376 {
2377         return users;
2378 }
2379
2380
2381 void Buffer::setParentName(string const & name)
2382 {
2383         params.parentname = name;
2384 }
2385
2386
2387 Buffer::inset_iterator::inset_iterator()
2388         : pit(0), pend(0)
2389 {}
2390
2391
2392 Buffer::inset_iterator::inset_iterator(base_type p, base_type e)
2393         : pit(p), pend(e)
2394 {
2395         setParagraph();
2396 }
2397
2398
2399 Buffer::inset_iterator & Buffer::inset_iterator::operator++()
2400 {
2401         if (pit != pend) {
2402                 ++it;
2403                 if (it == pit->insetlist.end()) {
2404                         ++pit;
2405                         setParagraph();
2406                 }
2407         }
2408         return *this;
2409 }
2410
2411
2412 Buffer::inset_iterator Buffer::inset_iterator::operator++(int)
2413 {
2414         inset_iterator tmp = *this;
2415         ++*this;
2416         return tmp;
2417 }
2418
2419
2420 Buffer::inset_iterator::reference Buffer::inset_iterator::operator*()
2421 {
2422         return *it.getInset();
2423 }
2424
2425
2426 Buffer::inset_iterator::pointer Buffer::inset_iterator::operator->()
2427 {
2428         return it.getInset();
2429 }
2430
2431
2432 ParagraphList::iterator Buffer::inset_iterator::getPar() const
2433 {
2434         return pit;
2435 }
2436
2437
2438 lyx::pos_type Buffer::inset_iterator::getPos() const
2439 {
2440         return it.getPos();
2441 }
2442
2443
2444 bool operator==(Buffer::inset_iterator const & iter1,
2445                 Buffer::inset_iterator const & iter2)
2446 {
2447         return iter1.pit == iter2.pit
2448                 && (iter1.pit == iter1.pend || iter1.it == iter2.it);
2449 }
2450
2451
2452 bool operator!=(Buffer::inset_iterator const & iter1,
2453                 Buffer::inset_iterator const & iter2)
2454 {
2455         return !(iter1 == iter2);
2456 }