spath.h

Go to the documentation of this file.

#ifndef SPATH_H
#define SPATH_H
 
#include <stdarg.h>
#include <sys/types.h>
 
/* enable C++ codes to include this header directly */
#ifdef __cplusplus
extern "C" {
#endif
 
#define SPATH_SUCCESS (0)
#define SPATH_FAILURE (1)
 
#define SPATH_VERSION "0.1.0"
 
/* TODO: for formatted strings, use special %| character (or something
 * similar) to denote directories in portable way */
 
/********************************************************/
struct spath_elem_struct;
 
typedef struct spath_elem_struct {
  char* component; /* pointer to strdup'd component string */
  size_t chars;    /* number of chars in component */
  struct spath_elem_struct* next; /* pointer to next element */
  struct spath_elem_struct* prev; /* pointer to previous element */
} spath_elem;
 
typedef struct spath_struct {
  int components;      /* number of components in path */
  size_t chars;        /* number of chars in path */
  spath_elem* head; /* pointer to first element */
  spath_elem* tail; /* pointer to last element */
} spath;
 
/********************************************************/
 
spath* spath_new(void);
 
spath* spath_from_str(const char* str);
 
spath* spath_from_strf(const char* format, ...);
 
spath* spath_dup(const spath* path);
 
int spath_delete(spath** ptr_path);
 
/********************************************************/
 
int spath_is_null(const spath* path);
 
int spath_components(const spath* path);
 
size_t spath_strlen(const spath* path);
 
size_t spath_strcpy(char* buf, size_t n, const spath* path);
 
char* spath_strdup(const spath* path);
 
/********************************************************/
 
int spath_insert(spath* path1, int offset, const spath* ptr_path2);
 
int spath_prepend(spath* path1, const spath* ptr_path2);
 
int spath_append(spath* path1, const spath* ptr_path2);
 
int spath_insert_str(spath* path, int offset, const char* str);
 
int spath_prepend_str(spath* path, const char* str);
 
int spath_append_str(spath* path, const char* str);
 
int spath_insert_strf(spath* path, int offset, const char* format, ...);
 
int spath_prepend_strf(spath* path, const char* format, ...);
 
int spath_append_strf(spath* path, const char* format, ...);
 
/********************************************************/
 
int spath_slice(spath* path, int offset, int length);
 
int spath_dirname(spath* path);
 
int spath_basename(spath* path);
 
spath* spath_sub(spath* path, int offset, int length);
 
spath* spath_cut(spath* path, int offset);
 
/********************************************************/
 
spath* spath_cwd(void);
 
int spath_realpath(spath* path);
 
int spath_reduce(spath* path);
 
char* spath_strdup_reduce_str(const char* str);
 
int spath_is_absolute(const spath* path);
 
int spath_is_child(const spath* parent, const spath* child);
 
spath* spath_relative(const spath* src, const spath* dst);
 
/* enable C++ codes to include this header directly */
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SPATH_H */