File: FileInfo.h

package info (click to toggle)
vcmi 1.6.5%2Bdfsg-2
  • links: PTS, VCS
  • area: contrib
  • in suites: forky, sid, trixie
  • size: 32,060 kB
  • sloc: cpp: 238,971; python: 265; sh: 224; xml: 157; ansic: 78; objc: 61; makefile: 49
file content (56 lines) | stat: -rw-r--r-- 1,266 bytes parent folder | download | duplicates (2)
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
/*
 * FileInfo.h, part of VCMI engine
 *
 * Authors: listed in file AUTHORS in main folder
 *
 * License: GNU General Public License v2.0 or later
 * Full text of license available in license.txt file, in main folder
 *
 */
#pragma once

#include <boost/utility/string_ref.hpp>

VCMI_LIB_NAMESPACE_BEGIN

namespace FileInfo
{

/**
 * Returns the name of the file.
 *
 * @return the name of the file. E.g. foo.txt
 */
boost::string_ref DLL_LINKAGE GetFilename(boost::string_ref path);

/**
 * Gets the file extension.
 *
 * @return the file extension. E.g. .ext
 */
boost::string_ref DLL_LINKAGE GetExtension(boost::string_ref path);

/**
 * Gets the file name exclusive the extension of the file.
 *
 * @return the file name exclusive the extension and the path of the file. E.g. foo
 */
boost::string_ref DLL_LINKAGE GetStem(boost::string_ref path);

/**
 * Gets the path to the file only.
 *
 * @return the path to the file only. E.g. ./dir/
 */
boost::string_ref DLL_LINKAGE GetParentPath(boost::string_ref path);

/**
 * Gets the file name + path exclusive the extension of the file.
 *
 * @return the file name exclusive the extension of the file. E.g. ./dir/foo
 */
boost::string_ref DLL_LINKAGE GetPathStem(boost::string_ref path);

}

VCMI_LIB_NAMESPACE_END