/* vim: set sw=8: -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ /* * gsf-input.h: abstract interface for reading data * * Copyright (C) 2002-2006 Jody Goldberg (jody@gnome.org) * * This program is free software; you can redistribute it and/or * modify it under the terms of version 2.1 of the GNU Lesser General Public * License as published by the Free Software Foundation. * * 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 Lesser General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 * USA */ #ifndef GSF_INPUT_H #define GSF_INPUT_H #include #include G_BEGIN_DECLS #define GSF_INPUT_TYPE (gsf_input_get_type ()) #define GSF_INPUT(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GSF_INPUT_TYPE, GsfInput)) #define GSF_IS_INPUT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GSF_INPUT_TYPE)) GType gsf_input_get_type (void) G_GNUC_CONST; /* void gsf_input_register_type (GTypeModule *module); glib dynamic types are not thread safe */ char const *gsf_input_name (GsfInput *input); GsfInfile *gsf_input_container (GsfInput *input); GsfInput *gsf_input_dup (GsfInput *input, GError **err); GsfInput *gsf_input_sibling (GsfInput const *input, char const *name, GError **err); gsf_off_t gsf_input_size (GsfInput *input); gboolean gsf_input_eof (GsfInput *input); guint8 const *gsf_input_read (GsfInput *input, size_t num_bytes, guint8 *optional_buffer); /* For bindings _only_! */ guint8 * gsf_input_read0 (GsfInput *input, size_t num_bytes, size_t *bytes_read); gsf_off_t gsf_input_remaining (GsfInput *input); gsf_off_t gsf_input_tell (GsfInput *input); gboolean gsf_input_seek (GsfInput *input, gsf_off_t offset, GSeekType whence); GDateTime * gsf_input_get_modtime (GsfInput *input); /* Utilities */ gboolean gsf_input_copy (GsfInput *input, GsfOutput *output); GsfInput *gsf_input_uncompress (GsfInput *src); GQuark gsf_input_error_id (void); #ifndef GSF_DISABLE_DEPRECATED /* deprecated in 1.12.0, use gsf_input_error_id */ GQuark gsf_input_error (void); #endif /* GSF_DISABLE_DEPRECATED */ G_END_DECLS #endif /* GSF_INPUT_H */