Blender V2.61 - r43446

util_path.h

Go to the documentation of this file.
00001 /*
00002  * Copyright 2011, Blender Foundation.
00003  *
00004  * This program is free software; you can redistribute it and/or
00005  * modify it under the terms of the GNU General Public License
00006  * as published by the Free Software Foundation; either version 2
00007  * of the License, or (at your option) any later version.
00008  *
00009  * This program is distributed in the hope that it will be useful,
00010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  * GNU General Public License for more details.
00013  *
00014  * You should have received a copy of the GNU General Public License
00015  * along with this program; if not, write to the Free Software Foundation,
00016  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
00017  */
00018 
00019 #ifndef __UTIL_PATH_H__
00020 #define __UTIL_PATH_H__
00021 
00022 /* Utility functions to get paths to files distributed with the program. For
00023  * the standalone apps, paths are relative to the executable, for dynamically
00024  * linked libraries, the path to the library may be set with path_init, which
00025  * then makes all paths relative to that. */
00026 
00027 #include "util_string.h"
00028 #include "util_types.h"
00029 #include "util_vector.h"
00030 
00031 CCL_NAMESPACE_BEGIN
00032 
00033 void path_init(const string& path = "", const string& user_path = "");
00034 string path_get(const string& sub = "");
00035 string path_user_get(const string& sub = "");
00036 
00037 string path_filename(const string& path);
00038 string path_dirname(const string& path);
00039 string path_join(const string& dir, const string& file);
00040 
00041 string path_escape(const string& path);
00042 bool path_exists(const string& path);
00043 string path_files_md5_hash(const string& dir);
00044 
00045 void path_create_directories(const string& path);
00046 bool path_write_binary(const string& path, const vector<uint8_t>& binary);
00047 bool path_read_binary(const string& path, vector<uint8_t>& binary);
00048 
00049 string path_source_replace_includes(const string& source, const string& path);
00050 
00051 CCL_NAMESPACE_END
00052 
00053 #endif
00054