a344c9d2bc13b78bcbdfab7476b6b01afc49f58b
[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 #include "BLI_compiler_attrs.h"
39
40 struct ListBase;
41
42 #ifdef WIN32
43 #define SEP '\\'
44 #define ALTSEP '/'
45 #else
46 #define SEP '/'
47 #define ALTSEP '\\'
48 #endif
49
50 void BLI_setenv(const char *env, const char *val) ATTR_NONNULL(1);
51 void BLI_setenv_if_new(const char *env, const char *val) ATTR_NONNULL(1);
52
53 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
54 void BLI_make_exist(char *dir);
55 void BLI_make_existing_file(const char *name);
56 void BLI_split_dirfile(const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen);
57 void BLI_split_dir_part(const char *string, char *dir, const size_t dirlen);
58 void BLI_split_file_part(const char *string, char *file, const size_t filelen);
59 void BLI_path_append(char *__restrict dst, const size_t maxlen,
60                      const char *__restrict file) ATTR_NONNULL();
61 void BLI_join_dirfile(char *__restrict string, const size_t maxlen,
62                       const char *__restrict dir, const char *__restrict file) ATTR_NONNULL();
63 const char *BLI_path_basename(const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
64
65 #if 0
66 typedef enum bli_rebase_state {
67         BLI_REBASE_NO_SRCDIR = 0,
68         BLI_REBASE_OK        = 1,
69         BLI_REBASE_IDENTITY  = 2
70 } bli_rebase_state;
71
72 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);
73 #endif
74
75 const char *BLI_last_slash(const char *string) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
76 int         BLI_add_slash(char *string) ATTR_NONNULL();
77 void        BLI_del_slash(char *string) ATTR_NONNULL();
78 const char *BLI_first_slash(const char *string) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
79 void        BLI_path_native_slash(char *path) ATTR_NONNULL();
80
81 #ifdef _WIN32
82 bool BLI_path_program_extensions_add_win32(char *name, const size_t maxlen);
83 #endif
84 bool BLI_path_program_search(char *fullname, const size_t maxlen, const char *name);
85
86 void BLI_getlastdir(const char *dir, char *last, const size_t maxlen);
87 bool BLI_testextensie(const char *str, const char *ext) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
88 bool BLI_testextensie_n(const char *str, ...) ATTR_NONNULL(1) ATTR_SENTINEL(0);
89 bool BLI_testextensie_array(const char *str, const char **ext_array) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
90 bool BLI_testextensie_glob(const char *str, const char *ext_fnmatch) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
91 bool BLI_replace_extension(char *path, size_t maxlen, const char *ext) ATTR_NONNULL();
92 bool BLI_ensure_extension(char *path, size_t maxlen, const char *ext) ATTR_NONNULL();
93 bool BLI_ensure_filename(char *filepath, size_t maxlen, const char *filename) ATTR_NONNULL();
94 bool BLI_uniquename(struct ListBase *list, void *vlink, const char *defname, char delim, int name_offs, int len);
95 bool BLI_uniquename_cb(bool (*unique_check)(void *arg, const char *name),
96                        void *arg, const char *defname, char delim, char *name, int name_len);
97 void BLI_newname(char *name, int add);
98 int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
99 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
100 int BLI_split_name_num(char *left, int *nr, const char *name, const char delim);
101
102 /**
103  * dir can be any input, like from buttons, and this function
104  * converts it to a regular full path.
105  * Also removes garbage from directory paths, like /../ or double slashes etc 
106  */
107
108 /* removes trailing slash */
109 void BLI_cleanup_file(const char *relabase, char *path) ATTR_NONNULL(2);
110 /* same as above but adds a trailing slash */
111 void BLI_cleanup_dir(const char *relabase, char *dir) ATTR_NONNULL(2);
112 /* doesn't touch trailing slash */
113 void BLI_cleanup_path(const char *relabase, char *path) ATTR_NONNULL(2);
114
115 bool BLI_filename_make_safe(char *fname) ATTR_NONNULL(1);
116 bool BLI_path_make_safe(char *path) ATTR_NONNULL(1);
117
118 /* go back one directory */
119 bool BLI_parent_dir(char *path) ATTR_NONNULL();
120
121 /**
122  * Blender's path code replacement function.
123  * Bases \a path strings leading with "//" by the
124  * directory \a basepath, and replaces instances of
125  * '#' with the \a framenum. Results are written
126  * back into \a path.
127  * 
128  * \a path The path to convert
129  * \a basepath The directory to base relative paths with.
130  * \a framenum The framenumber to replace the frame code with.
131  * \retval Returns true if the path was relative (started with "//").
132  */
133 bool BLI_path_abs(char *path, const char *basepath)  ATTR_NONNULL();
134 bool BLI_path_frame(char *path, int frame, int digits) ATTR_NONNULL();
135 bool BLI_path_frame_range(char *path, int sta, int end, int digits) ATTR_NONNULL();
136 bool BLI_path_frame_get(char *path, int *r_frame, int *numdigits) ATTR_NONNULL();
137 void BLI_path_frame_strip(char *path, bool setsharp, char *ext) ATTR_NONNULL();
138 bool BLI_path_frame_check_chars(const char *path) ATTR_NONNULL();
139 bool BLI_path_cwd(char *path) ATTR_NONNULL();
140 void BLI_path_rel(char *file, const char *relfile) ATTR_NONNULL();
141
142 bool BLI_path_is_rel(const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
143 bool BLI_path_is_unc(const char *path);
144
145 #if defined(WIN32)
146 void BLI_cleanup_unc_16(wchar_t *path_16);
147 void BLI_cleanup_unc(char *path_16, int maxlen);
148 #endif
149
150 bool BLI_path_suffix(char *string, size_t maxlen, const char *suffix, const char *sep) ATTR_NONNULL();
151
152 /* path string comparisons: case-insensitive for Windows, case-sensitive otherwise */
153 #if defined(WIN32)
154 #  define BLI_path_cmp BLI_strcasecmp
155 #  define BLI_path_ncmp BLI_strncasecmp
156 #else
157 #  define BLI_path_cmp strcmp
158 #  define BLI_path_ncmp strncmp
159 #endif
160
161 #ifdef WITH_ICONV
162 void BLI_string_to_utf8(char *original, char *utf_8, const char *code);
163 #endif
164
165 /* these values need to be hardcoded in structs, dna does not recognize defines */
166 /* also defined in DNA_space_types.h */
167 #ifndef FILE_MAXDIR
168 #  define FILE_MAXDIR         768
169 #  define FILE_MAXFILE        256
170 #  define FILE_MAX            1024
171 #endif
172
173 /* Parent and current dir helpers. */
174 #define FILENAME_PARENT ".."
175 #define FILENAME_CURRENT "."
176
177 /* Avoid calling strcmp on one or two chars! */
178 #define FILENAME_IS_PARENT(_n) (((_n)[0] == '.') && ((_n)[1] == '.') && ((_n)[2] == '\0'))
179 #define FILENAME_IS_CURRENT(_n) (((_n)[0] == '.') && ((_n)[1] == '\0'))
180 #define FILENAME_IS_CURRPAR(_n) (((_n)[0] == '.') && (((_n)[1] == '\0') || (((_n)[1] == '.') && ((_n)[2] == '\0'))))
181
182 #ifdef __cplusplus
183 }
184 #endif
185
186 #endif
187