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"
52 #include "support/textutils.h"
55 using namespace lyx::support;
59 namespace Alert = frontend::Alert;
62 Buffer * checkAndLoadLyXFile(FileName const & filename)
65 Buffer * checkBuffer = theBufferList().getBuffer(filename.absFilename());
67 if (checkBuffer->isClean())
69 docstring const file = makeDisplayPath(filename.absFilename(), 20);
70 docstring text = bformat(_(
71 "The document %1$s is already loaded and has unsaved changes.\n"
72 "Do you want to abandon your changes and reload the version on disk?"), file);
73 if (Alert::prompt(_("Reload saved document?"),
74 text, 0, 1, _("&Reload"), _("&Keep Changes")))
77 // FIXME: should be LFUN_REVERT
78 theBufferList().release(checkBuffer);
80 return checkAndLoadLyXFile(filename);
83 if (filename.isReadableFile()) {
84 Buffer * b = theBufferList().newBuffer(filename.absFilename());
86 // Buffer creation is not possible.
88 if (!b->loadLyXFile(filename)) {
89 theBufferList().release(b);
95 docstring text = bformat(_("The document %1$s does not yet "
96 "exist.\n\nDo you want to create a new document?"),
97 from_utf8(filename.absFilename()));
98 if (!Alert::prompt(_("Create new document?"),
99 text, 0, 1, _("&Create"), _("Cancel")))
100 return newFile(filename.absFilename(), string(), true);
106 // FIXME newFile() should probably be a member method of Application...
107 Buffer * newFile(string const & filename, string const & templatename,
111 Buffer * b = theBufferList().newBuffer(filename);
113 // Buffer creation is not possible.
117 // use defaults.lyx as a default template if it exists.
118 if (templatename.empty())
119 tname = libFileSearch("templates", "defaults.lyx");
121 tname = makeAbsPath(templatename);
123 if (!tname.empty()) {
124 if (!b->readFile(tname)) {
125 docstring const file = makeDisplayPath(tname.absFilename(), 50);
126 docstring const text = bformat(
127 _("The specified document template\n%1$s\ncould not be read."),
129 Alert::error(_("Could not read template"), text);
130 theBufferList().release(b);
137 b->setFileName(filename);
140 b->setReadonly(false);
141 b->setFullyLoaded(true);
147 Buffer * newUnnamedFile(string const & templatename, FileName const & path)
149 static int newfile_number;
151 string document_path = path.absFilename();
152 string filename = addName(document_path,
153 "newfile" + convert<string>(++newfile_number) + ".lyx");
154 while (theBufferList().exists(filename)
155 || FileName(filename).isReadableFile()) {
157 filename = addName(document_path,
158 "newfile" + convert<string>(newfile_number) + ".lyx");
160 return newFile(filename, templatename, false);
164 int countWords(DocIterator const & from, DocIterator const & to)
168 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
169 // Copied and adapted from isLetter() in ControlSpellChecker
171 && dit.pos() != dit.lastpos()
172 && dit.paragraph().isLetter(dit.pos())
173 && !dit.paragraph().isDeleted(dit.pos())) {
186 int countChars(DocIterator const & from, DocIterator const & to, bool with_blanks)
190 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
192 && dit.pos() != dit.lastpos()
193 && !dit.paragraph().isDeleted(dit.pos())) {
194 if (dit.paragraph().isInset(dit.pos())) {
195 if (dit.paragraph().getInset(dit.pos())->isLetter())
197 else if (dit.paragraph().getInset(dit.pos())->isSpace() && with_blanks)
200 char_type const c = dit.paragraph().getChar(dit.pos());
201 if (isPrintableNonspace(c))
203 else if (isSpace(c) && with_blanks)
209 return chars + blanks;
215 depth_type getDepth(DocIterator const & it)
217 depth_type depth = 0;
218 for (size_t i = 0 ; i < it.depth() ; ++i)
219 if (!it[i].inset().inMathed())
220 depth += it[i].paragraph().getDepth() + 1;
221 // remove 1 since the outer inset does not count
225 depth_type getItemDepth(ParIterator const & it)
227 Paragraph const & par = *it;
228 LabelType const labeltype = par.layout()->labeltype;
230 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
233 // this will hold the lowest depth encountered up to now.
234 depth_type min_depth = getDepth(it);
235 ParIterator prev_it = it;
238 --prev_it.top().pit();
240 // start of nested inset: go to outer par
242 if (prev_it.empty()) {
243 // start of document: nothing to do
248 // We search for the first paragraph with same label
249 // that is not more deeply nested.
250 Paragraph & prev_par = *prev_it;
251 depth_type const prev_depth = getDepth(prev_it);
252 if (labeltype == prev_par.layout()->labeltype) {
253 if (prev_depth < min_depth)
254 return prev_par.itemdepth + 1;
255 if (prev_depth == min_depth)
256 return prev_par.itemdepth;
258 min_depth = min(min_depth, prev_depth);
259 // small optimization: if we are at depth 0, we won't
260 // find anything else
267 bool needEnumCounterReset(ParIterator const & it)
269 Paragraph const & par = *it;
270 BOOST_ASSERT(par.layout()->labeltype == LABEL_ENUMERATE);
271 depth_type const cur_depth = par.getDepth();
272 ParIterator prev_it = it;
273 while (prev_it.pit()) {
274 --prev_it.top().pit();
275 Paragraph const & prev_par = *prev_it;
276 if (prev_par.getDepth() <= cur_depth)
277 return prev_par.layout()->labeltype != LABEL_ENUMERATE;
279 // start of nested inset: reset
284 // set the label of a paragraph. This includes the counters.
285 void setLabel(Buffer const & buf, ParIterator & it)
287 TextClass const & textclass = buf.params().getTextClass();
288 Paragraph & par = it.paragraph();
289 LayoutPtr const & layout = par.layout();
290 Counters & counters = textclass.counters();
292 if (par.params().startOfAppendix()) {
293 // FIXME: only the counter corresponding to toplevel
294 // sectionning should be reset
296 counters.appendix(true);
298 par.params().appendix(counters.appendix());
300 // Compute the item depth of the paragraph
301 par.itemdepth = getItemDepth(it);
303 if (layout->margintype == MARGIN_MANUAL) {
304 if (par.params().labelWidthString().empty())
305 par.params().labelWidthString(par.translateIfPossible(layout->labelstring(), buf.params()));
307 par.params().labelWidthString(docstring());
310 switch(layout->labeltype) {
312 if (layout->toclevel <= buf.params().secnumdepth
313 && (layout->latextype != LATEX_ENVIRONMENT
314 || isFirstInSequence(it.pit(), it.plist()))) {
315 counters.step(layout->counter);
316 par.params().labelString(
317 par.expandLabel(layout, buf.params()));
319 par.params().labelString(docstring());
322 case LABEL_ITEMIZE: {
323 // At some point of time we should do something more
324 // clever here, like:
325 // par.params().labelString(
326 // buf.params().user_defined_bullet(par.itemdepth).getText());
327 // for now, use a simple hardcoded label
329 switch (par.itemdepth) {
331 itemlabel = char_type(0x2022);
334 itemlabel = char_type(0x2013);
337 itemlabel = char_type(0x2217);
340 itemlabel = char_type(0x2219); // or 0x00b7
343 par.params().labelString(itemlabel);
347 case LABEL_ENUMERATE: {
348 // FIXME: Yes I know this is a really, really! bad solution
350 docstring enumcounter = from_ascii("enum");
352 switch (par.itemdepth) {
364 // not a valid enumdepth...
368 // Maybe we have to reset the enumeration counter.
369 if (needEnumCounterReset(it))
370 counters.reset(enumcounter);
372 counters.step(enumcounter);
376 switch (par.itemdepth) {
378 format = N_("\\arabic{enumi}.");
381 format = N_("(\\alph{enumii})");
384 format = N_("\\roman{enumiii}.");
387 format = N_("\\Alph{enumiv}.");
390 // not a valid enumdepth...
394 par.params().labelString(counters.counterLabel(
395 par.translateIfPossible(from_ascii(format), buf.params())));
400 case LABEL_SENSITIVE: {
401 string const & type = counters.current_float();
402 docstring full_label;
404 full_label = buf.B_("Senseless!!! ");
406 docstring name = buf.B_(textclass.floats().getType(type).name());
407 if (counters.hasCounter(from_utf8(type))) {
408 counters.step(from_utf8(type));
409 full_label = bformat(from_ascii("%1$s %2$s:"),
411 counters.theCounter(from_utf8(type)));
413 full_label = bformat(from_ascii("%1$s #:"), name);
415 par.params().labelString(full_label);
420 par.params().labelString(docstring());
424 case LABEL_TOP_ENVIRONMENT:
425 case LABEL_CENTERED_TOP_ENVIRONMENT:
428 par.params().labelString(
429 par.translateIfPossible(layout->labelstring(),
437 void updateLabels(Buffer const & buf, ParIterator & parit)
439 BOOST_ASSERT(parit.pit() == 0);
441 // set the position of the text in the buffer to be able
442 // to resolve macros in it. This has nothing to do with
443 // labels, but by putting it here we avoid implementing
444 // a whole bunch of traversal routines just for this call.
445 parit.text()->setMacrocontextPosition(parit);
447 depth_type maxdepth = 0;
448 pit_type const lastpit = parit.lastpit();
449 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
450 // reduce depth if necessary
451 parit->params().depth(min(parit->params().depth(), maxdepth));
452 maxdepth = parit->getMaxDepthAfter();
454 // set the counter for this paragraph
455 setLabel(buf, parit);
458 InsetList::const_iterator iit = parit->insetList().begin();
459 InsetList::const_iterator end = parit->insetList().end();
460 for (; iit != end; ++iit) {
461 parit.pos() = iit->pos;
462 iit->inset->updateLabels(buf, parit);
469 // FIXME: buf should should be const because updateLabels() modifies
470 // the contents of the paragraphs.
471 void updateLabels(Buffer const & buf, bool childonly)
473 Buffer const * const master = buf.masterBuffer();
474 // Use the master text class also for child documents
475 TextClass const & textclass = master->params().getTextClass();
478 // If this is a child document start with the master
479 if (master != &buf) {
480 updateLabels(*master);
484 // start over the counters
485 textclass.counters().reset();
488 Buffer & cbuf = const_cast<Buffer &>(buf);
490 if (buf.text().empty()) {
491 // FIXME: we don't call continue with updateLabels()
492 // here because it crashes on newly created documents.
493 // But the TocBackend needs to be initialised
494 // nonetheless so we update the tocBackend manually.
495 cbuf.tocBackend().update();
500 ParIterator parit = par_iterator_begin(buf.inset());
501 updateLabels(buf, parit);
503 cbuf.tocBackend().update();
505 cbuf.structureChanged();
509 void checkBufferStructure(Buffer & buffer, ParIterator const & par_it)
511 if (par_it->layout()->toclevel != Layout::NOT_IN_TOC) {
512 Buffer const * master = buffer.masterBuffer();
513 master->tocBackend().updateItem(par_it);
514 master->structureChanged();