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