* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Alfredo Braunstein
*
* Full author contact details are available in file CREDITS.
#include "LaTeX.h"
#include "Layout.h"
#include "LyX.h"
+#include "LyXVC.h"
#include "TextClass.h"
#include "Paragraph.h"
-#include "paragraph_funcs.h"
#include "ParagraphList.h"
#include "ParagraphParameters.h"
#include "ParIterator.h"
#include "support/filetools.h"
#include "support/gettext.h"
#include "support/lstrings.h"
+#include "support/mutex.h"
#include "support/textutils.h"
using namespace std;
namespace Alert = frontend::Alert;
-Buffer * checkAndLoadLyXFile(FileName const & filename)
+Buffer * checkAndLoadLyXFile(FileName const & filename, bool const acceptDirty)
{
// File already open?
Buffer * checkBuffer = theBufferList().getBuffer(filename);
if (checkBuffer) {
- if (checkBuffer->isClean())
+ // Sometimes (when setting the master buffer from a child)
+ // we accept a dirty buffer right away (otherwise we'd get
+ // an infinite loop (bug 5514).
+ // We also accept a dirty buffer when the document has not
+ // yet been saved to disk.
+ if (checkBuffer->isClean() || acceptDirty || !filename.exists())
return checkBuffer;
- docstring const file = makeDisplayPath(filename.absFilename(), 20);
- docstring text = bformat(_(
+ docstring const file = makeDisplayPath(filename.absFileName(), 20);
+ docstring const text = bformat(_(
"The document %1$s is already loaded and has unsaved changes.\n"
"Do you want to abandon your changes and reload the version on disk?"), file);
- if (Alert::prompt(_("Reload saved document?"),
- text, 0, 1, _("&Reload"), _("&Keep Changes")))
- return checkBuffer;
-
- // FIXME: should be LFUN_REVERT
- theBufferList().release(checkBuffer);
- // Load it again.
- return checkAndLoadLyXFile(filename);
+ int res = Alert::prompt(_("Reload saved document?"),
+ text, 2, 2, _("Yes, &Reload"), _("No, &Keep Changes"), _("&Cancel"));
+ switch (res) {
+ case 0: {
+ // reload the document
+ if (checkBuffer->reload() != Buffer::ReadSuccess)
+ return nullptr;
+ return checkBuffer;
+ }
+ case 1:
+ // keep changes
+ return checkBuffer;
+ case 2:
+ // cancel
+ return nullptr;
+ }
}
- if (filename.exists()) {
- if (!filename.isReadableFile()) {
- docstring text = bformat(_("The file %1$s exists but is not "
- "readable by the current user."),
- from_utf8(filename.absFilename()));
- Alert::error(_("File not readable!"), text);
- return 0;
+ bool const exists = filename.exists();
+ bool const tryVC = exists ? false : LyXVC::fileInVC(filename);
+ if (exists || tryVC) {
+ if (exists) {
+ if (!filename.isReadableFile()) {
+ docstring text = bformat(_("The file %1$s exists but is not "
+ "readable by the current user."),
+ from_utf8(filename.absFileName()));
+ Alert::error(_("File not readable!"), text);
+ return nullptr;
+ }
+ if (filename.extension() == "lyx" && filename.isFileEmpty()) {
+ // Makes it possible to open an empty (0 bytes) .lyx file
+ return newFile(filename.absFileName(), "", true);
+ }
}
- Buffer * b = theBufferList().newBuffer(filename.absFilename());
- if (!b)
+ Buffer * b = theBufferList().newBuffer(filename.absFileName());
+ if (!b) {
// Buffer creation is not possible.
- return 0;
- if (!b->loadLyXFile(filename)) {
+ return nullptr;
+ }
+ if (b->loadLyXFile() != Buffer::ReadSuccess) {
+ // do not save an emergency file when releasing the buffer
+ b->markClean();
theBufferList().release(b);
- return 0;
+ return nullptr;
}
return b;
}
docstring text = bformat(_("The document %1$s does not yet "
"exist.\n\nDo you want to create a new document?"),
- from_utf8(filename.absFilename()));
+ from_utf8(filename.absFileName()));
if (!Alert::prompt(_("Create new document?"),
- text, 0, 1, _("&Create"), _("Cancel")))
- return newFile(filename.absFilename(), string(), true);
+ text, 0, 1, _("&Yes, Create New Document"), _("&No, Do Not Create")))
+ return newFile(filename.absFileName(), string(), true);
- return 0;
+ return nullptr;
}
// FIXME newFile() should probably be a member method of Application...
Buffer * newFile(string const & filename, string const & templatename,
- bool const isNamed)
+ bool is_named)
{
// get a free buffer
Buffer * b = theBufferList().newBuffer(filename);
if (!b)
// Buffer creation is not possible.
- return 0;
+ return nullptr;
FileName tname;
// use defaults.lyx as a default template if it exists.
tname = makeAbsPath(templatename);
if (!tname.empty()) {
- if (!b->readFile(tname)) {
- docstring const file = makeDisplayPath(tname.absFilename(), 50);
+ if (b->loadThisLyXFile(tname) != Buffer::ReadSuccess) {
+ docstring const file = makeDisplayPath(tname.absFileName(), 50);
docstring const text = bformat(
_("The specified document template\n%1$s\ncould not be read."),
file);
Alert::error(_("Could not read template"), text);
theBufferList().release(b);
- return 0;
+ return nullptr;
}
}
- if (!isNamed) {
+ if (is_named)
+ // in this case, the user chose the filename, so we
+ // assume that she really does want this file.
+ b->markDirty();
+ else
b->setUnnamed();
- b->setFileName(filename);
- }
b->setReadonly(false);
b->setFullyLoaded(true);
}
-Buffer * newUnnamedFile(string const & templatename, FileName const & path)
-{
- static int newfile_number;
-
- FileName filename(path,
- "newfile" + convert<string>(++newfile_number) + ".lyx");
- while (theBufferList().exists(filename)
- || filename.isReadableFile()) {
- ++newfile_number;
- filename.set(path,
- "newfile" + convert<string>(newfile_number) + ".lyx");
- }
- return newFile(filename.absFilename(), templatename, false);
-}
-
-
-int countWords(DocIterator const & from, DocIterator const & to)
-{
- int count = 0;
- bool inword = false;
- for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
- // Copied and adapted from isLetter() in ControlSpellChecker
- if (dit.inTexted()
- && dit.pos() != dit.lastpos()
- && dit.paragraph().isLetter(dit.pos())
- && !dit.paragraph().isDeleted(dit.pos())) {
- if (!inword) {
- ++count;
- inword = true;
- }
- } else if (inword)
- inword = false;
- }
-
- return count;
-}
-
-
-int countChars(DocIterator const & from, DocIterator const & to, bool with_blanks)
-{
- int chars = 0;
- int blanks = 0;
- for (DocIterator dit = from ; dit != to ; dit.forwardPos()) {
-
- if (!dit.inTexted()) continue;
- Paragraph const & par = dit.paragraph();
- pos_type const pos = dit.pos();
-
- if (pos != dit.lastpos() && !par.isDeleted(pos)) {
- if (Inset const * ins = par.getInset(pos)) {
- if (ins->isLetter())
- ++chars;
- else if (with_blanks && ins->isSpace())
- ++blanks;
- } else {
- char_type const c = par.getChar(pos);
- if (isPrintableNonspace(c))
- ++chars;
- else if (isSpace(c) && with_blanks)
- ++blanks;
- }
- }
- }
-
- return chars + blanks;
-}
-
-
-namespace {
-
-depth_type getDepth(DocIterator const & it)
-{
- depth_type depth = 0;
- for (size_t i = 0 ; i < it.depth() ; ++i)
- if (!it[i].inset().inMathed())
- depth += it[i].paragraph().getDepth() + 1;
- // remove 1 since the outer inset does not count
- return depth - 1;
-}
-
-depth_type getItemDepth(ParIterator const & it)
+Buffer * newUnnamedFile(FileName const & path, string const & prefix,
+ string const & templatename)
{
- Paragraph const & par = *it;
- LabelType const labeltype = par.layout().labeltype;
-
- if (labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
- return 0;
-
- // this will hold the lowest depth encountered up to now.
- depth_type min_depth = getDepth(it);
- ParIterator prev_it = it;
- while (true) {
- if (prev_it.pit())
- --prev_it.top().pit();
- else {
- // start of nested inset: go to outer par
- prev_it.pop_back();
- if (prev_it.empty()) {
- // start of document: nothing to do
- return 0;
- }
- }
-
- // We search for the first paragraph with same label
- // that is not more deeply nested.
- Paragraph & prev_par = *prev_it;
- depth_type const prev_depth = getDepth(prev_it);
- if (labeltype == prev_par.layout().labeltype) {
- if (prev_depth < min_depth)
- return prev_par.itemdepth + 1;
- if (prev_depth == min_depth)
- return prev_par.itemdepth;
- }
- min_depth = min(min_depth, prev_depth);
- // small optimization: if we are at depth 0, we won't
- // find anything else
- if (prev_depth == 0)
- return 0;
- }
-}
+ static map<string, int> file_number;
+ static Mutex mutex;
+ Mutex::Locker locker(&mutex);
+ FileName filename;
-bool needEnumCounterReset(ParIterator const & it)
-{
- Paragraph const & par = *it;
- LASSERT(par.layout().labeltype == LABEL_ENUMERATE, /**/);
- depth_type const cur_depth = par.getDepth();
- ParIterator prev_it = it;
- while (prev_it.pit()) {
- --prev_it.top().pit();
- Paragraph const & prev_par = *prev_it;
- if (prev_par.getDepth() <= cur_depth)
- return prev_par.layout().labeltype != LABEL_ENUMERATE;
- }
- // start of nested inset: reset
- return true;
-}
-
-
-// set the label of a paragraph. This includes the counters.
-void setLabel(Buffer const & buf, ParIterator & it)
-{
- BufferParams const & bp = buf.masterBuffer()->params();
- DocumentClass const & textclass = bp.documentClass();
- Paragraph & par = it.paragraph();
- Layout const & layout = par.layout();
- Counters & counters = textclass.counters();
-
- if (par.params().startOfAppendix()) {
- // FIXME: only the counter corresponding to toplevel
- // sectionning should be reset
- counters.reset();
- counters.appendix(true);
- }
- par.params().appendix(counters.appendix());
-
- // Compute the item depth of the paragraph
- par.itemdepth = getItemDepth(it);
-
- if (layout.margintype == MARGIN_MANUAL) {
- if (par.params().labelWidthString().empty())
- par.params().labelWidthString(par.translateIfPossible(layout.labelstring(), bp));
- } else {
- par.params().labelWidthString(docstring());
- }
-
- switch(layout.labeltype) {
- case LABEL_COUNTER:
- if (layout.toclevel <= bp.secnumdepth
- && (layout.latextype != LATEX_ENVIRONMENT
- || isFirstInSequence(it.pit(), it.plist()))) {
- counters.step(layout.counter);
- par.params().labelString(
- par.expandLabel(layout, bp));
- } else
- par.params().labelString(docstring());
- break;
-
- case LABEL_ITEMIZE: {
- // At some point of time we should do something more
- // clever here, like:
- // par.params().labelString(
- // bp.user_defined_bullet(par.itemdepth).getText());
- // for now, use a simple hardcoded label
- docstring itemlabel;
- switch (par.itemdepth) {
- case 0:
- itemlabel = char_type(0x2022);
- break;
- case 1:
- itemlabel = char_type(0x2013);
- break;
- case 2:
- itemlabel = char_type(0x2217);
- break;
- case 3:
- itemlabel = char_type(0x2219); // or 0x00b7
- break;
- }
- par.params().labelString(itemlabel);
- break;
- }
-
- case LABEL_ENUMERATE: {
- // FIXME: Yes I know this is a really, really! bad solution
- // (Lgb)
- docstring enumcounter = from_ascii("enum");
-
- switch (par.itemdepth) {
- case 2:
- enumcounter += 'i';
- case 1:
- enumcounter += 'i';
- case 0:
- enumcounter += 'i';
- break;
- case 3:
- enumcounter += "iv";
- break;
- default:
- // not a valid enumdepth...
- break;
- }
-
- // Maybe we have to reset the enumeration counter.
- if (needEnumCounterReset(it))
- counters.reset(enumcounter);
-
- counters.step(enumcounter);
-
- string format;
-
- switch (par.itemdepth) {
- case 0:
- format = N_("\\arabic{enumi}.");
- break;
- case 1:
- format = N_("(\\alph{enumii})");
- break;
- case 2:
- format = N_("\\roman{enumiii}.");
- break;
- case 3:
- format = N_("\\Alph{enumiv}.");
- break;
- default:
- // not a valid enumdepth...
- break;
- }
-
- par.params().labelString(counters.counterLabel(
- par.translateIfPossible(from_ascii(format), bp)));
-
- break;
- }
-
- case LABEL_SENSITIVE: {
- string const & type = counters.current_float();
- docstring full_label;
- if (type.empty())
- full_label = buf.B_("Senseless!!! ");
- else {
- docstring name = buf.B_(textclass.floats().getType(type).name());
- if (counters.hasCounter(from_utf8(type))) {
- counters.step(from_utf8(type));
- full_label = bformat(from_ascii("%1$s %2$s:"),
- name,
- counters.theCounter(from_utf8(type)));
- } else
- full_label = bformat(from_ascii("%1$s #:"), name);
- }
- par.params().labelString(full_label);
- break;
+ do {
+ filename.set(path,
+ prefix + convert<string>(++file_number[prefix]) + ".lyx");
}
+ while (theBufferList().exists(filename) || filename.isReadableFile());
- case LABEL_NO_LABEL:
- par.params().labelString(docstring());
- break;
-
- case LABEL_MANUAL:
- case LABEL_TOP_ENVIRONMENT:
- case LABEL_CENTERED_TOP_ENVIRONMENT:
- case LABEL_STATIC:
- case LABEL_BIBLIO:
- par.params().labelString(
- par.translateIfPossible(layout.labelstring(), bp));
- break;
- }
+ return newFile(filename.absFileName(), templatename, false);
}
-} // anon namespace
-void updateLabels(Buffer const & buf, ParIterator & parit)
+Buffer * loadIfNeeded(FileName const & fname)
{
- LASSERT(parit.pit() == 0, /**/);
-
- // set the position of the text in the buffer to be able
- // to resolve macros in it. This has nothing to do with
- // labels, but by putting it here we avoid implementing
- // a whole bunch of traversal routines just for this call.
- parit.text()->setMacrocontextPosition(parit);
-
- depth_type maxdepth = 0;
- pit_type const lastpit = parit.lastpit();
- for ( ; parit.pit() <= lastpit ; ++parit.pit()) {
- // reduce depth if necessary
- parit->params().depth(min(parit->params().depth(), maxdepth));
- maxdepth = parit->getMaxDepthAfter();
-
- // set the counter for this paragraph
- setLabel(buf, parit);
-
- // Now the insets
- InsetList::const_iterator iit = parit->insetList().begin();
- InsetList::const_iterator end = parit->insetList().end();
- for (; iit != end; ++iit) {
- parit.pos() = iit->pos;
- iit->inset->updateLabels(parit);
- }
- }
-}
-
+ Buffer * buffer = theBufferList().getBuffer(fname);
+ if (!buffer) {
+ if (!fname.exists() && !LyXVC::fileInVC(fname))
+ return nullptr;
-// FIXME: buf should should be const because updateLabels() modifies
-// the contents of the paragraphs.
-void updateLabels(Buffer const & buf, bool childonly)
-{
- // Use the master text class also for child documents
- Buffer const * const master = buf.masterBuffer();
- DocumentClass const & textclass = master->params().documentClass();
-
- // keep the buffers to be children in this set. If the call from the
- // master comes back we can see which of them were actually seen (i.e.
- // via an InsetInclude). The remaining ones in the set need still be updated.
- static std::set<Buffer const *> bufToUpdate;
- if (!childonly) {
- // If this is a child document start with the master
- if (master != &buf) {
- bufToUpdate.insert(&buf);
- updateLabels(*master);
+ buffer = theBufferList().newBuffer(fname.absFileName());
+ if (!buffer)
+ // Buffer creation is not possible.
+ return nullptr;
- // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
- if (bufToUpdate.find(&buf) == bufToUpdate.end())
- return;
+ if (buffer->loadLyXFile() != Buffer::ReadSuccess) {
+ //close the buffer we just opened
+ theBufferList().release(buffer);
+ return nullptr;
}
-
- // start over the counters in the master
- textclass.counters().reset();
}
-
- // update will be done below for buf
- bufToUpdate.erase(&buf);
-
- // update all caches
- buf.clearReferenceCache();
- buf.inset().setBuffer(const_cast<Buffer &>(buf));
- buf.updateMacros();
-
- Buffer & cbuf = const_cast<Buffer &>(buf);
-
- BOOST_ASSERT(!buf.text().paragraphs().empty());
-
- // do the real work
- ParIterator parit = par_iterator_begin(buf.inset());
- updateLabels(buf, parit);
-
- if (master != &buf)
- // TocBackend update will be done later.
- return;
-
- cbuf.tocBackend().update();
- if (!childonly)
- cbuf.structureChanged();
+ return buffer;
}