1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2000 The LyX Team.
9 * ====================================================== */
14 #pragma implementation
20 #include "insetexternal.h"
21 #include "ExternalTemplate.h"
22 #include "BufferView.h"
25 #include "frontends/Dialogs.h"
27 #include "LaTeXFeatures.h"
28 #include "support/filetools.h"
29 #include "support/lstrings.h"
30 #include "support/path.h"
31 #include "support/syscall.h"
36 InsetExternal::InsetExternal()
39 tempname = lyx::tempName(string(), "lyxext");
40 //ExternalTemplateManager::Templates::const_iterator i1;
41 params_.templ = ExternalTemplateManager::get().getTemplates().begin()->second;
45 InsetExternal::~InsetExternal()
47 lyx::unlink(tempname);
52 InsetExternal::Params InsetExternal::params() const
58 void InsetExternal::setFromParams(Params const & p)
60 params_.filename = p.filename;
61 params_.parameters = p.parameters;
62 params_.templ = p.templ;
66 string const InsetExternal::EditMessage() const
68 return doSubstitution(0, params_.templ.guiName);
72 void InsetExternal::Edit(BufferView * bv,
73 int /*x*/, int /*y*/, unsigned int /*button*/)
76 view->owner()->getDialogs()->showExternal(this);
80 void InsetExternal::Write(Buffer const *, std::ostream & os) const
82 os << "External " << params_.templ.lyxName << ",\"" << params_.filename
83 << "\",\"" << params_.parameters << "\"\n";
87 void InsetExternal::Read(Buffer const *, LyXLex & lex)
92 // Read inset data from lex and store in format
94 format = lex.GetString();
96 lex.printError("InsetExternal: Parse error: `$$Token'");
99 token = lex.GetString();
100 if (token == "\\end_inset")
103 if (token != "\\end_inset") {
104 lex.printError("Missing \\end_inset at this point. "
108 // Parse string format...
109 string::size_type const pos1 = format.find(",");
110 params_.templ = ExternalTemplateManager::get().getTemplateByName(format.substr(0, pos1));
111 string::size_type const pos2 = format.find("\",\"", pos1);
112 params_.filename = format.substr(pos1 + 2, pos2 - (pos1 + 2));
113 params_.parameters = format.substr(pos2 + 3, format.length() - (pos2 + 4));
115 lyxerr[Debug::INFO] << "InsetExternal::Read: " << params_.templ.lyxName
116 << " " << params_.filename
117 << " " << params_.parameters << endl;
121 int InsetExternal::write(string const & format,
122 Buffer const * buf, std::ostream & os) const
124 ExternalTemplate const & et = params_.templ;
125 ExternalTemplate::Formats::const_iterator cit =
126 et.formats.find(format);
127 if (cit == et.formats.end()) {
128 lyxerr << "External template format '" << format
129 << "' not specified in template " << params_.templ.lyxName
134 if (et.automaticProduction) {
135 executeCommand(doSubstitution(buf,
136 (*cit).second.updateCommand),
140 os << doSubstitution(buf, (*cit).second.product);
141 return 0; // CHECK (FIXME check what ? - jbl)
145 int InsetExternal::Latex(Buffer const * buf,
146 std::ostream & os, bool, bool) const
148 return write("LaTeX", buf, os);
152 int InsetExternal::Ascii(Buffer const * buf, std::ostream & os, int) const
154 return write("Ascii", buf, os);
158 int InsetExternal::Linuxdoc(Buffer const * buf, std::ostream & os) const
160 return write("LinuxDoc", buf, os);
164 int InsetExternal::DocBook(Buffer const * buf, std::ostream & os) const
166 return write("DocBook", buf, os);
170 void InsetExternal::Validate(LaTeXFeatures & features) const
172 ExternalTemplate const & et = params_.templ;
173 ExternalTemplate::Formats::const_iterator cit =
174 et.formats.find("LaTeX");
176 if (cit == et.formats.end())
179 if (!(*cit).second.requirement.empty()) {
180 features.require((*cit).second.requirement);
182 if (!(*cit).second.preamble.empty()) {
183 features.externalPreambles += (*cit).second.preamble + "\n";
188 Inset * InsetExternal::Clone(Buffer const &) const
190 InsetExternal * inset = new InsetExternal();
191 inset->params_ = params_;
196 string const InsetExternal::getScreenLabel() const
198 ExternalTemplate const & et = params_.templ;
199 if (et.guiName.empty())
200 return _("External");
202 return doSubstitution(0, et.guiName);
206 void InsetExternal::executeCommand(string const & s,
207 Buffer const * buffer) const
209 string buf = MakeAbsPath(buffer->fileName());
210 string path = OnlyPath(buf);
213 if (lyxerr.debugging()) {
214 lyxerr << "Executing '" << s << "' in '"
215 << path << "'" << endl;
217 one.startscript(Systemcalls::Wait, s);
221 string const InsetExternal::doSubstitution(Buffer const * buffer,
222 string const & s) const
225 string const basename = ChangeExtension(params_.filename, string());
226 result = subst(s, "$$FName", params_.filename);
227 result = subst(result, "$$Basename", basename);
228 result = subst(result, "$$Parameters", params_.parameters);
229 result = ReplaceEnvironmentPath(result);
230 result = subst(result, "$$Tempname", tempname);
231 result = subst(result, "$$Sysdir", system_lyxdir);
233 // Handle the $$Contents(filename) syntax
234 if (contains(result, "$$Contents(\"")) {
236 string::size_type const pos = result.find("$$Contents(\"");
237 string::size_type const end = result.find("\")", pos);
238 string const file = result.substr(pos + 12, end - (pos + 12));
241 // Make sure we are in the directory of the buffer
242 string const buf = MakeAbsPath(buffer->fileName());
243 string const path = OnlyPath(buf);
245 contents = GetFileContents(file);
247 contents = GetFileContents(file);
249 result = subst(result,
250 ("$$Contents(\"" + file + "\")").c_str(),
258 void InsetExternal::updateExternal() const
260 ExternalTemplate const & et = params_.templ;
261 ExternalTemplate::Formats::const_iterator cit =
262 et.formats.find("LaTeX");
263 if (cit == et.formats.end())
266 executeCommand(doSubstitution(view->buffer(),
267 (*cit).second.updateCommand),
272 void InsetExternal::viewExternal() const
274 ExternalTemplate const & et = params_.templ;
275 if (et.automaticProduction)
278 executeCommand(doSubstitution(view->buffer(),
284 void InsetExternal::editExternal() const
286 ExternalTemplate const & et = params_.templ;
287 if (et.automaticProduction)
290 executeCommand(doSubstitution(view->buffer(),
296 bool operator==(InsetExternal::Params const & left,
297 InsetExternal::Params const & right)
299 return ((left.filename == right.filename) &&
300 (left.parameters == right.parameters) &&
301 (left.templ.lyxName == right.templ.lyxName));
305 bool operator!=(InsetExternal::Params const & left,
306 InsetExternal::Params const & right)
308 return !(left == right);