griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: rename BLI_paths_equal to BLI_path_cmp_normalized

Browse Source 
Changes to recent addition: c85c52f2ce.

Having both BLI_paths_equal and BLI_path_cmp made it ambiguous
which should be used, as `BLI_paths_equal` wasn't the equivalent to
`BLI_path_cmp(..) == 0` as it is for string equals macro `STREQ(..)`.
It's also a more specialized function which is not used for path
comparison throughout Blender's internal path handling logic.

Instead rename this `BLI_path_cmp_normalized` and return the result of
`BLI_path_cmp` to make it clear paths are modified before comparison.

Also add comments about the conventions for Blender's path comparison
as well as a possible equivalent to Python's `os.path.samefile`
for checking if two paths point to the same location on the file-system.
This commit is contained in:
Campbell Barton
2022-01-28 13:59:06 +11:00
parent f2b24272dd
commit 7475012e24
3 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
source/blender/blenlib/BLI_path_util.h
View File

@@ -380,11 +380,6 @@ void BLI_path_normalize_unc_16(wchar_t *path_16);
void BLI_path_normalize_unc(char *path_16, int maxlen);
#endif
/**
* Returns true if the given paths are equal.
*/
bool BLI_paths_equal(const char *p1, const char *p2);
/**
* Appends a suffix to the string, fitting it before the extension
*
@@ -409,6 +404,19 @@ bool BLI_path_suffix(char *string, size_t maxlen, const char *suffix, const char
# define BLI_path_ncmp strncmp
#endif
/**
* Returns the result of #BLI_path_cmp with both paths normalized and slashes made native.
*
* \note #BLI_path_cmp is used for Blender's internal logic to consider paths to be the same
* #BLI_path_cmp_normalized may be used in when handling other kinds of paths
* (e.g. importers/exporters) but should be used consistently.
*
* Checking the normalized paths is not a guarantee the paths reference different files.
* An equivalent to Python's `os.path.samefile` could be supported for checking if paths
* point to the same location on the file-system (following symbolic-links).
*/
int BLI_path_cmp_normalized(const char *p1, const char *p2);
/* These values need to be hard-coded in structs, dna does not recognize defines */
/* also defined in `DNA_space_types.h`. */
#ifndef FILE_MAXDIR

4
source/blender/blenlib/intern/path_util.c
View File

@@ -1830,7 +1830,7 @@ void BLI_path_slash_native(char *path)
#endif
}
bool BLI_paths_equal(const char *p1, const char *p2)
int BLI_path_cmp_normalized(const char *p1, const char *p2)
{
/* Normalize the paths so we can compare them. */
char norm_p1[FILE_MAX];
@@ -1845,5 +1845,5 @@ bool BLI_paths_equal(const char *p1, const char *p2)
BLI_path_normalize(NULL, norm_p1);
BLI_path_normalize(NULL, norm_p2);
return BLI_path_cmp(norm_p1, norm_p2) == 0;
return BLI_path_cmp(norm_p1, norm_p2);
}

6
source/blender/io/usd/intern/usd_writer_material.cc
View File

@@ -397,7 +397,7 @@ static void export_in_memory_texture(Image *ima,
return;
}
if (BLI_paths_equal(export_path, image_abs_path) && BLI_exists(image_abs_path)) {
if ((BLI_path_cmp_normalized(export_path, image_abs_path) == 0) && BLI_exists(image_abs_path)) {
/* As a precaution, don't overwrite the original path. */
return;
}
@@ -668,7 +668,7 @@ static void copy_tiled_textures(Image *ima,
continue;
}
if (BLI_paths_equal(src_tile_path, dest_tile_path)) {
if (BLI_path_cmp_normalized(src_tile_path, dest_tile_path) == 0) {
/* Source and destination paths are the same, don't copy. */
continue;
}
@@ -703,7 +703,7 @@ static void copy_single_file(Image *ima, const std::string &dest_dir, const bool
return;
}
if (BLI_paths_equal(source_path, dest_path)) {
if (BLI_path_cmp_normalized(source_path, dest_path) == 0) {
/* Source and destination paths are the same, don't copy. */
return;
}