mirror of
https://github.com/Luzifer/staticmap.git
synced 2024-10-18 15:44:21 +00:00
108 lines
4.8 KiB
Go
108 lines
4.8 KiB
Go
// appdirs project doc.go
|
|
|
|
/*
|
|
This is a port of a python module used for finding what directory you 'should'
|
|
be using for saving your application data such as configuration, cache files or
|
|
other files.
|
|
|
|
The location of these directories is often hard to get right. The original python
|
|
module set out to change this into a simple API that returns you the exact
|
|
directory you need. This is a port of it to Go.
|
|
|
|
Depending on platform, this package exports you at the least 6 functions that
|
|
return various system directories. And one helper struct type that combines the
|
|
functions into methods for less arguments in your code.
|
|
|
|
Each function defined accepts a number of arguments, each argument is optional
|
|
and can be left to the types default value if omitted. Often the function will
|
|
ignore arguments if the name given is empty.
|
|
|
|
Passing in all default values into any of the functions will return you the base
|
|
directory without any of the arguments appended to it.
|
|
*/
|
|
package appdirs
|
|
|
|
// UserDataDir returns the full path to the user-specific data directory.
|
|
//
|
|
// This function uses XDG_DATA_HOME as defined by the XDG spec on *nix like systems.
|
|
//
|
|
// Examples of return values:
|
|
// Mac OS X: ~/Library/Application Support/<AppName>
|
|
// Unix: ~/.local/share/<AppName> # or in $XDG_DATA_HOME, if defined
|
|
// Win XP (not roaming): C:\Documents and Settings\<username>\Application Data\<AppAuthor>\<AppName>
|
|
// Win XP (roaming): C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>
|
|
// Win 7 (not roaming): C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>
|
|
// Win 7 (roaming): C:\Users\<username>\AppData\Roaming\<AppAuthor>\<AppName>
|
|
func UserDataDir(name, author, version string, roaming bool) string {
|
|
return userDataDir(name, author, version, roaming)
|
|
}
|
|
|
|
// SiteDataDir returns the full path to the user-shared data directory.
|
|
//
|
|
// This function uses XDG_DATA_DIRS[0] as by the XDG spec on *nix like systems.
|
|
//
|
|
// Examples of return values:
|
|
// Mac OS X: /Library/Application Support/<AppName>
|
|
// Unix: /usr/local/share/<AppName> or /usr/share/<AppName>
|
|
// Win XP: C:\Documents and Settings\All Users\Application Data\<AppAuthor>\<AppName>
|
|
// Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.)
|
|
// Win 7: C:\ProgramData\<AppAuthor>\<AppName> # Hidden, but writeable on Win 7.
|
|
//
|
|
// WARNING: Do not use this on Windows Vista, See the note above.
|
|
func SiteDataDir(name, author, version string) string {
|
|
return siteDataDir(name, author, version)
|
|
}
|
|
|
|
// UserConfigDir returns the full path to the user-specific configuration directory
|
|
//
|
|
// This function uses XDG_CONFIG_HOME as by the XDG spec on *nix like systems.
|
|
//
|
|
// Examples of return values:
|
|
// Mac OS X: same as UserDataDir
|
|
// Unix: ~/.config/<AppName> # or in $XDG_CONFIG_HOME, if defined
|
|
// Win *: same as UserDataDir
|
|
func UserConfigDir(name, author, version string, roaming bool) string {
|
|
return userConfigDir(name, author, version, roaming)
|
|
}
|
|
|
|
// SiteConfigDir returns the full path to the user-shared data directory.
|
|
//
|
|
// This function uses XDG_CONFIG_DIRS[0] as by the XDG spec on *nix like systems.
|
|
//
|
|
// Examples of return values:
|
|
// Mac OS X: same as SiteDataDir
|
|
// Unix: /etc/xdg/<AppName> or $XDG_CONFIG_DIRS[i]/<AppName> for each value in $XDG_CONFIG_DIRS
|
|
// Win *: same as SiteDataDir
|
|
// Vista: (Fail! "C:\ProgramData" is a hidden *system* directory on Vista.)
|
|
//
|
|
// WARNING: Do not use this on Windows Vista, see the note above.
|
|
func SiteConfigDir(name, author, version string) string {
|
|
return siteConfigDir(name, author, version)
|
|
}
|
|
|
|
// UserCacheDir returns the full path to the user-specific cache directory.
|
|
//
|
|
// The opinion argument will append 'Cache' to the base directory if set to true.
|
|
//
|
|
// Examples of return values:
|
|
// Mac OS X: ~/Library/Caches/<AppName>
|
|
// Unix: ~/.cache/<AppName> (XDG default)
|
|
// Win XP: C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>\Cache
|
|
// Vista: C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>\Cache
|
|
func UserCacheDir(name, author, version string, opinion bool) string {
|
|
return userCacheDir(name, author, version, opinion)
|
|
}
|
|
|
|
// UserLogDir returns the full path to the user-specific log directory.
|
|
//
|
|
// The opinion argument will append either 'Logs' (windows) or 'log' (unix) to
|
|
// the base directory when set to true.
|
|
//
|
|
// Examples of return values:
|
|
// Mac OS X: ~/Library/Logs/<AppName>
|
|
// Unix: ~/.cache/<AppName>/log # or under $XDG_CACHE_HOME if defined
|
|
// Win XP: C:\Documents and Settings\<username>\Local Settings\Application Data\<AppAuthor>\<AppName>\Logs
|
|
// Vista: C:\Users\<username>\AppData\Local\<AppAuthor>\<AppName>\Logs
|
|
func UserLogDir(name, author, version string, opinion bool) string {
|
|
return userLogDir(name, author, version, opinion)
|
|
}
|