Code cleanup: remove BLI_exist, now there is only BLI_exists. One function just
[blender.git] / source / blender / blenlib / BLI_path_util.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 #ifndef BLI_PATH_UTIL_H
30 #define BLI_PATH_UTIL_H
31
32 /** \file BLI_path_util.h
33  *  \ingroup bli
34  */
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct ListBase;
41 struct direntry;
42
43 const char *BLI_getDefaultDocumentFolder(void);
44
45 char *BLI_get_folder(int folder_id, const char *subfolder);
46 char *BLI_get_folder_create(int folder_id, const char *subfolder);
47 char *BLI_get_user_folder_notest(int folder_id, const char *subfolder);
48 char *BLI_get_folder_version(const int id, const int ver, const int do_check);
49
50 /* folder_id */
51
52 /* general, will find based on user/local/system priority */
53 #define BLENDER_DATAFILES                       2
54
55 /* user-specific */
56 #define BLENDER_USER_CONFIG                     31
57 #define BLENDER_USER_DATAFILES          32
58 #define BLENDER_USER_SCRIPTS            33
59 #define BLENDER_USER_PLUGINS            34
60 #define BLENDER_USER_AUTOSAVE           35
61
62 /* system */
63 #define BLENDER_SYSTEM_DATAFILES        52
64 #define BLENDER_SYSTEM_SCRIPTS          53
65 #define BLENDER_SYSTEM_PLUGINS          54
66 #define BLENDER_SYSTEM_PYTHON           54
67
68 /* for BLI_get_folder_version only */
69 #define BLENDER_RESOURCE_PATH_USER              0
70 #define BLENDER_RESOURCE_PATH_LOCAL             1
71 #define BLENDER_RESOURCE_PATH_SYSTEM    2
72
73 #define BLENDER_STARTUP_FILE    "startup.blend"
74 #define BLENDER_BOOKMARK_FILE   "bookmarks.txt"
75 #define BLENDER_HISTORY_FILE    "recent-files.txt"
76
77 #ifdef WIN32
78 #define SEP '\\'
79 #define ALTSEP '/'
80 #else
81 #define SEP '/'
82 #define ALTSEP '\\'
83 #endif
84
85 void BLI_setenv(const char *env, const char *val);
86 void BLI_setenv_if_new(const char *env, const char* val);
87
88 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
89 void BLI_make_exist(char *dir);
90 void BLI_make_existing_file(const char *name);
91 void BLI_split_dirfile(const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen);
92 void BLI_split_dir_part(const char *string, char *dir, const size_t dirlen);
93 void BLI_split_file_part(const char *string, char *file, const size_t filelen);
94 void BLI_join_dirfile(char *string, const size_t maxlen, const char *dir, const char *file);
95 char *BLI_path_basename(char *path);
96 int BKE_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);
97 char *BLI_last_slash(const char *string);
98 int       BLI_add_slash(char *string);
99 void  BLI_del_slash(char *string);
100 char *BLI_first_slash(char *string);
101
102 void BLI_getlastdir(const char* dir, char *last, const size_t maxlen);
103 int BLI_testextensie(const char *str, const char *ext);
104 int BLI_testextensie_array(const char *str, const char **ext_array);
105 int BLI_testextensie_glob(const char *str, const char *ext_fnmatch);
106 int BLI_replace_extension(char *path, size_t maxlen, const char *ext);
107 void BLI_uniquename(struct ListBase *list, void *vlink, const char defname[], char delim, short name_offs, short len);
108 int BLI_uniquename_cb(int (*unique_check)(void *, const char *), void *arg, const char defname[], char delim, char *name, short name_len);
109 void BLI_newname(char * name, int add);
110 int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
111 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
112 int BLI_split_name_num(char *left, int *nr, const char *name, const char delim);
113 void BLI_splitdirstring(char *di,char *fi);
114
115 /* make sure path separators conform to system one */
116 void BLI_clean(char *path);
117
118 /**
119          * dir can be any input, like from buttons, and this function
120          * converts it to a regular full path.
121          * Also removes garbage from directory paths, like /../ or double slashes etc 
122          */
123 void BLI_cleanup_file(const char *relabase, char *dir); /* removes trailing slash */
124 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
125 void BLI_cleanup_path(const char *relabase, char *dir); /* doesn't touch trailing slash */
126
127 /* go back one directory */
128 int BLI_parent_dir(char *path);
129
130 /* return whether directory is root and thus has no parent dir */
131 int BLI_has_parent(char *path);
132
133         /**
134          * Blender's path code replacement function.
135          * Bases @a path strings leading with "//" by the
136          * directory @a basepath, and replaces instances of
137          * '#' with the @a framenum. Results are written
138          * back into @a path.
139          * 
140          * @a path The path to convert
141          * @a basepath The directory to base relative paths with.
142          * @a framenum The framenumber to replace the frame code with.
143          * @retval Returns true if the path was relative (started with "//").
144          */
145 int BLI_path_abs(char *path, const char *basepath);
146 int BLI_path_frame(char *path, int frame, int digits);
147 int BLI_path_frame_range(char *path, int sta, int end, int digits);
148 int BLI_path_cwd(char *path);
149 void BLI_path_rel(char *file, const char *relfile);
150
151 #ifdef WIN32
152 #  define BLI_path_cmp BLI_strcasecmp
153 #  define BLI_path_ncmp BLI_strncasecmp
154 #else
155 #  define BLI_path_cmp strcmp
156 #  define BLI_path_ncmp strncmp
157 #endif
158
159         /**
160          * Change every @a from in @a string into @a to. The
161          * result will be in @a string
162          *
163          * @a string The string to work on
164          * @a from The character to replace
165          * @a to The character to replace with
166          */
167 void BLI_char_switch(char *string, char from, char to);
168
169         /* Initialize path to program executable */
170 void BLI_init_program_path(const char *argv0);
171         /* Initialize path to temporary directory.
172          * NOTE: On Window userdir will be set to the temporary directory! */
173 void BLI_init_temporary_dir(char *userdir);
174
175         /* Path to executable */
176 const char *BLI_program_path(void);
177         /* Path to directory of executable */
178 const char *BLI_program_dir(void);
179         /* Path to temporary directory (with trailing slash) */
180 const char *BLI_temporary_dir(void);
181         /* Path to the system temporary directory (with trailing slash) */
182 void BLI_system_temporary_dir(char *dir);
183
184 #ifdef WITH_ICONV
185 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
186 #endif
187
188 #ifdef __cplusplus
189 }
190 #endif
191
192 #endif
193