ClangFormat: apply to source, most of intern
[blender.git] / intern / cycles / util / util_path.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __UTIL_PATH_H__
18 #define __UTIL_PATH_H__
19
20 /* Utility functions to get paths to files distributed with the program. For
21  * the standalone apps, paths are relative to the executable, for dynamically
22  * linked libraries, the path to the library may be set with path_init, which
23  * then makes all paths relative to that. */
24
25 #include <stdio.h>
26
27 #include "util/util_set.h"
28 #include "util/util_string.h"
29 #include "util/util_types.h"
30 #include "util/util_vector.h"
31
32 CCL_NAMESPACE_BEGIN
33
34 /* program paths */
35 void path_init(const string &path = "", const string &user_path = "");
36 string path_get(const string &sub = "");
37 string path_user_get(const string &sub = "");
38 string path_cache_get(const string &sub = "");
39
40 /* path string manipulation */
41 string path_filename(const string &path);
42 string path_dirname(const string &path);
43 string path_join(const string &dir, const string &file);
44 string path_escape(const string &path);
45 bool path_is_relative(const string &path);
46
47 /* file info */
48 size_t path_file_size(const string &path);
49 bool path_exists(const string &path);
50 bool path_is_directory(const string &path);
51 string path_files_md5_hash(const string &dir);
52 uint64_t path_modified_time(const string &path);
53
54 /* directory utility */
55 void path_create_directories(const string &path);
56
57 /* file read/write utilities */
58 FILE *path_fopen(const string &path, const string &mode);
59
60 bool path_write_binary(const string &path, const vector<uint8_t> &binary);
61 bool path_write_text(const string &path, string &text);
62 bool path_read_binary(const string &path, vector<uint8_t> &binary);
63 bool path_read_text(const string &path, string &text);
64
65 /* File manipulation. */
66 bool path_remove(const string &path);
67
68 /* source code utility */
69 string path_source_replace_includes(const string &source,
70                                     const string &path,
71                                     const string &source_filename = "");
72
73 /* cache utility */
74 void path_cache_clear_except(const string &name, const set<string> &except);
75
76 CCL_NAMESPACE_END
77
78 #endif