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 Stefan Schimanski
9 * Full author contact details are available in file CREDITS.
17 #include "LayoutFile.h"
18 #include "BiblioInfo.h"
19 #include "BranchList.h"
20 #include "buffer_funcs.h"
21 #include "BufferList.h"
22 #include "BufferParams.h"
25 #include "Converter.h"
27 #include "DispatchResult.h"
28 #include "DocIterator.h"
30 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "FuncStatus.h"
35 #include "IndicesList.h"
36 #include "InsetIterator.h"
37 #include "InsetList.h"
39 #include "LaTeXFeatures.h"
43 #include "LyXAction.h"
48 #include "output_docbook.h"
50 #include "output_latex.h"
51 #include "output_xhtml.h"
52 #include "output_plaintext.h"
53 #include "Paragraph.h"
54 #include "ParagraphParameters.h"
55 #include "ParIterator.h"
56 #include "PDFOptions.h"
57 #include "SpellChecker.h"
60 #include "TexStream.h"
62 #include "TextClass.h"
63 #include "TocBackend.h"
65 #include "VCBackend.h"
67 #include "WordLangTuple.h"
70 #include "insets/InsetBibitem.h"
71 #include "insets/InsetBibtex.h"
72 #include "insets/InsetBranch.h"
73 #include "insets/InsetInclude.h"
74 #include "insets/InsetText.h"
76 #include "mathed/MacroTable.h"
77 #include "mathed/MathMacroTemplate.h"
78 #include "mathed/MathSupport.h"
80 #include "frontends/alert.h"
81 #include "frontends/Delegates.h"
82 #include "frontends/WorkAreaManager.h"
84 #include "graphics/Previews.h"
86 #include "support/lassert.h"
87 #include "support/convert.h"
88 #include "support/debug.h"
89 #include "support/docstring_list.h"
90 #include "support/ExceptionMessage.h"
91 #include "support/FileName.h"
92 #include "support/FileNameList.h"
93 #include "support/filetools.h"
94 #include "support/ForkedCalls.h"
95 #include "support/gettext.h"
96 #include "support/gzstream.h"
97 #include "support/lstrings.h"
98 #include "support/lyxalgo.h"
99 #include "support/os.h"
100 #include "support/Package.h"
101 #include "support/Path.h"
102 #include "support/Systemcall.h"
103 #include "support/textutils.h"
104 #include "support/types.h"
106 #include <boost/bind.hpp>
107 #include <boost/shared_ptr.hpp>
119 using namespace lyx::support
;
123 namespace Alert
= frontend::Alert
;
124 namespace os
= support::os
;
128 // Do not remove the comment below, so we get merge conflict in
129 // independent branches. Instead add your own.
130 int const LYX_FORMAT
= 370; // uwestoehr: option to suppress default date
132 typedef map
<string
, bool> DepClean
;
133 typedef map
<docstring
, pair
<InsetLabel
const *, Buffer::References
> > RefCache
;
135 void showPrintError(string
const & name
)
137 docstring str
= bformat(_("Could not print the document %1$s.\n"
138 "Check that your printer is set up correctly."),
139 makeDisplayPath(name
, 50));
140 Alert::error(_("Print document failed"), str
);
145 class BufferSet
: public std::set
<Buffer
const *> {};
150 Impl(Buffer
& parent
, FileName
const & file
, bool readonly
);
164 mutable TexRow texrow
;
166 /// need to regenerate .tex?
170 mutable bool lyx_clean
;
172 /// is autosave needed?
173 mutable bool bak_clean
;
175 /// is this a unnamed file (New...)?
181 /// name of the file the buffer is associated with.
184 /** Set to true only when the file is fully loaded.
185 * Used to prevent the premature generation of previews
186 * and by the citation inset.
188 bool file_fully_loaded
;
191 mutable TocBackend toc_backend
;
194 typedef pair
<DocIterator
, MacroData
> ScopeMacro
;
195 typedef map
<DocIterator
, ScopeMacro
> PositionScopeMacroMap
;
196 typedef map
<docstring
, PositionScopeMacroMap
> NamePositionScopeMacroMap
;
197 /// map from the macro name to the position map,
198 /// which maps the macro definition position to the scope and the MacroData.
199 NamePositionScopeMacroMap macros
;
202 /// positions of child buffers in the buffer
203 typedef map
<Buffer
const * const, DocIterator
> BufferPositionMap
;
204 typedef pair
<DocIterator
, Buffer
const *> ScopeBuffer
;
205 typedef map
<DocIterator
, ScopeBuffer
> PositionScopeBufferMap
;
206 /// position of children buffers in this buffer
207 BufferPositionMap children_positions
;
208 /// map from children inclusion positions to their scope and their buffer
209 PositionScopeBufferMap position_to_children
;
211 /// Container for all sort of Buffer dependant errors.
212 map
<string
, ErrorList
> errorLists
;
214 /// timestamp and checksum used to test if the file has been externally
215 /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
217 unsigned long checksum_
;
220 frontend::WorkAreaManager
* wa_
;
225 /// A cache for the bibfiles (including bibfiles of loaded child
226 /// documents), needed for appropriate update of natbib labels.
227 mutable support::FileNameList bibfilesCache_
;
229 // FIXME The caching mechanism could be improved. At present, we have a
230 // cache for each Buffer, that caches all the bibliography info for that
231 // Buffer. A more efficient solution would be to have a global cache per
232 // file, and then to construct the Buffer's bibinfo from that.
233 /// A cache for bibliography info
234 mutable BiblioInfo bibinfo_
;
235 /// whether the bibinfo cache is valid
236 bool bibinfoCacheValid_
;
237 /// Cache of timestamps of .bib files
238 map
<FileName
, time_t> bibfileStatus_
;
240 mutable RefCache ref_cache_
;
242 /// our Text that should be wrapped in an InsetText
245 /// This is here to force the test to be done whenever parent_buffer
247 Buffer
const * parent() const {
248 // if parent_buffer is not loaded, then it has been unloaded,
249 // which means that parent_buffer is an invalid pointer. So we
250 // set it to null in that case.
251 if (!theBufferList().isLoaded(parent_buffer
))
253 return parent_buffer
;
256 void setParent(Buffer
const * pb
) {
257 if (parent_buffer
&& pb
&& parent_buffer
!= pb
)
258 LYXERR0("Warning: a buffer should not have two parents!");
262 /// So we can force access via the accessors.
263 mutable Buffer
const * parent_buffer
;
267 /// Creates the per buffer temporary directory
268 static FileName
createBufferTmpDir()
271 // We are in our own directory. Why bother to mangle name?
272 // In fact I wrote this code to circumvent a problematic behaviour
273 // (bug?) of EMX mkstemp().
274 FileName
tmpfl(package().temp_dir().absFilename() + "/lyx_tmpbuf" +
275 convert
<string
>(count
++));
277 if (!tmpfl
.createDirectory(0777)) {
278 throw ExceptionMessage(WarningException
, _("Disk Error: "), bformat(
279 _("LyX could not create the temporary directory '%1$s' (Disk is full maybe?)"),
280 from_utf8(tmpfl
.absFilename())));
286 Buffer::Impl::Impl(Buffer
& parent
, FileName
const & file
, bool readonly_
)
287 : lyx_clean(true), bak_clean(true), unnamed(false),
288 read_only(readonly_
), filename(file
), file_fully_loaded(false),
289 toc_backend(&parent
), macro_lock(false), timestamp_(0),
290 checksum_(0), wa_(0), undo_(parent
), bibinfoCacheValid_(false),
293 temppath
= createBufferTmpDir();
294 lyxvc
.setBuffer(&parent
);
296 wa_
= new frontend::WorkAreaManager
;
300 Buffer::Buffer(string
const & file
, bool readonly
)
301 : d(new Impl(*this, FileName(file
), readonly
)), gui_(0)
303 LYXERR(Debug::INFO
, "Buffer::Buffer()");
305 d
->inset
= new InsetText(this);
306 d
->inset
->setAutoBreakRows(true);
307 d
->inset
->getText(0)->setMacrocontextPosition(par_iterator_begin());
313 LYXERR(Debug::INFO
, "Buffer::~Buffer()");
314 // here the buffer should take care that it is
315 // saved properly, before it goes into the void.
317 // GuiView already destroyed
321 // No need to do additional cleanups for internal buffer.
326 // loop over children
327 Impl::BufferPositionMap::iterator it
= d
->children_positions
.begin();
328 Impl::BufferPositionMap::iterator end
= d
->children_positions
.end();
329 for (; it
!= end
; ++it
) {
330 Buffer
* child
= const_cast<Buffer
*>(it
->first
);
331 // The child buffer might have been closed already.
332 if (theBufferList().isLoaded(child
))
333 theBufferList().releaseChild(this, child
);
337 docstring msg
= _("LyX attempted to close a document that had unsaved changes!\n");
338 msg
+= emergencyWrite();
339 frontend::Alert::warning(_("Attempting to close changed document!"), msg
);
342 // clear references to children in macro tables
343 d
->children_positions
.clear();
344 d
->position_to_children
.clear();
346 if (!d
->temppath
.destroyDirectory()) {
347 Alert::warning(_("Could not remove temporary directory"),
348 bformat(_("Could not remove the temporary directory %1$s"),
349 from_utf8(d
->temppath
.absFilename())));
352 // Remove any previewed LaTeX snippets associated with this buffer.
353 thePreviews().removeLoader(*this);
359 void Buffer::changed() const
366 frontend::WorkAreaManager
& Buffer::workAreaManager() const
368 LASSERT(d
->wa_
, /**/);
373 Text
& Buffer::text() const
375 return d
->inset
->text();
379 Inset
& Buffer::inset() const
385 BufferParams
& Buffer::params()
391 BufferParams
const & Buffer::params() const
397 ParagraphList
& Buffer::paragraphs()
399 return text().paragraphs();
403 ParagraphList
const & Buffer::paragraphs() const
405 return text().paragraphs();
409 LyXVC
& Buffer::lyxvc()
415 LyXVC
const & Buffer::lyxvc() const
421 string
const Buffer::temppath() const
423 return d
->temppath
.absFilename();
427 TexRow
& Buffer::texrow()
433 TexRow
const & Buffer::texrow() const
439 TocBackend
& Buffer::tocBackend() const
441 return d
->toc_backend
;
445 Undo
& Buffer::undo()
451 string
Buffer::latexName(bool const no_path
) const
453 FileName latex_name
=
454 makeLatexName(exportFileName());
455 return no_path
? latex_name
.onlyFileName()
456 : latex_name
.absFilename();
460 FileName
Buffer::exportFileName() const
462 docstring
const branch_suffix
=
463 params().branchlist().getFilenameSuffix();
464 if (branch_suffix
.empty())
467 string
const name
= fileName().onlyFileNameWithoutExt()
468 + to_utf8(branch_suffix
);
469 FileName
res(fileName().onlyPath().absFilename() + "/" + name
);
470 res
.changeExtension(fileName().extension());
476 string
Buffer::logName(LogType
* type
) const
478 string
const filename
= latexName(false);
480 if (filename
.empty()) {
486 string
const path
= temppath();
488 FileName
const fname(addName(temppath(),
489 onlyFilename(changeExtension(filename
,
492 // FIXME: how do we know this is the name of the build log?
493 FileName
const bname(
494 addName(path
, onlyFilename(
495 changeExtension(filename
,
496 formats
.extension(bufferFormat()) + ".out"))));
498 // Also consider the master buffer log file
499 FileName masterfname
= fname
;
501 if (masterBuffer() != this) {
502 string
const mlogfile
= masterBuffer()->logName(&mtype
);
503 masterfname
= FileName(mlogfile
);
506 // If no Latex log or Build log is newer, show Build log
507 if (bname
.exists() &&
508 ((!fname
.exists() && !masterfname
.exists())
509 || (fname
.lastModified() < bname
.lastModified()
510 && masterfname
.lastModified() < bname
.lastModified()))) {
511 LYXERR(Debug::FILES
, "Log name calculated as: " << bname
);
514 return bname
.absFilename();
515 // If we have a newer master file log or only a master log, show this
516 } else if (fname
!= masterfname
517 && (!fname
.exists() && (masterfname
.exists()
518 || fname
.lastModified() < masterfname
.lastModified()))) {
519 LYXERR(Debug::FILES
, "Log name calculated as: " << masterfname
);
522 return masterfname
.absFilename();
524 LYXERR(Debug::FILES
, "Log name calculated as: " << fname
);
527 return fname
.absFilename();
531 void Buffer::setReadonly(bool const flag
)
533 if (d
->read_only
!= flag
) {
540 void Buffer::setFileName(string
const & newfile
)
542 d
->filename
= makeAbsPath(newfile
);
543 setReadonly(d
->filename
.isReadOnly());
548 int Buffer::readHeader(Lexer
& lex
)
550 int unknown_tokens
= 0;
552 int begin_header_line
= -1;
554 // Initialize parameters that may be/go lacking in header:
555 params().branchlist().clear();
556 params().preamble
.erase();
557 params().options
.erase();
558 params().master
.erase();
559 params().float_placement
.erase();
560 params().paperwidth
.erase();
561 params().paperheight
.erase();
562 params().leftmargin
.erase();
563 params().rightmargin
.erase();
564 params().topmargin
.erase();
565 params().bottommargin
.erase();
566 params().headheight
.erase();
567 params().headsep
.erase();
568 params().footskip
.erase();
569 params().columnsep
.erase();
570 params().fontsCJK
.erase();
571 params().listings_params
.clear();
572 params().clearLayoutModules();
573 params().clearRemovedModules();
574 params().pdfoptions().clear();
575 params().indiceslist().clear();
576 params().backgroundcolor
= lyx::rgbFromHexName("#ffffff");
578 for (int i
= 0; i
< 4; ++i
) {
579 params().user_defined_bullet(i
) = ITEMIZE_DEFAULTS
[i
];
580 params().temp_bullet(i
) = ITEMIZE_DEFAULTS
[i
];
583 ErrorList
& errorList
= d
->errorLists
["Parse"];
592 if (token
== "\\end_header")
596 if (token
== "\\begin_header") {
597 begin_header_line
= line
;
601 LYXERR(Debug::PARSER
, "Handling document header token: `"
604 string unknown
= params().readToken(lex
, token
, d
->filename
.onlyPath());
605 if (!unknown
.empty()) {
606 if (unknown
[0] != '\\' && token
== "\\textclass") {
607 Alert::warning(_("Unknown document class"),
608 bformat(_("Using the default document class, because the "
609 "class %1$s is unknown."), from_utf8(unknown
)));
612 docstring
const s
= bformat(_("Unknown token: "
616 errorList
.push_back(ErrorItem(_("Document header error"),
621 if (begin_header_line
) {
622 docstring
const s
= _("\\begin_header is missing");
623 errorList
.push_back(ErrorItem(_("Document header error"),
627 params().makeDocumentClass();
629 return unknown_tokens
;
634 // changed to be public and have one parameter
635 // Returns true if "\end_document" is not read (Asger)
636 bool Buffer::readDocument(Lexer
& lex
)
638 ErrorList
& errorList
= d
->errorLists
["Parse"];
641 if (!lex
.checkFor("\\begin_document")) {
642 docstring
const s
= _("\\begin_document is missing");
643 errorList
.push_back(ErrorItem(_("Document header error"),
647 // we are reading in a brand new document
648 LASSERT(paragraphs().empty(), /**/);
652 if (params().outputChanges
) {
653 bool dvipost
= LaTeXFeatures::isAvailable("dvipost");
654 bool xcolorulem
= LaTeXFeatures::isAvailable("ulem") &&
655 LaTeXFeatures::isAvailable("xcolor");
657 if (!dvipost
&& !xcolorulem
) {
658 Alert::warning(_("Changes not shown in LaTeX output"),
659 _("Changes will not be highlighted in LaTeX output, "
660 "because neither dvipost nor xcolor/ulem are installed.\n"
661 "Please install these packages or redefine "
662 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
663 } else if (!xcolorulem
) {
664 Alert::warning(_("Changes not shown in LaTeX output"),
665 _("Changes will not be highlighted in LaTeX output "
666 "when using pdflatex, because xcolor and ulem are not installed.\n"
667 "Please install both packages or redefine "
668 "\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
672 if (!params().master
.empty()) {
673 FileName
const master_file
= makeAbsPath(params().master
,
674 onlyPath(absFileName()));
675 if (isLyXFilename(master_file
.absFilename())) {
677 checkAndLoadLyXFile(master_file
, true);
679 // necessary e.g. after a reload
680 // to re-register the child (bug 5873)
681 // FIXME: clean up updateMacros (here, only
682 // child registering is needed).
683 master
->updateMacros();
684 // set master as master buffer, but only
685 // if we are a real child
686 if (master
->isChild(this))
688 // if the master is not fully loaded
689 // it is probably just loading this
690 // child. No warning needed then.
691 else if (master
->isFullyLoaded())
692 LYXERR0("The master '"
694 << "' assigned to this document ("
696 << ") does not include "
697 "this document. Ignoring the master assignment.");
702 // assure we have a default index
703 params().indiceslist().addDefault(B_("Index"));
706 bool const res
= text().read(lex
, errorList
, d
->inset
);
710 updateMacroInstances();
715 bool Buffer::readString(string
const & s
)
717 params().compressed
= false;
719 // remove dummy empty par
720 paragraphs().clear();
724 FileName
const name
= FileName::tempName("Buffer_readString");
725 switch (readFile(lex
, name
, true)) {
729 // We need to call lyx2lyx, so write the input to a file
730 ofstream
os(name
.toFilesystemEncoding().c_str());
733 return readFile(name
);
743 bool Buffer::readFile(FileName
const & filename
)
745 FileName
fname(filename
);
747 params().compressed
= fname
.isZippedFile();
749 // remove dummy empty par
750 paragraphs().clear();
753 if (readFile(lex
, fname
) != success
)
760 bool Buffer::isFullyLoaded() const
762 return d
->file_fully_loaded
;
766 void Buffer::setFullyLoaded(bool value
)
768 d
->file_fully_loaded
= value
;
772 Buffer::ReadStatus
Buffer::readFile(Lexer
& lex
, FileName
const & filename
,
775 LASSERT(!filename
.empty(), /**/);
777 // the first (non-comment) token _must_ be...
778 if (!lex
.checkFor("\\lyxformat")) {
779 Alert::error(_("Document format failure"),
780 bformat(_("%1$s is not a readable LyX document."),
781 from_utf8(filename
.absFilename())));
787 //lyxerr << "LyX Format: `" << tmp_format << '\'' << endl;
788 // if present remove ".," from string.
789 size_t dot
= tmp_format
.find_first_of(".,");
790 //lyxerr << " dot found at " << dot << endl;
791 if (dot
!= string::npos
)
792 tmp_format
.erase(dot
, 1);
793 int const file_format
= convert
<int>(tmp_format
);
794 //lyxerr << "format: " << file_format << endl;
796 // save timestamp and checksum of the original disk file, making sure
797 // to not overwrite them with those of the file created in the tempdir
798 // when it has to be converted to the current format.
800 // Save the timestamp and checksum of disk file. If filename is an
801 // emergency file, save the timestamp and checksum of the original lyx file
802 // because isExternallyModified will check for this file. (BUG4193)
803 string diskfile
= filename
.absFilename();
804 if (suffixIs(diskfile
, ".emergency"))
805 diskfile
= diskfile
.substr(0, diskfile
.size() - 10);
806 saveCheckSum(FileName(diskfile
));
809 if (file_format
!= LYX_FORMAT
) {
812 // lyx2lyx would fail
815 FileName
const tmpfile
= FileName::tempName("Buffer_readFile");
816 if (tmpfile
.empty()) {
817 Alert::error(_("Conversion failed"),
818 bformat(_("%1$s is from a different"
819 " version of LyX, but a temporary"
820 " file for converting it could"
822 from_utf8(filename
.absFilename())));
825 FileName
const lyx2lyx
= libFileSearch("lyx2lyx", "lyx2lyx");
826 if (lyx2lyx
.empty()) {
827 Alert::error(_("Conversion script not found"),
828 bformat(_("%1$s is from a different"
829 " version of LyX, but the"
830 " conversion script lyx2lyx"
831 " could not be found."),
832 from_utf8(filename
.absFilename())));
835 ostringstream command
;
836 command
<< os::python()
837 << ' ' << quoteName(lyx2lyx
.toFilesystemEncoding())
838 << " -t " << convert
<string
>(LYX_FORMAT
)
839 << " -o " << quoteName(tmpfile
.toFilesystemEncoding())
840 << ' ' << quoteName(filename
.toFilesystemEncoding());
841 string
const command_str
= command
.str();
843 LYXERR(Debug::INFO
, "Running '" << command_str
<< '\'');
845 cmd_ret
const ret
= runCommand(command_str
);
846 if (ret
.first
!= 0) {
847 Alert::error(_("Conversion script failed"),
848 bformat(_("%1$s is from a different version"
849 " of LyX, but the lyx2lyx script"
850 " failed to convert it."),
851 from_utf8(filename
.absFilename())));
854 bool const ret
= readFile(tmpfile
);
855 // Do stuff with tmpfile name and buffer name here.
856 return ret
? success
: failure
;
861 if (readDocument(lex
)) {
862 Alert::error(_("Document format failure"),
863 bformat(_("%1$s ended unexpectedly, which means"
864 " that it is probably corrupted."),
865 from_utf8(filename
.absFilename())));
868 d
->file_fully_loaded
= true;
873 // Should probably be moved to somewhere else: BufferView? LyXView?
874 bool Buffer::save() const
876 // We don't need autosaves in the immediate future. (Asger)
877 resetAutosaveTimers();
879 string
const encodedFilename
= d
->filename
.toFilesystemEncoding();
882 bool madeBackup
= false;
884 // make a backup if the file already exists
885 if (lyxrc
.make_backup
&& fileName().exists()) {
886 backupName
= FileName(absFileName() + '~');
887 if (!lyxrc
.backupdir_path
.empty()) {
888 string
const mangledName
=
889 subst(subst(backupName
.absFilename(), '/', '!'), ':', '!');
890 backupName
= FileName(addName(lyxrc
.backupdir_path
,
893 if (fileName().copyTo(backupName
)) {
896 Alert::error(_("Backup failure"),
897 bformat(_("Cannot create backup file %1$s.\n"
898 "Please check whether the directory exists and is writeable."),
899 from_utf8(backupName
.absFilename())));
900 //LYXERR(Debug::DEBUG, "Fs error: " << fe.what());
904 // ask if the disk file has been externally modified (use checksum method)
905 if (fileName().exists() && isExternallyModified(checksum_method
)) {
906 docstring
const file
= makeDisplayPath(absFileName(), 20);
907 docstring text
= bformat(_("Document %1$s has been externally modified. Are you sure "
908 "you want to overwrite this file?"), file
);
909 int const ret
= Alert::prompt(_("Overwrite modified file?"),
910 text
, 1, 1, _("&Overwrite"), _("&Cancel"));
915 if (writeFile(d
->filename
)) {
919 // Saving failed, so backup is not backup
921 backupName
.moveTo(d
->filename
);
927 bool Buffer::writeFile(FileName
const & fname
) const
929 if (d
->read_only
&& fname
== d
->filename
)
934 docstring
const str
= bformat(_("Saving document %1$s..."),
935 makeDisplayPath(fname
.absFilename()));
938 if (params().compressed
) {
939 gz::ogzstream
ofs(fname
.toFilesystemEncoding().c_str(), ios::out
|ios::trunc
);
940 retval
= ofs
&& write(ofs
);
942 ofstream
ofs(fname
.toFilesystemEncoding().c_str(), ios::out
|ios::trunc
);
943 retval
= ofs
&& write(ofs
);
947 message(str
+ _(" could not write file!"));
951 removeAutosaveFile();
953 saveCheckSum(d
->filename
);
954 message(str
+ _(" done."));
960 docstring
Buffer::emergencyWrite()
962 // No need to save if the buffer has not changed.
966 string
const doc
= isUnnamed() ? onlyFilename(absFileName()) : absFileName();
968 docstring user_message
= bformat(
969 _("LyX: Attempting to save document %1$s\n"), from_utf8(doc
));
971 // We try to save three places:
972 // 1) Same place as document. Unless it is an unnamed doc.
974 string s
= absFileName();
977 if (writeFile(FileName(s
))) {
979 user_message
+= bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s
));
982 user_message
+= _(" Save failed! Trying again...\n");
986 // 2) In HOME directory.
987 string s
= addName(package().home_dir().absFilename(), absFileName());
989 lyxerr
<< ' ' << s
<< endl
;
990 if (writeFile(FileName(s
))) {
992 user_message
+= bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s
));
996 user_message
+= _(" Save failed! Trying yet again...\n");
998 // 3) In "/tmp" directory.
999 // MakeAbsPath to prepend the current
1000 // drive letter on OS/2
1001 s
= addName(package().temp_dir().absFilename(), absFileName());
1003 lyxerr
<< ' ' << s
<< endl
;
1004 if (writeFile(FileName(s
))) {
1006 user_message
+= bformat(_(" Saved to %1$s. Phew.\n"), from_utf8(s
));
1007 return user_message
;
1010 user_message
+= _(" Save failed! Bummer. Document is lost.");
1013 return user_message
;
1017 bool Buffer::write(ostream
& ofs
) const
1020 // Use the standard "C" locale for file output.
1021 ofs
.imbue(locale::classic());
1024 // The top of the file should not be written by params().
1026 // write out a comment in the top of the file
1027 ofs
<< "#LyX " << lyx_version
1028 << " created this file. For more info see http://www.lyx.org/\n"
1029 << "\\lyxformat " << LYX_FORMAT
<< "\n"
1030 << "\\begin_document\n";
1032 /// For each author, set 'used' to true if there is a change
1033 /// by this author in the document; otherwise set it to 'false'.
1034 AuthorList::Authors::const_iterator a_it
= params().authors().begin();
1035 AuthorList::Authors::const_iterator a_end
= params().authors().end();
1036 for (; a_it
!= a_end
; ++a_it
)
1037 a_it
->setUsed(false);
1039 ParIterator
const end
= const_cast<Buffer
*>(this)->par_iterator_end();
1040 ParIterator it
= const_cast<Buffer
*>(this)->par_iterator_begin();
1041 for ( ; it
!= end
; ++it
)
1042 it
->checkAuthors(params().authors());
1044 // now write out the buffer parameters.
1045 ofs
<< "\\begin_header\n";
1046 params().writeFile(ofs
);
1047 ofs
<< "\\end_header\n";
1050 ofs
<< "\n\\begin_body\n";
1052 ofs
<< "\n\\end_body\n";
1054 // Write marker that shows file is complete
1055 ofs
<< "\\end_document" << endl
;
1057 // Shouldn't really be needed....
1060 // how to check if close went ok?
1061 // Following is an attempt... (BE 20001011)
1063 // good() returns false if any error occured, including some
1064 // formatting error.
1065 // bad() returns true if something bad happened in the buffer,
1066 // which should include file system full errors.
1071 lyxerr
<< "File was not closed properly." << endl
;
1078 bool Buffer::makeLaTeXFile(FileName
const & fname
,
1079 string
const & original_path
,
1080 OutputParams
const & runparams_in
,
1081 bool output_preamble
, bool output_body
) const
1083 OutputParams runparams
= runparams_in
;
1084 if (params().useXetex
)
1085 runparams
.flavor
= OutputParams::XETEX
;
1087 string
const encoding
= runparams
.encoding
->iconvName();
1088 LYXERR(Debug::LATEX
, "makeLaTeXFile encoding: " << encoding
<< "...");
1091 try { ofs
.reset(encoding
); }
1092 catch (iconv_codecvt_facet_exception
& e
) {
1093 lyxerr
<< "Caught iconv exception: " << e
.what() << endl
;
1094 Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
1095 "verify that the support software for your encoding (%1$s) is "
1096 "properly installed"), from_ascii(encoding
)));
1099 if (!openFileWrite(ofs
, fname
))
1102 //TexStream ts(ofs.rdbuf(), &texrow());
1103 ErrorList
& errorList
= d
->errorLists
["Export"];
1105 bool failed_export
= false;
1108 writeLaTeXSource(ofs
, original_path
,
1109 runparams
, output_preamble
, output_body
);
1111 catch (EncodingException
& e
) {
1112 odocstringstream ods
;
1113 ods
.put(e
.failed_char
);
1115 oss
<< "0x" << hex
<< e
.failed_char
<< dec
;
1116 docstring msg
= bformat(_("Could not find LaTeX command for character '%1$s'"
1117 " (code point %2$s)"),
1118 ods
.str(), from_utf8(oss
.str()));
1119 errorList
.push_back(ErrorItem(msg
, _("Some characters of your document are probably not "
1120 "representable in the chosen encoding.\n"
1121 "Changing the document encoding to utf8 could help."),
1122 e
.par_id
, e
.pos
, e
.pos
+ 1));
1123 failed_export
= true;
1125 catch (iconv_codecvt_facet_exception
& e
) {
1126 errorList
.push_back(ErrorItem(_("iconv conversion failed"),
1127 _(e
.what()), -1, 0, 0));
1128 failed_export
= true;
1130 catch (exception
const & e
) {
1131 errorList
.push_back(ErrorItem(_("conversion failed"),
1132 _(e
.what()), -1, 0, 0));
1133 failed_export
= true;
1136 lyxerr
<< "Caught some really weird exception..." << endl
;
1142 failed_export
= true;
1143 lyxerr
<< "File '" << fname
<< "' was not closed properly." << endl
;
1147 return !failed_export
;
1151 void Buffer::writeLaTeXSource(odocstream
& os
,
1152 string
const & original_path
,
1153 OutputParams
const & runparams_in
,
1154 bool const output_preamble
, bool const output_body
) const
1156 // The child documents, if any, shall be already loaded at this point.
1158 OutputParams runparams
= runparams_in
;
1160 // Classify the unicode characters appearing in math insets
1161 Encodings::initUnicodeMath(*this);
1163 // validate the buffer.
1164 LYXERR(Debug::LATEX
, " Validating buffer...");
1165 LaTeXFeatures
features(*this, params(), runparams
);
1167 LYXERR(Debug::LATEX
, " Buffer validation done.");
1169 // The starting paragraph of the coming rows is the
1170 // first paragraph of the document. (Asger)
1171 if (output_preamble
&& runparams
.nice
) {
1172 os
<< "%% LyX " << lyx_version
<< " created this file. "
1173 "For more info, see http://www.lyx.org/.\n"
1174 "%% Do not edit unless you really know what "
1176 d
->texrow
.newline();
1177 d
->texrow
.newline();
1179 LYXERR(Debug::INFO
, "lyx document header finished");
1181 // Don't move this behind the parent_buffer=0 code below,
1182 // because then the macros will not get the right "redefinition"
1183 // flag as they don't see the parent macros which are output before.
1186 // fold macros if possible, still with parent buffer as the
1187 // macros will be put in the prefix anyway.
1188 updateMacroInstances();
1190 // There are a few differences between nice LaTeX and usual files:
1191 // usual is \batchmode and has a
1192 // special input@path to allow the including of figures
1193 // with either \input or \includegraphics (what figinsets do).
1194 // input@path is set when the actual parameter
1195 // original_path is set. This is done for usual tex-file, but not
1196 // for nice-latex-file. (Matthias 250696)
1197 // Note that input@path is only needed for something the user does
1198 // in the preamble, included .tex files or ERT, files included by
1199 // LyX work without it.
1200 if (output_preamble
) {
1201 if (!runparams
.nice
) {
1202 // code for usual, NOT nice-latex-file
1203 os
<< "\\batchmode\n"; // changed
1204 // from \nonstopmode
1205 d
->texrow
.newline();
1207 if (!original_path
.empty()) {
1209 // We don't know the encoding of inputpath
1210 docstring
const inputpath
= from_utf8(latex_path(original_path
));
1211 os
<< "\\makeatletter\n"
1212 << "\\def\\input@path{{"
1213 << inputpath
<< "/}}\n"
1214 << "\\makeatother\n";
1215 d
->texrow
.newline();
1216 d
->texrow
.newline();
1217 d
->texrow
.newline();
1220 // get parent macros (if this buffer has a parent) which will be
1221 // written at the document begin further down.
1222 MacroSet parentMacros
;
1223 listParentMacros(parentMacros
, features
);
1225 // Write the preamble
1226 runparams
.use_babel
= params().writeLaTeX(os
, features
, d
->texrow
);
1228 runparams
.use_japanese
= features
.isRequired("japanese");
1234 os
<< "\\begin{document}\n";
1235 d
->texrow
.newline();
1237 // output the parent macros
1238 MacroSet::iterator it
= parentMacros
.begin();
1239 MacroSet::iterator end
= parentMacros
.end();
1240 for (; it
!= end
; ++it
)
1241 (*it
)->write(os
, true);
1242 } // output_preamble
1244 d
->texrow
.start(paragraphs().begin()->id(), 0);
1246 LYXERR(Debug::INFO
, "preamble finished, now the body.");
1248 // if we are doing a real file with body, even if this is the
1249 // child of some other buffer, let's cut the link here.
1250 // This happens for example if only a child document is printed.
1251 Buffer
const * save_parent
= 0;
1252 if (output_preamble
) {
1253 save_parent
= d
->parent();
1258 latexParagraphs(*this, text(), os
, d
->texrow
, runparams
);
1260 // Restore the parenthood if needed
1261 if (output_preamble
)
1262 d
->setParent(save_parent
);
1264 // add this just in case after all the paragraphs
1266 d
->texrow
.newline();
1268 if (output_preamble
) {
1269 os
<< "\\end{document}\n";
1270 d
->texrow
.newline();
1271 LYXERR(Debug::LATEX
, "makeLaTeXFile...done");
1273 LYXERR(Debug::LATEX
, "LaTeXFile for inclusion made.");
1275 runparams_in
.encoding
= runparams
.encoding
;
1277 // Just to be sure. (Asger)
1278 d
->texrow
.newline();
1280 LYXERR(Debug::INFO
, "Finished making LaTeX file.");
1281 LYXERR(Debug::INFO
, "Row count was " << d
->texrow
.rows() - 1 << '.');
1285 bool Buffer::isLatex() const
1287 return params().documentClass().outputType() == LATEX
;
1291 bool Buffer::isLiterate() const
1293 return params().documentClass().outputType() == LITERATE
;
1297 bool Buffer::isDocBook() const
1299 return params().documentClass().outputType() == DOCBOOK
;
1303 void Buffer::makeDocBookFile(FileName
const & fname
,
1304 OutputParams
const & runparams
,
1305 bool const body_only
) const
1307 LYXERR(Debug::LATEX
, "makeDocBookFile...");
1310 if (!openFileWrite(ofs
, fname
))
1313 writeDocBookSource(ofs
, fname
.absFilename(), runparams
, body_only
);
1317 lyxerr
<< "File '" << fname
<< "' was not closed properly." << endl
;
1321 void Buffer::writeDocBookSource(odocstream
& os
, string
const & fname
,
1322 OutputParams
const & runparams
,
1323 bool const only_body
) const
1325 LaTeXFeatures
features(*this, params(), runparams
);
1330 DocumentClass
const & tclass
= params().documentClass();
1331 string
const top_element
= tclass
.latexname();
1334 if (runparams
.flavor
== OutputParams::XML
)
1335 os
<< "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
1338 os
<< "<!DOCTYPE " << from_ascii(top_element
) << ' ';
1341 if (! tclass
.class_header().empty())
1342 os
<< from_ascii(tclass
.class_header());
1343 else if (runparams
.flavor
== OutputParams::XML
)
1344 os
<< "PUBLIC \"-//OASIS//DTD DocBook XML//EN\" "
1345 << "\"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd\"";
1347 os
<< " PUBLIC \"-//OASIS//DTD DocBook V4.2//EN\"";
1349 docstring preamble
= from_utf8(params().preamble
);
1350 if (runparams
.flavor
!= OutputParams::XML
) {
1351 preamble
+= "<!ENTITY % output.print.png \"IGNORE\">\n";
1352 preamble
+= "<!ENTITY % output.print.pdf \"IGNORE\">\n";
1353 preamble
+= "<!ENTITY % output.print.eps \"IGNORE\">\n";
1354 preamble
+= "<!ENTITY % output.print.bmp \"IGNORE\">\n";
1357 string
const name
= runparams
.nice
1358 ? changeExtension(absFileName(), ".sgml") : fname
;
1359 preamble
+= features
.getIncludedFiles(name
);
1360 preamble
+= features
.getLyXSGMLEntities();
1362 if (!preamble
.empty()) {
1363 os
<< "\n [ " << preamble
<< " ]";
1368 string top
= top_element
;
1370 if (runparams
.flavor
== OutputParams::XML
)
1371 top
+= params().language
->code();
1373 top
+= params().language
->code().substr(0, 2);
1376 if (!params().options
.empty()) {
1378 top
+= params().options
;
1381 os
<< "<!-- " << ((runparams
.flavor
== OutputParams::XML
)? "XML" : "SGML")
1382 << " file was created by LyX " << lyx_version
1383 << "\n See http://www.lyx.org/ for more information -->\n";
1385 params().documentClass().counters().reset();
1389 sgml::openTag(os
, top
);
1391 docbookParagraphs(text(), *this, os
, runparams
);
1392 sgml::closeTag(os
, top_element
);
1396 void Buffer::makeLyXHTMLFile(FileName
const & fname
,
1397 OutputParams
const & runparams
,
1398 bool const body_only
) const
1400 LYXERR(Debug::LATEX
, "makeLyXHTMLFile...");
1403 if (!openFileWrite(ofs
, fname
))
1406 writeLyXHTMLSource(ofs
, runparams
, body_only
);
1410 lyxerr
<< "File '" << fname
<< "' was not closed properly." << endl
;
1414 void Buffer::writeLyXHTMLSource(odocstream
& os
,
1415 OutputParams
const & runparams
,
1416 bool const only_body
) const
1418 LaTeXFeatures
features(*this, params(), runparams
);
1424 os
<< "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"" <<
1425 " \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n";
1426 // FIXME Language should be set properly.
1427 os
<< "<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n";
1430 // FIXME Presumably need to set this right
1431 os
<< "<meta http-equiv=\"Content-type\" content=\"text/html;charset=UTF-8\" />\n";
1432 // FIXME Get this during validation? What about other meta-data?
1433 os
<< "<title>TBA</title>\n";
1435 os
<< features
.getTClassHTMLPreamble();
1439 docstring
const styleinfo
= features
.getTClassHTMLStyles();
1440 if (!styleinfo
.empty()) {
1441 os
<< "<style type='text/css'>\n";
1445 os
<< "</head>\n<body>\n";
1448 params().documentClass().counters().reset();
1449 xhtmlParagraphs(text(), *this, os
, runparams
);
1451 os
<< "</body>\n</html>\n";
1455 // chktex should be run with these flags disabled: 3, 22, 25, 30, 38(?)
1456 // Other flags: -wall -v0 -x
1457 int Buffer::runChktex()
1461 // get LaTeX-Filename
1462 FileName
const path(temppath());
1463 string
const name
= addName(path
.absFilename(), latexName());
1464 string
const org_path
= filePath();
1466 PathChanger
p(path
); // path to LaTeX file
1467 message(_("Running chktex..."));
1469 // Generate the LaTeX file if neccessary
1470 OutputParams
runparams(¶ms().encoding());
1471 runparams
.flavor
= OutputParams::LATEX
;
1472 runparams
.nice
= false;
1473 makeLaTeXFile(FileName(name
), org_path
, runparams
);
1476 Chktex
chktex(lyxrc
.chktex_command
, onlyFilename(name
), filePath());
1477 int const res
= chktex
.run(terr
); // run chktex
1480 Alert::error(_("chktex failure"),
1481 _("Could not run chktex successfully."));
1482 } else if (res
> 0) {
1483 ErrorList
& errlist
= d
->errorLists
["ChkTeX"];
1485 bufferErrors(terr
, errlist
);
1496 void Buffer::validate(LaTeXFeatures
& features
) const
1498 params().validate(features
);
1502 for_each(paragraphs().begin(), paragraphs().end(),
1503 boost::bind(&Paragraph::validate
, _1
, boost::ref(features
)));
1505 if (lyxerr
.debugging(Debug::LATEX
)) {
1506 features
.showStruct();
1511 void Buffer::getLabelList(vector
<docstring
> & list
) const
1513 // If this is a child document, use the parent's list instead.
1514 Buffer
const * const pbuf
= d
->parent();
1516 pbuf
->getLabelList(list
);
1521 Toc
& toc
= d
->toc_backend
.toc("label");
1522 TocIterator toc_it
= toc
.begin();
1523 TocIterator end
= toc
.end();
1524 for (; toc_it
!= end
; ++toc_it
) {
1525 if (toc_it
->depth() == 0)
1526 list
.push_back(toc_it
->str());
1531 void Buffer::updateBibfilesCache(UpdateScope scope
) const
1533 // If this is a child document, use the parent's cache instead.
1534 Buffer
const * const pbuf
= d
->parent();
1535 if (pbuf
&& scope
!= UpdateChildOnly
) {
1536 pbuf
->updateBibfilesCache();
1540 d
->bibfilesCache_
.clear();
1541 for (InsetIterator it
= inset_iterator_begin(inset()); it
; ++it
) {
1542 if (it
->lyxCode() == BIBTEX_CODE
) {
1543 InsetBibtex
const & inset
=
1544 static_cast<InsetBibtex
const &>(*it
);
1545 support::FileNameList
const bibfiles
= inset
.getBibFiles();
1546 d
->bibfilesCache_
.insert(d
->bibfilesCache_
.end(),
1549 } else if (it
->lyxCode() == INCLUDE_CODE
) {
1550 InsetInclude
& inset
=
1551 static_cast<InsetInclude
&>(*it
);
1552 inset
.updateBibfilesCache();
1553 support::FileNameList
const & bibfiles
=
1554 inset
.getBibfilesCache();
1555 d
->bibfilesCache_
.insert(d
->bibfilesCache_
.end(),
1560 // the bibinfo cache is now invalid
1561 d
->bibinfoCacheValid_
= false;
1565 void Buffer::invalidateBibinfoCache()
1567 d
->bibinfoCacheValid_
= false;
1571 support::FileNameList
const & Buffer::getBibfilesCache(UpdateScope scope
) const
1573 // If this is a child document, use the parent's cache instead.
1574 Buffer
const * const pbuf
= d
->parent();
1575 if (pbuf
&& scope
!= UpdateChildOnly
)
1576 return pbuf
->getBibfilesCache();
1578 // We update the cache when first used instead of at loading time.
1579 if (d
->bibfilesCache_
.empty())
1580 const_cast<Buffer
*>(this)->updateBibfilesCache(scope
);
1582 return d
->bibfilesCache_
;
1586 BiblioInfo
const & Buffer::masterBibInfo() const
1588 // if this is a child document and the parent is already loaded
1589 // use the parent's list instead [ale990412]
1590 Buffer
const * const tmp
= masterBuffer();
1593 return tmp
->masterBibInfo();
1594 return localBibInfo();
1598 BiblioInfo
const & Buffer::localBibInfo() const
1600 if (d
->bibinfoCacheValid_
) {
1601 support::FileNameList
const & bibfilesCache
= getBibfilesCache();
1602 // compare the cached timestamps with the actual ones.
1603 support::FileNameList::const_iterator ei
= bibfilesCache
.begin();
1604 support::FileNameList::const_iterator en
= bibfilesCache
.end();
1605 for (; ei
!= en
; ++ ei
) {
1606 time_t lastw
= ei
->lastModified();
1607 if (lastw
!= d
->bibfileStatus_
[*ei
]) {
1608 d
->bibinfoCacheValid_
= false;
1609 d
->bibfileStatus_
[*ei
] = lastw
;
1615 if (!d
->bibinfoCacheValid_
) {
1616 d
->bibinfo_
.clear();
1617 for (InsetIterator it
= inset_iterator_begin(inset()); it
; ++it
)
1618 it
->fillWithBibKeys(d
->bibinfo_
, it
);
1619 d
->bibinfoCacheValid_
= true;
1625 bool Buffer::isDepClean(string
const & name
) const
1627 DepClean::const_iterator
const it
= d
->dep_clean
.find(name
);
1628 if (it
== d
->dep_clean
.end())
1634 void Buffer::markDepClean(string
const & name
)
1636 d
->dep_clean
[name
] = true;
1640 bool Buffer::getStatus(FuncRequest
const & cmd
, FuncStatus
& flag
)
1643 // FIXME? if there is an Buffer LFUN that can be dispatched even
1644 // if internal, put a switch '(cmd.action)' here.
1650 switch (cmd
.action
) {
1652 case LFUN_BUFFER_TOGGLE_READ_ONLY
:
1653 flag
.setOnOff(isReadonly());
1656 // FIXME: There is need for a command-line import.
1657 //case LFUN_BUFFER_IMPORT:
1659 case LFUN_BUFFER_AUTO_SAVE
:
1662 case LFUN_BUFFER_EXPORT_CUSTOM
:
1663 // FIXME: Nothing to check here?
1666 case LFUN_BUFFER_EXPORT
: {
1667 docstring
const arg
= cmd
.argument();
1668 enable
= arg
== "custom" || isExportable(to_utf8(arg
));
1670 flag
.message(bformat(
1671 _("Don't know how to export to format: %1$s"), arg
));
1675 case LFUN_MASTER_BUFFER_UPDATE
:
1676 case LFUN_MASTER_BUFFER_VIEW
:
1677 enable
= parent() != 0;
1679 case LFUN_BUFFER_UPDATE
:
1680 case LFUN_BUFFER_VIEW
: {
1681 string format
= to_utf8(cmd
.argument());
1682 if (cmd
.argument().empty())
1683 format
= getDefaultOutputFormat();
1684 typedef vector
<Format
const *> Formats
;
1686 formats
= exportableFormats(true);
1687 Formats::const_iterator fit
= formats
.begin();
1688 Formats::const_iterator end
= formats
.end();
1690 for (; fit
!= end
; ++fit
) {
1691 if ((*fit
)->name() == format
)
1696 case LFUN_BUFFER_CHKTEX
:
1697 enable
= isLatex() && !lyxrc
.chktex_command
.empty();
1700 case LFUN_BUILD_PROGRAM
:
1701 enable
= isExportable("program");
1704 case LFUN_BRANCH_ACTIVATE
:
1705 case LFUN_BRANCH_DEACTIVATE
: {
1706 BranchList
const & branchList
= params().branchlist();
1707 docstring
const branchName
= cmd
.argument();
1708 enable
= !branchName
.empty() && branchList
.find(branchName
);
1712 case LFUN_BRANCH_ADD
:
1713 case LFUN_BRANCHES_RENAME
:
1714 case LFUN_BUFFER_PRINT
:
1715 // if no Buffer is present, then of course we won't be called!
1718 case LFUN_BUFFER_LANGUAGE
:
1719 enable
= !isReadonly();
1725 flag
.setEnabled(enable
);
1730 void Buffer::dispatch(string
const & command
, DispatchResult
& result
)
1732 return dispatch(lyxaction
.lookupFunc(command
), result
);
1736 // NOTE We can end up here even if we have no GUI, because we are called
1737 // by LyX::exec to handled command-line requests. So we may need to check
1738 // whether we have a GUI or not. The boolean use_gui holds this information.
1739 void Buffer::dispatch(FuncRequest
const & func
, DispatchResult
& dr
)
1742 // FIXME? if there is an Buffer LFUN that can be dispatched even
1743 // if internal, put a switch '(cmd.action)' here.
1744 dr
.dispatched(false);
1747 string
const argument
= to_utf8(func
.argument());
1748 // We'll set this back to false if need be.
1749 bool dispatched
= true;
1750 undo().beginUndoGroup();
1752 switch (func
.action
) {
1753 case LFUN_BUFFER_TOGGLE_READ_ONLY
:
1754 if (lyxvc().inUse())
1755 lyxvc().toggleReadOnly();
1757 setReadonly(!isReadonly());
1760 case LFUN_BUFFER_EXPORT
: {
1761 if (argument
== "custom") {
1762 lyx::dispatch(FuncRequest(LFUN_DIALOG_SHOW
, "sendto"));
1765 doExport(argument
, false);
1766 bool success
= doExport(argument
, false);
1767 dr
.setError(success
);
1769 dr
.setMessage(bformat(_("Error exporting to format: %1$s."),
1774 case LFUN_BUFFER_UPDATE
: {
1775 string format
= argument
;
1776 if (argument
.empty())
1777 format
= getDefaultOutputFormat();
1778 doExport(format
, true);
1782 case LFUN_BUFFER_VIEW
: {
1783 string format
= argument
;
1784 if (argument
.empty())
1785 format
= getDefaultOutputFormat();
1790 case LFUN_MASTER_BUFFER_UPDATE
: {
1791 string format
= argument
;
1792 if (argument
.empty())
1793 format
= masterBuffer()->getDefaultOutputFormat();
1794 masterBuffer()->doExport(format
, true);
1798 case LFUN_MASTER_BUFFER_VIEW
: {
1799 string format
= argument
;
1800 if (argument
.empty())
1801 format
= masterBuffer()->getDefaultOutputFormat();
1802 masterBuffer()->preview(format
);
1806 case LFUN_BUILD_PROGRAM
:
1807 doExport("program", true);
1810 case LFUN_BUFFER_CHKTEX
:
1814 case LFUN_BUFFER_EXPORT_CUSTOM
: {
1816 string command
= split(argument
, format_name
, ' ');
1817 Format
const * format
= formats
.getFormat(format_name
);
1819 lyxerr
<< "Format \"" << format_name
1820 << "\" not recognized!"
1825 // The name of the file created by the conversion process
1828 // Output to filename
1829 if (format
->name() == "lyx") {
1830 string
const latexname
= latexName(false);
1831 filename
= changeExtension(latexname
,
1832 format
->extension());
1833 filename
= addName(temppath(), filename
);
1835 if (!writeFile(FileName(filename
)))
1839 doExport(format_name
, true, filename
);
1842 // Substitute $$FName for filename
1843 if (!contains(command
, "$$FName"))
1844 command
= "( " + command
+ " ) < $$FName";
1845 command
= subst(command
, "$$FName", filename
);
1847 // Execute the command in the background
1849 call
.startscript(Systemcall::DontWait
, command
);
1853 // FIXME: There is need for a command-line import.
1855 case LFUN_BUFFER_IMPORT:
1860 case LFUN_BUFFER_AUTO_SAVE
:
1864 case LFUN_BRANCH_ADD
: {
1865 docstring
const branch_name
= func
.argument();
1866 if (branch_name
.empty()) {
1870 BranchList
& branch_list
= params().branchlist();
1871 Branch
* branch
= branch_list
.find(branch_name
);
1873 LYXERR0("Branch " << branch_name
<< " already exists.");
1875 docstring
const msg
=
1876 bformat(_("Branch \"%1$s\" already exists."), branch_name
);
1879 branch_list
.add(branch_name
);
1880 branch
= branch_list
.find(branch_name
);
1881 string
const x11hexname
= X11hexname(branch
->color());
1882 docstring
const str
= branch_name
+ ' ' + from_ascii(x11hexname
);
1883 lyx::dispatch(FuncRequest(LFUN_SET_COLOR
, str
));
1885 dr
.update(Update::Force
);
1890 case LFUN_BRANCH_ACTIVATE
:
1891 case LFUN_BRANCH_DEACTIVATE
: {
1892 BranchList
& branchList
= params().branchlist();
1893 docstring
const branchName
= func
.argument();
1894 // the case without a branch name is handled elsewhere
1895 if (branchName
.empty()) {
1899 Branch
* branch
= branchList
.find(branchName
);
1901 LYXERR0("Branch " << branchName
<< " does not exist.");
1903 docstring
const msg
=
1904 bformat(_("Branch \"%1$s\" does not exist."), branchName
);
1907 branch
->setSelected(func
.action
== LFUN_BRANCH_ACTIVATE
);
1909 dr
.update(Update::Force
);
1914 case LFUN_BRANCHES_RENAME
: {
1915 if (func
.argument().empty())
1918 docstring
const oldname
= from_utf8(func
.getArg(0));
1919 docstring
const newname
= from_utf8(func
.getArg(1));
1920 InsetIterator it
= inset_iterator_begin(inset());
1921 InsetIterator
const end
= inset_iterator_end(inset());
1922 bool success
= false;
1923 for (; it
!= end
; ++it
) {
1924 if (it
->lyxCode() == BRANCH_CODE
) {
1925 InsetBranch
& ins
= static_cast<InsetBranch
&>(*it
);
1926 if (ins
.branch() == oldname
) {
1927 undo().recordUndo(it
);
1928 ins
.rename(newname
);
1933 if (it
->lyxCode() == INCLUDE_CODE
) {
1934 // get buffer of external file
1935 InsetInclude
const & ins
=
1936 static_cast<InsetInclude
const &>(*it
);
1937 Buffer
* child
= ins
.getChildBuffer();
1940 child
->dispatch(func
, dr
);
1945 dr
.update(Update::Force
);
1949 case LFUN_BUFFER_PRINT
: {
1950 // we'll assume there's a problem until we succeed
1952 string target
= func
.getArg(0);
1953 string target_name
= func
.getArg(1);
1954 string command
= func
.getArg(2);
1957 || target_name
.empty()
1958 || command
.empty()) {
1959 LYXERR0("Unable to parse " << func
.argument());
1960 docstring
const msg
=
1961 bformat(_("Unable to parse \"%1$s\""), func
.argument());
1965 if (target
!= "printer" && target
!= "file") {
1966 LYXERR0("Unrecognized target \"" << target
<< '"');
1967 docstring
const msg
=
1968 bformat(_("Unrecognized target \"%1$s\""), from_utf8(target
));
1973 if (!doExport("dvi", true)) {
1974 showPrintError(absFileName());
1975 dr
.setMessage(_("Error exporting to DVI."));
1979 // Push directory path.
1980 string
const path
= temppath();
1981 // Prevent the compiler from optimizing away p
1985 // there are three cases here:
1986 // 1. we print to a file
1987 // 2. we print directly to a printer
1988 // 3. we print using a spool command (print to file first)
1991 string
const dviname
= changeExtension(latexName(true), "dvi");
1993 if (target
== "printer") {
1994 if (!lyxrc
.print_spool_command
.empty()) {
1995 // case 3: print using a spool
1996 string
const psname
= changeExtension(dviname
,".ps");
1997 command
+= ' ' + lyxrc
.print_to_file
2000 + quoteName(dviname
);
2002 string command2
= lyxrc
.print_spool_command
+ ' ';
2003 if (target_name
!= "default") {
2004 command2
+= lyxrc
.print_spool_printerprefix
2008 command2
+= quoteName(psname
);
2010 // If successful, then spool command
2011 res
= one
.startscript(Systemcall::Wait
, command
);
2014 // If there's no GUI, we have to wait on this command. Otherwise,
2015 // LyX deletes the temporary directory, and with it the spooled
2016 // file, before it can be printed!!
2017 Systemcall::Starttype stype
= use_gui
?
2018 Systemcall::DontWait
: Systemcall::Wait
;
2019 res
= one
.startscript(stype
, command2
);
2022 // case 2: print directly to a printer
2023 if (target_name
!= "default")
2024 command
+= ' ' + lyxrc
.print_to_printer
+ target_name
+ ' ';
2026 Systemcall::Starttype stype
= use_gui
?
2027 Systemcall::DontWait
: Systemcall::Wait
;
2028 res
= one
.startscript(stype
, command
+ quoteName(dviname
));
2032 // case 1: print to a file
2033 FileName
const filename(makeAbsPath(target_name
, filePath()));
2034 FileName
const dvifile(makeAbsPath(dviname
, path
));
2035 if (filename
.exists()) {
2036 docstring text
= bformat(
2037 _("The file %1$s already exists.\n\n"
2038 "Do you want to overwrite that file?"),
2039 makeDisplayPath(filename
.absFilename()));
2040 if (Alert::prompt(_("Overwrite file?"),
2041 text
, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
2044 command
+= ' ' + lyxrc
.print_to_file
2045 + quoteName(filename
.toFilesystemEncoding())
2047 + quoteName(dvifile
.toFilesystemEncoding());
2049 Systemcall::Starttype stype
= use_gui
?
2050 Systemcall::DontWait
: Systemcall::Wait
;
2051 res
= one
.startscript(stype
, command
);
2057 dr
.setMessage(_("Error running external commands."));
2058 showPrintError(absFileName());
2063 case LFUN_BUFFER_LANGUAGE
: {
2064 Language
const * oldL
= params().language
;
2065 Language
const * newL
= languages
.getLanguage(argument
);
2066 if (!newL
|| oldL
== newL
)
2068 if (oldL
->rightToLeft() == newL
->rightToLeft() && !isMultiLingual())
2069 changeLanguage(oldL
, newL
);
2077 dr
.dispatched(dispatched
);
2078 undo().endUndoGroup();
2082 void Buffer::changeLanguage(Language
const * from
, Language
const * to
)
2084 LASSERT(from
, /**/);
2087 for_each(par_iterator_begin(),
2089 bind(&Paragraph::changeLanguage
, _1
, params(), from
, to
));
2093 bool Buffer::isMultiLingual() const
2095 ParConstIterator end
= par_iterator_end();
2096 for (ParConstIterator it
= par_iterator_begin(); it
!= end
; ++it
)
2097 if (it
->isMultiLingual(params()))
2104 DocIterator
Buffer::getParFromID(int const id
) const
2106 Buffer
* buf
= const_cast<Buffer
*>(this);
2108 // John says this is called with id == -1 from undo
2109 lyxerr
<< "getParFromID(), id: " << id
<< endl
;
2110 return doc_iterator_end(buf
);
2113 for (DocIterator it
= doc_iterator_begin(buf
); !it
.atEnd(); it
.forwardPar())
2114 if (it
.paragraph().id() == id
)
2117 return doc_iterator_end(buf
);
2121 bool Buffer::hasParWithID(int const id
) const
2123 return !getParFromID(id
).atEnd();
2127 ParIterator
Buffer::par_iterator_begin()
2129 return ParIterator(doc_iterator_begin(this));
2133 ParIterator
Buffer::par_iterator_end()
2135 return ParIterator(doc_iterator_end(this));
2139 ParConstIterator
Buffer::par_iterator_begin() const
2141 return ParConstIterator(doc_iterator_begin(this));
2145 ParConstIterator
Buffer::par_iterator_end() const
2147 return ParConstIterator(doc_iterator_end(this));
2151 Language
const * Buffer::language() const
2153 return params().language
;
2157 docstring
const Buffer::B_(string
const & l10n
) const
2159 return params().B_(l10n
);
2163 bool Buffer::isClean() const
2165 return d
->lyx_clean
;
2169 bool Buffer::isBakClean() const
2171 return d
->bak_clean
;
2175 bool Buffer::isExternallyModified(CheckMethod method
) const
2177 LASSERT(d
->filename
.exists(), /**/);
2178 // if method == timestamp, check timestamp before checksum
2179 return (method
== checksum_method
2180 || d
->timestamp_
!= d
->filename
.lastModified())
2181 && d
->checksum_
!= d
->filename
.checksum();
2185 void Buffer::saveCheckSum(FileName
const & file
) const
2187 if (file
.exists()) {
2188 d
->timestamp_
= file
.lastModified();
2189 d
->checksum_
= file
.checksum();
2191 // in the case of save to a new file.
2198 void Buffer::markClean() const
2200 if (!d
->lyx_clean
) {
2201 d
->lyx_clean
= true;
2204 // if the .lyx file has been saved, we don't need an
2206 d
->bak_clean
= true;
2210 void Buffer::markBakClean() const
2212 d
->bak_clean
= true;
2216 void Buffer::setUnnamed(bool flag
)
2222 bool Buffer::isUnnamed() const
2229 /// Don't check unnamed, here: isInternal() is used in
2230 /// newBuffer(), where the unnamed flag has not been set by anyone
2231 /// yet. Also, for an internal buffer, there should be no need for
2232 /// retrieving fileName() nor for checking if it is unnamed or not.
2233 bool Buffer::isInternal() const
2235 return fileName().extension() == "internal";
2239 void Buffer::markDirty()
2242 d
->lyx_clean
= false;
2245 d
->bak_clean
= false;
2247 DepClean::iterator it
= d
->dep_clean
.begin();
2248 DepClean::const_iterator
const end
= d
->dep_clean
.end();
2250 for (; it
!= end
; ++it
)
2255 FileName
Buffer::fileName() const
2261 string
Buffer::absFileName() const
2263 return d
->filename
.absFilename();
2267 string
Buffer::filePath() const
2269 return d
->filename
.onlyPath().absFilename() + "/";
2273 bool Buffer::isReadonly() const
2275 return d
->read_only
;
2279 void Buffer::setParent(Buffer
const * buffer
)
2281 // Avoids recursive include.
2282 d
->setParent(buffer
== this ? 0 : buffer
);
2287 Buffer
const * Buffer::parent() const
2293 void Buffer::collectRelatives(BufferSet
& bufs
) const
2297 parent()->collectRelatives(bufs
);
2299 // loop over children
2300 Impl::BufferPositionMap::iterator it
= d
->children_positions
.begin();
2301 Impl::BufferPositionMap::iterator end
= d
->children_positions
.end();
2302 for (; it
!= end
; ++it
)
2303 bufs
.insert(const_cast<Buffer
*>(it
->first
));
2307 std::vector
<Buffer
const *> Buffer::allRelatives() const
2310 collectRelatives(bufs
);
2311 BufferSet::iterator it
= bufs
.begin();
2312 std::vector
<Buffer
const *> ret
;
2313 for (; it
!= bufs
.end(); ++it
)
2319 Buffer
const * Buffer::masterBuffer() const
2321 Buffer
const * const pbuf
= d
->parent();
2325 return pbuf
->masterBuffer();
2329 bool Buffer::isChild(Buffer
* child
) const
2331 return d
->children_positions
.find(child
) != d
->children_positions
.end();
2335 DocIterator
Buffer::firstChildPosition(Buffer
const * child
)
2337 Impl::BufferPositionMap::iterator it
;
2338 it
= d
->children_positions
.find(child
);
2339 if (it
== d
->children_positions
.end())
2340 return DocIterator(this);
2345 std::vector
<Buffer
*> Buffer::getChildren(bool grand_children
) const
2347 std::vector
<Buffer
*> clist
;
2348 // loop over children
2349 Impl::BufferPositionMap::iterator it
= d
->children_positions
.begin();
2350 Impl::BufferPositionMap::iterator end
= d
->children_positions
.end();
2351 for (; it
!= end
; ++it
) {
2352 Buffer
* child
= const_cast<Buffer
*>(it
->first
);
2353 clist
.push_back(child
);
2354 if (grand_children
) {
2355 // there might be grandchildren
2356 std::vector
<Buffer
*> glist
= child
->getChildren();
2357 for (vector
<Buffer
*>::const_iterator git
= glist
.begin();
2358 git
!= glist
.end(); ++git
)
2359 clist
.push_back(*git
);
2366 template<typename M
>
2367 typename
M::iterator
greatest_below(M
& m
, typename
M::key_type
const & x
)
2372 typename
M::iterator it
= m
.lower_bound(x
);
2373 if (it
== m
.begin())
2381 MacroData
const * Buffer::getBufferMacro(docstring
const & name
,
2382 DocIterator
const & pos
) const
2384 LYXERR(Debug::MACROS
, "Searching for " << to_ascii(name
) << " at " << pos
);
2386 // if paragraphs have no macro context set, pos will be empty
2390 // we haven't found anything yet
2391 DocIterator bestPos
= par_iterator_begin();
2392 MacroData
const * bestData
= 0;
2394 // find macro definitions for name
2395 Impl::NamePositionScopeMacroMap::iterator nameIt
2396 = d
->macros
.find(name
);
2397 if (nameIt
!= d
->macros
.end()) {
2398 // find last definition in front of pos or at pos itself
2399 Impl::PositionScopeMacroMap::const_iterator it
2400 = greatest_below(nameIt
->second
, pos
);
2401 if (it
!= nameIt
->second
.end()) {
2403 // scope ends behind pos?
2404 if (pos
< it
->second
.first
) {
2405 // Looks good, remember this. If there
2406 // is no external macro behind this,
2407 // we found the right one already.
2408 bestPos
= it
->first
;
2409 bestData
= &it
->second
.second
;
2413 // try previous macro if there is one
2414 if (it
== nameIt
->second
.begin())
2421 // find macros in included files
2422 Impl::PositionScopeBufferMap::const_iterator it
2423 = greatest_below(d
->position_to_children
, pos
);
2424 if (it
== d
->position_to_children
.end())
2425 // no children before
2429 // do we know something better (i.e. later) already?
2430 if (it
->first
< bestPos
)
2433 // scope ends behind pos?
2434 if (pos
< it
->second
.first
) {
2435 // look for macro in external file
2436 d
->macro_lock
= true;
2437 MacroData
const * data
2438 = it
->second
.second
->getMacro(name
, false);
2439 d
->macro_lock
= false;
2441 bestPos
= it
->first
;
2447 // try previous file if there is one
2448 if (it
== d
->position_to_children
.begin())
2453 // return the best macro we have found
2458 MacroData
const * Buffer::getMacro(docstring
const & name
,
2459 DocIterator
const & pos
, bool global
) const
2464 // query buffer macros
2465 MacroData
const * data
= getBufferMacro(name
, pos
);
2469 // If there is a master buffer, query that
2470 Buffer
const * const pbuf
= d
->parent();
2472 d
->macro_lock
= true;
2473 MacroData
const * macro
= pbuf
->getMacro(
2474 name
, *this, false);
2475 d
->macro_lock
= false;
2481 data
= MacroTable::globalMacros().get(name
);
2490 MacroData
const * Buffer::getMacro(docstring
const & name
, bool global
) const
2492 // set scope end behind the last paragraph
2493 DocIterator scope
= par_iterator_begin();
2494 scope
.pit() = scope
.lastpit() + 1;
2496 return getMacro(name
, scope
, global
);
2500 MacroData
const * Buffer::getMacro(docstring
const & name
,
2501 Buffer
const & child
, bool global
) const
2503 // look where the child buffer is included first
2504 Impl::BufferPositionMap::iterator it
= d
->children_positions
.find(&child
);
2505 if (it
== d
->children_positions
.end())
2508 // check for macros at the inclusion position
2509 return getMacro(name
, it
->second
, global
);
2513 void Buffer::updateMacros(DocIterator
& it
, DocIterator
& scope
) const
2515 pit_type lastpit
= it
.lastpit();
2517 // look for macros in each paragraph
2518 while (it
.pit() <= lastpit
) {
2519 Paragraph
& par
= it
.paragraph();
2521 // iterate over the insets of the current paragraph
2522 InsetList
const & insets
= par
.insetList();
2523 InsetList::const_iterator iit
= insets
.begin();
2524 InsetList::const_iterator end
= insets
.end();
2525 for (; iit
!= end
; ++iit
) {
2526 it
.pos() = iit
->pos
;
2528 // is it a nested text inset?
2529 if (iit
->inset
->asInsetText()) {
2530 // Inset needs its own scope?
2531 InsetText
const * itext
= iit
->inset
->asInsetText();
2532 bool newScope
= itext
->isMacroScope();
2534 // scope which ends just behind the inset
2535 DocIterator insetScope
= it
;
2538 // collect macros in inset
2539 it
.push_back(CursorSlice(*iit
->inset
));
2540 updateMacros(it
, newScope
? insetScope
: scope
);
2545 // is it an external file?
2546 if (iit
->inset
->lyxCode() == INCLUDE_CODE
) {
2547 // get buffer of external file
2548 InsetInclude
const & inset
=
2549 static_cast<InsetInclude
const &>(*iit
->inset
);
2550 d
->macro_lock
= true;
2551 Buffer
* child
= inset
.getChildBuffer();
2552 d
->macro_lock
= false;
2556 // register its position, but only when it is
2557 // included first in the buffer
2558 if (d
->children_positions
.find(child
) ==
2559 d
->children_positions
.end())
2560 d
->children_positions
[child
] = it
;
2562 // register child with its scope
2563 d
->position_to_children
[it
] = Impl::ScopeBuffer(scope
, child
);
2567 if (iit
->inset
->lyxCode() != MATHMACRO_CODE
)
2571 MathMacroTemplate
& macroTemplate
=
2572 static_cast<MathMacroTemplate
&>(*iit
->inset
);
2573 MacroContext
mc(this, it
);
2574 macroTemplate
.updateToContext(mc
);
2577 bool valid
= macroTemplate
.validMacro();
2578 // FIXME: Should be fixNameAndCheckIfValid() in fact,
2579 // then the BufferView's cursor will be invalid in
2580 // some cases which leads to crashes.
2585 // FIXME (Abdel), I don't understandt why we pass 'it' here
2586 // instead of 'macroTemplate' defined above... is this correct?
2587 d
->macros
[macroTemplate
.name()][it
] =
2588 Impl::ScopeMacro(scope
, MacroData(const_cast<Buffer
*>(this), it
));
2598 void Buffer::updateMacros() const
2603 LYXERR(Debug::MACROS
, "updateMacro of " << d
->filename
.onlyFileName());
2605 // start with empty table
2607 d
->children_positions
.clear();
2608 d
->position_to_children
.clear();
2610 // Iterate over buffer, starting with first paragraph
2611 // The scope must be bigger than any lookup DocIterator
2612 // later. For the global lookup, lastpit+1 is used, hence
2613 // we use lastpit+2 here.
2614 DocIterator it
= par_iterator_begin();
2615 DocIterator outerScope
= it
;
2616 outerScope
.pit() = outerScope
.lastpit() + 2;
2617 updateMacros(it
, outerScope
);
2621 void Buffer::getUsedBranches(std::list
<docstring
> & result
, bool const from_master
) const
2623 InsetIterator it
= inset_iterator_begin(inset());
2624 InsetIterator
const end
= inset_iterator_end(inset());
2625 for (; it
!= end
; ++it
) {
2626 if (it
->lyxCode() == BRANCH_CODE
) {
2627 InsetBranch
& br
= static_cast<InsetBranch
&>(*it
);
2628 docstring
const name
= br
.branch();
2629 if (!from_master
&& !params().branchlist().find(name
))
2630 result
.push_back(name
);
2631 else if (from_master
&& !masterBuffer()->params().branchlist().find(name
))
2632 result
.push_back(name
);
2635 if (it
->lyxCode() == INCLUDE_CODE
) {
2636 // get buffer of external file
2637 InsetInclude
const & ins
=
2638 static_cast<InsetInclude
const &>(*it
);
2639 Buffer
* child
= ins
.getChildBuffer();
2642 child
->getUsedBranches(result
, true);
2645 // remove duplicates
2650 void Buffer::updateMacroInstances() const
2652 LYXERR(Debug::MACROS
, "updateMacroInstances for "
2653 << d
->filename
.onlyFileName());
2654 DocIterator it
= doc_iterator_begin(this);
2655 DocIterator end
= doc_iterator_end(this);
2656 for (; it
!= end
; it
.forwardPos()) {
2657 // look for MathData cells in InsetMathNest insets
2658 Inset
* inset
= it
.nextInset();
2662 InsetMath
* minset
= inset
->asInsetMath();
2666 // update macro in all cells of the InsetMathNest
2667 DocIterator::idx_type n
= minset
->nargs();
2668 MacroContext mc
= MacroContext(this, it
);
2669 for (DocIterator::idx_type i
= 0; i
< n
; ++i
) {
2670 MathData
& data
= minset
->cell(i
);
2671 data
.updateMacros(0, mc
);
2677 void Buffer::listMacroNames(MacroNameSet
& macros
) const
2682 d
->macro_lock
= true;
2684 // loop over macro names
2685 Impl::NamePositionScopeMacroMap::iterator nameIt
= d
->macros
.begin();
2686 Impl::NamePositionScopeMacroMap::iterator nameEnd
= d
->macros
.end();
2687 for (; nameIt
!= nameEnd
; ++nameIt
)
2688 macros
.insert(nameIt
->first
);
2690 // loop over children
2691 Impl::BufferPositionMap::iterator it
= d
->children_positions
.begin();
2692 Impl::BufferPositionMap::iterator end
= d
->children_positions
.end();
2693 for (; it
!= end
; ++it
)
2694 it
->first
->listMacroNames(macros
);
2697 Buffer
const * const pbuf
= d
->parent();
2699 pbuf
->listMacroNames(macros
);
2701 d
->macro_lock
= false;
2705 void Buffer::listParentMacros(MacroSet
& macros
, LaTeXFeatures
& features
) const
2707 Buffer
const * const pbuf
= d
->parent();
2712 pbuf
->listMacroNames(names
);
2715 MacroNameSet::iterator it
= names
.begin();
2716 MacroNameSet::iterator end
= names
.end();
2717 for (; it
!= end
; ++it
) {
2719 MacroData
const * data
=
2720 pbuf
->getMacro(*it
, *this, false);
2722 macros
.insert(data
);
2724 // we cannot access the original MathMacroTemplate anymore
2725 // here to calls validate method. So we do its work here manually.
2726 // FIXME: somehow make the template accessible here.
2727 if (data
->optionals() > 0)
2728 features
.require("xargs");
2734 Buffer::References
& Buffer::references(docstring
const & label
)
2737 return const_cast<Buffer
*>(masterBuffer())->references(label
);
2739 RefCache::iterator it
= d
->ref_cache_
.find(label
);
2740 if (it
!= d
->ref_cache_
.end())
2741 return it
->second
.second
;
2743 static InsetLabel
const * dummy_il
= 0;
2744 static References
const dummy_refs
;
2745 it
= d
->ref_cache_
.insert(
2746 make_pair(label
, make_pair(dummy_il
, dummy_refs
))).first
;
2747 return it
->second
.second
;
2751 Buffer::References
const & Buffer::references(docstring
const & label
) const
2753 return const_cast<Buffer
*>(this)->references(label
);
2757 void Buffer::setInsetLabel(docstring
const & label
, InsetLabel
const * il
)
2759 masterBuffer()->d
->ref_cache_
[label
].first
= il
;
2763 InsetLabel
const * Buffer::insetLabel(docstring
const & label
) const
2765 return masterBuffer()->d
->ref_cache_
[label
].first
;
2769 void Buffer::clearReferenceCache() const
2772 d
->ref_cache_
.clear();
2776 void Buffer::changeRefsIfUnique(docstring
const & from
, docstring
const & to
,
2779 //FIXME: This does not work for child documents yet.
2780 LASSERT(code
== CITE_CODE
, /**/);
2781 // Check if the label 'from' appears more than once
2782 vector
<docstring
> labels
;
2784 BiblioInfo
const & keys
= masterBibInfo();
2785 BiblioInfo::const_iterator bit
= keys
.begin();
2786 BiblioInfo::const_iterator bend
= keys
.end();
2788 for (; bit
!= bend
; ++bit
)
2790 labels
.push_back(bit
->first
);
2793 if (count(labels
.begin(), labels
.end(), from
) > 1)
2796 for (InsetIterator it
= inset_iterator_begin(inset()); it
; ++it
) {
2797 if (it
->lyxCode() == code
) {
2798 InsetCommand
& inset
= static_cast<InsetCommand
&>(*it
);
2799 docstring
const oldValue
= inset
.getParam(paramName
);
2800 if (oldValue
== from
)
2801 inset
.setParam(paramName
, to
);
2807 void Buffer::getSourceCode(odocstream
& os
, pit_type par_begin
,
2808 pit_type par_end
, bool full_source
) const
2810 OutputParams
runparams(¶ms().encoding());
2811 runparams
.nice
= true;
2812 runparams
.flavor
= params().useXetex
?
2813 OutputParams::XETEX
: OutputParams::LATEX
;
2814 runparams
.linelen
= lyxrc
.plaintext_linelen
;
2815 // No side effect of file copying and image conversion
2816 runparams
.dryrun
= true;
2819 os
<< "% " << _("Preview source code") << "\n\n";
2821 d
->texrow
.newline();
2822 d
->texrow
.newline();
2824 writeDocBookSource(os
, absFileName(), runparams
, false);
2826 // latex or literate
2827 writeLaTeXSource(os
, string(), runparams
, true, true);
2829 runparams
.par_begin
= par_begin
;
2830 runparams
.par_end
= par_end
;
2831 if (par_begin
+ 1 == par_end
) {
2833 << bformat(_("Preview source code for paragraph %1$d"), par_begin
)
2837 << bformat(_("Preview source code from paragraph %1$s to %2$s"),
2838 convert
<docstring
>(par_begin
),
2839 convert
<docstring
>(par_end
- 1))
2846 // output paragraphs
2848 docbookParagraphs(text(), *this, os
, runparams
);
2850 // latex or literate
2851 latexParagraphs(*this, text(), os
, texrow
, runparams
);
2856 ErrorList
& Buffer::errorList(string
const & type
) const
2858 static ErrorList emptyErrorList
;
2859 map
<string
, ErrorList
>::iterator I
= d
->errorLists
.find(type
);
2860 if (I
== d
->errorLists
.end())
2861 return emptyErrorList
;
2867 void Buffer::updateTocItem(std::string
const & type
,
2868 DocIterator
const & dit
) const
2871 gui_
->updateTocItem(type
, dit
);
2875 void Buffer::structureChanged() const
2878 gui_
->structureChanged();
2882 void Buffer::errors(string
const & err
, bool from_master
) const
2885 gui_
->errors(err
, from_master
);
2889 void Buffer::message(docstring
const & msg
) const
2896 void Buffer::setBusy(bool on
) const
2903 void Buffer::setReadOnly(bool on
) const
2906 d
->wa_
->setReadOnly(on
);
2910 void Buffer::updateTitles() const
2913 d
->wa_
->updateTitles();
2917 void Buffer::resetAutosaveTimers() const
2920 gui_
->resetAutosaveTimers();
2924 bool Buffer::hasGuiDelegate() const
2930 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate
* gui
)
2939 class AutoSaveBuffer
: public ForkedProcess
{
2942 AutoSaveBuffer(Buffer
const & buffer
, FileName
const & fname
)
2943 : buffer_(buffer
), fname_(fname
) {}
2945 virtual boost::shared_ptr
<ForkedProcess
> clone() const
2947 return boost::shared_ptr
<ForkedProcess
>(new AutoSaveBuffer(*this));
2952 command_
= to_utf8(bformat(_("Auto-saving %1$s"),
2953 from_utf8(fname_
.absFilename())));
2954 return run(DontWait
);
2958 virtual int generateChild();
2960 Buffer
const & buffer_
;
2965 int AutoSaveBuffer::generateChild()
2967 // tmp_ret will be located (usually) in /tmp
2968 // will that be a problem?
2969 // Note that this calls ForkedCalls::fork(), so it's
2970 // ok cross-platform.
2971 pid_t
const pid
= fork();
2972 // If you want to debug the autosave
2973 // you should set pid to -1, and comment out the fork.
2974 if (pid
!= 0 && pid
!= -1)
2977 // pid = -1 signifies that lyx was unable
2978 // to fork. But we will do the save
2980 bool failed
= false;
2981 FileName
const tmp_ret
= FileName::tempName("lyxauto");
2982 if (!tmp_ret
.empty()) {
2983 buffer_
.writeFile(tmp_ret
);
2984 // assume successful write of tmp_ret
2985 if (!tmp_ret
.moveTo(fname_
))
2991 // failed to write/rename tmp_ret so try writing direct
2992 if (!buffer_
.writeFile(fname_
)) {
2993 // It is dangerous to do this in the child,
2994 // but safe in the parent, so...
2995 if (pid
== -1) // emit message signal.
2996 buffer_
.message(_("Autosave failed!"));
3000 if (pid
== 0) // we are the child so...
3009 FileName
Buffer::getAutosaveFilename() const
3011 // if the document is unnamed try to save in the backup dir, else
3012 // in the default document path, and as a last try in the filePath,
3013 // which will most often be the temporary directory
3016 fpath
= lyxrc
.backupdir_path
.empty() ? lyxrc
.document_path
3017 : lyxrc
.backupdir_path
;
3018 if (!isUnnamed() || fpath
.empty() || !FileName(fpath
).exists())
3021 string
const fname
= "#" + d
->filename
.onlyFileName() + "#";
3022 return makeAbsPath(fname
, fpath
);
3026 void Buffer::removeAutosaveFile() const
3028 FileName
const f
= getAutosaveFilename();
3034 void Buffer::moveAutosaveFile(support::FileName
const & oldauto
) const
3036 FileName
const newauto
= getAutosaveFilename();
3037 if (!(oldauto
== newauto
|| oldauto
.moveTo(newauto
)))
3038 LYXERR0("Unable to remove autosave file `" << oldauto
<< "'!");
3042 // Perfect target for a thread...
3043 void Buffer::autoSave() const
3045 if (isBakClean() || isReadonly()) {
3046 // We don't save now, but we'll try again later
3047 resetAutosaveTimers();
3051 // emit message signal.
3052 message(_("Autosaving current document..."));
3053 AutoSaveBuffer
autosave(*this, getAutosaveFilename());
3057 resetAutosaveTimers();
3061 string
Buffer::bufferFormat() const
3063 string format
= params().documentClass().outputFormat();
3064 if (format
== "latex") {
3065 if (params().useXetex
)
3067 if (params().encoding().package() == Encoding::japanese
)
3074 string
Buffer::getDefaultOutputFormat() const
3076 if (!params().defaultOutputFormat
.empty()
3077 && params().defaultOutputFormat
!= "default")
3078 return params().defaultOutputFormat
;
3079 typedef vector
<Format
const *> Formats
;
3080 Formats formats
= exportableFormats(true);
3083 || params().useXetex
3084 || params().encoding().package() == Encoding::japanese
) {
3085 if (formats
.empty())
3087 // return the first we find
3088 return formats
.front()->name();
3090 return lyxrc
.default_view_format
;
3095 bool Buffer::doExport(string
const & format
, bool put_in_tempdir
,
3096 string
& result_file
) const
3098 string backend_format
;
3099 OutputParams
runparams(¶ms().encoding());
3100 runparams
.flavor
= OutputParams::LATEX
;
3101 runparams
.linelen
= lyxrc
.plaintext_linelen
;
3102 vector
<string
> backs
= backends();
3103 if (find(backs
.begin(), backs
.end(), format
) == backs
.end()) {
3104 // Get shortest path to format
3105 Graph::EdgePath path
;
3106 for (vector
<string
>::const_iterator it
= backs
.begin();
3107 it
!= backs
.end(); ++it
) {
3108 Graph::EdgePath p
= theConverters().getPath(*it
, format
);
3109 if (!p
.empty() && (path
.empty() || p
.size() < path
.size())) {
3110 backend_format
= *it
;
3115 runparams
.flavor
= theConverters().getFlavor(path
);
3117 Alert::error(_("Couldn't export file"),
3118 bformat(_("No information for exporting the format %1$s."),
3119 formats
.prettyName(format
)));
3123 backend_format
= format
;
3124 // FIXME: Don't hardcode format names here, but use a flag
3125 if (backend_format
== "pdflatex")
3126 runparams
.flavor
= OutputParams::PDFLATEX
;
3129 string filename
= latexName(false);
3130 filename
= addName(temppath(), filename
);
3131 filename
= changeExtension(filename
,
3132 formats
.extension(backend_format
));
3135 updateMacroInstances();
3137 // Plain text backend
3138 if (backend_format
== "text")
3139 writePlaintextFile(*this, FileName(filename
), runparams
);
3141 else if (backend_format
== "xhtml") {
3142 runparams
.flavor
= OutputParams::HTML
;
3143 makeLyXHTMLFile(FileName(filename
), runparams
);
3144 } else if (backend_format
== "lyx")
3145 writeFile(FileName(filename
));
3147 else if (isDocBook()) {
3148 runparams
.nice
= !put_in_tempdir
;
3149 makeDocBookFile(FileName(filename
), runparams
);
3152 else if (backend_format
== format
) {
3153 runparams
.nice
= true;
3154 if (!makeLaTeXFile(FileName(filename
), string(), runparams
))
3156 } else if (!lyxrc
.tex_allows_spaces
3157 && contains(filePath(), ' ')) {
3158 Alert::error(_("File name error"),
3159 _("The directory path to the document cannot contain spaces."));
3162 runparams
.nice
= false;
3163 if (!makeLaTeXFile(FileName(filename
), filePath(), runparams
))
3167 string
const error_type
= (format
== "program")
3168 ? "Build" : bufferFormat();
3169 ErrorList
& error_list
= d
->errorLists
[error_type
];
3170 string
const ext
= formats
.extension(format
);
3171 FileName
const tmp_result_file(changeExtension(filename
, ext
));
3172 bool const success
= theConverters().convert(this, FileName(filename
),
3173 tmp_result_file
, FileName(absFileName()), backend_format
, format
,
3175 // Emit the signal to show the error list.
3176 if (format
!= backend_format
) {
3178 // also to the children, in case of master-buffer-view
3179 std::vector
<Buffer
*> clist
= getChildren();
3180 for (vector
<Buffer
*>::const_iterator cit
= clist
.begin();
3181 cit
!= clist
.end(); ++cit
)
3182 (*cit
)->errors(error_type
, true);
3187 if (put_in_tempdir
) {
3188 result_file
= tmp_result_file
.absFilename();
3192 result_file
= changeExtension(exportFileName().absFilename(), ext
);
3193 // We need to copy referenced files (e. g. included graphics
3194 // if format == "dvi") to the result dir.
3195 vector
<ExportedFile
> const files
=
3196 runparams
.exportdata
->externalFiles(format
);
3197 string
const dest
= onlyPath(result_file
);
3198 CopyStatus status
= SUCCESS
;
3199 for (vector
<ExportedFile
>::const_iterator it
= files
.begin();
3200 it
!= files
.end() && status
!= CANCEL
; ++it
) {
3201 string
const fmt
= formats
.getFormatFromFile(it
->sourceName
);
3202 status
= copyFile(fmt
, it
->sourceName
,
3203 makeAbsPath(it
->exportName
, dest
),
3204 it
->exportName
, status
== FORCE
);
3206 if (status
== CANCEL
) {
3207 message(_("Document export cancelled."));
3208 } else if (tmp_result_file
.exists()) {
3209 // Finally copy the main file
3210 status
= copyFile(format
, tmp_result_file
,
3211 FileName(result_file
), result_file
,
3213 message(bformat(_("Document exported as %1$s "
3215 formats
.prettyName(format
),
3216 makeDisplayPath(result_file
)));
3218 // This must be a dummy converter like fax (bug 1888)
3219 message(bformat(_("Document exported as %1$s"),
3220 formats
.prettyName(format
)));
3227 bool Buffer::doExport(string
const & format
, bool put_in_tempdir
) const
3230 return doExport(format
, put_in_tempdir
, result_file
);
3234 bool Buffer::preview(string
const & format
) const
3237 if (!doExport(format
, true, result_file
))
3239 return formats
.view(*this, FileName(result_file
), format
);
3243 bool Buffer::isExportable(string
const & format
) const
3245 vector
<string
> backs
= backends();
3246 for (vector
<string
>::const_iterator it
= backs
.begin();
3247 it
!= backs
.end(); ++it
)
3248 if (theConverters().isReachable(*it
, format
))
3254 vector
<Format
const *> Buffer::exportableFormats(bool only_viewable
) const
3256 vector
<string
> const backs
= backends();
3257 vector
<Format
const *> result
=
3258 theConverters().getReachable(backs
[0], only_viewable
, true);
3259 for (vector
<string
>::const_iterator it
= backs
.begin() + 1;
3260 it
!= backs
.end(); ++it
) {
3261 vector
<Format
const *> r
=
3262 theConverters().getReachable(*it
, only_viewable
, false);
3263 result
.insert(result
.end(), r
.begin(), r
.end());
3269 vector
<string
> Buffer::backends() const
3272 if (params().baseClass()->isTeXClassAvailable()) {
3273 v
.push_back(bufferFormat());
3274 // FIXME: Don't hardcode format names here, but use a flag
3275 if (v
.back() == "latex")
3276 v
.push_back("pdflatex");
3278 v
.push_back("text");
3279 v
.push_back("xhtml");
3285 bool Buffer::readFileHelper(FileName
const & s
)
3287 // File information about normal file
3289 docstring
const file
= makeDisplayPath(s
.absFilename(), 50);
3290 docstring text
= bformat(_("The specified document\n%1$s"
3291 "\ncould not be read."), file
);
3292 Alert::error(_("Could not read document"), text
);
3296 // Check if emergency save file exists and is newer.
3297 FileName
const e(s
.absFilename() + ".emergency");
3299 if (e
.exists() && s
.exists() && e
.lastModified() > s
.lastModified()) {
3300 docstring
const file
= makeDisplayPath(s
.absFilename(), 20);
3301 docstring
const text
=
3302 bformat(_("An emergency save of the document "
3304 "Recover emergency save?"), file
);
3305 switch (Alert::prompt(_("Load emergency save?"), text
, 0, 2,
3306 _("&Recover"), _("&Load Original"),
3310 // the file is not saved if we load the emergency file.
3315 if ((res
= readFile(e
)) == success
)
3316 str
= _("Document was successfully recovered.");
3318 str
= _("Document was NOT successfully recovered.");
3319 str
+= "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
3320 from_utf8(e
.absFilename()));
3322 if (!Alert::prompt(_("Delete emergency file?"), str
, 1, 1,
3323 _("&Remove"), _("&Keep it"))) {
3326 Alert::warning(_("Emergency file deleted"),
3327 _("Do not forget to save your file now!"), true);
3332 if (!Alert::prompt(_("Delete emergency file?"),
3333 _("Remove emergency file now?"), 1, 1,
3334 _("&Remove"), _("&Keep it")))
3342 // Now check if autosave file is newer.
3343 FileName
const a(onlyPath(s
.absFilename()) + '#' + onlyFilename(s
.absFilename()) + '#');
3345 if (a
.exists() && s
.exists() && a
.lastModified() > s
.lastModified()) {
3346 docstring
const file
= makeDisplayPath(s
.absFilename(), 20);
3347 docstring
const text
=
3348 bformat(_("The backup of the document "
3349 "%1$s is newer.\n\nLoad the "
3350 "backup instead?"), file
);
3351 switch (Alert::prompt(_("Load backup?"), text
, 0, 2,
3352 _("&Load backup"), _("Load &original"),
3356 // the file is not saved if we load the autosave file.
3360 // Here we delete the autosave
3371 bool Buffer::loadLyXFile(FileName
const & s
)
3373 if (s
.isReadableFile()) {
3374 if (readFileHelper(s
)) {
3375 lyxvc().file_found_hook(s
);
3376 if (!s
.isWritable())
3381 docstring
const file
= makeDisplayPath(s
.absFilename(), 20);
3382 // Here we probably should run
3383 if (LyXVC::file_not_found_hook(s
)) {
3384 docstring
const text
=
3385 bformat(_("Do you want to retrieve the document"
3386 " %1$s from version control?"), file
);
3387 int const ret
= Alert::prompt(_("Retrieve from version control?"),
3388 text
, 0, 1, _("&Retrieve"), _("&Cancel"));
3391 // How can we know _how_ to do the checkout?
3392 // With the current VC support it has to be,
3393 // a RCS file since CVS do not have special ,v files.
3395 return loadLyXFile(s
);
3403 void Buffer::bufferErrors(TeXErrors
const & terr
, ErrorList
& errorList
) const
3405 TeXErrors::Errors::const_iterator cit
= terr
.begin();
3406 TeXErrors::Errors::const_iterator end
= terr
.end();
3408 for (; cit
!= end
; ++cit
) {
3411 int errorRow
= cit
->error_in_line
;
3412 bool found
= d
->texrow
.getIdFromRow(errorRow
, id_start
,
3418 found
= d
->texrow
.getIdFromRow(errorRow
, id_end
, pos_end
);
3419 } while (found
&& id_start
== id_end
&& pos_start
== pos_end
);
3421 errorList
.push_back(ErrorItem(cit
->error_desc
,
3422 cit
->error_text
, id_start
, pos_start
, pos_end
));
3427 void Buffer::setBuffersForInsets() const
3429 inset().setBuffer(const_cast<Buffer
&>(*this));
3433 void Buffer::updateLabels(UpdateScope scope
) const
3435 // Use the master text class also for child documents
3436 Buffer
const * const master
= masterBuffer();
3437 DocumentClass
const & textclass
= master
->params().documentClass();
3439 // keep the buffers to be children in this set. If the call from the
3440 // master comes back we can see which of them were actually seen (i.e.
3441 // via an InsetInclude). The remaining ones in the set need still be updated.
3442 static std::set
<Buffer
const *> bufToUpdate
;
3443 if (scope
== UpdateMaster
) {
3444 // If this is a child document start with the master
3445 if (master
!= this) {
3446 bufToUpdate
.insert(this);
3447 master
->updateLabels();
3448 // Do this here in case the master has no gui associated with it. Then,
3449 // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
3453 // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
3454 if (bufToUpdate
.find(this) == bufToUpdate
.end())
3458 // start over the counters in the master
3459 textclass
.counters().reset();
3462 // update will be done below for this buffer
3463 bufToUpdate
.erase(this);
3465 // update all caches
3466 clearReferenceCache();
3469 Buffer
& cbuf
= const_cast<Buffer
&>(*this);
3471 LASSERT(!text().paragraphs().empty(), /**/);
3474 ParIterator parit
= cbuf
.par_iterator_begin();
3475 updateLabels(parit
);
3478 // TocBackend update will be done later.
3481 cbuf
.tocBackend().update();
3482 if (scope
== UpdateMaster
)
3483 cbuf
.structureChanged();
3487 static depth_type
getDepth(DocIterator
const & it
)
3489 depth_type depth
= 0;
3490 for (size_t i
= 0 ; i
< it
.depth() ; ++i
)
3491 if (!it
[i
].inset().inMathed())
3492 depth
+= it
[i
].paragraph().getDepth() + 1;
3493 // remove 1 since the outer inset does not count
3497 static depth_type
getItemDepth(ParIterator
const & it
)
3499 Paragraph
const & par
= *it
;
3500 LabelType
const labeltype
= par
.layout().labeltype
;
3502 if (labeltype
!= LABEL_ENUMERATE
&& labeltype
!= LABEL_ITEMIZE
)
3505 // this will hold the lowest depth encountered up to now.
3506 depth_type min_depth
= getDepth(it
);
3507 ParIterator prev_it
= it
;
3510 --prev_it
.top().pit();
3512 // start of nested inset: go to outer par
3514 if (prev_it
.empty()) {
3515 // start of document: nothing to do
3520 // We search for the first paragraph with same label
3521 // that is not more deeply nested.
3522 Paragraph
& prev_par
= *prev_it
;
3523 depth_type
const prev_depth
= getDepth(prev_it
);
3524 if (labeltype
== prev_par
.layout().labeltype
) {
3525 if (prev_depth
< min_depth
)
3526 return prev_par
.itemdepth
+ 1;
3527 if (prev_depth
== min_depth
)
3528 return prev_par
.itemdepth
;
3530 min_depth
= min(min_depth
, prev_depth
);
3531 // small optimization: if we are at depth 0, we won't
3532 // find anything else
3533 if (prev_depth
== 0)
3539 static bool needEnumCounterReset(ParIterator
const & it
)
3541 Paragraph
const & par
= *it
;
3542 LASSERT(par
.layout().labeltype
== LABEL_ENUMERATE
, /**/);
3543 depth_type
const cur_depth
= par
.getDepth();
3544 ParIterator prev_it
= it
;
3545 while (prev_it
.pit()) {
3546 --prev_it
.top().pit();
3547 Paragraph
const & prev_par
= *prev_it
;
3548 if (prev_par
.getDepth() <= cur_depth
)
3549 return prev_par
.layout().labeltype
!= LABEL_ENUMERATE
;
3551 // start of nested inset: reset
3556 // set the label of a paragraph. This includes the counters.
3557 static void setLabel(Buffer
const & buf
, ParIterator
& it
)
3559 BufferParams
const & bp
= buf
.masterBuffer()->params();
3560 DocumentClass
const & textclass
= bp
.documentClass();
3561 Paragraph
& par
= it
.paragraph();
3562 Layout
const & layout
= par
.layout();
3563 Counters
& counters
= textclass
.counters();
3565 if (par
.params().startOfAppendix()) {
3566 // FIXME: only the counter corresponding to toplevel
3567 // sectionning should be reset
3569 counters
.appendix(true);
3571 par
.params().appendix(counters
.appendix());
3573 // Compute the item depth of the paragraph
3574 par
.itemdepth
= getItemDepth(it
);
3576 if (layout
.margintype
== MARGIN_MANUAL
3577 || layout
.latextype
== LATEX_BIB_ENVIRONMENT
) {
3578 if (par
.params().labelWidthString().empty())
3579 par
.params().labelWidthString(par
.expandLabel(layout
, bp
));
3581 par
.params().labelWidthString(docstring());
3584 switch(layout
.labeltype
) {
3586 if (layout
.toclevel
<= bp
.secnumdepth
3587 && (layout
.latextype
!= LATEX_ENVIRONMENT
3588 || it
.text()->isFirstInSequence(it
.pit()))) {
3589 counters
.step(layout
.counter
);
3590 par
.params().labelString(
3591 par
.expandLabel(layout
, bp
));
3593 par
.params().labelString(docstring());
3596 case LABEL_ITEMIZE
: {
3597 // At some point of time we should do something more
3598 // clever here, like:
3599 // par.params().labelString(
3600 // bp.user_defined_bullet(par.itemdepth).getText());
3601 // for now, use a simple hardcoded label
3602 docstring itemlabel
;
3603 switch (par
.itemdepth
) {
3605 itemlabel
= char_type(0x2022);
3608 itemlabel
= char_type(0x2013);
3611 itemlabel
= char_type(0x2217);
3614 itemlabel
= char_type(0x2219); // or 0x00b7
3617 par
.params().labelString(itemlabel
);
3621 case LABEL_ENUMERATE
: {
3622 docstring enumcounter
= layout
.counter
.empty() ? from_ascii("enum") : layout
.counter
;
3624 switch (par
.itemdepth
) {
3633 enumcounter
+= "iv";
3636 // not a valid enumdepth...
3640 // Maybe we have to reset the enumeration counter.
3641 if (needEnumCounterReset(it
))
3642 counters
.reset(enumcounter
);
3643 counters
.step(enumcounter
);
3645 string
const & lang
= par
.getParLanguage(bp
)->code();
3646 par
.params().labelString(counters
.theCounter(enumcounter
, lang
));
3651 case LABEL_SENSITIVE
: {
3652 string
const & type
= counters
.current_float();
3653 docstring full_label
;
3655 full_label
= buf
.B_("Senseless!!! ");
3657 docstring name
= buf
.B_(textclass
.floats().getType(type
).name());
3658 if (counters
.hasCounter(from_utf8(type
))) {
3659 string
const & lang
= par
.getParLanguage(bp
)->code();
3660 counters
.step(from_utf8(type
));
3661 full_label
= bformat(from_ascii("%1$s %2$s:"),
3663 counters
.theCounter(from_utf8(type
), lang
));
3665 full_label
= bformat(from_ascii("%1$s #:"), name
);
3667 par
.params().labelString(full_label
);
3671 case LABEL_NO_LABEL
:
3672 par
.params().labelString(docstring());
3676 case LABEL_TOP_ENVIRONMENT
:
3677 case LABEL_CENTERED_TOP_ENVIRONMENT
:
3680 par
.params().labelString(par
.expandLabel(layout
, bp
));
3686 void Buffer::updateLabels(ParIterator
& parit
) const
3688 LASSERT(parit
.pit() == 0, /**/);
3690 // set the position of the text in the buffer to be able
3691 // to resolve macros in it. This has nothing to do with
3692 // labels, but by putting it here we avoid implementing
3693 // a whole bunch of traversal routines just for this call.
3694 parit
.text()->setMacrocontextPosition(parit
);
3696 depth_type maxdepth
= 0;
3697 pit_type
const lastpit
= parit
.lastpit();
3698 for ( ; parit
.pit() <= lastpit
; ++parit
.pit()) {
3699 // reduce depth if necessary
3700 parit
->params().depth(min(parit
->params().depth(), maxdepth
));
3701 maxdepth
= parit
->getMaxDepthAfter();
3703 // set the counter for this paragraph
3704 setLabel(*this, parit
);
3707 InsetList::const_iterator iit
= parit
->insetList().begin();
3708 InsetList::const_iterator end
= parit
->insetList().end();
3709 for (; iit
!= end
; ++iit
) {
3710 parit
.pos() = iit
->pos
;
3711 iit
->inset
->updateLabels(parit
);
3717 int Buffer::spellCheck(DocIterator
& from
, DocIterator
& to
,
3718 WordLangTuple
& word_lang
, docstring_list
& suggestions
) const
3722 suggestions
.clear();
3723 word_lang
= WordLangTuple();
3724 // OK, we start from here.
3725 DocIterator
const end
= doc_iterator_end(this);
3726 for (; from
!= end
; from
.forwardPos()) {
3727 // We are only interested in text so remove the math CursorSlice.
3728 while (from
.inMathed())
3729 from
.forwardInset();
3731 if (from
.paragraph().spellCheck(from
.pos(), to
.pos(), wl
, suggestions
)) {