Blender  V3.3
path.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: Apache-2.0
2  * Copyright 2011-2022 Blender Foundation */
3 
4 #ifndef __UTIL_PATH_H__
5 #define __UTIL_PATH_H__
6 
7 /* Utility functions to get paths to files distributed with the program. For
8  * the standalone apps, paths are relative to the executable, for dynamically
9  * linked libraries, the path to the library may be set with path_init, which
10  * then makes all paths relative to that. */
11 
12 #include <stdio.h>
13 
14 #include "util/set.h"
15 #include "util/string.h"
16 #include "util/types.h"
17 #include "util/vector.h"
18 
20 
21 /* program paths */
22 void path_init(const string &path = "", const string &user_path = "");
23 string path_get(const string &sub = "");
24 string path_user_get(const string &sub = "");
25 string path_cache_get(const string &sub = "");
26 
27 /* path string manipulation */
28 string path_filename(const string &path);
29 string path_dirname(const string &path);
30 string path_join(const string &dir, const string &file);
31 string path_escape(const string &path);
32 bool path_is_relative(const string &path);
33 
34 /* file info */
35 size_t path_file_size(const string &path);
36 bool path_exists(const string &path);
37 bool path_is_directory(const string &path);
38 string path_files_md5_hash(const string &dir);
39 uint64_t path_modified_time(const string &path);
40 
41 /* directory utility */
42 void path_create_directories(const string &path);
43 
44 /* file read/write utilities */
45 FILE *path_fopen(const string &path, const string &mode);
46 
47 bool path_write_binary(const string &path, const vector<uint8_t> &binary);
48 bool path_write_text(const string &path, string &text);
49 bool path_read_binary(const string &path, vector<uint8_t> &binary);
50 bool path_read_text(const string &path, string &text);
51 
52 /* File manipulation. */
53 bool path_remove(const string &path);
54 
55 /* source code utility */
56 string path_source_replace_includes(const string &source, const string &path);
57 
58 /* cache utility */
59 void path_cache_clear_except(const string &name, const set<string> &except);
60 
62 
63 #endif
#define CCL_NAMESPACE_END
Definition: cuda/compat.h:9
FILE * file
size_t path_file_size(const string &path)
Definition: path.cpp:550
FILE * path_fopen(const string &path, const string &mode)
Definition: path.cpp:890
void path_cache_clear_except(const string &name, const set< string > &except)
Definition: path.cpp:901
bool path_is_directory(const string &path)
Definition: path.cpp:578
string path_dirname(const string &path)
Definition: path.cpp:399
string path_get(const string &sub="")
Definition: path.cpp:338
string path_source_replace_includes(const string &source, const string &path)
Definition: path.cpp:883
string path_files_md5_hash(const string &dir)
Definition: path.cpp:606
bool path_is_relative(const string &path)
Definition: path.cpp:442
uint64_t path_modified_time(const string &path)
Definition: path.cpp:715
string path_join(const string &dir, const string &file)
Definition: path.cpp:413
bool path_exists(const string &path)
Definition: path.cpp:559
string path_user_get(const string &sub="")
Definition: path.cpp:350
string path_escape(const string &path)
Definition: path.cpp:435
bool path_write_binary(const string &path, const vector< uint8_t > &binary)
Definition: path.cpp:648
bool path_write_text(const string &path, string &text)
Definition: path.cpp:666
bool path_read_text(const string &path, string &text)
Definition: path.cpp:701
void path_create_directories(const string &path)
Definition: path.cpp:642
string path_filename(const string &path)
Definition: path.cpp:376
CCL_NAMESPACE_BEGIN void path_init(const string &path="", const string &user_path="")
Definition: path.cpp:325
string path_cache_get(const string &sub="")
Definition: path.cpp:358
bool path_remove(const string &path)
Definition: path.cpp:724
bool path_read_binary(const string &path, vector< uint8_t > &binary)
Definition: path.cpp:674
unsigned __int64 uint64_t
Definition: stdint.h:90