]> git.lyx.org Git - lyx.git/blob - src/insets/insetinclude.C
Rework InsetCommandParams interface and file storage
[lyx.git] / src / insets / insetinclude.C
1 /**
2  * \file insetinclude.C
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #include <config.h>
12
13 #include "insetinclude.h"
14
15 #include "buffer.h"
16 #include "buffer_funcs.h"
17 #include "bufferlist.h"
18 #include "bufferparams.h"
19 #include "BufferView.h"
20 #include "cursor.h"
21 #include "debug.h"
22 #include "dispatchresult.h"
23 #include "exporter.h"
24 #include "funcrequest.h"
25 #include "FuncStatus.h"
26 #include "gettext.h"
27 #include "LaTeXFeatures.h"
28 #include "lyx_main.h"
29 #include "lyxrc.h"
30 #include "lyxlex.h"
31 #include "metricsinfo.h"
32 #include "outputparams.h"
33
34 #include "frontends/Alert.h"
35 #include "frontends/Painter.h"
36
37 #include "graphics/PreviewImage.h"
38 #include "graphics/PreviewLoader.h"
39
40 #include "insets/render_preview.h"
41
42 #include "support/filename.h"
43 #include "support/filetools.h"
44 #include "support/lstrings.h" // contains
45 #include "support/lyxalgo.h"
46 #include "support/lyxlib.h"
47 #include "support/convert.h"
48
49 #include <boost/bind.hpp>
50 #include <boost/filesystem/operations.hpp>
51
52 #include "support/std_ostream.h"
53
54 #include <sstream>
55
56 using lyx::docstring;
57 using lyx::support::addName;
58 using lyx::support::absolutePath;
59 using lyx::support::bformat;
60 using lyx::support::changeExtension;
61 using lyx::support::contains;
62 using lyx::support::copy;
63 using lyx::support::FileName;
64 using lyx::support::getFileContents;
65 using lyx::support::isFileReadable;
66 using lyx::support::isLyXFilename;
67 using lyx::support::latex_path;
68 using lyx::support::makeAbsPath;
69 using lyx::support::makeDisplayPath;
70 using lyx::support::makeRelPath;
71 using lyx::support::onlyFilename;
72 using lyx::support::onlyPath;
73 using lyx::support::subst;
74 using lyx::support::sum;
75
76 using std::endl;
77 using std::string;
78 using std::auto_ptr;
79 using std::istringstream;
80 using std::ostream;
81 using std::ostringstream;
82
83 namespace Alert = lyx::frontend::Alert;
84 namespace fs = boost::filesystem;
85
86
87 namespace {
88
89 string const uniqueID()
90 {
91         static unsigned int seed = 1000;
92         return "file" + convert<string>(++seed);
93 }
94
95 } // namespace anon
96
97
98 InsetInclude::InsetInclude(InsetCommandParams const & p)
99         : params_(p), include_label(uniqueID()),
100           preview_(new RenderMonitoredPreview(this)),
101           set_label_(false)
102 {
103         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
104 }
105
106
107 InsetInclude::InsetInclude(InsetInclude const & other)
108         : InsetOld(other),
109           params_(other.params_),
110           include_label(other.include_label),
111           preview_(new RenderMonitoredPreview(this)),
112           set_label_(false)
113 {
114         preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
115 }
116
117
118 InsetInclude::~InsetInclude()
119 {
120         InsetIncludeMailer(*this).hideDialog();
121 }
122
123
124 void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd)
125 {
126         switch (cmd.action) {
127
128         case LFUN_INSET_MODIFY: {
129                 InsetCommandParams p("include");
130                 InsetIncludeMailer::string2params(lyx::to_utf8(cmd.argument()), p);
131                 if (!p.getCmdName().empty()) {
132                         set(p, cur.buffer());
133                         cur.buffer().updateBibfilesCache();
134                 } else
135                         cur.noUpdate();
136                 break;
137         }
138
139         case LFUN_INSET_DIALOG_UPDATE:
140                 InsetIncludeMailer(*this).updateDialog(&cur.bv());
141                 break;
142
143         case LFUN_MOUSE_RELEASE:
144                 InsetIncludeMailer(*this).showDialog(&cur.bv());
145                 break;
146
147         default:
148                 InsetBase::doDispatch(cur, cmd);
149                 break;
150         }
151 }
152
153
154 bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd,
155                 FuncStatus & flag) const
156 {
157         switch (cmd.action) {
158
159         case LFUN_INSET_MODIFY:
160         case LFUN_INSET_DIALOG_UPDATE:
161                 flag.enabled(true);
162                 return true;
163
164         default:
165                 return InsetBase::getStatus(cur, cmd, flag);
166         }
167 }
168
169
170 InsetCommandParams const & InsetInclude::params() const
171 {
172         return params_;
173 }
174
175
176 namespace {
177
178 /// the type of inclusion
179 enum Types {
180         INCLUDE = 0,
181         VERB = 1,
182         INPUT = 2,
183         VERBAST = 3
184 };
185
186
187 Types type(InsetCommandParams const & params)
188 {
189         string const command_name = params.getCmdName();
190
191         if (command_name == "input")
192                 return INPUT;
193         if  (command_name == "verbatiminput")
194                 return VERB;
195         if  (command_name == "verbatiminput*")
196                 return VERBAST;
197         return INCLUDE;
198 }
199
200
201 bool isVerbatim(InsetCommandParams const & params)
202 {
203         string const command_name = params.getCmdName();
204         return command_name == "verbatiminput" ||
205                 command_name == "verbatiminput*";
206 }
207
208
209 string const masterFilename(Buffer const & buffer)
210 {
211         return buffer.getMasterBuffer()->fileName();
212 }
213
214
215 string const parentFilename(Buffer const & buffer)
216 {
217         return buffer.fileName();
218 }
219
220
221 string const includedFilename(Buffer const & buffer,
222                               InsetCommandParams const & params)
223 {
224         return makeAbsPath(params.getContents(),
225                            onlyPath(parentFilename(buffer)));
226 }
227
228
229 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
230
231 } // namespace anon
232
233
234 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
235 {
236         params_ = p;
237         set_label_ = false;
238
239         if (preview_->monitoring())
240                 preview_->stopMonitoring();
241
242         if (type(params_) == INPUT)
243                 add_preview(*preview_, *this, buffer);
244 }
245
246
247 auto_ptr<InsetBase> InsetInclude::doClone() const
248 {
249         return auto_ptr<InsetBase>(new InsetInclude(*this));
250 }
251
252
253 void InsetInclude::write(Buffer const &, ostream & os) const
254 {
255         write(os);
256 }
257
258
259 void InsetInclude::write(ostream & os) const
260 {
261         os << "Include " << params_.getCommand() << '\n'
262            << "preview " << convert<string>(params_.preview()) << '\n';
263 }
264
265
266 void InsetInclude::read(Buffer const &, LyXLex & lex)
267 {
268         read(lex);
269 }
270
271
272 void InsetInclude::read(LyXLex & lex)
273 {
274         params_.read(lex);
275 }
276
277
278 docstring const InsetInclude::getScreenLabel(Buffer const &) const
279 {
280         docstring temp;
281
282         switch (type(params_)) {
283                 case INPUT:
284                         temp += _("Input");
285                         break;
286                 case VERB:
287                         temp += _("Verbatim Input");
288                         break;
289                 case VERBAST:
290                         temp += _("Verbatim Input*");
291                         break;
292                 case INCLUDE:
293                         temp += _("Include");
294                         break;
295         }
296
297         temp += ": ";
298
299         if (params_.getContents().empty())
300                 temp += "???";
301         else
302                 // FIXME: We don't know the encoding of the filename
303                 temp += lyx::from_ascii(onlyFilename(params_.getContents()));
304
305         return temp;
306 }
307
308
309 namespace {
310
311 /// return the child buffer if the file is a LyX doc and is loaded
312 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
313 {
314         if (isVerbatim(params))
315                 return 0;
316
317         string const included_file = includedFilename(buffer, params);
318         if (!isLyXFilename(included_file))
319                 return 0;
320
321         return theBufferList().getBuffer(included_file);
322 }
323
324
325 /// return true if the file is or got loaded.
326 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
327 {
328         if (isVerbatim(params))
329                 return false;
330
331         string const included_file = includedFilename(buffer, params);
332         if (!isLyXFilename(included_file))
333                 return false;
334
335         Buffer * buf = theBufferList().getBuffer(included_file);
336         if (!buf) {
337                 // the readonly flag can/will be wrong, not anymore I think.
338                 if (!fs::exists(included_file))
339                         return false;
340                 buf = theBufferList().newBuffer(included_file);
341                 if (!loadLyXFile(buf, included_file))
342                         return false;
343         }
344         if (buf)
345                 buf->setParentName(parentFilename(buffer));
346         return buf != 0;
347 }
348
349
350 } // namespace anon
351
352
353 int InsetInclude::latex(Buffer const & buffer, ostream & os,
354                         OutputParams const & runparams) const
355 {
356         string incfile(params_.getContents());
357
358         // Do nothing if no file name has been specified
359         if (incfile.empty())
360                 return 0;
361
362         string const included_file = includedFilename(buffer, params_);
363         Buffer const * const m_buffer = buffer.getMasterBuffer();
364
365         // if incfile is relative, make it relative to the master
366         // buffer directory.
367         if (!absolutePath(incfile)) {
368                 incfile = makeRelPath(included_file,
369                                       m_buffer->filePath());
370         }
371
372         // write it to a file (so far the complete file)
373         string const exportfile = changeExtension(incfile, ".tex");
374         string const mangled = FileName(changeExtension(included_file,
375                                                         ".tex")).mangledFilename();
376         string const writefile = makeAbsPath(mangled, m_buffer->temppath());
377
378         if (!runparams.nice)
379                 incfile = mangled;
380         lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
381         lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
382         lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
383
384         if (runparams.inComment || runparams.dryrun)
385                 // Don't try to load or copy the file
386                 ;
387         else if (loadIfNeeded(buffer, params_)) {
388                 Buffer * tmp = theBufferList().getBuffer(included_file);
389
390                 if (tmp->params().textclass != m_buffer->params().textclass) {
391                         // FIXME UNICODE
392                         docstring text = bformat(_("Included file `%1$s'\n"
393                                                 "has textclass `%2$s'\n"
394                                                              "while parent file has textclass `%3$s'."),
395                                               makeDisplayPath(included_file),
396                                               lyx::from_utf8(tmp->params().getLyXTextClass().name()),
397                                               lyx::from_utf8(m_buffer->params().getLyXTextClass().name()));
398                         Alert::warning(_("Different textclasses"), text);
399                         //return 0;
400                 }
401
402                 tmp->markDepClean(m_buffer->temppath());
403
404 #ifdef WITH_WARNINGS
405 #warning handle non existing files
406 #warning Second argument is irrelevant!
407 // since only_body is true, makeLaTeXFile will not look at second
408 // argument. Should we set it to string(), or should makeLaTeXFile
409 // make use of it somehow? (JMarc 20031002)
410 #endif
411                 tmp->makeLaTeXFile(writefile,
412                                    onlyPath(masterFilename(buffer)),
413                                    runparams, false);
414         } else {
415                 // Copy the file to the temp dir, so that .aux files etc.
416                 // are not created in the original dir. Files included by
417                 // this file will be found via input@path, see ../buffer.C.
418                 unsigned long const checksum_in  = sum(included_file);
419                 unsigned long const checksum_out = sum(writefile);
420
421                 if (checksum_in != checksum_out) {
422                         if (!copy(included_file, writefile)) {
423                                 // FIXME UNICODE
424                                 lyxerr[Debug::LATEX]
425                                         << lyx::to_utf8(bformat(_("Could not copy the file\n%1$s\n"
426                                                                   "into the temporary directory."),
427                                                    lyx::from_utf8(included_file)))
428                                         << endl;
429                                 return 0;
430                         }
431                 }
432         }
433
434         string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
435                         "latex" : "pdflatex";
436         if (isVerbatim(params_)) {
437                 incfile = latex_path(incfile);
438                 os << '\\' << params_.getCmdName() << '{' << incfile << '}';
439         } else if (type(params_) == INPUT) {
440                 runparams.exportdata->addExternalFile(tex_format, writefile,
441                                                       exportfile);
442
443                 // \input wants file with extension (default is .tex)
444                 if (!isLyXFilename(included_file)) {
445                         incfile = latex_path(incfile);
446                         os << '\\' << params_.getCmdName() << '{' << incfile << '}';
447                 } else {
448                 incfile = changeExtension(incfile, ".tex");
449                 incfile = latex_path(incfile);
450                         os << '\\' << params_.getCmdName() << '{'
451                            << incfile
452                            <<  '}';
453                 }
454         } else {
455                 runparams.exportdata->addExternalFile(tex_format, writefile,
456                                                       exportfile);
457
458                 // \include don't want extension and demands that the
459                 // file really have .tex
460                 incfile = changeExtension(incfile, string());
461                 incfile = latex_path(incfile);
462                 os << '\\' << params_.getCmdName() << '{'
463                    << incfile
464                    << '}';
465         }
466
467         return 0;
468 }
469
470
471 int InsetInclude::plaintext(Buffer const & buffer, lyx::odocstream & os,
472                         OutputParams const &) const
473 {
474         if (isVerbatim(params_)) {
475                 // FIXME: We don't know the encoding of the file
476                 docstring const str = lyx::from_utf8(
477                         getFileContents(includedFilename(buffer, params_)));
478                 os << str;
479                 // Return how many newlines we issued.
480                 return int(lyx::count(str.begin(), str.end(), '\n'));
481         }
482         return 0;
483 }
484
485
486 int InsetInclude::docbook(Buffer const & buffer, ostream & os,
487                           OutputParams const & runparams) const
488 {
489         string incfile(params_.getContents());
490
491         // Do nothing if no file name has been specified
492         if (incfile.empty())
493                 return 0;
494
495         string const included_file = includedFilename(buffer, params_);
496
497         // write it to a file (so far the complete file)
498         string const exportfile = changeExtension(incfile, ".sgml");
499         string writefile = changeExtension(included_file, ".sgml");
500
501         if (loadIfNeeded(buffer, params_)) {
502                 Buffer * tmp = theBufferList().getBuffer(included_file);
503
504                 string const mangled = FileName(writefile).mangledFilename();
505                 writefile = makeAbsPath(mangled,
506                                         buffer.getMasterBuffer()->temppath());
507                 if (!runparams.nice)
508                         incfile = mangled;
509
510                 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
511                 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
512                 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
513
514                 tmp->makeDocBookFile(writefile, runparams, true);
515         }
516
517         runparams.exportdata->addExternalFile("docbook", writefile,
518                                               exportfile);
519         runparams.exportdata->addExternalFile("docbook-xml", writefile,
520                                               exportfile);
521
522         if (isVerbatim(params_)) {
523                 os << "<inlinegraphic fileref=\""
524                    << '&' << include_label << ';'
525                    << "\" format=\"linespecific\">";
526         } else
527                 os << '&' << include_label << ';';
528
529         return 0;
530 }
531
532
533 void InsetInclude::validate(LaTeXFeatures & features) const
534 {
535         string incfile(params_.getContents());
536         string writefile;
537
538         Buffer const & buffer = features.buffer();
539
540         string const included_file = includedFilename(buffer, params_);
541
542         if (isLyXFilename(included_file))
543                 writefile = changeExtension(included_file, ".sgml");
544         else
545                 writefile = included_file;
546
547         if (!features.runparams().nice && !isVerbatim(params_)) {
548                 incfile = FileName(writefile).mangledFilename();
549                 writefile = makeAbsPath(incfile,
550                                         buffer.getMasterBuffer()->temppath());
551         }
552
553         features.includeFile(include_label, writefile);
554
555         if (isVerbatim(params_))
556                 features.require("verbatim");
557
558         // Here we must do the fun stuff...
559         // Load the file in the include if it needs
560         // to be loaded:
561         if (loadIfNeeded(buffer, params_)) {
562                 // a file got loaded
563                 Buffer * const tmp = theBufferList().getBuffer(included_file);
564                 if (tmp) {
565                         // We must temporarily change features.buffer,
566                         // otherwise it would always be the master buffer,
567                         // and nested includes would not work.
568                         features.setBuffer(*tmp);
569                         tmp->validate(features);
570                         features.setBuffer(buffer);
571                 }
572         }
573 }
574
575
576 void InsetInclude::getLabelList(Buffer const & buffer,
577                                 std::vector<docstring> & list) const
578 {
579         if (loadIfNeeded(buffer, params_)) {
580                 string const included_file = includedFilename(buffer, params_);
581                 Buffer * tmp = theBufferList().getBuffer(included_file);
582                 tmp->setParentName("");
583                 tmp->getLabelList(list);
584                 tmp->setParentName(parentFilename(buffer));
585         }
586 }
587
588
589 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
590                                    std::vector<std::pair<string,string> > & keys) const
591 {
592         if (loadIfNeeded(buffer, params_)) {
593                 string const included_file = includedFilename(buffer, params_);
594                 Buffer * tmp = theBufferList().getBuffer(included_file);
595                 tmp->setParentName("");
596                 tmp->fillWithBibKeys(keys);
597                 tmp->setParentName(parentFilename(buffer));
598         }
599 }
600
601
602 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
603 {
604         Buffer * const tmp = getChildBuffer(buffer, params_);
605         if (tmp) {
606                 tmp->setParentName("");
607                 tmp->updateBibfilesCache();
608                 tmp->setParentName(parentFilename(buffer));
609         }
610 }
611
612
613 std::vector<string> const &
614 InsetInclude::getBibfilesCache(Buffer const & buffer) const
615 {
616         Buffer * const tmp = getChildBuffer(buffer, params_);
617         if (tmp) {
618                 tmp->setParentName("");
619                 std::vector<string> const & cache = tmp->getBibfilesCache();
620                 tmp->setParentName(parentFilename(buffer));
621                 return cache;
622         }
623         static std::vector<string> const empty;
624         return empty;
625 }
626
627
628 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
629 {
630         BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
631
632         bool use_preview = false;
633         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
634                 lyx::graphics::PreviewImage const * pimage =
635                         preview_->getPreviewImage(*mi.base.bv->buffer());
636                 use_preview = pimage && pimage->image();
637         }
638
639         if (use_preview) {
640                 preview_->metrics(mi, dim);
641         } else {
642                 if (!set_label_) {
643                         set_label_ = true;
644                         button_.update(getScreenLabel(*mi.base.bv->buffer()),
645                                        true);
646                 }
647                 button_.metrics(mi, dim);
648         }
649
650         Box b(0, dim.wid, -dim.asc, dim.des);
651         button_.setBox(b);
652
653         dim_ = dim;
654 }
655
656
657 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
658 {
659         setPosCache(pi, x, y);
660
661         BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
662
663         bool use_preview = false;
664         if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
665                 lyx::graphics::PreviewImage const * pimage =
666                         preview_->getPreviewImage(*pi.base.bv->buffer());
667                 use_preview = pimage && pimage->image();
668         }
669
670         if (use_preview)
671                 preview_->draw(pi, x, y);
672         else
673                 button_.draw(pi, x, y);
674 }
675
676 bool InsetInclude::display() const
677 {
678         return type(params_) != INPUT;
679 }
680
681
682
683 //
684 // preview stuff
685 //
686
687 void InsetInclude::fileChanged() const
688 {
689         Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
690         if (!buffer_ptr)
691                 return;
692
693         Buffer const & buffer = *buffer_ptr;
694         preview_->removePreview(buffer);
695         add_preview(*preview_.get(), *this, buffer);
696         preview_->startLoading(buffer);
697 }
698
699
700 namespace {
701
702 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
703 {
704         string const included_file = includedFilename(buffer, params);
705
706         return type(params) == INPUT && params.preview() &&
707                 isFileReadable(included_file);
708 }
709
710
711 string const latex_string(InsetInclude const & inset, Buffer const & buffer)
712 {
713         ostringstream os;
714         OutputParams runparams;
715         runparams.flavor = OutputParams::LATEX;
716         inset.latex(buffer, os, runparams);
717
718         return os.str();
719 }
720
721
722 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
723                  Buffer const & buffer)
724 {
725         InsetCommandParams const & params = inset.params();
726         if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
727             preview_wanted(params, buffer)) {
728                 renderer.setAbsFile(includedFilename(buffer, params));
729                 string const snippet = latex_string(inset, buffer);
730                 renderer.addPreview(snippet, buffer);
731         }
732 }
733
734 } // namespace anon
735
736
737 void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const
738 {
739         Buffer const & buffer = ploader.buffer();
740         if (preview_wanted(params(), buffer)) {
741                 preview_->setAbsFile(includedFilename(buffer, params()));
742                 string const snippet = latex_string(*this, buffer);
743                 preview_->addPreview(snippet, ploader);
744         }
745 }
746
747
748 string const InsetIncludeMailer::name_("include");
749
750 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
751         : inset_(inset)
752 {}
753
754
755 string const InsetIncludeMailer::inset2string(Buffer const &) const
756 {
757         return params2string(inset_.params());
758 }
759
760
761 void InsetIncludeMailer::string2params(string const & in,
762                                        InsetCommandParams & params)
763 {
764         params.clear();
765         if (in.empty())
766                 return;
767
768         istringstream data(in);
769         LyXLex lex(0,0);
770         lex.setStream(data);
771
772         string name;
773         lex >> name;
774         if (!lex || name != name_)
775                 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
776
777         // This is part of the inset proper that is usually swallowed
778         // by LyXText::readInset
779         string id;
780         lex >> id;
781         if (!lex || id != "Include")
782                 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
783
784         InsetInclude inset(params);
785         inset.read(lex);
786         params = inset.params();
787 }
788
789
790 string const
791 InsetIncludeMailer::params2string(InsetCommandParams const & params)
792 {
793         InsetInclude inset(params);
794         ostringstream data;
795         data << name_ << ' ';
796         inset.write(data);
797         data << "\\end_inset\n";
798         return data.str();
799 }