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"
18 #include "bufferlist.h"
19 #include "bufferparams.h"
20 #include "dociterator.h"
22 #include "errorlist.h"
24 #include "FloatList.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"
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 const errorrow = cit->error_in_line;
218 buf.texrow().getIdFromRow(errorrow, par_id, posstart);
220 buf.texrow().getIdFromRow(errorrow + 1, par_id, posend);
221 buf.error(ErrorItem(cit->error_desc,
223 par_id, posstart, posend));
228 void bufferErrors(Buffer const & buf, ErrorList const & el)
230 for_each(el.begin(), el.end(), bind(ref(buf.error), _1));
234 string const BufferFormat(Buffer const & buffer)
236 if (buffer.isLinuxDoc())
238 else if (buffer.isDocBook())
240 else if (buffer.isLiterate())
247 int countWords(DocIterator const & from, DocIterator const & to)
251 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
252 // Copied and adapted from isLetter() in ControlSpellChecker
254 && dit.pos() != dit.lastpos()
255 && dit.paragraph().isLetter(dit.pos())
256 && !isDeletedText(dit.paragraph(), dit.pos())) {
271 void incrementItemDepth(ParagraphList & pars, pit_type pit, pit_type first_pit)
273 int const cur_labeltype = pars[pit].layout()->labeltype;
275 if (cur_labeltype != LABEL_ENUMERATE && cur_labeltype != LABEL_ITEMIZE)
278 int const cur_depth = pars[pit].getDepth();
280 pit_type prev_pit = pit - 1;
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;
289 } else if (prev_depth < cur_depth) {
290 if (prev_labeltype == cur_labeltype) {
291 pars[pit].itemdepth = pars[prev_pit].itemdepth + 1;
294 } else if (prev_depth == cur_depth) {
295 if (prev_labeltype == cur_labeltype) {
296 pars[pit].itemdepth = pars[prev_pit].itemdepth;
300 if (prev_pit == first_pit)
308 void resetEnumCounterIfNeeded(ParagraphList & pars, pit_type pit,
309 pit_type firstpit, Counters & counters)
314 int const cur_depth = pars[pit].getDepth();
315 pit_type prev_pit = pit - 1;
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) {
323 counters.reset("enumi");
325 counters.reset("enumii");
327 counters.reset("enumiii");
329 counters.reset("enumiv");
335 if (prev_pit == firstpit)
343 // set the counter of a paragraph. This includes the labels
344 void setCounter(Buffer const & buf, ParIterator & it)
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();
356 par.params().appendix(par.params().startOfAppendix());
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();
365 // Maybe we have to increment the item depth.
366 incrementItemDepth(it.plist(), it.pit(), 0);
369 // erase what was there before
370 par.params().labelString(string());
372 if (layout->margintype == MARGIN_MANUAL) {
373 if (par.params().labelWidthString().empty())
374 par.setLabelWidthString(layout->labelstring());
376 par.setLabelWidthString(string());
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);
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
396 switch (par.itemdepth) {
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);
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 counters.step(enumcounter);
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");
444 par.bibitem()->setCounter(number);
445 par.params().labelString(layout->labelstring());
446 // In biblio should't be following counters but...
447 } else if (layout->labeltype == LABEL_SENSITIVE) {
448 // Search for the first float or wrap inset in the iterator
450 size_t i = it.depth();
453 InsetBase * const in = &it[i].inset();
454 if (in->lyxCode() == InsetBase::FLOAT_CODE
455 || in->lyxCode() == InsetBase::WRAP_CODE)
456 type = in->getInsetName();
462 Floating const & fl = textclass.floats().getType(type);
464 counters.step(fl.type());
466 // Doesn't work... yet.
467 s = bformat(_("%1$s #:"), buf.B_(fl.name()));
469 // par->SetLayout(0);
470 s = buf.B_(layout->labelstring());
473 par.params().labelString(s);
475 par.params().labelString(buf.B_(layout->labelstring()));
481 void updateCounters(Buffer const & buf)
484 buf.params().getLyXTextClass().counters().reset();
486 for (ParIterator it = par_iterator_begin(buf.inset()); it; ++it) {
487 // reduce depth if necessary
489 Paragraph const & prevpar = it.plist()[it.pit() - 1];
490 it->params().depth(min(it->params().depth(),
491 prevpar.getMaxDepthAfter()));
493 it->params().depth(0);
495 // set the counter for this paragraph
501 string expandLabel(LyXTextClass const & textclass,
502 LyXLayout_ptr const & layout, bool appendix)
504 string fmt = appendix ?
505 layout->labelstring_appendix() : layout->labelstring();
507 // handle 'inherited level parts' in 'fmt',
508 // i.e. the stuff between '@' in '@Section@.\arabic{subsection}'
509 size_t const i = fmt.find('@', 0);
510 if (i != string::npos) {
511 size_t const j = fmt.find('@', i + 1);
512 if (j != string::npos) {
513 string parent(fmt, i + 1, j - i - 1);
514 string label = expandLabel(textclass, textclass[parent], appendix);
515 fmt = string(fmt, 0, i) + label + string(fmt, j + 1, string::npos);
519 return textclass.counters().counterLabel(fmt);