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"
19 #include "FuncRequest.h"
20 #include "FuncStatus.h"
21 #include "LaTeXFeatures.h"
22 #include "OutputParams.h"
23 #include "output_xhtml.h"
25 #include "support/docstream.h"
26 #include "support/FileName.h"
27 #include "support/filetools.h"
28 #include "support/gettext.h"
29 #include "support/lstrings.h"
32 using namespace lyx::support;
37 InsetHyperlink::InsetHyperlink(Buffer * buf, InsetCommandParams const & p)
38 : InsetCommand(buf, p)
42 ParamInfo const & InsetHyperlink::findInfo(string const & /* cmdName */)
44 static ParamInfo param_info_;
45 if (param_info_.empty()) {
46 param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
47 param_info_.add("target", ParamInfo::LATEX_REQUIRED);
48 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
54 docstring InsetHyperlink::screenLabel() const
56 docstring const temp = from_ascii("Hyperlink: ");
60 url += getParam("name");
62 url += getParam("target");
65 if (url.length() > 30) {
66 url = url.substr(0, 10) + "..."
67 + url.substr(url.length() - 17, url.length());
72 void InsetHyperlink::doDispatch(Cursor & cur, FuncRequest & cmd)
74 switch (cmd.action()) {
81 InsetCommand::doDispatch(cur, cmd);
87 bool InsetHyperlink::getStatus(Cursor & cur, FuncRequest const & cmd,
88 FuncStatus & flag) const
90 switch (cmd.action()) {
92 flag.setEnabled(getParam("type").empty() || getParam("type") == "file:");
96 return InsetCommand::getStatus(cur, cmd, flag);
101 void InsetHyperlink::viewTarget() const
103 if (getParam("type") == "file:") {
104 FileName url = makeAbsPath(to_utf8(getParam("target")), buffer().filePath());
105 string const format = formats.getFormatFromFile(url);
106 formats.view(buffer(), url, format);
111 int InsetHyperlink::latex(odocstream & os,
112 OutputParams const & runparams) const
114 docstring url = getParam("target");
115 docstring name = getParam("name");
116 static docstring const backslash = from_ascii("\\");
117 static docstring const braces = from_ascii("{}");
118 static char_type const chars_url[2] = {'%', '#'};
119 static char_type const chars_name[6] = {
120 '&', '_', '$', '%', '#', '^'};
122 // For the case there is no name given, the target is set as name.
123 // Do this before !url.empty() and !name.empty() to handle characters
124 // like the "%" correctly.
129 // Replace the "\" character by its ASCII code according to the
130 // URL specifications because "\" is not allowed in URLs and by
131 // \href. Only do this when the following character is not also
132 // a "\", because "\\" is valid code
133 for (size_t i = 0, pos;
134 (pos = url.find('\\', i)) != string::npos;
136 if (url[pos + 1] != '\\')
137 url.replace(pos, 1, from_ascii("%5C"));
140 // The characters in chars_url[] need to be escaped in the url
141 // field because otherwise LaTeX will fail when the hyperlink is
142 // within an argument of another command, e.g. in a \footnote. It
143 // is important that they are escaped as "\#" and not as "\#{}".
144 for (int k = 0; k < 2; k++)
145 for (size_t i = 0, pos;
146 (pos = url.find(chars_url[k], i)) != string::npos;
148 url.replace(pos, 1, backslash + chars_url[k]);
150 // add "http://" when the type is web (type = empty)
151 // and no "://" or "run:" is given
152 docstring type = getParam("type");
153 if (url.find(from_ascii("://")) == string::npos
154 && url.find(from_ascii("run:")) == string::npos
156 url = from_ascii("http://") + url;
158 } // end if (!url.empty())
160 // The characters in chars_name[] need to be changed to a command when
161 // they are in the name field.
163 // handle the "\" character, but only when the following character
164 // is not also a "\", because "\\" is valid code
165 docstring const textbackslash = from_ascii("\\textbackslash{}");
166 for (size_t i = 0, pos;
167 (pos = name.find('\\', i)) != string::npos;
169 if (name[pos + 1] != '\\')
170 name.replace(pos, 1, textbackslash);
172 // The characters in chars_name[] need to be changed to a command
173 // when they are in the name field.
174 // Therefore the treatment of "\" must be the first thing
175 for (int k = 0; k < 6; k++)
176 for (size_t i = 0, pos;
177 (pos = name.find(chars_name[k], i)) != string::npos;
179 name.replace(pos, 1, backslash + chars_name[k] + braces);
181 // replace the tilde by the \sim character as suggested in the
182 // LaTeX FAQ for URLs
183 docstring const sim = from_ascii("$\\sim$");
184 for (size_t i = 0, pos;
185 (pos = name.find('~', i)) != string::npos;
187 name.replace(pos, 1, sim);
189 } // end if (!name.empty())
191 if (runparams.moving_arg)
194 // output the ready \href command
195 os << "\\href{" << getParam("type") << url << "}{" << name << '}';
201 int InsetHyperlink::plaintext(odocstream & os, OutputParams const &) const
203 odocstringstream oss;
205 oss << '[' << getParam("target");
206 if (getParam("name").empty())
209 oss << "||" << getParam("name") << ']';
211 docstring const str = oss.str();
217 int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const
219 os << "<ulink url=\""
220 << subst(getParam("target"), from_ascii("&"), from_ascii("&"))
228 docstring InsetHyperlink::xhtml(XHTMLStream & xs, OutputParams const &) const
230 docstring const & target = getParam("target");
231 docstring const & name = getParam("name");
232 xs << html::StartTag("a", to_utf8("href=\"" + target + "\""));
233 xs << (name.empty() ? target : name);
234 xs << html::EndTag("a");
239 void InsetHyperlink::toString(odocstream & os) const
241 plaintext(os, OutputParams(0));
245 void InsetHyperlink::forToc(docstring & os, size_t) const
247 docstring const & n = getParam("name");
252 os += getParam("target");
256 docstring InsetHyperlink::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
258 docstring url = getParam("target");
259 docstring type = getParam("type");
260 docstring guitype = _("www");
261 if (type == "mailto:")
262 guitype = _("email");
263 else if (type == "file:")
265 return bformat(_("Hyperlink (%1$s) to %2$s"), guitype, url);
269 void InsetHyperlink::validate(LaTeXFeatures & features) const
271 features.require("hyperref");
275 docstring InsetHyperlink::contextMenuName() const
277 return from_ascii("context-hyperlink");