-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
helper_functions.h
75 lines (70 loc) · 2.2 KB
/
helper_functions.h
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
/*
** MIT License
**
** Copyright(c) 2021 Alec Musasa
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this softwareand associated documentation files(the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and /or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions :
**
** The above copyright noticeand this permission notice shall be included in all
** copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
** OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
** SOFTWARE.
*/
#pragma once
#include <string>
#include <vector>
/// <summary>
/// Extract file name from full path.
/// </summary>
///
/// <param name="full_path">
/// The full path, e.g. C:\\MyFolder\\myFile.txt
/// </param>
///
/// <param name="file_name">
/// The directory in which file specified in sFullPath is.
/// </param>
///
/// <returns>
/// Returns true if successful, else false.
/// </returns>
bool get_filename_from_full_path(
const std::string& full_path,
std::string& file_name);
/// <summary>
/// Extract directory from full path.
/// </summary>
///
/// <param name="full_path">
/// The full path, e.g. C:\\MyFolder\\myFile.txt
/// </param>
///
/// <param name="directory">
/// The directory in which file specified in full_path is.
/// </param>
///
/// <returns>
/// Returns true if successful, else false.
/// </returns>
bool get_directory_from_full_path(
const std::string& full_path,
std::string& directory);
/// <summary>
/// Get the folder from which this module is running.
/// </summary>
///
/// <returns>
/// The full path to the current folder.
/// </returns>
std::string get_current_folder();