src/io-xml/naxml-reader.h

   1 /*
   2  * Nautilus-Actions
   3  * A Nautilus extension which offers configurable context menu actions.
   4  *
   5  * Copyright (C) 2005 The GNOME Foundation
   6  * Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
   7  * Copyright (C) 2009, 2010, 2011 Pierre Wieser and others (see AUTHORS)
   8  *
   9  * This Program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation; either version 2 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This Program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public
  20  * License along with this Library; see the file COPYING.  If not,
  21  * write to the Free Software Foundation, Inc., 59 Temple Place,
  22  * Suite 330, Boston, MA 02111-1307, USA.
  23  *
  24  * Authors:
  25  *   Frederic Ruaudel <grumz@grumz.net>
  26  *   Rodrigo Moya <rodrigo@gnome-db.org>
  27  *   Pierre Wieser <pwieser@trychlos.org>
  28  *   ... and many others (see AUTHORS)
  29  */
  30
  31 #ifndef __NAXML_READER_H__
  32 #define __NAXML_READER_H__
  33
  34 /**
  35  * SECTION: naxml_reader
  36  * @short_description: #NAXMLReader class definition.
  37  * @include: naxml-reader.h
  38  *
  39  * This is the base class for importing items from XML files.
  40  *
  41  * If the imported file is not an XML one, with a known document root,
  42  * then we returned IMPORTER_CODE_NOT_WILLING_TO.
  43  * In all other cases, errors or inconsistancies are signaled, but
  44  * we do our best to actually import the file and produce a valuable
  45  * #NAObjectItem-derived object.
  46  */
  47
  48 #include <api/na-data-boxed.h>
  49 #include <api/na-iimporter.h>
  50 #include <api/na-ifactory-provider.h>
  51
  52 G_BEGIN_DECLS
  53
  54 #define NAXML_READER_TYPE                ( naxml_reader_get_type())
  55 #define NAXML_READER( object )           ( G_TYPE_CHECK_INSTANCE_CAST( object, NAXML_READER_TYPE, NAXMLReader ))
  56 #define NAXML_READER_CLASS( klass )      ( G_TYPE_CHECK_CLASS_CAST( klass, NAXML_READER_TYPE, NAXMLReaderClass ))
  57 #define NAXML_IS_READER( object )        ( G_TYPE_CHECK_INSTANCE_TYPE( object, NAXML_READER_TYPE ))
  58 #define NAXML_IS_READER_CLASS( klass )   ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NAXML_READER_TYPE ))
  59 #define NAXML_READER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NAXML_READER_TYPE, NAXMLReaderClass ))
  60
  61 typedef struct _NAXMLReaderPrivate       NAXMLReaderPrivate;
  62
  63 typedef struct {
  64         /*< private >*/
  65         GObject             parent;
  66         NAXMLReaderPrivate *private;
  67 }
  68         NAXMLReader;
  69
  70 typedef struct _NAXMLReaderClassPrivate  NAXMLReaderClassPrivate;
  71
  72 typedef struct {
  73         /*< private >*/
  74         GObjectClass             parent;
  75         NAXMLReaderClassPrivate *private;
  76 }
  77         NAXMLReaderClass;
  78
  79 GType        naxml_reader_get_type( void );
  80
  81 guint        naxml_reader_import_from_uri( const NAIImporter *instance, NAIImporterImportFromUriParms *parms );
  82
  83 void         naxml_reader_read_start( const NAIFactoryProvider *provider, void *reader_data, const NAIFactoryObject *object, GSList **messages  );
  84 NADataBoxed *naxml_reader_read_data ( const NAIFactoryProvider *provider, void *reader_data, const NAIFactoryObject *object, const NADataDef *def, GSList **messages );
  85 void         naxml_reader_read_done ( const NAIFactoryProvider *provider, void *reader_data, const NAIFactoryObject *object, GSList **messages  );
  86
  87 G_END_DECLS
  88
  89 #endif /* __NAXML_READER_H__ */