thodg/got/lib/got_lib_path.h

Branch : - branch - main - tag - 0.1 0.10 0.11 0.12 0.13 0.14 0.15 0.16 0.17 0.18 0.19 0.2 0.20 0.21 0.22 0.23 0.24 0.25 0.26 0.27 0.28 0.29 0.3 0.30 0.31 0.32 0.33 0.34 0.35 0.36 0.37 0.38 0.39 0.4 0.40 0.41 0.42 0.43 0.44 0.45 0.46 0.47 0.48 0.49 0.5 0.50 0.51 0.52 0.53 0.54 0.55 0.56 0.57 0.58 0.59 0.6 0.60 0.61 0.62 0.63 0.64 0.65 0.66 0.67 0.68 0.69 0.7 0.70 0.71 0.72 0.8 0.9

• Show log

  Commit

• Author : Stefan Sperling
  Date : 2019-02-05 14:49:54
  Hash : 3d8df59c
  Message : add a caller-provided data pointer to path list elements

• lib/got_lib_path.h

• /*
   * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
   *
   * Permission to use, copy, modify, and distribute this software for any
   * purpose with or without fee is hereby granted, provided that the above
   * copyright notice and this permission notice appear in all copies.
   *
   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
   */
  
  /* Utilities for dealing with filesystem paths. */
  
  #define GOT_DEFAULT_FILE_MODE	(S_IRUSR|S_IWUSR | S_IRGRP | S_IROTH)
  #define GOT_DEFAULT_DIR_MODE	(S_IRWXU | S_IRGRP|S_IXGRP | S_IROTH|S_IXOTH)
  
  /* Determine whether a path is an absolute path. */
  int got_path_is_absolute(const char *);
  
  /*
   * Return an absolute version of a relative path.
   * The result is allocated with malloc(3).
   */
  char *got_path_get_absolute(const char *);
  
  /* 
   * Normalize a path for internal processing.
   * The result is allocated with malloc(3).
   */
  char *got_path_normalize(const char *);
  
  /*
   * Canonicalize absolute paths by removing redundant path separators
   * and resolving references to parent directories ("/../").
   * Relative paths are copied from input to buf as-is.
   */
  const struct got_error *got_canonpath(const char *, char *, size_t);
  
  /*
   * Get child part of two absolute paths. The second path must equal the first
   * path up to some path component, and must be longer than the first path.
   * The result is allocated with malloc(3).
   */
  const struct got_error *got_path_skip_common_ancestor(char **, const char *,
      const char *);
  
  /* Determine whether a path points to the root directory "/" . */
  int got_path_is_root_dir(const char *);
  
  /* Determine whether a path is a path-wise child of another path. */
  int got_path_is_child(const char *, const char *, size_t);
  
  /*
   * Like strcmp() but orders children in subdirectories directly after
   * their parents.
   */
  int got_path_cmp(const char *, const char *);
  
  /*
   * Path lists allow for predictable concurrent iteration over multiple lists
   * of paths obtained from disparate sources which don't all provide the same
   * ordering guarantees (e.g. git trees, file index, and on-disk directories).
   */
  struct got_pathlist_entry {
  	TAILQ_ENTRY(got_pathlist_entry) entry;
  	const char *path;
  	void *data; /* data pointer provided to got_pathlist_insert() */
  };
  TAILQ_HEAD(got_pathlist_head, got_pathlist_entry);
  
  /*
   * Insert a path into the list of paths in a predictable order.
   * The caller should already have initialized the list head. This list stores
   * the pointer to the path as-is, i.e. the path is not copied internally and
   * must remain available until the list is freed with got_pathlist_free().
   * If the first argument is not NULL, set it to a pointer to the newly inserted
   * element, or to a NULL pointer in case the path was already on the list.
   */
  const struct got_error *got_pathlist_insert(struct got_pathlist_entry **,
      struct got_pathlist_head *, const char *, void *);
  
  /* Free resources allocated for a path list. */
  void got_pathlist_free(struct got_pathlist_head *);