diff audacious/vfs_buffer.h @ 2146:e0e50e151bab trunk

[svn] - move vfs from libaudacious to main audacious
author nenolod
date Sun, 17 Dec 2006 08:52:31 -0800
parents libaudacious/vfs_buffer.h@f18a5b617c34
children 329fb2453c87
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/audacious/vfs_buffer.h	Sun Dec 17 08:52:31 2006 -0800
@@ -0,0 +1,70 @@
+/*  Audacious
+ *  Copyright (c) 2006 William Pitcock
+ *
+ *  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; under version 2 of the License.
+ *
+ *  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 AUDACIOUS_VFS_BUFFER_H
+#define AUDACIOUS_VFS_BUFFER_H
+
+#include <glib.h>
+#include "vfs.h"
+
+G_BEGIN_DECLS
+
+/**
+ * VFSBuffer:
+ * @data: The data inside the VFSBuffer.
+ * @iter: The current position of the VFS buffer iterator.
+ * @begin: The beginning of the memory segment that the VFS buffer uses.
+ * @end: The end of the memory segment that the VFS buffer uses.
+ * @size: The size of the memory segment.
+ *
+ * Private data for the VFS memorybuffer class.
+ **/
+
+typedef struct {
+	guchar *data;
+	guchar *iter;
+	guchar *end;
+	gsize   size;
+} VFSBuffer;
+
+/**
+ * vfs_buffer_new:
+ * @data: Pointer to data to use.
+ * @size: Size of data to use.
+ *
+ * Creates a VFS buffer for reading/writing to a memory segment.
+ *
+ * Return value: A VFSFile handle for the memory segment's stream 
+ *               representation.
+ **/
+VFSFile *vfs_buffer_new(gpointer data, gsize size);
+
+/**
+ * vfs_buffer_new_from_string:
+ * @str: String to use.
+ *
+ * Creates a VFS buffer for reading/writing to a string.
+ *
+ * Return value: A VFSFile handle for the memory segment's stream 
+ *               representation.
+ **/
+VFSFile *vfs_buffer_new_from_string(gchar *str);
+
+G_END_DECLS
+
+#endif