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 "support/docstream.h"
27 #include "support/FileName.h"
28 #include "support/filetools.h"
29 #include "support/gettext.h"
30 #include "support/lstrings.h"
32 #include "frontends/alert.h"
35 using namespace lyx::support;
40 InsetHyperlink::InsetHyperlink(Buffer * buf, InsetCommandParams const & p)
41 : InsetCommand(buf, p)
45 ParamInfo const & InsetHyperlink::findInfo(string const & /* cmdName */)
47 static ParamInfo param_info_;
48 if (param_info_.empty()) {
49 param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
50 param_info_.add("target", ParamInfo::LATEX_REQUIRED);
51 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
57 docstring InsetHyperlink::screenLabel() const
59 docstring const temp = _("Hyperlink: ");
63 url += getParam("name");
65 url += getParam("target");
68 if (url.length() > 30) {
69 docstring end = url.substr(url.length() - 17, url.length());
70 support::truncateWithEllipsis(url, 13);
76 void InsetHyperlink::doDispatch(Cursor & cur, FuncRequest & cmd)
78 switch (cmd.action()) {
85 InsetCommand::doDispatch(cur, cmd);
91 bool InsetHyperlink::getStatus(Cursor & cur, FuncRequest const & cmd,
92 FuncStatus & flag) const
94 switch (cmd.action()) {
96 flag.setEnabled(getParam("type").empty() || getParam("type") == "file:");
100 return InsetCommand::getStatus(cur, cmd, flag);
105 void InsetHyperlink::viewTarget() const
107 if (getParam("type") == "file:") {
108 FileName url = makeAbsPath(to_utf8(getParam("target")), buffer().filePath());
109 string const format = formats.getFormatFromFile(url);
110 formats.view(buffer(), url, format);
115 void InsetHyperlink::latex(otexstream & os,
116 OutputParams const & runparams) const
118 docstring url = getParam("target");
119 docstring name = getParam("name");
120 static docstring const backslash = from_ascii("\\");
121 static docstring const braces = from_ascii("{}");
122 static char_type const chars_url[2] = {'%', '#'};
123 static char_type const chars_name[6] = {
124 '&', '_', '$', '%', '#', '^'};
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, backslash + 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())
164 // The characters in chars_name[] need to be changed to a command when
165 // they are in the name field.
167 // handle the "\" character, but only when the following character
168 // is not also a "\", because "\\" is valid code
169 docstring const textbackslash = from_ascii("\\textbackslash{}");
170 for (size_t i = 0, pos;
171 (pos = name.find('\\', i)) != string::npos;
173 if (name[pos + 1] != '\\')
174 name.replace(pos, 1, textbackslash);
176 // The characters in chars_name[] need to be changed to a command
177 // when they are in the name field.
178 // Therefore the treatment of "\" must be the first thing
179 for (int k = 0; k < 6; k++)
180 for (size_t i = 0, pos;
181 (pos = name.find(chars_name[k], i)) != string::npos;
183 name.replace(pos, 1, backslash + chars_name[k] + braces);
185 // replace the tilde by the \sim character as suggested in the
186 // LaTeX FAQ for URLs
187 docstring const sim = from_ascii("$\\sim$");
188 for (size_t i = 0, pos;
189 (pos = name.find('~', i)) != string::npos;
191 name.replace(pos, 1, sim);
192 pair<docstring, docstring> name_latexed =
193 runparams.encoding->latexString(name, runparams.dryrun);
194 name = name_latexed.first;
195 if (!name_latexed.second.empty() && !runparams.silent) {
196 // issue a warning about omitted characters
197 // FIXME: should be passed to the error dialog
198 frontend::Alert::warning(_("Uncodable characters"),
199 bformat(_("The following characters that are used in the href inset are not\n"
200 "representable in the current encoding and therefore have been omitted:\n%1$s."),
201 name_latexed.second));
203 } // end if (!name.empty())
205 if (runparams.moving_arg)
208 // output the ready \href command
209 os << "\\href{" << getParam("type") << url << "}{" << name << '}';
213 int InsetHyperlink::plaintext(odocstringstream & os,
214 OutputParams const &, size_t) const
216 odocstringstream oss;
218 oss << '[' << getParam("target");
219 if (getParam("name").empty())
222 oss << "||" << getParam("name") << ']';
224 docstring const str = oss.str();
230 int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const
232 os << "<ulink url=\""
233 << subst(getParam("target"), from_ascii("&"), from_ascii("&"))
241 docstring InsetHyperlink::xhtml(XHTMLStream & xs, OutputParams const &) const
243 docstring const & target =
244 html::htmlize(getParam("target"), XHTMLStream::ESCAPE_AND);
245 docstring const & name = getParam("name");
246 xs << html::StartTag("a", to_utf8("href=\"" + target + "\""));
247 xs << (name.empty() ? target : name);
248 xs << html::EndTag("a");
253 void InsetHyperlink::toString(odocstream & os) const
255 odocstringstream ods;
256 plaintext(ods, OutputParams(0), INT_MAX);
261 void InsetHyperlink::forOutliner(docstring & os, size_t const, bool const) const
263 docstring const & n = getParam("name");
268 os += getParam("target");
272 docstring InsetHyperlink::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
274 docstring url = getParam("target");
275 docstring type = getParam("type");
276 docstring guitype = _("www");
277 if (type == "mailto:")
278 guitype = _("email");
279 else if (type == "file:")
281 return bformat(_("Hyperlink (%1$s) to %2$s"), guitype, url);
285 void InsetHyperlink::validate(LaTeXFeatures & features) const
287 features.require("hyperref");
291 string InsetHyperlink::contextMenuName() const
293 return "context-hyperlink";