Build: use TBB as Embree tasking system
[blender.git] / source / blender / blenlib / BLI_path_util.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19 #ifndef __BLI_PATH_UTIL_H__
20 #define __BLI_PATH_UTIL_H__
21
22 /** \file
23  * \ingroup bli
24  */
25
26 #include "BLI_compiler_attrs.h"
27 #include "BLI_utildefines.h"
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 void BLI_setenv(const char *env, const char *val) ATTR_NONNULL(1);
34 void BLI_setenv_if_new(const char *env, const char *val) ATTR_NONNULL(1);
35 const char *BLI_getenv(const char *env) ATTR_NONNULL(1);
36
37 void BLI_make_file_string(const char *relabase, char *string, const char *dir, const char *file);
38 bool BLI_make_existing_file(const char *name);
39 void BLI_split_dirfile(
40     const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen);
41 void BLI_split_dir_part(const char *string, char *dir, const size_t dirlen);
42 void BLI_split_file_part(const char *string, char *file, const size_t filelen);
43 const char *BLI_path_extension(const char *filepath) ATTR_NONNULL();
44
45 void BLI_path_append(char *__restrict dst, const size_t maxlen, const char *__restrict file)
46     ATTR_NONNULL();
47 void BLI_join_dirfile(char *__restrict string,
48                       const size_t maxlen,
49                       const char *__restrict dir,
50                       const char *__restrict file) ATTR_NONNULL();
51 size_t BLI_path_join(char *__restrict dst, const size_t dst_len, const char *path_first, ...)
52     ATTR_NONNULL(1, 3) ATTR_SENTINEL(0);
53 const char *BLI_path_basename(const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
54 bool BLI_path_name_at_index(const char *__restrict path,
55                             const int index,
56                             int *__restrict r_offset,
57                             int *__restrict r_len) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
58
59 const char *BLI_path_slash_rfind(const char *string) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
60 int BLI_path_slash_ensure(char *string) ATTR_NONNULL();
61 void BLI_path_slash_rstrip(char *string) ATTR_NONNULL();
62 const char *BLI_path_slash_find(const char *string) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
63 void BLI_path_slash_native(char *path) ATTR_NONNULL();
64
65 #ifdef _WIN32
66 bool BLI_path_program_extensions_add_win32(char *name, const size_t maxlen);
67 #endif
68 bool BLI_path_program_search(char *fullname, const size_t maxlen, const char *name);
69
70 bool BLI_path_extension_check(const char *str, const char *ext)
71     ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
72 bool BLI_path_extension_check_n(const char *str, ...) ATTR_NONNULL(1) ATTR_SENTINEL(0);
73 bool BLI_path_extension_check_array(const char *str, const char **ext_array)
74     ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
75 bool BLI_path_extension_check_glob(const char *str, const char *ext_fnmatch)
76     ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
77 bool BLI_path_extension_glob_validate(char *ext_fnmatch) ATTR_NONNULL();
78 bool BLI_path_extension_replace(char *path, size_t maxlen, const char *ext) ATTR_NONNULL();
79 bool BLI_path_extension_ensure(char *path, size_t maxlen, const char *ext) ATTR_NONNULL();
80 bool BLI_path_filename_ensure(char *filepath, size_t maxlen, const char *filename) ATTR_NONNULL();
81 int BLI_path_sequence_decode(const char *string, char *head, char *start, unsigned short *numlen);
82 void BLI_path_sequence_encode(
83     char *string, const char *head, const char *tail, unsigned short numlen, int pic);
84
85 void BLI_path_normalize(const char *relabase, char *path) ATTR_NONNULL(2);
86 /* Same as above but adds a trailing slash. */
87 void BLI_path_normalize_dir(const char *relabase, char *dir) ATTR_NONNULL(2);
88
89 bool BLI_filename_make_safe(char *fname) ATTR_NONNULL(1);
90 bool BLI_path_make_safe(char *path) ATTR_NONNULL(1);
91
92 /* Go back one directory. */
93 bool BLI_path_parent_dir(char *path) ATTR_NONNULL();
94 /* Go back until the directory is found. */
95 bool BLI_path_parent_dir_until_exists(char *path) ATTR_NONNULL();
96
97 bool BLI_path_abs(char *path, const char *basepath) ATTR_NONNULL();
98 bool BLI_path_frame(char *path, int frame, int digits) ATTR_NONNULL();
99 bool BLI_path_frame_range(char *path, int sta, int end, int digits) ATTR_NONNULL();
100 bool BLI_path_frame_get(char *path, int *r_frame, int *numdigits) ATTR_NONNULL();
101 void BLI_path_frame_strip(char *path, char *ext) ATTR_NONNULL();
102 bool BLI_path_frame_check_chars(const char *path) ATTR_NONNULL();
103 bool BLI_path_abs_from_cwd(char *path, const size_t maxlen) ATTR_NONNULL();
104 void BLI_path_rel(char *file, const char *relfile) ATTR_NONNULL();
105
106 bool BLI_path_is_rel(const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
107 bool BLI_path_is_unc(const char *path);
108
109 void BLI_path_to_display_name(char *display_name, int maxlen, const char *name) ATTR_NONNULL();
110
111 #if defined(WIN32)
112 void BLI_path_normalize_unc_16(wchar_t *path_16);
113 void BLI_path_normalize_unc(char *path_16, int maxlen);
114 #endif
115
116 bool BLI_path_suffix(char *string, size_t maxlen, const char *suffix, const char *sep)
117     ATTR_NONNULL();
118
119 /* path string comparisons: case-insensitive for Windows, case-sensitive otherwise */
120 #if defined(WIN32)
121 #  define BLI_path_cmp BLI_strcasecmp
122 #  define BLI_path_ncmp BLI_strncasecmp
123 #else
124 #  define BLI_path_cmp strcmp
125 #  define BLI_path_ncmp strncmp
126 #endif
127
128 /* these values need to be hardcoded in structs, dna does not recognize defines */
129 /* also defined in DNA_space_types.h */
130 #ifndef FILE_MAXDIR
131 #  define FILE_MAXDIR 768
132 #  define FILE_MAXFILE 256
133 #  define FILE_MAX 1024
134 #endif
135
136 #ifdef WIN32
137 #  define SEP '\\'
138 #  define ALTSEP '/'
139 #  define SEP_STR "\\"
140 #  define ALTSEP_STR "/"
141 #else
142 #  define SEP '/'
143 #  define ALTSEP '\\'
144 #  define SEP_STR "/"
145 #  define ALTSEP_STR "\\"
146 #endif
147
148 /* Parent and current dir helpers. */
149 #define FILENAME_PARENT ".."
150 #define FILENAME_CURRENT "."
151
152 /* Avoid calling strcmp on one or two chars! */
153 #define FILENAME_IS_PARENT(_n) (((_n)[0] == '.') && ((_n)[1] == '.') && ((_n)[2] == '\0'))
154 #define FILENAME_IS_CURRENT(_n) (((_n)[0] == '.') && ((_n)[1] == '\0'))
155 #define FILENAME_IS_CURRPAR(_n) \
156   (((_n)[0] == '.') && (((_n)[1] == '\0') || (((_n)[1] == '.') && ((_n)[2] == '\0'))))
157
158 #ifdef __cplusplus
159 }
160 #endif
161
162 #endif /* __BLI_PATH_UTIL_H__ */