summaryrefslogtreecommitdiff
path: root/libpurple/purplepath.h
diff options
context:
space:
mode:
authorGary Kramlich <grim@reaperworld.com>2022-01-08 15:35:51 -0600
committerGary Kramlich <grim@reaperworld.com>2022-01-08 15:35:51 -0600
commitedea864044592babc5e2deb12fe5245bc82d502f (patch)
tree0516bf613b23b6ffa82a1557dacf5d14cd0d127d /libpurple/purplepath.h
parentcff1361cf090ce807a5e955bdf968d9862a8ea20 (diff)
downloadpidgin-edea864044592babc5e2deb12fe5245bc82d502f.tar.gz
Move the path based functions from util.c to their own file.
This is the first step in cleaning these up and using separate directories for each libpurple based client. Testing Done: Ran with no config directory and added an account. Verified that all of the config files were correctly created. Also ran the unit tests without issue. Reviewed at https://reviews.imfreedom.org/r/1192/
Diffstat (limited to 'libpurple/purplepath.h')
-rw-r--r--libpurple/purplepath.h103
1 files changed, 103 insertions, 0 deletions
diff --git a/libpurple/purplepath.h b/libpurple/purplepath.h
new file mode 100644
index 0000000000..fab053c3cd
--- /dev/null
+++ b/libpurple/purplepath.h
@@ -0,0 +1,103 @@
+/*
+ * Purple - Internet Messaging Library
+ * Copyright (C) Pidgin Developers <devel@pidgin.im>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <https://www.gnu.org/licenses/>.
+ */
+
+#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
+# error "only <purple.h> may be included directly"
+#endif
+
+#ifndef PURPLE_PATH_H
+#define PURPLE_PATH_H
+
+#include <glib.h>
+
+G_BEGIN_DECLS
+
+/**
+ * purple_home_dir:
+ *
+ * Returns the user's home directory.
+ *
+ * See purple_user_dir()
+ *
+ * Returns: The user's home directory.
+ */
+const gchar *purple_home_dir(void);
+
+/**
+ * purple_user_dir:
+ *
+ * Returns the purple settings directory in the user's home directory.
+ * This is usually $HOME/.purple
+ *
+ * See purple_home_dir()
+ *
+ * Returns: The purple settings directory.
+ *
+ * Deprecated: Use purple_cache_dir(), purple_config_dir() or
+ * purple_data_dir() instead.
+ */
+G_DEPRECATED_FOR(purple_cache_dir or purple_config_dir or purple_data_dir)
+const gchar *purple_user_dir(void);
+
+/**
+ * purple_cache_dir:
+ *
+ * Returns the purple cache directory according to XDG Base Directory Specification.
+ * This is usually $HOME/.cache/purple.
+ * If custom user dir was specified then this is cache
+ * sub-directory of DIR argument passed to -c option.
+ *
+ * Returns: The purple cache directory.
+ */
+const gchar *purple_cache_dir(void);
+
+/**
+ * purple_config_dir:
+ *
+ * Returns the purple configuration directory according to XDG Base Directory Specification.
+ * This is usually $HOME/.config/purple.
+ * If custom user dir was specified then this is config
+ * sub-directory of DIR argument passed to -c option.
+ *
+ * Returns: The purple configuration directory.
+ */
+const gchar *purple_config_dir(void);
+
+/**
+ * purple_data_dir:
+ *
+ * Returns the purple data directory according to XDG Base Directory Specification.
+ * This is usually $HOME/.local/share/purple.
+ * If custom user dir was specified then this is data
+ * sub-directory of DIR argument passed to -c option.
+ *
+ * Returns: The purple data directory.
+ */
+const gchar *purple_data_dir(void);
+
+/**
+ * purple_util_set_user_dir:
+ * @dir: The custom settings directory
+ *
+ * Define a custom purple settings directory, overriding the default (user's home directory/.purple)
+ */
+void purple_util_set_user_dir(const gchar *dir);
+
+G_END_DECLS
+
+#endif /* PURPLE_PATH_H */