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 "vc-backend.h"
38 #include "frontends/Alert.h"
40 #include "insets/insetbibitem.h"
42 #include "support/filetools.h"
43 #include "support/fs_extras.h"
44 #include "support/lyxlib.h"
48 #include <boost/bind.hpp>
49 #include <boost/filesystem/operations.hpp>
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;
64 namespace fs = boost::filesystem;
66 extern BufferList bufferlist;
70 bool readFile(Buffer * const b, string const & s)
74 // File information about normal file
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);
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 string const file = makeDisplayPath(s, 20);
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 string const file = makeDisplayPath(s, 20);
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 string const file = makeDisplayPath(s, 20);
157 // Here we probably should run
158 if (LyXVC::file_not_found_hook(s)) {
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);
178 Buffer * newFile(string const & filename, string const & templatename,
182 Buffer * b = bufferlist.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 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);
204 b->setFileName(filename);
207 b->setReadonly(false);
208 b->fully_loaded(true);
209 b->updateDocLang(b->params().language);
215 void bufferErrors(Buffer const & buf, TeXErrors const & terr)
217 TeXErrors::Errors::const_iterator cit = terr.begin();
218 TeXErrors::Errors::const_iterator end = terr.end();
220 for (; cit != end; ++cit) {
223 int errorrow = cit->error_in_line;
224 bool found = buf.texrow().getIdFromRow(errorrow, id_start,
230 found = buf.texrow().getIdFromRow(errorrow, id_end,
232 } while (found && id_start == id_end && pos_start == pos_end);
234 buf.addError(ErrorItem(cit->error_desc,
235 cit->error_text, id_start, pos_start, pos_end));
240 void bufferErrors(Buffer const & buf, ErrorList const & el)
242 buf.setErrorList(el);
246 string const bufferFormat(Buffer const & buffer)
248 if (buffer.isLinuxDoc())
250 else if (buffer.isDocBook())
252 else if (buffer.isLiterate())
259 int countWords(DocIterator const & from, DocIterator const & to)
263 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
264 // Copied and adapted from isLetter() in ControlSpellChecker
266 && dit.pos() != dit.lastpos()
267 && dit.paragraph().isLetter(dit.pos())
268 && !isDeletedText(dit.paragraph(), dit.pos())) {
283 lyx::depth_type getDepth(DocIterator const & it)
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
293 lyx::depth_type getItemDepth(ParIterator const & it)
295 Paragraph const & par = *it;
296 LYX_LABEL_TYPES const labeltype = par.layout()->labeltype;
298 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
301 // this will hold the lowest depth encountered up to now.
302 lyx::depth_type min_depth = getDepth(it);
303 ParIterator prev_it = it;
306 --prev_it.top().pit();
308 // start of nested inset: go to outer par
310 if (prev_it.empty()) {
311 // start of document: nothing to do
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;
324 else if (prev_depth == min_depth) {
325 return prev_par.itemdepth;
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) {
338 bool needEnumCounterReset(ParIterator const & it)
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;
350 // start of nested inset: reset
355 // set the label of a paragraph. This includes the counters.
356 void setLabel(Buffer const & buf, ParIterator & it)
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();
365 par.params().appendix(par.params().startOfAppendix());
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();
375 // Compute the item depth of the paragraph
376 par.itemdepth = getItemDepth(it);
378 // erase what was there before
379 par.params().labelString(string());
381 if (layout->margintype == MARGIN_MANUAL) {
382 if (par.params().labelWidthString().empty())
383 par.setLabelWidthString(layout->labelstring());
385 par.setLabelWidthString(string());
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);
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
405 switch (par.itemdepth) {
420 par.params().labelString(itemlabel);
421 } else if (layout->labeltype == LABEL_ENUMERATE) {
423 // Yes I know this is a really, really! bad solution
425 string enumcounter = "enum";
427 switch (par.itemdepth) {
439 // not a valid enumdepth...
443 // Maybe we have to reset the enumeration counter.
444 if (needEnumCounterReset(it))
445 counters.reset(enumcounter);
447 counters.step(enumcounter);
451 switch (par.itemdepth) {
453 format = N_("\\arabic{enumi}.");
456 format = N_("(\\alph{enumii})");
459 format = N_("\\roman{enumiii}.");
462 format = N_("\\Alph{enumiv}.");
465 // not a valid enumdepth...
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");
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
480 size_t i = it.depth();
483 InsetBase * const in = &it[i].inset();
484 if (in->lyxCode() == InsetBase::FLOAT_CODE
485 || in->lyxCode() == InsetBase::WRAP_CODE) {
486 type = in->getInsetName();
493 Floating const & fl = textclass.floats().getType(type);
495 counters.step(fl.type());
497 // Doesn't work... yet.
498 s = bformat(_("%1$s #:"), buf.B_(fl.name()));
500 // par->SetLayout(0);
501 s = buf.B_(layout->labelstring());
504 par.params().labelString(s);
505 } else if (layout->labeltype == LABEL_NO_LABEL)
506 par.params().labelString(string());
508 par.params().labelString(buf.B_(layout->labelstring()));
514 bool updateCurrentLabel(Buffer const & buf,
517 if (it == par_iterator_end(buf.inset()))
520 // if (it.lastpit == 0 && LyXText::isMainText())
523 switch (it->layout()->labeltype) {
528 case LABEL_TOP_ENVIRONMENT:
529 case LABEL_CENTERED_TOP_ENVIRONMENT:
535 case LABEL_SENSITIVE:
537 // do more things with enumerate later
538 case LABEL_ENUMERATE:
542 // This is dead code which get rid of a warning:
547 void updateLabels(Buffer const & buf,
548 ParIterator & from, ParIterator & to)
550 for (ParIterator it = from; it != to; ++it) {
551 if (it.pit() > it.lastpit())
553 if (!updateCurrentLabel (buf, it)) {
561 void updateLabels(Buffer const & buf,
564 if (updateCurrentLabel(buf, iter))
571 void updateLabels(Buffer const & buf)
573 // start over the counters
574 buf.params().getLyXTextClass().counters().reset();
576 ParIterator const end = par_iterator_end(buf.inset());
578 for (ParIterator it = par_iterator_begin(buf.inset()); it != end; ++it) {
579 // reduce depth if necessary
581 Paragraph const & prevpar = it.plist()[it.pit() - 1];
582 it->params().depth(min(it->params().depth(),
583 prevpar.getMaxDepthAfter()));
585 it->params().depth(0);
587 // set the counter for this paragraph
591 lyx::toc::updateToc(buf);
595 string expandLabel(Buffer const & buf,
596 LyXLayout_ptr const & layout, bool appendix)
598 LyXTextClass const & tclass = buf.params().getLyXTextClass();
600 string fmt = buf.B_(appendix ? layout->labelstring_appendix()
601 : layout->labelstring());
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);
615 return tclass.counters().counterLabel(fmt);