]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetHyperlink.cpp
Rename LATEX debug level to OUTFILE and use it for DocBook, HTML, and XML messages.
[lyx.git] / src / insets / InsetHyperlink.cpp
index 29ce2ddca75585bc141c6eb11fa8c8bfcef0e9a1..3f1131c4ad3a86cb12a882a909026e5f89e61e52 100644 (file)
  */
 
 #include <config.h>
-
 #include "InsetHyperlink.h"
 
 #include "Buffer.h"
-#include "DispatchResult.h"
 #include "Format.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "LaTeXFeatures.h"
-#include "OutputParams.h"
+#include "output_docbook.h"
 #include "output_xhtml.h"
+#include "xml.h"
+#include "texstream.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"
+
+#include "frontends/alert.h"
+
+#include <QtGui/QDesktopServices>
+#include <QUrl>
 
 using namespace std;
 using namespace lyx::support;
@@ -43,9 +50,11 @@ ParamInfo const & InsetHyperlink::findInfo(string const & /* cmdName */)
 {
        static ParamInfo param_info_;
        if (param_info_.empty()) {
-               param_info_.add("name", ParamInfo::LATEX_OPTIONAL);
+               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_;
 }
@@ -53,22 +62,33 @@ ParamInfo const & InsetHyperlink::findInfo(string const & /* cmdName */)
 
 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;
 }
 
+
 void InsetHyperlink::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action()) {
@@ -88,9 +108,13 @@ 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:");
+       case LFUN_INSET_EDIT: {
+               QUrl url(toqstr(getParam("target")),QUrl::StrictMode);
+               bool url_valid = getParam("type").empty() && url.isValid();
+
+               flag.setEnabled(url_valid || getParam("type") == "file:");
                return true;
+               }
 
        default:
                return InsetCommand::getStatus(cur, cmd, flag);
@@ -100,39 +124,39 @@ bool InsetHyperlink::getStatus(Cursor & cur, FuncRequest const & cmd,
 
 void InsetHyperlink::viewTarget() const
 {
-       if (getParam("type").empty()) 
-               formats.viewURL(getParam("target"));
+       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:") {
+       else if (getParam("type") == "file:") {
                FileName url = makeAbsPath(to_utf8(getParam("target")), buffer().filePath());
-               string const format = formats.getFormatFromFile(url);
-               formats.view(buffer(), url, format);
+               string const format = theFormats().getFormatFromFile(url);
+               theFormats().view(buffer(), url, format);
        }
 }
 
 
-int InsetHyperlink::latex(odocstream & os,
-                         OutputParams const & runparams) const
+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] = {
-               '&', '_', '$', '%', '#', '^'};
 
        // 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.
+       // such as % correctly.
        if (name.empty())
                name = url;
 
        if (!url.empty()) {
-               // 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
+               // 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 = url.find('\\', i)) != string::npos;
                        i = pos + 2) {
@@ -144,12 +168,13 @@ int InsetHyperlink::latex(odocstream & os,
                // 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, backslash + chars_url[k]);
-               
+                               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");
@@ -160,48 +185,30 @@ int InsetHyperlink::latex(odocstream & os,
 
        } // end if (!url.empty())
 
-       // 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{}");
-               for (size_t i = 0, pos;
-                       (pos = name.find('\\', i)) != string::npos;
-                       i = pos + 2) {
-                       if (name[pos + 1] != '\\')
-                               name.replace(pos, 1, textbackslash);
-               }
-               // 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)
-                               name.replace(pos, 1, backslash + chars_name[k] + braces);
-
+               name = params().prepareCommand(runparams, name,
+                                       ParamInfo::HANDLING_LATEXIFY);
                // 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);
+               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);
+               }
+       }
 
-       }  // end if (!name.empty())
-       
        if (runparams.moving_arg)
                os << "\\protect";
 
        // output the ready \href command
        os << "\\href{" << getParam("type") << url << "}{" << name << '}';
-
-       return 0;
 }
 
 
-int InsetHyperlink::plaintext(odocstream & os, OutputParams const &) const
+int InsetHyperlink::plaintext(odocstringstream & os,
+        OutputParams const &, size_t) const
 {
        odocstringstream oss;
 
@@ -217,31 +224,42 @@ int InsetHyperlink::plaintext(odocstream & os, OutputParams const &) const
 }
 
 
-int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const
+void InsetHyperlink::docbook(XMLStream & xs, OutputParams const &) const
 {
-       os << "<ulink url=\""
-          << subst(getParam("target"), from_ascii("&"), from_ascii("&amp;"))
-          << "\">"
-          << getParam("name")
-          << "</ulink>";
-       return 0;
+       xs << xml::StartTag("link", "xlink:href=\"" + subst(getParam("target"), from_ascii("&"), from_ascii("&amp;")) + "\"");
+       xs << xml::escapeString(getParam("name"));
+       xs << xml::EndTag("link");
 }
 
 
-docstring InsetHyperlink::xhtml(XHTMLStream & xs, OutputParams const &) const
+docstring InsetHyperlink::xhtml(XMLStream & xs, OutputParams const &) const
 {
-       docstring const & target = getParam("target");
+       docstring const & target =
+               xml::escapeString(getParam("target"), XMLStream::ESCAPE_AND);
        docstring const & name   = getParam("name");
-       xs << html::StartTag("a", to_utf8("href=\"" + target + "\""));
+       xs << xml::StartTag("a", to_utf8("href=\"" + target + "\""));
        xs << (name.empty() ? target : name);
-       xs << html::EndTag("a");
+       xs << xml::EndTag("a");
        return docstring();
 }
 
 
-void InsetHyperlink::tocString(odocstream & os) const
+void InsetHyperlink::toString(odocstream & os) const
 {
-       plaintext(os, OutputParams(0));
+       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");
 }
 
 
@@ -261,12 +279,20 @@ docstring InsetHyperlink::toolTip(BufferView const & /*bv*/, int /*x*/, int /*y*
 void InsetHyperlink::validate(LaTeXFeatures & features) const
 {
        features.require("hyperref");
+       InsetCommand::validate(features);
+}
+
+
+pair<int, int> InsetHyperlink::isWords() const
+{
+       docstring const label = getParam("name");
+       return pair<int, int>(label.size(), wordCount(label));
 }
 
 
-docstring InsetHyperlink::contextMenu(BufferView const &, int, int) const
+string InsetHyperlink::contextMenuName() const
 {
-       return from_ascii("context-hyperlink");
+       return "context-hyperlink";
 }