E-MailRelay

gxtext.h
Go to the documentation of this file.
1//
2// Copyright (C) 2001-2021 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 <string>
26
27 namespace G
28{
29 class Xtext ;
30}
31
32//| \class G::Xtext
33/// An xtext codec class, encoding space as "+20" etc.
34/// \see RFC-1891 section 5
35///
36 class G::Xtext
37{
38 public:
39 static std::string encode( const std::string & ) ;
40 ///< Encodes the given string.
41
42 static std::string decode( const std::string & ) ;
43 ///< Decodes the given string. Input strings must be
44 ///< un-strictly valid(), otherwise the result is
45 ///< undefined.
46
47 static bool valid( const std::string & , bool strict = false ) ;
48 ///< Returns true if a valid encoding. If strict
49 ///< then 'equals' and 'space' are disallowed and
50 ///< hex characters must be uppercase (eg. "+1A").
51
52 public:
53 Xtext() = delete ;
54} ;
55
56#endif
G::Xtext
An xtext codec class, encoding space as "+20" etc.
Definition: gxtext.h:37
G::Xtext::decode
static std::string decode(const std::string &)
Decodes the given string.
Definition: gxtext.cpp:117
G::Xtext::valid
static bool valid(const std::string &, bool strict=false)
Returns true if a valid encoding.
Definition: gxtext.cpp:75
G::Xtext::encode
static std::string encode(const std::string &)
Encodes the given string.
Definition: gxtext.cpp:95
G
Low-level classes.
Definition: galign.h:28