moved includes back to the top of the files (before gtk-doc SECTION

2008-06-22  Michael Natterer  <mitch@imendio.com>

	* *.c: moved includes back to the top of the files (before gtk-doc
	SECTION comments). Add "config.h" in all files and move system
	included before glib includes. Remove trailing whitespace from
	SECTION comments and did some reformatting where lines were overly
	long, no documentation content was changed.


svn path=/trunk/; revision=7089

gobject/ChangeLog

@@ -1,3 +1,11 @@
+2008-06-22  Michael Natterer  <mitch@imendio.com>
+
+	* *.c: moved includes back to the top of the files (before gtk-doc
+	SECTION comments). Add "config.h" in all files and move system
+	included before glib includes. Remove trailing whitespace from
+	SECTION comments and did some reformatting where lines were overly
+	long, no documentation content was changed.
+
 2008-06-22  Stefan Kost  <ensonic@users.sf.net>
 
 	* docs/reference/gobject/tmpl/gobject-unused.sgml:

gobject/gboxed.c

@@ -16,10 +16,27 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+#include "config.h"
+
+#include <string.h>
+
+#include "gboxed.h"
+#include "gbsearcharray.h"
+#include "gvalue.h"
+#include "gvaluearray.h"
+#include "gclosure.h"
+#include "gvaluecollector.h"
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:gboxed
- * @Short_description: A mechanism to wrap opaque C structures registered by the type system
+ * @Short_description: A mechanism to wrap opaque C structures registered
+ *                     by the type system
+ *
  * @See_also: #GParamSpecBoxed, g_param_spec_boxed()
+ *
  * @Title: Boxed Types
  *
  * GBoxed is a generic wrapper mechanism for arbitrary C structures. The only
@@ -31,18 +48,6 @@
  * based libraries.
  */
 
-#include	"gboxed.h"
-
-#include	"gbsearcharray.h"
-#include	"gvalue.h"
-#include	"gvaluearray.h"
-#include	"gclosure.h"
-#include	"gvaluecollector.h"
-
-#include	"gobjectalias.h"
-
-#include <string.h>
-
 /* --- typedefs & structures --- */
 typedef struct
 {

gobject/gclosure.c

@@ -17,36 +17,52 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/*
+ * MT safe with regards to reference counting.
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include "gclosure.h"
+#include "gvalue.h"
+#include "gobjectalias.h"
+
 /**
  * SECTION:gclosure
  * @Short_description: Functions as first-class objects
  * @Title: Closures
  *
- * A #GClosure represents a callback supplied by the programmer. It will generally
+ * A #GClosure represents a callback supplied by the programmer. It
- * comprise a function of some kind and a marshaller used to call it. It is the 
+ * will generally comprise a function of some kind and a marshaller
- * reponsibility of the marshaller to convert the arguments for the invocation 
+ * used to call it. It is the reponsibility of the marshaller to
- * from #GValue<!-- -->s into a suitable form, perform the callback on the 
+ * convert the arguments for the invocation from #GValue<!-- -->s into
- * converted arguments, and transform the return value back into a #GValue.
+ * a suitable form, perform the callback on the converted arguments,
+ * and transform the return value back into a #GValue.
  *
- * In the case of C programs, a closure usually just holds a pointer to a function
+ * In the case of C programs, a closure usually just holds a pointer
- * and maybe a data argument, and the marshaller converts between #GValue<!-- -->
+ * to a function and maybe a data argument, and the marshaller
- * and native C types. The GObject library provides the #GCClosure type for this
+ * converts between #GValue<!-- --> and native C types. The GObject
- * purpose. Bindings for other languages need marshallers which 
+ * library provides the #GCClosure type for this purpose. Bindings for
- * convert between #GValue<!-- -->s and suitable representations in the runtime
+ * other languages need marshallers which convert between #GValue<!--
- * of the language in order to use functions written in that languages as 
+ * -->s and suitable representations in the runtime of the language in
- * callbacks.
+ * order to use functions written in that languages as callbacks.
  *
- * Within GObject, closures play an important role in the implementation of 
+ * Within GObject, closures play an important role in the
- * signals. When a signal is registered, the @c_marshaller argument to 
+ * implementation of signals. When a signal is registered, the
- * g_signal_new() specifies the default C marshaller for any closure which is 
+ * @c_marshaller argument to g_signal_new() specifies the default C
- * connected to this signal. GObject provides a number of C marshallers  
+ * marshaller for any closure which is connected to this
- * for this purpose, see the g_cclosure_marshal_*() functions. Additional
+ * signal. GObject provides a number of C marshallers for this
- * C marshallers can be generated with the
+ * purpose, see the g_cclosure_marshal_*() functions. Additional C
- * <link linkend="glib-genmarshal">glib-genmarshal</link> utility.
+ * marshallers can be generated with the <link
- * Closures can be explicitly connected to signals with 
+ * linkend="glib-genmarshal">glib-genmarshal</link> utility.  Closures
- * g_signal_connect_closure(), but it usually more convenient to let GObject 
+ * can be explicitly connected to signals with
- * create a closure automatically by using one of the g_signal_connect_*() 
+ * g_signal_connect_closure(), but it usually more convenient to let
- * functions which take a callback function/user data pair.
+ * GObject create a closure automatically by using one of the
+ * g_signal_connect_*() functions which take a callback function/user
+ * data pair.
  *
  * Using closures has a number of important advantages over a simple
  * callback function/data pointer combination:
@@ -68,17 +84,6 @@
  * </itemizedlist>
  */
 
-#include	"gclosure.h"
-
-/*
- * MT safe with regards to reference counting.
- */
-
-#include	"gvalue.h"
-#include 	"gobjectalias.h"
-#include	<string.h>
-
-
 #define	CLOSURE_MAX_REF_COUNT		((1 << 15) - 1)
 #define	CLOSURE_MAX_N_GUARDS		((1 << 1) - 1)
 #define	CLOSURE_MAX_N_FNOTIFIERS	((1 << 2) - 1)

gobject/genums.c

@@ -16,40 +16,50 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-/**
- * SECTION:enumerations_flags
- * @Short_description: Enumeration and flags types
- * @See_also:#GParamSpecEnum, #GParamSpecFlags, g_param_spec_enum(), g_param_spec_flags(), 
- * <link linkend="glib-mkenums">glib-mkenums</link>
- * @Title: Enumeration and Flag Types
- * 
- * The GLib type system provides fundamental types for enumeration and flags types. (Flags types
- * are like enumerations, but allow their values to be combined by bitwise or). A registered 
- * enumeration or flags type associates a name and a nickname with each allowed value, and 
- * the methods g_enum_get_value_by_name(), g_enum_get_value_by_nick(), g_flags_get_value_by_name()
- * and g_flags_get_value_by_nick() can look up values by their name or nickname.
- * When an enumeration or flags type is registered with the GLib type system, it can
- * be used as value type for object properties, using g_param_spec_enum() or 
- * g_param_spec_flags().
- * 
- * GObject ships with a utility called <link linkend="glib-mkenums">glib-mkenums</link> that can 
- * construct suitable type registration functions from C enumeration definitions.
- */
 
 /*
  * MT safe
  */
 
+#include "config.h"
+
 #include <string.h>
 
 #include "genums.h"
-
 #include "gvalue.h"
 #include "gvaluecollector.h"
-
 #include "gobjectalias.h"
 
 
+/**
+ * SECTION:enumerations_flags
+ *
+ * @Short_description: Enumeration and flags types
+ *
+ * @See_also:#GParamSpecEnum, #GParamSpecFlags, g_param_spec_enum(),
+ * g_param_spec_flags(),
+ *
+ * <link linkend="glib-mkenums">glib-mkenums</link>
+ * @Title: Enumeration and Flag Types
+ *
+ * The GLib type system provides fundamental types for enumeration and
+ * flags types. (Flags types are like enumerations, but allow their
+ * values to be combined by bitwise or). A registered enumeration or
+ * flags type associates a name and a nickname with each allowed
+ * value, and the methods g_enum_get_value_by_name(),
+ * g_enum_get_value_by_nick(), g_flags_get_value_by_name() and
+ * g_flags_get_value_by_nick() can look up values by their name or
+ * nickname.  When an enumeration or flags type is registered with the
+ * GLib type system, it can be used as value type for object
+ * properties, using g_param_spec_enum() or g_param_spec_flags().
+ *
+ * GObject ships with a utility called <link
+ * linkend="glib-mkenums">glib-mkenums</link> that can construct
+ * suitable type registration functions from C enumeration
+ * definitions.
+ */
+
+
 /* --- prototypes --- */
 static void	g_enum_class_init		(GEnumClass	*class,
 						 gpointer	 class_data);

gobject/glib-genmarshal.c

@@ -16,13 +16,9 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
 #include "config.h"
 
-#undef G_LOG_DOMAIN
-#define G_LOG_DOMAIN "GLib-Genmarshal"
-#include	<glib.h>
-
-#include	<glib/gprintf.h>
 #include <stdlib.h>
 #include <fcntl.h>
 #include <string.h>
@@ -37,6 +33,12 @@
 #include <io.h>
 #endif
 
+#undef G_LOG_DOMAIN
+#define G_LOG_DOMAIN "GLib-Genmarshal"
+#include <glib.h>
+#include <glib/gprintf.h>
+
+
 /* --- defines --- */
 #define	PRG_NAME	"glib-genmarshal"
 #define	PKG_NAME	"GLib"

gobject/gobject-query.c

@@ -16,11 +16,9 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-#include	"../config.h"
 
-#include        <glib-object.h>
+#include "config.h"
 
-#include	<glib/gprintf.h>
 #include <stdlib.h>
 #include <string.h>
 #ifdef HAVE_UNISTD_H
@@ -29,6 +27,10 @@
 #include <sys/stat.h>
 #include <fcntl.h>
 
+#include <glib-object.h>
+#include <glib/gprintf.h>
+
+
 static gchar *indent_inc = NULL;
 static guint spacing = 1;
 static FILE *f_out = NULL;

gobject/gobject.c

@@ -16,17 +16,41 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/*
+ * MT safe with regards to reference counting.
+ */
+
+#include "config.h"
+
+#include <string.h>
+#include <signal.h>
+
+#include "glib/gdatasetprivate.h"
+
+#include "gobject.h"
+#include "gvaluecollector.h"
+#include "gsignal.h"
+#include "gparamspecs.h"
+#include "gvaluetypes.h"
+#include "gobjectalias.h"
+
+/* This should be included after gobjectalias.h (or pltcheck.sh will fail) */
+#include "gobjectnotifyqueue.c"
+
+
 /**
  * SECTION:objects
  * @Short_description: The base object type
  * @See_also:#GParamSpecObject, g_param_spec_object()
  * @Title: The Base Object Type
  *
- * GObject is the fundamental type providing the common attributes and methods 
+ * GObject is the fundamental type providing the common attributes and
- * for all object types in GTK+, Pango and other libraries based on GObject. 
+ * methods for all object types in GTK+, Pango and other libraries
- * The GObject class provides methods for object construction and destruction, 
+ * based on GObject.  The GObject class provides methods for object
- * property access methods, and signal support. 
+ * construction and destruction, property access methods, and signal
- * Signals are described in detail in <xref linkend="gobject-Signals"/>.
+ * support.  Signals are described in detail in <xref
+ * linkend="gobject-Signals"/>.
  *
  * <para id="floating-ref">
  * #GInitiallyUnowned is derived from #GObject. The only difference between
@@ -78,24 +102,6 @@
  * g_obejct_unref (object); // release previously acquired reference
  * ]|
  */
-#include	"gobject.h"
-#include        <glib/gdatasetprivate.h>
-
-/*
- * MT safe with regards to reference counting.
- */
-
-#include	"gvaluecollector.h"
-#include	"gsignal.h"
-#include	"gparamspecs.h"
-#include	"gvaluetypes.h"
-#include	<string.h>
-#include	<signal.h>
-
-#include	"gobjectalias.h"
-
-/* This should be included after gobjectalias.h (or pltcheck.sh will fail) */
-#include	"gobjectnotifyqueue.c"
 
 
 #define	PREALLOC_CPARAMS	(8)

gobject/gobjectnotifyqueue.c

@@ -16,10 +16,12 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
 #ifndef __G_OBJECT_NOTIFY_QUEUE_H__
 #define __G_OBJECT_NOTIFY_QUEUE_H__
 
 #include <string.h> /* memset */
+
 #include <glib-object.h>
 
 G_BEGIN_DECLS

gobject/gparam.c

@@ -16,6 +16,21 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/*
+ * MT safe
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include "gparam.h"
+#include "gparamspecs.h"
+#include "gvaluecollector.h"
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:gparamspec
  * @Short_description: Metadata for parameter specifications
@@ -34,17 +49,6 @@
  * parameter.
  * </para>
  */
-/*
- * MT safe
- */
-
-#include	"gparam.h"
-#include        "gparamspecs.h"
-
-#include	"gvaluecollector.h"
-#include	"gobjectalias.h"
-#include	<string.h>
-
 
 
 /* --- defines --- */

gobject/gparamspecs.c

@@ -16,6 +16,21 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/*
+ * MT safe
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include "gparamspecs.h"
+#include "gvaluecollector.h"
+#include "gvaluearray.h"
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:param_value_types
  * @Short_description: Standard Parameter and Value Types
@@ -33,18 +48,7 @@
  * characters can be letters, numbers or a '-'.
  * All other characters are replaced by a '-' during construction.
  */
-/*
- * MT safe
- */
 
-#include	"../config.h"
-
-#include	"gparamspecs.h"
-
-#include	"gvaluecollector.h"
-#include	"gvaluearray.h"
-#include	"gobjectalias.h"
-#include	<string.h>
 
 #define	G_FLOAT_EPSILON		(1e-30)
 #define	G_DOUBLE_EPSILON	(1e-90)

gobject/gsignal.c

@@ -19,21 +19,41 @@
  * this code is based on the original GtkSignal implementation
  * for the Gtk+ library by Peter Mattis <petm@xcf.berkeley.edu>
  */
+
+/*
+ * MT safe
+ */
+
+#include "config.h"
+
+#include <string.h>
+#include <signal.h>
+
+#include "gsignal.h"
+#include "gbsearcharray.h"
+#include "gvaluecollector.h"
+#include "gvaluetypes.h"
+#include "gboxed.h"
+#include "gobject.h"
+#include "genums.h"
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:signals
  * @Short_description: A means for customization of object behaviour and a general purpose notification mechanism
  * @Title: Signals
  *
- * The basic concept of the signal system is that of the <emphasis>emission</emphasis>
+ * The basic concept of the signal system is that of the
- * of a signal.
+ * <emphasis>emission</emphasis> of a signal. Signals are introduced
- * Signals are introduced per-type and are identified through strings.
+ * per-type and are identified through strings.  Signals introduced
- * Signals introduced for a parent type are available in derived types as well,
+ * for a parent type are available in derived types as well, so
- * so basically they are a per-type facility that is inherited.
+ * basically they are a per-type facility that is inherited.  A signal
- * A signal emission mainly involves invocation of a certain set of callbacks in
+ * emission mainly involves invocation of a certain set of callbacks
- * precisely defined manner. There are two main categories of such callbacks,
+ * in precisely defined manner. There are two main categories of such
- * per-object
+ * callbacks, per-object i'm referring to those types as "object
- * 	i'm referring to those types as "object types" in the following, simply
+ * types" in the following, simply because that is the context most
- * 	because that is the context most users will encounter signals in.
+ * users will encounter signals in.
  *
  * ones and user provided ones.
  * The per-object callbacks are most often referred to as "object method
@@ -80,25 +100,6 @@
  * detail part of the signal specification upon connection) serves as a
  * wildcard and matches any detail argument passed in to emission.
  */
-/*
- * MT safe
- */
-
-#include <config.h>
-
-#include        "gsignal.h"
-
-#include        "gbsearcharray.h"
-#include        "gvaluecollector.h"
-#include	"gvaluetypes.h"
-#include	"gboxed.h"
-#include	"gobject.h"
-#include	"genums.h"
-
-#include	"gobjectalias.h"
-
-#include	<string.h> 
-#include	<signal.h>
 
 
 /* pre allocation configurations

gobject/gsourceclosure.c

@@ -17,6 +17,8 @@
  * Boston, MA 02111-1307, USA.
  */
 
+#include "config.h"
+
 #include "gsourceclosure.h"
 #include "gboxed.h"
 #include "genums.h"
@@ -25,6 +27,7 @@
 #include "gvaluetypes.h"
 #include "gobjectalias.h"
 
+
 GType
 g_io_channel_get_type (void)
 {

gobject/gtype.c

@@ -16,6 +16,22 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/*
+ * MT safe
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include "gtype.h"
+#include "gtypeplugin.h"
+#include "gvaluecollector.h"
+#include "gbsearcharray.h"
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:gtype
  * @Short_description: The GLib Runtime type identification and management system
@@ -52,19 +68,7 @@
  * or an underscore '_'. Subsequent characters can be letters, numbers or
  * any of '-_+'.
  */
-#include        <config.h>
-#include	"gtype.h"
 
-/*
- * MT safe
- */
-
-#include	"gtypeplugin.h"
-#include	"gvaluecollector.h"
-#include	"gbsearcharray.h"
-#include	<string.h>
-
-#include	"gobjectalias.h"
 
 /* NOTE: some functions (some internal variants and exported ones)
  * invalidate data portions of the TypeNodes. if external functions/callbacks

gobject/gtypemodule.c

@@ -16,6 +16,16 @@
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+#include "config.h"
+
+#include <stdlib.h>
+
+#include "gtypeplugin.h"
+#include "gtypemodule.h"
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:gtypemodule
  * @Short_description: Type loading modules
@@ -60,11 +70,6 @@
  * in #GTypeModuleClass.
  */
 
-#include <stdlib.h>
-
-#include "gtypeplugin.h"
-#include "gtypemodule.h"
-#include "gobjectalias.h"
 
 typedef struct _ModuleTypeInfo ModuleTypeInfo;
 typedef struct _ModuleInterfaceInfo ModuleInterfaceInfo;

gobject/gtypeplugin.c

@@ -16,15 +16,22 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+#include "config.h"
+
+#include "gtypeplugin.h"
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:gtypeplugin
  * @Short_description: An interface for dynamically loadable types
  * @See_also:#GTypeModule and g_type_register_dynamic().
  * @Titile: GTypePlugin
  *
- * The GObject type system supports dynamic loading of types. The #GTypePlugin 
+ * The GObject type system supports dynamic loading of types. The
- * interface is used to handle the lifecycle of dynamically loaded types. 
+ * #GTypePlugin interface is used to handle the lifecycle of
- * It goes as follows:
+ * dynamically loaded types.  It goes as follows:
  *
  * <orderedlist>
  * <listitem><para>
@@ -66,21 +73,19 @@
  * </para></listitem>
  * </orderedlist>
  *
- * So basically, you need to implement a #GTypePlugin type that carries a
+ * So basically, you need to implement a #GTypePlugin type that
- * use_count, once use_count goes from zero to one, you need to load the 
+ * carries a use_count, once use_count goes from zero to one, you need
- * implementation to successfully handle the upcoming 
+ * to load the implementation to successfully handle the upcoming
- * g_type_plugin_complete_type_info() call. Later, maybe after succeeding 
+ * g_type_plugin_complete_type_info() call. Later, maybe after
- * use/unuse calls, once use_count drops to zero, you can unload the 
+ * succeeding use/unuse calls, once use_count drops to zero, you can
- * implementation again. The type system makes sure to call g_type_plugin_use() 
+ * unload the implementation again. The type system makes sure to call
- * and g_type_plugin_complete_type_info() again when the type is needed again.
+ * g_type_plugin_use() and g_type_plugin_complete_type_info() again
+ * when the type is needed again.
  *
- * #GTypeModule is an implementation of #GTypePlugin that already implements 
+ * #GTypeModule is an implementation of #GTypePlugin that already
- * most of this except for the actual module loading and unloading. It even 
+ * implements most of this except for the actual module loading and
- * handles multiple registered types per module.
+ * unloading. It even handles multiple registered types per module.
  */
-#include	"gtypeplugin.h"
-#include	"gobjectalias.h"
-
 
 
 /* --- functions --- */

gobject/gvaluearray.c

@@ -16,26 +16,33 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+/*
+ * MT safe
+ */
+
+#include "config.h"
+
+#include <string.h>
+#include <stdlib.h>  /* qsort() */
+
+#include "gvaluearray.h"
+
+#include "gobjectalias.h"
+
+
 /**
  * SECTION:value_arrays
  * @Short_description: A container structure to maintain an array of generic values
  * @See_also:#GValue, #GParamSpecValueArray, g_param_spec_value_array()
  * @Title: Value arrays
  *
- * The prime purpose of a #GValueArray is for it to be used as an object property
+ * The prime purpose of a #GValueArray is for it to be used as an
- * that holds an array of values. A #GValueArray wraps an array of #GValue elements
+ * object property that holds an array of values. A #GValueArray wraps
- * in order for it to be used as a boxed type through %G_TYPE_VALUE_ARRAY.
+ * an array of #GValue elements in order for it to be used as a boxed
- */
+ * type through %G_TYPE_VALUE_ARRAY.
-/*
- * MT safe
  */
 
-#include <config.h>
-
-#include	"gvaluearray.h"
-#include 	"gobjectalias.h"
-#include	<string.h>
-#include	<stdlib.h>	/* qsort() */
 
 #ifdef	DISABLE_MEM_POOLS
 #  define	GROUP_N_VALUES	(1)	/* power of 2 !! */

gobject/gvaluetransform.c

@@ -16,10 +16,14 @@
  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  * Boston, MA 02111-1307, USA.
  */
+
+#include "config.h"
+
 #include <string.h>
 
 #include "gvalue.h"
 #include "genums.h"
+
 #include "gobjectalias.h"
 
 

gobject/gvaluetypes.c

@@ -21,18 +21,19 @@
  * MT safe
  */
 
+#include "config.h"
+
+#include <string.h>
+#include <stdlib.h> /* qsort() */
+
 #include "gvaluetypes.h"
-
 #include "gvaluecollector.h"
-
 #include "gobject.h"
 #include "gparam.h"
 #include "gboxed.h"
 #include "genums.h"
 
 #include "gobjectalias.h"
-#include	<string.h>
-#include	<stdlib.h>	/* qsort() */
 
 
 /* --- value functions --- */