aboutsummaryrefslogtreecommitdiffstats
path: root/src/DatabaseSimple.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'src/DatabaseSimple.hxx')
-rw-r--r--src/DatabaseSimple.hxx88
1 files changed, 88 insertions, 0 deletions
diff --git a/src/DatabaseSimple.hxx b/src/DatabaseSimple.hxx
new file mode 100644
index 000000000..e57ae41bf
--- /dev/null
+++ b/src/DatabaseSimple.hxx
@@ -0,0 +1,88 @@
+/*
+ * Copyright (C) 2003-2013 The Music Player Daemon Project
+ * http://www.musicpd.org
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef MPD_DATABASE_SIMPLE_HXX
+#define MPD_DATABASE_SIMPLE_HXX
+
+#include "gcc.h"
+
+#include <glib.h>
+
+#include <sys/time.h>
+#include <stdbool.h>
+
+struct config_param;
+struct Directory;
+struct db_selection;
+struct db_visitor;
+
+/**
+ * Check whether the default #SimpleDatabasePlugin is used. This
+ * allows using db_get_root(), db_save(), db_get_mtime() and
+ * db_exists().
+ */
+bool
+db_is_simple(void);
+
+/**
+ * Returns the root directory object. Returns NULL if there is no
+ * configured music directory.
+ *
+ * May only be used if db_is_simple() returns true.
+ */
+gcc_pure
+Directory *
+db_get_root(void);
+
+/**
+ * Caller must lock the #db_mutex.
+ */
+gcc_nonnull(1)
+gcc_pure
+Directory *
+db_get_directory(const char *name);
+
+/**
+ * May only be used if db_is_simple() returns true.
+ */
+bool
+db_save(GError **error_r);
+
+/**
+ * May only be used if db_is_simple() returns true.
+ */
+gcc_pure
+time_t
+db_get_mtime(void);
+
+/**
+ * Returns true if there is a valid database file on the disk.
+ *
+ * May only be used if db_is_simple() returns true.
+ */
+gcc_pure
+static inline bool
+db_exists(void)
+{
+ /* mtime is set only if the database file was loaded or saved
+ successfully */
+ return db_get_mtime() > 0;
+}
+
+#endif