diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/ChangeLog | 9 | ||||
| -rw-r--r-- | docs/reference/gio/gio-docs.xml | 3 | ||||
| -rw-r--r-- | docs/reference/gio/gio-sections.txt | 11 | ||||
| -rw-r--r-- | docs/reference/glib/glib-docs.sgml | 3 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/byte_order.sgml | 189 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/glib-unused.sgml | 838 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/iochannels.sgml | 8 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/limits.sgml | 137 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/macros_misc.sgml | 197 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/main.sgml | 9 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/memory.sgml | 10 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/modules.sgml | 183 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/threads.sgml | 13 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/type_conversion.sgml | 46 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/types.sgml | 102 | ||||
| -rw-r--r-- | docs/reference/glib/tmpl/version.sgml | 30 | ||||
| -rw-r--r-- | docs/reference/gobject/gobject-docs.sgml | 2 |
17 files changed, 947 insertions, 843 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index add41cb5c..fd079482a 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,12 @@ +2008-10-16 Matthias Clasen <mclasen@redhat.com> + + * === Released 2.19.0 === + + * gio/gio-sections.txt: Add new api + + * gobject/gobject-docs.sgml: + * gio/gio-docs.xml: Add new indexes + 2008-10-16 Matthias Clasen <mclasen@redhat.com> * glib/Makefile.am: Don't specify multiple directories in diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml index f21ad8f45..dfe2fb53b 100644 --- a/docs/reference/gio/gio-docs.xml +++ b/docs/reference/gio/gio-docs.xml @@ -111,4 +111,7 @@ <index role="2.18"> <title>Index of new symbols in 2.18</title> </index> + <index role="2.20"> + <title>Index of new symbols in 2.20</title> + </index> </book> diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt index 6d78499ec..3bb0a7943 100644 --- a/docs/reference/gio/gio-sections.txt +++ b/docs/reference/gio/gio-sections.txt @@ -320,6 +320,8 @@ g_file_attribute_info_list_unref g_file_attribute_info_list_dup g_file_attribute_info_list_lookup g_file_attribute_info_list_add +<SUBSECTION Private> +g_file_attribute_info_list_get_type </SECTION> <SECTION> @@ -449,6 +451,12 @@ g_emblem_get_icon g_emblem_get_origin <SUBSECTION Private> g_emblem_get_type +G_EMBLEM +G_EMBLEM_CLASS +G_EMBLEM_GET_CLASS +G_IS_EMBLEM +G_IS_EMBLEM_CLASS +G_TYPE_EMBLEM </SECTION> <SECTION> @@ -1061,6 +1069,9 @@ g_app_info_supports_files g_app_info_supports_uris g_app_info_launch_uris g_app_info_should_show +g_app_info_can_delete +g_app_info_delete +g_app_info_reset_type_associations g_app_info_set_as_default_for_type g_app_info_set_as_default_for_extension g_app_info_add_supports_type diff --git a/docs/reference/glib/glib-docs.sgml b/docs/reference/glib/glib-docs.sgml index 736504137..390fd4bd2 100644 --- a/docs/reference/glib/glib-docs.sgml +++ b/docs/reference/glib/glib-docs.sgml @@ -235,5 +235,8 @@ synchronize their operation. <index role="2.18"> <title>Index of new symbols in 2.18</title> </index> + <index role="2.20"> + <title>Index of new symbols in 2.20</title> + </index> </book> diff --git a/docs/reference/glib/tmpl/byte_order.sgml b/docs/reference/glib/tmpl/byte_order.sgml index ee0dfb8f5..47a7225cb 100644 --- a/docs/reference/glib/tmpl/byte_order.sgml +++ b/docs/reference/glib/tmpl/byte_order.sgml @@ -52,6 +52,15 @@ side-effects. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### MACRO G_BYTE_ORDER ##### --> +<para> +The host byte order. +This can be either #G_LITTLE_ENDIAN or #G_BIG_ENDIAN (support for +#G_PDP_ENDIAN may be added in future.) +</para> + + + <!-- ##### MACRO G_LITTLE_ENDIAN ##### --> <para> Specifies one of the possible types of byte order. @@ -130,6 +139,24 @@ Converts a #gint value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GINT_TO_BE ##### --> +<para> +Converts a #gint value from host byte order to big-endian. +</para> + +@val: a #gint value in host byte order. +@Returns: @val converted to big-endian byte order. + + +<!-- ##### MACRO GINT_TO_LE ##### --> +<para> +Converts a #gint value from host byte order to little-endian. +</para> + +@val: a #gint value in host byte order. +@Returns: @val converted to little-endian byte order. + + <!-- ##### MACRO GUINT_FROM_BE ##### --> <para> Converts a #guint value from big-endian to host byte order. @@ -148,6 +175,24 @@ Converts a #guint value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GUINT_TO_BE ##### --> +<para> +Converts a #guint value from host byte order to big-endian. +</para> + +@val: a #guint value in host byte order. +@Returns: @val converted to big-endian byte order. + + +<!-- ##### MACRO GUINT_TO_LE ##### --> +<para> +Converts a #guint value from host byte order to little-endian. +</para> + +@val: a #guint value in host byte order. +@Returns: @val converted to little-endian byte order. + + <!-- ##### MACRO GLONG_FROM_BE ##### --> <para> Converts a #glong value from big-endian to the host byte order. @@ -166,6 +211,24 @@ Converts a #glong value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GLONG_TO_BE ##### --> +<para> +Converts a #glong value from host byte order to big-endian. +</para> + +@val: a #glong value in host byte order. +@Returns: @val converted to big-endian byte order. + + +<!-- ##### MACRO GLONG_TO_LE ##### --> +<para> +Converts a #glong value from host byte order to little-endian. +</para> + +@val: a #glong value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GULONG_FROM_BE ##### --> <para> Converts a #gulong value from big-endian to host byte order. @@ -184,6 +247,24 @@ Converts a #gulong value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GULONG_TO_BE ##### --> +<para> +Converts a #gulong value from host byte order to big-endian. +</para> + +@val: a #gulong value in host byte order. +@Returns: @val converted to big-endian. + + +<!-- ##### MACRO GULONG_TO_LE ##### --> +<para> +Converts a #gulong value from host byte order to little-endian. +</para> + +@val: a #gulong value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GINT16_FROM_BE ##### --> <para> Converts a #gint16 value from big-endian to host byte order. @@ -202,6 +283,24 @@ Converts a #gint16 value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GINT16_TO_BE ##### --> +<para> +Converts a #gint16 value from host byte order to big-endian. +</para> + +@val: a #gint16 value in host byte order. +@Returns: @val converted to big-endian. + + +<!-- ##### MACRO GINT16_TO_LE ##### --> +<para> +Converts a #gint16 value from host byte order to little-endian. +</para> + +@val: a #gint16 value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GUINT16_FROM_BE ##### --> <para> Converts a #guint16 value from big-endian to host byte order. @@ -220,6 +319,24 @@ Converts a #guint16 value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GUINT16_TO_BE ##### --> +<para> +Converts a #guint16 value from host byte order to big-endian. +</para> + +@val: a #guint16 value in host byte order. +@Returns: @val converted to big-endian. + + +<!-- ##### MACRO GUINT16_TO_LE ##### --> +<para> +Converts a #guint16 value from host byte order to little-endian. +</para> + +@val: a #guint16 value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GINT32_FROM_BE ##### --> <para> Converts a #gint32 value from big-endian to host byte order. @@ -238,6 +355,24 @@ Converts a #gint32 value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GINT32_TO_BE ##### --> +<para> +Converts a #gint32 value from host byte order to big-endian. +</para> + +@val: a #gint32 value in host byte order. +@Returns: @val converted to big-endian. + + +<!-- ##### MACRO GINT32_TO_LE ##### --> +<para> +Converts a #gint32 value from host byte order to little-endian. +</para> + +@val: a #gint32 value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GUINT32_FROM_BE ##### --> <para> Converts a #guint32 value from big-endian to host byte order. @@ -256,6 +391,24 @@ Converts a #guint32 value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GUINT32_TO_BE ##### --> +<para> +Converts a #guint32 value from host byte order to big-endian. +</para> + +@val: a #guint32 value in host byte order. +@Returns: @val converted to big-endian. + + +<!-- ##### MACRO GUINT32_TO_LE ##### --> +<para> +Converts a #guint32 value from host byte order to little-endian. +</para> + +@val: a #guint32 value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GINT64_FROM_BE ##### --> <para> Converts a #gint64 value from big-endian to host byte order. @@ -274,6 +427,24 @@ Converts a #gint64 value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GINT64_TO_BE ##### --> +<para> +Converts a #gint64 value from host byte order to big-endian. +</para> + +@val: a #gint64 value in host byte order. +@Returns: @val converted to big-endian. + + +<!-- ##### MACRO GINT64_TO_LE ##### --> +<para> +Converts a #gint64 value from host byte order to little-endian. +</para> + +@val: a #gint64 value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GUINT64_FROM_BE ##### --> <para> Converts a #guint64 value from big-endian to host byte order. @@ -292,6 +463,24 @@ Converts a #guint64 value from little-endian to host byte order. @Returns: @val converted to host byte order. +<!-- ##### MACRO GUINT64_TO_BE ##### --> +<para> +Converts a #guint64 value from host byte order to big-endian. +</para> + +@val: a #guint64 value in host byte order. +@Returns: @val converted to big-endian. + + +<!-- ##### MACRO GUINT64_TO_LE ##### --> +<para> +Converts a #guint64 value from host byte order to little-endian. +</para> + +@val: a #guint64 value in host byte order. +@Returns: @val converted to little-endian. + + <!-- ##### MACRO GUINT16_SWAP_BE_PDP ##### --> <para> Converts a #guint16 value between big-endian and pdp-endian byte order. diff --git a/docs/reference/glib/tmpl/glib-unused.sgml b/docs/reference/glib/tmpl/glib-unused.sgml index 0e80ab3d5..ca73e16e9 100644 --- a/docs/reference/glib/tmpl/glib-unused.sgml +++ b/docs/reference/glib/tmpl/glib-unused.sgml @@ -180,83 +180,6 @@ Specifies the type of function passed to g_set_error_handler(). @hook_list: @hook: -<!-- ##### MACRO GINT16_TO_BE ##### --> -<para> -Converts a #gint16 value from host byte order to big-endian. -</para> - -@val: a #gint16 value in host byte order. -@Returns: @val converted to big-endian. - -<!-- ##### MACRO GINT16_TO_LE ##### --> -<para> -Converts a #gint16 value from host byte order to little-endian. -</para> - -@val: a #gint16 value in host byte order. -@Returns: @val converted to little-endian. - -<!-- ##### MACRO GINT32_TO_BE ##### --> -<para> -Converts a #gint32 value from host byte order to big-endian. -</para> - -@val: a #gint32 value in host byte order. -@Returns: @val converted to big-endian. - -<!-- ##### MACRO GINT32_TO_LE ##### --> -<para> -Converts a #gint32 value from host byte order to little-endian. -</para> - -@val: a #gint32 value in host byte order. -@Returns: @val converted to little-endian. - -<!-- ##### MACRO GINT64_TO_BE ##### --> -<para> -Converts a #gint64 value from host byte order to big-endian. -</para> - -@val: a #gint64 value in host byte order. -@Returns: @val converted to big-endian. - -<!-- ##### MACRO GINT64_TO_LE ##### --> -<para> -Converts a #gint64 value from host byte order to little-endian. -</para> - -@val: a #gint64 value in host byte order. -@Returns: @val converted to little-endian. - -<!-- ##### MACRO GINT_TO_BE ##### --> -<para> -Converts a #gint value from host byte order to big-endian. -</para> - -@val: a #gint value in host byte order. -@Returns: @val converted to big-endian byte order. - -<!-- ##### MACRO GINT_TO_LE ##### --> -<para> -Converts a #gint value from host byte order to little-endian. -</para> - -@val: a #gint value in host byte order. -@Returns: @val converted to little-endian byte order. - -<!-- ##### MACRO GINT_TO_POINTER ##### --> -<para> -Stuffs an integer into a pointer type. -</para> -<para> -Remember, YOU MAY NOT STORE POINTERS IN INTEGERS. THIS IS NOT PORTABLE -IN ANY WAY SHAPE OR FORM. These macros <emphasis>ONLY</emphasis> allow -storing integers in pointers, and only preserve 32 bits of the -integer; values outside the range of a 32-bit integer will be mangled. -</para> - -@i: integer to stuff into a pointer. - <!-- ##### ENUM GIOFileMode ##### --> <para> @@ -269,49 +192,6 @@ integer; values outside the range of a 32-bit integer will be mangled. @G_IO_FILE_MODE_READ_WRITE_TRUNCATE: @G_IO_FILE_MODE_READ_WRITE_APPEND: -<!-- ##### MACRO GLIB_MAJOR_VERSION ##### --> -<para> -The major version number of the GLib library. -Like #glib_major_version, but from the headers used at -application compile time, rather than from the library linked against -at application run time. -</para> - - -<!-- ##### MACRO GLIB_MICRO_VERSION ##### --> -<para> -The micro version number of the GLib library. -Like #gtk_micro_version, but from the headers used at -application compile time, rather than from the library linked against -at application run time. -</para> - - -<!-- ##### MACRO GLIB_MINOR_VERSION ##### --> -<para> -The minor version number of the GLib library. -Like #gtk_minor_version, but from the headers used at -application compile time, rather than from the library linked against -at application run time. -</para> - - -<!-- ##### MACRO GLONG_TO_BE ##### --> -<para> -Converts a #glong value from host byte order to big-endian. -</para> - -@val: a #glong value in host byte order. -@Returns: @val converted to big-endian byte order. - -<!-- ##### MACRO GLONG_TO_LE ##### --> -<para> -Converts a #glong value from host byte order to little-endian. -</para> - -@val: a #glong value in host byte order. -@Returns: @val converted to little-endian. - <!-- ##### ENUM GMatchType ##### --> <para> Enumeration representing different kinds of patterns. This is only used @@ -326,170 +206,6 @@ the end of the string. @G_MATCH_EXACT: a pattern matching exactly one string. @G_MATCH_LAST: -<!-- ##### STRUCT GModule ##### --> -<para> -The #GModule struct is an opaque data structure to represent a -<link linkend="glib-Dynamic-Loading-of-Modules">Dynamically-Loaded Module</link>. -It should only be accessed via the following functions. -</para> - - -<!-- ##### USER_FUNCTION GModuleCheckInit ##### --> -<para> -Specifies the type of the module initialization function. -<indexterm zone="g-module-check-init"><primary>g_module_check_init</primary></indexterm> -If a module contains a function named g_module_check_init() it is called -automatically when the module is loaded. It is passed the #GModule structure -and should return %NULL on success or a string describing the initialization -error. -</para> - -@module: the #GModule corresponding to the module which has just been loaded. -@Returns: %NULL on success, or a string describing the initialization error. - -<!-- ##### ENUM GModuleFlags ##### --> -<para> -Flags passed to g_module_open(). Note that these flags are -not supported on all platforms. -</para> - -@G_MODULE_BIND_LAZY: specifies that symbols are only resolved when needed. - The default action is to bind all symbols when the module is loaded. -@G_MODULE_BIND_LOCAL: specifies that symbols in the module should - not be added to the global name space. The default action on most - platforms is to place symbols in the module in the global name space, - which may cause conflicts with existing symbols. -@G_MODULE_BIND_MASK: mask for all flags. - -<!-- ##### USER_FUNCTION GModuleUnload ##### --> -<para> -<indexterm zone="g-module-unload"><primary>g_module_unload</primary></indexterm> -Specifies the type of the module function called when it is unloaded. -If a module contains a function named g_module_unload() it is called -automatically when the module is unloaded. -It is passed the #GModule structure. -</para> - -@module: the #GModule about to be unloaded. - -<!-- ##### MACRO GPOINTER_TO_INT ##### --> -<para> -Extracts an integer from a pointer. The integer must have -been stored in the pointer with GINT_TO_POINTER(). -</para> -<para> -Remember, YOU MAY NOT STORE POINTERS IN INTEGERS. THIS IS NOT PORTABLE -IN ANY WAY SHAPE OR FORM. These macros <emphasis>ONLY</emphasis> allow -storing integers in pointers, and only preserve 32 bits of the -integer; values outside the range of a 32-bit integer will be mangled. -</para> - -@p: pointer containing an integer. - -<!-- ##### MACRO GPOINTER_TO_UINT ##### --> -<para> -Extracts an unsigned integer from a pointer. The integer must have -been stored in the pointer with GUINT_TO_POINTER(). -</para> - -@p: pointer to extract an unsigned integer from. - -<!-- ##### TYPEDEF GPid ##### --> -<para> -A type which is used to hold a process identification. -On Unix, processes are identified by a process id (an -integer), while Windows uses process handles (which are -pointers). -</para> - - -<!-- ##### MACRO GUINT16_TO_BE ##### --> -<para> -Converts a #guint16 value from host byte order to big-endian. -</para> - -@val: a #guint16 value in host byte order. -@Returns: @val converted to big-endian. - -<!-- ##### MACRO GUINT16_TO_LE ##### --> -<para> -Converts a #guint16 value from host byte order to little-endian. -</para> - -@val: a #guint16 value in host byte order. -@Returns: @val converted to little-endian. - -<!-- ##### MACRO GUINT32_TO_BE ##### --> -<para> -Converts a #guint32 value from host byte order to big-endian. -</para> - -@val: a #guint32 value in host byte order. -@Returns: @val converted to big-endian. - -<!-- ##### MACRO GUINT32_TO_LE ##### --> -<para> -Converts a #guint32 value from host byte order to little-endian. -</para> - -@val: a #guint32 value in host byte order. -@Returns: @val converted to little-endian. - -<!-- ##### MACRO GUINT64_TO_BE ##### --> -<para> -Converts a #guint64 value from host byte order to big-endian. -</para> - -@val: a #guint64 value in host byte order. -@Returns: @val converted to big-endian. - -<!-- ##### MACRO GUINT64_TO_LE ##### --> -<para> -Converts a #guint64 value from host byte order to little-endian. -</para> - -@val: a #guint64 value in host byte order. -@Returns: @val converted to little-endian. - -<!-- ##### MACRO GUINT_TO_BE ##### --> -<para> -Converts a #guint value from host byte order to big-endian. -</para> - -@val: a #guint value in host byte order. -@Returns: @val converted to big-endian byte order. - -<!-- ##### MACRO GUINT_TO_LE ##### --> -<para> -Converts a #guint value from host byte order to little-endian. -</para> - -@val: a #guint value in host byte order. -@Returns: @val converted to little-endian byte order. - -<!-- ##### MACRO GUINT_TO_POINTER ##### --> -<para> -Stuffs an unsigned integer into a pointer type. -</para> - -@u: unsigned integer to stuff into the pointer. - -<!-- ##### MACRO GULONG_TO_BE ##### --> -<para> -Converts a #gulong value from host byte order to big-endian. -</para> - -@val: a #gulong value in host byte order. -@Returns: @val converted to big-endian. - -<!-- ##### MACRO GULONG_TO_LE ##### --> -<para> -Converts a #gulong value from host byte order to little-endian. -</para> - -@val: a #gulong value in host byte order. -@Returns: @val converted to little-endian. - <!-- ##### USER_FUNCTION GWarningFunc ##### --> <para> Specifies the type of function passed to g_set_warning_handler(). @@ -497,14 +213,6 @@ Specifies the type of function passed to g_set_warning_handler(). @str: the warning message. -<!-- ##### MACRO G_BYTE_ORDER ##### --> -<para> -The host byte order. -This can be either #G_LITTLE_ENDIAN or #G_BIG_ENDIAN (support for -#G_PDP_ENDIAN may be added in future.) -</para> - - <!-- ##### MACRO G_CHANNEL_ERROR ##### --> <para> @@ -519,214 +227,6 @@ error domains. </para> -<!-- ##### MACRO G_GINT16_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #gint16. It is a string literal, but doesn't -include the percent-sign, such that you can add precision and length -modifiers between percent-sign and conversion specifier. -</para> - -<para> -<informalexample> -<programlisting> -gint16 in; -gint32 out; -sscanf ("42", "%" G_GINT16_FORMAT, &in) -out = in * 1000; -g_print ("%" G_GINT32_FORMAT, out); -</programlisting> -</informalexample> -</para> - - -<!-- ##### MACRO G_GINT16_MODIFIER ##### --> -<para> -The platform dependent length modifier for constructing printf() conversion -specifiers for values of type #gint16 or #guint16. It is a string literal, -but doesn't include the percent-sign, such that you can add precision and -length modifiers between percent-sign and conversion specifier and append a -conversion specifier. -</para> - -<para> -The following example prints "0x7b"; -<informalexample> -<programlisting> -gint16 value = 123; -g_print ("%#" G_GINT16_MODIFIER "x", value); -</programlisting> -</informalexample> -</para> - -@Since: 2.4 - -<!-- ##### MACRO G_GINT32_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #gint32. See also #G_GINT16_FORMAT. -</para> - - -<!-- ##### MACRO G_GINT32_MODIFIER ##### --> -<para> -The platform dependent length modifier for constructing printf() conversion -specifiers for values of type #gint32 or #guint32. See also #G_GINT16_MODIFIER. -</para> - -@Since: 2.4 - -<!-- ##### MACRO G_GINT64_CONSTANT ##### --> -<para> -This macro is used to insert 64-bit integer literals into the source code. -</para> - -@val: a literal integer value, e.g. 0x1d636b02300a7aa7U. - -<!-- ##### MACRO G_GINT64_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #gint64. See also #G_GINT16_FORMAT. -</para> - -<note> -<para> -Some platforms do not support scanning and printing 64 bit integers, -even though the types are supported. On such platforms #G_GINT64_FORMAT -is not defined. Note that scanf() may not support 64 bit integers, even -if #G_GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not -recommended for parsing anyway; consider using g_strtoull() instead. -</para> -</note> - - -<!-- ##### MACRO G_GINT64_MODIFIER ##### --> -<para> -The platform dependent length modifier for constructing printf() conversion -specifiers for values of type #gint64 or #guint64. See also #G_GINT16_MODIFIER. -</para> - -<note> -<para> -Some platforms do not support printing 64 bit integers, -even though the types are supported. On such platforms #G_GINT64_MODIFIER -is not defined. -</para> -</note> - -@Since: 2.4 - -<!-- ##### MACRO G_GNUC_INTERNAL ##### --> -<para> -This attribute can be used for marking library functions as being used -internally to the library only, which may allow the compiler to handle -function calls more efficiently. -Note that static functions do not need to be marked as internal in this way. -See the GNU C documentation for details. -</para> -<para> -When using a compiler that supports the GNU C hidden visibility attribute, -this macro expands to <literal>__attribute__((visibility("hidden")))</literal>. -When using the Sun Studio compiler, it expands to <literal>__hidden</literal>. -</para> -<para> -Note that for portability, the attribute should be placed before the -function declaration. While GCC allows the macro after the declaration, -Sun Studio does not. -</para> -<informalexample><programlisting> -G_GNUC_INTERNAL -void _g_log_fallback_handler (const gchar *log_domain, - GLogLevelFlags log_level, - const gchar *message, - gpointer unused_data); -</programlisting></informalexample> - -Since: 2.6 - - -<!-- ##### MACRO G_GSIZE_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #gsize. See also #G_GINT16_FORMAT. -</para> - -@Since: 2.6 - -<!-- ##### MACRO G_GSIZE_MODIFIER ##### --> -<para> -The platform dependent length modifier for constructing printf() conversion -specifiers for values of type #gsize or #gssize. See also #G_GINT16_MODIFIER. -</para> - -@Since: 2.6 - -<!-- ##### MACRO G_GSSIZE_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #gssize. See also #G_GINT16_FORMAT. -</para> - -@Since: 2.6 - -<!-- ##### MACRO G_GUINT16_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #guint16. See also #G_GINT16_FORMAT. -</para> - - -<!-- ##### MACRO G_GUINT32_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #guint32. See also #G_GINT16_FORMAT. -</para> - - -<!-- ##### MACRO G_GUINT64_CONSTANT ##### --> -<para> -This macro is used to insert 64-bit unsigned integer literals into the -source code. -</para> - -@val: a literal integer value, e.g. 0x1d636b02300a7aa7U. -@Since: 2.10 - -<!-- ##### MACRO G_GUINT64_FORMAT ##### --> -<para> -This is the platform dependent conversion specifier for scanning and -printing values of type #guint64. See also #G_GINT16_FORMAT. -</para> - -<note> -<para> -Some platforms do not support scanning and printing 64 bit integers, -even though the types are supported. On such platforms #G_GUINT64_FORMAT -is not defined. Note that scanf() may not support 64 bit integers, even -if #G_GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not -recommended for parsing anyway; consider using g_strtoull() instead. -</para> -</note> - - -<!-- ##### MACRO G_HAVE_GINT64 ##### --> -<para> -This macro is defined if 64-bit signed and unsigned integers are available -on the platform. -</para> - -@Deprecated: GLib requires 64-bit integer support since version 2.0, therefore -%G_HAVE_GINT64 is <emphasis>always</emphasis> defined. - -<!-- ##### MACRO G_HAVE_GNUC_VISIBILITY ##### --> -<para> -This macro is defined as 1 if the compiler supports ELF visibility -attributes (currently only <command>gcc</command>). -</para> - -Since: 2.6 - - <!-- ##### MACRO G_HOOK_DEFERRED_DESTROY ##### --> <para> @@ -767,159 +267,6 @@ not work. </para> -<!-- ##### MACRO G_MAXDOUBLE ##### --> -<para> -The maximum value which can be held in a #gdouble. -</para> - - -<!-- ##### MACRO G_MAXFLOAT ##### --> -<para> -The maximum value which can be held in a #gfloat. -</para> - - -<!-- ##### MACRO G_MAXINT ##### --> -<para> -The maximum value which can be held in a #gint. -</para> - - -<!-- ##### MACRO G_MAXLONG ##### --> -<para> -The maximum value which can be held in a #glong. -</para> - - -<!-- ##### MACRO G_MAXOFFSET ##### --> -<para> -The maximum value which can be held in a #goffset. -</para> - - -<!-- ##### MACRO G_MAXSHORT ##### --> -<para> -The maximum value which can be held in a #gshort. -</para> - - -<!-- ##### MACRO G_MAXSIZE ##### --> -<para> -The maximum value which can be held in a #gsize. -</para> - -@Since: 2.4 - -<!-- ##### MACRO G_MAXSSIZE ##### --> -<para> -The maximum value which can be held in a #gssize. -</para> - -@Since: 2.14 - -<!-- ##### MACRO G_MAXUINT ##### --> -<para> -The maximum value which can be held in a #guint. -</para> - - -<!-- ##### MACRO G_MAXULONG ##### --> -<para> -The maximum value which can be held in a #gulong. -</para> - - -<!-- ##### MACRO G_MAXUSHORT ##### --> -<para> -The maximum value which can be held in a #gushort. -</para> - - -<!-- ##### MACRO G_MINDOUBLE ##### --> -<para> -The minimum positive value which can be held in a #gdouble. -</para> -<para> -If you are interested in the smallest value which can be held in a #gdouble, -use -G_MAXDOUBLE. -</para> - - -<!-- ##### MACRO G_MINFLOAT ##### --> -<para> -The minimum positive value which can be held in a #gfloat. -</para> -<para> -If you are interested in the smallest value which can be held in a #gfloat, -use -G_MAX_FLOAT. -</para> - - -<!-- ##### MACRO G_MININT ##### --> -<para> -The minimum value which can be held in a #gint. -</para> - - -<!-- ##### MACRO G_MINLONG ##### --> -<para> -The minimum value which can be held in a #glong. -</para> - - -<!-- ##### MACRO G_MINOFFSET ##### --> -<para> -The minimum value which can be held in a #goffset. -</para> - - -<!-- ##### MACRO G_MINSHORT ##### --> -<para> -The minimum value which can be held in a #gshort. -</para> - - -<!-- ##### MACRO G_MINSSIZE ##### --> -<para> -The minimum value which can be held in a #gssize. -</para> - -@Since: 2.14 - -<!-- ##### MACRO G_MODULE_EXPORT ##### --> -<para> -Used to declare functions exported by modules. This is a no-op on Linux and -Unices, but when compiling for Windows, it marks a symbol to be exported from -the library or executable being built. -</para> - - -<!-- ##### MACRO G_MODULE_IMPORT ##### --> -<para> -Used to declare functions imported from modules. -</para> - - -<!-- ##### MACRO G_MODULE_SUFFIX ##### --> -<para> -Expands to the proper shared library suffix for the current platform -without the leading dot. For the most Unices and Linux this is "so", -for some HP-UX versions this is "sl" and for Windows this is "dll". -</para> - - -<!-- ##### MACRO G_THREADS_ENABLED ##### --> - -<para> -This macro is defined if GLib was compiled with thread support. This -does not necessarily mean that there is a thread implementation -available, but it does mean that the infrastructure is in place and -that once you provide a thread implementation to g_thread_init(), GLib -will be multi-thread safe. If #G_THREADS_ENABLED is not defined, then -Glib is not, and cannot be, multi-thread safe. -</para> - - <!-- ##### MACRO NAME_MAX ##### --> <para> Provided for UNIX emulation on Windows; equivalent to UNIX macro @@ -1406,117 +753,6 @@ To use this function you must configure glib with the flag @mem: the memory to check. -<!-- ##### MACRO g_memmove ##### --> -<para> - -</para> - -@dest: -@src: -@len: - -<!-- ##### FUNCTION g_module_build_path ##### --> -<para> -A portable way to build the filename of a module. The platform-specific -prefix and suffix are added to the filename, if needed, and the result is -added to the directory, using the correct separator character. -</para> -<para> -The directory should specify the directory where the module can be found. -It can be %NULL or an empty string to indicate that the module is in a standard -platform-specific directory, though this is not recommended since the -wrong module may be found. -</para> -<para> -For example, calling g_module_build_path() on a Linux system with a @directory -of <filename>/lib</filename> and a @module_name of "mylibrary" will return -<filename>/lib/libmylibrary.so</filename>. On a Windows system, using -<filename>\Windows</filename> as the directory it will return -<filename>\Windows\mylibrary.dll</filename>. -</para> - -@directory: the directory where the module is. This can be %NULL or the empty -string to indicate that the standard platform-specific directories will be -used, though that is not recommended. -@module_name: the name of the module. -@Returns: the complete path of the module, including the standard library -prefix and suffix. This should be freed when no longer needed. - -<!-- ##### FUNCTION g_module_close ##### --> -<para> -Closes a module. -</para> - -@module: a #GModule to close. -@Returns: %TRUE on success. - -<!-- ##### FUNCTION g_module_error ##### --> -<para> -Gets a string describing the last module error. -</para> - -@Returns: a string describing the last module error. - -<!-- ##### FUNCTION g_module_make_resident ##### --> -<para> -Ensures that a module will never be unloaded. -Any future g_module_close() calls on the module will be ignored. -</para> - -@module: a #GModule to make permanently resident. - -<!-- ##### FUNCTION g_module_name ##### --> -<para> -Gets the filename from a #GModule. -</para> - -@module: a #GModule. -@Returns: the filename of the module, or "main" if the module is the main -program itself. - -<!-- ##### FUNCTION g_module_open ##### --> -<para> -Opens a module. If the module has already been opened, its reference -count is incremented. -</para> - -<para> -First of all g_module_open() tries to open @file_name as a module. If -that fails and @file_name has the ".la"-suffix (and is a libtool archive) -it tries to open the corresponding module. If that fails and it doesn't -have the proper module suffix for the platform (#G_MODULE_SUFFIX), this -suffix will be appended and the corresponding module will be opended. If -that fails and @file_name doesn't have the ".la"-suffix, this suffix is -appended and g_module_open() tries to open the corresponding module. If -eventually that fails as well, %NULL is returned. -</para> - -@file_name: the name of the file containing the module, or %NULL to obtain - a #GModule representing the main program itself. -@flags: the flags used for opening the module. This can be the logical -OR of any of the #GModuleFlags. -@Returns: a #GModule on success, or %NULL on failure. - -<!-- ##### FUNCTION g_module_supported ##### --> -<para> -Checks if modules are supported on the current platform. -</para> - -@Returns: %TRUE if modules are supported. - -<!-- ##### FUNCTION g_module_symbol ##### --> -<para> -Gets a symbol pointer from a module, such as one exported by #G_MODULE_EXPORT. -</para> -<para> -Note that a valid symbol can be %NULL. -</para> - -@module: a #GModule. -@symbol_name: the name of the symbol to find. -@symbol: returns the pointer to the symbol value. -@Returns: %TRUE on success. - <!-- ##### FUNCTION g_regex_error_quark ##### --> <para> @@ -1664,80 +900,6 @@ Turns the argument into a string literal by using the '#' stringizing operator. </para> -<!-- ##### TYPEDEF gint16 ##### --> -<para> -A signed integer guaranteed to be 16 bits on all platforms. -Values of this type can range from -32,768 to 32,767. -</para> - - -<!-- ##### TYPEDEF gint32 ##### --> -<para> -A signed integer guaranteed to be 32 bits on all platforms. -Values of this type can range from -2,147,483,648 to 2,147,483,647. -</para> - - -<!-- ##### TYPEDEF gint64 ##### --> -<para> -A signed integer guaranteed to be 64 bits on all platforms. -Values of this type can range from -9,223,372,036,854,775,808 to -9,223,372,036,854,775,807. -</para> - - -<!-- ##### TYPEDEF gint8 ##### --> -<para> -A signed integer guaranteed to be 8 bits on all platforms. -Values of this type can range from -128 to 127. -</para> - - -<!-- ##### TYPEDEF goffset ##### --> -<para> -A signed integer type that is used for file offsets, corresponding to the -C99 type off64_t. -</para> - -Since: 2.14 - - -<!-- ##### TYPEDEF gsize ##### --> -<para> -An unsigned integer type of the result of the sizeof operator, corresponding -to the size_t type defined in C99. This type is wide enough to hold the numeric -value of a pointer, so it is usually 32bit wide on a 32bit platform and -64bit wide on a 64bit platform. -</para> - - -<!-- ##### TYPEDEF gssize ##### --> -<para> -A signed variant of gsize, corresponding to the ssize_t defined on most platforms. -</para> - - -<!-- ##### TYPEDEF guint16 ##### --> -<para> -An unsigned integer guaranteed to be 16 bits on all platforms. -Values of this type can range from 0 to 65,535. -</para> - - -<!-- ##### TYPEDEF guint32 ##### --> -<para> -An unsigned integer guaranteed to be 32 bits on all platforms. -Values of this type can range from 0 to 4,294,967,295. -</para> - - -<!-- ##### TYPEDEF guint8 ##### --> -<para> -An unsigned integer guaranteed to be 8 bits on all platforms. -Values of this type can range from 0 to 255. -</para> - - <!-- ##### MACRO lseek ##### --> <para> diff --git a/docs/reference/glib/tmpl/iochannels.sgml b/docs/reference/glib/tmpl/iochannels.sgml index c651def5a..4d5380258 100644 --- a/docs/reference/glib/tmpl/iochannels.sgml +++ b/docs/reference/glib/tmpl/iochannels.sgml @@ -395,7 +395,7 @@ error domains. @channel: @condition: -@Returns: +@Returns: <!-- ##### FUNCTION g_io_add_watch ##### --> @@ -404,7 +404,7 @@ error domains. </para> @channel: -@condition: +@condition: @func: @user_data: @Returns: @@ -417,9 +417,9 @@ error domains. @channel: @priority: -@condition: +@condition: @func: -@user_data: +@user_data: @notify: @Returns: diff --git a/docs/reference/glib/tmpl/limits.sgml b/docs/reference/glib/tmpl/limits.sgml index a06cd9181..c0fe16c53 100644 --- a/docs/reference/glib/tmpl/limits.sgml +++ b/docs/reference/glib/tmpl/limits.sgml @@ -18,6 +18,69 @@ the standard integer and floating point types. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### MACRO G_MININT ##### --> +<para> +The minimum value which can be held in a #gint. +</para> + + + +<!-- ##### MACRO G_MAXINT ##### --> +<para> +The maximum value which can be held in a #gint. +</para> + + + +<!-- ##### MACRO G_MAXUINT ##### --> +<para> +The maximum value which can be held in a #guint. +</para> + + + +<!-- ##### MACRO G_MINSHORT ##### --> +<para> +The minimum value which can be held in a #gshort. +</para> + + + +<!-- ##### MACRO G_MAXSHORT ##### --> +<para> +The maximum value which can be held in a #gshort. +</para> + + + +<!-- ##### MACRO G_MAXUSHORT ##### --> +<para> +The maximum value which can be held in a #gushort. +</para> + + + +<!-- ##### MACRO G_MINLONG ##### --> +<para> +The minimum value which can be held in a #glong. +</para> + + + +<!-- ##### MACRO G_MAXLONG ##### --> +<para> +The maximum value which can be held in a #glong. +</para> + + + +<!-- ##### MACRO G_MAXULONG ##### --> +<para> +The maximum value which can be held in a #gulong. +</para> + + + <!-- ##### MACRO G_MININT8 ##### --> <para> The minimum value which can be held in a #gint8. @@ -111,3 +174,77 @@ The maximum value which can be held in a #guint64. +<!-- ##### MACRO G_MAXSIZE ##### --> +<para> +The maximum value which can be held in a #gsize. +</para> + +@Since: 2.4 + + +<!-- ##### MACRO G_MINSSIZE ##### --> +<para> +The minimum value which can be held in a #gssize. +</para> + +@Since: 2.14 + + +<!-- ##### MACRO G_MAXSSIZE ##### --> +<para> +The maximum value which can be held in a #gssize. +</para> + +@Since: 2.14 + + +<!-- ##### MACRO G_MINOFFSET ##### --> +<para> +The minimum value which can be held in a #goffset. +</para> + + + +<!-- ##### MACRO G_MAXOFFSET ##### --> +<para> +The maximum value which can be held in a #goffset. +</para> + + + +<!-- ##### MACRO G_MINFLOAT ##### --> +<para> +The minimum positive value which can be held in a #gfloat. +</para> +<para> +If you are interested in the smallest value which can be held in a #gfloat, +use -G_MAX_FLOAT. +</para> + + + +<!-- ##### MACRO G_MAXFLOAT ##### --> +<para> +The maximum value which can be held in a #gfloat. +</para> + + + +<!-- ##### MACRO G_MINDOUBLE ##### --> +<para> +The minimum positive value which can be held in a #gdouble. +</para> +<para> +If you are interested in the smallest value which can be held in a #gdouble, +use -G_MAXDOUBLE. +</para> + + + +<!-- ##### MACRO G_MAXDOUBLE ##### --> +<para> +The maximum value which can be held in a #gdouble. +</para> + + + diff --git a/docs/reference/glib/tmpl/macros_misc.sgml b/docs/reference/glib/tmpl/macros_misc.sgml index a59d6fb6f..b84b5b93e 100644 --- a/docs/reference/glib/tmpl/macros_misc.sgml +++ b/docs/reference/glib/tmpl/macros_misc.sgml @@ -320,6 +320,46 @@ See the GNU C documentation for details. +<!-- ##### MACRO G_HAVE_GNUC_VISIBILITY ##### --> +<para> +This macro is defined as 1 if the compiler supports ELF visibility +attributes (currently only <command>gcc</command>). +</para> + +Since: 2.6 + + + +<!-- ##### MACRO G_GNUC_INTERNAL ##### --> +<para> +This attribute can be used for marking library functions as being used +internally to the library only, which may allow the compiler to handle +function calls more efficiently. +Note that static functions do not need to be marked as internal in this way. +See the GNU C documentation for details. +</para> +<para> +When using a compiler that supports the GNU C hidden visibility attribute, +this macro expands to <literal>__attribute__((visibility("hidden")))</literal>. +When using the Sun Studio compiler, it expands to <literal>__hidden</literal>. +</para> +<para> +Note that for portability, the attribute should be placed before the +function declaration. While GCC allows the macro after the declaration, +Sun Studio does not. +</para> +<informalexample><programlisting> +G_GNUC_INTERNAL +void _g_log_fallback_handler (const gchar *log_domain, + GLogLevelFlags log_level, + const gchar *message, + gpointer unused_data); +</programlisting></informalexample> + +Since: 2.6 + + + <!-- ##### MACRO G_GNUC_MAY_ALIAS ##### --> <para> Expands to the GNU C <literal>may_alias</literal> type attribute @@ -379,3 +419,160 @@ Expands to a string identifying the current function. @Since: 2.4 +<!-- ##### MACRO G_GINT16_MODIFIER ##### --> +<para> +The platform dependent length modifier for constructing printf() conversion +specifiers for values of type #gint16 or #guint16. It is a string literal, +but doesn't include the percent-sign, such that you can add precision and +length modifiers between percent-sign and conversion specifier and append a +conversion specifier. +</para> + +<para> +The following example prints "0x7b"; +<informalexample> +<programlisting> +gint16 value = 123; +g_print ("%#" G_GINT16_MODIFIER "x", value); +</programlisting> +</informalexample> +</para> + +@Since: 2.4 + + +<!-- ##### MACRO G_GINT16_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #gint16. It is a string literal, but doesn't +include the percent-sign, such that you can add precision and length +modifiers between percent-sign and conversion specifier. +</para> + +<para> +<informalexample> +<programlisting> +gint16 in; +gint32 out; +sscanf ("42", "%" G_GINT16_FORMAT, &in) +out = in * 1000; +g_print ("%" G_GINT32_FORMAT, out); +</programlisting> +</informalexample> +</para> + + + +<!-- ##### MACRO G_GUINT16_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #guint16. See also #G_GINT16_FORMAT. +</para> + + + +<!-- ##### MACRO G_GINT32_MODIFIER ##### --> +<para> +The platform dependent length modifier for constructing printf() conversion +specifiers for values of type #gint32 or #guint32. See also #G_GINT16_MODIFIER. +</para> + +@Since: 2.4 + + +<!-- ##### MACRO G_GINT32_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #gint32. See also #G_GINT16_FORMAT. +</para> + + + +<!-- ##### MACRO G_GUINT32_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #guint32. See also #G_GINT16_FORMAT. +</para> + + + +<!-- ##### MACRO G_GINT64_MODIFIER ##### --> +<para> +The platform dependent length modifier for constructing printf() conversion +specifiers for values of type #gint64 or #guint64. See also #G_GINT16_MODIFIER. +</para> + +<note> +<para> +Some platforms do not support printing 64 bit integers, +even though the types are supported. On such platforms #G_GINT64_MODIFIER +is not defined. +</para> +</note> + +@Since: 2.4 + + +<!-- ##### MACRO G_GINT64_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #gint64. See also #G_GINT16_FORMAT. +</para> + +<note> +<para> +Some platforms do not support scanning and printing 64 bit integers, +even though the types are supported. On such platforms #G_GINT64_FORMAT +is not defined. Note that scanf() may not support 64 bit integers, even +if #G_GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not +recommended for parsing anyway; consider using g_strtoull() instead. +</para> +</note> + + + +<!-- ##### MACRO G_GUINT64_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #guint64. See also #G_GINT16_FORMAT. +</para> + +<note> +<para> +Some platforms do not support scanning and printing 64 bit integers, +even though the types are supported. On such platforms #G_GUINT64_FORMAT +is not defined. Note that scanf() may not support 64 bit integers, even +if #G_GINT64_FORMAT is defined. Due to its weak error handling, scanf() is not +recommended for parsing anyway; consider using g_strtoull() instead. +</para> +</note> + + + +<!-- ##### MACRO G_GSIZE_MODIFIER ##### --> +<para> +The platform dependent length modifier for constructing printf() conversion +specifiers for values of type #gsize or #gssize. See also #G_GINT16_MODIFIER. +</para> + +@Since: 2.6 + + +<!-- ##### MACRO G_GSIZE_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #gsize. See also #G_GINT16_FORMAT. +</para> + +@Since: 2.6 + + +<!-- ##### MACRO G_GSSIZE_FORMAT ##### --> +<para> +This is the platform dependent conversion specifier for scanning and +printing values of type #gssize. See also #G_GINT16_FORMAT. +</para> + +@Since: 2.6 + + diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml index d711c0961..9f7de38f9 100644 --- a/docs/reference/glib/tmpl/main.sgml +++ b/docs/reference/glib/tmpl/main.sgml @@ -645,6 +645,15 @@ for the default main context. @Returns: +<!-- ##### TYPEDEF GPid ##### --> +<para> +A type which is used to hold a process identification. +On Unix, processes are identified by a process id (an +integer), while Windows uses process handles (which are +pointers). +</para> + + <!-- ##### USER_FUNCTION GChildWatchFunc ##### --> <para> The type of functions to be called when a child exists. diff --git a/docs/reference/glib/tmpl/memory.sgml b/docs/reference/glib/tmpl/memory.sgml index 963c17dd9..90df4f882 100644 --- a/docs/reference/glib/tmpl/memory.sgml +++ b/docs/reference/glib/tmpl/memory.sgml @@ -258,6 +258,16 @@ Wraps g_alloca() in a more typesafe manner. @Returns: Pointer to stack space for @n_structs chunks of type @struct_type +<!-- ##### MACRO g_memmove ##### --> +<para> + +</para> + +@dest: +@src: +@len: + + <!-- ##### FUNCTION g_memdup ##### --> <para> Allocates @byte_size bytes of memory, and copies @byte_size bytes into it diff --git a/docs/reference/glib/tmpl/modules.sgml b/docs/reference/glib/tmpl/modules.sgml index 33d268312..c47df3593 100644 --- a/docs/reference/glib/tmpl/modules.sgml +++ b/docs/reference/glib/tmpl/modules.sgml @@ -99,3 +99,186 @@ just_say_hello (const char *filename, GError **error) <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### STRUCT GModule ##### --> +<para> +The #GModule struct is an opaque data structure to represent a +<link linkend="glib-Dynamic-Loading-of-Modules">Dynamically-Loaded Module</link>. +It should only be accessed via the following functions. +</para> + + +<!-- ##### FUNCTION g_module_supported ##### --> +<para> +Checks if modules are supported on the current platform. +</para> + +@Returns: %TRUE if modules are supported. + + +<!-- ##### FUNCTION g_module_build_path ##### --> +<para> +A portable way to build the filename of a module. The platform-specific +prefix and suffix are added to the filename, if needed, and the result is +added to the directory, using the correct separator character. +</para> +<para> +The directory should specify the directory where the module can be found. +It can be %NULL or an empty string to indicate that the module is in a standard +platform-specific directory, though this is not recommended since the +wrong module may be found. +</para> +<para> +For example, calling g_module_build_path() on a Linux system with a @directory +of <filename>/lib</filename> and a @module_name of "mylibrary" will return +<filename>/lib/libmylibrary.so</filename>. On a Windows system, using +<filename>\Windows</filename> as the directory it will return +<filename>\Windows\mylibrary.dll</filename>. +</para> + +@directory: the directory where the module is. This can be %NULL or the empty +string to indicate that the standard platform-specific directories will be +used, though that is not recommended. +@module_name: the name of the module. +@Returns: the complete path of the module, including the standard library +prefix and suffix. This should be freed when no longer needed. + + +<!-- ##### FUNCTION g_module_open ##### --> +<para> +Opens a module. If the module has already been opened, its reference +count is incremented. +</para> + +<para> +First of all g_module_open() tries to open @file_name as a module. If +that fails and @file_name has the ".la"-suffix (and is a libtool archive) +it tries to open the corresponding module. If that fails and it doesn't +have the proper module suffix for the platform (#G_MODULE_SUFFIX), this +suffix will be appended and the corresponding module will be opended. If +that fails and @file_name doesn't have the ".la"-suffix, this suffix is +appended and g_module_open() tries to open the corresponding module. If +eventually that fails as well, %NULL is returned. +</para> + +@file_name: the name of the file containing the module, or %NULL to obtain + a #GModule representing the main program itself. +@flags: the flags used for opening the module. This can be the logical +OR of any of the #GModuleFlags. +@Returns: a #GModule on success, or %NULL on failure. + + +<!-- ##### ENUM GModuleFlags ##### --> +<para> +Flags passed to g_module_open(). Note that these flags are +not supported on all platforms. +</para> + +@G_MODULE_BIND_LAZY: specifies that symbols are only resolved when needed. + The default action is to bind all symbols when the module is loaded. +@G_MODULE_BIND_LOCAL: specifies that symbols in the module should + not be added to the global name space. The default action on most + platforms is to place symbols in the module in the global name space, + which may cause conflicts with existing symbols. +@G_MODULE_BIND_MASK: mask for all flags. + +<!-- ##### FUNCTION g_module_symbol ##### --> +<para> +Gets a symbol pointer from a module, such as one exported by #G_MODULE_EXPORT. +</para> +<para> +Note that a valid symbol can be %NULL. +</para> + +@module: a #GModule. +@symbol_name: the name of the symbol to find. +@symbol: returns the pointer to the symbol value. +@Returns: %TRUE on success. + + +<!-- ##### FUNCTION g_module_name ##### --> +<para> +Gets the filename from a #GModule. +</para> + +@module: a #GModule. +@Returns: the filename of the module, or "main" if the module is the main +program itself. + + +<!-- ##### FUNCTION g_module_make_resident ##### --> +<para> +Ensures that a module will never be unloaded. +Any future g_module_close() calls on the module will be ignored. +</para> + +@module: a #GModule to make permanently resident. + + +<!-- ##### FUNCTION g_module_close ##### --> +<para> +Closes a module. +</para> + +@module: a #GModule to close. +@Returns: %TRUE on success. + + +<!-- ##### FUNCTION g_module_error ##### --> +<para> +Gets a string describing the last module error. +</para> + +@Returns: a string describing the last module error. + + +<!-- ##### USER_FUNCTION GModuleCheckInit ##### --> +<para> +Specifies the type of the module initialization function. +<indexterm zone="g-module-check-init"><primary>g_module_check_init</primary></indexterm> +If a module contains a function named g_module_check_init() it is called +automatically when the module is loaded. It is passed the #GModule structure +and should return %NULL on success or a string describing the initialization +error. +</para> + +@module: the #GModule corresponding to the module which has just been loaded. +@Returns: %NULL on success, or a string describing the initialization error. + + +<!-- ##### USER_FUNCTION GModuleUnload ##### --> +<para> +<indexterm zone="g-module-unload"><primary>g_module_unload</primary></indexterm> +Specifies the type of the module function called when it is unloaded. +If a module contains a function named g_module_unload() it is called +automatically when the module is unloaded. +It is passed the #GModule structure. +</para> + +@module: the #GModule about to be unloaded. + + +<!-- ##### MACRO G_MODULE_SUFFIX ##### --> +<para> +Expands to the proper shared library suffix for the current platform +without the leading dot. For the most Unices and Linux this is "so", +for some HP-UX versions this is "sl" and for Windows this is "dll". +</para> + + + +<!-- ##### MACRO G_MODULE_EXPORT ##### --> +<para> +Used to declare functions exported by modules. This is a no-op on Linux and +Unices, but when compiling for Windows, it marks a symbol to be exported from +the library or executable being built. +</para> + + + +<!-- ##### MACRO G_MODULE_IMPORT ##### --> +<para> +Used to declare functions imported from modules. +</para> + + + diff --git a/docs/reference/glib/tmpl/threads.sgml b/docs/reference/glib/tmpl/threads.sgml index 25b59ba3d..9cff5f61d 100644 --- a/docs/reference/glib/tmpl/threads.sgml +++ b/docs/reference/glib/tmpl/threads.sgml @@ -89,6 +89,19 @@ common problems. To use error-checking mutexes, define the symbol <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### MACRO G_THREADS_ENABLED ##### --> + +<para> +This macro is defined if GLib was compiled with thread support. This +does not necessarily mean that there is a thread implementation +available, but it does mean that the infrastructure is in place and +that once you provide a thread implementation to g_thread_init(), GLib +will be multi-thread safe. If #G_THREADS_ENABLED is not defined, then +Glib is not, and cannot be, multi-thread safe. +</para> + + + <!-- ##### MACRO G_THREADS_IMPL_POSIX ##### --> <para> diff --git a/docs/reference/glib/tmpl/type_conversion.sgml b/docs/reference/glib/tmpl/type_conversion.sgml index e4ba44f35..0d1d94b37 100644 --- a/docs/reference/glib/tmpl/type_conversion.sgml +++ b/docs/reference/glib/tmpl/type_conversion.sgml @@ -57,6 +57,52 @@ integer; values outside the range of a 32-bit integer will be mangled. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### MACRO GINT_TO_POINTER ##### --> +<para> +Stuffs an integer into a pointer type. +</para> +<para> +Remember, YOU MAY NOT STORE POINTERS IN INTEGERS. THIS IS NOT PORTABLE +IN ANY WAY SHAPE OR FORM. These macros <emphasis>ONLY</emphasis> allow +storing integers in pointers, and only preserve 32 bits of the +integer; values outside the range of a 32-bit integer will be mangled. +</para> + +@i: integer to stuff into a pointer. + + +<!-- ##### MACRO GPOINTER_TO_INT ##### --> +<para> +Extracts an integer from a pointer. The integer must have +been stored in the pointer with GINT_TO_POINTER(). +</para> +<para> +Remember, YOU MAY NOT STORE POINTERS IN INTEGERS. THIS IS NOT PORTABLE +IN ANY WAY SHAPE OR FORM. These macros <emphasis>ONLY</emphasis> allow +storing integers in pointers, and only preserve 32 bits of the +integer; values outside the range of a 32-bit integer will be mangled. +</para> + +@p: pointer containing an integer. + + +<!-- ##### MACRO GUINT_TO_POINTER ##### --> +<para> +Stuffs an unsigned integer into a pointer type. +</para> + +@u: unsigned integer to stuff into the pointer. + + +<!-- ##### MACRO GPOINTER_TO_UINT ##### --> +<para> +Extracts an unsigned integer from a pointer. The integer must have +been stored in the pointer with GUINT_TO_POINTER(). +</para> + +@p: pointer to extract an unsigned integer from. + + <!-- ##### MACRO GSIZE_TO_POINTER ##### --> <para> Stuffs a #gsize into a pointer type. diff --git a/docs/reference/glib/tmpl/types.sgml b/docs/reference/glib/tmpl/types.sgml index ec2512e43..4c3b77883 100644 --- a/docs/reference/glib/tmpl/types.sgml +++ b/docs/reference/glib/tmpl/types.sgml @@ -119,6 +119,66 @@ Values of this type can range from 0 to #G_MAXULONG. </para> +<!-- ##### TYPEDEF gint8 ##### --> +<para> +A signed integer guaranteed to be 8 bits on all platforms. +Values of this type can range from -128 to 127. +</para> + + +<!-- ##### TYPEDEF guint8 ##### --> +<para> +An unsigned integer guaranteed to be 8 bits on all platforms. +Values of this type can range from 0 to 255. +</para> + + +<!-- ##### TYPEDEF gint16 ##### --> +<para> +A signed integer guaranteed to be 16 bits on all platforms. +Values of this type can range from -32,768 to 32,767. +</para> + + +<!-- ##### TYPEDEF guint16 ##### --> +<para> +An unsigned integer guaranteed to be 16 bits on all platforms. +Values of this type can range from 0 to 65,535. +</para> + + +<!-- ##### TYPEDEF gint32 ##### --> +<para> +A signed integer guaranteed to be 32 bits on all platforms. +Values of this type can range from -2,147,483,648 to 2,147,483,647. +</para> + + +<!-- ##### TYPEDEF guint32 ##### --> +<para> +An unsigned integer guaranteed to be 32 bits on all platforms. +Values of this type can range from 0 to 4,294,967,295. +</para> + + +<!-- ##### MACRO G_HAVE_GINT64 ##### --> +<para> +This macro is defined if 64-bit signed and unsigned integers are available +on the platform. +</para> + +@Deprecated: GLib requires 64-bit integer support since version 2.0, therefore +%G_HAVE_GINT64 is <emphasis>always</emphasis> defined. + + +<!-- ##### TYPEDEF gint64 ##### --> +<para> +A signed integer guaranteed to be 64 bits on all platforms. +Values of this type can range from -9,223,372,036,854,775,808 to +9,223,372,036,854,775,807. +</para> + + <!-- ##### FUNCTION guint64 ##### --> <para> An unsigned integer guaranteed to be 64 bits on all platforms. @@ -128,6 +188,24 @@ Values of this type can range from 0 to 18,446,744,073,709,551,615. @Returns: +<!-- ##### MACRO G_GINT64_CONSTANT ##### --> +<para> +This macro is used to insert 64-bit integer literals into the source code. +</para> + +@val: a literal integer value, e.g. 0x1d636b02300a7aa7U. + + +<!-- ##### MACRO G_GUINT64_CONSTANT ##### --> +<para> +This macro is used to insert 64-bit unsigned integer literals into the +source code. +</para> + +@val: a literal integer value, e.g. 0x1d636b02300a7aa7U. +@Since: 2.10 + + <!-- ##### TYPEDEF gfloat ##### --> <para> Corresponds to the standard C <type>float</type> type. @@ -142,3 +220,27 @@ Values of this type can range from -#G_MAXDOUBLE to #G_MAXDOUBLE. </para> +<!-- ##### TYPEDEF gsize ##### --> +<para> +An unsigned integer type of the result of the sizeof operator, corresponding +to the size_t type defined in C99. This type is wide enough to hold the numeric +value of a pointer, so it is usually 32bit wide on a 32bit platform and +64bit wide on a 64bit platform. +</para> + + +<!-- ##### TYPEDEF gssize ##### --> +<para> +A signed variant of gsize, corresponding to the ssize_t defined on most platforms. +</para> + + +<!-- ##### TYPEDEF goffset ##### --> +<para> +A signed integer type that is used for file offsets, corresponding to the +C99 type off64_t. +</para> + +Since: 2.14 + + diff --git a/docs/reference/glib/tmpl/version.sgml b/docs/reference/glib/tmpl/version.sgml index 11b0d2e66..f46c1e1a5 100644 --- a/docs/reference/glib/tmpl/version.sgml +++ b/docs/reference/glib/tmpl/version.sgml @@ -87,6 +87,36 @@ about it. ;-) @Returns: +<!-- ##### MACRO GLIB_MAJOR_VERSION ##### --> +<para> +The major version number of the GLib library. +Like #glib_major_version, but from the headers used at +application compile time, rather than from the library linked against +at application run time. +</para> + + + +<!-- ##### MACRO GLIB_MINOR_VERSION ##### --> +<para> +The minor version number of the GLib library. +Like #gtk_minor_version, but from the headers used at +application compile time, rather than from the library linked against +at application run time. +</para> + + + +<!-- ##### MACRO GLIB_MICRO_VERSION ##### --> +<para> +The micro version number of the GLib library. +Like #gtk_micro_version, but from the headers used at +application compile time, rather than from the library linked against +at application run time. +</para> + + + <!-- ##### MACRO GLIB_CHECK_VERSION ##### --> <para> Checks the version of the GLib library. diff --git a/docs/reference/gobject/gobject-docs.sgml b/docs/reference/gobject/gobject-docs.sgml index 5ec9978af..a37b26257 100644 --- a/docs/reference/gobject/gobject-docs.sgml +++ b/docs/reference/gobject/gobject-docs.sgml @@ -149,7 +149,7 @@ <title>Index of new symbols in 2.14</title> </index> <index role="2.18"> - <title>Index of new symbols in 2.14</title> + <title>Index of new symbols in 2.18</title> </index> </book> |