svn_path.h

Go to the documentation of this file.

#ifndef SVN_PATH_H
#define SVN_PATH_H

#include <apr.h>
#include <apr_pools.h>
#include <apr_tables.h>

#include "svn_types.h"
#include "svn_string.h"
#include "svn_dirent_uri.h"


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */



SVN_DEPRECATED
const char *
svn_path_internal_style(const char *path, apr_pool_t *pool);

SVN_DEPRECATED
const char *
svn_path_local_style(const char *path, apr_pool_t *pool);


SVN_DEPRECATED
char *
svn_path_join(const char *base, const char *component, apr_pool_t *pool);

SVN_DEPRECATED
char *
svn_path_join_many(apr_pool_t *pool, const char *base, ...);


SVN_DEPRECATED
char *
svn_path_basename(const char *path, apr_pool_t *pool);

SVN_DEPRECATED
char *
svn_path_dirname(const char *path, apr_pool_t *pool);

void
svn_path_splitext(const char **path_root, const char **path_ext,
                  const char *path, apr_pool_t *pool);

apr_size_t
svn_path_component_count(const char *path);

void
svn_path_add_component(svn_stringbuf_t *path, const char *component);

void
svn_path_remove_component(svn_stringbuf_t *path);

void
svn_path_remove_components(svn_stringbuf_t *path, apr_size_t n);

SVN_DEPRECATED
void
svn_path_split(const char *path,
               const char **dirpath,
               const char **base_name,
               apr_pool_t *pool);


int
svn_path_is_empty(const char *path);


#ifndef SVN_DIRENT_URI_H
/* This declaration has been moved to svn_dirent_uri.h, and remains
   here only for compatibility reasons. */
svn_boolean_t
svn_dirent_is_root(const char *dirent, apr_size_t len);
#endif /* SVN_DIRENT_URI_H */


SVN_DEPRECATED
const char *
svn_path_canonicalize(const char *path, apr_pool_t *pool);

SVN_DEPRECATED
svn_boolean_t
svn_path_is_canonical(const char *path, apr_pool_t *pool);


int
svn_path_compare_paths(const char *path1, const char *path2);


SVN_DEPRECATED
char *
svn_path_get_longest_ancestor(const char *path1,
                              const char *path2,
                              apr_pool_t *pool);

SVN_DEPRECATED
svn_error_t *
svn_path_get_absolute(const char **pabsolute,
                      const char *relative,
                      apr_pool_t *pool);

SVN_DEPRECATED
svn_error_t *
svn_path_split_if_file(const char *path,
                       const char **pdirectory,
                       const char **pfile,
                       apr_pool_t *pool);

SVN_DEPRECATED
svn_error_t *
svn_path_condense_targets(const char **pcommon,
                          apr_array_header_t **pcondensed_targets,
                          const apr_array_header_t *targets,
                          svn_boolean_t remove_redundancies,
                          apr_pool_t *pool);


svn_error_t *
svn_path_remove_redundancies(apr_array_header_t **pcondensed_targets,
                             const apr_array_header_t *targets,
                             apr_pool_t *pool);


apr_array_header_t *
svn_path_decompose(const char *path, apr_pool_t *pool);

const char *
svn_path_compose(const apr_array_header_t *components, apr_pool_t *pool);

svn_boolean_t
svn_path_is_single_path_component(const char *name);


svn_boolean_t
svn_path_is_backpath_present(const char *path);


svn_boolean_t
svn_path_is_dotpath_present(const char *path);


SVN_DEPRECATED
const char *
svn_path_is_child(const char *path1, const char *path2, apr_pool_t *pool);

SVN_DEPRECATED
svn_boolean_t
svn_path_is_ancestor(const char *path1, const char *path2);

svn_error_t *
svn_path_check_valid(const char *path, apr_pool_t *pool);


svn_boolean_t
svn_path_is_url(const char *path);

svn_boolean_t
svn_path_is_uri_safe(const char *path);

const char *
svn_path_uri_encode(const char *path, apr_pool_t *pool);

const char *
svn_path_uri_decode(const char *path, apr_pool_t *pool);

const char *
svn_path_url_add_component2(const char *url,
                            const char *component,
                            apr_pool_t *pool);

SVN_DEPRECATED
const char *
svn_path_url_add_component(const char *url,
                           const char *component,
                           apr_pool_t *pool);

const char *
svn_path_uri_from_iri(const char *iri, apr_pool_t *pool);

const char *
svn_path_uri_autoescape(const char *uri, apr_pool_t *pool);

svn_error_t *
svn_path_cstring_from_utf8(const char **path_apr,
                           const char *path_utf8,
                           apr_pool_t *pool);

svn_error_t *
svn_path_cstring_to_utf8(const char **path_utf8,
                         const char *path_apr,
                         apr_pool_t *pool);



svn_boolean_t
svn_path_is_repos_relative_url(const char *path);

svn_error_t *
svn_path_resolve_repos_relative_url(const char **absolute_url,
                                    const char *relative_url,
                                    const char *repos_root_url,
                                    apr_pool_t *pool);

/* Return a copy of @a path, allocated from @a pool, for which control
 * characters have been escaped using the form \NNN (where NNN is the
 * octal representation of the byte's ordinal value).
 * 
 * @since New in 1.8. */
const char *
svn_path_illegal_path_escape(const char *path, apr_pool_t *pool);

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* SVN_PATH_H */