src/buffer_funcs.C

   1 /**
   2  * \file buffer_funcs.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  * \author Alfredo Braunstein
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  */
  12
  13 #include <config.h>
  14
  15 #include "buffer_funcs.h"
  16 #include "buffer.h"
  17 #include "bufferlist.h"
  18 #include "bufferparams.h"
  19 #include "dociterator.h"
  20 #include "counters.h"
  21 #include "errorlist.h"
  22 #include "Floating.h"
  23 #include "FloatList.h"
  24 #include "gettext.h"
  25 #include "language.h"
  26 #include "LaTeX.h"
  27 #include "lyxtextclass.h"
  28 #include "paragraph.h"
  29 #include "paragraph_funcs.h"
  30 #include "ParagraphList.h"
  31 #include "ParagraphParameters.h"
  32 #include "pariterator.h"
  33 #include "lyxvc.h"
  34 #include "texrow.h"
  35 #include "vc-backend.h"
  36 #include "toc.h"
  37
  38 #include "frontends/Alert.h"
  39
  40 #include "insets/insetbibitem.h"
  41
  42 #include "support/filetools.h"
  43 #include "support/fs_extras.h"
  44 #include "support/lyxlib.h"
  45
  46 #include <iostream>
  47
  48 #include <boost/bind.hpp>
  49 #include <boost/filesystem/operations.hpp>
  50
  51 using namespace std;
  52
  53 using lyx::pit_type;
  54 using lyx::support::bformat;
  55 using lyx::support::libFileSearch;
  56 using lyx::support::makeDisplayPath;
  57 using lyx::support::onlyFilename;
  58 using lyx::support::onlyPath;
  59 using lyx::support::unlink;
  60
  61 using std::min;
  62 using std::string;
  63
  64 namespace fs = boost::filesystem;
  65
  66 extern BufferList bufferlist;
  67
  68 namespace {
  69
  70 bool readFile(Buffer * const b, string const & s)
  71 {
  72         BOOST_ASSERT(b);
  73
  74         // File information about normal file
  75         if (!fs::exists(s)) {
  76                 string const file = makeDisplayPath(s, 50);
  77                 string text = bformat(_("The specified document\n%1$s"
  78                                         "\ncould not be read."), file);
  79                 Alert::error(_("Could not read document"), text);
  80                 return false;
  81         }
  82
  83         // Check if emergency save file exists and is newer.
  84         string const e = onlyPath(s) + onlyFilename(s) + ".emergency";
  85
  86         if (fs::exists(e) && fs::exists(s)
  87             && fs::last_write_time(e) > fs::last_write_time(s))
  88         {
  89                 string const file = makeDisplayPath(s, 20);
  90                 string const text =
  91                         bformat(_("An emergency save of the document "
  92                                   "%1$s exists.\n\n"
  93                                   "Recover emergency save?"), file);
  94                 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
  95                                       _("&Recover"),  _("&Load Original"),
  96                                       _("&Cancel")))
  97                 {
  98                 case 0:
  99                         // the file is not saved if we load the emergency file.
 100                         b->markDirty();
 101                         return b->readFile(e);
 102                 case 1:
 103                         break;
 104                 default:
 105                         return false;
 106                 }
 107         }
 108
 109         // Now check if autosave file is newer.
 110         string const a = onlyPath(s) + '#' + onlyFilename(s) + '#';
 111
 112         if (fs::exists(a) && fs::exists(s)
 113             && fs::last_write_time(a) > fs::last_write_time(s))
 114         {
 115                 string const file = makeDisplayPath(s, 20);
 116                 string const text =
 117                         bformat(_("The backup of the document "
 118                                   "%1$s is newer.\n\nLoad the "
 119                                   "backup instead?"), file);
 120                 switch (Alert::prompt(_("Load backup?"), text, 0, 2,
 121                                       _("&Load backup"), _("Load &original"),
 122                                       _("&Cancel") ))
 123                 {
 124                 case 0:
 125                         // the file is not saved if we load the autosave file.
 126                         b->markDirty();
 127                         return b->readFile(a);
 128                 case 1:
 129                         // Here we delete the autosave
 130                         unlink(a);
 131                         break;
 132                 default:
 133                         return false;
 134                 }
 135         }
 136         return b->readFile(s);
 137 }
 138
 139
 140 } // namespace anon
 141
 142
 143
 144 bool loadLyXFile(Buffer * b, string const & s)
 145 {
 146         BOOST_ASSERT(b);
 147
 148         if (fs::is_readable(s)) {
 149                 if (readFile(b, s)) {
 150                         b->lyxvc().file_found_hook(s);
 151                         if (!fs::is_writable(s))
 152                                 b->setReadonly(true);
 153                         return true;
 154                 }
 155         } else {
 156                 string const file = makeDisplayPath(s, 20);
 157                 // Here we probably should run
 158                 if (LyXVC::file_not_found_hook(s)) {
 159                         string const text =
 160                                 bformat(_("Do you want to retrieve the document"
 161                                           " %1$s from version control?"), file);
 162                         int const ret = Alert::prompt(_("Retrieve from version control?"),
 163                                 text, 0, 1, _("&Retrieve"), _("&Cancel"));
 164
 165                         if (ret == 0) {
 166                                 // How can we know _how_ to do the checkout?
 167                                 // With the current VC support it has to be,
 168                                 // a RCS file since CVS do not have special ,v files.
 169                                 RCS::retrieve(s);
 170                                 return loadLyXFile(b, s);
 171                         }
 172                 }
 173         }
 174         return false;
 175 }
 176
 177
 178 Buffer * newFile(string const & filename, string const & templatename,
 179                  bool const isNamed)
 180 {
 181         // get a free buffer
 182         Buffer * b = bufferlist.newBuffer(filename);
 183         BOOST_ASSERT(b);
 184
 185         string tname;
 186         // use defaults.lyx as a default template if it exists.
 187         if (templatename.empty())
 188                 tname = libFileSearch("templates", "defaults.lyx");
 189         else
 190                 tname = templatename;
 191
 192         if (!tname.empty()) {
 193                 if (!b->readFile(tname)) {
 194                         string const file = makeDisplayPath(tname, 50);
 195                         string const text  = bformat(_("The specified document template\n%1$s\ncould not be read."), file);
 196                         Alert::error(_("Could not read template"), text);
 197                         bufferlist.release(b);
 198                         return 0;
 199                 }
 200         }
 201
 202         if (!isNamed) {
 203                 b->setUnnamed();
 204                 b->setFileName(filename);
 205         }
 206
 207         b->setReadonly(false);
 208         b->fully_loaded(true);
 209         b->updateDocLang(b->params().language);
 210
 211         return b;
 212 }
 213
 214
 215 void bufferErrors(Buffer const & buf, TeXErrors const & terr)
 216 {
 217         TeXErrors::Errors::const_iterator cit = terr.begin();
 218         TeXErrors::Errors::const_iterator end = terr.end();
 219
 220         for (; cit != end; ++cit) {
 221                 int id_start = -1;
 222                 int pos_start = -1;
 223                 int errorrow = cit->error_in_line;
 224                 bool found = buf.texrow().getIdFromRow(errorrow, id_start,
 225                                                        pos_start);
 226                 int id_end = -1;
 227                 int pos_end = -1;
 228                 do {
 229                         ++errorrow;
 230                         found = buf.texrow().getIdFromRow(errorrow, id_end,
 231                                                           pos_end);
 232                 } while (found && id_start == id_end && pos_start == pos_end);
 233
 234                 buf.addError(ErrorItem(cit->error_desc,
 235                         cit->error_text, id_start, pos_start, pos_end));
 236         }
 237 }
 238
 239
 240 void bufferErrors(Buffer const & buf, ErrorList const & el)
 241 {
 242         buf.setErrorList(el);
 243 }
 244
 245
 246 string const bufferFormat(Buffer const & buffer)
 247 {
 248         if (buffer.isLinuxDoc())
 249                 return "linuxdoc";
 250         else if (buffer.isDocBook())
 251                 return "docbook";
 252         else if (buffer.isLiterate())
 253                 return "literate";
 254         else
 255                 return "latex";
 256 }
 257
 258
 259 int countWords(DocIterator const & from, DocIterator const & to)
 260 {
 261         int count = 0;
 262         bool inword = false;
 263         for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
 264                 // Copied and adapted from isLetter() in ControlSpellChecker
 265                 if (dit.inTexted()
 266                     && dit.pos() != dit.lastpos()
 267                     && dit.paragraph().isLetter(dit.pos())
 268                     && !isDeletedText(dit.paragraph(), dit.pos())) {
 269                         if (!inword) {
 270                                 ++count;
 271                                 inword = true;
 272                         }
 273                 } else if (inword)
 274                         inword = false;
 275         }
 276
 277         return count;
 278 }
 279
 280
 281 namespace {
 282
 283 lyx::depth_type getDepth(DocIterator const & it)
 284 {
 285         lyx::depth_type depth = 0;
 286         for (size_t i = 0 ; i < it.depth() ; ++i)
 287                 if (!it[i].inset().inMathed())
 288                         depth += it[i].paragraph().getDepth() + 1;
 289         // remove 1 since the outer inset does not count
 290         return depth - 1;
 291 }
 292
 293 lyx::depth_type getItemDepth(ParIterator const & it)
 294 {
 295         Paragraph const & par = *it;
 296         LYX_LABEL_TYPES const labeltype = par.layout()->labeltype;
 297
 298         if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
 299                 return 0;
 300
 301         // this will hold the lowest depth encountered up to now.
 302         lyx::depth_type min_depth = getDepth(it);
 303         ParIterator prev_it = it;
 304         while (true) {
 305                 if (prev_it.pit())
 306                         --prev_it.top().pit();
 307                 else {
 308                         // start of nested inset: go to outer par
 309                         prev_it.pop_back();
 310                         if (prev_it.empty()) {
 311                                 // start of document: nothing to do
 312                                 return 0;
 313                         }
 314                 }
 315
 316                 // We search for the first paragraph with same label
 317                 // that is not more deeply nested.
 318                 Paragraph & prev_par = *prev_it;
 319                 lyx::depth_type const prev_depth = getDepth(prev_it);
 320                 if (labeltype == prev_par.layout()->labeltype) {
 321                         if (prev_depth < min_depth) {
 322                                 return prev_par.itemdepth + 1;
 323                         }
 324                         else if (prev_depth == min_depth) {
 325                                 return prev_par.itemdepth;
 326                         }
 327                 }
 328                 min_depth = std::min(min_depth, prev_depth);
 329                 // small optimization: if we are at depth 0, we won't
 330                 // find anything else
 331                 if (prev_depth == 0) {
 332                         return 0;
 333                 }
 334         }
 335 }
 336
 337
 338 bool needEnumCounterReset(ParIterator const & it)
 339 {
 340         Paragraph const & par = *it;
 341         BOOST_ASSERT(par.layout()->labeltype == LABEL_ENUMERATE);
 342         lyx::depth_type const cur_depth = par.getDepth();
 343         ParIterator prev_it = it;
 344         while (prev_it.pit()) {
 345                 --prev_it.top().pit();
 346                 Paragraph const & prev_par = *prev_it;
 347                 if (prev_par.getDepth() <= cur_depth)
 348                         return  prev_par.layout()->labeltype != LABEL_ENUMERATE;
 349         }
 350         // start of nested inset: reset
 351         return true;
 352 }
 353
 354
 355 // set the label of a paragraph. This includes the counters.
 356 void setLabel(Buffer const & buf, ParIterator & it)
 357 {
 358         Paragraph & par = *it;
 359         BufferParams const & bufparams = buf.params();
 360         LyXTextClass const & textclass = bufparams.getLyXTextClass();
 361         LyXLayout_ptr const & layout = par.layout();
 362         Counters & counters = textclass.counters();
 363
 364         if (it.pit() == 0) {
 365                 par.params().appendix(par.params().startOfAppendix());
 366         } else {
 367                 par.params().appendix(it.plist()[it.pit() - 1].params().appendix());
 368                 if (!par.params().appendix() &&
 369                     par.params().startOfAppendix()) {
 370                         par.params().appendix(true);
 371                         textclass.counters().reset();
 372                 }
 373         }
 374
 375         // Compute the item depth of the paragraph
 376         par.itemdepth = getItemDepth(it);
 377
 378         // erase what was there before
 379         par.params().labelString(string());
 380
 381         if (layout->margintype == MARGIN_MANUAL) {
 382                 if (par.params().labelWidthString().empty())
 383                         par.setLabelWidthString(layout->labelstring());
 384         } else {
 385                 par.setLabelWidthString(string());
 386         }
 387
 388         // is it a layout that has an automatic label?
 389         if (layout->labeltype == LABEL_COUNTER) {
 390                 if (layout->toclevel <= buf.params().secnumdepth
 391                     && (layout->latextype != LATEX_ENVIRONMENT
 392                         || isFirstInSequence(it.pit(), it.plist()))) {
 393                         counters.step(layout->counter);
 394                         string label = expandLabel(buf, layout,
 395                                                    par.params().appendix());
 396                         par.params().labelString(label);
 397                 }
 398         } else if (layout->labeltype == LABEL_ITEMIZE) {
 399                 // At some point of time we should do something more
 400                 // clever here, like:
 401                 //   par.params().labelString(
 402                 //    bufparams.user_defined_bullet(par.itemdepth).getText());
 403                 // for now, use a simple hardcoded label
 404                 string itemlabel;
 405                 switch (par.itemdepth) {
 406                 case 0:
 407                         itemlabel = "*";
 408                         break;
 409                 case 1:
 410                         itemlabel = "-";
 411                         break;
 412                 case 2:
 413                         itemlabel = "@";
 414                         break;
 415                 case 3:
 416                         itemlabel = "·";
 417                         break;
 418                 }
 419
 420                 par.params().labelString(itemlabel);
 421         } else if (layout->labeltype == LABEL_ENUMERATE) {
 422                 // FIXME
 423                 // Yes I know this is a really, really! bad solution
 424                 // (Lgb)
 425                 string enumcounter = "enum";
 426
 427                 switch (par.itemdepth) {
 428                 case 2:
 429                         enumcounter += 'i';
 430                 case 1:
 431                         enumcounter += 'i';
 432                 case 0:
 433                         enumcounter += 'i';
 434                         break;
 435                 case 3:
 436                         enumcounter += "iv";
 437                         break;
 438                 default:
 439                         // not a valid enumdepth...
 440                         break;
 441                 }
 442
 443                 // Maybe we have to reset the enumeration counter.
 444                 if (needEnumCounterReset(it))
 445                         counters.reset(enumcounter);
 446
 447                 counters.step(enumcounter);
 448
 449                 string format;
 450
 451                 switch (par.itemdepth) {
 452                 case 0:
 453                         format = N_("\\arabic{enumi}.");
 454                         break;
 455                 case 1:
 456                         format = N_("(\\alph{enumii})");
 457                         break;
 458                 case 2:
 459                         format = N_("\\roman{enumiii}.");
 460                         break;
 461                 case 3:
 462                         format = N_("\\Alph{enumiv}.");
 463                         break;
 464                 default:
 465                         // not a valid enumdepth...
 466                         break;
 467                 }
 468
 469                 par.params().labelString(counters.counterLabel(buf.B_(format)));
 470         } else if (layout->labeltype == LABEL_BIBLIO) {// ale970302
 471                 counters.step("bibitem");
 472                 int number = counters.value("bibitem");
 473                 if (par.bibitem())
 474                         par.bibitem()->setCounter(number);
 475                 par.params().labelString(buf.B_(layout->labelstring()));
 476                 // In biblio should't be following counters but...
 477         } else if (layout->labeltype == LABEL_SENSITIVE) {
 478                 // Search for the first float or wrap inset in the iterator
 479                 string type;
 480                 size_t i = it.depth();
 481                 while (i > 0) {
 482                         --i;
 483                         InsetBase * const in = &it[i].inset();
 484                         if (in->lyxCode() == InsetBase::FLOAT_CODE
 485                             || in->lyxCode() == InsetBase::WRAP_CODE) {
 486                                 type = in->getInsetName();
 487                                 break;
 488                         }
 489                 }
 490
 491                 string s;
 492                 if (!type.empty()) {
 493                         Floating const & fl = textclass.floats().getType(type);
 494
 495                         counters.step(fl.type());
 496
 497                         // Doesn't work... yet.
 498                         s = bformat(_("%1$s #:"), buf.B_(fl.name()));
 499                 } else {
 500                         // par->SetLayout(0);
 501                         s = buf.B_(layout->labelstring());
 502                 }
 503
 504                 par.params().labelString(s);
 505         } else if (layout->labeltype == LABEL_NO_LABEL)
 506                 par.params().labelString(string());
 507         else
 508                 par.params().labelString(buf.B_(layout->labelstring()));
 509 }
 510
 511 } // anon namespace
 512
 513
 514 bool updateCurrentLabel(Buffer const & buf,
 515         ParIterator & it)
 516 {
 517     if (it == par_iterator_end(buf.inset()))
 518         return false;
 519
 520 //      if (it.lastpit == 0 && LyXText::isMainText())
 521 //              return false;
 522
 523         switch (it->layout()->labeltype) {
 524
 525         case LABEL_NO_LABEL:
 526         case LABEL_MANUAL:
 527         case LABEL_BIBLIO:
 528         case LABEL_TOP_ENVIRONMENT:
 529         case LABEL_CENTERED_TOP_ENVIRONMENT:
 530         case LABEL_STATIC:
 531         case LABEL_ITEMIZE:
 532                 setLabel(buf, it);
 533                 return true;
 534
 535         case LABEL_SENSITIVE:
 536         case LABEL_COUNTER:
 537         // do more things with enumerate later
 538         case LABEL_ENUMERATE:
 539                 return false;
 540         }
 541
 542         // This is dead code which get rid of a warning:
 543         return true;
 544 }
 545
 546
 547 void updateLabels(Buffer const & buf,
 548         ParIterator & from, ParIterator & to)
 549 {
 550         for (ParIterator it = from; it != to; ++it) {
 551                 if (it.pit() > it.lastpit())
 552                         return;
 553                 if (!updateCurrentLabel (buf, it)) {
 554                         updateLabels(buf);
 555                         return;
 556                 }
 557         }
 558 }
 559
 560
 561 void updateLabels(Buffer const & buf,
 562         ParIterator & iter)
 563 {
 564         if (updateCurrentLabel(buf, iter))
 565                 return;
 566
 567         updateLabels(buf);
 568 }
 569
 570
 571 void updateLabels(Buffer const & buf)
 572 {
 573         // start over the counters
 574         buf.params().getLyXTextClass().counters().reset();
 575
 576         ParIterator const end = par_iterator_end(buf.inset());
 577
 578         for (ParIterator it = par_iterator_begin(buf.inset()); it != end; ++it) {
 579                 // reduce depth if necessary
 580                 if (it.pit()) {
 581                         Paragraph const & prevpar = it.plist()[it.pit() - 1];
 582                         it->params().depth(min(it->params().depth(),
 583                                                prevpar.getMaxDepthAfter()));
 584                 } else
 585                         it->params().depth(0);
 586
 587                 // set the counter for this paragraph
 588                 setLabel(buf, it);
 589         }
 590
 591         lyx::toc::updateToc(buf);
 592 }
 593
 594
 595 string expandLabel(Buffer const & buf,
 596         LyXLayout_ptr const & layout, bool appendix)
 597 {
 598         LyXTextClass const & tclass = buf.params().getLyXTextClass();
 599
 600         string fmt = buf.B_(appendix ? layout->labelstring_appendix()
 601                             : layout->labelstring());
 602
 603         // handle 'inherited level parts' in 'fmt',
 604         // i.e. the stuff between '@' in   '@Section@.\arabic{subsection}'
 605         size_t const i = fmt.find('@', 0);
 606         if (i != string::npos) {
 607                 size_t const j = fmt.find('@', i + 1);
 608                 if (j != string::npos) {
 609                         string parent(fmt, i + 1, j - i - 1);
 610                         string label = expandLabel(buf, tclass[parent], appendix);
 611                         fmt = string(fmt, 0, i) + label + string(fmt, j + 1, string::npos);
 612                 }
 613         }
 614
 615         return tclass.counters().counterLabel(fmt);
 616 }