Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

html: add (un)escaping function variants

Browse Source
This commit is contained in:
Simon Rozman 2023-12-07 12:26:41 +01:00
parent b15ab697c2
commit 0d3785850b
1 changed files with 179 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
include/stdex/html.hpp
View File

@ -40,7 +40,7 @@ namespace stdex
template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>> template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>>
inline void escape( inline void escape(
_Inout_ std::basic_string<char, _Traits, _Alloc>& dst, _Inout_ std::basic_string<char, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i]; ++i) { for (size_t i = 0; i < num_chars && src[i]; ++i) {
@ -67,7 +67,7 @@ namespace stdex
template<class _Traits = std::char_traits<wchar_t>, class _Alloc = std::allocator<wchar_t>> template<class _Traits = std::char_traits<wchar_t>, class _Alloc = std::allocator<wchar_t>>
inline void escape( inline void escape(
_Inout_ std::basic_string<wchar_t, _Traits, _Alloc>& dst, _Inout_ std::basic_string<wchar_t, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const wchar_t* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const wchar_t* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i]; ++i) { for (size_t i = 0; i < num_chars && src[i]; ++i) {
@ -84,6 +84,34 @@ namespace stdex
} }
} }
///
/// Appends HTML escaped string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, size_t _Size, class _Traits = std::char_traits<_Elem>, class _Alloc = std::allocator<_Elem>>
inline void escape(
_Inout_ std::basic_string<_Elem, _Traits, _Alloc>& dst,
_In_ const _Elem (&src)[_Size])
{
escape(dst, src, _Size);
}
///
/// Appends HTML escaped string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, class _Traits_dst = std::char_traits<_Elem>, class _Alloc_dst = std::allocator<_Elem>, class _Traits_src = std::char_traits<_Elem>, class _Alloc_src = std::allocator<_Elem>>
inline void escape(
_Inout_ std::basic_string<_Elem, _Traits_dst, _Alloc_dst>& dst,
_In_ const std::basic_string<_Elem, _Traits_src, _Alloc_src>& src)
{
escape(dst, src.data(), src.size());
}
/// ///
/// Appends HTML escaped character /// Appends HTML escaped character
/// ///
@ -130,7 +158,7 @@ namespace stdex
template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>> template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>>
inline void escape_min( inline void escape_min(
_Inout_ std::basic_string<char, _Traits, _Alloc>& dst, _Inout_ std::basic_string<char, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i]; ++i) { for (size_t i = 0; i < num_chars && src[i]; ++i) {
@ -154,7 +182,7 @@ namespace stdex
template<class _Traits = std::char_traits<wchar_t>, class _Alloc = std::allocator<wchar_t>> template<class _Traits = std::char_traits<wchar_t>, class _Alloc = std::allocator<wchar_t>>
inline void escape_min( inline void escape_min(
_Inout_ std::basic_string<wchar_t, _Traits, _Alloc>& dst, _Inout_ std::basic_string<wchar_t, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const wchar_t* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const wchar_t* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i]; ++i) { for (size_t i = 0; i < num_chars && src[i]; ++i) {
@ -168,6 +196,34 @@ namespace stdex
} }
} }
///
/// Appends HTML escaped string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, size_t _Size, class _Traits = std::char_traits<_Elem>, class _Alloc = std::allocator<_Elem>>
inline void escape_min(
_Inout_ std::basic_string<_Elem, _Traits, _Alloc>& dst,
_In_ const _Elem (&src)[_Size])
{
escape_min(dst, src, _Size);
}
///
/// Appends HTML escaped string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, class _Traits_dst = std::char_traits<_Elem>, class _Alloc_dst = std::allocator<_Elem>, class _Traits_src = std::char_traits<_Elem>, class _Alloc_src = std::allocator<_Elem>>
inline void escape_min(
_Inout_ std::basic_string<_Elem, _Traits_dst, _Alloc_dst>& dst,
_In_ const std::basic_string<_Elem, _Traits_src, _Alloc_src>& src)
{
escape_min(dst, src.data(), src.size());
}
/// ///
/// Appends unescaped URL string /// Appends unescaped URL string
/// ///
@ -178,7 +234,7 @@ namespace stdex
template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>> template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>>
inline void url_unescape( inline void url_unescape(
_Inout_ std::basic_string<char, _Traits, _Alloc>& dst, _Inout_ std::basic_string<char, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i];) { for (size_t i = 0; i < num_chars && src[i];) {
@ -210,6 +266,34 @@ namespace stdex
} }
} }
///
/// Appends unescaped URL string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<size_t _Size, class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>>
inline void url_unescape(
_Inout_ std::basic_string<char, _Traits, _Alloc>& dst,
_In_ const char (&src)[_Size])
{
url_unescape(dst, src, _Size);
}
///
/// Appends unescaped URL string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Traits_dst = std::char_traits<char>, class _Alloc_dst = std::allocator<char>, class _Traits_src = std::char_traits<char>, class _Alloc_src = std::allocator<char>>
inline void url_unescape(
_Inout_ std::basic_string<char, _Traits_dst, _Alloc_dst>& dst,
_In_ const std::basic_string<char, _Traits_src, _Alloc_src>& src)
{
url_unescape(dst, src.data(), src.size());
}
/// ///
/// Appends escaped URL string /// Appends escaped URL string
/// ///
@ -220,7 +304,7 @@ namespace stdex
template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>> template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>>
inline void url_escape( inline void url_escape(
_Inout_ std::basic_string<char, _Traits, _Alloc>& dst, _Inout_ std::basic_string<char, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i]; ++i) { for (size_t i = 0; i < num_chars && src[i]; ++i) {
@ -261,6 +345,34 @@ namespace stdex
} }
} }
///
/// Appends escaped URL string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<size_t _Size, class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>>
inline void url_escape(
_Inout_ std::basic_string<char, _Traits, _Alloc>& dst,
_In_ const char (&src)[_Size])
{
url_escape(dst, src, _Size);
}
///
/// Appends escaped URL string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Traits_dst = std::char_traits<char>, class _Alloc_dst = std::allocator<char>, class _Traits_src = std::char_traits<char>, class _Alloc_src = std::allocator<char>>
inline void url_escape(
_Inout_ std::basic_string<char, _Traits_dst, _Alloc_dst>& dst,
_In_ const std::basic_string<char, _Traits_src, _Alloc_src>& src)
{
url_escape(dst, src.data(), src.size());
}
/// ///
/// Appends unescaped CSS string /// Appends unescaped CSS string
/// ///
@ -271,7 +383,7 @@ namespace stdex
template<class _Elem, class _Traits = std::char_traits<_Elem>, class _Alloc = std::allocator<_Elem>> template<class _Elem, class _Traits = std::char_traits<_Elem>, class _Alloc = std::allocator<_Elem>>
inline void css_unescape( inline void css_unescape(
_Inout_ std::basic_string<_Elem, _Traits, _Alloc>& dst, _Inout_ std::basic_string<_Elem, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const _Elem* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const _Elem* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i];) { for (size_t i = 0; i < num_chars && src[i];) {
@ -331,6 +443,34 @@ namespace stdex
} }
} }
///
/// Appends unescaped CSS string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, size_t _Size, class _Traits = std::char_traits<_Elem>, class _Alloc = std::allocator<_Elem>>
inline void css_unescape(
_Inout_ std::basic_string<_Elem, _Traits, _Alloc>& dst,
_In_ const _Elem (&src)[_Size])
{
css_unescape(dst, src, _Size);
}
///
/// Appends unescaped CSS string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, class _Traits_dst = std::char_traits<_Elem>, class _Alloc_dst = std::allocator<_Elem>, class _Traits_src = std::char_traits<_Elem>, class _Alloc_src = std::allocator<_Elem>>
inline void css_unescape(
_Inout_ std::basic_string<_Elem, _Traits_dst, _Alloc_dst>& dst,
_In_ const std::basic_string<_Elem, _Traits_src, _Alloc_src>& src)
{
css_unescape(dst, src.data(), src.size());
}
/// ///
/// Appends escaped CSS string /// Appends escaped CSS string
/// ///
@ -341,7 +481,7 @@ namespace stdex
template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>> template<class _Traits = std::char_traits<char>, class _Alloc = std::allocator<char>>
inline void css_escape( inline void css_escape(
_Inout_ std::basic_string<char, _Traits, _Alloc>& dst, _Inout_ std::basic_string<char, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const char* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i]; ++i) { for (size_t i = 0; i < num_chars && src[i]; ++i) {
@ -367,7 +507,7 @@ namespace stdex
template<class _Traits = std::char_traits<wchar_t>, class _Alloc = std::allocator<wchar_t>> template<class _Traits = std::char_traits<wchar_t>, class _Alloc = std::allocator<wchar_t>>
inline void css_escape( inline void css_escape(
_Inout_ std::basic_string<wchar_t, _Traits, _Alloc>& dst, _Inout_ std::basic_string<wchar_t, _Traits, _Alloc>& dst,
_In_reads_or_z_opt_(num_chars) const wchar_t* src, _In_ size_t num_chars = SIZE_MAX) _In_reads_or_z_opt_(num_chars) const wchar_t* src, _In_ size_t num_chars)
{ {
_Assume_(src || !num_chars); _Assume_(src || !num_chars);
for (size_t i = 0; i < num_chars && src[i]; ++i) { for (size_t i = 0; i < num_chars && src[i]; ++i) {
@ -383,6 +523,34 @@ namespace stdex
} }
} }
///
/// Appends escaped CSS string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, size_t _Size, class _Traits = std::char_traits<_Elem>, class _Alloc = std::allocator<_Elem>>
inline void css_escape(
_Inout_ std::basic_string<_Elem, _Traits, _Alloc>& dst,
_In_ const _Elem (&src)[_Size])
{
css_escape(dst, src, _Size);
}
///
/// Appends escaped CSS string
///
/// \param[in,out] dst String to append to
/// \param[in] src Source string
///
template<class _Elem, class _Traits_dst = std::char_traits<_Elem>, class _Alloc_dst = std::allocator<_Elem>, class _Traits_src = std::char_traits<_Elem>, class _Alloc_src = std::allocator<_Elem>>
inline void css_escape(
_Inout_ std::basic_string<_Elem, _Traits_dst, _Alloc_dst>& dst,
_In_ const std::basic_string<_Elem, _Traits_src, _Alloc_src>& src)
{
css_escape(dst, src.data(), src.size());
}
/// ///
/// HTML element type /// HTML element type
/// ///
@ -1469,7 +1637,7 @@ namespace stdex
/// ///
/// Parses HTML source code by chunks /// Parses HTML source code by chunks
/// ///
void append(_In_reads_or_z_opt_(num_chars) const _Elem* source, _In_ size_t num_chars = SIZE_MAX) void append(_In_reads_or_z_opt_(num_chars) const _Elem* source, _In_ size_t num_chars)
{ {
_Assume_(source || !num_chars); _Assume_(source || !num_chars);
m_source.append(source, stdex::strnlen(source, num_chars)); m_source.append(source, stdex::strnlen(source, num_chars));
@ -1692,7 +1860,7 @@ namespace stdex
/// ///
/// Parses HTML document source code /// Parses HTML document source code
/// ///
inline void assign(_In_reads_or_z_opt_(num_chars) const _Elem* source, _In_ size_t num_chars = SIZE_MAX) inline void assign(_In_reads_or_z_opt_(num_chars) const _Elem* source, _In_ size_t num_chars)
{ {
clear(); clear();
append(source, num_chars); append(source, num_chars);