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