patch [#34103] path_util_split_dirstring.patch, path_util_split_dirstring_2.patch...
[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, size_t dirlen, size_t filelen);
90 void BLI_split_dir_part(const char *string, char *dir, size_t dirlen);
91 void BLI_split_file_part(const char *string, char *file, size_t filelen);
92 void BLI_join_dirfile(char *string, size_t maxlen, const char *dir, const char *file);
93 const char *BLI_path_basename(const char *path);
94
95 typedef enum bli_rebase_state {
96         BLI_REBASE_NO_SRCDIR = 0,
97         BLI_REBASE_OK        = 1,
98         BLI_REBASE_IDENTITY  = 2
99 } bli_rebase_state;
100
101 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);
102
103 const char *BLI_last_slash(const char *string);
104 int         BLI_add_slash(char *string);
105 void        BLI_del_slash(char *string);
106 const char *BLI_first_slash(const char *string);
107
108 void BLI_getlastdir(const char *dir, char *last, size_t maxlen);
109 bool BLI_testextensie(const char *str, const char *ext);
110 bool BLI_testextensie_array(const char *str, const char **ext_array);
111 bool BLI_testextensie_glob(const char *str, const char *ext_fnmatch);
112 bool BLI_replace_extension(char *path, size_t maxlen, const char *ext);
113 bool BLI_ensure_extension(char *path, size_t maxlen, const char *ext);
114 void BLI_uniquename(struct ListBase *list, void *vlink, const char * defname, char delim, short name_offs, short len);
115 bool BLI_uniquename_cb(bool (*unique_check)(void * arg, const char * name),
116                        void *arg, const char * defname, char delim, char *name, short name_len);
117 void BLI_newname(char *name, int add);
118 int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
119 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
120 int BLI_split_name_num(char *left, int *nr, const char *name, char delim);
121
122 /* make sure path separators conform to system one */
123 void BLI_clean(char *path)
124 #ifdef __GNUC__
125 __attribute__((nonnull(1)))
126 #endif
127 ;
128
129 /**
130  * dir can be any input, like from buttons, and this function
131  * converts it to a regular full path.
132  * Also removes garbage from directory paths, like /../ or double slashes etc 
133  */
134 void BLI_cleanup_file(const char *relabase, char *path); /* removes trailing slash */
135 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
136 void BLI_cleanup_path(const char *relabase, char *path); /* doesn't touch trailing slash */
137
138 /* go back one directory */
139 bool BLI_parent_dir(char *path);
140
141 /* return whether directory is root and thus has no parent dir */
142 bool BLI_has_parent(char *path);
143
144 /**
145  * Blender's path code replacement function.
146  * Bases \a path strings leading with "//" by the
147  * directory \a basepath, and replaces instances of
148  * '#' with the \a framenum. Results are written
149  * back into \a path.
150  * 
151  * \a path The path to convert
152  * \a basepath The directory to base relative paths with.
153  * \a framenum The framenumber to replace the frame code with.
154  * \retval Returns true if the path was relative (started with "//").
155  */
156 bool BLI_path_abs(char *path, const char *basepath);
157 bool BLI_path_frame(char *path, int frame, int digits);
158 bool BLI_path_frame_range(char *path, int sta, int end, int digits);
159 bool BLI_path_cwd(char *path);
160 void BLI_path_rel(char *file, const char *relfile);
161
162 bool BLI_path_is_rel(const char *path);
163
164 /* path string comparisons: case-insensitive for Windows, case-sensitive otherwise */
165 #ifdef WIN32
166 #  define BLI_path_cmp BLI_strcasecmp
167 #  define BLI_path_ncmp BLI_strncasecmp
168 #else
169 #  define BLI_path_cmp strcmp
170 #  define BLI_path_ncmp strncmp
171 #endif
172
173 /**
174  * Change every \a from in \a string into \a to. The
175  * result will be in \a string
176  *
177  * \a string The string to work on
178  * \a from The character to replace
179  * \a to The character to replace with
180  */
181 void BLI_char_switch(char *string, char from, char to)
182 #ifdef __GNUC__
183 __attribute__((nonnull(1)))
184 #endif
185 ;
186
187 /* Initialize path to program executable */
188 void BLI_init_program_path(const char *argv0);
189 /* Initialize path to temporary directory.
190  * NOTE: On Window userdir will be set to the temporary directory! */
191 void BLI_init_temporary_dir(char *userdir);
192
193 /* Path to executable */
194 const char *BLI_program_path(void);
195 /* Path to directory of executable */
196 const char *BLI_program_dir(void);
197 /* Path to temporary directory (with trailing slash) */
198 const char *BLI_temporary_dir(void);
199 /* Path to the system temporary directory (with trailing slash) */
200 void BLI_system_temporary_dir(char *dir);
201
202 #ifdef WITH_ICONV
203 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
204 #endif
205
206 /* these values need to be hardcoded in structs, dna does not recognize defines */
207 /* also defined in DNA_space_types.h */
208 #ifndef FILE_MAXDIR
209 #  define FILE_MAXDIR         768
210 #  define FILE_MAXFILE        256
211 #  define FILE_MAX            1024
212 #endif
213
214 #ifdef __cplusplus
215 }
216 #endif
217
218 #endif
219