style cleanup / comment formatting for bli/bke/bmesh
[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 char *BLI_get_folder(int folder_id, const char *subfolder);
44 char *BLI_get_folder_create(int folder_id, const char *subfolder);
45 char *BLI_get_user_folder_notest(int folder_id, const char *subfolder);
46 char *BLI_get_folder_version(const int id, const int ver, const int 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_PLUGINS            34
58 #define BLENDER_USER_AUTOSAVE           35
59
60 /* system */
61 #define BLENDER_SYSTEM_DATAFILES        52
62 #define BLENDER_SYSTEM_SCRIPTS          53
63 #define BLENDER_SYSTEM_PLUGINS          54
64 #define BLENDER_SYSTEM_PYTHON           54
65
66 /* for BLI_get_folder_version only */
67 #define BLENDER_RESOURCE_PATH_USER              0
68 #define BLENDER_RESOURCE_PATH_LOCAL             1
69 #define BLENDER_RESOURCE_PATH_SYSTEM    2
70
71 #define BLENDER_STARTUP_FILE    "startup.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_join_dirfile(char *string, const size_t maxlen, const char *dir, const char *file);
93 char *BLI_path_basename(char *path);
94 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);
95 char *BLI_last_slash(const char *string);
96 int       BLI_add_slash(char *string);
97 void  BLI_del_slash(char *string);
98 char *BLI_first_slash(char *string);
99
100 void BLI_getlastdir(const char* dir, char *last, const size_t maxlen);
101 int BLI_testextensie(const char *str, const char *ext);
102 int BLI_testextensie_array(const char *str, const char **ext_array);
103 int BLI_testextensie_glob(const char *str, const char *ext_fnmatch);
104 int BLI_replace_extension(char *path, size_t maxlen, const char *ext);
105 int BLI_ensure_extension(char *path, size_t maxlen, const char *ext);
106 void BLI_uniquename(struct ListBase *list, void *vlink, const char defname[], char delim, short name_offs, short len);
107 int BLI_uniquename_cb(int (*unique_check)(void *, const char *), void *arg, const char defname[], char delim, char *name, short name_len);
108 void BLI_newname(char * name, int add);
109 int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
110 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
111 int BLI_split_name_num(char *left, int *nr, const char *name, const char delim);
112 void BLI_splitdirstring(char *di,char *fi);
113
114 /* make sure path separators conform to system one */
115 void BLI_clean(char *path);
116
117 /**
118  * dir can be any input, like from buttons, and this function
119  * converts it to a regular full path.
120  * Also removes garbage from directory paths, like /../ or double slashes etc 
121  */
122 void BLI_cleanup_file(const char *relabase, char *dir); /* removes trailing slash */
123 void BLI_cleanup_dir(const char *relabase, char *dir); /* same as above but adds a trailing slash */
124 void BLI_cleanup_path(const char *relabase, char *dir); /* doesn't touch trailing slash */
125
126 /* go back one directory */
127 int BLI_parent_dir(char *path);
128
129 /* return whether directory is root and thus has no parent dir */
130 int BLI_has_parent(char *path);
131
132 /**
133  * Blender's path code replacement function.
134  * Bases \a path strings leading with "//" by the
135  * directory \a basepath, and replaces instances of
136  * '#' with the \a framenum. Results are written
137  * back into \a path.
138  * 
139  * \a path The path to convert
140  * \a basepath The directory to base relative paths with.
141  * \a framenum The framenumber to replace the frame code with.
142  * \retval Returns true if the path was relative (started with "//").
143  */
144 int BLI_path_abs(char *path, const char *basepath);
145 int BLI_path_frame(char *path, int frame, int digits);
146 int BLI_path_frame_range(char *path, int sta, int end, int digits);
147 int BLI_path_cwd(char *path);
148 void BLI_path_rel(char *file, const char *relfile);
149
150 #ifdef WIN32
151 #  define BLI_path_cmp BLI_strcasecmp
152 #  define BLI_path_ncmp BLI_strncasecmp
153 #else
154 #  define BLI_path_cmp strcmp
155 #  define BLI_path_ncmp strncmp
156 #endif
157
158 /**
159  * Change every \a from in \a string into \a to. The
160  * result will be in \a string
161  *
162  * \a string The string to work on
163  * \a from The character to replace
164  * \a to The character to replace with
165  */
166 void BLI_char_switch(char *string, char from, char to);
167
168         /* Initialize path to program executable */
169 void BLI_init_program_path(const char *argv0);
170         /* Initialize path to temporary directory.
171          * NOTE: On Window userdir will be set to the temporary directory! */
172 void BLI_init_temporary_dir(char *userdir);
173
174         /* Path to executable */
175 const char *BLI_program_path(void);
176         /* Path to directory of executable */
177 const char *BLI_program_dir(void);
178         /* Path to temporary directory (with trailing slash) */
179 const char *BLI_temporary_dir(void);
180         /* Path to the system temporary directory (with trailing slash) */
181 void BLI_system_temporary_dir(char *dir);
182
183 #ifdef WITH_ICONV
184 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
185 #endif
186
187 #ifdef __cplusplus
188 }
189 #endif
190
191 #endif
192