Merging r58475 through r58700 from trunk into soc-2013-depsgraph_mt
[blender.git] / source / blender / blenlib / BLI_path_util.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BLI_PATH_UTIL_H__
28 #define __BLI_PATH_UTIL_H__
29
30 /** \file BLI_path_util.h
31  *  \ingroup bli
32  */
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 struct ListBase;
39 struct direntry;
40
41 const char *BLI_getDefaultDocumentFolder(void);
42
43 const char *BLI_get_folder(int folder_id, const char *subfolder);
44 const char *BLI_get_folder_create(int folder_id, const char *subfolder);
45 const char *BLI_get_user_folder_notest(int folder_id, const char *subfolder);
46 const char *BLI_get_folder_version(const int id, const int ver, const bool do_check);
47
48 /* folder_id */
49
50 /* general, will find based on user/local/system priority */
51 #define BLENDER_DATAFILES           2
52
53 /* user-specific */
54 #define BLENDER_USER_CONFIG         31
55 #define BLENDER_USER_DATAFILES      32
56 #define BLENDER_USER_SCRIPTS        33
57 #define BLENDER_USER_AUTOSAVE       34
58
59 /* system */
60 #define BLENDER_SYSTEM_DATAFILES    52
61 #define BLENDER_SYSTEM_SCRIPTS      53
62 #define BLENDER_SYSTEM_PYTHON       54
63
64 /* for BLI_get_folder_version only */
65 #define BLENDER_RESOURCE_PATH_USER      0
66 #define BLENDER_RESOURCE_PATH_LOCAL     1
67 #define BLENDER_RESOURCE_PATH_SYSTEM    2
68
69 #define BLENDER_STARTUP_FILE    "startup.blend"
70 #define BLENDER_USERPREF_FILE   "userpref.blend"
71 #define BLENDER_QUIT_FILE       "quit.blend"
72 #define BLENDER_BOOKMARK_FILE   "bookmarks.txt"
73 #define BLENDER_HISTORY_FILE    "recent-files.txt"
74
75 #ifdef WIN32
76 #define SEP '\\'
77 #define ALTSEP '/'
78 #else
79 #define SEP '/'
80 #define ALTSEP '\\'
81 #endif
82
83 void BLI_setenv(const char *env, const char *val);
84 void BLI_setenv_if_new(const char *env, const char *val);
85
86 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
87 void BLI_make_exist(char *dir);
88 void BLI_make_existing_file(const char *name);
89 void BLI_split_dirfile(const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen);
90 void BLI_split_dir_part(const char *string, char *dir, const size_t dirlen);
91 void BLI_split_file_part(const char *string, char *file, const size_t filelen);
92 void BLI_path_append(char *__restrict dst, const size_t maxlen,
93                      const char *__restrict file)
94 #ifdef __GNUC__
95 __attribute__((nonnull))
96 #endif
97 ;
98 void BLI_join_dirfile(char *__restrict string, const size_t maxlen,
99                       const char *__restrict dir, const char *__restrict file)
100 #ifdef __GNUC__
101 __attribute__((nonnull))
102 #endif
103 ;
104 const char *BLI_path_basename(const char *path);
105
106 typedef enum bli_rebase_state {
107         BLI_REBASE_NO_SRCDIR = 0,
108         BLI_REBASE_OK        = 1,
109         BLI_REBASE_IDENTITY  = 2
110 } bli_rebase_state;
111
112 int BLI_rebase_path(char *abs, size_t abs_len, char *rel, size_t rel_len, const char *base_dir, const char *src_dir, const char *dest_dir);
113
114 const char *BLI_last_slash(const char *string);
115 int         BLI_add_slash(char *string);
116 void        BLI_del_slash(char *string);
117 const char *BLI_first_slash(const char *string);
118
119 void BLI_getlastdir(const char *dir, char *last, const size_t maxlen);
120 bool BLI_testextensie(const char *str, const char *ext);
121 bool BLI_testextensie_array(const char *str, const char **ext_array);
122 bool BLI_testextensie_glob(const char *str, const char *ext_fnmatch);
123 bool BLI_replace_extension(char *path, size_t maxlen, const char *ext);
124 bool BLI_ensure_extension(char *path, size_t maxlen, const char *ext);
125 void BLI_uniquename(struct ListBase *list, void *vlink, const char *defname, char delim, short name_offs, short len);
126 bool BLI_uniquename_cb(bool (*unique_check)(void *arg, const char *name),
127                        void *arg, const char * defname, char delim, char *name, short name_len);
128 void BLI_newname(char *name, int add);
129 int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
130 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
131 int BLI_split_name_num(char *left, int *nr, const char *name, const char delim);
132
133 /* make sure path separators conform to system one */
134 void BLI_clean(char *path)
135 #ifdef __GNUC__
136 __attribute__((nonnull(1)))
137 #endif
138 ;
139
140 /**
141  * dir can be any input, like from buttons, and this function
142  * converts it to a regular full path.
143  * Also removes garbage from directory paths, like /../ or double slashes etc 
144  */
145 void BLI_cleanup_file(const char *relabase, char *path); /* removes trailing slash */
146 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
147 void BLI_cleanup_path(const char *relabase, char *path); /* doesn't touch trailing slash */
148
149 /* go back one directory */
150 bool BLI_parent_dir(char *path);
151
152 /* return whether directory is root and thus has no parent dir */
153 bool BLI_has_parent(char *path);
154
155 /**
156  * Blender's path code replacement function.
157  * Bases \a path strings leading with "//" by the
158  * directory \a basepath, and replaces instances of
159  * '#' with the \a framenum. Results are written
160  * back into \a path.
161  * 
162  * \a path The path to convert
163  * \a basepath The directory to base relative paths with.
164  * \a framenum The framenumber to replace the frame code with.
165  * \retval Returns true if the path was relative (started with "//").
166  */
167 bool BLI_path_abs(char *path, const char *basepath);
168 bool BLI_path_frame(char *path, int frame, int digits);
169 bool BLI_path_frame_range(char *path, int sta, int end, int digits);
170 bool BLI_path_cwd(char *path);
171 void BLI_path_rel(char *file, const char *relfile);
172
173 bool BLI_path_is_rel(const char *path);
174
175 /* path string comparisons: case-insensitive for Windows, case-sensitive otherwise */
176 #if defined(WIN32)
177 #  define BLI_path_cmp BLI_strcasecmp
178 #  define BLI_path_ncmp BLI_strncasecmp
179 #else
180 #  define BLI_path_cmp strcmp
181 #  define BLI_path_ncmp strncmp
182 #endif
183
184 void BLI_char_switch(char *string, char from, char to)
185 #ifdef __GNUC__
186 __attribute__((nonnull(1)))
187 #endif
188 ;
189
190 /* Initialize path to program executable */
191 void BLI_init_program_path(const char *argv0);
192 /* Initialize path to temporary directory.
193  * NOTE: On Window userdir will be set to the temporary directory! */
194 void BLI_init_temporary_dir(char *userdir);
195
196 const char *BLI_program_path(void);
197 const char *BLI_program_dir(void);
198 const char *BLI_temporary_dir(void);
199 void BLI_system_temporary_dir(char *dir);
200
201 #ifdef WITH_ICONV
202 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
203 #endif
204
205 /* these values need to be hardcoded in structs, dna does not recognize defines */
206 /* also defined in DNA_space_types.h */
207 #ifndef FILE_MAXDIR
208 #  define FILE_MAXDIR         768
209 #  define FILE_MAXFILE        256
210 #  define FILE_MAX            1024
211 #endif
212
213 #ifdef __cplusplus
214 }
215 #endif
216
217 #endif
218