GFilename.hpp
6.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/***************************************************************************
* GFilename.hpp - Filename class *
* ----------------------------------------------------------------------- *
* copyright (C) 2015 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GFilename.hpp
* @brief Filename class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GFILENAME_HPP
#define GFILENAME_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
/***********************************************************************//**
* @class GFilename
*
* @brief Filename class
*
* This class handles filenames.
***************************************************************************/
class GFilename : public GBase {
public:
// Constructors and destructors
GFilename(void);
GFilename(const std::string& filename);
GFilename(const char* filename);
GFilename(const GFilename& filename);
virtual ~GFilename(void);
// Operators
GFilename& operator=(const GFilename& filename);
// Methods
void clear(void);
GFilename* clone(void) const;
std::string classname(void) const;
bool empty(void) const;
int size(void) const;
int length(void) const;
const std::string& filename(void) const;
std::string extname(const std::string& defaultname = "") const;
int extno(const int& defaultno = -1) const;
int extver(const int& defaultver = 0) const;
bool has_extname(void) const;
bool has_extno(void) const;
bool has_extver(void) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GFilename& filename);
void free_members(void);
void set_filename(const std::string& filename);
// Protected members
std::string m_filename; //!< Filename (with stripped extension info)
std::string m_extname; //!< Extension name ("": not set)
int m_extno; //!< Extension number (-1: not set)
int m_extver; //!< Extension version (0: not set)
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GFilename").
***************************************************************************/
inline
std::string GFilename::classname(void) const
{
return ("GFilename");
}
/***********************************************************************//**
* @brief Signal if filename is empty
*
* @return True if filename is empty, false otherwise.
***************************************************************************/
inline
bool GFilename::empty(void) const
{
return (m_filename.empty());
}
/***********************************************************************//**
* @brief Return size of filename
*
* @return Size of filename.
*
* The size of the file name is equal to its length.
***************************************************************************/
inline
int GFilename::size(void) const
{
return (m_filename.size());
}
/***********************************************************************//**
* @brief Return length of filename
*
* @return Length of filename.
***************************************************************************/
inline
int GFilename::length(void) const
{
return (m_filename.length());
}
/***********************************************************************//**
* @brief Return file name
*
* @return String containing file name.
***************************************************************************/
inline
const std::string& GFilename::filename(void) const
{
return (m_filename);
}
/***********************************************************************//**
* @brief Signal if filename has an extension name
*
* @return True if filename has an extension name, false otherwise.
***************************************************************************/
inline
bool GFilename::has_extname(void) const
{
return (!m_extname.empty());
}
/***********************************************************************//**
* @brief Signal if filename has an extension number
*
* @return True if filename has an extension number, false otherwise.
***************************************************************************/
inline
bool GFilename::has_extno(void) const
{
return (m_extno >= 0);
}
/***********************************************************************//**
* @brief Signal if filename has an extension version
*
* @return True if filename has an extension version, false otherwise.
***************************************************************************/
inline
bool GFilename::has_extver(void) const
{
return (m_extver > 0);
}
#endif /* GFILENAME_HPP */