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/lyxlib.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());
85 if (!b->loadLyXFile(filename)) {
86 theBufferList().release(b);
92 docstring text = bformat(_("The document %1$s does not yet "
93 "exist.\n\nDo you want to create a new document?"),
94 from_utf8(filename.absFilename()));
95 if (!Alert::prompt(_("Create new document?"),
96 text, 0, 1, _("&Create"), _("Cancel")))
97 return newFile(filename.absFilename(), string(), true);
103 // FIXME newFile() should probably be a member method of Application...
104 Buffer * newFile(string const & filename, string const & templatename,
108 Buffer * b = theBufferList().newBuffer(filename);
112 // use defaults.lyx as a default template if it exists.
113 if (templatename.empty())
114 tname = libFileSearch("templates", "defaults.lyx");
116 tname = makeAbsPath(templatename);
118 if (!tname.empty()) {
119 if (!b->readFile(tname)) {
120 docstring const file = makeDisplayPath(tname.absFilename(), 50);
121 docstring const text = bformat(
122 _("The specified document template\n%1$s\ncould not be read."),
124 Alert::error(_("Could not read template"), text);
125 theBufferList().release(b);
132 b->setFileName(filename);
135 b->setReadonly(false);
136 b->setFullyLoaded(true);
142 Buffer * newUnnamedFile(string const & templatename, FileName const & path)
144 static int newfile_number;
146 string document_path = path.absFilename();
147 string filename = addName(document_path,
148 "newfile" + convert<string>(++newfile_number) + ".lyx");
149 while (theBufferList().exists(filename)
150 || FileName(filename).isReadableFile()) {
152 filename = addName(document_path,
153 "newfile" + convert<string>(newfile_number) + ".lyx");
155 return newFile(filename, templatename, false);
159 int countWords(DocIterator const & from, DocIterator const & to)
163 for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
164 // Copied and adapted from isLetter() in ControlSpellChecker
166 && dit.pos() != dit.lastpos()
167 && dit.paragraph().isLetter(dit.pos())
168 && !dit.paragraph().isDeleted(dit.pos())) {
183 depth_type getDepth(DocIterator const & it)
185 depth_type depth = 0;
186 for (size_t i = 0 ; i < it.depth() ; ++i)
187 if (!it[i].inset().inMathed())
188 depth += it[i].paragraph().getDepth() + 1;
189 // remove 1 since the outer inset does not count
193 depth_type getItemDepth(ParIterator const & it)
195 Paragraph const & par = *it;
196 LabelType const labeltype = par.layout()->labeltype;
198 if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
201 // this will hold the lowest depth encountered up to now.
202 depth_type min_depth = getDepth(it);
203 ParIterator prev_it = it;
206 --prev_it.top().pit();
208 // start of nested inset: go to outer par
210 if (prev_it.empty()) {
211 // start of document: nothing to do
216 // We search for the first paragraph with same label
217 // that is not more deeply nested.
218 Paragraph & prev_par = *prev_it;
219 depth_type const prev_depth = getDepth(prev_it);
220 if (labeltype == prev_par.layout()->labeltype) {
221 if (prev_depth < min_depth)
222 return prev_par.itemdepth + 1;
223 if (prev_depth == min_depth)
224 return prev_par.itemdepth;
226 min_depth = min(min_depth, prev_depth);
227 // small optimization: if we are at depth 0, we won't
228 // find anything else
235 bool needEnumCounterReset(ParIterator const & it)
237 Paragraph const & par = *it;
238 BOOST_ASSERT(par.layout()->labeltype == LABEL_ENUMERATE);
239 depth_type const cur_depth = par.getDepth();
240 ParIterator prev_it = it;
241 while (prev_it.pit()) {
242 --prev_it.top().pit();
243 Paragraph const & prev_par = *prev_it;
244 if (prev_par.getDepth() <= cur_depth)
245 return prev_par.layout()->labeltype != LABEL_ENUMERATE;
247 // start of nested inset: reset
252 // set the label of a paragraph. This includes the counters.
253 void setLabel(Buffer const & buf, ParIterator & it)
255 TextClass const & textclass = buf.params().getTextClass();
256 Paragraph & par = it.paragraph();
257 LayoutPtr const & layout = par.layout();
258 Counters & counters = textclass.counters();
260 if (par.params().startOfAppendix()) {
261 // FIXME: only the counter corresponding to toplevel
262 // sectionning should be reset
264 counters.appendix(true);
266 par.params().appendix(counters.appendix());
268 // Compute the item depth of the paragraph
269 par.itemdepth = getItemDepth(it);
271 if (layout->margintype == MARGIN_MANUAL) {
272 if (par.params().labelWidthString().empty())
273 par.params().labelWidthString(par.translateIfPossible(layout->labelstring(), buf.params()));
275 par.params().labelWidthString(docstring());
278 switch(layout->labeltype) {
280 if (layout->toclevel <= buf.params().secnumdepth
281 && (layout->latextype != LATEX_ENVIRONMENT
282 || isFirstInSequence(it.pit(), it.plist()))) {
283 counters.step(layout->counter);
284 par.params().labelString(
285 par.expandLabel(layout, buf.params()));
287 par.params().labelString(docstring());
290 case LABEL_ITEMIZE: {
291 // At some point of time we should do something more
292 // clever here, like:
293 // par.params().labelString(
294 // buf.params().user_defined_bullet(par.itemdepth).getText());
295 // for now, use a simple hardcoded label
297 switch (par.itemdepth) {
299 itemlabel = char_type(0x2022);
302 itemlabel = char_type(0x2013);
305 itemlabel = char_type(0x2217);
308 itemlabel = char_type(0x2219); // or 0x00b7
311 par.params().labelString(itemlabel);
315 case LABEL_ENUMERATE: {
316 // FIXME: Yes I know this is a really, really! bad solution
318 docstring enumcounter = from_ascii("enum");
320 switch (par.itemdepth) {
332 // not a valid enumdepth...
336 // Maybe we have to reset the enumeration counter.
337 if (needEnumCounterReset(it))
338 counters.reset(enumcounter);
340 counters.step(enumcounter);
344 switch (par.itemdepth) {
346 format = N_("\\arabic{enumi}.");
349 format = N_("(\\alph{enumii})");
352 format = N_("\\roman{enumiii}.");
355 format = N_("\\Alph{enumiv}.");
358 // not a valid enumdepth...
362 par.params().labelString(counters.counterLabel(
363 par.translateIfPossible(from_ascii(format), buf.params())));
368 case LABEL_SENSITIVE: {
369 string const & type = counters.current_float();
370 docstring full_label;
372 full_label = buf.B_("Senseless!!! ");
374 docstring name = buf.B_(textclass.floats().getType(type).name());
375 if (counters.hasCounter(from_utf8(type))) {
376 counters.step(from_utf8(type));
377 full_label = bformat(from_ascii("%1$s %2$s:"),
379 counters.theCounter(from_utf8(type)));
381 full_label = bformat(from_ascii("%1$s #:"), name);
383 par.params().labelString(full_label);
388 par.params().labelString(docstring());
392 case LABEL_TOP_ENVIRONMENT:
393 case LABEL_CENTERED_TOP_ENVIRONMENT:
396 par.params().labelString(
397 par.translateIfPossible(layout->labelstring(),
405 void updateLabels(Buffer const & buf, ParIterator & parit)
407 BOOST_ASSERT(parit.pit() == 0);
409 depth_type maxdepth = 0;
410 pit_type const lastpit = parit.lastpit();
411 for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
412 // reduce depth if necessary
413 parit->params().depth(min(parit->params().depth(), maxdepth));
414 maxdepth = parit->getMaxDepthAfter();
416 // set the counter for this paragraph
417 setLabel(buf, parit);
420 InsetList::const_iterator iit = parit->insetList().begin();
421 InsetList::const_iterator end = parit->insetList().end();
422 for (; iit != end; ++iit) {
423 parit.pos() = iit->pos;
424 iit->inset->updateLabels(buf, parit);
431 // FIXME: buf should should be const because updateLabels() modifies
432 // the contents of the paragraphs.
433 void updateLabels(Buffer const & buf, bool childonly)
435 Buffer const * const master = buf.masterBuffer();
436 // Use the master text class also for child documents
437 TextClass const & textclass = master->params().getTextClass();
440 // If this is a child document start with the master
441 if (master != &buf) {
442 updateLabels(*master);
446 // start over the counters
447 textclass.counters().reset();
450 Buffer & cbuf = const_cast<Buffer &>(buf);
452 if (buf.text().empty()) {
453 // FIXME: we don't call continue with updateLabels()
454 // here because it crashes on newly created documents.
455 // But the TocBackend needs to be initialised
456 // nonetheless so we update the tocBackend manually.
457 cbuf.tocBackend().update();
462 ParIterator parit = par_iterator_begin(buf.inset());
463 updateLabels(buf, parit);
465 cbuf.tocBackend().update();
467 cbuf.structureChanged();
471 void checkBufferStructure(Buffer & buffer, ParIterator const & par_it)
473 if (par_it->layout()->toclevel != Layout::NOT_IN_TOC) {
474 Buffer const * master = buffer.masterBuffer();
475 master->tocBackend().updateItem(par_it);
476 master->structureChanged();