2 * \file InsetHyperlink.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
14 #include "InsetHyperlink.h"
17 #include "DispatchResult.h"
20 #include "FuncRequest.h"
21 #include "FuncStatus.h"
22 #include "LaTeXFeatures.h"
23 #include "OutputParams.h"
24 #include "output_xhtml.h"
26 #include "texstream.h"
28 #include "support/docstream.h"
29 #include "support/FileName.h"
30 #include "support/filetools.h"
31 #include "support/gettext.h"
32 #include "support/lstrings.h"
34 #include "frontends/alert.h"
37 using namespace lyx::support;
42 InsetHyperlink::InsetHyperlink(Buffer * buf, InsetCommandParams const & p)
43 : InsetCommand(buf, p)
47 ParamInfo const & InsetHyperlink::findInfo(string const & /* cmdName */)
49 static ParamInfo param_info_;
50 if (param_info_.empty()) {
51 param_info_.add("name", ParamInfo::LATEX_OPTIONAL,
52 ParamInfo::HANDLING_LATEXIFY);
53 param_info_.add("target", ParamInfo::LATEX_REQUIRED);
54 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
55 param_info_.add("literal", ParamInfo::LYX_INTERNAL);
61 docstring InsetHyperlink::screenLabel() const
63 docstring const temp = _("Hyperlink: ");
67 url += getParam("name");
69 url += getParam("target");
72 if (url.length() > 30) {
73 docstring end = url.substr(url.length() - 17, url.length());
74 support::truncateWithEllipsis(url, 13);
80 void InsetHyperlink::doDispatch(Cursor & cur, FuncRequest & cmd)
82 switch (cmd.action()) {
89 InsetCommand::doDispatch(cur, cmd);
95 bool InsetHyperlink::getStatus(Cursor & cur, FuncRequest const & cmd,
96 FuncStatus & flag) const
98 switch (cmd.action()) {
100 flag.setEnabled(getParam("type").empty() || getParam("type") == "file:");
104 return InsetCommand::getStatus(cur, cmd, flag);
109 void InsetHyperlink::viewTarget() const
111 if (getParam("type") == "file:") {
112 FileName url = makeAbsPath(to_utf8(getParam("target")), buffer().filePath());
113 string const format = theFormats().getFormatFromFile(url);
114 theFormats().view(buffer(), url, format);
119 void InsetHyperlink::latex(otexstream & os,
120 OutputParams const & runparams) const
122 docstring url = getParam("target");
123 docstring name = getParam("name");
124 static char_type const chars_url[2] = {'%', '#'};
126 // For the case there is no name given, the target is set as name.
127 // Do this before !url.empty() and !name.empty() to handle characters
128 // like the "%" correctly.
133 // Replace the "\" character by its ASCII code according to the
134 // URL specifications because "\" is not allowed in URLs and by
135 // \href. Only do this when the following character is not also
136 // a "\", because "\\" is valid code
137 for (size_t i = 0, pos;
138 (pos = url.find('\\', i)) != string::npos;
140 if (url[pos + 1] != '\\')
141 url.replace(pos, 1, from_ascii("%5C"));
144 // The characters in chars_url[] need to be escaped in the url
145 // field because otherwise LaTeX will fail when the hyperlink is
146 // within an argument of another command, e.g. in a \footnote. It
147 // is important that they are escaped as "\#" and not as "\#{}".
148 for (int k = 0; k < 2; k++)
149 for (size_t i = 0, pos;
150 (pos = url.find(chars_url[k], i)) != string::npos;
152 url.replace(pos, 1, from_ascii("\\") + chars_url[k]);
154 // add "http://" when the type is web (type = empty)
155 // and no "://" or "run:" is given
156 docstring type = getParam("type");
157 if (url.find(from_ascii("://")) == string::npos
158 && url.find(from_ascii("run:")) == string::npos
160 url = from_ascii("http://") + url;
162 } // end if (!url.empty())
165 name = params().prepareCommand(runparams, name,
166 ParamInfo::HANDLING_LATEXIFY);
167 // replace the tilde by the \sim character as suggested in the
168 // LaTeX FAQ for URLs
169 if (getParam("literal") != from_ascii("true")) {
170 docstring const sim = from_ascii("$\\sim$");
171 for (size_t i = 0, pos;
172 (pos = name.find('~', i)) != string::npos;
174 name.replace(pos, 1, sim);
178 if (runparams.moving_arg)
181 // output the ready \href command
182 os << "\\href{" << getParam("type") << url << "}{" << name << '}';
186 int InsetHyperlink::plaintext(odocstringstream & os,
187 OutputParams const &, size_t) const
189 odocstringstream oss;
191 oss << '[' << getParam("target");
192 if (getParam("name").empty())
195 oss << "||" << getParam("name") << ']';
197 docstring const str = oss.str();
203 int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const
205 os << "<ulink url=\""
206 << subst(getParam("target"), from_ascii("&"), from_ascii("&"))
208 << sgml::escapeString(getParam("name"))
214 docstring InsetHyperlink::xhtml(XHTMLStream & xs, OutputParams const &) const
216 docstring const & target =
217 html::htmlize(getParam("target"), XHTMLStream::ESCAPE_AND);
218 docstring const & name = getParam("name");
219 xs << html::StartTag("a", to_utf8("href=\"" + target + "\""));
220 xs << (name.empty() ? target : name);
221 xs << html::EndTag("a");
226 void InsetHyperlink::toString(odocstream & os) const
228 odocstringstream ods;
229 plaintext(ods, OutputParams(0), INT_MAX);
234 void InsetHyperlink::forOutliner(docstring & os, size_t const, bool const) const
236 docstring const & n = getParam("name");
241 os += getParam("target");
245 docstring InsetHyperlink::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
247 docstring url = getParam("target");
248 docstring type = getParam("type");
249 docstring guitype = _("www");
250 if (type == "mailto:")
251 guitype = _("email");
252 else if (type == "file:")
254 return bformat(_("Hyperlink (%1$s) to %2$s"), guitype, url);
258 void InsetHyperlink::validate(LaTeXFeatures & features) const
260 features.require("hyperref");
261 InsetCommand::validate(features);
265 string InsetHyperlink::contextMenuName() const
267 return "context-hyperlink";