summaryrefslogtreecommitdiffstats
path: root/osdep/path.h
blob: c5540e43520977cd8a438bc018420cc55a4896f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#ifndef OSDEP_PATH_H
#define OSDEP_PATH_H

// Return a platform-specific path, identified by the type parameter. If the
// return value is allocated, talloc_ctx is used as talloc parent context.
//
// The following type values are defined:
//  "home"          the native mpv-specific user config dir
//  "old_home"      same as "home", but lesser priority (compatibility)
//  "osxbundle"     macOS bundle resource path
//  "global"        the least priority, global config file location
//  "desktop"       path to desktop contents
//
//  These additional types are also defined. However, they are not necessarily
//  implemented on every platform. Unlike some other type values that are
//  platform specific (like "osxbundle"), the value of "home" is returned
//  instead if these types are not explicitly defined.
//  "cache"         the native mpv-specific user cache dir
//  "state"         the native mpv-specific user state dir
//
// It is allowed to return a static string, so the caller must set talloc_ctx
// to something other than NULL to avoid memory leaks.
typedef const char *(*mp_get_platform_path_cb)(void *talloc_ctx, const char *type);

// Conforming to mp_get_platform_path_cb.
const char *mp_get_platform_path_darwin(void *talloc_ctx, const char *type);
const char *mp_get_platform_path_uwp(void *talloc_ctx, const char *type);
const char *mp_get_platform_path_win(void *talloc_ctx, const char *type);
const char *mp_get_platform_path_mac(void *talloc_ctx, const char *type);
const char *mp_get_platform_path_unix(void *talloc_ctx, const char *type);

#endif