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
  17 #include "buffer.h"
  18 #include "bufferlist.h"
  19 #include "bufferparams.h"
  20 #include "dociterator.h"
  21 #include "counters.h"
  22 #include "errorlist.h"
  23 #include "Floating.h"
  24 #include "FloatList.h"
  25 #include "gettext.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 par_id = -1;
 216                 int posstart = -1;
 217                 int const errorrow = cit->error_in_line;
 218                 buf.texrow().getIdFromRow(errorrow, par_id, posstart);
 219                 int posend = -1;
 220                 buf.texrow().getIdFromRow(errorrow + 1, par_id, posend);
 221                 buf.error(ErrorItem(cit->error_desc,
 222                                          cit->error_text,
 223                                          par_id, posstart, posend));
 224         }
 225 }
 226
 227
 228 void bufferErrors(Buffer const & buf, ErrorList const & el)
 229 {
 230         for_each(el.begin(), el.end(), bind(ref(buf.error), _1));
 231 }
 232
 233
 234 string const BufferFormat(Buffer const & buffer)
 235 {
 236         if (buffer.isLinuxDoc())
 237                 return "linuxdoc";
 238         else if (buffer.isDocBook())
 239                 return "docbook";
 240         else if (buffer.isLiterate())
 241                 return "literate";
 242         else
 243                 return "latex";
 244 }
 245
 246
 247 int countWords(DocIterator const & from, DocIterator const & to)
 248 {
 249         int count = 0;
 250         bool inword = false;
 251         for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
 252                 // Copied and adapted from isLetter() in ControlSpellChecker
 253                 if (dit.inTexted()
 254                     && dit.pos() != dit.lastpos()
 255                     && dit.paragraph().isLetter(dit.pos())
 256                     && !isDeletedText(dit.paragraph(), dit.pos())) {
 257                         if (!inword) {
 258                                 ++count;
 259                                 inword = true;
 260                         }
 261                 } else if (inword)
 262                         inword = false;
 263         }
 264
 265         return count;
 266 }
 267
 268
 269 namespace {
 270
 271 void incrementItemDepth(ParagraphList & pars, pit_type pit, pit_type first_pit)
 272 {
 273         int const cur_labeltype = pars[pit].layout()->labeltype;
 274
 275         if (cur_labeltype != LABEL_ENUMERATE && cur_labeltype != LABEL_ITEMIZE)
 276                 return;
 277
 278         int const cur_depth = pars[pit].getDepth();
 279
 280         pit_type prev_pit = pit - 1;
 281         while (true) {
 282                 int const prev_depth = pars[prev_pit].getDepth();
 283                 int const prev_labeltype = pars[prev_pit].layout()->labeltype;
 284                 if (prev_depth == 0 && cur_depth > 0) {
 285                         if (prev_labeltype == cur_labeltype) {
 286                                 pars[pit].itemdepth = pars[prev_pit].itemdepth + 1;
 287                         }
 288                         break;
 289                 } else if (prev_depth < cur_depth) {
 290                         if (prev_labeltype == cur_labeltype) {
 291                                 pars[pit].itemdepth = pars[prev_pit].itemdepth + 1;
 292                                 break;
 293                         }
 294                 } else if (prev_depth == cur_depth) {
 295                         if (prev_labeltype == cur_labeltype) {
 296                                 pars[pit].itemdepth = pars[prev_pit].itemdepth;
 297                                 break;
 298                         }
 299                 }
 300                 if (prev_pit == first_pit)
 301                         break;
 302
 303                 --prev_pit;
 304         }
 305 }
 306
 307
 308 void resetEnumCounterIfNeeded(ParagraphList & pars, pit_type pit,
 309         pit_type firstpit, Counters & counters)
 310 {
 311         if (pit == firstpit)
 312                 return;
 313
 314         int const cur_depth = pars[pit].getDepth();
 315         pit_type prev_pit = pit - 1;
 316         while (true) {
 317                 int const prev_depth = pars[prev_pit].getDepth();
 318                 int const prev_labeltype = pars[prev_pit].layout()->labeltype;
 319                 if (prev_depth <= cur_depth) {
 320                         if (prev_labeltype != LABEL_ENUMERATE) {
 321                                 switch (pars[pit].itemdepth) {
 322                                 case 0:
 323                                         counters.reset("enumi");
 324                                 case 1:
 325                                         counters.reset("enumii");
 326                                 case 2:
 327                                         counters.reset("enumiii");
 328                                 case 3:
 329                                         counters.reset("enumiv");
 330                                 }
 331                         }
 332                         break;
 333                 }
 334
 335                 if (prev_pit == firstpit)
 336                         break;
 337
 338                 --prev_pit;
 339         }
 340 }
 341
 342
 343 // set the counter of a paragraph. This includes the labels
 344 void setCounter(Buffer const & buf, ParIterator & it)
 345 {
 346         Paragraph & par = *it;
 347         BufferParams const & bufparams = buf.params();
 348         LyXTextClass const & textclass = bufparams.getLyXTextClass();
 349         LyXLayout_ptr const & layout = par.layout();
 350         Counters & counters = textclass.counters();
 351
 352         // Always reset
 353         par.itemdepth = 0;
 354
 355         if (it.pit() == 0) {
 356                 par.params().appendix(par.params().startOfAppendix());
 357         } else {
 358                 par.params().appendix(it.plist()[it.pit() - 1].params().appendix());
 359                 if (!par.params().appendix() &&
 360                     par.params().startOfAppendix()) {
 361                         par.params().appendix(true);
 362                         textclass.counters().reset();
 363                 }
 364
 365                 // Maybe we have to increment the item depth.
 366                 incrementItemDepth(it.plist(), it.pit(), 0);
 367         }
 368
 369         // erase what was there before
 370         par.params().labelString(string());
 371
 372         if (layout->margintype == MARGIN_MANUAL) {
 373                 if (par.params().labelWidthString().empty())
 374                         par.setLabelWidthString(layout->labelstring());
 375         } else {
 376                 par.setLabelWidthString(string());
 377         }
 378
 379         // is it a layout that has an automatic label?
 380         if (layout->labeltype == LABEL_COUNTER) {
 381                 if (layout->toclevel <= buf.params().secnumdepth
 382                     && (!layout->isEnvironment()
 383                         || isFirstInSequence(it.pit(), it.plist()))) {
 384                         counters.step(layout->counter);
 385                         string label = expandLabel(textclass, layout,
 386                                                    par.params().appendix());
 387                         par.params().labelString(label);
 388                 }
 389         } else if (layout->labeltype == LABEL_ITEMIZE) {
 390                 // At some point of time we should do something more
 391                 // clever here, like:
 392                 //   par.params().labelString(
 393                 //    bufparams.user_defined_bullet(par.itemdepth).getText());
 394                 // for now, use a simple hardcoded label
 395                 string itemlabel;
 396                 switch (par.itemdepth) {
 397                 case 0:
 398                         itemlabel = "*";
 399                         break;
 400                 case 1:
 401                         itemlabel = "-";
 402                         break;
 403                 case 2:
 404                         itemlabel = "@";
 405                         break;
 406                 case 3:
 407                         itemlabel = "·";
 408                         break;
 409                 }
 410
 411                 par.params().labelString(itemlabel);
 412         } else if (layout->labeltype == LABEL_ENUMERATE) {
 413                 // Maybe we have to reset the enumeration counter.
 414                 resetEnumCounterIfNeeded(it.plist(), it.pit(), 0, counters);
 415
 416                 // FIXME
 417                 // Yes I know this is a really, really! bad solution
 418                 // (Lgb)
 419                 string enumcounter = "enum";
 420
 421                 switch (par.itemdepth) {
 422                 case 2:
 423                         enumcounter += 'i';
 424                 case 1:
 425                         enumcounter += 'i';
 426                 case 0:
 427                         enumcounter += 'i';
 428                         break;
 429                 case 3:
 430                         enumcounter += "iv";
 431                         break;
 432                 default:
 433                         // not a valid enumdepth...
 434                         break;
 435                 }
 436
 437                 counters.step(enumcounter);
 438
 439                 par.params().labelString(counters.enumLabel(enumcounter));
 440         } else if (layout->labeltype == LABEL_BIBLIO) {// ale970302
 441                 counters.step("bibitem");
 442                 int number = counters.value("bibitem");
 443                 if (par.bibitem()) {
 444                         par.bibitem()->setCounter(number);
 445                         par.params().labelString(layout->labelstring());
 446                 }
 447                 // In biblio should't be following counters but...
 448         } else if (layout->labeltype == LABEL_SENSITIVE) {
 449                 // Search for the first float or wrap inset in the iterator
 450                 string type;
 451                 size_t i = it.depth();
 452                 while (i > 0) {
 453                         --i;
 454                         InsetBase * const in = &it[i].inset();
 455                         if (in->lyxCode() == InsetBase::FLOAT_CODE
 456                             || in->lyxCode() == InsetBase::WRAP_CODE)
 457                                 type = in->getInsetName();
 458                                 break;
 459                 }
 460
 461                 string s;
 462                 if (!type.empty()) {
 463                         Floating const & fl = textclass.floats().getType(type);
 464
 465                         counters.step(fl.type());
 466
 467                         // Doesn't work... yet.
 468                         s = bformat(_("%1$s #:"), buf.B_(fl.name()));
 469                 } else {
 470                         // par->SetLayout(0);
 471                         s = buf.B_(layout->labelstring());
 472                 }
 473
 474                 par.params().labelString(s);
 475         } else
 476                 par.params().labelString(buf.B_(layout->labelstring()));
 477 }
 478
 479 } // anon namespace
 480
 481
 482 void updateCounters(Buffer const & buf)
 483 {
 484         // start over
 485         buf.params().getLyXTextClass().counters().reset();
 486
 487         for (ParIterator it = par_iterator_begin(buf.inset()); it; ++it) {
 488                 // reduce depth if necessary
 489                 if (it.pit()) {
 490                         Paragraph const & prevpar = it.plist()[it.pit() - 1];
 491                         it->params().depth(min(it->params().depth(),
 492                                                prevpar.getMaxDepthAfter()));
 493                 } else
 494                         it->params().depth(0);
 495
 496                 // set the counter for this paragraph
 497                 setCounter(buf, it);
 498         }
 499 }
 500
 501
 502 string expandLabel(LyXTextClass const & textclass,
 503         LyXLayout_ptr const & layout, bool appendix)
 504 {
 505         string fmt = appendix ?
 506                 layout->labelstring_appendix() : layout->labelstring();
 507
 508         // handle 'inherited level parts' in 'fmt',
 509         // i.e. the stuff between '@' in   '@Section@.\arabic{subsection}'
 510         size_t const i = fmt.find('@', 0);
 511         if (i != string::npos) {
 512                 size_t const j = fmt.find('@', i + 1);
 513                 if (j != string::npos) {
 514                         string parent(fmt, i + 1, j - i - 1);
 515                         string label = expandLabel(textclass, textclass[parent], appendix);
 516                         fmt = string(fmt, 0, i) + label + string(fmt, j + 1, string::npos);
 517                 }
 518         }
 519
 520         return textclass.counters().counterLabel(fmt);
 521 }
 522
 523