BLI: make BLI_make_existing_file() return true on success, and false on failure...
[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 void BLI_setenv(const char *env, const char *val) ATTR_NONNULL(1);
43 void BLI_setenv_if_new(const char *env, const char *val) ATTR_NONNULL(1);
44
45 void BLI_make_file_string(const char *relabase, char *string,  const char *dir, const char *file);
46 void BLI_make_exist(char *dir);
47 bool BLI_make_existing_file(const char *name);
48 void BLI_split_dirfile(const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen);
49 void BLI_split_dir_part(const char *string, char *dir, const size_t dirlen);
50 void BLI_split_file_part(const char *string, char *file, const size_t filelen);
51 void BLI_path_append(char *__restrict dst, const size_t maxlen,
52                      const char *__restrict file) ATTR_NONNULL();
53 void BLI_join_dirfile(char *__restrict string, const size_t maxlen,
54                       const char *__restrict dir, const char *__restrict file) ATTR_NONNULL();
55 size_t BLI_path_join(
56         char *__restrict dst, const size_t dst_len,
57         const char *path_first, ...) ATTR_NONNULL(1, 3) ATTR_SENTINEL(0);
58 const char *BLI_path_basename(const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
59 bool BLI_path_name_at_index(
60         const char *__restrict path, const int index,
61         int *__restrict r_offset, int *__restrict r_len) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
62
63 #if 0
64 typedef enum bli_rebase_state {
65         BLI_REBASE_NO_SRCDIR = 0,
66         BLI_REBASE_OK        = 1,
67         BLI_REBASE_IDENTITY  = 2
68 } bli_rebase_state;
69
70 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);
71 #endif
72
73 const char *BLI_last_slash(const char *string) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
74 int         BLI_add_slash(char *string) ATTR_NONNULL();
75 void        BLI_del_slash(char *string) ATTR_NONNULL();
76 const char *BLI_first_slash(const char *string) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
77 void        BLI_path_native_slash(char *path) ATTR_NONNULL();
78
79 #ifdef _WIN32
80 bool BLI_path_program_extensions_add_win32(char *name, const size_t maxlen);
81 #endif
82 bool BLI_path_program_search(char *fullname, const size_t maxlen, const char *name);
83
84 bool BLI_testextensie(const char *str, const char *ext) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
85 bool BLI_testextensie_n(const char *str, ...) ATTR_NONNULL(1) ATTR_SENTINEL(0);
86 bool BLI_testextensie_array(const char *str, const char **ext_array) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
87 bool BLI_testextensie_glob(const char *str, const char *ext_fnmatch) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
88 bool BLI_replace_extension(char *path, size_t maxlen, const char *ext) ATTR_NONNULL();
89 bool BLI_ensure_extension(char *path, size_t maxlen, const char *ext) ATTR_NONNULL();
90 bool BLI_ensure_filename(char *filepath, size_t maxlen, const char *filename) ATTR_NONNULL();
91 int BLI_stringdec(const char *string, char *head, char *start, unsigned short *numlen);
92 void BLI_stringenc(char *string, const char *head, const char *tail, unsigned short numlen, int pic);
93
94 /* removes trailing slash */
95 void BLI_cleanup_file(const char *relabase, char *path) ATTR_NONNULL(2);
96 /* same as above but adds a trailing slash */
97 void BLI_cleanup_dir(const char *relabase, char *dir) ATTR_NONNULL(2);
98 /* doesn't touch trailing slash */
99 void BLI_cleanup_path(const char *relabase, char *path) ATTR_NONNULL(2);
100
101 bool BLI_filename_make_safe(char *fname) ATTR_NONNULL(1);
102 bool BLI_path_make_safe(char *path) ATTR_NONNULL(1);
103
104 /* go back one directory */
105 bool BLI_parent_dir(char *path) ATTR_NONNULL();
106
107 bool BLI_path_abs(char *path, const char *basepath)  ATTR_NONNULL();
108 bool BLI_path_frame(char *path, int frame, int digits) ATTR_NONNULL();
109 bool BLI_path_frame_range(char *path, int sta, int end, int digits) ATTR_NONNULL();
110 bool BLI_path_frame_get(char *path, int *r_frame, int *numdigits) ATTR_NONNULL();
111 void BLI_path_frame_strip(char *path, bool set_frame_char, char *ext) ATTR_NONNULL();
112 bool BLI_path_frame_check_chars(const char *path) ATTR_NONNULL();
113 bool BLI_path_cwd(char *path, const size_t maxlen) ATTR_NONNULL();
114 void BLI_path_rel(char *file, const char *relfile) ATTR_NONNULL();
115
116 bool BLI_path_is_rel(const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
117 bool BLI_path_is_unc(const char *path);
118
119 #if defined(WIN32)
120 void BLI_cleanup_unc_16(wchar_t *path_16);
121 void BLI_cleanup_unc(char *path_16, int maxlen);
122 #endif
123
124 bool BLI_path_suffix(char *string, size_t maxlen, const char *suffix, const char *sep) ATTR_NONNULL();
125
126 /* path string comparisons: case-insensitive for Windows, case-sensitive otherwise */
127 #if defined(WIN32)
128 #  define BLI_path_cmp BLI_strcasecmp
129 #  define BLI_path_ncmp BLI_strncasecmp
130 #else
131 #  define BLI_path_cmp strcmp
132 #  define BLI_path_ncmp strncmp
133 #endif
134
135 /* these values need to be hardcoded in structs, dna does not recognize defines */
136 /* also defined in DNA_space_types.h */
137 #ifndef FILE_MAXDIR
138 #  define FILE_MAXDIR         768
139 #  define FILE_MAXFILE        256
140 #  define FILE_MAX            1024
141 #endif
142
143 #ifdef WIN32
144 #  define SEP        '\\'
145 #  define ALTSEP     '/'
146 #  define SEP_STR    "\\"
147 #  define ALTSEP_STR "/"
148 #else
149 #  define SEP        '/'
150 #  define ALTSEP     '\\'
151 #  define SEP_STR    "/"
152 #  define ALTSEP_STR "\\"
153 #endif
154
155 /* Parent and current dir helpers. */
156 #define FILENAME_PARENT ".."
157 #define FILENAME_CURRENT "."
158
159 /* Avoid calling strcmp on one or two chars! */
160 #define FILENAME_IS_PARENT(_n) (((_n)[0] == '.') && ((_n)[1] == '.') && ((_n)[2] == '\0'))
161 #define FILENAME_IS_CURRENT(_n) (((_n)[0] == '.') && ((_n)[1] == '\0'))
162 #define FILENAME_IS_CURRPAR(_n) (((_n)[0] == '.') && (((_n)[1] == '\0') || (((_n)[1] == '.') && ((_n)[2] == '\0'))))
163
164 #ifdef __cplusplus
165 }
166 #endif
167
168 #endif  /* __BLI_PATH_UTIL_H__ */