annotate foosdk/sdk/pfc/pathUtils.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 #include <functional>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 #include "string_base.h"
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 namespace pfc {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 namespace io {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8 namespace path {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 #ifdef _WINDOWS
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 typedef string::comparatorCaseInsensitive comparator;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 #else
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 typedef string::comparatorCaseSensitive comparator; // wild assumption
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 typedef std::function<const char* (char)> charReplace_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 const char * charReplaceDefault(char);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 const char * charReplaceModern(char);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 string getFileName(string path);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 string getFileNameWithoutExtension(string path);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 string getFileExtension(string path);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 string getParent(string filePath);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 string getDirectory(string filePath);//same as getParent()
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 string combine(string basePath,string fileName);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 char getDefaultSeparator();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 string getSeparators();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 bool isSeparator(char c);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 string getIllegalNameChars(bool allowWC = false);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31 string replaceIllegalNameChars(string fn, bool allowWC = false, charReplace_t replace = charReplaceDefault);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 string replaceIllegalPathChars(string fn, charReplace_t replace = charReplaceDefault);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 bool isInsideDirectory(pfc::string directory, pfc::string inside);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34 bool isDirectoryRoot(string path);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 string validateFileName(string name, bool allowWC = false, bool preserveExt = false, charReplace_t replace = charReplaceDefault);//removes various illegal things from the name, exact effect depends on the OS, includes removal of the invalid characters
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 template<typename t1, typename t2> inline bool equals(const t1 & v1, const t2 & v2) {return comparator::compare(v1,v2) == 0;}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39 template<typename t1, typename t2> inline int compare( t1 const & p1, t2 const & p2 ) {return comparator::compare(p1, p2); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 }