X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetHyperlink.cpp;h=cbcf613b788b3acdfaf891cb50a07a2a7012910c;hb=245c2b3c45dce1f5f385665e932ee19c9a904081;hp=9b75a9e0a3c9e3c2c02403351ae6a5dfd748dda1;hpb=a258a932d9d5f64dbc53f0577f704df2f61fd472;p=lyx.git diff --git a/src/insets/InsetHyperlink.cpp b/src/insets/InsetHyperlink.cpp index 9b75a9e0a3..cbcf613b78 100644 --- a/src/insets/InsetHyperlink.cpp +++ b/src/insets/InsetHyperlink.cpp @@ -3,8 +3,8 @@ * 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. */ @@ -13,23 +13,32 @@ #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 "OutputParams.h" +#include "output_xhtml.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" + using namespace std; using namespace lyx::support; namespace lyx { -InsetHyperlink::InsetHyperlink(InsetCommandParams const & p) - : InsetCommand(p, "href") +InsetHyperlink::InsetHyperlink(Buffer * buf, InsetCommandParams const & p) + : InsetCommand(buf, p) {} @@ -63,42 +72,97 @@ docstring InsetHyperlink::screenLabel() const return temp + url; } +void InsetHyperlink::doDispatch(Cursor & cur, FuncRequest & cmd) +{ + switch (cmd.action()) { + + case LFUN_INSET_EDIT: + viewTarget(); + break; + + default: + InsetCommand::doDispatch(cur, cmd); + break; + } +} + -int InsetHyperlink::latex(odocstream & os, OutputParams const & runparams) const +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); + } +} + + +void InsetHyperlink::viewTarget() const +{ + if (getParam("type") == "file:") { + FileName url = makeAbsPath(to_utf8(getParam("target")), buffer().filePath()); + string const format = formats.getFormatFromFile(url); + formats.view(buffer(), url, format); + } +} + + +void InsetHyperlink::latex(otexstream & os, + OutputParams const & runparams) const { docstring url = getParam("target"); + docstring name = getParam("name"); static docstring const backslash = from_ascii("\\"); static docstring const braces = from_ascii("{}"); static char_type const chars_url[2] = {'%', '#'}; static char_type const chars_name[6] = { '&', '_', '$', '%', '#', '^'}; - // The characters in chars_url[] need to be changed to a command when - // they are in the url field. + // 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 + // like the "%" correctly. + if (name.empty()) + name = url; + if (!url.empty()) { - // the chars_url[] characters must be handled for both, url and href - for (int k = 0; k < 2; k++) { + // Replace the "\" character by its ASCII code according to the + // URL specifications because "\" is not allowed in URLs and by + // \href. Only do this when the following character is not also + // a "\", because "\\" is valid code + for (size_t i = 0, pos; + (pos = url.find('\\', i)) != string::npos; + i = pos + 2) { + if (url[pos + 1] != '\\') + url.replace(pos, 1, from_ascii("%5C")); + } + + // 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 "\#{}". + 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) { + i = pos + 2) url.replace(pos, 1, backslash + chars_url[k]); - } - } - + // add "http://" when the type is web (type = empty) - // and no "://" is given + // and no "://" or "run:" is given docstring type = getParam("type"); - if (url.find(from_ascii("://")) == string::npos && 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()) - docstring name = getParam("name"); - // The characters in chars_name[] need to be changed to a command when // they are in the name field. if (!name.empty()) { - // handle the "\" character, but only when the following character // is not also a "\", because "\\" is valid code docstring const textbackslash = from_ascii("\\textbackslash{}"); @@ -108,35 +172,45 @@ int InsetHyperlink::latex(odocstream & os, OutputParams const & runparams) const if (name[pos + 1] != '\\') name.replace(pos, 1, textbackslash); } - for (int k = 0; k < 6; k++) { + // The characters in chars_name[] need to be changed to a command + // when they are in the name field. + // Therefore the treatment of "\" must be the first thing + for (int k = 0; k < 6; k++) for (size_t i = 0, pos; (pos = name.find(chars_name[k], i)) != string::npos; - i = pos + 2) { + i = pos + 2) name.replace(pos, 1, backslash + chars_name[k] + braces); - } - } - // replace the tilde by the \sim character as suggested in the LaTeX FAQ - // for URLs + + // replace the tilde by the \sim character as suggested in the + // LaTeX FAQ for URLs docstring const sim = from_ascii("$\\sim$"); for (size_t i = 0, pos; (pos = name.find('~', i)) != string::npos; i = pos + 1) name.replace(pos, 1, sim); - + pair name_latexed = + runparams.encoding->latexString(name, runparams.dryrun); + name = name_latexed.first; + if (!name_latexed.second.empty() && !runparams.silent) { + // issue a warning about omitted characters + // FIXME: should be passed to the error dialog + frontend::Alert::warning(_("Uncodable characters"), + bformat(_("The following characters that are used in the href inset are not\n" + "representable in the current encoding and therefore have been omitted:\n%1$s."), + name_latexed.second)); + } } // end if (!name.empty()) if (runparams.moving_arg) os << "\\protect"; - //for the case there is no name given, the target is set as name - os << "\\href{" << getParam("type") << url << "}{" - << (name.empty()? url : name) << '}'; - - return 0; + // output the ready \href command + os << "\\href{" << getParam("type") << url << "}{" << name << '}'; } -int InsetHyperlink::plaintext(odocstream & os, OutputParams const &) const +int InsetHyperlink::plaintext(odocstringstream & os, + OutputParams const &, size_t) const { odocstringstream oss; @@ -163,9 +237,47 @@ int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const } -void InsetHyperlink::textString(odocstream & os) const +docstring InsetHyperlink::xhtml(XHTMLStream & xs, OutputParams const &) const +{ + 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 { - plaintext(os, OutputParams(0)); + 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); } @@ -175,4 +287,10 @@ void InsetHyperlink::validate(LaTeXFeatures & features) const } +string InsetHyperlink::contextMenuName() const +{ + return "context-hyperlink"; +} + + } // namespace lyx