All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
CollapseWsPipe.h
Go to the documentation of this file.
1 // Copyright 2015, 2016 Thomas Trapp
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef HEXT_COLLAPSEWSPIPE_H_INCLUDED
16 #define HEXT_COLLAPSEWSPIPE_H_INCLUDED
17 
18 /// @file
19 /// Declares hext::CollapseWsPipe
20 
21 #include "hext/Cloneable.h"
22 #include "hext/StringPipe.h"
23 #include "hext/Visibility.h"
24 
25 #include <string>
26 
27 
28 namespace hext {
29 
30 
31 /// Removes whitespace from beginning and end and collapses multiple whitespace
32 /// to a single space.
33 ///
34 /// @par Example:
35 /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 /// " Like\na Rolling\n\tStone "
37 /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 /// becomes
39 /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 /// "Like a Rolling Stone"
41 /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43  : public hext::Cloneable<CollapseWsPipe, StringPipe>
44 {
45 public:
46  /// Collapses multiple whitespace to a single space
47  std::string transform(std::string str) const override;
48 };
49 
50 
51 } // namespace hext
52 
53 
54 #endif // HEXT_COLLAPSEWSPIPE_H_INCLUDED
55 
Declares hext::StringPipe.
Defines HEXT_PUBLIC and HEXT_PRIVATE.
#define HEXT_PUBLIC
Definition: Visibility.h:26
Curiously recurring template pattern that extends a base class to provide a virtual method Cloneable:...
Definition: Cloneable.h:36
Defines template hext::Cloneable.
Removes whitespace from beginning and end and collapses multiple whitespace to a single space...