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