mastodonpp/include/helpers.hpp

51 lines
1.3 KiB
C++
Raw Normal View History

2020-01-15 19:09:43 +01:00
/* This file is part of mastodonpp.
* Copyright © 2020 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODONPP_HELPERS_HPP
#define MASTODONPP_HELPERS_HPP
#include <string>
#include <string_view>
2020-01-16 19:13:21 +01:00
//! @headerfile helpers.hpp mastodonpp/helpers.hpp
2020-01-15 19:09:43 +01:00
namespace mastodonpp
{
using std::string;
/*!
* @brief Replaces HTML entities with UTF-8 characters.
*
* Supports named and numbered entities, decimal and hexadecimal.
*
* Example:
* @code
* // Will output: 2€ = 2€ = 2€
* std::cout << mastodonpp::unescape_html("2&euro; = 2&#8364; = 2&#x20ac;");
* @endcode
*
2020-01-15 19:09:43 +01:00
* @param html The HTML to unescape.
*
* @since 0.4.0
*/
2020-02-03 13:06:01 +01:00
[[nodiscard]]
2020-01-16 18:19:47 +01:00
string unescape_html(string html);
2020-01-15 19:09:43 +01:00
} // namespace mastodonpp
#endif // MASTODONPP_HELPERS_HPP