path_utils.h

/*
    Authors:
        John Dennis <jdennis.redhat.com>

    Copyright (C) 2009 Red Hat

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef PATH_UTILS_H
#define PATH_UTILS_H

/*****************************************************************************/
/******************************** Documentation ******************************/
/*****************************************************************************/

/*****************************************************************************/
/******************************* Include Files *******************************/
/*****************************************************************************/

#include <stdbool.h>
#include <libintl.h>
#include <sys/param.h>
#include <sys/stat.h>

/*****************************************************************************/
/*********************************** Defines *********************************/
/*****************************************************************************/

#ifndef _
#define _(String) gettext(String)
#endif

#ifndef SUCCESS
#define SUCCESS 0
#endif

#define PATH_UTILS_ERROR_BASE -3000
#define PATH_UTILS_ERROR_LIMIT (PATH_UTILS_ERROR_BASE+20)

#define IS_PATH_UTILS_ERROR(error)  (((error) >= PATH_UTILS_ERROR_BASE) && ((error) < PATH_UTILS_ERROR_LIMIT))

#define PATH_UTILS_ERROR_NOT_FULLY_NORMALIZED   (PATH_UTILS_ERROR_BASE + 1)

/*****************************************************************************/
/******************************* Type Definitions ****************************/
/*****************************************************************************/

/*****************************************************************************/
/*************************  External Global Variables  ***********************/
/*****************************************************************************/

/*****************************************************************************/
/****************************  Exported Functions  ***************************/
/*****************************************************************************/

const char *path_utils_error_string(int error);

int get_basename(char *base_name, size_t base_name_size, const char *path);

int get_dirname(char *dir_path, size_t dir_path_size, const char *path);

int get_directory_and_base_name(char *dir_path, size_t dir_path_size,
                                char *base_name, size_t base_name_size,
                                const char *path);

bool is_absolute_path(const char *path);

int path_concat(char *path, size_t path_size, const char *head, const char *tail);

int make_path_absolute(char *absolute_path, size_t absolute_path_size, const char *path);

char **split_path(const char *path, int *count);

int normalize_path(char *normalized_path, size_t normalized_path_size, const char *path);

int common_path_prefix(char *common_path,
                       size_t common_path_size,
                       int *common_count,
                       const char *path1, const char *path2);


int make_normalized_absolute_path(char *result_path, size_t result_path_size, const char *path);

int find_existing_directory_ancestor(char *ancestor, size_t ancestor_size, const char *path);

typedef bool (*directory_list_callback_t)(const char *directory, const char *base_name,
                                          const char *path, struct stat *info,
                                          void *user_data);
int directory_list(const char *path, bool recursive,
                   directory_list_callback_t callback, void *user_data);

bool is_ancestor_path(const char *ancestor, const char *path);

#endif /* PATH_UTILS_H */