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