2 324d37e7 2019-05-11 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
4 324d37e7 2019-05-11 stsp * Permission to use, copy, modify, and distribute this software for any
5 324d37e7 2019-05-11 stsp * purpose with or without fee is hereby granted, provided that the above
6 324d37e7 2019-05-11 stsp * copyright notice and this permission notice appear in all copies.
8 324d37e7 2019-05-11 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 324d37e7 2019-05-11 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 324d37e7 2019-05-11 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 324d37e7 2019-05-11 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 324d37e7 2019-05-11 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 324d37e7 2019-05-11 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 324d37e7 2019-05-11 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 324d37e7 2019-05-11 stsp /* Utilities for dealing with filesystem paths. */
19 bb51a5b4 2020-01-13 stsp #define GOT_DEFAULT_FILE_MODE (S_IFREG | \
20 bb51a5b4 2020-01-13 stsp S_IRUSR|S_IWUSR | S_IRGRP | S_IROTH)
21 bb51a5b4 2020-01-13 stsp #define GOT_DEFAULT_DIR_MODE (S_IFDIR | \
22 bb51a5b4 2020-01-13 stsp S_IRWXU | S_IRGRP|S_IXGRP | S_IROTH|S_IXOTH)
24 324d37e7 2019-05-11 stsp /* Determine whether a path is an absolute path. */
25 324d37e7 2019-05-11 stsp int got_path_is_absolute(const char *);
28 324d37e7 2019-05-11 stsp * Return an absolute version of a relative path.
29 324d37e7 2019-05-11 stsp * The result is allocated with malloc(3).
31 324d37e7 2019-05-11 stsp char *got_path_get_absolute(const char *);
34 324d37e7 2019-05-11 stsp * Canonicalize absolute paths by removing redundant path separators
35 324d37e7 2019-05-11 stsp * and resolving references to parent directories ("/../").
36 324d37e7 2019-05-11 stsp * Relative paths are copied from input to buf as-is.
38 324d37e7 2019-05-11 stsp const struct got_error *got_canonpath(const char *, char *, size_t);
41 324d37e7 2019-05-11 stsp * Get child part of two absolute paths. The second path must equal the first
42 324d37e7 2019-05-11 stsp * path up to some path component, and must be longer than the first path.
43 324d37e7 2019-05-11 stsp * The result is allocated with malloc(3).
45 324d37e7 2019-05-11 stsp const struct got_error *got_path_skip_common_ancestor(char **, const char *,
46 324d37e7 2019-05-11 stsp const char *);
48 324d37e7 2019-05-11 stsp /* Determine whether a path points to the root directory "/" . */
49 324d37e7 2019-05-11 stsp int got_path_is_root_dir(const char *);
51 324d37e7 2019-05-11 stsp /* Determine whether a path is a path-wise child of another path. */
52 324d37e7 2019-05-11 stsp int got_path_is_child(const char *, const char *, size_t);
55 324d37e7 2019-05-11 stsp * Like strcmp() but orders children in subdirectories directly after
56 d572f586 2019-08-02 stsp * their parents. String lengths must also be passed in.
58 d572f586 2019-08-02 stsp int got_path_cmp(const char *, const char *, size_t, size_t);
61 324d37e7 2019-05-11 stsp * Path lists allow for predictable concurrent iteration over multiple lists
62 324d37e7 2019-05-11 stsp * of paths obtained from disparate sources which don't all provide the same
63 324d37e7 2019-05-11 stsp * ordering guarantees (e.g. git trees, file index, and on-disk directories).
65 324d37e7 2019-05-11 stsp struct got_pathlist_entry {
66 324d37e7 2019-05-11 stsp TAILQ_ENTRY(got_pathlist_entry) entry;
67 324d37e7 2019-05-11 stsp const char *path;
68 f2b16ada 2019-08-02 stsp size_t path_len;
69 324d37e7 2019-05-11 stsp void *data; /* data pointer provided to got_pathlist_insert() */
71 324d37e7 2019-05-11 stsp TAILQ_HEAD(got_pathlist_head, got_pathlist_entry);
74 324d37e7 2019-05-11 stsp * Insert a path into the list of paths in a predictable order.
75 324d37e7 2019-05-11 stsp * The caller should already have initialized the list head. This list stores
76 324d37e7 2019-05-11 stsp * the pointer to the path as-is, i.e. the path is not copied internally and
77 324d37e7 2019-05-11 stsp * must remain available until the list is freed with got_pathlist_free().
78 324d37e7 2019-05-11 stsp * If the first argument is not NULL, set it to a pointer to the newly inserted
79 324d37e7 2019-05-11 stsp * element, or to a NULL pointer in case the path was already on the list.
81 324d37e7 2019-05-11 stsp const struct got_error *got_pathlist_insert(struct got_pathlist_entry **,
82 324d37e7 2019-05-11 stsp struct got_pathlist_head *, const char *, void *);
85 72ea6654 2019-07-27 stsp * Append a path to the list of paths.
86 72ea6654 2019-07-27 stsp * The caller should already have initialized the list head. This list stores
87 72ea6654 2019-07-27 stsp * the pointer to the path as-is, i.e. the path is not copied internally and
88 72ea6654 2019-07-27 stsp * must remain available until the list is freed with got_pathlist_free().
90 adc19d55 2019-07-28 stsp const struct got_error *got_pathlist_append(struct got_pathlist_head *,
91 adc19d55 2019-07-28 stsp const char *, void *);
93 324d37e7 2019-05-11 stsp /* Free resources allocated for a path list. */
94 324d37e7 2019-05-11 stsp void got_pathlist_free(struct got_pathlist_head *);
96 324d37e7 2019-05-11 stsp /* Attempt to create a directory at a given path. */
97 324d37e7 2019-05-11 stsp const struct got_error *got_path_mkdir(const char *);
99 3c45a30a 2019-05-12 jcs /* Determine whether a directory has no files or directories in it. */
100 280f921b 2019-05-12 stsp int got_path_dir_is_empty(const char *);
102 324d37e7 2019-05-11 stsp /* dirname(3) with error handling and dynamically allocated result. */
103 324d37e7 2019-05-11 stsp const struct got_error *got_path_dirname(char **, const char *);
105 f2ea84fa 2019-07-27 stsp /* basename(3) with dynamically allocated result. */
106 f2ea84fa 2019-07-27 stsp const struct got_error *got_path_basename(char **, const char *);
108 72151b04 2019-05-11 stsp /* Strip trailing slashes from a path; path will be modified in-place. */
109 72151b04 2019-05-11 stsp void got_path_strip_trailing_slashes(char *);
111 0ee7065d 2019-05-13 stsp /* Look up the absolute path of a program in $PATH */
112 0ee7065d 2019-05-13 stsp const struct got_error *got_path_find_prog(char **, const char *);
114 2c7829a4 2019-06-17 stsp /* Create a new file at a specified path, with optional content. */
115 2c7829a4 2019-06-17 stsp const struct got_error *got_path_create_file(const char *, const char *);
