index.md (4638B)
1 --- 2 title: Reference 3 description: A complete reference of the cwalk path library for C/C++. 4 --- 5 6 ## Basics 7 These are some basic, helpful functions available in the library. The basename is the last portion of the path which determines the name of the file or folder which is being pointed to. For instance, the path ``/var/log/test.txt`` would have the basename ``test.txt``. The dirname is the opposite - the path up to the basename. In that example the dirname would be ``/var/log``. 8 9 ### Functions 10 * **[cwk_path_get_basename]({{ site.baseurl }}{% link reference/cwk_path_get_basename.md %})** 11 Gets the basename of a file path. 12 13 * **[cwk_path_change_basename]({{ site.baseurl }}{% link reference/cwk_path_change_basename.md %})** 14 Changes the basename of a file path. 15 16 * **[cwk_path_get_dirname]({{ site.baseurl }}{% link reference/cwk_path_get_dirname.md %})** 17 Gets the dirname of a file path. 18 19 * **[cwk_path_get_root]({{ site.baseurl }}{% link reference/cwk_path_get_root.md %})** 20 Determines the root of a path. 21 22 * **[cwk_path_change_root]({{ site.baseurl }}{% link reference/cwk_path_change_root.md %})** 23 Changes the root of a path. 24 25 * **[cwk_path_is_absolute]({{ site.baseurl }}{% link reference/cwk_path_is_absolute.md %})** 26 Determine whether the path is absolute or not. 27 28 * **[cwk_path_is_relative]({{ site.baseurl }}{% link reference/cwk_path_is_relative.md %})** 29 Determine whether the path is relative or not. 30 31 * **[cwk_path_join]({{ site.baseurl }}{% link reference/cwk_path_join.md %})** 32 Joins two paths together. 33 34 * **[cwk_path_join_multiple]({{ site.baseurl }}{% link reference/cwk_path_join_multiple.md %})** 35 Joins multiple paths together. 36 37 * **[cwk_path_normalize]({{ site.baseurl }}{% link reference/cwk_path_normalize.md %})** 38 Creates a normalized version of the path. 39 40 * **[cwk_path_intersection]({{ site.baseurl }}{% link reference/cwk_path_intersection.md %})** 41 Finds common portions in two paths. 42 43 ## Navigation 44 One might specify paths containing relative components ``../``. These functions help to resolve or create relative paths based on a base path. 45 46 ### Functions 47 * **[cwk_path_get_absolute]({{ site.baseurl }}{% link reference/cwk_path_get_absolute.md %})** 48 Generates an absolute path based on a base. 49 50 * **[cwk_path_get_relative]({{ site.baseurl }}{% link reference/cwk_path_get_relative.md %})** 51 Generates a relative path based on a base. 52 53 ## Extensions 54 Extensions are the portion of a path which come after a `.`. For instance, the file extension of the ``/var/log/test.txt`` would be ``.txt`` - which indicates that the content is text. 55 56 ### Functions 57 * **[cwk_path_get_extension]({{ site.baseurl }}{% link reference/cwk_path_get_extension.md %})** 58 Gets the extension of a file path. 59 60 * **[cwk_path_has_extension]({{ site.baseurl }}{% link reference/cwk_path_has_extension.md %})** 61 Determines whether the file path has an extension. 62 63 * **[cwk_path_change_extension]({{ site.baseurl }}{% link reference/cwk_path_change_extension.md %})** 64 Changes the extension of a file path. 65 66 ## Segments 67 A segment represents a single component of a path. For instance, on linux a path might look like this ``/var/log/``, which consists of two segments ``var`` and ``log``. 68 69 ### Functions 70 * **[cwk_path_get_first_segment]({{ site.baseurl }}{% link reference/cwk_path_get_first_segment.md %})** 71 Gets the first segment of a path. 72 73 * **[cwk_path_get_last_segment]({{ site.baseurl }}{% link reference/cwk_path_get_last_segment.md %})** 74 Gets the last segment of the path. 75 76 * **[cwk_path_get_next_segment]({{ site.baseurl }}{% link reference/cwk_path_get_next_segment.md %})** 77 Advances to the next segment. 78 79 * **[cwk_path_get_previous_segment]({{ site.baseurl }}{% link reference/cwk_path_get_previous_segment.md %})** 80 Moves to the previous segment. 81 82 * **[cwk_path_get_segment_type]({{ site.baseurl }}{% link reference/cwk_path_get_segment_type.md %})** 83 Gets the type of the submitted path segment. 84 85 * **[cwk_path_change_segment]({{ site.baseurl }}{% link reference/cwk_path_change_segment.md %})** 86 Changes the content of a segment. 87 88 ## Style 89 The path style describes how paths are generated and parsed. **cwalk** currently supports two path styles, ``CWK_STYLE_WINDOWS`` and ``CWK_STYLE_UNIX``. 90 91 ### Functions 92 * **[cwk_path_guess_style]({{ site.baseurl }}{% link reference/cwk_path_guess_style.md %})** 93 Guesses the path style. 94 95 * **[cwk_path_set_style]({{ site.baseurl }}{% link reference/cwk_path_set_style.md %})** 96 Configures which path style is used. 97 98 * **[cwk_path_get_style]({{ site.baseurl }}{% link reference/cwk_path_get_style.md %})** 99 Gets the path style configuration.