E-MailRelay

gxtext.h
Go to the documentation of this file.
1//
2// Copyright (C) 2001-2024 Graeme Walker <graeme_walker@users.sourceforge.net>
3//
4// This program is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program. If not, see <http://www.gnu.org/licenses/>.
16// ===
17///
18/// \file gxtext.h
19///
20
21#ifndef G_XTEXT_H
22#define G_XTEXT_H
23
24#include "gdef.h"
25#include "gstringview.h"
26#include <string>
27
28 namespace G
29{
30 class Xtext ;
31}
32
33//| \class G::Xtext
34/// An xtext codec class, encoding space as "+20" etc.
35/// \see RFC-1891 section 5
36///
37 class G::Xtext
38{
39 public:
40 static std::string encode( std::string_view ) ;
41 ///< Encodes the given string.
42
43 static std::string decode( std::string_view ) ;
44 ///< Decodes the given string. Input strings must be
45 ///< un-strictly valid(), otherwise the result is
46 ///< undefined.
47
48 static bool valid( std::string_view , bool strict = false ) ;
49 ///< Returns true if a valid encoding, or empty. If
50 ///< strict then 'equals' and 'space' are disallowed
51 ///< and hex characters must be uppercase (eg. "+1A").
52
53 public:
54 Xtext() = delete ;
55} ;
56
57#endif
G::Xtext
An xtext codec class, encoding space as "+20" etc.
Definition: gxtext.h:38
G::Xtext::encode
static std::string encode(std::string_view)
Encodes the given string.
Definition: gxtext.cpp:97
G::Xtext::decode
static std::string decode(std::string_view)
Decodes the given string.
Definition: gxtext.cpp:119
G::Xtext::valid
static bool valid(std::string_view, bool strict=false)
Returns true if a valid encoding, or empty.
Definition: gxtext.cpp:77
gstringview.h
G
Low-level classes.
Definition: garg.h:36