* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author José Matos
- * \author Uwe Stöhr
+ * \author José Matos
+ * \author Uwe Stöhr
*
* Full author contact details are available in file CREDITS.
*/
#include "InsetHyperlink.h"
+#include "Buffer.h"
#include "DispatchResult.h"
+#include "Encoding.h"
+#include "Format.h"
#include "FuncRequest.h"
+#include "FuncStatus.h"
#include "LaTeXFeatures.h"
-#include "gettext.h"
#include "OutputParams.h"
+#include "output_xhtml.h"
+#include "sgml.h"
+#include "texstream.h"
-#include "support/lstrings.h"
#include "support/docstream.h"
+#include "support/FileName.h"
+#include "support/filetools.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
+#include "frontends/alert.h"
-namespace lyx {
-
-using support::subst;
-
-using std::string;
-using std::find;
-using std::replace;
-
-static char_type const chars_url[2] = {'%', '#'};
+using namespace std;
+using namespace lyx::support;
-static char_type const chars_name[6] = {
- '&', '_', '$', '%', '#', '^'};
+namespace lyx {
-InsetHyperlink::InsetHyperlink(InsetCommandParams const & p)
- : InsetCommand(p, "href")
+InsetHyperlink::InsetHyperlink(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p)
{}
-CommandInfo const * InsetHyperlink::findInfo(string const & /* cmdName */)
+ParamInfo const & InsetHyperlink::findInfo(string const & /* cmdName */)
{
- static const char * const paramnames[] =
- {"name", "target", "type", ""};
- static const bool isoptional[] = {true, false};
- static const CommandInfo info = {3, paramnames, isoptional};
- return &info;
+ static ParamInfo param_info_;
+ if (param_info_.empty()) {
+ param_info_.add("name", ParamInfo::LATEX_OPTIONAL,
+ ParamInfo::HANDLING_LATEXIFY);
+ param_info_.add("target", ParamInfo::LATEX_REQUIRED);
+ param_info_.add("type", ParamInfo::LATEX_REQUIRED);
+ param_info_.add("literal", ParamInfo::LYX_INTERNAL);
+ }
+ return param_info_;
}
-docstring const InsetHyperlink::getScreenLabel(Buffer const &) const
+docstring InsetHyperlink::screenLabel() const
{
- docstring const temp = from_ascii("Hyperlink: ");
+ docstring const temp = _("Hyperlink: ");
docstring url;
// elide if long
if (url.length() > 30) {
- url = url.substr(0, 10) + "..."
- + url.substr(url.length() - 17, url.length());
+ docstring end = url.substr(url.length() - 17, url.length());
+ support::truncateWithEllipsis(url, 13);
+ url += end;
}
return temp + url;
}
-int InsetHyperlink::latex(Buffer const &, odocstream & os,
- OutputParams const & runparams) const
+void InsetHyperlink::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- docstring url = getParam("target");
- docstring backslash = from_ascii("\\");
- docstring braces = from_ascii("{}");
+ switch (cmd.action()) {
+
+ case LFUN_INSET_EDIT:
+ viewTarget();
+ break;
+
+ default:
+ InsetCommand::doDispatch(cur, cmd);
+ break;
+ }
+}
+
+
+bool InsetHyperlink::getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
+{
+ switch (cmd.action()) {
+ case LFUN_INSET_EDIT:
+ flag.setEnabled(getParam("type").empty() || getParam("type") == "file:");
+ return true;
+
+ default:
+ return InsetCommand::getStatus(cur, cmd, flag);
+ }
+}
- // The characters in chars_url[] need to be changed to a command when
- // they are in the url field.
- if (!url.empty()) {
- // the chars_url[] characters must be handled for both, url and href
- for (int k = 0; k < 2; k++) {
- for (size_t i = 0, pos;
- (pos = url.find(chars_url[k], i)) != string::npos;
- i = pos + 2) {
- url.replace(pos, 1, backslash + chars_url[k]);
- }
- }
- } // end if (!url.empty())
+void InsetHyperlink::viewTarget() const
+{
+ if (getParam("type") == "file:") {
+ FileName url = makeAbsPath(to_utf8(getParam("target")), buffer().filePath());
+ string const format = theFormats().getFormatFromFile(url);
+ theFormats().view(buffer(), url, format);
+ }
+}
+
+
+void InsetHyperlink::latex(otexstream & os,
+ OutputParams const & runparams) const
+{
+ docstring url = getParam("target");
docstring name = getParam("name");
+ static char_type const chars_url[2] = {'%', '#'};
- // The characters in chars_name[] need to be changed to a command when
- // they are in the name field.
- if (!name.empty()) {
+ // For the case there is no name given, the target is set as name.
+ // Do this before !url.empty() and !name.empty() to handle characters
+ // such as % correctly.
+ if (name.empty())
+ name = url;
- // handle the "\" character, but only when the following character
- // is not also a "\", because "\\" is valid code
- docstring textbackslash = from_ascii("\\textbackslash{}");
+ if (!url.empty()) {
+ // Use URI/URL-style percent-encoded string (hexadecimal).
+ // We exclude some characters that must not be transformed
+ // in hrefs: % # / : ? = & ! * ' ( ) ; @ + $ , [ ]
+ // or that we need to treat manually: \.
+ url = to_percent_encoding(url, from_ascii("%#\\/:?=&!*'();@+$,[]"));
+ // We handle \ manually since \\ is valid
for (size_t i = 0, pos;
- (pos = name.find('\\', i)) != string::npos;
+ (pos = url.find('\\', i)) != string::npos;
i = pos + 2) {
- if (name[pos + 1] != '\\')
- name.replace(pos, 1, textbackslash);
+ if (url[pos + 1] != '\\')
+ url.replace(pos, 1, from_ascii("%5C"));
}
- for (int k = 0; k < 6; k++) {
+
+ // The characters in chars_url[] need to be escaped in the url
+ // field because otherwise LaTeX will fail when the hyperlink is
+ // within an argument of another command, e.g. in a \footnote. It
+ // is important that they are escaped as "\#" and not as "\#{}".
+ // FIXME this is not necessary in outside of commands.
+ for (int k = 0; k < 2; k++)
+ for (size_t i = 0, pos;
+ (pos = url.find(chars_url[k], i)) != string::npos;
+ i = pos + 2)
+ url.replace(pos, 1, from_ascii("\\") + chars_url[k]);
+
+ // add "http://" when the type is web (type = empty)
+ // and no "://" or "run:" is given
+ docstring type = getParam("type");
+ if (url.find(from_ascii("://")) == string::npos
+ && url.find(from_ascii("run:")) == string::npos
+ && type.empty())
+ url = from_ascii("http://") + url;
+
+ } // end if (!url.empty())
+
+ if (!name.empty()) {
+ name = params().prepareCommand(runparams, name,
+ ParamInfo::HANDLING_LATEXIFY);
+ // replace the tilde by the \sim character as suggested in the
+ // LaTeX FAQ for URLs
+ if (getParam("literal") != from_ascii("true")) {
+ docstring const sim = from_ascii("$\\sim$");
for (size_t i = 0, pos;
- (pos = name.find(chars_name[k], i)) != string::npos;
- i = pos + 2) {
- name.replace(pos, 1, backslash + chars_name[k] + braces);
- }
+ (pos = name.find('~', i)) != string::npos;
+ i = pos + 1)
+ name.replace(pos, 1, sim);
}
- // replace the tilde by the \sim character as suggested in the LaTeX FAQ
- // for URLs
- docstring sim = from_ascii("$\\sim$");
- for (int i = 0, pos;
- (pos = name.find('~', i)) != string::npos;
- i = pos + 1)
- name.replace(pos, 1, sim);
-
- } // end if (!name.empty())
-
- //for the case there is no name given, the target is set as name
- docstring urlname = url;
- // set the hyperlink type
- url += getParam("type");
+ }
if (runparams.moving_arg)
os << "\\protect";
- //set the target for the name when no name is given
- if (!name.empty())
- os << "\\href{" << url << "}{" << name << '}';
- else
- os << "\\href{" << url << "}{" << urlname << '}';
- return 0;
+
+ // output the ready \href command
+ os << "\\href{" << getParam("type") << url << "}{" << name << '}';
}
-int InsetHyperlink::plaintext(Buffer const &, odocstream & os,
- OutputParams const &) const
+int InsetHyperlink::plaintext(odocstringstream & os,
+ OutputParams const &, size_t) const
{
odocstringstream oss;
}
-int InsetHyperlink::docbook(Buffer const &, odocstream & os,
- OutputParams const &) const
+int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const
{
os << "<ulink url=\""
<< subst(getParam("target"), from_ascii("&"), from_ascii("&"))
<< "\">"
- << getParam("name")
+ << sgml::escapeString(getParam("name"))
<< "</ulink>";
return 0;
}
-int InsetHyperlink::textString(Buffer const & buf, odocstream & os,
- OutputParams const & op) const
+docstring InsetHyperlink::xhtml(XHTMLStream & xs, OutputParams const &) const
{
- return plaintext(buf, os, op);
+ docstring const & target =
+ html::htmlize(getParam("target"), XHTMLStream::ESCAPE_AND);
+ docstring const & name = getParam("name");
+ xs << html::StartTag("a", to_utf8("href=\"" + target + "\""));
+ xs << (name.empty() ? target : name);
+ xs << html::EndTag("a");
+ return docstring();
+}
+
+
+void InsetHyperlink::toString(odocstream & os) const
+{
+ odocstringstream ods;
+ plaintext(ods, OutputParams(0), INT_MAX);
+ os << ods.str();
+}
+
+
+void InsetHyperlink::forOutliner(docstring & os, size_t const, bool const) const
+{
+ docstring const & n = getParam("name");
+ if (!n.empty()) {
+ os += n;
+ return;
+ }
+ os += getParam("target");
+}
+
+
+docstring InsetHyperlink::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const
+{
+ docstring url = getParam("target");
+ docstring type = getParam("type");
+ docstring guitype = _("www");
+ if (type == "mailto:")
+ guitype = _("email");
+ else if (type == "file:")
+ guitype = _("file");
+ return bformat(_("Hyperlink (%1$s) to %2$s"), guitype, url);
}
void InsetHyperlink::validate(LaTeXFeatures & features) const
{
features.require("hyperref");
+ InsetCommand::validate(features);
+}
+
+
+string InsetHyperlink::contextMenuName() const
+{
+ return "context-hyperlink";
}
projects / lyx.git / blobdiff