libyelp/yelp-transform.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * Copyright (C) 2003-2009 Shaun McCance  <shaunm@gnome.org>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public
  16  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Shaun McCance  <shaunm@gnome.org>
  19  */
  20
  21 #ifndef __YELP_TRANSFORM_H__
  22 #define __YELP_TRANSFORM_H__
  23
  24 #include <glib.h>
  25 #include <glib-object.h>
  26 #include <libxml/tree.h>
  27 #include <libxslt/xslt.h>
  28 #include <libxslt/transform.h>
  29
  30 #define YELP_TYPE_TRANSFORM            (yelp_transform_get_type ())
  31 #define YELP_TRANSFORM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), YELP_TYPE_TRANSFORM, YelpTransform))
  32 #define YELP_TRANSFORM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), YELP_TYPE_TRANSFORM, YelpTransformClass))
  33 #define YELP_IS_TRANSFORM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), YELP_TYPE_TRANSFORM))
  34 #define YELP_IS_TRANSFORM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), YELP_TYPE_TRANSFORM))
  35
  36 typedef struct _YelpTransform YelpTransform;
  37 typedef struct _YelpTransformClass YelpTransformClass;
  38 struct _YelpTransform {
  39     GObject       parent;
  40 };
  41 struct _YelpTransformClass {
  42     GObjectClass  parent_class;
  43 };
  44
  45 GType            yelp_transform_get_type       (void);
  46 YelpTransform  * yelp_transform_new            (const gchar         *stylesheet);
  47 gboolean         yelp_transform_start          (YelpTransform       *transform,
  48                                                 xmlDocPtr            document,
  49                                                 xmlDocPtr            auxiliary,
  50                                                 const gchar * const *params);
  51 gchar *          yelp_transform_take_chunk     (YelpTransform       *transform,
  52                                                 const gchar         *chunk_id);
  53 void             yelp_transform_cancel         (YelpTransform       *transform);
  54 GError *         yelp_transform_get_error      (YelpTransform       *transform);
  55
  56 #endif /* __YELP_TRANSFORM_H__ */