path.h File Reference

Menu Path. More...

Go to the source code of this file.

Data Structures
struct	path_t
	Path Structure. More...

Functions
path_t *	path_create (const char *string)
	Create a new path object.
path_t *	path_init (const char *prefix, char *string)
	Initialize a path object with a prefix and string.
void	path_free (path_t *path)
	Free a path object.
path_t *	path_clone (path_t *string)
	Clone a path object.
path_t *	path_clone_push (path_t *path, char *string)
	Clone a path object and push a string onto it.
char *	path_get (path_t *path)
	Get the string representation of a path.
char *	path_last_get (path_t *path)
	Get the last component of a path.
bool	path_is_root (path_t *path)
	Check if the path is the root directory.
void	path_pop (path_t *path)
	Pop the last component from the path.
void	path_push (path_t *path, char *string)
	Push a string onto the path.
void	path_push_subdir (path_t *path, char *string)
	Push a subdirectory onto the path.
char *	path_ext_get (path_t *path)
	Get the file extension from the path.
void	path_ext_remove (path_t *path)
	Remove the file extension from the path.
void	path_ext_replace (path_t *path, char *ext)
	Replace the file extension of the path.
bool	path_has_value (path_t *path)
	Check if the path has a value.
bool	path_are_match (path_t *left, path_t *right)
	Check if two paths match.

Detailed Description

Menu Path.

---

Data Structure Documentation

path_t

struct path_t

Path Structure.

Data Fields
char *	buffer	Buffer for the path
char *	root	Root directory
size_t	capacity	Capacity of the buffer

Function Documentation

path_create()

path_t * path_create

(

const char *

string

)

Create a new path object.

Parameters

string

Initial path string

Returns

path_t* Pointer to the created path object

Create a new path object.

Parameters

string

Initial path string.

Returns

path_t* Pointer to the created path structure.

path_init()

path_t * path_init	(	const char *	prefix,
		char *	string )

Initialize a path object with a prefix and string.

Parameters

prefix	Prefix for the path
string	Initial path string

Returns

path_t* Pointer to the initialized path object

Initialize a path object with a prefix and string.

Parameters

prefix	Path prefix.
string	Initial path string.

Returns

path_t* Pointer to the initialized path structure.

path_free()

void path_free

(

path_t *

path

)

Free a path object.

Parameters

path	Pointer to the path object to be freed

Free a path object.

Parameters

path	Pointer to the path structure.

path_clone()

path_t * path_clone

(

path_t *

path

)

Clone a path object.

Parameters

string

Path object to be cloned

Returns

path_t* Pointer to the cloned path object

Clone a path object.

Parameters

path	Pointer to the path structure to clone.

Returns

path_t* Pointer to the cloned path structure.

path_clone_push()

path_t * path_clone_push	(	path_t *	path,
		char *	string )

Clone a path object and push a string onto it.

Parameters

path	Path object to be cloned
string	String to be pushed onto the cloned path

Returns

path_t* Pointer to the cloned and modified path object

Clone a path object and push a string onto it.

Parameters

path	Pointer to the path structure to clone.
string	String to push to the cloned path.

Returns

path_t* Pointer to the cloned and modified path structure.

path_get()

char * path_get

(

path_t *

path

)

Get the string representation of a path.

Parameters

path	Path object

Returns

char* String representation of the path

Get the string representation of a path.

Parameters

path	Pointer to the path structure.

Returns

char* Pointer to the current path string.

path_last_get()

char * path_last_get

(

path_t *

path

)

Get the last component of a path.

Parameters

path	Path object

Returns

char* Last component of the path

Get the last component of a path.

Parameters

path	Pointer to the path structure.

Returns

char* Pointer to the last component of the path.

path_is_root()

bool path_is_root

(

path_t *

path

)

Check if the path is the root directory.

Parameters

path	Path object

Returns

true If the path is the root directory

false Otherwise

Check if the path is the root directory.

Parameters

path	Pointer to the path structure.

Returns

true if the path is the root path, false otherwise.

path_pop()

void path_pop

(

path_t *

path

)

Pop the last component from the path.

Parameters

path	Path object
path	Pointer to the path structure.

path_push()

void path_push	(	path_t *	path,
		char *	string )

Push a string onto the path.

Parameters

path	Path object
string	String to be pushed onto the path

Push a string onto the path.

Parameters

path	Pointer to the path structure.
string	String to push to the path.

path_push_subdir()

void path_push_subdir	(	path_t *	path,
		char *	string )

Push a subdirectory onto the path.

Parameters

path	Path object
string	Subdirectory to be pushed onto the path

Push a subdirectory onto the path.

Parameters

path	Pointer to the path structure.
string	Subdirectory string to push to the path.

path_ext_get()

char * path_ext_get

(

path_t *

path

)

Get the file extension from the path.

Parameters

path	Path object

Returns

char* File extension

Parameters

path	Pointer to the path structure.

Returns

char* Pointer to the file extension.

path_ext_remove()

void path_ext_remove

(

path_t *

path

)

Remove the file extension from the path.

Parameters

path	Path object
path	Pointer to the path structure.

path_ext_replace()

void path_ext_replace	(	path_t *	path,
		char *	ext )

Replace the file extension of the path.

Parameters

path	Path object
ext	New file extension

Replace the file extension of the path.

Parameters

path	Pointer to the path structure.
ext	New file extension.

path_has_value()

bool path_has_value

(

path_t *

path

)

Check if the path has a value.

Parameters

path	Path object

Returns

true If the path has a value

false Otherwise

Parameters

path	Pointer to the path structure.

Returns

true if the path has a value, false otherwise.

path_are_match()

bool path_are_match	(	path_t *	left,
		path_t *	right )

Check if two paths match.

Parameters

left	First path object
right	Second path object

Returns

true If the paths match

false Otherwise

Parameters

left	Pointer to the first path structure.
right	Pointer to the second path structure.

Returns

true if the paths match, false otherwise.