CString.h
Go to the documentation of this file.
1 //==============================================================================
2 /*
3  Software License Agreement (BSD License)
4  Copyright (c) 2003-2016, CHAI3D.
5  (www.chai3d.org)
6 
7  All rights reserved.
8 
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions
11  are met:
12 
13  * Redistributions of source code must retain the above copyright
14  notice, this list of conditions and the following disclaimer.
15 
16  * Redistributions in binary form must reproduce the above
17  copyright notice, this list of conditions and the following
18  disclaimer in the documentation and/or other materials provided
19  with the distribution.
20 
21  * Neither the name of CHAI3D nor the names of its contributors may
22  be used to endorse or promote products derived from this software
23  without specific prior written permission.
24 
25  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  POSSIBILITY OF SUCH DAMAGE.
37 
38  \author <http://www.chai3d.org>
39  \author Francois Conti
40  \author Dan Morris
41  \version 3.2.0 $Rev: 1869 $
42 */
43 //==============================================================================
44 
45 //------------------------------------------------------------------------------
46 #ifndef CStringH
47 #define CStringH
48 //------------------------------------------------------------------------------
49 #include <string>
50 //------------------------------------------------------------------------------
51 
52 //------------------------------------------------------------------------------
53 namespace chai3d {
54 //------------------------------------------------------------------------------
55 
56 //==============================================================================
64 //==============================================================================
65 
66 //------------------------------------------------------------------------------
70 //------------------------------------------------------------------------------
71 
73 
74 //------------------------------------------------------------------------------
75 // ANSI STRINGS:
76 //------------------------------------------------------------------------------
77 
79 int cStrLength(const char* a_input);
80 
81 
82 //------------------------------------------------------------------------------
83 // FILENAME TOOLS:
84 //------------------------------------------------------------------------------
85 
87 std::string cGetFilename(const std::string& a_input, const bool a_includeFileExtension = true);
88 
90 std::string cGetFileExtension(const std::string& a_input, const bool a_includeDot = false);
91 
93 std::string cGetDirectory(const std::string& a_input);
94 
96 std::string cReplaceFileExtension(const std::string& a_input, const std::string& a_extension);
97 
98 
99 //------------------------------------------------------------------------------
100 // CONVERTING VALUES TO STRINGS:
101 //------------------------------------------------------------------------------
102 
104 std::string cStr(const bool a_value);
105 
107 std::string cStr(const int a_value);
108 
110 std::string cStr(const unsigned int a_value);
111 
113 std::string cStr(const float a_value, const unsigned int a_precision = 2);
114 
116 std::string cStr(const double a_value, const unsigned int a_precision = 2);
117 
119 std::string cStrToLower(const std::string& a_input);
120 
122 
123 //------------------------------------------------------------------------------
124 } // namespace chai3d
125 //------------------------------------------------------------------------------
126 
127 //------------------------------------------------------------------------------
128 #endif
129 //------------------------------------------------------------------------------
chai3d::cReplaceFileExtension
std::string cReplaceFileExtension(const std::string &a_input, const std::string &a_extension)
This function replaces the file extension of a filename with a new extension name.
Definition: CString.cpp:165
chai3d::cGetDirectory
std::string cGetDirectory(const std::string &a_input)
This function extracts the directory path from the full file path.
Definition: CString.cpp:148
chai3d::cStrLength
int cStrLength(const char *a_input)
This function computes the length of an ANSI string.
Definition: CString.cpp:71
chai3d::cStr
std::string cStr(const bool a_value)
This function converts a boolean into a string.
Definition: CString.cpp:189
chai3d::cGetFileExtension
std::string cGetFileExtension(const std::string &a_input, const bool a_includeDot)
This function extracts the file extension of a file.
Definition: CString.cpp:122
chai3d::cStrToLower
std::string cStrToLower(const std::string &a_input)
This function converts a string to lower case.
Definition: CString.cpp:283
chai3d::cGetFilename
std::string cGetFilename(const std::string &a_input, const bool a_includeFileExtension)
This function extracts the filename with or without its extension.
Definition: CString.cpp:88
chai3d
Definition: CAudioBuffer.cpp:56