Well, it turns out that we need a different return value for the xhtml

[lyx.git] / src / insets / InsetHyperlink.cpp

diff --git a/src/insets/InsetHyperlink.cpp b/src/insets/InsetHyperlink.cpp
index 6db2babd08b4286843d3058f0aa9c619179719b8..aa4ff3af7d784655d07bacb73bb8e753945067b6 100644 (file)
--- 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.
  */
@@ -64,27 +64,45 @@ docstring InsetHyperlink::screenLabel() const
 }
 
 
-int InsetHyperlink::latex(odocstream & os, OutputParams const & runparams) const
+int InsetHyperlink::latex(odocstream & 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 "://" or "run:" is given
                docstring type = getParam("type");
@@ -95,12 +113,9 @@ int InsetHyperlink::latex(odocstream & os, OutputParams const & runparams) const
 
        } // 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{}");
@@ -110,15 +125,17 @@ 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;
@@ -130,9 +147,8 @@ int InsetHyperlink::latex(odocstream & os, OutputParams const & runparams) const
        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) << '}';
+       // output the ready \href command
+       os << "\\href{" << getParam("type") << url << "}{" << name << '}';
 
        return 0;
 }
@@ -165,6 +181,18 @@ int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const
 }
 
 
+docstring InsetHyperlink::xhtml(odocstream & os, OutputParams const &) const
+{
+       os << "<a href=\""
+                       // FIXME Do we need to do more escaping than this?
+          << subst(getParam("target"), from_ascii("&"), from_ascii("&amp;"))
+          << "\">"
+          << getParam("name")
+          << "</a>";
+       return docstring();
+}
+
+
 void InsetHyperlink::tocString(odocstream & os) const
 {
        plaintext(os, OutputParams(0));