Spinning Topp Logo BlackTopp Studios
inc
consolestringmanipulation.h
Go to the documentation of this file.
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine 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  The Mezzanine Engine 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 The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _consolestringmanipulation_h
41 #define _consolestringmanipulation_h
42 
43 /// @file
44 /// @brief Some string manipulation functions geared towards console output for use in the Unit Tests.
45 
46 #include "datatypes.h"
47 
48 namespace Mezzanine
49 {
50  namespace Testing
51  {
52  /// @brief Take the whitespace off the end of a String
53  /// @param t The Text to clean up.
54  /// @param If " asdf " is passed " asdf" is returned. Also removes carriage returns, newlines and tabs. Does not use the locale.
56 
57  /// @brief Creates some blank spaces, useful for controlling the vertical location of console text.
58  /// @param Leader The string on the beginning of the line.
59  /// @param Column The desired column that the padding should lead toward
60  /// @return If "asdf" and 6 are passed this will return " " (Two spaces).
61  Mezzanine::String MakePadding(Mezzanine::String Leader, unsigned int Column);
62 
63  /// @brief Makes a c style stron all lowercase with respect to the current locale
64  /// @param StringToConvert This string is actually changed.
65  /// @return for convience purposes the string is also returned.
66  char* AllLower(char* StringToConvert);
67  String AllLower(String StringToConvert);
68 
69  /// @brief Get a String Corresponding to a passed bool
70  /// @param i A bool
71  /// @return "True" if true is passed, "False" if false is passed.
73 
74  }// Testing
75 }// Mezzanine
76 
77 #endif
String MakePadding(String Leader, unsigned int Column)
Creates some blank spaces, useful for controlling the vertical location of console text...
All the definitions for datatypes as well as some basic conversion functions are defined here...
String rtrim(const String &t)
Take the whitespace off the end of a String.
Mezzanine::String BoolToString(bool i)
Get a String Corresponding to a passed bool.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
char * AllLower(char *StringToConvert)
Makes a c style stron all lowercase with respect to the current locale.
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159