kc3-lang/pkgconf/doc/libpkgconf-path.rst

Branch : - branch - master - tag - pkgconf-0.1 pkgconf-0.1.1 pkgconf-0.2 pkgconf-0.3 pkgconf-0.4 pkgconf-0.5 pkgconf-0.5.1 pkgconf-0.5.2 pkgconf-0.5.3 pkgconf-0.6 pkgconf-0.7 pkgconf-0.8 pkgconf-0.8.1 pkgconf-0.8.10 pkgconf-0.8.11 pkgconf-0.8.12 pkgconf-0.8.2 pkgconf-0.8.3 pkgconf-0.8.4 pkgconf-0.8.7 pkgconf-0.8.8 pkgconf-0.8.9 pkgconf-0.9.0 pkgconf-0.9.1 pkgconf-0.9.10 pkgconf-0.9.11 pkgconf-0.9.12 pkgconf-0.9.2 pkgconf-0.9.3 pkgconf-0.9.4 pkgconf-0.9.5 pkgconf-0.9.6 pkgconf-0.9.7 pkgconf-0.9.8 pkgconf-0.9.9 pkgconf-1 pkgconf-1.0.1 pkgconf-1.1.0 pkgconf-1.2.0 pkgconf-1.3.0 pkgconf-1.3.1 pkgconf-1.3.2 pkgconf-1.3.3 pkgconf-1.3.4 pkgconf-1.3.5 pkgconf-1.3.6 pkgconf-1.3.7 pkgconf-1.3.90 pkgconf-1.4.0 pkgconf-1.4.1 pkgconf-1.4.2 pkgconf-1.5.1 pkgconf-1.5.2 pkgconf-1.5.3 pkgconf-1.5.4 pkgconf-1.6.0 pkgconf-1.6.1 pkgconf-1.6.2 pkgconf-1.6.3 pkgconf-1.7.0 pkgconf-1.7.1 pkgconf-1.7.2 pkgconf-1.7.3 pkgconf-1.7.4 pkgconf-1.8.0 pkgconf-1.9.0 pkgconf-1.9.1 pkgconf-1.9.2 pkgconf-1.9.3 pkgconf-1.9.4 pkgconf-1.9.5 pkgconf-2.0.0 pkgconf-2.0.1 pkgconf-2.0.2 pkgconf-2.0.3 pkgconf-2.1.0 pkgconf-2.1.1 pkgconf-2.2.0 pkgconf-2.3.0 pkgconf-2.4.0 pkgconf-2.4.1 pkgconf-2.4.2 pkgconf-2.4.3 pkgconf-2.5.0 pkgconf-2.5.1

• Show log

  Commit

• Author : William Pitcock
  Date : 2016-12-30 11:13:04
  Hash : 23050315
  Message : libpkgconf: path: make the duplicate filtering opt-in. some path lists should not be deduped (compiler path lists, for example)

• doc/libpkgconf-path.rst

• libpkgconf `path` module
  ========================
  
  The `path` module provides functions for manipulating lists of paths in a cross-platform manner.  Notably,
  it is used by the `pkgconf client` to parse the ``PKG_CONFIG_PATH``, ``PKG_CONFIG_LIBDIR`` and related environment
  variables.
  
  .. c:function:: void pkgconf_path_add(const char *text, pkgconf_list_t *dirlist)
  
     Adds a path node to a path list.  If the path is already in the list, do nothing.
  
     :param char* text: The path text to add as a path node.
     :param pkgconf_list_t* dirlist: The path list to add the path node to.
     :param bool filter: Whether to perform duplicate filtering.
     :return: nothing
  
  .. c:function:: size_t pkgconf_path_split(const char *text, pkgconf_list_t *dirlist)
  
     Splits a given text input and inserts paths into a path list.
  
     :param char* text: The path text to split and add as path nodes.
     :param pkgconf_list_t* dirlist: The path list to have the path nodes added to.
     :param bool filter: Whether to perform duplicate filtering.
     :return: number of path nodes added to the path list
     :rtype: size_t
  
  .. c:function:: size_t pkgconf_path_build_from_environ(const char *environ, const char *fallback, pkgconf_list_t *dirlist)
  
     Adds the paths specified in an environment variable to a path list.  If the environment variable is not set,
     an optional default set of paths is added.
  
     :param char* environ: The environment variable to look up.
     :param char* fallback: The fallback paths to use if the environment variable is not set.
     :param pkgconf_list_t* dirlist: The path list to add the path nodes to.
     :param bool filter: Whether to perform duplicate filtering.
     :return: number of path nodes added to the path list
     :rtype: size_t
  
  .. c:function:: bool pkgconf_path_match_list(const char *path, const pkgconf_list_t *dirlist)
  
     Checks whether a path has a matching prefix in a path list.
  
     :param char* path: The path to check against a path list.
     :param pkgconf_list_t* dirlist: The path list to check the path against.
     :return: true if the path list has a matching prefix, otherwise false
     :rtype: bool
  
  .. c:function:: void pkgconf_path_free(pkgconf_list_t *dirlist)
  
     Releases any path nodes attached to the given path list.
  
     :param pkgconf_list_t* dirlist: The path list to clean up.
     :return: nothing