3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Alfredo Braunstein
9 * Full author contact details are available in file CREDITS.
15 #include "buffer_funcs.h"
17 #include "bufferlist.h"
18 #include "bufferparams.h"
19 #include "dociterator.h"
21 #include "errorlist.h"
23 #include "FloatList.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"
35 #include "TocBackend.h"
36 #include "vc-backend.h"
38 #include "frontends/Alert.h"
40 #include "insets/insetbibitem.h"
41 #include "insets/insetinclude.h"
43 #include "support/filetools.h"
44 #include "support/fs_extras.h"
45 #include "support/lyxlib.h"
47 #include <boost/bind.hpp>
48 #include <boost/filesystem/operations.hpp>
55 using support::bformat;
56 using support::libFileSearch;
57 using support::makeDisplayPath;
58 using support::onlyFilename;
59 using support::onlyPath;
60 using support::unlink;
65 namespace Alert = frontend::Alert;
66 namespace fs = boost::filesystem;
70 bool readFile(Buffer * const b, string const & s)
74 // File information about normal file
76 docstring const file = makeDisplayPath(s, 50);
77 docstring text = bformat(_("The specified document\n%1$s"
78 "\ncould not be read."), file);
79 Alert::error(_("Could not read document"), text);
83 // Check if emergency save file exists and is newer.
84 string const e = onlyPath(s) + onlyFilename(s) + ".emergency";
86 if (fs::exists(e) && fs::exists(s)
87 && fs::last_write_time(e) > fs::last_write_time(s))
89 docstring const file = makeDisplayPath(s, 20);
90 docstring const text =
91 bformat(_("An emergency save of the document "
93 "Recover emergency save?"), file);
94 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
95 _("&Recover"), _("&Load Original"),
99 // the file is not saved if we load the emergency file.
101 return b->readFile(e);
109 // Now check if autosave file is newer.
110 string const a = onlyPath(s) + '#' + onlyFilename(s) + '#';
112 if (fs::exists(a) && fs::exists(s)
113 && fs::last_write_time(a) > fs::last_write_time(s))
115 docstring const file = makeDisplayPath(s, 20);
116 docstring 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"),
125 // the file is not saved if we load the autosave file.
127 return b->readFile(a);
129 // Here we delete the autosave
136 return b->readFile(s);
144 bool loadLyXFile(Buffer * b, string const & s)
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);
156 docstring const file = makeDisplayPath(s, 20);
157 // Here we probably should run
158 if (LyXVC::file_not_found_hook(s)) {
159 docstring 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"));
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.
170 return loadLyXFile(b, s);
177 // FIXME newFile() should probably be a member method of Application...
178 Buffer * newFile(string const & filename, string const & templatename,
182 Buffer * b = theBufferList().newBuffer(filename);
186 // use defaults.lyx as a default template if it exists.
187 if (templatename.empty())
188 tname = libFileSearch("templates", "defaults.lyx");
190 tname = templatename;
192 if (!tname.empty()) {
193 if (!b->readFile(tname)) {
194 docstring const file = makeDisplayPath(tname, 50);
195 docstring const text = bformat(
196 _("The specified document template\n%1$s\ncould not be read."),
198 Alert::error(_("Could not read template"), text);
199 theBufferList().release(b);
206 b->setFileName(filename);
209 b->setReadonly(false);
210 b->fully_loaded(true);
211 b->updateDocLang(b->params().language);
217 void bufferErrors(Buffer const & buf, TeXErrors const & terr,
218 ErrorList & errorList)
220 TeXErrors::Errors::const_iterator cit = terr.begin();
221 TeXErrors::Errors::const_iterator end = terr.end();
223 for (; cit != end; ++cit) {
226 int errorrow = cit->error_in_line;
227 bool found = buf.texrow().getIdFromRow(errorrow, id_start,
233 found = buf.texrow().getIdFromRow(errorrow, id_end,
235 } while (found && id_start == id_end && pos_start == pos_end);
237 errorList.push_back(ErrorItem(cit->error_desc,
238 cit->error_text, id_start, pos_start, pos_end));
243 string const bufferFormat(Buffer const & buffer)
245 if (buffer.isDocBook())
247 else if (buffer.isLiterate())
254 int countWords(DocIterator const & from, DocIterator const & to)
258 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
259 // Copied and adapted from isLetter() in ControlSpellChecker
261 && dit.pos() != dit.lastpos()
262 && dit.paragraph().isLetter(dit.pos())
263 && !dit.paragraph().isDeleted(dit.pos())) {
278 depth_type getDepth(DocIterator const & it)
280 depth_type depth = 0;
281 for (size_t i = 0 ; i < it.depth() ; ++i)
282 if (!it[i].inset().inMathed())
283 depth += it[i].paragraph().getDepth() + 1;
284 // remove 1 since the outer inset does not count
288 depth_type getItemDepth(ParIterator const & it)
290 Paragraph const & par = *it;
291 LYX_LABEL_TYPES const labeltype = par.layout()->labeltype;
293 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
296 // this will hold the lowest depth encountered up to now.
297 depth_type min_depth = getDepth(it);
298 ParIterator prev_it = it;
301 --prev_it.top().pit();
303 // start of nested inset: go to outer par
305 if (prev_it.empty()) {
306 // start of document: nothing to do
311 // We search for the first paragraph with same label
312 // that is not more deeply nested.
313 Paragraph & prev_par = *prev_it;
314 depth_type const prev_depth = getDepth(prev_it);
315 if (labeltype == prev_par.layout()->labeltype) {
316 if (prev_depth < min_depth) {
317 return prev_par.itemdepth + 1;
319 else if (prev_depth == min_depth) {
320 return prev_par.itemdepth;
323 min_depth = std::min(min_depth, prev_depth);
324 // small optimization: if we are at depth 0, we won't
325 // find anything else
326 if (prev_depth == 0) {
333 bool needEnumCounterReset(ParIterator const & it)
335 Paragraph const & par = *it;
336 BOOST_ASSERT(par.layout()->labeltype == LABEL_ENUMERATE);
337 depth_type const cur_depth = par.getDepth();
338 ParIterator prev_it = it;
339 while (prev_it.pit()) {
340 --prev_it.top().pit();
341 Paragraph const & prev_par = *prev_it;
342 if (prev_par.getDepth() <= cur_depth)
343 return prev_par.layout()->labeltype != LABEL_ENUMERATE;
345 // start of nested inset: reset
350 // set the label of a paragraph. This includes the counters.
351 void setLabel(Buffer const & buf, ParIterator & it, LyXTextClass const & textclass)
353 Paragraph & par = *it;
354 LyXLayout_ptr const & layout = par.layout();
355 Counters & counters = textclass.counters();
358 par.params().appendix(par.params().startOfAppendix());
360 par.params().appendix(it.plist()[it.pit() - 1].params().appendix());
361 if (!par.params().appendix() &&
362 par.params().startOfAppendix()) {
363 par.params().appendix(true);
364 textclass.counters().reset();
368 // Compute the item depth of the paragraph
369 par.itemdepth = getItemDepth(it);
371 // erase what was there before
372 par.params().labelString(docstring());
374 if (layout->margintype == MARGIN_MANUAL) {
375 if (par.params().labelWidthString().empty())
376 par.setLabelWidthString(buf.translateLabel(layout->labelstring()));
378 par.setLabelWidthString(docstring());
381 // is it a layout that has an automatic label?
382 if (layout->labeltype == LABEL_COUNTER) {
383 if (layout->toclevel <= buf.params().secnumdepth
384 && (layout->latextype != LATEX_ENVIRONMENT
385 || isFirstInSequence(it.pit(), it.plist()))) {
386 counters.step(layout->counter);
387 docstring label = expandLabel(buf, layout,
388 par.params().appendix());
389 par.params().labelString(label);
391 } else if (layout->labeltype == LABEL_ITEMIZE) {
392 // At some point of time we should do something more
393 // clever here, like:
394 // par.params().labelString(
395 // buf.params().user_defined_bullet(par.itemdepth).getText());
396 // for now, use a simple hardcoded label
398 switch (par.itemdepth) {
400 itemlabel = char_type(0x2022);
403 itemlabel = char_type(0x2013);
406 itemlabel = char_type(0x2217);
409 itemlabel += char_type(0x2219); // or 0x00b7
413 par.params().labelString(itemlabel);
414 } else if (layout->labeltype == LABEL_ENUMERATE) {
416 // Yes I know this is a really, really! bad solution
418 docstring enumcounter = from_ascii("enum");
420 switch (par.itemdepth) {
432 // not a valid enumdepth...
436 // Maybe we have to reset the enumeration counter.
437 if (needEnumCounterReset(it))
438 counters.reset(enumcounter);
440 counters.step(enumcounter);
444 switch (par.itemdepth) {
446 format = N_("\\arabic{enumi}.");
449 format = N_("(\\alph{enumii})");
452 format = N_("\\roman{enumiii}.");
455 format = N_("\\Alph{enumiv}.");
458 // not a valid enumdepth...
462 par.params().labelString(counters.counterLabel(buf.B_(format)));
463 } else if (layout->labeltype == LABEL_BIBLIO) {// ale970302
464 counters.step(from_ascii("bibitem"));
465 int number = counters.value(from_ascii("bibitem"));
467 par.bibitem()->setCounter(number);
468 par.params().labelString(buf.translateLabel(layout->labelstring()));
469 // In biblio should't be following counters but...
470 } else if (layout->labeltype == LABEL_SENSITIVE) {
471 // Search for the first float or wrap inset in the iterator
473 size_t i = it.depth();
476 InsetBase * const in = &it[i].inset();
477 if (in->lyxCode() == InsetBase::FLOAT_CODE
478 || in->lyxCode() == InsetBase::WRAP_CODE) {
479 type = in->getInsetName();
486 Floating const & fl = textclass.floats().getType(to_ascii(type));
488 counters.step(from_ascii(fl.type()));
490 // Doesn't work... yet.
491 s = bformat(_("%1$s #:"), buf.B_(fl.name()));
493 // par->SetLayout(0);
494 s = buf.translateLabel(layout->labelstring());
497 par.params().labelString(s);
498 } else if (layout->labeltype == LABEL_NO_LABEL)
499 par.params().labelString(docstring());
501 par.params().labelString(buf.translateLabel(layout->labelstring()));
507 bool updateCurrentLabel(Buffer const & buf,
510 if (it == par_iterator_end(buf.inset()))
513 // if (it.lastpit == 0 && LyXText::isMainText(buf))
516 switch (it->layout()->labeltype) {
521 case LABEL_TOP_ENVIRONMENT:
522 case LABEL_CENTERED_TOP_ENVIRONMENT:
525 setLabel(buf, it, buf.params().getLyXTextClass());
528 case LABEL_SENSITIVE:
530 // do more things with enumerate later
531 case LABEL_ENUMERATE:
535 // This is dead code which get rid of a warning:
540 void updateLabels(Buffer const & buf,
541 ParIterator & from, ParIterator & to, bool childonly)
543 for (ParIterator it = from; it != to; ++it) {
544 if (it.pit() > it.lastpit())
546 if (!updateCurrentLabel (buf, it)) {
547 updateLabels(buf, childonly);
554 void updateLabels(Buffer const & buf, ParIterator & iter, bool childonly)
556 if (updateCurrentLabel(buf, iter))
559 updateLabels(buf, childonly);
563 void updateLabels(Buffer const & buf, bool childonly)
565 // Use the master text class also for child documents
566 LyXTextClass const & textclass = buf.params().getLyXTextClass();
569 // If this is a child document start with the master
570 Buffer const * const master = buf.getMasterBuffer();
571 if (master != &buf) {
572 updateLabels(*master);
576 // start over the counters
577 textclass.counters().reset();
580 ParIterator const end = par_iterator_end(buf.inset());
582 for (ParIterator it = par_iterator_begin(buf.inset()); it != end; ++it) {
583 // reduce depth if necessary
585 Paragraph const & prevpar = it.plist()[it.pit() - 1];
586 it->params().depth(min(it->params().depth(),
587 prevpar.getMaxDepthAfter()));
589 it->params().depth(0);
591 // set the counter for this paragraph
592 setLabel(buf, it, textclass);
595 InsetList::const_iterator iit = it->insetlist.begin();
596 InsetList::const_iterator end = it->insetlist.end();
597 for (; iit != end; ++iit) {
598 if (iit->inset->lyxCode() == InsetBase::INCLUDE_CODE)
599 static_cast<InsetInclude const *>(iit->inset)
604 const_cast<Buffer &>(buf).tocBackend().update();
608 docstring expandLabel(Buffer const & buf,
609 LyXLayout_ptr const & layout, bool appendix)
611 LyXTextClass const & tclass = buf.params().getLyXTextClass();
613 docstring fmt = buf.translateLabel(appendix ?
614 layout->labelstring_appendix() :
615 layout->labelstring());
617 // handle 'inherited level parts' in 'fmt',
618 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
619 size_t const i = fmt.find('@', 0);
620 if (i != docstring::npos) {
621 size_t const j = fmt.find('@', i + 1);
622 if (j != docstring::npos) {
623 docstring parent(fmt, i + 1, j - i - 1);
625 docstring label = expandLabel(buf, tclass[to_utf8(parent)], appendix);
626 fmt = docstring(fmt, 0, i) + label + docstring(fmt, j + 1, docstring::npos);
630 return tclass.counters().counterLabel(fmt);