libgimpconfig/gimpconfigwriter.h

   1 /* LIBGIMP - The GIMP Library
   2  * Copyright (C) 1995 Spencer Kimball and Peter Mattis
   3  *
   4  * GimpConfigWriter
   5  * Copyright (C) 2003  Sven Neumann <sven@gimp.org>
   6  *
   7  * This library is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 3 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library.  If not, see
  19  * <https://www.gnu.org/licenses/>.
  20  */
  21
  22 #if !defined (__GIMP_CONFIG_H_INSIDE__) && !defined (GIMP_CONFIG_COMPILATION)
  23 #error "Only <libgimpconfig/gimpconfig.h> can be included directly."
  24 #endif
  25
  26 #ifndef __GIMP_CONFIG_WRITER_H__
  27 #define __GIMP_CONFIG_WRITER_H__
  28
  29
  30 GimpConfigWriter * gimp_config_writer_new_file     (const gchar       *filename,
  31                                                     gboolean           atomic,
  32                                                     const gchar       *header,
  33                                                     GError           **error);
  34 GimpConfigWriter * gimp_config_writer_new_gfile    (GFile             *file,
  35                                                     gboolean           atomic,
  36                                                     const gchar       *header,
  37                                                     GError           **error);
  38 GimpConfigWriter * gimp_config_writer_new_stream   (GOutputStream     *output,
  39                                                     const gchar       *header,
  40                                                     GError           **error);
  41 GimpConfigWriter * gimp_config_writer_new_fd       (gint               fd);
  42 GimpConfigWriter * gimp_config_writer_new_string   (GString           *string);
  43
  44 void               gimp_config_writer_open         (GimpConfigWriter  *writer,
  45                                                     const gchar       *name);
  46 void               gimp_config_writer_comment_mode (GimpConfigWriter  *writer,
  47                                                     gboolean           enable);
  48
  49 void               gimp_config_writer_print        (GimpConfigWriter  *writer,
  50                                                     const gchar       *string,
  51                                                     gint               len);
  52 void               gimp_config_writer_printf       (GimpConfigWriter  *writer,
  53                                                     const gchar       *format,
  54                                                     ...) G_GNUC_PRINTF (2, 3);
  55 void               gimp_config_writer_identifier   (GimpConfigWriter  *writer,
  56                                                     const gchar       *identifier);
  57 void               gimp_config_writer_string       (GimpConfigWriter  *writer,
  58                                                     const gchar       *string);
  59 void               gimp_config_writer_data         (GimpConfigWriter  *writer,
  60                                                     gint               length,
  61                                                     const guint8      *data);
  62 void               gimp_config_writer_comment      (GimpConfigWriter  *writer,
  63                                                     const gchar       *comment);
  64 void               gimp_config_writer_linefeed     (GimpConfigWriter  *writer);
  65
  66
  67 void               gimp_config_writer_revert       (GimpConfigWriter  *writer);
  68 void               gimp_config_writer_close        (GimpConfigWriter  *writer);
  69 gboolean           gimp_config_writer_finish       (GimpConfigWriter  *writer,
  70                                                     const gchar       *footer,
  71                                                     GError           **error);
  72
  73
  74 #endif /* __GIMP_CONFIG_WRITER_H__ */