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"
37 #include "frontends/Alert.h"
39 #include "insets/insetbibitem.h"
41 #include "support/filetools.h"
42 #include "support/fs_extras.h"
43 #include "support/lyxlib.h"
45 #include <boost/bind.hpp>
46 #include <boost/filesystem/operations.hpp>
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;
59 namespace fs = boost::filesystem;
61 extern BufferList bufferlist;
65 bool readFile(Buffer * const b, string const & s)
69 // File information about normal file
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);
78 // Check if emergency save file exists and is newer.
79 string const e = onlyPath(s) + onlyFilename(s) + ".emergency";
81 if (fs::exists(e) && fs::exists(s)
82 && fs::last_write_time(e) > fs::last_write_time(s))
84 string const file = makeDisplayPath(s, 20);
86 bformat(_("An emergency save of the document "
88 "Recover emergency save?"), file);
89 switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
90 _("&Recover"), _("&Load Original"),
94 // the file is not saved if we load the emergency file.
96 return b->readFile(e);
104 // Now check if autosave file is newer.
105 string const a = onlyPath(s) + '#' + onlyFilename(s) + '#';
107 if (fs::exists(a) && fs::exists(s)
108 && fs::last_write_time(a) > fs::last_write_time(s))
110 string const file = makeDisplayPath(s, 20);
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"),
120 // the file is not saved if we load the autosave file.
122 return b->readFile(a);
124 // Here we delete the autosave
131 return b->readFile(s);
139 bool loadLyXFile(Buffer * b, string const & s)
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);
151 string const file = makeDisplayPath(s, 20);
152 // Here we probably should run
153 if (LyXVC::file_not_found_hook(s)) {
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"));
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.
165 return loadLyXFile(b, s);
173 Buffer * newFile(string const & filename, string const & templatename,
177 Buffer * b = bufferlist.newBuffer(filename);
181 // use defaults.lyx as a default template if it exists.
182 if (templatename.empty())
183 tname = libFileSearch("templates", "defaults.lyx");
185 tname = templatename;
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
198 b->setFileName(filename);
201 b->setReadonly(false);
202 b->fully_loaded(true);
203 b->updateDocLang(b->params().language);
209 void bufferErrors(Buffer const & buf, TeXErrors const & terr)
211 TeXErrors::Errors::const_iterator cit = terr.begin();
212 TeXErrors::Errors::const_iterator end = terr.end();
214 for (; cit != end; ++cit) {
217 int errorrow = cit->error_in_line;
218 bool found = buf.texrow().getIdFromRow(errorrow, id_start,
224 found = buf.texrow().getIdFromRow(errorrow, id_end,
226 } while (found && id_start == id_end && pos_start == pos_end);
228 buf.error(ErrorItem(cit->error_desc, cit->error_text,
229 id_start, pos_start, pos_end));
234 void bufferErrors(Buffer const & buf, ErrorList const & el)
236 for_each(el.begin(), el.end(), bind(ref(buf.error), _1));
240 string const bufferFormat(Buffer const & buffer)
242 if (buffer.isLinuxDoc())
244 else if (buffer.isDocBook())
246 else if (buffer.isLiterate())
253 int countWords(DocIterator const & from, DocIterator const & to)
257 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
258 // Copied and adapted from isLetter() in ControlSpellChecker
260 && dit.pos() != dit.lastpos()
261 && dit.paragraph().isLetter(dit.pos())
262 && !isDeletedText(dit.paragraph(), dit.pos())) {
277 lyx::depth_type getDepth(DocIterator const & it)
279 lyx::depth_type depth = 0;
280 for (size_t i = 0 ; i < it.depth() ; ++i)
281 if (!it[i].inset().inMathed())
282 depth += it[i].paragraph().getDepth() + 1;
283 // remove 1 since the outer inset does not count
287 lyx::depth_type getItemDepth(ParIterator const & it)
289 Paragraph const & par = *it;
290 LYX_LABEL_TYPES const labeltype = par.layout()->labeltype;
292 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
295 // this will hold the lowest depth encountered up to now.
296 lyx::depth_type min_depth = getDepth(it);
297 ParIterator prev_it = it;
300 --prev_it.top().pit();
302 // start of nested inset: go to outer par
304 if (prev_it.empty()) {
305 // start of document: nothing to do
310 // We search for the first paragraph with same label
311 // that is not more deeply nested.
312 Paragraph & prev_par = *prev_it;
313 lyx::depth_type const prev_depth = getDepth(prev_it);
314 if (labeltype == prev_par.layout()->labeltype) {
315 if (prev_depth < min_depth) {
316 return prev_par.itemdepth + 1;
318 else if (prev_depth == min_depth) {
319 return prev_par.itemdepth;
322 min_depth = std::min(min_depth, prev_depth);
323 // small optimization: if we are at depth 0, we won't
324 // find anything else
325 if (prev_depth == 0) {
332 bool needEnumCounterReset(ParIterator const & it)
334 Paragraph const & par = *it;
335 BOOST_ASSERT(par.layout()->labeltype == LABEL_ENUMERATE);
336 lyx::depth_type const cur_depth = par.getDepth();
337 ParIterator prev_it = it;
338 while (prev_it.pit()) {
339 --prev_it.top().pit();
340 Paragraph const & prev_par = *prev_it;
341 if (prev_par.getDepth() <= cur_depth)
342 return prev_par.layout()->labeltype != LABEL_ENUMERATE;
344 // start of nested inset: reset
349 // set the counter of a paragraph. This includes the labels
350 void setCounter(Buffer const & buf, ParIterator & it)
352 Paragraph & par = *it;
353 BufferParams const & bufparams = buf.params();
354 LyXTextClass const & textclass = bufparams.getLyXTextClass();
355 LyXLayout_ptr const & layout = par.layout();
356 Counters & counters = textclass.counters();
359 par.params().appendix(par.params().startOfAppendix());
361 par.params().appendix(it.plist()[it.pit() - 1].params().appendix());
362 if (!par.params().appendix() &&
363 par.params().startOfAppendix()) {
364 par.params().appendix(true);
365 textclass.counters().reset();
369 // Compute the item depth of the paragraph
370 par.itemdepth = getItemDepth(it);
372 // erase what was there before
373 par.params().labelString(string());
375 if (layout->margintype == MARGIN_MANUAL) {
376 if (par.params().labelWidthString().empty())
377 par.setLabelWidthString(layout->labelstring());
379 par.setLabelWidthString(string());
382 // is it a layout that has an automatic label?
383 if (layout->labeltype == LABEL_COUNTER) {
384 if (layout->toclevel <= buf.params().secnumdepth
385 && (layout->latextype != LATEX_ENVIRONMENT
386 || isFirstInSequence(it.pit(), it.plist()))) {
387 counters.step(layout->counter);
388 string label = expandLabel(buf, layout,
389 par.params().appendix());
390 par.params().labelString(label);
392 } else if (layout->labeltype == LABEL_ITEMIZE) {
393 // At some point of time we should do something more
394 // clever here, like:
395 // par.params().labelString(
396 // bufparams.user_defined_bullet(par.itemdepth).getText());
397 // for now, use a simple hardcoded label
399 switch (par.itemdepth) {
414 par.params().labelString(itemlabel);
415 } else if (layout->labeltype == LABEL_ENUMERATE) {
417 // Yes I know this is a really, really! bad solution
419 string enumcounter = "enum";
421 switch (par.itemdepth) {
433 // not a valid enumdepth...
437 // Maybe we have to reset the enumeration counter.
438 if (needEnumCounterReset(it))
439 counters.reset(enumcounter);
441 counters.step(enumcounter);
445 switch (par.itemdepth) {
447 format = N_("\\arabic{enumi}.");
450 format = N_("(\\alph{enumii})");
453 format = N_("\\roman{enumiii}.");
456 format = N_("\\Alph{enumiv}.");
459 // not a valid enumdepth...
463 par.params().labelString(counters.counterLabel(buf.B_(format)));
464 } else if (layout->labeltype == LABEL_BIBLIO) {// ale970302
465 counters.step("bibitem");
466 int number = counters.value("bibitem");
468 par.bibitem()->setCounter(number);
469 par.params().labelString(buf.B_(layout->labelstring()));
470 // In biblio should't be following counters but...
471 } else if (layout->labeltype == LABEL_SENSITIVE) {
472 // Search for the first float or wrap inset in the iterator
474 size_t i = it.depth();
477 InsetBase * const in = &it[i].inset();
478 if (in->lyxCode() == InsetBase::FLOAT_CODE
479 || in->lyxCode() == InsetBase::WRAP_CODE) {
480 type = in->getInsetName();
487 Floating const & fl = textclass.floats().getType(type);
489 counters.step(fl.type());
491 // Doesn't work... yet.
492 s = bformat(_("%1$s #:"), buf.B_(fl.name()));
494 // par->SetLayout(0);
495 s = buf.B_(layout->labelstring());
498 par.params().labelString(s);
499 } else if (layout->labeltype == LABEL_NO_LABEL)
500 par.params().labelString(string());
502 par.params().labelString(buf.B_(layout->labelstring()));
508 bool needsUpdateCounters(Buffer const & buf, ParIterator & it)
510 switch (it->layout()->labeltype) {
515 case LABEL_TOP_ENVIRONMENT:
516 case LABEL_CENTERED_TOP_ENVIRONMENT:
522 case LABEL_SENSITIVE:
524 // do more things with enumerate later
525 case LABEL_ENUMERATE:
531 void updateCounters(Buffer const & buf)
534 buf.params().getLyXTextClass().counters().reset();
536 for (ParIterator it = par_iterator_begin(buf.inset()); it; ++it) {
537 // reduce depth if necessary
539 Paragraph const & prevpar = it.plist()[it.pit() - 1];
540 it->params().depth(min(it->params().depth(),
541 prevpar.getMaxDepthAfter()));
543 it->params().depth(0);
545 // set the counter for this paragraph
551 string expandLabel(Buffer const & buf,
552 LyXLayout_ptr const & layout, bool appendix)
554 LyXTextClass const & tclass = buf.params().getLyXTextClass();
556 string fmt = buf.B_(appendix ? layout->labelstring_appendix()
557 : layout->labelstring());
559 // handle 'inherited level parts' in 'fmt',
560 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
561 size_t const i = fmt.find('@', 0);
562 if (i != string::npos) {
563 size_t const j = fmt.find('@', i + 1);
564 if (j != string::npos) {
565 string parent(fmt, i + 1, j - i - 1);
566 string label = expandLabel(buf, tclass[parent], appendix);
567 fmt = string(fmt, 0, i) + label + string(fmt, j + 1, string::npos);
571 return tclass.counters().counterLabel(fmt);