libxdg-basedir-1.2.0  1.2.0
basedir.h
Go to the documentation of this file.
1 /* Copyright (c) 2007 Mark Nevill
2  *
3  * Permission is hereby granted, free of charge, to any person
4  * obtaining a copy of this software and associated documentation
5  * files (the "Software"), to deal in the Software without
6  * restriction, including without limitation the rights to use,
7  * copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following
10  * conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
43 #ifndef XDG_BASEDIR_H
44 #define XDG_BASEDIR_H
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
51 #define XDG_BASEDIR_SPEC 0.7
52 
55 
59 typedef struct /*_xdgHandle*/ {
61  void *reserved;
62 } xdgHandle;
63 
68 
71 void xdgWipeHandle(xdgHandle *handle);
72 
78 int xdgUpdateData(xdgHandle *handle);
79 
83 
87 const char * xdgDataHome(xdgHandle *handle);
88 
92 const char * xdgConfigHome(xdgHandle *handle);
93 
98 const char * const * xdgDataDirectories(xdgHandle *handle);
99 
106 const char * const * xdgSearchableDataDirectories(xdgHandle *handle);
107 
112 const char * const * xdgConfigDirectories(xdgHandle *handle);
113 
120 const char * const * xdgSearchableConfigDirectories(xdgHandle *handle);
121 
125 const char * xdgCacheHome(xdgHandle *handle);
126 
132 const char * xdgRuntimeDirectory(xdgHandle *handle);
133 
136 #ifdef __cplusplus
137 } // extern "C"
138 #endif
139 
140 #endif /*XDG_BASEDIR_H*/
xdgConfigDirectories
const char *const * xdgConfigDirectories(xdgHandle *handle)
Preference-ordered set of base directories to search for configuration files in addition to the $XDG_...
Definition: basedir.c:623
xdgDataDirectories
const char *const * xdgDataDirectories(xdgHandle *handle)
Preference-ordered set of base directories to search for data files in addition to the $XDG_DATA_HOME...
Definition: basedir.c:603
xdgWipeHandle
void xdgWipeHandle(xdgHandle *handle)
Wipe handle of XDG data cache.
Definition: basedir.c:170
xdgCacheHome
const char * xdgCacheHome(xdgHandle *handle)
Base directory for user specific non-essential data files.
Definition: basedir.c:643
xdgDataHome
const char * xdgDataHome(xdgHandle *handle)
Base directory for user specific data files.
Definition: basedir.c:589
xdgHandle
Handle to XDG data cache.
Definition: basedir.h:59
xdgSearchableConfigDirectories
const char *const * xdgSearchableConfigDirectories(xdgHandle *handle)
Preference-ordered set of base directories to search for configuration files with $XDG_CONFIG_HOME pr...
Definition: basedir.c:630
xdgInitHandle
xdgHandle * xdgInitHandle(xdgHandle *handle)
Initialize a handle to an XDG data cache and initialize the cache.
Definition: basedir.c:123
xdgConfigHome
const char * xdgConfigHome(xdgHandle *handle)
Base directory for user specific configuration files.
Definition: basedir.c:596
xdgRuntimeDirectory
const char * xdgRuntimeDirectory(xdgHandle *handle)
Base directory for user specific non-essential runtime files such as sockets and named pipes.
Definition: basedir.c:650
xdgHandle::reserved
void * reserved
Reserved for internal use, do not modify.
Definition: basedir.h:61
xdgUpdateData
int xdgUpdateData(xdgHandle *handle)
Update the data cache.
Definition: basedir.c:414
xdgSearchableDataDirectories
const char *const * xdgSearchableDataDirectories(xdgHandle *handle)
Preference-ordered set of base directories to search for data files with $XDG_DATA_HOME prepended.
Definition: basedir.c:610