include/basedir.h File Reference

Functions for using the XDG Base Directory specification. More...

Go to the source code of this file.

Data Structures

struct  xdgHandle
 Handle to XDG data cache. More...

Defines

#define XDG_BASEDIR_SPEC   0.6
 Version of XDG Base Directory specification implemented in this library.

Functions

XDG data cache management



xdgHandlexdgInitHandle (xdgHandle *handle)
 Initialize a handle to an XDG data cache and initialize the cache.
void xdgWipeHandle (xdgHandle *handle)
 Wipe handle of XDG data cache.
int xdgUpdateData (xdgHandle *handle)
 Update the data cache.
Basic XDG Base Directory Queries



const char * xdgDataHome (xdgHandle *handle)
 Base directory for user specific data files.
const char * xdgConfigHome (xdgHandle *handle)
 Base directory for user specific configuration files.
const char *const * xdgDataDirectories (xdgHandle *handle)
 Preference-ordered set of base directories to search for data files in addition to the $XDG_DATA_HOME base directory.
const char *const * xdgSearchableDataDirectories (xdgHandle *handle)
 Preference-ordered set of base directories to search for data files with $XDG_DATA_HOME prepended.
const char *const * xdgConfigDirectories (xdgHandle *handle)
 Preference-ordered set of base directories to search for configuration files in addition to the $XDG_CONFIG_HOME base directory.
const char *const * xdgSearchableConfigDirectories (xdgHandle *handle)
 Preference-ordered set of base directories to search for configuration files with $XDG_CONFIG_HOME prepended.
const char * xdgCacheHome (xdgHandle *handle)
 Base directory for user specific non-essential data files.

Detailed Description

Functions for using the XDG Base Directory specification.

Definition in file basedir.h.


Define Documentation

#define XDG_BASEDIR_SPEC   0.6

Version of XDG Base Directory specification implemented in this library.

Definition at line 51 of file basedir.h.


Function Documentation

const char* xdgCacheHome ( xdgHandle handle  ) 

Base directory for user specific non-essential data files.

Parameters:
handle Handle to data cache, initialized with xdgInitHandle().
Returns:
a path as described by the standards.

Definition at line 546 of file basedir.c.

const char* const* xdgConfigDirectories ( xdgHandle handle  ) 

Preference-ordered set of base directories to search for configuration files in addition to the $XDG_CONFIG_HOME base directory.

Parameters:
handle Handle to data cache, initialized with xdgInitHandle().
Returns:
A null-terminated list of directory strings.

Definition at line 538 of file basedir.c.

const char* xdgConfigHome ( xdgHandle handle  ) 

Base directory for user specific configuration files.

Parameters:
handle Handle to data cache, initialized with xdgInitHandle().
Returns:
a path as described by the standards.

Definition at line 526 of file basedir.c.

const char* const* xdgDataDirectories ( xdgHandle handle  ) 

Preference-ordered set of base directories to search for data files in addition to the $XDG_DATA_HOME base directory.

Parameters:
handle Handle to data cache, initialized with xdgInitHandle().
Returns:
A null-terminated list of directory strings.

Definition at line 530 of file basedir.c.

const char* xdgDataHome ( xdgHandle handle  ) 

Base directory for user specific data files.

Parameters:
handle Handle to data cache, initialized with xdgInitHandle().
Returns:
a path as described by the standards.

Definition at line 522 of file basedir.c.

xdgHandle* xdgInitHandle ( xdgHandle handle  ) 

Initialize a handle to an XDG data cache and initialize the cache.

Use xdgWipeHandle() to free the handle.

Returns:
a pointer to the handle if initialization was successful, else 0

Definition at line 121 of file basedir.c.

const char* const* xdgSearchableConfigDirectories ( xdgHandle handle  ) 

Preference-ordered set of base directories to search for configuration files with $XDG_CONFIG_HOME prepended.

The base directory defined by $XDG_CONFIG_HOME is considered more important than any of the base directories defined by $XDG_CONFIG_DIRS.

Parameters:
handle Handle to data cache, initialized with xdgInitHandle().
Returns:
A null-terminated list of directory strings.

Definition at line 542 of file basedir.c.

const char* const* xdgSearchableDataDirectories ( xdgHandle handle  ) 

Preference-ordered set of base directories to search for data files with $XDG_DATA_HOME prepended.

The base directory defined by $XDG_DATA_HOME is considered more important than any of the base directories defined by $XDG_DATA_DIRS.

Parameters:
handle Handle to data cache, initialized with xdgInitHandle().
Returns:
A null-terminated list of directory strings.

Definition at line 534 of file basedir.c.

int xdgUpdateData ( xdgHandle handle  ) 

Update the data cache.

This should not be done frequently as it reallocates the cache. Even if updating the cache fails the handle remains valid and can be used to access XDG data as it was before xdgUpdateData() was called.

Returns:
0 if update failed, non-0 if successful.

Definition at line 372 of file basedir.c.

void xdgWipeHandle ( xdgHandle handle  ) 

Wipe handle of XDG data cache.

Wipe handle initialized using xdgInitHandle().

Definition at line 167 of file basedir.c.


Generated on 1 Sep 2009 for libxdg-basedir-1.0.2 by  doxygen 1.6.1