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
|
/***********************************************/
/**
* @file fileName.h
*
* @brief File names
*
* @author Torsten Mayer-Guerr
* @date 2008-07-28
*
*/
/***********************************************/
#ifndef __GROOPS_FILENAME__
#define __GROOPS_FILENAME__
#include "base/importStd.h"
#include "parser/expressionParser.h"
/***** CLASS ***********************************/
/** @brief File names.
* @ingroup inputOutputGroup */
class FileName
{
std::string nameUnparsed;
mutable std::string nameParsed;
mutable Bool resolved;
VariableList varList;
void resolve() const;
public:
FileName(); //!< Constructor.
FileName(const FileName &) = default; //!< Copy constructor.
FileName(const std::string &name); //!< Constructor.
FileName(const char *name) : FileName(std::string(name)) {} //!< Constructor.
FileName(const std::string &name, const VariableList &varList); //!< Constructor with parsing.
FileName &operator=(const FileName &) = default; //!< Assignment.
operator const std::string&() const {resolve(); return nameParsed;} //!< Cast to string.
operator const char *() const {resolve(); return nameParsed.c_str();} //!< Cast to old C type string.
const char *c_str() const {resolve(); return nameParsed.c_str();} //!< Old C type string.
const std::string &str() const {resolve(); return nameParsed;} //!< String.
/** @brief Is FileName empty? */
Bool empty() const {return nameUnparsed.empty();}
/** @brief Append a fileName to a directory.
* Directory and file will be separated by the directory separator (e.g. '/') if needed. */
FileName append(const FileName& fileName) const;
/** @brief Extension.
* Returns the string of all characters in the FileName
* after (but not including) the last '.' character plus an additional ".gz" or ".z".
* Example: FileName("name.txt.gz").typeExtension() returns "txt.gz". */
FileName fullExtension() const;
/** @brief Extension.
* Returns the string of all characters in the FileName
* after (but not including) the last '.' character without an additional ".gz" or ".z".
* Example: FileName("name.txt.gz").typeExtension() returns "txt". */
FileName typeExtension() const;
/** @brief Extension.
* Example: FileName("name.txt.gz").typeExtension() returns "gz". */
FileName packExtension() const;
/** @brief File name without extension.
* Returns the string of all characters in the FileName
* before (but not including) the last '.' character. */
FileName stripFullExtension() const;
/** @brief Replaces the extension with text.
* Firstly, if this path has an extension(), it is removed.
* Then, a dot character is appended if text is not empty or does not begin with a dot character.
* Then text is appended to the path. */
FileName replaceFullExtension(const std::string &text) const;
/** @brief Directory name of file.
* Returns the string of all characters in the FileName
* name before the last '/' character. */
FileName directory() const;
/** @brief File name without directory.
* Returns the string of all characters in the FileName
* name after (but not including) the last '/' character. */
FileName stripDirectory() const;
/** @brief File name without directory and extension.
* Returns (*this).stripDirectory().stripFullExtension(). */
FileName baseName() const {return stripDirectory().stripFullExtension();}
/** @brief Extent the baseName.
* Returns a FileName with appending text before '.'+extension(). */
FileName appendBaseName(const std::string &text) const;
/** Returns a FileName with replaced variable {name} names. */
FileName operator()(const VariableList &varList) const;
/** @brief 'Less than' operator, required for sorting. */
Bool operator< (const FileName &fileName) const {resolve(); return nameParsed < fileName.nameParsed;}
};
/*************************************************/
#endif /* __GROOPS__ */
|
