X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetHyperlink.cpp;h=aa4ff3af7d784655d07bacb73bb8e753945067b6;hb=67e70c6c022fa445cd654937faeb87955e3bca7a;hp=31737ec1473ad7e612c604e80d2257894d63a9ac;hpb=bd820e1168380c516a162512ffa4028386011d54;p=lyx.git diff --git a/src/insets/InsetHyperlink.cpp b/src/insets/InsetHyperlink.cpp index 31737ec147..aa4ff3af7d 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. */ @@ -16,45 +16,36 @@ #include "DispatchResult.h" #include "FuncRequest.h" #include "LaTeXFeatures.h" -#include "gettext.h" #include "OutputParams.h" -#include "support/lstrings.h" #include "support/docstream.h" +#include "support/gettext.h" +#include "support/lstrings.h" +using namespace std; +using namespace lyx::support; namespace lyx { -using support::subst; - -using std::string; -using std::ostream; -using std::find; -using std::replace; - -//FIXME: these should be lists of char_type and not char -static char_type const chars_url[2] = {'%', '#'}; - -static char_type const chars_name[6] = { - '&', '_', '$', '%', '#', '^'}; - InsetHyperlink::InsetHyperlink(InsetCommandParams const & p) : InsetCommand(p, "href") {} -CommandInfo const * InsetHyperlink::findInfo(std::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); + param_info_.add("target", ParamInfo::LATEX_REQUIRED); + param_info_.add("type", ParamInfo::LATEX_REQUIRED); + } + return param_info_; } -docstring const InsetHyperlink::getScreenLabel(Buffer const &) const +docstring InsetHyperlink::screenLabel() const { docstring const temp = from_ascii("Hyperlink: "); @@ -73,78 +64,97 @@ docstring const InsetHyperlink::getScreenLabel(Buffer const &) const } -int InsetHyperlink::latex(Buffer const &, odocstream & os, - OutputParams const & runparams) const +int InsetHyperlink::latex(odocstream & os, + OutputParams const & runparams) const { - //FIXME: all strings in this routine should be docstrings 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. + if (name.empty()) + name = url; - docstring backslash = from_ascii("\\"); - docstring braces = from_ascii("{}"); - - // 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++) { + // 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]); - } - } - } // end if (!url.empty()) + + // 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; - docstring name = getParam("name"); + } // 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 textbackslash = from_ascii("\\textbackslash{}"); + 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] != '\\') + 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 - docstring sim = from_ascii("$\\sim$"); - for (int i = 0, pos; + + // 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); } // 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 << '}'; + + // output the ready \href command + os << "\\href{" << getParam("type") << url << "}{" << name << '}'; + return 0; } -int InsetHyperlink::plaintext(Buffer const &, odocstream & os, - OutputParams const &) const +int InsetHyperlink::plaintext(odocstream & os, OutputParams const &) const { odocstringstream oss; @@ -160,8 +170,7 @@ int InsetHyperlink::plaintext(Buffer const &, odocstream & os, } -int InsetHyperlink::docbook(Buffer const &, odocstream & os, - OutputParams const &) const +int InsetHyperlink::docbook(odocstream & os, OutputParams const &) const { os << "" + << getParam("name") + << ""; + return docstring(); +} + + +void InsetHyperlink::tocString(odocstream & os) const { - return plaintext(buf, os, op); + plaintext(os, OutputParams(0)); }