cwk_path_normalize.md (2416B)
1 --- 2 title: cwk_path_normalize 3 description: Creates a normalized version of the path. 4 --- 5 6 _(since v1.0.0)_ 7 Creates a normalized version of the path. 8 9 ## Description 10 ```c 11 size_t cwk_path_normalize(const char *path, char *buffer, size_t buffer_size); 12 ``` 13 14 This function creates a normalized version of the path within the specified buffer. This function will not write out more than the specified buffer can contain. However, the generated string is always null-terminated - even if not the whole path is written out. The function returns the total number of characters the complete buffer would have, even if it was not written out completely. The path may be the same memory address as the buffer. 15 16 The following will be true for the normalized path: 17 * "../" will be resolved. 18 * "./" will be removed. 19 * double separators will be fixed with a single separator. 20 * separator suffixes will be removed. 21 22 ## Parameters 23 * **path**: The path which will be normalized. 24 * **buffer**: The buffer where the new path is written to. 25 * **buffer_size**: The size of the buffer. 26 27 ## Return Value 28 The size which the complete normalized path has if it was not truncated. 29 30 ## Outcomes 31 32 | Input | Output | 33 |-------------------------------------|------------------| 34 | `/var` | `/var` | 35 | `/var/logs/test/../../` | `/var` | 36 | `/var/logs/test/../../../../../../` | `/` | 37 | `rel/../../` | `..` | 38 | `/var////logs//test/` | `/var/logs/test` | 39 | `/var/././././` | `/var` | 40 | `/var/./logs/.//test/..//..//////` | `/var` | 41 42 43 ## Example 44 ```c 45 #include <cwalk.h> 46 #include <stdio.h> 47 #include <stdlib.h> 48 #include <stdlib.h> 49 50 int main(int argc, char *argv[]) 51 { 52 char result[FILENAME_MAX]; 53 54 // The following function cleans up the input path and writes it 55 // to the result buffer. 56 cwk_path_normalize("/var/log/weird/////path/.././..///", result, 57 sizeof(result)); 58 59 printf("%s\n", result); 60 return EXIT_SUCCESS; 61 } 62 ``` 63 64 Output: 65 ``` 66 /var/log 67 ``` 68 69 ## Changelog 70 71 | Version | Description | 72 |------------|---------------------------------------------------| 73 | **v1.2.7** | Fixed windows paths with forward slashes in root. | 74 | **v1.0.0** | The function is introduced. |