X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetHyperlink.cpp;h=3f1131c4ad3a86cb12a882a909026e5f89e61e52;hb=997f0621c5346bb623cf86713c4fe1be0c941104;hp=a799488864cd12398b93e95a97bf254f615c89bf;hpb=12a3c703d16d64c5897c228dadc3cb179eafdf87;p=lyx.git diff --git a/src/insets/InsetHyperlink.cpp b/src/insets/InsetHyperlink.cpp index a799488864..3f1131c4ad 100644 --- a/src/insets/InsetHyperlink.cpp +++ b/src/insets/InsetHyperlink.cpp @@ -3,144 +3,212 @@ * 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 - #include "InsetHyperlink.h" -#include "DispatchResult.h" +#include "Buffer.h" +#include "Format.h" #include "FuncRequest.h" +#include "FuncStatus.h" #include "LaTeXFeatures.h" -#include "gettext.h" -#include "OutputParams.h" +#include "output_docbook.h" +#include "output_xhtml.h" +#include "xml.h" +#include "texstream.h" -#include "support/lstrings.h" +#include "support/debug.h" #include "support/docstream.h" +#include "support/FileName.h" +#include "support/filetools.h" +#include "support/gettext.h" +#include "support/lstrings.h" +#include "support/qstring_helpers.h" -using std::string; -using std::find; -using std::replace; +#include "frontends/alert.h" -namespace lyx { +#include +#include -using support::subst; +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) {} -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: "); + // TODO: replace with unicode hyperlink character = U+1F517 + docstring const temp = _("Hyperlink: "); docstring url; url += getParam("name"); - if (url.empty()) + if (url.empty()) { url += getParam("target"); - // elide if long - if (url.length() > 30) { - url = url.substr(0, 10) + "..." - + url.substr(url.length() - 17, url.length()); + // elide if long and no name was provided + if (url.length() > 30) { + docstring end = url.substr(url.length() - 17, url.length()); + support::truncateWithEllipsis(url, 13); + url += end; + } + } else { + // elide if long (approx number of chars in line of article class) + if (url.length() > 80) { + docstring end = url.substr(url.length() - 67, url.length()); + support::truncateWithEllipsis(url, 13); + url += end; + } } return temp + url; } -static void replaceAny(docstring & s, docstring const & items, - docstring const & replacement) +void InsetHyperlink::doDispatch(Cursor & cur, FuncRequest & cmd) { - if (s.empty()) - return; + switch (cmd.action()) { - size_t i = 0; - while (i < s.size()) { - if ((i = s.find_first_of(items, i)) == string::npos) - break; - s.insert(i, replacement); - i += 2; + case LFUN_INSET_EDIT: + viewTarget(); + break; + + default: + InsetCommand::doDispatch(cur, cmd); + break; } } -int InsetHyperlink::latex(Buffer const &, odocstream & os, - OutputParams const & runparams) const +bool InsetHyperlink::getStatus(Cursor & cur, FuncRequest const & cmd, + FuncStatus & flag) const { - docstring url = getParam("target"); - static docstring const backslash = from_ascii("\\"); - static docstring const braces = from_ascii("{}"); - static char_type const chars_name[6] = { - '&', '_', '$', '%', '#', '^'}; + switch (cmd.action()) { + case LFUN_INSET_EDIT: { + QUrl url(toqstr(getParam("target")),QUrl::StrictMode); + bool url_valid = getParam("type").empty() && url.isValid(); - // The characters in chars_url[] need to be changed to a command when - // they are in the url field. - // the chars_url[] characters must be handled for both, url and href - static docstring const chars_url = from_ascii("%#"); - replaceAny(url, chars_url, backslash); + flag.setEnabled(url_valid || getParam("type") == "file:"); + return true; + } - docstring name = getParam("name"); + default: + return InsetCommand::getStatus(cur, cmd, flag); + } +} + + +void InsetHyperlink::viewTarget() const +{ + if (getParam("type").empty()) { //==Web + QUrl url(toqstr(getParam("target")),QUrl::StrictMode); + if (!QDesktopServices::openUrl(url)) + LYXERR0("Unable to open URL!"); + + } else if (getParam("type") == "file:") { + FileName url = makeAbsPath(to_utf8(getParam("target")), buffer().filePath()); + string const format = theFormats().getFormatFromFile(url); + theFormats().view(buffer(), url, format); + } +} - // 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{}"); +void InsetHyperlink::latex(otexstream & os, + OutputParams const & runparams) const +{ + docstring url = getParam("target"); + docstring name = getParam("name"); + static char_type const chars_url[2] = {'%', '#'}; + + // 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; + + 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 = name.find(chars_name[k], i)) != string::npos; - i = pos + 2) { - name.replace(pos, 1, backslash + chars_name[k] + braces); - } + (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('~', 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 const 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()) - + } + 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(Buffer const &, odocstream & os, - OutputParams const &) const +int InsetHyperlink::plaintext(odocstringstream & os, + OutputParams const &, size_t) const { odocstringstream oss; @@ -156,28 +224,75 @@ int InsetHyperlink::plaintext(Buffer const &, odocstream & os, } -int InsetHyperlink::docbook(Buffer const &, odocstream & os, - OutputParams const &) const +void InsetHyperlink::docbook(XMLStream & xs, OutputParams const &) const +{ + xs << xml::StartTag("link", "xlink:href=\"" + subst(getParam("target"), from_ascii("&"), from_ascii("&")) + "\""); + xs << xml::escapeString(getParam("name")); + xs << xml::EndTag("link"); +} + + +docstring InsetHyperlink::xhtml(XMLStream & xs, OutputParams const &) const +{ + docstring const & target = + xml::escapeString(getParam("target"), XMLStream::ESCAPE_AND); + docstring const & name = getParam("name"); + xs << xml::StartTag("a", to_utf8("href=\"" + target + "\"")); + xs << (name.empty() ? target : name); + xs << xml::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 { - os << "" - << getParam("name") - << ""; - return 0; + docstring const & n = getParam("name"); + if (!n.empty()) { + os += n; + return; + } + os += getParam("target"); } -int InsetHyperlink::textString(Buffer const & buf, odocstream & os, - OutputParams const & op) const +docstring InsetHyperlink::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*/) const { - return plaintext(buf, os, op); + 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); +} + + +pair InsetHyperlink::isWords() const +{ + docstring const label = getParam("name"); + return pair(label.size(), wordCount(label)); +} + + +string InsetHyperlink::contextMenuName() const +{ + return "context-hyperlink"; }