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"
16 #include "DispatchResult.h"
17 #include "FuncRequest.h"
18 #include "LaTeXFeatures.h"
19 #include "OutputParams.h"
21 #include "support/docstream.h"
22 #include "support/gettext.h"
23 #include "support/lstrings.h"
26 using namespace lyx::support;
31 InsetHyperlink::InsetHyperlink(InsetCommandParams const & p)
32 : InsetCommand(p, "href")
36 ParamInfo const & InsetHyperlink::findInfo(string const & /* cmdName */)
38 static ParamInfo param_info_;
39 if (param_info_.empty()) {
40 param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
41 param_info_.add("target", ParamInfo::LATEX_REQUIRED);
42 param_info_.add("type", ParamInfo::LATEX_REQUIRED);
48 docstring InsetHyperlink::screenLabel() const
50 docstring const temp = from_ascii("Hyperlink: ");
54 url += getParam("name");
56 url += getParam("target");
59 if (url.length() > 30) {
60 url = url.substr(0, 10) + "..."
61 + url.substr(url.length() - 17, url.length());
67 int InsetHyperlink::latex(odocstream & os, OutputParams const & runparams) const
69 docstring url = getParam("target");
70 static docstring const backslash = from_ascii("\\");
71 static docstring const braces = from_ascii("{}");
72 static char_type const chars_url[2] = {'%', '#'};
73 static char_type const chars_name[6] = {
74 '&', '_', '$', '%', '#', '^'};
76 // The characters in chars_url[] need to be changed to a command when
77 // they are in the url field.
79 // the chars_url[] characters must be handled for both, url and href
80 for (int k = 0; k < 2; k++) {
81 for (size_t i = 0, pos;
82 (pos = url.find(chars_url[k], i)) != string::npos;
84 url.replace(pos, 1, backslash + chars_url[k]);
87 // Replace the "\" character with a "/" because "\" is not allowed in
88 // URLs and by \href. Only do this when the following character
89 // is not also a "\", because "\\" is valid code
90 docstring const slash = from_ascii("/");
91 for (size_t i = 0, pos;
92 (pos = url.find('\\', i)) != string::npos;
94 if (url[pos + 1] != '\\')
95 url.replace(pos, 1, slash);
98 // add "http://" when the type is web (type = empty)
99 // and no "://" or "run:" is given
100 docstring type = getParam("type");
101 if (url.find(from_ascii("://")) == string::npos
102 && url.find(from_ascii("run:")) == string::npos
104 url = from_ascii("http://") + url;
106 } // end if (!url.empty())
108 docstring name = getParam("name");
110 // The characters in chars_name[] need to be changed to a command when
111 // they are in the name field.
113 // handle the "\" character, but only when the following character
114 // is not also a "\", because "\\" is valid code
115 docstring const textbackslash = from_ascii("\\textbackslash{}");
116 for (size_t i = 0, pos;
117 (pos = name.find('\\', i)) != string::npos;
119 if (name[pos + 1] != '\\')
120 name.replace(pos, 1, textbackslash);
122 // The characters in chars_name[] need to be changed to a command when
123 // they are in the name field.
124 for (int k = 0; k < 6; k++) {
125 for (size_t i = 0, pos;
126 (pos = name.find(chars_name[k], i)) != string::npos;
128 name.replace(pos, 1, backslash + chars_name[k] + braces);
131 // replace the tilde by the \sim character as suggested in the LaTeX FAQ
133 docstring const sim = from_ascii("$\\sim$");
134 for (size_t i = 0, pos;
135 (pos = name.find('~', i)) != string::npos;
137 name.replace(pos, 1, sim);
139 } // end if (!name.empty())
141 if (runparams.moving_arg)
144 //for the case there is no name given, the target is set as name
145 os << "\\href{" << getParam("type") << url << "}{"
146 << (name.empty()? url : name) << '}';
152 int InsetHyperlink::plaintext(odocstream & os, OutputParams const &) const
154 odocstringstream oss;
156 oss << '[' << getParam("target");
157 if (getParam("name").empty())
160 oss << "||" << getParam("name") << ']';
162 docstring const str = oss.str();
168 int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const
170 os << "<ulink url=\""
171 << subst(getParam("target"), from_ascii("&"), from_ascii("&"))
179 void InsetHyperlink::tocString(odocstream & os) const
181 plaintext(os, OutputParams(0));
185 void InsetHyperlink::validate(LaTeXFeatures & features) const
187 features.require("hyperref");