Blender V5.3
BLI_path_utils.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
9
10#include "BLI_compiler_attrs.hh"
12#include "BLI_utildefines.hh"
14
15namespace blender {
16
17/* -------------------------------------------------------------------- */
20
33bool BLI_path_name_at_index(const char *__restrict path,
34 int index,
35 int *__restrict r_offset,
36 int *__restrict r_len) ATTR_NONNULL(1, 3, 4) ATTR_WARN_UNUSED_RESULT;
37
42
43bool BLI_path_is_win32_drive(const char *path);
44bool BLI_path_is_win32_drive_only(const char *path);
45bool BLI_path_is_win32_drive_with_slash(const char *path);
46
48
49/* -------------------------------------------------------------------- */
52
61bool BLI_path_parent_dir(char *path) ATTR_NONNULL(1);
69
81const char *BLI_path_parent_dir_end(const char *path, size_t path_len)
83
85
86/* -------------------------------------------------------------------- */
89
121bool BLI_path_make_safe_filename_ex(char *filename, bool allow_tokens) ATTR_NONNULL(1);
123
133bool BLI_path_make_safe(char *path) ATTR_NONNULL(1);
134
141void BLI_path_to_display_name(char *display_name, int display_name_maxncpy, const char *name)
142 ATTR_NONNULL(1, 3);
143
145
146/* -------------------------------------------------------------------- */
149
172int BLI_path_normalize(char *path) ATTR_NONNULL(1);
173
181int BLI_path_normalize_native(char *path) ATTR_NONNULL(1);
182
190int BLI_path_normalize_dir(char *dir, size_t dir_maxncpy) ATTR_NONNULL(1);
191
192#if defined(WIN32)
193void BLI_path_normalize_unc_16(wchar_t *path_16);
194void BLI_path_normalize_unc(char *path, int path_maxncpy);
195#endif
196
198
199/* -------------------------------------------------------------------- */
202
217int BLI_path_canonicalize_native(char *path, int path_maxncpy);
218
220
221/* -------------------------------------------------------------------- */
224
229bool BLI_path_filename_ensure(char *filepath, size_t filepath_maxncpy, const char *filename)
230 ATTR_NONNULL(1, 3);
231
244bool BLI_path_suffix(char *path, size_t path_maxncpy, const char *suffix, const char *sep)
245 ATTR_NONNULL(1, 3, 4);
246
248
249/* -------------------------------------------------------------------- */
252
256const char *BLI_path_slash_find(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
260const char *BLI_path_slash_rfind(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
266int BLI_path_slash_ensure_ex(char *path, size_t path_maxncpy, const size_t path_len)
267 ATTR_NONNULL(1);
272int BLI_path_slash_ensure(char *path, size_t path_maxncpy) ATTR_NONNULL(1);
276void BLI_path_slash_rstrip(char *path) ATTR_NONNULL(1);
280const char *BLI_path_slash_skip(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
284void BLI_path_slash_native(char *path) ATTR_NONNULL(1);
290
292
293/* -------------------------------------------------------------------- */
296
301void BLI_path_split_dir_file(const char *filepath,
302 char *dir,
303 size_t dir_maxncpy,
304 char *file,
305 size_t file_maxncpy) ATTR_NONNULL(1, 2, 4);
309void BLI_path_split_dir_part(const char *filepath, char *dir, size_t dir_maxncpy)
310 ATTR_NONNULL(1, 2);
316void BLI_path_split_file_part(const char *filepath, char *file, size_t file_maxncpy)
317 ATTR_NONNULL(1, 2);
318
325const char *BLI_path_basename(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
326
328
329/* -------------------------------------------------------------------- */
332
337
339
340/* -------------------------------------------------------------------- */
343
348size_t BLI_path_append(char *__restrict dst, size_t dst_maxncpy, const char *__restrict file)
349 ATTR_NONNULL(1, 3);
354size_t BLI_path_append_dir(char *__restrict dst, size_t dst_maxncpy, const char *__restrict dir)
355 ATTR_NONNULL(1, 3);
356
358
359/* -------------------------------------------------------------------- */
362
366size_t BLI_path_join_array(char *__restrict dst,
367 const size_t dst_maxncpy,
368 const char *path_array[],
369 const int path_array_num) ATTR_NONNULL(1, 3);
370
386#define BLI_path_join(...) VA_NARGS_CALL_OVERLOAD(_BLI_path_join_, __VA_ARGS__)
387
388#define _BLI_PATH_JOIN_ARGS_1 char *__restrict dst, size_t dst_maxncpy, const char *a
389#define _BLI_PATH_JOIN_ARGS_2 _BLI_PATH_JOIN_ARGS_1, const char *b
390#define _BLI_PATH_JOIN_ARGS_3 _BLI_PATH_JOIN_ARGS_2, const char *c
391#define _BLI_PATH_JOIN_ARGS_4 _BLI_PATH_JOIN_ARGS_3, const char *d
392#define _BLI_PATH_JOIN_ARGS_5 _BLI_PATH_JOIN_ARGS_4, const char *e
393#define _BLI_PATH_JOIN_ARGS_6 _BLI_PATH_JOIN_ARGS_5, const char *f
394#define _BLI_PATH_JOIN_ARGS_7 _BLI_PATH_JOIN_ARGS_6, const char *g
395#define _BLI_PATH_JOIN_ARGS_8 _BLI_PATH_JOIN_ARGS_7, const char *h
396#define _BLI_PATH_JOIN_ARGS_9 _BLI_PATH_JOIN_ARGS_8, const char *i
397#define _BLI_PATH_JOIN_ARGS_10 _BLI_PATH_JOIN_ARGS_9, const char *j
398
409
411{
412 const char *path_array[] = {a};
413 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
414}
416{
417 const char *path_array[] = {a, b};
418 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
419}
421{
422 const char *path_array[] = {a, b, c};
423 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
424}
426{
427 const char *path_array[] = {a, b, c, d};
428 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
429}
431{
432 const char *path_array[] = {a, b, c, d, e};
433 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
434}
436{
437 const char *path_array[] = {a, b, c, d, e, f};
438 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
439}
441{
442 const char *path_array[] = {a, b, c, d, e, f, g};
443 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
444}
446{
447 const char *path_array[] = {a, b, c, d, e, f, g, h};
448 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
449}
451{
452 const char *path_array[] = {a, b, c, d, e, f, g, h, i};
453 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
454}
456{
457 const char *path_array[] = {a, b, c, d, e, f, g, h, i, j};
458 return BLI_path_join_array(dst, dst_maxncpy, path_array, ARRAY_SIZE(path_array));
459}
460
461#undef _BLI_PATH_JOIN_ARGS_1
462#undef _BLI_PATH_JOIN_ARGS_2
463#undef _BLI_PATH_JOIN_ARGS_3
464#undef _BLI_PATH_JOIN_ARGS_4
465#undef _BLI_PATH_JOIN_ARGS_5
466#undef _BLI_PATH_JOIN_ARGS_6
467#undef _BLI_PATH_JOIN_ARGS_7
468#undef _BLI_PATH_JOIN_ARGS_8
469#undef _BLI_PATH_JOIN_ARGS_9
470#undef _BLI_PATH_JOIN_ARGS_10
471
473
474/* -------------------------------------------------------------------- */
477
482const char *BLI_path_extension_or_end(const char *filepath)
488const char *BLI_path_extension(const char *filepath) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
489
493bool BLI_path_extension_check(const char *path, const char *ext)
495bool BLI_path_extension_check_n(const char *path, ...) ATTR_NONNULL(1) ATTR_SENTINEL(0);
499bool BLI_path_extension_check_array(const char *path, const char **ext_array)
505bool BLI_path_extension_check_glob(const char *path, const char *ext_fnmatch)
516bool BLI_path_extension_glob_validate(char *ext_fnmatch) ATTR_NONNULL(1);
521bool BLI_path_extension_replace(char *path, size_t path_maxncpy, const char *ext)
522 ATTR_NONNULL(1, 3);
527bool BLI_path_extension_strip(char *path) ATTR_NONNULL(1);
531bool BLI_path_extension_ensure(char *path, size_t path_maxncpy, const char *ext)
532 ATTR_NONNULL(1, 3);
533
535
536/* -------------------------------------------------------------------- */
539
540/* Path string comparisons: case-insensitive for Windows, case-sensitive otherwise. */
541#if defined(WIN32)
542# define BLI_path_cmp BLI_strcasecmp
543# define BLI_path_ncmp BLI_strncasecmp
544#else
545# define BLI_path_cmp strcmp
546# define BLI_path_ncmp strncmp
547#endif
548
560int BLI_path_cmp_normalized(const char *p1, const char *p2)
562
564bool BLI_path_contains(const char *container_path, const char *containee_path)
579bool BLI_path_relative_to(const char *path,
580 const char *base_dir,
581 bool walk_up,
582 char *r_path_relative,
583 size_t r_path_relative_maxncpy) ATTR_NONNULL(1, 2);
584
586
587/* -------------------------------------------------------------------- */
590
591#ifdef _WIN32
592bool BLI_path_program_extensions_add_win32(char *program_name, size_t program_name_maxncpy);
593#endif
597bool BLI_path_program_search(char *program_filepath,
598 size_t program_filepath_maxncpy,
599 const char *program_name) ATTR_NONNULL(1, 3);
600
602
603/* -------------------------------------------------------------------- */
606
611void BLI_path_sequence_encode(char *path,
612 size_t path_maxncpy,
613 const char *head,
614 const char *tail,
615 unsigned short numlen,
616 int pic);
617
629int BLI_path_sequence_decode(const char *path,
630 char *head,
631 size_t head_maxncpy,
632 char *tail,
633 size_t tail_maxncpy,
634 unsigned short *r_digits_len);
635
637
638/* -------------------------------------------------------------------- */
641
646bool BLI_path_frame(char *path, size_t path_maxncpy, int frame, int digits) ATTR_NONNULL(1);
652bool BLI_path_frame_range(char *path, size_t path_maxncpy, int sta, int end, int digits)
653 ATTR_NONNULL(1);
659bool BLI_path_frame_get(const char *path, int *r_frame, int *r_digits_len) ATTR_NONNULL(1, 2, 3);
667void BLI_path_frame_strip(char *path, char *r_ext, size_t ext_maxncpy) ATTR_NONNULL(1, 2);
672
674
675/* -------------------------------------------------------------------- */
678
693#ifndef FILE_MAXDIR
694# define FILE_MAXDIR 768
695# define FILE_MAXFILE 256
696# define FILE_MAX 1024
697#endif
698
709bool BLI_path_abs(char path[FILE_MAX], const char *basepath) ATTR_NONNULL(1, 2);
714void BLI_path_rel(char path[FILE_MAX], const char *basepath) ATTR_NONNULL(1);
715
721
723
724/* -------------------------------------------------------------------- */
727
742bool BLI_path_abs_from_cwd(char *path, size_t path_maxncpy) ATTR_NONNULL(1);
743
745
746/* -------------------------------------------------------------------- */
749
750#ifdef WIN32
751constexpr char SEP = '\\';
752constexpr char ALTSEP = '/';
753# define SEP_STR "\\"
754# define ALTSEP_STR "/"
755#else
756constexpr char SEP = '/';
757constexpr char ALTSEP = '\\';
758# define SEP_STR "/"
759# define ALTSEP_STR "\\"
760#endif
761
766{
767 /* On UNIX it only makes sense to treat `/` as a path separator.
768 * On WIN32 either may be used. */
769 if (ch == SEP) {
770 return true;
771 }
772#ifdef WIN32
773 if (ch == ALTSEP) {
774 return true;
775 }
776#endif
777 return false;
778}
779
781
782/* -------------------------------------------------------------------- */
787
792void BLI_setenv(const char *env, const char *val) ATTR_NONNULL(1);
799void BLI_setenv_if_new(const char *env, const char *val) ATTR_NONNULL(1);
808const char *BLI_getenv(const char *env) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT;
809
811
812/* -------------------------------------------------------------------- */
815
816/* Parent and current dir helpers. */
817#define FILENAME_PARENT ".."
818#define FILENAME_CURRENT "."
819
820/* Avoid calling `strcmp` on one or two chars! */
821#define FILENAME_IS_PARENT(_n) (((_n)[0] == '.') && ((_n)[1] == '.') && ((_n)[2] == '\0'))
822#define FILENAME_IS_CURRENT(_n) (((_n)[0] == '.') && ((_n)[1] == '\0'))
823#define FILENAME_IS_CURRPAR(_n) \
824 (((_n)[0] == '.') && (((_n)[1] == '\0') || (((_n)[1] == '.') && ((_n)[2] == '\0'))))
825
827
828} // namespace blender
#define ATTR_SENTINEL(arg_pos)
#define ATTR_WARN_UNUSED_RESULT
#define ATTR_RETURNS_NONNULL
#define ATTR_NONNULL(...)
#define _BLI_PATH_JOIN_ARGS_7
#define _BLI_PATH_JOIN_ARGS_4
#define _BLI_PATH_JOIN_ARGS_9
#define _BLI_PATH_JOIN_ARGS_3
#define _BLI_PATH_JOIN_ARGS_8
#define FILE_MAX
#define _BLI_PATH_JOIN_ARGS_1
#define _BLI_PATH_JOIN_ARGS_5
#define _BLI_PATH_JOIN_ARGS_10
#define _BLI_PATH_JOIN_ARGS_6
#define _BLI_PATH_JOIN_ARGS_2
#define BLI_INLINE
std::string filename(const std::string_view &str, size_t pos)
BMesh Iterators.
bool bool BLI_path_extension_strip(char *path) ATTR_NONNULL(1)
const char * BLI_path_parent_dir_end(const char *path, size_t path_len) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool void bool BLI_path_frame_check_chars(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool BLI_path_is_win32_drive_with_slash(const char *path)
const char * BLI_path_extension_or_end(const char *filepath) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL
bool BLI_path_is_win32_drive(const char *path)
void BLI_path_slash_forward_from_native(char *path) ATTR_NONNULL(1)
bool BLI_path_abs(char path[FILE_MAX], const char *basepath) ATTR_NONNULL(1
bool BLI_path_make_safe(char *path) ATTR_NONNULL(1)
BLI_INLINE size_t _BLI_path_join_10(_BLI_PATH_JOIN_ARGS_8) ATTR_NONNULL()
constexpr char ALTSEP
int BLI_path_normalize_dir(char *dir, size_t dir_maxncpy) ATTR_NONNULL(1)
BLI_INLINE bool BLI_path_slash_is_native_compat(const char ch)
bool bool BLI_path_suffix(char *path, size_t path_maxncpy, const char *suffix, const char *sep) ATTR_NONNULL(1
size_t size_t BLI_path_append_dir(char *__restrict dst, size_t dst_maxncpy, const char *__restrict dir) ATTR_NONNULL(1
BLI_INLINE size_t _BLI_path_join_11(_BLI_PATH_JOIN_ARGS_9) ATTR_NONNULL()
BLI_INLINE size_t _BLI_path_join_7(_BLI_PATH_JOIN_ARGS_5) ATTR_NONNULL()
const char * BLI_path_extension(const char *filepath) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool BLI_path_frame(char *path, size_t path_maxncpy, int frame, int digits) ATTR_NONNULL(1)
size_t BLI_path_append(char *__restrict dst, size_t dst_maxncpy, const char *__restrict file) ATTR_NONNULL(1
BLI_INLINE size_t _BLI_path_join_8(_BLI_PATH_JOIN_ARGS_6) ATTR_NONNULL()
bool BLI_path_frame_get(const char *path, int *r_frame, int *r_digits_len) ATTR_NONNULL(1
void BLI_path_slash_native(char *path) ATTR_NONNULL(1)
void BLI_setenv(const char *env, const char *val) ATTR_NONNULL(1)
bool BLI_path_relative_to(const char *path, const char *base_dir, bool walk_up, char *r_path_relative, size_t r_path_relative_maxncpy) ATTR_NONNULL(1
bool BLI_path_frame_range(char *path, size_t path_maxncpy, int sta, int end, int digits) ATTR_NONNULL(1)
BLI_INLINE size_t _BLI_path_join_6(_BLI_PATH_JOIN_ARGS_4) ATTR_NONNULL()
void void void const char * BLI_path_basename(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool BLI_path_extension_ensure(char *path, size_t path_maxncpy, const char *ext) ATTR_NONNULL(1
BLI_INLINE size_t _BLI_path_join_4(_BLI_PATH_JOIN_ARGS_2) ATTR_NONNULL()
void BLI_path_slash_rstrip(char *path) ATTR_NONNULL(1)
void void BLI_path_split_dir_part(const char *filepath, char *dir, size_t dir_maxncpy) ATTR_NONNULL(1
bool BLI_path_is_unc(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
int BLI_path_canonicalize_native(char *path, int path_maxncpy)
BLI_INLINE size_t _BLI_path_join_5(_BLI_PATH_JOIN_ARGS_3) ATTR_NONNULL()
int BLI_path_cmp_normalized(const char *p1, const char *p2) ATTR_NONNULL(1
bool BLI_path_is_abs_from_cwd(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool BLI_path_program_search(char *program_filepath, size_t program_filepath_maxncpy, const char *program_name) ATTR_NONNULL(1
bool void BLI_path_rel(char path[FILE_MAX], const char *basepath) ATTR_NONNULL(1)
bool BLI_path_abs_from_cwd(char *path, size_t path_maxncpy) ATTR_NONNULL(1)
constexpr size_t ARRAY_SIZE(const T(&arg)[N]) noexcept
bool BLI_path_extension_glob_validate(char *ext_fnmatch) ATTR_NONNULL(1)
int BLI_path_normalize(char *path) ATTR_NONNULL(1)
bool BLI_path_is_win32_drive_only(const char *path)
void BLI_setenv_if_new(const char *env, const char *val) ATTR_NONNULL(1)
int BLI_path_slash_ensure(char *path, size_t path_maxncpy) ATTR_NONNULL(1)
bool BLI_path_extension_replace(char *path, size_t path_maxncpy, const char *ext) ATTR_NONNULL(1
BLI_INLINE size_t _BLI_path_join_9(_BLI_PATH_JOIN_ARGS_7) ATTR_NONNULL()
void BLI_path_to_display_name(char *display_name, int display_name_maxncpy, const char *name) ATTR_NONNULL(1
bool BLI_path_filename_ensure(char *filepath, size_t filepath_maxncpy, const char *filename) ATTR_NONNULL(1
int BLI_path_slash_ensure_ex(char *path, size_t path_maxncpy, const size_t path_len) ATTR_NONNULL(1)
bool BLI_path_name_at_index(const char *__restrict path, int index, int *__restrict r_offset, int *__restrict r_len) ATTR_NONNULL(1
bool BLI_path_parent_dir(char *path) ATTR_NONNULL(1)
void void void BLI_path_split_file_part(const char *filepath, char *file, size_t file_maxncpy) ATTR_NONNULL(1
BLI_INLINE size_t _BLI_path_join_3(_BLI_PATH_JOIN_ARGS_1) ATTR_NONNULL()
bool BLI_path_extension_check_array(const char *path, const char **ext_array) ATTR_NONNULL(1
bool BLI_path_is_rel(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool BLI_path_extension_check(const char *path, const char *ext) ATTR_NONNULL(1
bool BLI_path_contains(const char *container_path, const char *containee_path) ATTR_NONNULL(1
int BLI_path_sequence_decode(const char *path, char *head, size_t head_maxncpy, char *tail, size_t tail_maxncpy, unsigned short *r_digits_len)
Definition path_utils.cc:61
void BLI_path_split_dir_file(const char *filepath, char *dir, size_t dir_maxncpy, char *file, size_t file_maxncpy) ATTR_NONNULL(1
void BLI_path_sequence_encode(char *path, size_t path_maxncpy, const char *head, const char *tail, unsigned short numlen, int pic)
bool BLI_path_has_hidden_component(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
BLI_INLINE size_t _BLI_path_join_12(_BLI_PATH_JOIN_ARGS_10) ATTR_NONNULL()
int BLI_path_normalize_native(char *path) ATTR_NONNULL(1)
bool BLI_path_extension_check_glob(const char *path, const char *ext_fnmatch) ATTR_NONNULL(1
bool void BLI_path_frame_strip(char *path, char *r_ext, size_t ext_maxncpy) ATTR_NONNULL(1
bool ATTR_WARN_UNUSED_RESULT
size_t BLI_path_join_array(char *__restrict dst, const size_t dst_maxncpy, const char *path_array[], const int path_array_num) ATTR_NONNULL(1
bool BLI_path_make_safe_filename(char *filename) ATTR_NONNULL(1)
void ATTR_NONNULL(1, 2)
constexpr char SEP
const char * BLI_path_slash_find(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool BLI_path_parent_dir_until_exists(char *path) ATTR_NONNULL(1)
bool BLI_path_extension_check_n(const char *path,...) ATTR_NONNULL(1) ATTR_SENTINEL(0)
const char * BLI_path_slash_rfind(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
ATTR_WARN_UNUSED_RESULT const BMVert const BMEdge * e
const char * BLI_getenv(const char *env) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT
bool BLI_path_make_safe_filename_ex(char *filename, bool allow_tokens) ATTR_NONNULL(1)
const char * BLI_path_slash_skip(const char *path) ATTR_NONNULL(1) ATTR_WARN_UNUSED_RESULT