Cycles: svn merge -r40934:41157 ^/trunk/blender
[blender.git] / intern / cycles / util / util_path.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  */
18
19 #ifndef __UTIL_PATH_H__
20 #define __UTIL_PATH_H__
21
22 /* Utility functions to get paths to files distributed with the program. For
23  * the standalone apps, paths are relative to the executable, for dynamically
24  * linked libraries, the path to the library may be set with path_init, which
25  * then makes all paths relative to that. */
26
27 #include "util_string.h"
28 #include "util_types.h"
29 #include "util_vector.h"
30
31 CCL_NAMESPACE_BEGIN
32
33 void path_init(const string& path = "", const string& user_path = "");
34 string path_get(const string& sub = "");
35 string path_user_get(const string& sub = "");
36
37 string path_filename(const string& path);
38 string path_dirname(const string& path);
39 string path_join(const string& dir, const string& file);
40
41 string path_escape(const string& path);
42 bool path_exists(const string& path);
43 string path_files_md5_hash(const string& dir);
44
45 void path_create_directories(const string& path);
46 bool path_write_binary(const string& path, const vector<uint8_t>& binary);
47 bool path_read_binary(const string& path, vector<uint8_t>& binary);
48
49 CCL_NAMESPACE_END
50
51 #endif
52