2 * \file buffer_funcs.cpp
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"
24 #include "InsetList.h"
25 #include "InsetIterator.h"
29 #include "LayoutPtr.h"
31 #include "TextClass.h"
32 #include "TextClassList.h"
33 #include "Paragraph.h"
34 #include "paragraph_funcs.h"
35 #include "ParagraphList.h"
36 #include "ParagraphParameters.h"
37 #include "ParIterator.h"
40 #include "TocBackend.h"
42 #include "frontends/alert.h"
44 #include "insets/InsetBibitem.h"
45 #include "insets/InsetInclude.h"
47 #include "support/convert.h"
48 #include "support/debug.h"
49 #include "support/filetools.h"
50 #include "support/gettext.h"
51 #include "support/lstrings.h"
54 using namespace lyx::support;
58 namespace Alert = frontend::Alert;
61 Buffer * checkAndLoadLyXFile(FileName const & filename)
64 Buffer * checkBuffer = theBufferList().getBuffer(filename.absFilename());
66 if (checkBuffer->isClean())
68 docstring const file = makeDisplayPath(filename.absFilename(), 20);
69 docstring text = bformat(_(
70 "The document %1$s is already loaded and has unsaved changes.\n"
71 "Do you want to abandon your changes and reload the version on disk?"), file);
72 if (Alert::prompt(_("Reload saved document?"),
73 text, 0, 1, _("&Reload"), _("&Keep Changes")))
76 // FIXME: should be LFUN_REVERT
77 theBufferList().release(checkBuffer);
79 return checkAndLoadLyXFile(filename);
82 if (filename.isReadableFile()) {
83 Buffer * b = theBufferList().newBuffer(filename.absFilename());
85 // Buffer creation is not possible.
87 if (!b->loadLyXFile(filename)) {
88 theBufferList().release(b);
94 docstring text = bformat(_("The document %1$s does not yet "
95 "exist.\n\nDo you want to create a new document?"),
96 from_utf8(filename.absFilename()));
97 if (!Alert::prompt(_("Create new document?"),
98 text, 0, 1, _("&Create"), _("Cancel")))
99 return newFile(filename.absFilename(), string(), true);
105 // FIXME newFile() should probably be a member method of Application...
106 Buffer * newFile(string const & filename, string const & templatename,
110 Buffer * b = theBufferList().newBuffer(filename);
112 // Buffer creation is not possible.
116 // use defaults.lyx as a default template if it exists.
117 if (templatename.empty())
118 tname = libFileSearch("templates", "defaults.lyx");
120 tname = makeAbsPath(templatename);
122 if (!tname.empty()) {
123 if (!b->readFile(tname)) {
124 docstring const file = makeDisplayPath(tname.absFilename(), 50);
125 docstring const text = bformat(
126 _("The specified document template\n%1$s\ncould not be read."),
128 Alert::error(_("Could not read template"), text);
129 theBufferList().release(b);
136 b->setFileName(filename);
139 b->setReadonly(false);
140 b->setFullyLoaded(true);
146 Buffer * newUnnamedFile(string const & templatename, FileName const & path)
148 static int newfile_number;
150 string document_path = path.absFilename();
151 string filename = addName(document_path,
152 "newfile" + convert<string>(++newfile_number) + ".lyx");
153 while (theBufferList().exists(filename)
154 || FileName(filename).isReadableFile()) {
156 filename = addName(document_path,
157 "newfile" + convert<string>(newfile_number) + ".lyx");
159 return newFile(filename, templatename, false);
163 int countWords(DocIterator const & from, DocIterator const & to)
167 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
168 // Copied and adapted from isLetter() in ControlSpellChecker
170 && dit.pos() != dit.lastpos()
171 && dit.paragraph().isLetter(dit.pos())
172 && !dit.paragraph().isDeleted(dit.pos())) {
187 depth_type getDepth(DocIterator const & it)
189 depth_type depth = 0;
190 for (size_t i = 0 ; i < it.depth() ; ++i)
191 if (!it[i].inset().inMathed())
192 depth += it[i].paragraph().getDepth() + 1;
193 // remove 1 since the outer inset does not count
197 depth_type getItemDepth(ParIterator const & it)
199 Paragraph const & par = *it;
200 LabelType const labeltype = par.layout()->labeltype;
202 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
205 // this will hold the lowest depth encountered up to now.
206 depth_type min_depth = getDepth(it);
207 ParIterator prev_it = it;
210 --prev_it.top().pit();
212 // start of nested inset: go to outer par
214 if (prev_it.empty()) {
215 // start of document: nothing to do
220 // We search for the first paragraph with same label
221 // that is not more deeply nested.
222 Paragraph & prev_par = *prev_it;
223 depth_type const prev_depth = getDepth(prev_it);
224 if (labeltype == prev_par.layout()->labeltype) {
225 if (prev_depth < min_depth)
226 return prev_par.itemdepth + 1;
227 if (prev_depth == min_depth)
228 return prev_par.itemdepth;
230 min_depth = min(min_depth, prev_depth);
231 // small optimization: if we are at depth 0, we won't
232 // find anything else
239 bool needEnumCounterReset(ParIterator const & it)
241 Paragraph const & par = *it;
242 BOOST_ASSERT(par.layout()->labeltype == LABEL_ENUMERATE);
243 depth_type const cur_depth = par.getDepth();
244 ParIterator prev_it = it;
245 while (prev_it.pit()) {
246 --prev_it.top().pit();
247 Paragraph const & prev_par = *prev_it;
248 if (prev_par.getDepth() <= cur_depth)
249 return prev_par.layout()->labeltype != LABEL_ENUMERATE;
251 // start of nested inset: reset
256 // set the label of a paragraph. This includes the counters.
257 void setLabel(Buffer const & buf, ParIterator & it)
259 TextClass const & textclass = buf.params().getTextClass();
260 Paragraph & par = it.paragraph();
261 LayoutPtr const & layout = par.layout();
262 Counters & counters = textclass.counters();
264 if (par.params().startOfAppendix()) {
265 // FIXME: only the counter corresponding to toplevel
266 // sectionning should be reset
268 counters.appendix(true);
270 par.params().appendix(counters.appendix());
272 // Compute the item depth of the paragraph
273 par.itemdepth = getItemDepth(it);
275 if (layout->margintype == MARGIN_MANUAL) {
276 if (par.params().labelWidthString().empty())
277 par.params().labelWidthString(par.translateIfPossible(layout->labelstring(), buf.params()));
279 par.params().labelWidthString(docstring());
282 switch(layout->labeltype) {
284 if (layout->toclevel <= buf.params().secnumdepth
285 && (layout->latextype != LATEX_ENVIRONMENT
286 || isFirstInSequence(it.pit(), it.plist()))) {
287 counters.step(layout->counter);
288 par.params().labelString(
289 par.expandLabel(layout, buf.params()));
291 par.params().labelString(docstring());
294 case LABEL_ITEMIZE: {
295 // At some point of time we should do something more
296 // clever here, like:
297 // par.params().labelString(
298 // buf.params().user_defined_bullet(par.itemdepth).getText());
299 // for now, use a simple hardcoded label
301 switch (par.itemdepth) {
303 itemlabel = char_type(0x2022);
306 itemlabel = char_type(0x2013);
309 itemlabel = char_type(0x2217);
312 itemlabel = char_type(0x2219); // or 0x00b7
315 par.params().labelString(itemlabel);
319 case LABEL_ENUMERATE: {
320 // FIXME: Yes I know this is a really, really! bad solution
322 docstring enumcounter = from_ascii("enum");
324 switch (par.itemdepth) {
336 // not a valid enumdepth...
340 // Maybe we have to reset the enumeration counter.
341 if (needEnumCounterReset(it))
342 counters.reset(enumcounter);
344 counters.step(enumcounter);
348 switch (par.itemdepth) {
350 format = N_("\\arabic{enumi}.");
353 format = N_("(\\alph{enumii})");
356 format = N_("\\roman{enumiii}.");
359 format = N_("\\Alph{enumiv}.");
362 // not a valid enumdepth...
366 par.params().labelString(counters.counterLabel(
367 par.translateIfPossible(from_ascii(format), buf.params())));
372 case LABEL_SENSITIVE: {
373 string const & type = counters.current_float();
374 docstring full_label;
376 full_label = buf.B_("Senseless!!! ");
378 docstring name = buf.B_(textclass.floats().getType(type).name());
379 if (counters.hasCounter(from_utf8(type))) {
380 counters.step(from_utf8(type));
381 full_label = bformat(from_ascii("%1$s %2$s:"),
383 counters.theCounter(from_utf8(type)));
385 full_label = bformat(from_ascii("%1$s #:"), name);
387 par.params().labelString(full_label);
392 par.params().labelString(docstring());
396 case LABEL_TOP_ENVIRONMENT:
397 case LABEL_CENTERED_TOP_ENVIRONMENT:
400 par.params().labelString(
401 par.translateIfPossible(layout->labelstring(),
409 void updateLabels(Buffer const & buf, ParIterator & parit)
411 BOOST_ASSERT(parit.pit() == 0);
413 // set the position of the text in the buffer to be able
414 // to resolve macros in it. This has nothing to do with
415 // labels, but by putting it here we avoid implementing
416 // a whole bunch of traversal routines just for this call.
417 parit.text()->setMacrocontextPosition(parit);
419 depth_type maxdepth = 0;
420 pit_type const lastpit = parit.lastpit();
421 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
422 // reduce depth if necessary
423 parit->params().depth(min(parit->params().depth(), maxdepth));
424 maxdepth = parit->getMaxDepthAfter();
426 // set the counter for this paragraph
427 setLabel(buf, parit);
430 InsetList::const_iterator iit = parit->insetList().begin();
431 InsetList::const_iterator end = parit->insetList().end();
432 for (; iit != end; ++iit) {
433 parit.pos() = iit->pos;
434 iit->inset->updateLabels(buf, parit);
441 // FIXME: buf should should be const because updateLabels() modifies
442 // the contents of the paragraphs.
443 void updateLabels(Buffer const & buf, bool childonly)
445 Buffer const * const master = buf.masterBuffer();
446 // Use the master text class also for child documents
447 TextClass const & textclass = master->params().getTextClass();
450 // If this is a child document start with the master
451 if (master != &buf) {
452 updateLabels(*master);
456 // start over the counters
457 textclass.counters().reset();
460 Buffer & cbuf = const_cast<Buffer &>(buf);
462 if (buf.text().empty()) {
463 // FIXME: we don't call continue with updateLabels()
464 // here because it crashes on newly created documents.
465 // But the TocBackend needs to be initialised
466 // nonetheless so we update the tocBackend manually.
467 cbuf.tocBackend().update();
472 ParIterator parit = par_iterator_begin(buf.inset());
473 updateLabels(buf, parit);
475 cbuf.tocBackend().update();
477 cbuf.structureChanged();
481 void checkBufferStructure(Buffer & buffer, ParIterator const & par_it)
483 if (par_it->layout()->toclevel != Layout::NOT_IN_TOC) {
484 Buffer const * master = buffer.masterBuffer();
485 master->tocBackend().updateItem(par_it);
486 master->structureChanged();