glib

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2026 License: MIT Imports: 8 Imported by: 4

Documentation

Overview

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Package glib was automatically generated by github.com/bnema/puregotk DO NOT EDIT

Index

Constants

View Source 
const (
	ALLOCATOR_LIST int = 1

	ALLOCATOR_NODE int = 3

	ALLOCATOR_SLIST int = 2

	ALLOC_AND_FREE int = 2

	ALLOC_ONLY int = 1
)
View Source 
const (
	// Represents an invalid #GDateDay.
	DATE_BAD_DAY int = 0
	// Represents an invalid Julian day number.
	DATE_BAD_JULIAN int = 0
	// Represents an invalid year.
	DATE_BAD_YEAR int = 0
)
View Source 
const (
	// Evaluates to a time span of one day.
	TIME_SPAN_DAY int64 = 86400000000
	// Evaluates to a time span of one hour.
	TIME_SPAN_HOUR int64 = 3600000000
	// Evaluates to a time span of one millisecond.
	TIME_SPAN_MILLISECOND int64 = 1000
	// Evaluates to a time span of one minute.
	TIME_SPAN_MINUTE int64 = 60000000
	// Evaluates to a time span of one second.
	TIME_SPAN_SECOND int64 = 1000000
)
View Source 
const (
	// The name of the main group of a desktop entry file, as defined in the
	// [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/).
	//
	// Consult the specification for more
	// details about the meanings of the keys below.
	KEY_FILE_DESKTOP_GROUP string = "Desktop Entry"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string list
	// giving the available application actions.
	KEY_FILE_DESKTOP_KEY_ACTIONS string = "Actions"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list
	// of strings giving the categories in which the desktop entry
	// should be shown in a menu.
	KEY_FILE_DESKTOP_KEY_CATEGORIES string = "Categories"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized
	// string giving the tooltip for the desktop entry.
	KEY_FILE_DESKTOP_KEY_COMMENT string = "Comment"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean
	// set to true if the application is D-Bus activatable.
	KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE string = "DBusActivatable"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string
	// giving the command line to execute.
	//
	// It is only valid for desktop entries with the `Application` type.
	KEY_FILE_DESKTOP_KEY_EXEC string = "Exec"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized
	// string giving the generic name of the desktop entry.
	KEY_FILE_DESKTOP_KEY_GENERIC_NAME string = "GenericName"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean
	// stating whether the desktop entry has been deleted by the user.
	KEY_FILE_DESKTOP_KEY_HIDDEN string = "Hidden"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized
	// string giving the name of the icon to be displayed for the desktop
	// entry.
	KEY_FILE_DESKTOP_KEY_ICON string = "Icon"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list
	// of strings giving the MIME types supported by this desktop entry.
	KEY_FILE_DESKTOP_KEY_MIME_TYPE string = "MimeType"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a localized
	// string giving the specific name of the desktop entry.
	KEY_FILE_DESKTOP_KEY_NAME string = "Name"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list of
	// strings identifying the environments that should not display the
	// desktop entry.
	KEY_FILE_DESKTOP_KEY_NOT_SHOW_IN string = "NotShowIn"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean
	// stating whether the desktop entry should be shown in menus.
	KEY_FILE_DESKTOP_KEY_NO_DISPLAY string = "NoDisplay"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a list of
	// strings identifying the environments that should display the
	// desktop entry.
	KEY_FILE_DESKTOP_KEY_ONLY_SHOW_IN string = "OnlyShowIn"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string
	// containing the working directory to run the program in.
	//
	// It is only valid for desktop entries with the `Application` type.
	KEY_FILE_DESKTOP_KEY_PATH string = "Path"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean
	// stating whether the application supports the
	// [Startup Notification Protocol Specification](https://specifications.freedesktop.org/startup-notification-spec/latest/).
	KEY_FILE_DESKTOP_KEY_STARTUP_NOTIFY string = "StartupNotify"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is string
	// identifying the WM class or name hint of a window that the application
	// will create, which can be used to emulate
	// [Startup Notification](https://specifications.freedesktop.org/startup-notification-spec/latest/)
	// with older applications.
	KEY_FILE_DESKTOP_KEY_STARTUP_WM_CLASS string = "StartupWMClass"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a boolean
	// stating whether the program should be run in a terminal window.
	//
	// It is only valid for desktop entries with the `Application` type.
	KEY_FILE_DESKTOP_KEY_TERMINAL string = "Terminal"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string
	// giving the file name of a binary on disk used to determine if the
	// program is actually installed.
	//
	// It is only valid for desktop entries with the `Application` type.
	KEY_FILE_DESKTOP_KEY_TRY_EXEC string = "TryExec"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string
	// giving the type of the desktop entry.
	//
	// Usually [const@GLib.KEY_FILE_DESKTOP_TYPE_APPLICATION],
	// [const@GLib.KEY_FILE_DESKTOP_TYPE_LINK], or
	// [const@GLib.KEY_FILE_DESKTOP_TYPE_DIRECTORY].
	KEY_FILE_DESKTOP_KEY_TYPE string = "Type"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string
	// giving the URL to access.
	//
	// It is only valid for desktop entries with the `Link` type.
	KEY_FILE_DESKTOP_KEY_URL string = "URL"
	// A key under [const@GLib.KEY_FILE_DESKTOP_GROUP], whose value is a string
	// giving the version of the Desktop Entry Specification used for
	// the desktop entry file.
	KEY_FILE_DESKTOP_KEY_VERSION string = "Version"
	// The value of the [const@GLib.KEY_FILE_DESKTOP_KEY_TYPE], key for desktop
	// entries representing applications.
	KEY_FILE_DESKTOP_TYPE_APPLICATION string = "Application"
	// The value of the [const@GLib.KEY_FILE_DESKTOP_KEY_TYPE], key for desktop
	// entries representing directories.
	KEY_FILE_DESKTOP_TYPE_DIRECTORY string = "Directory"
	// The value of the [const@GLib.KEY_FILE_DESKTOP_KEY_TYPE], key for desktop
	// entries representing links to documents.
	KEY_FILE_DESKTOP_TYPE_LINK string = "Link"
)
View Source 
const (
	// The directory separator character.
	//
	// This is `'/'` on UNIX machines and `'\'` under Windows.
	DIR_SEPARATOR int = 47
	// The directory separator as a string.
	//
	// This is `"/"` on UNIX machines and `"\"` under Windows.
	DIR_SEPARATOR_S string = "/"

	GINT16_FORMAT string = "hi"

	GINT16_MODIFIER string = "h"

	GINT32_FORMAT string = "i"

	GINT32_MODIFIER string = ""

	GINT64_FORMAT string = "li"

	GINT64_MODIFIER string = "l"

	GINTPTR_FORMAT string = "li"

	GINTPTR_MODIFIER string = "l"

	GSIZE_FORMAT string = "lu"

	GSIZE_MODIFIER string = "l"

	GSSIZE_FORMAT string = "li"

	GSSIZE_MODIFIER string = "l"

	GUINT16_FORMAT string = "hu"

	GUINT32_FORMAT string = "u"

	GUINT64_FORMAT string = "lu"

	GUINTPTR_FORMAT string = "lu"

	HAVE_GINT64 int = 1

	HAVE_GNUC_VARARGS int = 1

	HAVE_GROWING_STACK int = 0

	HAVE_ISO_VARARGS int = 1
	// 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.
	MAJOR_VERSION int = 2
	// 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.
	MICRO_VERSION int = 0
	// 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.
	MINOR_VERSION int = 88

	MODULE_SUFFIX string = "so"
	// A format specifier that can be used in printf()-style format strings
	// when printing a #GPid.
	PID_FORMAT string = "i"
	// A format specifier that can be used in printf()-style format strings
	// when printing the @fd member of a #GPollFD.
	POLLFD_FORMAT string = "%d"
	// The search path separator character.
	// This is ':' on UNIX machines and ';' under Windows.
	SEARCHPATH_SEPARATOR int = 58
	// The search path separator as a string.
	// This is ":" on UNIX machines and ";" under Windows.
	SEARCHPATH_SEPARATOR_S string = ":"

	SIZEOF_LONG int = 8

	SIZEOF_SIZE_T int = 8

	SIZEOF_SSIZE_T int = 8

	SIZEOF_VOID_P int = 8

	SYSDEF_AF_INET int = 2

	SYSDEF_AF_INET6 int = 10

	SYSDEF_AF_UNIX int = 1

	SYSDEF_MSG_DONTROUTE int = 4

	SYSDEF_MSG_OOB int = 1

	SYSDEF_MSG_PEEK int = 2

	VA_COPY_AS_ARRAY int = 1
)
View Source 
const (
	ANALYZER_ANALYZING int = 1
	// The C standard version the code is compiling against, it's normally
	// defined with the same value of `__STDC_VERSION__` for C standard
	// compatible compilers, while it uses the lowest standard version
	// in pure MSVC, given that in such compiler the definition depends on
	// a compilation flag.
	//
	// This is granted to be undefined when compiling with a C++ compiler.
	//
	// See also: %G_C_STD_CHECK_VERSION and %G_CXX_STD_VERSION
	C_STD_VERSION int = 199000
	// Expands to "" on all modern compilers, and to  __FUNCTION__ on gcc
	// version 2.x. Don't use it.
	GNUC_FUNCTION string = ""
	// Expands to "" on all modern compilers, and to __PRETTY_FUNCTION__
	// on gcc version 2.x. Don't use it.
	GNUC_PRETTY_FUNCTION string = ""
	// Defined to 1 if gcc-style visibility handling is supported.
	HAVE_GNUC_VISIBILITY int = 1
)
View Source 
const (
	// Use this for default priority event sources.
	//
	// In GLib this priority is used when adding timeout functions
	// with [func@GLib.timeout_add]. In GDK this priority is used for events
	// from the X server.
	PRIORITY_DEFAULT int = 0
	// Use this for default priority idle functions.
	//
	// In GLib this priority is used when adding idle functions with
	// [func@GLib.idle_add].
	PRIORITY_DEFAULT_IDLE int = 200
	// Use this for high priority event sources.
	//
	// It is not used within GLib or GTK.
	PRIORITY_HIGH int = -100
	// Use this for high priority idle functions.
	//
	// GTK uses %G_PRIORITY_HIGH_IDLE + 10 for resizing operations,
	// and %G_PRIORITY_HIGH_IDLE + 20 for redrawing operations. (This is
	// done to ensure that any pending resizes are processed before any
	// pending redraws, so that widgets are not redrawn twice unnecessarily.)
	PRIORITY_HIGH_IDLE int = 100
	// Use this for very low priority background tasks.
	//
	// It is not used within GLib or GTK.
	PRIORITY_LOW int = 300
	// Use this macro as the return value of a [callback@GLib.SourceFunc] to leave
	// the [struct@GLib.Source] in the main loop.
	SOURCE_CONTINUE bool = true
	// Use this macro as the return value of a [callback@GLib.SourceFunc] to remove
	// the [struct@GLib.Source] from the main loop.
	SOURCE_REMOVE bool = false
)
View Source 
const (
	// Defines the log domain. See [Log Domains](#log-domains).
	//
	// Libraries should define this so that any messages
	// which they log can be differentiated from messages from other
	// libraries and application code. But be careful not to define
	// it in any public header files.
	//
	// Log domains must be unique, and it is recommended that they are the
	// application or library name, optionally followed by a hyphen and a sub-domain
	// name. For example, `bloatpad` or `bloatpad-io`.
	//
	// If undefined, it defaults to the default %NULL (or `""`) log domain; this is
	// not advisable, as it cannot be filtered against using the `G_MESSAGES_DEBUG`
	// environment variable.
	//
	// For example, GTK uses this in its `Makefile.am`:
	// |[
	// AM_CPPFLAGS = -DG_LOG_DOMAIN=\"Gtk\"
	// ]|
	//
	// Applications can choose to leave it as the default %NULL (or `""`)
	// domain. However, defining the domain offers the same advantages as
	// above.
	LOG_DOMAIN byte = 0
	// GLib log levels that are considered fatal by default.
	//
	// This is not used if structured logging is enabled; see
	// [Using Structured Logging](logging.html#using-structured-logging).
	LOG_FATAL_MASK int = 5
	// Log levels below `1<<G_LOG_LEVEL_USER_SHIFT` are used by GLib.
	// Higher bits can be used for user-defined log levels.
	LOG_LEVEL_USER_SHIFT int = 8
)
View Source 
const (
	// Evaluates to the initial reference count for `gatomicrefcount`.
	//
	// This macro is useful for initializing `gatomicrefcount` fields inside
	// structures, for instance:
	//
	// |[<!-- language="C" -->
	// typedef struct {
	//   gatomicrefcount ref_count;
	//   char *name;
	//   char *address;
	// } Person;
	//
	// static const Person default_person = {
	//   .ref_count = G_ATOMIC_REF_COUNT_INIT,
	//   .name = "Default name",
	//   .address = "Default address",
	// };
	// ]|
	ATOMIC_REF_COUNT_INIT int = 1
	// Evaluates to the initial reference count for `grefcount`.
	//
	// This macro is useful for initializing `grefcount` fields inside
	// structures, for instance:
	//
	// |[<!-- language="C" -->
	// typedef struct {
	//   grefcount ref_count;
	//   char *name;
	//   char *address;
	// } Person;
	//
	// static const Person default_person = {
	//   .ref_count = G_REF_COUNT_INIT,
	//   .name = "Default name",
	//   .address = "Default address",
	// };
	// ]|
	REF_COUNT_INIT int = -1
)
View Source 
const (
	// The set of uppercase ASCII alphabet characters.
	// Used for specifying valid identifier characters
	// in #GScannerConfig.
	CSET_A_2_Z string = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
	// The set of ASCII digits.
	// Used for specifying valid identifier characters
	// in #GScannerConfig.
	CSET_DIGITS string = "0123456789"
	// The set of lowercase ASCII alphabet characters.
	// Used for specifying valid identifier characters
	// in #GScannerConfig.
	CSET_a_2_z string = "abcdefghijklmnopqrstuvwxyz"
)
View Source 
const (
	// A good size for a buffer to be passed into [func@GLib.ascii_dtostr].
	// It is guaranteed to be enough for all output of that function
	// on systems with 64bit IEEE-compatible doubles.
	//
	// The typical usage would be something like:
	// “`C
	// char buf[G_ASCII_DTOSTR_BUF_SIZE];
	//
	// fprintf (out, "value=%s\n", g_ascii_dtostr (buf, sizeof (buf), value));
	// “`
	ASCII_DTOSTR_BUF_SIZE int = 39
	// The standard delimiters, used in [func@GLib.strdelimit].
	STR_DELIMITERS string = "_-|> <."
)
View Source 
const (
	// A value that can be passed as an option to [func@GLib.test_init].
	//
	// Creates a unique temporary directory for each unit test and uses sets
	// XDG directories to point into subdirectories of it for the duration of
	// the unit test. The directory tree is cleaned up after the test finishes
	// successfully.
	//
	// Note that this doesn’t take effect until [func@GLib.test_run] is called,
	// so calls to (for example) [func@GLib.get_home_dir] will return the
	// system-wide value when made in a test program’s main() function.
	//
	// The following functions will return subdirectories of the temporary directory
	// when this option is used. The specific subdirectory paths in use are not
	// guaranteed to be stable API — always use a getter function to retrieve them.
	//
	//  - [func@GLib.get_home_dir]
	//  - [func@GLib.get_user_cache_dir]
	//  - [func@GLib.get_system_config_dirs]
	//  - [func@GLib.get_user_config_dir]
	//  - [func@GLib.get_system_data_dirs]
	//  - [func@GLib.get_user_data_dir]
	//  - [func@GLib.get_user_state_dir]
	//  - [func@GLib.get_user_runtime_dir]
	//
	// The subdirectories may not be created by the test harness; as with normal
	// calls to functions like [func@GLib.get_user_cache_dir], the caller must
	// be prepared to create the directory if it doesn’t exist.
	TEST_OPTION_ISOLATE_DIRS string = "isolate_dirs"
	// A value that can be passed as an option to [func@GLib.test_init].
	//
	// If this option is given, assertions will not abort the process, but
	// call [func@GLib.test_fail]. Equivalent to [func@GLib.test_set_nonfatal_assertions].
	TEST_OPTION_NONFATAL_ASSERTIONS string = "nonfatal-assertions"
	// A value that can be passed as an option to [func@GLib.test_init].
	//
	// If this option is given, [func@GLib.test_init] will not call [func@GLib.set_prgname].
	TEST_OPTION_NO_PRGNAME string = "no_g_set_prgname"
)
View Source 
const (
	// Number of nanoseconds in one second (1 billion).
	// This macro is provided for code readability.
	NSEC_PER_SEC uint64 = 1000000000
	// Number of microseconds in one second (1 million).
	// This macro is provided for code readability.
	USEC_PER_SEC int = 1000000
)
View Source 
const (
	// Specifies one of the possible types of byte order.
	// See %G_BYTE_ORDER.
	BIG_ENDIAN int = 4321
	// The base of natural logarithms.
	E float64 = 2.718282
	// The bias by which exponents in double-precision floats are offset.
	IEEE754_DOUBLE_BIAS int = 1023
	// The bias by which exponents in single-precision floats are offset.
	IEEE754_FLOAT_BIAS int = 127
	// Specifies one of the possible types of byte order.
	// See %G_BYTE_ORDER.
	LITTLE_ENDIAN int = 1234
	// The natural logarithm of 10.
	LN10 float64 = 2.302585
	// The natural logarithm of 2.
	LN2 float64 = 0.693147
	// Multiplying the base 2 exponent by this number yields the base 10 exponent.
	LOG_2_BASE_10 float64 = 0.301030

	MAXINT16 int16 = 32767

	MAXINT32 int32 = 2147483647

	MAXINT64 int64 = 9223372036854775807

	MAXINT8 int8 = 127

	MAXUINT16 uint16 = 65535

	MAXUINT32 uint32 = 4294967295

	MAXUINT64 uint64 = 18446744073709551615

	MAXUINT8 byte = 255
	// The minimum value which can be held in a #gint16.
	MININT16 int16 = -32768
	// The minimum value which can be held in a #gint32.
	MININT32 int32 = -2147483648
	// The minimum value which can be held in a #gint64.
	MININT64 int64 = -9223372036854775808
	// The minimum value which can be held in a #gint8.
	MININT8 int8 = -128
	// Specifies one of the possible types of byte order
	// (currently unused). See %G_BYTE_ORDER.
	PDP_ENDIAN int = 3412
	// The value of pi (ratio of circle's circumference to its diameter).
	PI float64 = 3.141593
	// Pi divided by 2.
	PI_2 float64 = 1.570796
	// Pi divided by 4.
	PI_4 float64 = 0.785398
	// The square root of two.
	SQRT2 float64 = 1.414214
)
View Source 
const (
	// Generic delimiters characters as defined in
	// [RFC 3986](https://tools.ietf.org/html/rfc3986). Includes `:/?#[]@`.
	URI_RESERVED_CHARS_GENERIC_DELIMITERS string = ":/?#[]@"
	// Subcomponent delimiter characters as defined in
	// [RFC 3986](https://tools.ietf.org/html/rfc3986). Includes `!$&amp;'()*+,;=`.
	URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS string = "!$&'()*+,;="
)
View Source 
const (
	// A bitmask that restricts the possible flags passed to
	// g_datalist_set_flags(). Passing a flags value where
	// flags &amp; ~G_DATALIST_FLAGS_MASK != 0 is an error.
	DATALIST_FLAGS_MASK int = 3
)
View Source 
const (
	// The position of the first bit which is not reserved for internal
	// use be the #GHook implementation, i.e.
	// `1 &lt;&lt; G_HOOK_FLAG_USER_SHIFT` is the first
	// bit which can be used for application-defined flags.
	HOOK_FLAG_USER_SHIFT int = 4
)
View Source 
const (
	// If a long option in the main group has this name, it is not treated as a
	// regular option. Instead it collects all non-option arguments which would
	// otherwise be left in `argv`. The option must be of type
	// %G_OPTION_ARG_CALLBACK, %G_OPTION_ARG_STRING_ARRAY
	// or %G_OPTION_ARG_FILENAME_ARRAY.
	//
	//
	// Using %G_OPTION_REMAINING instead of simply scanning `argv`
	// for leftover arguments has the advantage that GOption takes care of
	// necessary encoding conversions for strings or filenames.
	OPTION_REMAINING string = ""
)
View Source 
const (
	// The maximum length (in codepoints) of a compatibility or canonical
	// decomposition of a single Unicode character.
	//
	// This is as defined by Unicode 6.1.
	UNICHAR_MAX_DECOMPOSITION_LENGTH int = 18
)
View Source 
const (
	// A macro that should be defined by the user prior to including
	// the glib.h header.
	// The definition should be one of the predefined GLib version
	// macros: %GLIB_VERSION_2_26, %GLIB_VERSION_2_28,...
	//
	// This macro defines the earliest version of GLib that the package is
	// required to be able to compile against.
	//
	// If the compiler is configured to warn about the use of deprecated
	// functions, then using functions that were deprecated in version
	// %GLIB_VERSION_MIN_REQUIRED or earlier will cause warnings (but
	// using functions deprecated in later releases will not).
	VERSION_MIN_REQUIRED int = 2
)
View Source 
const (
	WIN32_MSG_HANDLE int = 19981206
)

Variables

This section is empty.

Functions

func Access 

func Access(FilenameVar string, ModeVar int) int

A wrapper for the POSIX access() function. This function is used to test a pathname for one or several of read, write or execute permissions, or just existence.

On Windows, the file protection mechanism is not at all POSIX-like, and the underlying function in the C library only checks the FAT-style READONLY attribute, and does not look at the ACL of a file at all. This function is this in practise almost useless on Windows. Software that needs to handle file permissions on Windows more exactly should use the Win32 API.

See your C library manual for more details about access().

func AlignedAlloc 

func AlignedAlloc(NBlocksVar uint, NBlockBytesVar uint, AlignmentVar uint) uintptr

This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to align the allocated memory to with the given alignment value. Additionally, it will detect possible overflow during multiplication.

If the allocation fails (because the system is out of memory), the program is terminated.

Aligned memory allocations returned by this function can only be freed using g_aligned_free_sized() or g_aligned_free().

func AlignedAlloc0 

func AlignedAlloc0(NBlocksVar uint, NBlockBytesVar uint, AlignmentVar uint) uintptr

This function is similar to g_aligned_alloc(), but it will also clear the allocated memory before returning it.

func AlignedFree 

func AlignedFree(MemVar uintptr)

Frees the memory allocated by g_aligned_alloc().

func AlignedFreeSized 

func AlignedFreeSized(MemVar uintptr, AlignmentVar uint, SizeVar uint)

Frees the memory pointed to by @mem, assuming it is has the given @size and @alignment.

If @mem is %NULL this is a no-op (and @size is ignored).

It is an error if @size doesn’t match the size, or @alignment doesn’t match the alignment, passed when @mem was allocated. @size and @alignment are passed to this function to allow optimizations in the allocator. If you don’t know either of them, use g_aligned_free() instead.

func ArrayGLibType 

func ArrayGLibType() types.GType

func ArrayNewTake 

func ArrayNewTake(DataVar uintptr, LenVar uint, ClearVar bool, ElementSizeVar uint) uintptr

Creates a new `GArray` with @data as array data, @len as length and a reference count of 1.

This avoids having to copy the data manually, when it can just be inherited. After this call, @data belongs to the `GArray` and may no longer be modified by the caller. The memory of @data has to be dynamically allocated and will eventually be freed with [func@GLib.free].

In case the elements need to be cleared when the array is freed, use [func@GLib.Array.set_clear_func] to set a [callback@GLib.DestroyNotify] function to perform such task.

Do not use it if @len or @element_size are greater than 

[`G_MAXUINT`](types.html#guint). `GArray` stores the length of its data in
`guint`, which may be shorter than `gsize`.

func ArrayNewTakeZeroTerminated 

func ArrayNewTakeZeroTerminated(DataVar uintptr, ClearVar bool, ElementSizeVar uint) uintptr

Creates a new `GArray` with @data as array data, computing the length of it and setting the reference count to 1.

This avoids having to copy the data manually, when it can just be inherited. After this call, @data belongs to the `GArray` and may no longer be modified by the caller. The memory of @data has to be dynamically allocated and will eventually be freed with [func@GLib.free].

The length is calculated by iterating through @data until the first `NULL` element is found.

In case the elements need to be cleared when the array is freed, use [func@GLib.Array.set_clear_func] to set a [callback@GLib.DestroyNotify] function to perform such task.

Do not use it if @data length or @element_size are greater than [`G_MAXUINT`](types.html#guint). `GArray` stores the length of its data in `guint`, which may be shorter than `gsize`.

func AsciiDigitValue 

func AsciiDigitValue(CVar byte) int

Determines the numeric value of a character as a decimal digit. If the character is not a decimal digit according to [func@GLib.ascii_isdigit], `-1` is returned.

Differs from [func@GLib.unichar_digit_value] because it takes a char, so there's no worry about sign extension if characters are signed.

func AsciiDtostr 

func AsciiDtostr(BufferVar string, BufLenVar int, DVar float64) string

Converts a `gdouble` to a string, using the '.' as decimal point.

This function generates enough precision that converting the string back using [func@GLib.ascii_strtod] gives the same machine-number (on machines with IEEE compatible 64bit doubles). It is guaranteed that the size of the resulting string will never be larger than [const@GLib.ASCII_DTOSTR_BUF_SIZE] bytes, including the terminating nul character, which is always added.

func AsciiFormatd 

func AsciiFormatd(BufferVar string, BufLenVar int, FormatVar string, DVar float64) string

Converts a `gdouble` to a string, using the '.' as decimal point. To format the number you pass in a `printf()`-style format string. Allowed conversion specifiers are 'e', 'E', 'f', 'F', 'g' and 'G'.

The @format must just be a single format specifier starting with `%`, expecting a `gdouble` argument.

The returned buffer is guaranteed to be nul-terminated.

If you just want to want to serialize the value into a string, use [func@GLib.ascii_dtostr].

func AsciiStrcasecmp 

func AsciiStrcasecmp(S1Var string, S2Var string) int

Compare two strings, ignoring the case of ASCII characters.

Unlike the BSD `strcasecmp()` function, this only recognizes standard ASCII letters and ignores the locale, treating all non-ASCII bytes as if they are not letters.

This function should be used only on strings that are known to be in encodings where the bytes corresponding to ASCII letters always represent themselves. This includes UTF-8 and the ISO-8859-* charsets, but not for instance double-byte encodings like the Windows Codepage 932, where the trailing bytes of double-byte characters include all ASCII letters. If you compare two CP932 strings using this function, you will get false matches.

Both @s1 and @s2 must be non-`NULL`.

func AsciiStrdown 

func AsciiStrdown(StrVar string, LenVar int) string

Converts all upper case ASCII letters to lower case ASCII letters, with semantics that exactly match [func@GLib.ascii_tolower].

func AsciiStringToSigned 

func AsciiStringToSigned(StrVar string, BaseVar uint, MinVar int64, MaxVar int64, OutNumVar *int64) (bool, error)

A convenience function for converting a string to a signed number.

This function assumes that @str contains only a number of the given @base that is within inclusive bounds limited by @min and @max. If this is true, then the converted number is stored in @out_num. An empty string is not a valid input. A string with leading or trailing whitespace is also an invalid input.

@base can be between 2 and 36 inclusive. Hexadecimal numbers must not be prefixed with "0x" or "0X". Such a problem does not exist for octal numbers, since they were usually prefixed with a zero which does not change the value of the parsed number.

Parsing failures result in an error with the `G_NUMBER_PARSER_ERROR` domain. If the input is invalid, the error code will be [error@GLib.NumberParserError.INVALID]. If the parsed number is out of bounds - [error@GLib.NumberParserError.OUT_OF_BOUNDS].

See [func@GLib.ascii_strtoll] if you have more complex needs such as parsing a string which starts with a number, but then has other characters.

func AsciiStringToUnsigned 

func AsciiStringToUnsigned(StrVar string, BaseVar uint, MinVar uint64, MaxVar uint64, OutNumVar *uint64) (bool, error)

A convenience function for converting a string to an unsigned number.

This function assumes that @str contains only a number of the given @base that is within inclusive bounds limited by @min and @max. If this is true, then the converted number is stored in @out_num. An empty string is not a valid input. A string with leading or trailing whitespace is also an invalid input. A string with a leading sign (`-` or `+`) is not a valid input for the unsigned parser.

@base can be between 2 and 36 inclusive. Hexadecimal numbers must not be prefixed with "0x" or "0X". Such a problem does not exist for octal numbers, since they were usually prefixed with a zero which does not change the value of the parsed number.

Parsing failures result in an error with the `G_NUMBER_PARSER_ERROR` domain. If the input is invalid, the error code will be [error@GLib.NumberParserError.INVALID]. If the parsed number is out of bounds - [error@GLib.NumberParserError.OUT_OF_BOUNDS].

See [func@GLib.ascii_strtoull] if you have more complex needs such as parsing a string which starts with a number, but then has other characters.

func AsciiStrncasecmp 

func AsciiStrncasecmp(S1Var string, S2Var string, NVar uint) int

Compare @s1 and @s2, ignoring the case of ASCII characters and any characters after the first @n in each string. If either string is less than @n bytes long, comparison will stop at the first nul byte encountered.

Unlike the BSD `strncasecmp()` function, this only recognizes standard ASCII letters and ignores the locale, treating all non-ASCII characters as if they are not letters.

The same warning as in [func@GLib.ascii_strcasecmp] applies: Use this function only on strings known to be in encodings where bytes corresponding to ASCII letters always represent themselves.

func AsciiStrtod 

func AsciiStrtod(NptrVar string, EndptrVar *string) float64

Converts a string to a floating point value.

This function behaves like the standard `strtod()` function does in the C locale. It does this without actually changing the current locale, since that would not be thread-safe. A limitation of the implementation is that this function will still accept localized versions of infinities and NANs.

This function is typically used when reading configuration files or other non-user input that should be locale independent. To handle input from the user you should normally use the locale-sensitive system `strtod()` function.

To convert from a gdouble to a string in a locale-insensitive way, use [func@GLib.ascii_dtostr].

If the correct value would cause overflow, plus or minus `HUGE_VAL` is returned (according to the sign of the value), and `ERANGE` is stored in `errno`. If the correct value would cause underflow, zero is returned and `ERANGE` is stored in `errno`.

This function resets `errno` before calling `strtod()` so that you can reliably detect overflow and underflow.

func AsciiStrtoll 

func AsciiStrtoll(NptrVar string, EndptrVar *string, BaseVar uint) int64

Converts a string to a `gint64` value.

This function behaves like the standard `strtoll()` function does in the C locale. It does this without actually changing the current locale, since that would not be thread-safe.

This function is typically used when reading configuration files or other non-user input that should be locale independent. To handle input from the user you should normally use the locale-sensitive system `strtoll()` function.

If the correct value would cause overflow, [const@GLib.MAXINT64] or [const@GLib.MININT64] is returned, and `ERANGE` is stored in `errno`. If the base is outside the valid range, zero is returned, and `EINVAL` is stored in `errno`. If the string conversion fails, zero is returned, and @endptr returns @nptr (if @endptr is non-`NULL`).

func AsciiStrtoull 

func AsciiStrtoull(NptrVar string, EndptrVar *string, BaseVar uint) uint64

Converts a string to a `guint64` value.

This function behaves like the standard `strtoull()` function does in the C locale. It does this without actually changing the current locale, since that would not be thread-safe.

Note that input with a leading minus sign (`-`) is accepted, and will return the negation of the parsed number, unless that would overflow a `guint64`. Critically, this means you cannot assume that a short fixed length input will result in a low return value, as the input could have a leading `-`.

This function is typically used when reading configuration files or other non-user input that should be locale independent. To handle input from the user you should normally use the locale-sensitive system `strtoull()` function.

If the correct value would cause overflow, [const@GLib.MAXUINT64] is returned, and `ERANGE` is stored in `errno`. If the base is outside the valid range, zero is returned, and `EINVAL` is stored in `errno`. If the string conversion fails, zero is returned, and @endptr returns @nptr (if @endptr is non-`NULL`).

func AsciiStrup 

func AsciiStrup(StrVar string, LenVar int) string

Converts all lower case ASCII letters to upper case ASCII letters, with semantics that exactly match [func@GLib.ascii_toupper].

func AsciiTolower 

func AsciiTolower(CVar byte) byte

Convert a character to ASCII lower case. If the character is not an ASCII upper case letter, it is returned unchanged.

Unlike the standard C library `tolower()` function, this only recognizes standard ASCII letters and ignores the locale, returning all non-ASCII characters unchanged, even if they are lower case letters in a particular character set. Also unlike the standard library function, this takes and returns a char, not an int, so don't call it on `EOF` but no need to worry about casting to `guchar` before passing a possibly non-ASCII character in.

func AsciiToupper 

func AsciiToupper(CVar byte) byte

Convert a character to ASCII upper case. If the character is not an ASCII lower case letter, it is returned unchanged.

Unlike the standard C library `toupper()` function, this only recognizes standard ASCII letters and ignores the locale, returning all non-ASCII characters unchanged, even if they are upper case letters in a particular character set. Also unlike the standard library function, this takes and returns a char, not an int, so don't call it on `EOF` but no need to worry about casting to `guchar` before passing a possibly non-ASCII character in.

func AsciiXdigitValue 

func AsciiXdigitValue(CVar byte) int

Determines the numeric value of a character as a hexadecimal digit. If the character is not a hex digit according to [func@GLib.ascii_isxdigit], `-1` is returned.

Differs from [func@GLib.unichar_xdigit_value] because it takes a char, so there's no worry about sign extension if characters are signed.

Differs from [func@GLib.unichar_xdigit_value] because it takes a char, so there's no worry about sign extension if characters are signed.

func AssertWarning 

func AssertWarning(LogDomainVar string, FileVar string, LineVar int, PrettyFunctionVar string, ExpressionVar string)

func AssertionMessage 

func AssertionMessage(DomainVar string, FileVar string, LineVar int, FuncVar string, MessageVar string)

func AssertionMessageCmpint 

func AssertionMessageCmpint(DomainVar string, FileVar string, LineVar int, FuncVar string, ExprVar string, Arg1Var uint64, CmpVar string, Arg2Var uint64, NumtypeVar byte)

func AssertionMessageCmpnum 

func AssertionMessageCmpnum(DomainVar string, FileVar string, LineVar int, FuncVar string, ExprVar string, Arg1Var float64, CmpVar string, Arg2Var float64, NumtypeVar byte)

func AssertionMessageCmpstr 

func AssertionMessageCmpstr(DomainVar string, FileVar string, LineVar int, FuncVar string, ExprVar string, Arg1Var string, CmpVar string, Arg2Var string)

func AssertionMessageCmpstrv 

func AssertionMessageCmpstrv(DomainVar string, FileVar string, LineVar int, FuncVar string, ExprVar string, Arg1Var string, Arg2Var string, FirstWrongIdxVar uint)

func AssertionMessageError 

func AssertionMessageError(DomainVar string, FileVar string, LineVar int, FuncVar string, ExprVar string, ErrorVar *Error, ErrorDomainVar Quark, ErrorCodeVar int)

func AssertionMessageExpr 

func AssertionMessageExpr(DomainVar *string, FileVar string, LineVar int, FuncVar string, ExprVar *string)

Internal function used to print messages from the public g_assert() and g_assert_not_reached() macros.

func Atexit 

func Atexit(FuncVar *VoidFunc)

Specifies a function to be called at normal program termination.

Since GLib 2.8.2, on Windows g_atexit() actually is a preprocessor macro that maps to a call to the atexit() function in the C library. This means that in case the code that calls g_atexit(), i.e. atexit(), is in a DLL, the function will be called when the DLL is detached from the program. This typically makes more sense than that the function is called when the GLib DLL is detached, which happened earlier when g_atexit() was a function in the GLib DLL.

The behaviour of atexit() in the context of dynamically loaded modules is not formally specified and varies wildly.

On POSIX systems, calling g_atexit() (or atexit()) in a dynamically loaded module which is unloaded before the program terminates might well cause a crash at program exit.

Some POSIX systems implement atexit() like Windows, and have each dynamically loaded module maintain an own atexit chain that is called when the module is unloaded.

On other POSIX systems, before a dynamically loaded module is unloaded, the registered atexit functions (if any) residing in that module are called, regardless where the code that registered them resided. This is presumably the most robust approach.

As can be seen from the above, for portability it's best to avoid calling g_atexit() (or atexit()) except in the main executable of a program.

func AtomicIntAdd 

func AtomicIntAdd(AtomicVar uintptr, ValVar int) int

Atomically adds @val to the value of @atomic.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic += val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

Before version 2.30, this function did not return a value (but g_atomic_int_exchange_and_add() did, and had the same meaning).

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntAnd 

func AtomicIntAnd(AtomicVar uintptr, ValVar uint) uint

Performs an atomic bitwise 'and' of the value of @atomic and @val, storing the result back in @atomic.

This call acts as a full compiler and hardware memory barrier.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic &amp;= val; return tmp; }`.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntCompareAndExchange 

func AtomicIntCompareAndExchange(AtomicVar uintptr, OldvalVar int, NewvalVar int) bool

Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs.

This compare and exchange is done atomically.

Think of this operation as an atomic version of `{ if (*atomic == oldval) { *atomic = newval; return TRUE; } else return FALSE; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntCompareAndExchangeFull 

func AtomicIntCompareAndExchangeFull(AtomicVar uintptr, OldvalVar int, NewvalVar int, PrevalVar *int) bool

Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs. In any case the value of @atomic before this operation is stored in @preval.

This compare and exchange is done atomically.

Think of this operation as an atomic version of `{ *preval = *atomic; if (*atomic == oldval) { *atomic = newval; return TRUE; } else return FALSE; }`.

This call acts as a full compiler and hardware memory barrier.

See also g_atomic_int_compare_and_exchange()

func AtomicIntDecAndTest 

func AtomicIntDecAndTest(AtomicVar uintptr) bool

Decrements the value of @atomic by 1.

Think of this operation as an atomic version of `{ *atomic -= 1; return (*atomic == 0); }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntExchange 

func AtomicIntExchange(AtomicVar uintptr, NewvalVar int) int

Sets the @atomic to @newval and returns the old value from @atomic.

This exchange is done atomically.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic = val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

func AtomicIntExchangeAndAdd 

func AtomicIntExchangeAndAdd(AtomicVar uintptr, ValVar int) int

This function existed before g_atomic_int_add() returned the prior value of the integer (which it now does). It is retained only for compatibility reasons. Don't use this function in new code.

func AtomicIntGet 

func AtomicIntGet(AtomicVar uintptr) int

Gets the current value of @atomic.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntInc 

func AtomicIntInc(AtomicVar uintptr)

Increments the value of @atomic by 1.

Think of this operation as an atomic version of `{ *atomic += 1; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntOr 

func AtomicIntOr(AtomicVar uintptr, ValVar uint) uint

Performs an atomic bitwise 'or' of the value of @atomic and @val, storing the result back in @atomic.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic |= val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntSet 

func AtomicIntSet(AtomicVar uintptr, NewvalVar int)

Sets the value of @atomic to @newval.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicIntXor 

func AtomicIntXor(AtomicVar uintptr, ValVar uint) uint

Performs an atomic bitwise 'xor' of the value of @atomic and @val, storing the result back in @atomic.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic ^= val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicPointerAdd 

func AtomicPointerAdd(AtomicVar uintptr, ValVar int) int

Atomically adds @val to the value of @atomic.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic += val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

In GLib 2.80, the return type was changed from #gssize to #gintptr to add support for platforms with 128-bit pointers. This should not affect existing code.

func AtomicPointerAnd 

func AtomicPointerAnd(AtomicVar uintptr, ValVar uint) uintptr

Performs an atomic bitwise 'and' of the value of @atomic and @val, storing the result back in @atomic.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic &amp;= val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

In GLib 2.80, the return type was changed from #gsize to #guintptr to add support for platforms with 128-bit pointers. This should not affect existing code.

func AtomicPointerCompareAndExchange 

func AtomicPointerCompareAndExchange(AtomicVar uintptr, OldvalVar uintptr, NewvalVar uintptr) bool

Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs.

This compare and exchange is done atomically.

Think of this operation as an atomic version of `{ if (*atomic == oldval) { *atomic = newval; return TRUE; } else return FALSE; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicPointerCompareAndExchangeFull 

func AtomicPointerCompareAndExchangeFull(AtomicVar uintptr, OldvalVar uintptr, NewvalVar uintptr, PrevalVar *uintptr) bool

Compares @atomic to @oldval and, if equal, sets it to @newval. If @atomic was not equal to @oldval then no change occurs. In any case the value of @atomic before this operation is stored in @preval.

This compare and exchange is done atomically.

Think of this operation as an atomic version of `{ *preval = *atomic; if (*atomic == oldval) { *atomic = newval; return TRUE; } else return FALSE; }`.

This call acts as a full compiler and hardware memory barrier.

See also g_atomic_pointer_compare_and_exchange()

func AtomicPointerExchange 

func AtomicPointerExchange(AtomicVar uintptr, NewvalVar uintptr) uintptr

Sets the @atomic to @newval and returns the old value from @atomic.

This exchange is done atomically.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic = val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

func AtomicPointerGet 

func AtomicPointerGet(AtomicVar uintptr) uintptr

Gets the current value of @atomic.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicPointerOr 

func AtomicPointerOr(AtomicVar uintptr, ValVar uint) uintptr

Performs an atomic bitwise 'or' of the value of @atomic and @val, storing the result back in @atomic.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic |= val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

In GLib 2.80, the return type was changed from #gsize to #guintptr to add support for platforms with 128-bit pointers. This should not affect existing code.

func AtomicPointerSet 

func AtomicPointerSet(AtomicVar uintptr, NewvalVar uintptr)

Sets the value of @atomic to @newval.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func AtomicPointerXor 

func AtomicPointerXor(AtomicVar uintptr, ValVar uint) uintptr

Performs an atomic bitwise 'xor' of the value of @atomic and @val, storing the result back in @atomic.

Think of this operation as an atomic version of `{ tmp = *atomic; *atomic ^= val; return tmp; }`.

This call acts as a full compiler and hardware memory barrier.

While @atomic has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

In GLib 2.80, the return type was changed from #gsize to #guintptr to add support for platforms with 128-bit pointers. This should not affect existing code.

func AtomicRcBoxAcquire 

func AtomicRcBoxAcquire(MemBlockVar uintptr) uintptr

Atomically acquires a reference on the data pointed by @mem_block.

func AtomicRcBoxAlloc 

func AtomicRcBoxAlloc(BlockSizeVar uint) uintptr

Allocates @block_size bytes of memory, and adds atomic reference counting semantics to it.

The data will be freed when its reference count drops to zero.

The allocated data is guaranteed to be suitably aligned for any built-in type.

func AtomicRcBoxAlloc0 

func AtomicRcBoxAlloc0(BlockSizeVar uint) uintptr

Allocates @block_size bytes of memory, and adds atomic reference counting semantics to it.

The contents of the returned data is set to zero.

The data will be freed when its reference count drops to zero.

The allocated data is guaranteed to be suitably aligned for any built-in type.

func AtomicRcBoxDup 

func AtomicRcBoxDup(BlockSizeVar uint, MemBlockVar uintptr) uintptr

Allocates a new block of data with atomic reference counting semantics, and copies @block_size bytes of @mem_block into it.

func AtomicRcBoxGetSize 

func AtomicRcBoxGetSize(MemBlockVar uintptr) uint

Retrieves the size of the reference counted data pointed by @mem_block.

func AtomicRcBoxRelease 

func AtomicRcBoxRelease(MemBlockVar uintptr)

Atomically releases a reference on the data pointed by @mem_block.

If the reference was the last one, it will free the resources allocated for @mem_block.

func AtomicRcBoxReleaseFull 

func AtomicRcBoxReleaseFull(MemBlockVar uintptr, ClearFuncVar *DestroyNotify)

Atomically releases a reference on the data pointed by @mem_block.

If the reference was the last one, it will call @clear_func to clear the contents of @mem_block, and then will free the resources allocated for @mem_block.

Note that implementing weak references via @clear_func is not thread-safe: clearing a pointer to the memory from the callback can race with another thread trying to access it as @mem_block already has a reference count of 0 when the callback is called and will be freed.

func AtomicRefCountCompare 

func AtomicRefCountCompare(ArcVar int, ValVar int) bool

Atomically compares the current value of @arc with @val.

func AtomicRefCountDec 

func AtomicRefCountDec(ArcVar int) bool

Atomically decreases the reference count.

If %TRUE is returned, the reference count reached 0. After this point, @arc is an undefined state and must be reinitialized with g_atomic_ref_count_init() to be used again.

func AtomicRefCountInc 

func AtomicRefCountInc(ArcVar int)

Atomically increases the reference count.

func AtomicRefCountInit 

func AtomicRefCountInit(ArcVar *int)

Initializes a reference count variable to 1.

func Base64Decode 

func Base64Decode(TextVar string, OutLenVar *uint) uintptr

Decode a sequence of Base-64 encoded text into binary data. Note that the returned binary data is not necessarily zero-terminated, so it should not be used as a character string.

func Base64DecodeInplace 

func Base64DecodeInplace(TextVar *[]byte, OutLenVar *uint) byte

Decode a sequence of Base-64 encoded text into binary data by overwriting the input data.

func Base64DecodeStep 

func Base64DecodeStep(InVar []byte, LenVar uint, OutVar *[]byte, StateVar *int, SaveVar *uint) uint

Incrementally decode a sequence of binary data from its Base-64 stringified representation. By calling this function multiple times you can convert data in chunks to avoid having to have the full encoded data in memory.

The output buffer must be large enough to fit all the data that will be written to it. Since base64 encodes 3 bytes in 4 chars you need at least: (@len / 4) * 3 + 3 bytes (+ 3 may be needed in case of non-zero state).

func Base64Encode 

func Base64Encode(DataVar []byte, LenVar uint) string

Encode a sequence of binary data into its Base-64 stringified representation.

func Base64EncodeClose 

func Base64EncodeClose(BreakLinesVar bool, OutVar *[]byte, StateVar *int, SaveVar *int) uint

Flush the status from a sequence of calls to g_base64_encode_step().

The output buffer must be large enough to fit all the data that will be written to it. It will need up to 4 bytes, or up to 5 bytes if line-breaking is enabled.

The @out array will not be automatically nul-terminated.

func Base64EncodeStep 

func Base64EncodeStep(InVar []byte, LenVar uint, BreakLinesVar bool, OutVar *[]byte, StateVar *int, SaveVar *int) uint

Incrementally encode a sequence of binary data into its Base-64 stringified representation. By calling this function multiple times you can convert data in chunks to avoid having to have the full encoded data in memory.

When all of the data has been converted you must call g_base64_encode_close() to flush the saved state.

The output buffer must be large enough to fit all the data that will be written to it. Due to the way base64 encodes you will need at least: (@len / 3 + 1) * 4 + 4 bytes (+ 4 may be needed in case of non-zero state). If you enable line-breaking you will need at least: ((@len / 3 + 1) * 4 + 4) / 76 + 1 bytes of extra space.

@break_lines is typically used when putting base64-encoded data in emails. It breaks the lines at 76 columns instead of putting all of the text on the same line. This avoids problems with long lines in the email system. Note however that it breaks the lines with `LF` characters, not `CR LF` sequences, so the result cannot be passed directly to SMTP or certain other protocols.

func Basename 

func Basename(FileNameVar string) string

Gets the name of the file without any leading directory components. It returns a pointer into the given file name string.

func BitLock 

func BitLock(AddressVar uintptr, LockBitVar int)

Sets the indicated @lock_bit in @address. If the bit is already set, this call will block until g_bit_unlock() unsets the corresponding bit.

Attempting to lock on two different bits within the same integer is not supported and will very probably cause deadlocks.

The value of the bit that is set is (1u &lt;&lt; @bit). If @bit is not between 0 and 31 then the result is undefined.

This function accesses @address atomically. All other accesses to @address must be atomic in order for this function to work reliably. While @address has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`.

func BitLockAndGet 

func BitLockAndGet(AddressVar uintptr, LockBitVar uint, OutValVar *int)

Sets the indicated @lock_bit in @address and atomically returns the new value.

This is like [func@GLib.bit_lock], except it can atomically return the new value at @address (right after obtaining the lock). Thus the value returned in @out_val always has the @lock_bit set.

func BitNthLsf 

func BitNthLsf(MaskVar uint, NthBitVar int) int

Find the position of the first bit set in @mask, searching from (but not including) @nth_bit upwards. Bits are numbered from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63, usually). To start searching from the 0th bit, set @nth_bit to -1.

func BitNthMsf 

func BitNthMsf(MaskVar uint, NthBitVar int) int

Find the position of the first bit set in @mask, searching from (but not including) @nth_bit downwards. Bits are numbered from 0 (least significant) to sizeof(#gulong) * 8 - 1 (31 or 63, usually). To start searching from the last bit, set @nth_bit to -1 or GLIB_SIZEOF_LONG * 8.

func BitStorage 

func BitStorage(NumberVar uint) uint

Gets the number of bits used to hold @number, e.g. if @number is 4, 3 bits are needed.

func BitTrylock 

func BitTrylock(AddressVar uintptr, LockBitVar int) bool

Sets the indicated @lock_bit in @address, returning %TRUE if successful. If the bit is already set, returns %FALSE immediately.

Attempting to lock on two different bits within the same integer is not supported.

The value of the bit that is set is (1u &lt;&lt; @bit). If @bit is not between 0 and 31 then the result is undefined.

This function accesses @address atomically. All other accesses to @address must be atomic in order for this function to work reliably. While @address has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`.

func BitUnlock 

func BitUnlock(AddressVar uintptr, LockBitVar int)

Clears the indicated @lock_bit in @address. If another thread is currently blocked in g_bit_lock() on this same bit then it will be woken up.

This function accesses @address atomically. All other accesses to @address must be atomic in order for this function to work reliably. While @address has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`.

func BitUnlockAndSet 

func BitUnlockAndSet(AddressVar uintptr, LockBitVar uint, NewValVar int, PreserveMaskVar int)

This is like [func@GLib.bit_unlock] but also atomically sets @address to @val.

If @preserve_mask is not zero, then the @preserve_mask bits will be preserved in @address and are not set to @val.

Note that the @lock_bit bit will always be unset regardless of @val, @preserve_mask and the currently set value in @address.

func BlowChunks 

func BlowChunks()

func BookmarkFileGLibType 

func BookmarkFileGLibType() types.GType

func BuildFilename 

func BuildFilename(FirstElementVar string, varArgs ...interface{}) string

Creates a filename from a series of elements using the correct separator for the current platform.

On Unix, this function behaves identically to `g_build_path (G_DIR_SEPARATOR_S, first_element, ....)`.

On Windows, it takes into account that either the backslash (`\` or slash (`/`) can be used as separator in filenames, but otherwise behaves as on UNIX. When file pathname separators need to be inserted, the one that last previously occurred in the parameters (reading from left to right) is used.

No attempt is made to force the resulting filename to be an absolute path. If the first element is a relative path, the result will be a relative path.

If you are building a path programmatically you may want to use #GPathBuf instead.

func BuildFilenameValist 

func BuildFilenameValist(FirstElementVar string, ArgsVar []interface{}) string

Creates a filename from a list of elements using the correct separator for the current platform.

Behaves exactly like g_build_filename(), but takes the path elements as a va_list.

This function is mainly meant for implementing other variadic arguments functions.

func BuildFilenamev 

func BuildFilenamev(ArgsVar []string) string

Creates a filename from a vector of elements using the correct separator for the current platform.

This function behaves exactly like g_build_filename(), but takes the path elements as a string array, instead of varargs. This function is mainly meant for language bindings.

If you are building a path programmatically you may want to use #GPathBuf instead.

func BuildPath 

func BuildPath(SeparatorVar string, FirstElementVar string, varArgs ...interface{}) string

Creates a path from a series of elements using @separator as the separator between elements.

At the boundary between two elements, any trailing occurrences of separator in the first element, or leading occurrences of separator in the second element are removed and exactly one copy of the separator is inserted.

Empty elements are ignored.

The number of leading copies of the separator on the result is the same as the number of leading copies of the separator on the first non-empty element.

The number of trailing copies of the separator on the result is the same as the number of trailing copies of the separator on the last non-empty element. (Determination of the number of trailing copies is done without stripping leading copies, so if the separator is `ABA`, then `ABABA` has 1 trailing copy.)

However, if there is only a single non-empty element, and there are no characters in that element not part of the leading or trailing separators, then the result is exactly the original value of that element.

Other than for determination of the number of leading and trailing copies of the separator, elements consisting only of copies of the separator are ignored.

func BuildPathv 

func BuildPathv(SeparatorVar string, ArgsVar []string) string

Behaves exactly like g_build_path(), but takes the path elements as a string array, instead of variadic arguments.

This function is mainly meant for language bindings.

func ByteArrayAppend 

func ByteArrayAppend(ArrayVar []byte, DataVar []byte, LenVar uint) uintptr

Adds the given bytes to the end of the `GByteArray`. The array will grow in size automatically if necessary.

func ByteArrayFree 

func ByteArrayFree(ArrayVar []byte, FreeSegmentVar bool) uintptr

Frees the memory allocated by the `GByteArray`. If @free_segment is true it frees the actual byte data. If the reference count of @array is greater than one, the `GByteArray` wrapper is preserved but the size of @array will be set to zero.

func ByteArrayGLibType 

func ByteArrayGLibType() types.GType

func ByteArrayNew 

func ByteArrayNew() uintptr

Creates a new `GByteArray` with a reference count of 1.

func ByteArrayNewTake 

func ByteArrayNewTake(DataVar []byte, LenVar uint) uintptr

Creates a byte array containing the @data. After this call, @data belongs to the `GByteArray` and may no longer be modified by the caller. The memory of @data has to be dynamically allocated and will eventually be freed with [func@GLib.free].

Do not use it if @len is greater than [`G_MAXUINT`](types.html#guint). `GByteArray` stores the length of its data in `guint`, which may be shorter than `gsize`.

func ByteArrayPrepend 

func ByteArrayPrepend(ArrayVar []byte, DataVar []byte, LenVar uint) uintptr

Adds the given data to the start of the `GByteArray`. The array will grow in size automatically if necessary.

func ByteArrayRef 

func ByteArrayRef(ArrayVar []byte) uintptr

Atomically increments the reference count of @array by one. This function is thread-safe and may be called from any thread.

func ByteArrayRemoveIndex 

func ByteArrayRemoveIndex(ArrayVar []byte, IndexVar uint) uintptr

Removes the byte at the given index from a `GByteArray`. The following bytes are moved down one place.

func ByteArrayRemoveIndexFast 

func ByteArrayRemoveIndexFast(ArrayVar []byte, IndexVar uint) uintptr

Removes the byte at the given index from a `GByteArray`. The last element in the array is used to fill in the space, so this function does not preserve the order of the `GByteArray`. But it is faster than [func@GLib.ByteArray.remove_index].

func ByteArrayRemoveRange 

func ByteArrayRemoveRange(ArrayVar []byte, IndexVar uint, LengthVar uint) uintptr

Removes the given number of bytes starting at the given index from a `GByteArray`. The following elements are moved to close the gap.

func ByteArraySetSize 

func ByteArraySetSize(ArrayVar []byte, LengthVar uint) uintptr

Sets the size of the `GByteArray`, expanding it if necessary.

func ByteArraySizedNew 

func ByteArraySizedNew(ReservedSizeVar uint) uintptr

Creates a new `GByteArray` with @reserved_size bytes preallocated. This avoids frequent reallocation, if you are going to add many bytes to the array. Note however that the size of the array is still 0.

func ByteArraySort 

func ByteArraySort(ArrayVar []byte, CompareFuncVar *CompareFunc)

Sorts a byte array, using @compare_func which should be a `qsort()`-style comparison function (returns less than zero for first arg is less than second arg, zero for equal, greater than zero if first arg is greater than second arg).

If two array elements compare equal, their order in the sorted array is undefined. If you want equal elements to keep their order (i.e. you want a stable sort) you can write a comparison function that, if two elements would otherwise compare equal, compares them by their addresses.

func ByteArraySortWithData 

func ByteArraySortWithData(ArrayVar []byte, CompareFuncVar *CompareDataFunc, UserDataVar uintptr)

Like [func@GLib.ByteArray.sort], but the comparison function takes an extra user data argument.

func ByteArraySteal 

func ByteArraySteal(ArrayVar []byte, LenVar *uint) uintptr

Frees the data in the array and resets the size to zero, while the underlying array is preserved for use elsewhere and returned to the caller.

func ByteArrayUnref 

func ByteArrayUnref(ArrayVar []byte)

Atomically decrements the reference count of @array by one. If the reference count drops to 0, all memory allocated by the array is released. This function is thread-safe and may be called from any thread.

func BytesGLibType 

func BytesGLibType() types.GType

func CanonicalizeFilename 

func CanonicalizeFilename(FilenameVar string, RelativeToVar *string) string

Gets the canonical file name from @filename. All triple slashes are turned into single slashes, and all `..` and `.`s resolved against @relative_to.

Symlinks are not followed, and the returned path is guaranteed to be absolute.

If @filename is an absolute path, @relative_to is ignored. Otherwise, @relative_to will be prepended to @filename to make it absolute. @relative_to must be an absolute path, or %NULL. If @relative_to is %NULL, it'll fallback to g_get_current_dir().

This function never fails, and will canonicalize file paths even if they don't exist.

No file system I/O is done.

func Chdir 

func Chdir(PathVar string) int

A wrapper for the POSIX chdir() function. The function changes the current directory of the process to @path.

See your C library manual for more details about chdir().

func CheckVersion 

func CheckVersion(RequiredMajorVar uint, RequiredMinorVar uint, RequiredMicroVar uint) string

Checks that the GLib library in use is compatible with the given version.

Generally you would pass in the constants %GLIB_MAJOR_VERSION, %GLIB_MINOR_VERSION, %GLIB_MICRO_VERSION as the three arguments to this function; that produces a check that the library in use is compatible with the version of GLib the application or module was compiled against.

Compatibility is defined by two things: first the version of the running library is newer than the version `@required_major.required_minor.@required_micro`. Second the running library must be binary compatible with the version `@required_major.@required_minor.@required_micro` (same major version.)

func ChecksumGLibType 

func ChecksumGLibType() types.GType

func ChecksumTypeGetLength 

func ChecksumTypeGetLength(ChecksumTypeVar ChecksumType) int

Gets the length in bytes of digests of type @checksum_type

func ChildWatchAdd 

func ChildWatchAdd(PidVar Pid, FunctionVar *ChildWatchFunc, DataVar uintptr) uint

Sets a function to be called when the child indicated by @pid exits, at a default priority, [const@GLib.PRIORITY_DEFAULT].

If you obtain @pid from [func@GLib.spawn_async] or [func@GLib.spawn_async_with_pipes] you will need to pass [flags@GLib.SpawnFlags.DO_NOT_REAP_CHILD] as a flag to the spawn function for the child watching to work.

Note that on platforms where [type@GLib.Pid] must be explicitly closed (see [func@GLib.spawn_close_pid]) @pid must not be closed while the source is still active. Typically, you will want to call [func@GLib.spawn_close_pid] in the callback function for the source.

GLib supports only a single callback per process ID. On POSIX platforms, the same restrictions mentioned for [func@GLib.child_watch_source_new] apply to this function.

This internally creates a main loop source using [func@GLib.child_watch_source_new] and attaches it to the main loop context using [method@GLib.Source.attach]. You can do these steps manually if you need greater control.

func ChildWatchAddFull 

func ChildWatchAddFull(PriorityVar int, PidVar Pid, FunctionVar *ChildWatchFunc, DataVar uintptr, NotifyVar *DestroyNotify) uint

Sets a function to be called when the child indicated by @pid exits, at the priority @priority.

If you obtain @pid from [func@GLib.spawn_async] or [func@GLib.spawn_async_with_pipes] you will need to pass [flags@GLib.SpawnFlags.DO_NOT_REAP_CHILD] as a flag to the spawn function for the child watching to work.

In many programs, you will want to call [func@GLib.spawn_check_wait_status] in the callback to determine whether or not the child exited successfully.

Also, note that on platforms where [type@GLib.Pid] must be explicitly closed (see [func@GLib.spawn_close_pid]) @pid must not be closed while the source is still active. Typically, you should invoke [func@GLib.spawn_close_pid] in the callback function for the source.

GLib supports only a single callback per process ID. On POSIX platforms, the same restrictions mentioned for [func@GLib.child_watch_source_new] apply to this function.

This internally creates a main loop source using [func@GLib.child_watch_source_new] and attaches it to the main loop context using [method@GLib.Source.attach]. You can do these steps manually if you need greater control.

func Chmod 

func Chmod(FilenameVar string, ModeVar int) int

A wrapper for the POSIX chmod() function. The chmod() function is used to set the permissions of a file system object.

On Windows the file protection mechanism is not at all POSIX-like, and the underlying chmod() function in the C library just sets or clears the FAT-style READONLY attribute. It does not touch any ACL. Software that needs to manage file permissions on Windows exactly should use the Win32 API.

See your C library manual for more details about chmod().

func ClearError 

func ClearError() error

If @err or `*err` is %NULL, does nothing. Otherwise, calls g_error_free() on `*err` and sets `*err` to %NULL.

func ClearHandleId 

func ClearHandleId(TagPtrVar uint, ClearFuncVar *ClearHandleFunc)

Clears a numeric handler, such as a [struct@GLib.Source] ID.

The @tag_ptr must be a valid pointer to the variable holding the handler.

If the ID is zero then this function does nothing. Otherwise, @clear_func is called with the ID as a parameter, and the tag is set to zero.

A macro is also included that allows this function to be used without pointer casts.

func ClearList 

func ClearList(ListPtrVar **List, DestroyVar *DestroyNotify)

Clears a pointer to a #GList, freeing it and, optionally, freeing its elements using @destroy.

@list_ptr must be a valid pointer. If @list_ptr points to a null #GList, this does nothing.

func ClearPointer 

func ClearPointer(PpVar *uintptr, DestroyVar *DestroyNotify)

Clears a reference to a variable.

@pp must not be %NULL.

If the reference is %NULL then this function does nothing. Otherwise, the variable is destroyed using @destroy and the pointer is set to %NULL.

A macro is also included that allows this function to be used without pointer casts. This will mask any warnings about incompatible function types or calling conventions, so you must ensure that your @destroy function is compatible with being called as [callback@GLib.DestroyNotify] using the standard calling convention for the platform that GLib was compiled for; otherwise the program will experience undefined behaviour.

Examples of this kind of undefined behaviour include using many Windows Win32 APIs, as well as many if not all OpenGL and Vulkan calls on 32-bit Windows, which typically use the `__stdcall` calling convention rather than the `__cdecl` calling convention.

The affected functions can be used by wrapping them in a [callback@GLib.DestroyNotify] that is declared with the standard calling convention:

```c // Wrapper needed to avoid mismatched calling conventions on Windows static void destroy_sync (void *sync) 

{
  glDeleteSync (sync);
}

// …

g_clear_pointer (&amp;sync, destroy_sync); ```

func ClearSlist 

func ClearSlist(SlistPtrVar **SList, DestroyVar *DestroyNotify)

Clears a pointer to a #GSList, freeing it and, optionally, freeing its elements using @destroy.

@slist_ptr must be a valid pointer. If @slist_ptr points to a null #GSList, this does nothing.

func Close 

func Close(FdVar int) (bool, error)

This wraps the close() call. In case of error, %errno will be preserved, but the error will also be stored as a #GError in @error. In case of success, %errno is undefined.

Besides using #GError, there is another major reason to prefer this function over the call provided by the system; on Unix, it will attempt to correctly handle %EINTR, which has platform-specific semantics.

It is a bug to call this function with an invalid file descriptor.

On POSIX platforms since GLib 2.76, this function is async-signal safe if (and only if) @error is %NULL and @fd is a valid open file descriptor. This makes it safe to call from a signal handler or a #GSpawnChildSetupFunc under those conditions. See [`signal(7)`](man:signal(7)) and [`signal-safety(7)`](man:signal-safety(7)) for more details.

func ComputeChecksumForBytes 

func ComputeChecksumForBytes(ChecksumTypeVar ChecksumType, DataVar *Bytes) string

Computes the checksum for a binary @data. This is a convenience wrapper for g_checksum_new(), g_checksum_get_string() and g_checksum_free().

The hexadecimal string returned will be in lower case.

func ComputeChecksumForData 

func ComputeChecksumForData(ChecksumTypeVar ChecksumType, DataVar []byte, LengthVar uint) string

Computes the checksum for a binary @data of @length. This is a convenience wrapper for g_checksum_new(), g_checksum_get_string() and g_checksum_free().

The hexadecimal string returned will be in lower case.

func ComputeChecksumForString 

func ComputeChecksumForString(ChecksumTypeVar ChecksumType, StrVar string, LengthVar int) string

Computes the checksum of a string.

The hexadecimal string returned will be in lower case.

func ComputeHmacForBytes 

func ComputeHmacForBytes(DigestTypeVar ChecksumType, KeyVar *Bytes, DataVar *Bytes) string

Computes the HMAC for a binary @data. This is a convenience wrapper for g_hmac_new(), g_hmac_get_string() and g_hmac_unref().

The hexadecimal string returned will be in lower case.

func ComputeHmacForData 

func ComputeHmacForData(DigestTypeVar ChecksumType, KeyVar []byte, KeyLenVar uint, DataVar []byte, LengthVar uint) string

Computes the HMAC for a binary @data of @length. This is a convenience wrapper for g_hmac_new(), g_hmac_get_string() and g_hmac_unref().

The hexadecimal string returned will be in lower case.

func ComputeHmacForString 

func ComputeHmacForString(DigestTypeVar ChecksumType, KeyVar []byte, KeyLenVar uint, StrVar string, LengthVar int) string

Computes the HMAC for a string.

The hexadecimal string returned will be in lower case.

func Convert 

func Convert(StrVar []byte, LenVar int, ToCodesetVar string, FromCodesetVar string, BytesReadVar *uint, BytesWrittenVar *uint) (uintptr, error)

Converts a string from one character set to another.

Note that you should use g_iconv() for streaming conversions. Despite the fact that @bytes_read can return information about partial characters, the g_convert_... functions are not generally suitable for streaming. If the underlying converter maintains internal state, then this won't be preserved across successive calls to g_convert(), g_convert_with_iconv() or g_convert_with_fallback(). (An example of this is the GNU C converter for CP1255 which does not emit a base character until it knows that the next character is not a mark that could combine with the base character.)

Using extensions such as "//TRANSLIT" may not work (or may not work well) on many platforms. Consider using g_str_to_ascii() instead.

func ConvertWithFallback 

func ConvertWithFallback(StrVar []byte, LenVar int, ToCodesetVar string, FromCodesetVar string, FallbackVar string, BytesReadVar *uint, BytesWrittenVar *uint) (uintptr, error)

Converts a string from one character set to another, possibly including fallback sequences for characters not representable in the output. Note that it is not guaranteed that the specification for the fallback sequences in @fallback will be honored. Some systems may do an approximate conversion from @from_codeset to @to_codeset in their iconv() functions, in which case GLib will simply return that approximate conversion.

Note that you should use g_iconv() for streaming conversions. Despite the fact that @bytes_read can return information about partial characters, the g_convert_... functions are not generally suitable for streaming. If the underlying converter maintains internal state, then this won't be preserved across successive calls to g_convert(), g_convert_with_iconv() or g_convert_with_fallback(). (An example of this is the GNU C converter for CP1255 which does not emit a base character until it knows that the next character is not a mark that could combine with the base character.)

func ConvertWithIconv 

func ConvertWithIconv(StrVar []byte, LenVar int, ConverterVar uintptr, BytesReadVar *uint, BytesWrittenVar *uint) (uintptr, error)

Converts a string from one character set to another.

Note that you should use g_iconv() for streaming conversions. Despite the fact that @bytes_read can return information about partial characters, the g_convert_... functions are not generally suitable for streaming. If the underlying converter maintains internal state, then this won't be preserved across successive calls to g_convert(), g_convert_with_iconv() or g_convert_with_fallback(). (An example of this is the GNU C converter for CP1255 which does not emit a base character until it knows that the next character is not a mark that could combine with the base character.)

Characters which are valid in the input character set, but which have no representation in the output character set will result in a %G_CONVERT_ERROR_ILLEGAL_SEQUENCE error. This is in contrast to the iconv() specification, which leaves this behaviour implementation defined. Note that this is the same error code as is returned for an invalid byte sequence in the input character set. To get defined behaviour for conversion of unrepresentable characters, use g_convert_with_fallback().

func Creat 

func Creat(FilenameVar string, ModeVar int) int

A wrapper for the POSIX creat() function. The creat() function is used to convert a pathname into a file descriptor, creating a file if necessary.

On POSIX systems file descriptors are implemented by the operating system. On Windows, it's the C library that implements creat() and file descriptors. The actual Windows API for opening files is different, see MSDN documentation for CreateFile(). The Win32 API uses file handles, which are more randomish integers, not small integers like file descriptors.

Because file descriptors are specific to the C library on Windows, the file descriptor returned by this function makes sense only to functions in the same C library. Thus if the GLib-using code uses a different C library than GLib does, the file descriptor returned by this function cannot be passed to C library functions like write() or read().

See your C library manual for more details about creat().

func DatalistClear 

func DatalistClear(DatalistVar **Data)

Frees all the data elements of the datalist. The data elements' destroy functions are called if they have been set.

func DatalistForeach 

func DatalistForeach(DatalistVar **Data, FuncVar *DataForeachFunc, UserDataVar uintptr)

Calls the given function for each data element of the datalist. The function is called with each data element's #GQuark id and data, together with the given @user_data parameter. Note that this function is NOT thread-safe. So unless @datalist can be protected from any modifications during invocation of this function, it should not be called.

@func can make changes to @datalist, but the iteration will not reflect changes made during the g_datalist_foreach() call, other than skipping over elements that are removed.

func DatalistGetData 

func DatalistGetData(DatalistVar **Data, KeyVar string) uintptr

Gets a data element, using its string identifier. This is slower than g_datalist_id_get_data() because it compares strings.

func DatalistGetFlags 

func DatalistGetFlags(DatalistVar **Data) uint

Gets flags values packed in together with the datalist. See g_datalist_set_flags().

func DatalistIdDupData 

func DatalistIdDupData(DatalistVar **Data, KeyIdVar Quark, DupFuncVar *DuplicateFunc, UserDataVar uintptr) uintptr

This is a variant of g_datalist_id_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

If the @key_id is not set in the datalist then @dup_func will be called with a %NULL argument.

Note that @dup_func is called while the datalist is locked, so it is not allowed to read or modify the datalist.

This function can be useful to avoid races when multiple threads are using the same datalist and the same key.

func DatalistIdGetData 

func DatalistIdGetData(DatalistVar **Data, KeyIdVar Quark) uintptr

Retrieves the data element corresponding to @key_id.

func DatalistIdRemoveMultiple 

func DatalistIdRemoveMultiple(DatalistVar **Data, KeysVar []Quark, NKeysVar uint)

Removes multiple keys from a datalist.

This is more efficient than calling g_datalist_id_remove_data() multiple times in a row.

Before 2.80, @n_keys had to be not larger than 16. Since 2.84, performance is improved for larger number of keys.

func DatalistIdRemoveNoNotify 

func DatalistIdRemoveNoNotify(DatalistVar **Data, KeyIdVar Quark) uintptr

Removes an element, without calling its destroy notification function.

func DatalistIdReplaceData 

func DatalistIdReplaceData(DatalistVar **Data, KeyIdVar Quark, OldvalVar uintptr, NewvalVar uintptr, DestroyVar *DestroyNotify, OldDestroyVar *DestroyNotify) bool

Compares the member that is associated with @key_id in @datalist to @oldval, and if they are the same, replace @oldval with @newval.

This is like a typical atomic compare-and-exchange operation, for a member of @datalist.

If the previous value was replaced then ownership of the old value (@oldval) is passed to the caller, including the registered destroy notify for it (passed out in @old_destroy). Its up to the caller to free this as they wish, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way.

func DatalistIdSetDataFull 

func DatalistIdSetDataFull(DatalistVar **Data, KeyIdVar Quark, DataVar uintptr, DestroyFuncVar *DestroyNotify)

Sets the data corresponding to the given #GQuark id, and the function to be called when the element is removed from the datalist. Any previous data with the same key is removed, and its destroy function is called.

func DatalistInit 

func DatalistInit(DatalistVar **Data)

Resets the datalist to %NULL. It does not free any memory or call any destroy functions.

func DatalistSetFlags 

func DatalistSetFlags(DatalistVar **Data, FlagsVar uint)

Turns on flag values for a data list. This function is used to keep a small number of boolean flags in an object with a data list without using any additional space. It is not generally useful except in circumstances where space is very tight. (It is used in the base #GObject type, for example.)

func DatalistUnsetFlags 

func DatalistUnsetFlags(DatalistVar **Data, FlagsVar uint)

Turns off flag values for a data list. See g_datalist_unset_flags()

func DatasetDestroy 

func DatasetDestroy(DatasetLocationVar uintptr)

Destroys the dataset, freeing all memory allocated, and calling any destroy functions set for data elements.

func DatasetForeach 

func DatasetForeach(DatasetLocationVar uintptr, FuncVar *DataForeachFunc, UserDataVar uintptr)

Calls the given function for each data element which is associated with the given location. Note that this function is NOT thread-safe. So unless @dataset_location can be protected from any modifications during invocation of this function, it should not be called.

@func can make changes to the dataset, but the iteration will not reflect changes made during the g_dataset_foreach() call, other than skipping over elements that are removed.

func DatasetIdGetData 

func DatasetIdGetData(DatasetLocationVar uintptr, KeyIdVar Quark) uintptr

Gets the data element corresponding to a #GQuark.

func DatasetIdRemoveNoNotify 

func DatasetIdRemoveNoNotify(DatasetLocationVar uintptr, KeyIdVar Quark) uintptr

Removes an element, without calling its destroy notification function.

func DatasetIdSetDataFull 

func DatasetIdSetDataFull(DatasetLocationVar uintptr, KeyIdVar Quark, DataVar uintptr, DestroyFuncVar *DestroyNotify)

Sets the data element associated with the given #GQuark id, and also the function to call when the data element is destroyed. Any previous data with the same key is removed, and its destroy function is called.

func DateGLibType 

func DateGLibType() types.GType

func DateGetDaysInMonth 

func DateGetDaysInMonth(MonthVar DateMonth, YearVar DateYear) byte

Returns the number of days in a month, taking leap years into account.

func DateGetMondayWeeksInYear 

func DateGetMondayWeeksInYear(YearVar DateYear) byte

Returns the number of weeks in the year, where weeks are taken to start on Monday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap year. This function is basically telling you how many Mondays are in the year, i.e. there are 53 Mondays if one of the extra days happens to be a Monday.)

func DateGetSundayWeeksInYear 

func DateGetSundayWeeksInYear(YearVar DateYear) byte

Returns the number of weeks in the year, where weeks are taken to start on Sunday. Will be 52 or 53. The date must be valid. (Years always have 52 7-day periods, plus 1 or 2 extra days depending on whether it's a leap year. This function is basically telling you how many Sundays are in the year, i.e. there are 53 Sundays if one of the extra days happens to be a Sunday.)

func DateGetWeeksInYear 

func DateGetWeeksInYear(YearVar DateYear, FirstDayOfWeekVar DateWeekday) byte

Calculates the number of weeks in the year.

The result depends on which day is considered the first day of the week, which varies by locale. `first_day_of_week` must be valid.

The result will be either 52 or 53. Years always have 52 seven-day periods, plus one or two extra days depending on whether it’s a leap year. This function effectively calculates how many @first_day_of_week days there are in the year.

func DateIsLeapYear 

func DateIsLeapYear(YearVar DateYear) bool

Returns %TRUE if the year is a leap year.

For the purposes of this function, leap year is every year divisible by 4 unless that year is divisible by 100. If it is divisible by 100 it would be a leap year only if that year is also divisible by 400.

func DateStrftime 

func DateStrftime(SVar string, SlenVar uint, FormatVar string, DateVar *Date) uint

Generates a printed representation of the date, in a [locale](running.html#locale)-specific way. Works just like the platform's C library strftime() function, but only accepts date-related formats; time-related formats give undefined results. Date must be valid. Unlike strftime() (which uses the locale encoding), works on a UTF-8 format string and stores a UTF-8 result.

This function does not provide any conversion specifiers in addition to those implemented by the platform's C library. For example, don't expect that using g_date_strftime() would make the \%F provided by the C99 strftime() work on Windows where the C library only complies to C89.

func DateTimeGLibType 

func DateTimeGLibType() types.GType

func DateValidDay 

func DateValidDay(DayVar DateDay) bool

Returns %TRUE if the day of the month is valid (a day is valid if it's between 1 and 31 inclusive).

func DateValidDmy 

func DateValidDmy(DayVar DateDay, MonthVar DateMonth, YearVar DateYear) bool

Returns %TRUE if the day-month-year triplet forms a valid, existing day in the range of days #GDate understands (Year 1 or later, no more than a few thousand years in the future).

func DateValidJulian 

func DateValidJulian(JulianDateVar uint32) bool

Returns %TRUE if the Julian day is valid. Anything greater than zero is basically a valid Julian, though there is a 32-bit limit.

func DateValidMonth 

func DateValidMonth(MonthVar DateMonth) bool

Returns %TRUE if the month value is valid. The 12 #GDateMonth enumeration values are the only valid months.

func DateValidWeekday 

func DateValidWeekday(WeekdayVar DateWeekday) bool

Returns %TRUE if the weekday is valid. The seven #GDateWeekday enumeration values are the only valid weekdays.

func DateValidYear 

func DateValidYear(YearVar DateYear) bool

Returns %TRUE if the year is valid. Any year greater than 0 is valid, though there is a 16-bit limit to what #GDate will understand.

func Dcgettext 

func Dcgettext(DomainVar *string, MsgidVar string, CategoryVar int) string

This is a variant of g_dgettext() that allows specifying a locale category instead of always using `LC_MESSAGES`. See g_dgettext() for more information about how this functions differs from calling dcgettext() directly.

func Dgettext 

func Dgettext(DomainVar *string, MsgidVar string) string

This function is a wrapper of dgettext() which does not translate the message if the default domain as set with textdomain() has no translations for the current locale.

The advantage of using this function over dgettext() proper is that libraries using this function (like GTK) will not use translations if the application using the library does not have translations for the current locale. This results in a consistent English-only interface instead of one having partial translations. For this feature to work, the call to textdomain() and setlocale() should precede any g_dgettext() invocations. For GTK, it means calling textdomain() before gtk_init or its variants.

This function disables translations if and only if upon its first call all the following conditions hold:

- @domain is not %NULL

- textdomain() has been called to set a default text domain

  • there is no translations available for the default text domain and the current locale

  • current locale is not "C" or any English locales (those starting with "en_")

Note that this behavior may not be desired for example if an application has its untranslated messages in a language other than English. In those cases the application should call textdomain() after initializing GTK.

Applications should normally not use this function directly, but use the _() macro for translations.

func DirGLibType 

func DirGLibType() types.GType

func DirMakeTmp 

func DirMakeTmp(TmplVar *string) (string, error)

Creates a subdirectory in the preferred directory for temporary files (as returned by g_get_tmp_dir()).

@tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, as the parameter to g_mkstemp(). However, unlike these functions, the template should only be a basename, no directory components are allowed. If template is %NULL, a default template is used.

Note that in contrast to g_mkdtemp() (and mkdtemp()) @tmpl is not modified, and might thus be a read-only literal string.

func DirectEqual 

func DirectEqual(V1Var uintptr, V2Var uintptr) bool

Compares two #gpointer arguments and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using opaque pointers compared by pointer value as keys in a #GHashTable.

This equality function is also appropriate for keys that are integers stored in pointers, such as `GINT_TO_POINTER (n)`.

func DirectHash 

func DirectHash(VVar uintptr) uint

Converts a gpointer to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using opaque pointers compared by pointer value as keys in a #GHashTable.

This hash function is also appropriate for keys that are integers stored in pointers, such as `GINT_TO_POINTER (n)`.

func Dngettext 

func Dngettext(DomainVar *string, MsgidVar string, MsgidPluralVar string, NVar uint) string

This function is a wrapper of dngettext() which does not translate the message if the default domain as set with textdomain() has no translations for the current locale.

See g_dgettext() for details of how this differs from dngettext() proper.

func DoubleEqual 

func DoubleEqual(V1Var uintptr, V2Var uintptr) bool

Compares the two #gdouble values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to doubles as keys in a #GHashTable.

func DoubleHash 

func DoubleHash(VVar uintptr) uint

Converts a pointer to a #gdouble to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to doubles as keys in a #GHashTable.

func Dpgettext 

func Dpgettext(DomainVar *string, MsgctxtidVar string, MsgidoffsetVar uint) string

This function is a variant of g_dgettext() which supports a disambiguating message context. GNU gettext uses the '\004' character to separate the message context and message id in @msgctxtid. If 0 is passed as @msgidoffset, this function will fall back to trying to use the deprecated convention of using "|" as a separation character.

This uses g_dgettext() internally. See that functions for differences with dgettext() proper.

Applications should normally not use this function directly, but use the C_() macro for translations with context.

func Dpgettext2 

func Dpgettext2(DomainVar *string, ContextVar string, MsgidVar string) string

This function is a variant of g_dgettext() which supports a disambiguating message context. GNU gettext uses the '\004' character to separate the message context and message id in @msgctxtid.

This uses g_dgettext() internally. See that functions for differences with dgettext() proper.

This function differs from C_() in that it is not a macro and thus you may use non-string-literals as context and msgid arguments.

func EnvironGetenv 

func EnvironGetenv(EnvpVar []string, VariableVar string) string

Returns the value of the environment variable @variable in the provided list @envp.

func EnvironSetenv 

func EnvironSetenv(EnvpVar []string, VariableVar string, ValueVar string, OverwriteVar bool) []string

Sets the environment variable @variable in the provided list @envp to @value.

func EnvironUnsetenv 

func EnvironUnsetenv(EnvpVar []string, VariableVar string) []string

Removes the environment variable @variable from the provided environment @envp.

func ErrorGLibType 

func ErrorGLibType() types.GType

func FileGetContents 

func FileGetContents(FilenameVar string, ContentsVar *[]byte, LengthVar *uint) (bool, error)

Reads an entire file into allocated memory, with good error checking.

If the call was successful, it returns %TRUE and sets @contents to the file contents and @length to the length of the file contents in bytes. The string stored in @contents will be nul-terminated, so for text files you can pass %NULL for the @length argument. If the call was not successful, it returns %FALSE and sets @error. The error domain is %G_FILE_ERROR. Possible error codes are those in the #GFileError enumeration. In the error case, @contents is set to %NULL and @length is set to zero.

func FileOpenTmp 

func FileOpenTmp(TmplVar *string, NameUsedVar *string) (int, error)

Opens a file for writing in the preferred directory for temporary files (as returned by g_get_tmp_dir()).

@tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, as the parameter to g_mkstemp(). However, unlike these functions, the template should only be a basename, no directory components are allowed. If template is %NULL, a default template is used.

Note that in contrast to g_mkstemp() (and mkstemp()) @tmpl is not modified, and might thus be a read-only literal string.

Upon success, and if @name_used is non-%NULL, the actual name used is returned in @name_used. This string should be freed with g_free() when not needed any longer. The returned name is in the GLib file name encoding. 

func FileReadLink(FilenameVar string) (string, error)

Reads the contents of the symbolic link @filename like the POSIX `readlink()` function.

The returned string is in the encoding used for filenames. Use g_filename_to_utf8() to convert it to UTF-8.

The returned string may also be a relative path. Use g_build_filename() to convert it to an absolute path:

|[&lt;!-- language="C" --&gt; g_autoptr(GError) local_error = NULL; g_autofree gchar *link_target = g_file_read_link ("/etc/localtime", &amp;local_error);

if (local_error != NULL) 

g_error ("Error reading link: %s", local_error-&gt;message);

if (!g_path_is_absolute (link_target)) 

{
  g_autofree gchar *absolute_link_target = g_build_filename ("/etc", link_target, NULL);
  g_free (link_target);
  link_target = g_steal_pointer (&amp;absolute_link_target);
}

]|

func FileSetContents 

func FileSetContents(FilenameVar string, ContentsVar []byte, LengthVar int) (bool, error)

Writes all of @contents to a file named @filename. This is a convenience wrapper around calling g_file_set_contents_full() with `flags` set to `G_FILE_SET_CONTENTS_CONSISTENT | G_FILE_SET_CONTENTS_ONLY_EXISTING` and `mode` set to `0666`.

func FileSetContentsFull 

func FileSetContentsFull(FilenameVar string, ContentsVar []byte, LengthVar int, FlagsVar FileSetContentsFlags, ModeVar int) (bool, error)

Writes all of @contents to a file named @filename, with good error checking. If a file called @filename already exists it will be overwritten.

@flags control the properties of the write operation: whether it’s atomic, and what the tradeoff is between returning quickly or being resilient to system crashes.

As this function performs file I/O, it is recommended to not call it anywhere where blocking would cause problems, such as in the main loop of a graphical application. In particular, if @flags has any value other than %G_FILE_SET_CONTENTS_NONE then this function may call `fsync()`.

If %G_FILE_SET_CONTENTS_CONSISTENT is set in @flags, the operation is atomic in the sense that it is first written to a temporary file which is then renamed to the final name.

Notes:

  • On UNIX, if @filename already exists hard links to @filename will break. Also since the file is recreated, existing permissions, access control lists, metadata etc. may be lost. If @filename is a symbolic link, the link itself will be replaced, not the linked file.

  • On UNIX, if @filename already exists and is non-empty, and if the system supports it (via a journalling filesystem or equivalent), and if %G_FILE_SET_CONTENTS_CONSISTENT is set in @flags, the `fsync()` call (or equivalent) will be used to ensure atomic replacement: @filename will contain either its old contents or @contents, even in the face of system power loss, the disk being unsafely removed, etc.

  • On UNIX, if @filename does not already exist or is empty, there is a possibility that system power loss etc. after calling this function will leave @filename empty or full of NUL bytes, depending on the underlying filesystem, unless %G_FILE_SET_CONTENTS_DURABLE and %G_FILE_SET_CONTENTS_CONSISTENT are set in @flags.

  • On Windows renaming a file will not remove an existing file with the new name, so on Windows there is a race condition between the existing file being removed and the temporary file being renamed.

  • On Windows there is no way to remove a file that is open to some process, or mapped into memory. Thus, this function will fail if @filename already exists and is open.

If the call was successful, it returns %TRUE. If the call was not successful, it returns %FALSE and sets @error. The error domain is %G_FILE_ERROR. Possible error codes are those in the #GFileError enumeration.

Note that the name for the temporary file is constructed by appending up to 7 characters to @filename.

If the file didn’t exist before and is created, it will be given the permissions from @mode. Otherwise, the permissions of the existing file will remain unchanged.

func FilenameDisplayBasename 

func FilenameDisplayBasename(FilenameVar string) string

Returns the display basename for the particular filename, guaranteed to be valid UTF-8. The display name might not be identical to the filename, for instance there might be problems converting it to UTF-8, and some files can be translated in the display.

If GLib cannot make sense of the encoding of @filename, as a last resort it replaces unknown characters with U+FFFD, the Unicode replacement character. You can search the result for the UTF-8 encoding of this character (which is "\357\277\275" in octal notation) to find out if @filename was in an invalid encoding.

You must pass the whole absolute pathname to this functions so that translation of well known locations can be done.

This function is preferred over g_filename_display_name() if you know the whole path, as it allows translation.

func FilenameDisplayName 

func FilenameDisplayName(FilenameVar string) string

Converts a filename into a valid UTF-8 string. The conversion is not necessarily reversible, so you should keep the original around and use the return value of this function only for display purposes. Unlike g_filename_to_utf8(), the result is guaranteed to be non-%NULL even if the filename actually isn't in the GLib file name encoding.

If GLib cannot make sense of the encoding of @filename, as a last resort it replaces unknown characters with U+FFFD, the Unicode replacement character. You can search the result for the UTF-8 encoding of this character (which is "\357\277\275" in octal notation) to find out if @filename was in an invalid encoding.

If you know the whole pathname of the file you should use g_filename_display_basename(), since that allows location-based translation of filenames.

func FilenameFromUri 

func FilenameFromUri(UriVar string, HostnameVar *string) (string, error)

Converts an escaped ASCII-encoded URI to a local filename in the encoding used for filenames.

Since GLib 2.78, the query string and fragment can be present in the URI, but are not part of the resulting filename. We take inspiration from https://url.spec.whatwg.org/#file-state, but we don't support the entire standard.

func FilenameFromUtf8 

func FilenameFromUtf8(Utf8stringVar string, LenVar int, BytesReadVar *uint, BytesWrittenVar *uint) (string, error)

Converts a string from UTF-8 to the encoding GLib uses for filenames. Note that on Windows GLib uses UTF-8 for filenames; on other platforms, this function indirectly depends on the [current locale](running.html#locale).

The input string shall not contain nul characters even if the @len argument is positive. A nul character found inside the string will result in error %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. If the filename encoding is not UTF-8 and the conversion output contains a nul character, the error %G_CONVERT_ERROR_EMBEDDED_NUL is set and the function returns %NULL.

func FilenameToUri 

func FilenameToUri(FilenameVar string, HostnameVar *string) (string, error)

Converts an absolute filename to an escaped ASCII-encoded URI, with the path component following Section 3.3. of RFC 2396.

func FilenameToUtf8 

func FilenameToUtf8(OpsysstringVar string, LenVar int, BytesReadVar *uint, BytesWrittenVar *uint) (string, error)

Converts a string which is in the encoding used by GLib for filenames into a UTF-8 string. Note that on Windows GLib uses UTF-8 for filenames; on other platforms, this function indirectly depends on the [current locale](running.html#locale).

The input string shall not contain nul characters even if the @len argument is positive. A nul character found inside the string will result in error %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. If the source encoding is not UTF-8 and the conversion output contains a nul character, the error %G_CONVERT_ERROR_EMBEDDED_NUL is set and the function returns %NULL. Use g_convert() to produce output that may contain embedded nul characters.

func FindProgramInPath 

func FindProgramInPath(ProgramVar string) string

Locates the first executable named @program in the user's path, in the same way that execvp() would locate it. Returns an allocated string with the absolute path name, or %NULL if the program is not found in the path. If @program is already an absolute path, returns a copy of @program if @program exists and is executable, and %NULL otherwise.

On Windows, if @program does not have a file type suffix, tries with the suffixes .exe, .cmd, .bat and .com, and the suffixes in the `PATHEXT` environment variable.

On Windows, it looks for the file in the same way as CreateProcess() would. This means first in the directory where the executing program was loaded from, then in the current directory, then in the Windows 32-bit system directory, then in the Windows directory, and finally in the directories in the `PATH` environment variable. If the program is found, the return value contains the full name including the type suffix.

func Fopen 

func Fopen(FilenameVar string, ModeVar string) uintptr

A wrapper for the stdio `fopen()` function. The `fopen()` function opens a file and associates a new stream with it.

Because file descriptors are specific to the C library on Windows, and a file descriptor is part of the `FILE` struct, the `FILE*` returned by this function makes sense only to functions in the same C library. Thus if the GLib-using code uses a different C library than GLib does, the FILE* returned by this function cannot be passed to C library functions like `fprintf()` or `fread()`.

See your C library manual for more details about `fopen()`.

As `close()` and `fclose()` are part of the C library, this implies that it is currently impossible to close a file if the application C library and the C library used by GLib are different. Convenience functions like g_file_set_contents_full() avoid this problem.

Since GLib 2.86, the `e` option is supported in @mode on all platforms. On Unix platforms it will set `O_CLOEXEC` on the opened file descriptor. On Windows platforms it will be converted to the [`N` modifier](https://learn.microsoft.com/en-us/cpp/c-runtime-library/reference/fopen-wfopen?view=msvc-170). It is recommended to set `e` unconditionally, unless you know the returned file should be shared between this process and a new fork.

func FormatSize 

func FormatSize(SizeVar uint64) string

Formats a size (for example the size of a file) into a human readable string. Sizes are rounded to the nearest size prefix (kB, MB, GB) and are displayed rounded to the nearest tenth. E.g. the file size 3292528 bytes will be converted into the string "3.2 MB". The returned string is UTF-8, and may use a non-breaking space to separate the number and units, to ensure they aren’t separated when line wrapped.

The prefix units base is 1000 (i.e. 1 kB is 1000 bytes).

This string should be freed with g_free() when not needed any longer.

See g_format_size_full() for more options about how the size might be formatted.

func FormatSizeForDisplay 

func FormatSizeForDisplay(SizeVar int64) string

Formats a size (for example the size of a file) into a human readable string. Sizes are rounded to the nearest size prefix (KB, MB, GB) and are displayed rounded to the nearest tenth. E.g. the file size 3292528 bytes will be converted into the string "3.1 MB".

The prefix units base is 1024 (i.e. 1 KB is 1024 bytes).

This string should be freed with g_free() when not needed any longer.

func FormatSizeFull 

func FormatSizeFull(SizeVar uint64, FlagsVar FormatSizeFlags) string

Formats a size.

This function is similar to g_format_size() but allows for flags that modify the output. See #GFormatSizeFlags.

func Fprintf 

func Fprintf(FileVar uintptr, FormatVar string, varArgs ...interface{}) int

An implementation of the standard `fprintf()` function which supports positional parameters, as specified in the Single Unix Specification.

`glib/gprintf.h` must be explicitly included in order to use this function.

func Free 

func Free(MemVar uintptr)

Frees the memory pointed to by @mem.

If you know the allocated size of @mem, calling g_free_sized() may be faster, depending on the libc implementation in use.

Starting from GLib 2.78, this may happen automatically in case a GCC compatible compiler is used with some optimization level and the allocated size is known at compile time (see [documentation of `__builtin_object_size()`](https://gcc.gnu.org/onlinedocs/gcc/Object-Size-Checking.html) to understand its caveats).

If @mem is %NULL it simply returns, so there is no need to check @mem against %NULL before calling this function.

func FreeSized 

func FreeSized(MemVar uintptr, SizeVar uint)

Frees the memory pointed to by @mem, assuming it is has the given @size.

If @mem is %NULL this is a no-op (and @size is ignored).

It is an error if @size doesn’t match the size passed when @mem was allocated. @size is passed to this function to allow optimizations in the allocator. If you don’t know the allocation size, use g_free() instead.

In case a GCC compatible compiler is used, this function may be used automatically via g_free() if the allocated size is known at compile time, since GLib 2.78.

func Freopen 

func Freopen(FilenameVar string, ModeVar string, StreamVar uintptr) uintptr

A wrapper for the POSIX freopen() function. The freopen() function opens a file and associates it with an existing stream.

See your C library manual for more details about freopen().

Since GLib 2.86, the `e` option is supported in @mode on all platforms. See the documentation for [func@GLib.fopen] for more details.

func Fsync 

func Fsync(FdVar int) int

A wrapper for the POSIX `fsync()` function. On Windows, `_commit()` will be used. On macOS, `fcntl(F_FULLFSYNC)` will be used. The `fsync()` function is used to synchronize a file's in-core state with that of the disk.

This wrapper will handle retrying on `EINTR`.

See the C library manual for more details about fsync().

func GetApplicationName 

func GetApplicationName() string

Gets a human-readable name for the application, as set by g_set_application_name(). This name should be localized if possible, and is intended for display to the user. Contrast with g_get_prgname(), which gets a non-localized name. If g_set_application_name() has not been called, returns the result of g_get_prgname() (which may be %NULL if g_set_prgname() has also not been called).

func GetCallback 

func GetCallback(cbPtr uintptr) (uintptr, bool)

GetCallback retrives a callback reference by value. Users should not need to call this.

func GetCharset 

func GetCharset(CharsetVar *string) bool

Obtains the character set for the [current locale](running.html#locale); you might use this character set as an argument to g_convert(), to convert from the current locale's encoding to some other encoding. (Frequently g_locale_to_utf8() and g_locale_from_utf8() are nice shortcuts, though.)

On Windows the character set returned by this function is the so-called system default ANSI code-page. That is the character set used by the "narrow" versions of C library and Win32 functions that handle file names. It might be different from the character set used by the C library's current locale.

On Linux, the character set is found by consulting nl_langinfo() if available. If not, the environment variables `LC_ALL`, `LC_CTYPE`, `LANG` and `CHARSET` are queried in order. nl_langinfo() returns the C locale if no locale has been loaded by setlocale().

The return value is %TRUE if the locale's encoding is UTF-8, in that case you can perhaps avoid calling g_convert().

The string returned in @charset is not allocated, and should not be freed.

func GetCodeset 

func GetCodeset() string

Gets the character set for the current locale.

func GetConsoleCharset 

func GetConsoleCharset(CharsetVar *string) bool

Obtains the character set used by the console attached to the process, which is suitable for printing output to the terminal.

Usually this matches the result returned by g_get_charset(), but in environments where the locale's character set does not match the encoding of the console this function tries to guess a more suitable value instead.

On Windows the character set returned by this function is the output code page used by the console associated with the calling process. If the codepage can't be determined (for example because there is no console attached) UTF-8 is assumed.

The return value is %TRUE if the locale's encoding is UTF-8, in that case you can perhaps avoid calling g_convert().

The string returned in @charset is not allocated, and should not be freed.

func GetCurrentDir 

func GetCurrentDir() string

Gets the current directory.

The returned string should be freed when no longer needed. The encoding of the returned string is system defined. On Windows, it is always UTF-8.

Since GLib 2.40, this function will return the value of the "PWD" environment variable if it is set and it happens to be the same as the current directory. This can make a difference in the case that the current directory is the target of a symbolic link.

func GetCurrentTime 

func GetCurrentTime(ResultVar *TimeVal)

Queries the system wall-clock time.

This is equivalent to the UNIX [`gettimeofday()`](man:gettimeofday(2)) function, but portable.

You may find [func@GLib.get_real_time] to be more convenient.

func GetEnviron 

func GetEnviron() []string

Gets the list of environment variables for the current process.

The list is %NULL terminated and each item in the list is of the form 'NAME=VALUE'.

This is equivalent to direct access to the 'environ' global variable, except portable.

The return value is freshly allocated and it should be freed with g_strfreev() when it is no longer needed.

func GetFilenameCharsets 

func GetFilenameCharsets(FilenameCharsetsVar *[]string) bool

Determines the preferred character sets used for filenames. The first character set from the @charsets is the filename encoding, the subsequent character sets are used when trying to generate a displayable representation of a filename, see g_filename_display_name().

On Unix, the character sets are determined by consulting the environment variables `G_FILENAME_ENCODING` and `G_BROKEN_FILENAMES`. On Windows, the character set used in the GLib API is always UTF-8 and said environment variables have no effect.

`G_FILENAME_ENCODING` may be set to a comma-separated list of character set names. The special token `@locale` is taken to mean the character set for the [current locale](running.html#locale). If `G_FILENAME_ENCODING` is not set, but `G_BROKEN_FILENAMES` is, the character set of the current locale is taken as the filename encoding. If neither environment variable is set, UTF-8 is taken as the filename encoding, but the character set of the current locale is also put in the list of encodings.

The returned @charsets belong to GLib and must not be freed.

Note that on Unix, regardless of the locale character set or `G_FILENAME_ENCODING` value, the actual file names present on a system might be in any random encoding or just gibberish.

func GetHomeDir 

func GetHomeDir() string

Gets the current user's home directory.

As with most UNIX tools, this function will return the value of the `HOME` environment variable if it is set to an existing absolute path name, falling back to the `passwd` file in the case that it is unset.

If the path given in `HOME` is non-absolute, does not exist, or is not a directory, the result is undefined.

Before version 2.36 this function would ignore the `HOME` environment variable, taking the value from the `passwd` database instead. This was changed to increase the compatibility of GLib with other programs (and the XDG basedir specification) and to increase testability of programs based on GLib (by making it easier to run them from test frameworks).

If your program has a strong requirement for either the new or the old behaviour (and if you don't wish to increase your GLib dependency to ensure that the new behaviour is in effect) then you should either directly check the `HOME` environment variable yourself or unset it before calling any functions in GLib.

func GetHostName 

func GetHostName() string

Return a name for the machine.

The returned name is not necessarily a fully-qualified domain name, or even present in DNS or some other name service at all. It need not even be unique on your local network or site, but usually it is. Callers should not rely on the return value having any specific properties like uniqueness for security purposes. Even if the name of the machine is changed while an application is running, the return value from this function does not change. The returned string is owned by GLib and should not be modified or freed. If no name can be determined, a default fixed string "localhost" is returned.

The encoding of the returned string is UTF-8.

func GetLanguageNames 

func GetLanguageNames() []string

Computes a list of applicable locale names, which can be used to e.g. construct locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable and always contains the default locale "C".

For example, if LANGUAGE=de:en_US, then the returned list is "de", "en_US", "en", "C".

This function consults the environment variables `LANGUAGE`, `LC_ALL`, `LC_MESSAGES` and `LANG` to find the list of locales specified by the user.

func GetLanguageNamesWithCategory 

func GetLanguageNamesWithCategory(CategoryNameVar string) []string

Computes a list of applicable locale names with a locale category name, which can be used to construct the fallback locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable and always contains the default locale "C".

This function consults the environment variables `LANGUAGE`, `LC_ALL`, @category_name, and `LANG` to find the list of locales specified by the user.

g_get_language_names() returns g_get_language_names_with_category("LC_MESSAGES").

func GetLocaleVariants 

func GetLocaleVariants(LocaleVar string) []string

Returns a list of derived variants of @locale, which can be used to e.g. construct locale-dependent filenames or search paths. The returned list is sorted from most desirable to least desirable. This function handles territory, charset and extra locale modifiers. See [`setlocale(3)`](man:setlocale) for information about locales and their format.

@locale itself is guaranteed to be returned in the output.

For example, if @locale is `fr_BE`, then the returned list is `fr_BE`, `fr`. If @locale is `en_GB.UTF-8@euro`, then the returned list is `en_GB.UTF-8@euro`, `en_GB.UTF-8`, `en_GB@euro`, `en_GB`, `en.UTF-8@euro`, `en.UTF-8`, `en@euro`, `en`.

If you need the list of variants for the current locale, use g_get_language_names().

func GetMonotonicTime 

func GetMonotonicTime() int64

Queries the system monotonic time in microseconds.

The monotonic clock will always increase and doesn’t suffer discontinuities when the user (or NTP) changes the system time. It may or may not continue to tick during times where the machine is suspended.

We try to use the clock that corresponds as closely as possible to the passage of time as measured by system calls such as [`poll()`](man:poll(2)) but it may not always be possible to do this.

A more accurate version of this function exists. [func@GLib.get_monotonic_time_ns] returns the time in nanoseconds.

func GetMonotonicTimeNs added in v0.5.0 

func GetMonotonicTimeNs() uint64

Queries the system monotonic time in nanoseconds.

The monotonic clock will always increase and doesn’t suffer discontinuities when the user (or NTP) changes the system time. It may or may not continue to tick during times where the machine is suspended.

We try to use the clock that corresponds as closely as possible to the passage of time as measured by system calls such as [`poll()`](man:poll(2)) but it may not always be possible to do this.

Another version of this function exists. [func@GLib.get_monotonic_time] returns the time in microseconds. If you want to support older GLib versions, it is an alternative.

func GetNumProcessors 

func GetNumProcessors() uint

Determine the approximate number of threads that the system will schedule simultaneously for this process. This is intended to be used as a parameter to g_thread_pool_new() for CPU bound tasks and similar cases.

func GetOsInfo 

func GetOsInfo(KeyNameVar string) string

Get information about the operating system.

On Linux this comes from the `/etc/os-release` file. On other systems, it may come from a variety of sources. You can either use the standard key names like %G_OS_INFO_KEY_NAME or pass any UTF-8 string key name. For example, `/etc/os-release` provides a number of other less commonly used values that may be useful. No key is guaranteed to be provided, so the caller should always check if the result is %NULL.

func GetPrgname 

func GetPrgname() string

Gets the name of the program. This name should not be localized, in contrast to g_get_application_name().

If you are using #GApplication the program name is set in g_application_run(). In case of GDK or GTK it is set in gdk_init(), which is called by gtk_init() and the #GtkApplication::startup handler. The program name is found by taking the last component of @argv[0].

func GetRealName 

func GetRealName() string

Gets the real name of the user. This usually comes from the user's entry in the `passwd` file. The encoding of the returned string is system-defined. (On Windows, it is, however, always UTF-8.) If the real user name cannot be determined, the string "Unknown" is returned.

func GetRealTime 

func GetRealTime() int64

Queries the system wall-clock time.

This is equivalent to the UNIX [`gettimeofday()`](man:gettimeofday(2)) function, but portable.

You should only use this call if you are actually interested in the real wall-clock time. [func@GLib.get_monotonic_time] is probably more useful for measuring intervals.

func GetSystemConfigDirs 

func GetSystemConfigDirs() []string

Returns an ordered list of base directories in which to access system-wide configuration information.

On UNIX platforms this is determined using the mechanisms described in the [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). In this case the list of directories retrieved will be `XDG_CONFIG_DIRS`.

On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_DIRS` is defined. If `XDG_CONFIG_DIRS` is undefined, the directory that contains application data for all users is used instead. A typical path is `C:\Documents and Settings\All Users\Application Data`. This folder is used for application data that is not user specific. For example, an application can store a spell-check dictionary, a database of clip art, or a log file in the FOLDERID_ProgramData folder. This information will not roam and is available to anyone using the computer.

The return value is cached and modifying it at runtime is not supported, as it’s not thread-safe to modify environment variables at runtime.

func GetSystemDataDirs 

func GetSystemDataDirs() []string

Returns an ordered list of base directories in which to access system-wide application data.

On UNIX platforms this is determined using the mechanisms described in the [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec) In this case the list of directories retrieved will be `XDG_DATA_DIRS`.

On Windows it follows XDG Base Directory Specification if `XDG_DATA_DIRS` is defined. If `XDG_DATA_DIRS` is undefined, the first elements in the list are the Application Data and Documents folders for All Users. (These can be determined only on Windows 2000 or later and are not present in the list on other Windows versions.) See documentation for FOLDERID_ProgramData and FOLDERID_PublicDocuments.

Then follows the "share" subfolder in the installation folder for the package containing the DLL that calls this function, if it can be determined.

Finally the list contains the "share" subfolder in the installation folder for GLib, and in the installation folder for the package the application's .exe file belongs to.

The installation folders above are determined by looking up the folder where the module (DLL or EXE) in question is located. If the folder's name is "bin", its parent is used, otherwise the folder itself.

Note that on Windows the returned list can vary depending on where this function is called.

The return value is cached and modifying it at runtime is not supported, as it’s not thread-safe to modify environment variables at runtime.

func GetTmpDir 

func GetTmpDir() string

Gets the directory to use for temporary files.

On UNIX, this is taken from the `TMPDIR` environment variable. If the variable is not set, `P_tmpdir` is used, as defined by the system C library. Failing that, a hard-coded default of "/tmp" is returned.

On Windows, the `TEMP` environment variable is used, with the root directory of the Windows installation (eg: "C:\") used as a default.

The encoding of the returned string is system-defined. On Windows, it is always UTF-8. The return value is never %NULL or the empty string.

func GetUserCacheDir 

func GetUserCacheDir() string

Returns a base directory in which to store non-essential, cached data specific to particular user.

On UNIX platforms this is determined using the mechanisms described in the [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). In this case the directory retrieved will be `XDG_CACHE_HOME`.

On Windows it follows XDG Base Directory Specification if `XDG_CACHE_HOME` is defined. If `XDG_CACHE_HOME` is undefined, the directory that serves as a common repository for temporary Internet files is used instead. A typical path is `C:\Documents and Settings\username\Local Settings\Temporary Internet Files`. See the [documentation for `FOLDERID_InternetCache`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid).

The return value is cached and modifying it at runtime is not supported, as it’s not thread-safe to modify environment variables at runtime.

func GetUserConfigDir 

func GetUserConfigDir() string

Returns a base directory in which to store user-specific application configuration information such as user preferences and settings.

On UNIX platforms this is determined using the mechanisms described in the [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). In this case the directory retrieved will be `XDG_CONFIG_HOME`.

On Windows it follows XDG Base Directory Specification if `XDG_CONFIG_HOME` is defined. If `XDG_CONFIG_HOME` is undefined, the folder to use for local (as opposed to roaming) application data is used instead. See the [documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid). Note that in this case on Windows it will be the same as what g_get_user_data_dir() returns.

The return value is cached and modifying it at runtime is not supported, as it’s not thread-safe to modify environment variables at runtime.

func GetUserDataDir 

func GetUserDataDir() string

Returns a base directory in which to access application data such as icons that is customized for a particular user.

On UNIX platforms this is determined using the mechanisms described in the [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). In this case the directory retrieved will be `XDG_DATA_HOME`.

On Windows it follows XDG Base Directory Specification if `XDG_DATA_HOME` is defined. If `XDG_DATA_HOME` is undefined, the folder to use for local (as opposed to roaming) application data is used instead. See the [documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid). Note that in this case on Windows it will be the same as what g_get_user_config_dir() returns.

The return value is cached and modifying it at runtime is not supported, as it’s not thread-safe to modify environment variables at runtime.

func GetUserName 

func GetUserName() string

Gets the user name of the current user. The encoding of the returned string is system-defined. On UNIX, it might be the preferred file name encoding, or something else, and there is no guarantee that it is even consistent on a machine. On Windows, it is always UTF-8.

func GetUserRuntimeDir 

func GetUserRuntimeDir() string

Returns a directory that is unique to the current user on the local system.

This is determined using the mechanisms described in the [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). This is the directory specified in the `XDG_RUNTIME_DIR` environment variable. In the case that this variable is not set, we return the value of g_get_user_cache_dir(), after verifying that it exists.

The return value is cached and modifying it at runtime is not supported, as it’s not thread-safe to modify environment variables at runtime.

func GetUserSpecialDir 

func GetUserSpecialDir(DirectoryVar UserDirectory) string

Returns the full path of a special directory using its logical id.

On UNIX this is done using the XDG special user directories. For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP falls back to `$HOME/Desktop` when XDG special user directories have not been set up.

Depending on the platform, the user might be able to change the path of the special directory without requiring the session to restart; GLib will not reflect any change once the special directories are loaded.

func GetUserStateDir 

func GetUserStateDir() string

Returns a base directory in which to store state files specific to particular user.

On UNIX platforms this is determined using the mechanisms described in the [XDG Base Directory Specification](http://www.freedesktop.org/Standards/basedir-spec). In this case the directory retrieved will be `XDG_STATE_HOME`.

On Windows it follows XDG Base Directory Specification if `XDG_STATE_HOME` is defined. If `XDG_STATE_HOME` is undefined, the folder to use for local (as opposed to roaming) application data is used instead. See the [documentation for `FOLDERID_LocalAppData`](https://docs.microsoft.com/en-us/windows/win32/shell/knownfolderid). Note that in this case on Windows it will be the same as what g_get_user_data_dir() returns.

The return value is cached and modifying it at runtime is not supported, as it’s not thread-safe to modify environment variables at runtime.

func Getenv 

func Getenv(VariableVar string) string

Returns the value of an environment variable.

On UNIX, the name and value are byte strings which might or might not be in some consistent character set and encoding. On Windows, they are in UTF-8. On Windows, in case the environment variable's value contains references to other environment variables, they are expanded.

func HashTableAdd 

func HashTableAdd(HashTableVar *HashTable, KeyVar uintptr) bool

This is a convenience function for using a #GHashTable as a set. It is equivalent to calling g_hash_table_replace() with @key as both the key and the value.

In particular, this means that if @key already exists in the hash table, then the old copy of @key in the hash table is freed and @key replaces it in the table.

When a hash table only ever contains keys that have themselves as the corresponding value it is able to be stored more efficiently. See the discussion in the section description.

Starting from GLib 2.40, this function returns a boolean value to indicate whether the newly added value was already in the hash table or not.

func HashTableContains 

func HashTableContains(HashTableVar *HashTable, KeyVar uintptr) bool

Checks if @key is in @hash_table.

func HashTableDestroy 

func HashTableDestroy(HashTableVar *HashTable)

Destroys all keys and values in the #GHashTable and decrements its reference count by 1. If keys and/or values are dynamically allocated, you should either free them first or create the #GHashTable with destroy notifiers using g_hash_table_new_full(). In the latter case the destroy functions you supplied will be called on all keys and values during the destruction phase.

func HashTableFind 

func HashTableFind(HashTableVar *HashTable, PredicateVar *HRFunc, UserDataVar uintptr) uintptr

Calls the given function for key/value pairs in the #GHashTable until @predicate returns %TRUE. The function is passed the key and value of each pair, and the given @user_data parameter. The hash table may not be modified while iterating over it (you can't add/remove items).

Note, that hash tables are really only optimized for forward lookups, i.e. g_hash_table_lookup(). So code that frequently issues g_hash_table_find() or g_hash_table_foreach() (e.g. in the order of once per every entry in a hash table) should probably be reworked to use additional or different data structures for reverse lookups (keep in mind that an O(n) find/foreach operation issued for all n values in a hash table ends up needing O(n*n) operations).

func HashTableForeach 

func HashTableForeach(HashTableVar *HashTable, FuncVar *HFunc, UserDataVar uintptr)

Calls the given function for each of the key/value pairs in the #GHashTable. The function is passed the key and value of each pair, and the given @user_data parameter. The hash table may not be modified while iterating over it (you can't add/remove items). To remove all items matching a predicate, use g_hash_table_foreach_remove().

The order in which g_hash_table_foreach() iterates over the keys/values in the hash table is not defined.

See g_hash_table_find() for performance caveats for linear order searches in contrast to g_hash_table_lookup().

func HashTableForeachRemove 

func HashTableForeachRemove(HashTableVar *HashTable, FuncVar *HRFunc, UserDataVar uintptr) uint

Calls the given function for each key/value pair in the #GHashTable. If the function returns %TRUE, then the key/value pair is removed from the #GHashTable. If you supplied key or value destroy functions when creating the #GHashTable, they are used to free the memory allocated for the removed keys and values.

See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table.

func HashTableForeachSteal 

func HashTableForeachSteal(HashTableVar *HashTable, FuncVar *HRFunc, UserDataVar uintptr) uint

Calls the given function for each key/value pair in the #GHashTable. If the function returns %TRUE, then the key/value pair is removed from the #GHashTable, but no key or value destroy functions are called.

See #GHashTableIter for an alternative way to loop over the key/value pairs in the hash table.

func HashTableGLibType 

func HashTableGLibType() types.GType

func HashTableGetKeysAsPtrArray 

func HashTableGetKeysAsPtrArray(HashTableVar *HashTable) uintptr

Retrieves every key inside @hash_table, as a #GPtrArray. The returned data is valid until changes to the hash release those keys.

This iterates over every entry in the hash table to build its return value. To iterate over the entries in a #GHashTable more efficiently, use a #GHashTableIter.

You should always unref the returned array with g_ptr_array_unref().

func HashTableGetValuesAsPtrArray 

func HashTableGetValuesAsPtrArray(HashTableVar *HashTable) uintptr

Retrieves every value inside @hash_table, as a #GPtrArray. The returned data is valid until changes to the hash release those values.

This iterates over every entry in the hash table to build its return value. To iterate over the entries in a #GHashTable more efficiently, use a #GHashTableIter.

You should always unref the returned array with g_ptr_array_unref().

func HashTableInsert 

func HashTableInsert(HashTableVar *HashTable, KeyVar uintptr, ValueVar uintptr) bool

Inserts a new key and value into a #GHashTable.

If the key already exists in the #GHashTable its current value is replaced with the new value. If you supplied a @value_destroy_func when creating the #GHashTable, the old value is freed using that function. If you supplied a @key_destroy_func when creating the #GHashTable, the passed key is freed using that function.

Starting from GLib 2.40, this function returns a boolean value to indicate whether the newly added value was already in the hash table or not.

func HashTableLookup 

func HashTableLookup(HashTableVar *HashTable, KeyVar uintptr) uintptr

Looks up a key in a #GHashTable. Note that this function cannot distinguish between a key that is not present and one which is present and has the value %NULL. If you need this distinction, use g_hash_table_lookup_extended().

func HashTableLookupExtended 

func HashTableLookupExtended(HashTableVar *HashTable, LookupKeyVar uintptr, OrigKeyVar *uintptr, ValueVar *uintptr) bool

Looks up a key in the #GHashTable, returning the original key and the associated value and a #gboolean which is %TRUE if the key was found. This is useful if you need to free the memory allocated for the original key, for example before calling g_hash_table_remove().

You can actually pass %NULL for @lookup_key to test whether the %NULL key exists, provided the hash and equal functions of @hash_table are %NULL-safe.

func HashTableRemove 

func HashTableRemove(HashTableVar *HashTable, KeyVar uintptr) bool

Removes a key and its associated value from a #GHashTable.

If the #GHashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise you have to make sure that any dynamically allocated values are freed yourself.

func HashTableRemoveAll 

func HashTableRemoveAll(HashTableVar *HashTable)

Removes all keys and their associated values from a #GHashTable.

If the #GHashTable was created using g_hash_table_new_full(), the keys and values are freed using the supplied destroy functions, otherwise you have to make sure that any dynamically allocated values are freed yourself.

func HashTableReplace 

func HashTableReplace(HashTableVar *HashTable, KeyVar uintptr, ValueVar uintptr) bool

Inserts a new key and value into a #GHashTable similar to g_hash_table_insert(). The difference is that if the key already exists in the #GHashTable, it gets replaced by the new key. If you supplied a @value_destroy_func when creating the #GHashTable, the old value is freed using that function. If you supplied a @key_destroy_func when creating the #GHashTable, the old key is freed using that function.

Starting from GLib 2.40, this function returns a boolean value to indicate whether the newly added value was already in the hash table or not.

func HashTableSize 

func HashTableSize(HashTableVar *HashTable) uint

Returns the number of elements contained in the #GHashTable.

func HashTableSteal 

func HashTableSteal(HashTableVar *HashTable, KeyVar uintptr) bool

Removes a key and its associated value from a #GHashTable without calling the key and value destroy functions.

func HashTableStealAll 

func HashTableStealAll(HashTableVar *HashTable)

Removes all keys and their associated values from a #GHashTable without calling the key and value destroy functions.

func HashTableStealAllKeys 

func HashTableStealAllKeys(HashTableVar *HashTable) uintptr

Removes all keys and their associated values from a #GHashTable without calling the key destroy functions, returning the keys as a #GPtrArray with the free func set to the @hash_table key destroy function.

func HashTableStealAllValues 

func HashTableStealAllValues(HashTableVar *HashTable) uintptr

Removes all keys and their associated values from a #GHashTable without calling the value destroy functions, returning the values as a #GPtrArray with the free func set to the @hash_table value destroy function.

func HashTableStealExtended 

func HashTableStealExtended(HashTableVar *HashTable, LookupKeyVar uintptr, StolenKeyVar *uintptr, StolenValueVar *uintptr) bool

Looks up a key in the #GHashTable, stealing the original key and the associated value and returning %TRUE if the key was found. If the key was not found, %FALSE is returned.

If found, the stolen key and value are removed from the hash table without calling the key and value destroy functions, and ownership is transferred to the caller of this method, as with g_hash_table_steal(). That is the case regardless whether @stolen_key or @stolen_value output parameters are requested.

You can pass %NULL for @lookup_key, provided the hash and equal functions of @hash_table are %NULL-safe.

The dictionary implementation optimizes for having all values identical to their keys, for example by using g_hash_table_add(). Before 2.82, when stealing both the key and the value from such a dictionary, the value was %NULL. Since 2.82, the returned value and key will be the same.

func HashTableUnref 

func HashTableUnref(HashTableVar *HashTable)

Atomically decrements the reference count of @hash_table by one. If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread.

func HmacGLibType 

func HmacGLibType() types.GType

func HookDestroy 

func HookDestroy(HookListVar *HookList, HookIdVar uint) bool

Destroys a #GHook, given its ID. 

func HookDestroyLink(HookListVar *HookList, HookVar *Hook)

Removes one #GHook from a #GHookList, marking it inactive and calling g_hook_unref() on it.

func HookFree 

func HookFree(HookListVar *HookList, HookVar *Hook)

Calls the #GHookList @finalize_hook function if it exists, and frees the memory allocated for the #GHook.

func HookInsertBefore 

func HookInsertBefore(HookListVar *HookList, SiblingVar *Hook, HookVar *Hook)

Inserts a #GHook into a #GHookList, before a given #GHook.

func HookInsertSorted 

func HookInsertSorted(HookListVar *HookList, HookVar *Hook, FuncVar *HookCompareFunc)

Inserts a #GHook into a #GHookList, sorted by the given function.

func HookPrepend 

func HookPrepend(HookListVar *HookList, HookVar *Hook)

Prepends a #GHook on the start of a #GHookList.

func HookUnref 

func HookUnref(HookListVar *HookList, HookVar *Hook)

Decrements the reference count of a #GHook. If the reference count falls to 0, the #GHook is removed from the #GHookList and g_hook_free() is called to free it.

func HostnameIsAsciiEncoded 

func HostnameIsAsciiEncoded(HostnameVar string) bool

Tests if @hostname contains segments with an ASCII-compatible encoding of an Internationalized Domain Name. If this returns %TRUE, you should decode the hostname with g_hostname_to_unicode() before displaying it to the user.

Note that a hostname might contain a mix of encoded and unencoded segments, and so it is possible for g_hostname_is_non_ascii() and g_hostname_is_ascii_encoded() to both return %TRUE for a name.

func HostnameIsIpAddress 

func HostnameIsIpAddress(HostnameVar string) bool

Tests if @hostname is the string form of an IPv4 or IPv6 address. (Eg, "192.168.0.1".)

Since 2.66, IPv6 addresses with a zone-id are accepted (RFC6874).

func HostnameIsNonAscii 

func HostnameIsNonAscii(HostnameVar string) bool

Tests if @hostname contains Unicode characters. If this returns %TRUE, you need to encode the hostname with g_hostname_to_ascii() before using it in non-IDN-aware contexts.

Note that a hostname might contain a mix of encoded and unencoded segments, and so it is possible for g_hostname_is_non_ascii() and g_hostname_is_ascii_encoded() to both return %TRUE for a name.

func HostnameToAscii 

func HostnameToAscii(HostnameVar string) string

Converts @hostname to its canonical ASCII form; an ASCII-only string containing no uppercase letters and not ending with a trailing dot.

func HostnameToUnicode 

func HostnameToUnicode(HostnameVar string) string

Converts @hostname to its canonical presentation form; a UTF-8 string in Unicode normalization form C, containing no uppercase letters, no forbidden characters, and no ASCII-encoded segments, and not ending with a trailing dot.

Of course if @hostname is not an internationalized hostname, then the canonical presentation form will be entirely ASCII.

func IOChannelGLibType 

func IOChannelGLibType() types.GType

func IOConditionGLibType 

func IOConditionGLibType() types.GType

func Iconv 

func Iconv(ConverterVar uintptr, InbufVar string, InbytesLeftVar *uint, OutbufVar string, OutbytesLeftVar *uint) uint

Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation.

GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers.

Note that the behaviour of iconv() for characters which are valid in the input character set, but which have no representation in the output character set, is implementation defined. This function may return success (with a positive number of non-reversible conversions as replacement characters were used), or it may return -1 and set an error such as %EILSEQ, in such a situation.

See [`iconv(3posix)`](man:iconv(3posix)) and [`iconv(3)`](man:iconv(3)) for more details about behavior when an error occurs.

func IconvOpen 

func IconvOpen(ToCodesetVar string, FromCodesetVar string) uintptr

Same as the standard UNIX routine iconv_open(), but may be implemented via libiconv on UNIX flavors that lack a native implementation.

GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers.

func IdleAdd 

func IdleAdd(FunctionVar *SourceFunc, DataVar uintptr) uint

Adds a function to be called whenever there are no higher priority events pending to the default main loop.

The function is given the default idle priority, [const@GLib.PRIORITY_DEFAULT_IDLE]. If the function returns [const@GLib.SOURCE_REMOVE] it is automatically removed from the list of event sources and will not be called again.

See [main loop memory management](main-loop.html#memory-management-of-sources) for details on how to handle the return value and memory management of @data.

This internally creates a main loop source using [func@GLib.idle_source_new] and attaches it to the global [struct@GLib.MainContext] using [method@GLib.Source.attach], so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context.

func IdleAddFull 

func IdleAddFull(PriorityVar int, FunctionVar *SourceFunc, DataVar uintptr, NotifyVar *DestroyNotify) uint

Adds a function to be called whenever there are no higher priority events pending.

If the function returns [const@GLib.SOURCE_REMOVE] it is automatically removed from the list of event sources and will not be called again.

See [main loop memory management](main-loop.html#memory-management-of-sources) for details on how to handle the return value and memory management of @data.

This internally creates a main loop source using [func@GLib.idle_source_new] and attaches it to the global [struct@GLib.MainContext] using [method@GLib.Source.attach], so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context.

func IdleAddOnce 

func IdleAddOnce(FunctionVar *SourceOnceFunc, DataVar uintptr) uint

Adds a function to be called whenever there are no higher priority events pending to the default main loop.

The function is given the default idle priority, [const@GLib.PRIORITY_DEFAULT_IDLE].

The function will only be called once and then the source will be automatically removed from the main context.

This function otherwise behaves like [func@GLib.idle_add].

func IdleRemoveByData 

func IdleRemoveByData(DataVar uintptr) bool

Removes the idle function with the given data.

func Int64Equal 

func Int64Equal(V1Var uintptr, V2Var uintptr) bool

Compares the two #gint64 values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to 64-bit integers as keys in a #GHashTable.

func Int64Hash 

func Int64Hash(VVar uintptr) uint

Converts a pointer to a #gint64 to a hash value.

It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to 64-bit integer values as keys in a #GHashTable.

func IntEqual 

func IntEqual(V1Var uintptr, V2Var uintptr) bool

Compares the two #gint values being pointed to and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL pointers to integers as keys in a #GHashTable.

Note that this function acts on pointers to #gint, not on #gint directly: if your hash table's keys are of the form `GINT_TO_POINTER (n)`, use g_direct_equal() instead.

func IntHash 

func IntHash(VVar uintptr) uint

Converts a pointer to a #gint to a hash value. It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL pointers to integer values as keys in a #GHashTable.

Note that this function acts on pointers to #gint, not on #gint directly: if your hash table's keys are of the form `GINT_TO_POINTER (n)`, use g_direct_hash() instead.

func InternStaticString 

func InternStaticString(StringVar *string) string

Returns a canonical representation for @string. Interned strings can be compared for equality by comparing the pointers, instead of using strcmp(). g_intern_static_string() does not copy the string, therefore @string must not be freed or modified.

This function must not be used before library constructors have finished running. In particular, this means it cannot be used to initialize global variables in C++.

func InternString 

func InternString(StringVar *string) string

Returns a canonical representation for @string. Interned strings can be compared for equality by comparing the pointers, instead of using strcmp().

This function must not be used before library constructors have finished running. In particular, this means it cannot be used to initialize global variables in C++.

func IoAddWatch 

func IoAddWatch(ChannelVar *IOChannel, ConditionVar IOCondition, FuncVar *IOFunc, UserDataVar uintptr) uint

Adds the #GIOChannel into the default main loop context with the default priority.

func IoAddWatchFull 

func IoAddWatchFull(ChannelVar *IOChannel, PriorityVar int, ConditionVar IOCondition, FuncVar *IOFunc, UserDataVar uintptr, NotifyVar *DestroyNotify) uint

Adds the #GIOChannel into the default main loop context with the given priority.

This internally creates a main loop source using g_io_create_watch() and attaches it to the main loop context with g_source_attach(). You can do these steps manually if you need greater control.

func KeyFileGLibType 

func KeyFileGLibType() types.GType

func ListPopAllocator 

func ListPopAllocator()

func ListPushAllocator 

func ListPushAllocator(AllocatorVar *Allocator)

func Listenv 

func Listenv() []string

Gets the names of all variables set in the environment.

Programs that want to be portable to Windows should typically use this function and g_getenv() instead of using the environ array from the C library directly. On Windows, the strings in the environ array are in system codepage encoding, while in most of the typical use cases for environment variables in GLib-using programs you want the UTF-8 encoding that this function and g_getenv() provide.

func LocaleFromUtf8 

func LocaleFromUtf8(Utf8stringVar string, LenVar int, BytesReadVar *uint, BytesWrittenVar *uint) (uintptr, error)

Converts a string from UTF-8 to the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the [current locale](running.html#locale). On Windows this means the system codepage.

The input string shall not contain nul characters even if the @len argument is positive. A nul character found inside the string will result in error %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. Use g_convert() to convert input that may contain embedded nul characters.

func LocaleToUtf8 

func LocaleToUtf8(OpsysstringVar []byte, LenVar int, BytesReadVar *uint, BytesWrittenVar *uint) (string, error)

Converts a string which is in the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the [current locale](running.html#locale) into a UTF-8 string.

If the source encoding is not UTF-8 and the conversion output contains a nul character, the error %G_CONVERT_ERROR_EMBEDDED_NUL is set and the function returns %NULL. If the source encoding is UTF-8, an embedded nul character is treated with the %G_CONVERT_ERROR_ILLEGAL_SEQUENCE error for backward compatibility with earlier versions of this library. Use g_convert() to produce output that may contain embedded nul characters.

func Log 

func Log(LogDomainVar *string, LogLevelVar LogLevelFlags, FormatVar string, varArgs ...interface{})

Logs an error or debugging message.

If the log level has been set as fatal, [func@GLib.BREAKPOINT] is called to terminate the program. See the documentation for [func@GLib.BREAKPOINT] for details of the debugging options this provides.

If [func@GLib.log_default_handler] is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually.

If [structured logging is enabled](logging.html#using-structured-logging) this will output via the structured log writer function (see [func@GLib.log_set_writer_func]).

func LogDefaultHandler 

func LogDefaultHandler(LogDomainVar *string, LogLevelVar LogLevelFlags, MessageVar *string, UnusedDataVar uintptr)

The default log handler set up by GLib; [func@GLib.log_set_default_handler] allows to install an alternate default log handler.

This is used if no log handler has been set for the particular log domain and log level combination. It outputs the message to `stderr` or `stdout` and if the log level is fatal it calls [func@GLib.BREAKPOINT]. It automatically prints a new-line character after the message, so one does not need to be manually included in @message.

The behavior of this log handler can be influenced by a number of environment variables:

  • `G_MESSAGES_PREFIXED`: A `:`-separated list of log levels for which messages should be prefixed by the program name and PID of the application.
  • `G_MESSAGES_DEBUG`: A space-separated list of log domains for which debug and informational messages are printed. By default these messages are not printed. If you need to set the allowed domains at runtime, use [func@GLib.log_writer_default_set_debug_domains].
  • `DEBUG_INVOCATION`: If set to `1`, this is equivalent to `G_MESSAGES_DEBUG=all`. `DEBUG_INVOCATION` is a standard environment variable set by systemd to prompt debug output. (Since: 2.84)

`stderr` is used for levels [flags@GLib.LogLevelFlags.LEVEL_ERROR], [flags@GLib.LogLevelFlags.LEVEL_CRITICAL], [flags@GLib.LogLevelFlags.LEVEL_WARNING] and [flags@GLib.LogLevelFlags.LEVEL_MESSAGE]. `stdout` is used for the rest, unless `stderr` was requested by [func@GLib.log_writer_default_set_use_stderr].

This has no effect if structured logging is enabled; see [Using Structured Logging](logging.html#using-structured-logging).

func LogGetDebugEnabled 

func LogGetDebugEnabled() bool

Return whether debug output from the GLib logging system is enabled.

Note that this should not be used to conditionalise calls to [func@GLib.debug] or other logging functions; it should only be used from [type@GLib.LogWriterFunc] implementations.

Note also that the value of this does not depend on `G_MESSAGES_DEBUG`, nor `DEBUG_INVOCATION`, nor [func@GLib.log_writer_default_set_debug_domains]; see the docs for [func@GLib.log_set_debug_enabled].

func LogRemoveHandler 

func LogRemoveHandler(LogDomainVar string, HandlerIdVar uint)

Removes the log handler.

This has no effect if structured logging is enabled; see [Using Structured Logging](logging.html#using-structured-logging).

func LogSetDebugEnabled 

func LogSetDebugEnabled(EnabledVar bool)

Enable or disable debug output from the GLib logging system for all domains.

This value interacts disjunctively with `G_MESSAGES_DEBUG`, `DEBUG_INVOCATION` and [func@GLib.log_writer_default_set_debug_domains] — if any of them would allow a debug message to be outputted, it will be.

Note that this should not be used from within library code to enable debug output — it is intended for external use.

func LogSetDefaultHandler 

func LogSetDefaultHandler(LogFuncVar *LogFunc, UserDataVar uintptr) uintptr

Installs a default log handler which is used if no log handler has been set for the particular log domain and log level combination.

By default, GLib uses [func@GLib.log_default_handler] as default log handler.

This has no effect if structured logging is enabled; see [Using Structured Logging](logging.html#using-structured-logging).

func LogSetHandler 

func LogSetHandler(LogDomainVar *string, LogLevelsVar LogLevelFlags, LogFuncVar *LogFunc, UserDataVar uintptr) uint

Sets the log handler for a domain and a set of log levels.

To handle fatal and recursive messages the @log_levels parameter must be combined with the [flags@GLib.LogLevelFlags.FLAG_FATAL] and [flags@GLib.LogLevelFlags.FLAG_RECURSION] bit flags.

Note that since the [flags@GLib.LogLevelFlags.LEVEL_ERROR] log level is always fatal, if you want to set a handler for this log level you must combine it with [flags@GLib.LogLevelFlags.FLAG_FATAL].

This has no effect if structured logging is enabled; see [Using Structured Logging](logging.html#using-structured-logging).

The `log_domain` parameter can be set to `NULL` or an empty string to use the default application domain.

Here is an example for adding a log handler for all warning messages in the default domain:

```c g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL 

| G_LOG_FLAG_RECURSION, my_log_handler, NULL);

```

This example adds a log handler for all critical messages from GTK:

```c g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL 

| G_LOG_FLAG_RECURSION, my_log_handler, NULL);

```

This example adds a log handler for all messages from GLib:

```c g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL 

| G_LOG_FLAG_RECURSION, my_log_handler, NULL);

```

func LogSetHandlerFull 

func LogSetHandlerFull(LogDomainVar *string, LogLevelsVar LogLevelFlags, LogFuncVar *LogFunc, UserDataVar uintptr, DestroyVar *DestroyNotify) uint

Like [func@GLib.log_set_handler], but takes a destroy notify for the @user_data.

This has no effect if structured logging is enabled; see [Using Structured Logging](logging.html#using-structured-logging).

The `log_domain` parameter can be set to `NULL` or an empty string to use the default application domain.

func LogSetWriterFunc 

func LogSetWriterFunc(FuncVar *LogWriterFunc, UserDataVar uintptr, UserDataFreeVar *DestroyNotify)

Set a writer function which will be called to format and write out each log message.

Each program should set a writer function, or the default writer ([func@GLib.log_writer_default]) will be used.

Libraries **must not** call this function — only programs are allowed to install a writer function, as there must be a single, central point where log messages are formatted and outputted.

There can only be one writer function. It is an error to set more than one.

func LogStructured 

func LogStructured(LogDomainVar string, LogLevelVar LogLevelFlags, varArgs ...interface{})

Log a message with structured data.

The message will be passed through to the log writer set by the application using [func@GLib.log_set_writer_func]. If the message is fatal (i.e. its log level is [flags@GLib.LogLevelFlags.LEVEL_ERROR]), the program will be aborted by calling [func@GLib.BREAKPOINT] at the end of this function. If the log writer returns [enum@GLib.LogWriterOutput.UNHANDLED] (failure), no other fallback writers will be tried. See the documentation for [type@GLib.LogWriterFunc] for information on chaining writers.

The structured data is provided as key–value pairs, where keys are UTF-8 strings, and values are arbitrary pointers — typically pointing to UTF-8 strings, but that is not a requirement. To pass binary (non-nul-terminated) structured data, use [func@GLib.log_structured_array]. The keys for structured data should follow the [systemd journal fields](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html) specification. It is suggested that custom keys are namespaced according to the code which sets them. For example, custom keys from GLib all have a `GLIB_` prefix.

Note that keys that expect UTF-8 strings (specifically `"MESSAGE"` and `"GLIB_DOMAIN"`) must be passed as nul-terminated UTF-8 strings until GLib version 2.74.1 because the default log handler did not consider the length of the `GLogField`. Starting with GLib 2.74.1 this is fixed and non-nul-terminated UTF-8 strings can be passed with their correct length, with the exception of `"GLIB_DOMAIN"` which was only fixed with GLib 2.82.3.

The @log_domain will be converted into a `GLIB_DOMAIN` field. @log_level will be converted into a [`PRIORITY`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#PRIORITY=) field. The format string will have its placeholders substituted for the provided values and be converted into a [`MESSAGE`](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#MESSAGE=) field.

Other fields you may commonly want to pass into this function:

Note that `CODE_FILE`, `CODE_LINE` and `CODE_FUNC` are automatically set by the logging macros, [func@GLib.DEBUG_HERE], [func@GLib.message], [func@GLib.warning], [func@GLib.critical], [func@GLib.error], etc, if the symbol `G_LOG_USE_STRUCTURED` is defined before including `glib.h`.

For example:

```c g_log_structured (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG, 

"MESSAGE_ID", "06d4df59e6c24647bfe69d2c27ef0b4e",
"MY_APPLICATION_CUSTOM_FIELD", "some debug string",
"MESSAGE", "This is a debug message about pointer %p and integer %u.",
some_pointer, some_integer);

```

Note that each `MESSAGE_ID` must be [uniquely and randomly generated](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html#MESSAGE_ID=). If adding a `MESSAGE_ID`, consider shipping a [message catalog](https://www.freedesktop.org/wiki/Software/systemd/catalog/) with your software.

To pass a user data pointer to the log writer function which is specific to this logging call, you must use [func@GLib.log_structured_array] and pass the pointer as a field with `GLogField.length` set to zero, otherwise it will be interpreted as a string.

For example:

```c 

const GLogField fields[] = {
  { "MESSAGE", "This is a debug message.", -1 },
  { "MESSAGE_ID", "fcfb2e1e65c3494386b74878f1abf893", -1 },
  { "MY_APPLICATION_CUSTOM_FIELD", "some debug string", -1 },
  { "MY_APPLICATION_STATE", state_object, 0 },
};

g_log_structured_array (G_LOG_LEVEL_DEBUG, fields, G_N_ELEMENTS (fields)); ```

Note also that, even if no other structured fields are specified, there must always be a `MESSAGE` key before the format string. The `MESSAGE`-format pair has to be the last of the key-value pairs, and `MESSAGE` is the only field for which `printf()`-style formatting is supported.

The default writer function for `stdout` and `stderr` will automatically append a new-line character after the message, so you should not add one manually to the format string.

func LogStructuredArray 

func LogStructuredArray(LogLevelVar LogLevelFlags, FieldsVar []LogField, NFieldsVar uint)

Log a message with structured data.

The message will be passed through to the log writer set by the application using [func@GLib.log_set_writer_func]. If the message is fatal (i.e. its log level is [flags@GLib.LogLevelFlags.LEVEL_ERROR]), the program will be aborted at the end of this function.

See [func@GLib.log_structured] for more documentation.

This assumes that @log_level is already present in @fields (typically as the `PRIORITY` field).

func LogStructuredStandard 

func LogStructuredStandard(LogDomainVar string, LogLevelVar LogLevelFlags, FileVar string, LineVar string, FuncVar string, MessageFormatVar string, varArgs ...interface{})

func LogVariant 

func LogVariant(LogDomainVar *string, LogLevelVar LogLevelFlags, FieldsVar *Variant)

Log a message with structured data, accepting the data within a [type@GLib.Variant].

This version is especially useful for use in other languages, via introspection.

The only mandatory item in the @fields dictionary is the `"MESSAGE"` which must contain the text shown to the user.

The values in the @fields dictionary are likely to be of type `G_VARIANT_TYPE_STRING`. Array of bytes (`G_VARIANT_TYPE_BYTESTRING`) is also supported. In this case the message is handled as binary and will be forwarded to the log writer as such. The size of the array should not be higher than `G_MAXSSIZE`. Otherwise it will be truncated to this size. For other types [method@GLib.Variant.print] will be used to convert the value into a string.

For more details on its usage and about the parameters, see [func@GLib.log_structured].

func LogWriterDefaultSetDebugDomains 

func LogWriterDefaultSetDebugDomains(DomainsVar *string)

Reset the list of domains to be logged, that might be initially set by the `G_MESSAGES_DEBUG` or `DEBUG_INVOCATION` environment variables.

This function is thread-safe.

func LogWriterDefaultSetUseStderr 

func LogWriterDefaultSetUseStderr(UseStderrVar bool)

Configure whether the built-in log functions will output all log messages to `stderr`.

The built-in log functions are [func@GLib.log_default_handler] for the old-style API, and both [func@GLib.log_writer_default] and [func@GLib.log_writer_standard_streams] for the structured API.

By default, log messages of levels [flags@GLib.LogLevelFlags.LEVEL_INFO] and [flags@GLib.LogLevelFlags.LEVEL_DEBUG] are sent to `stdout`, and other log messages are sent to `stderr`. This is problematic for applications that intend to reserve `stdout` for structured output such as JSON or XML.

This function sets global state. It is not thread-aware, and should be called at the very start of a program, before creating any other threads or creating objects that could create worker threads of their own.

func LogWriterDefaultWouldDrop 

func LogWriterDefaultWouldDrop(LogLevelVar LogLevelFlags, LogDomainVar *string) bool

Check whether [func@GLib.log_writer_default] and [func@GLib.log_default_handler] would ignore a message with the given domain and level.

As with [func@GLib.log_default_handler], this function drops debug and informational messages unless their log domain (or `all`) is listed in the space-separated `G_MESSAGES_DEBUG` environment variable, or `DEBUG_INVOCATION=1` is set in the environment, or by [func@GLib.log_writer_default_set_debug_domains].

This can be used when implementing log writers with the same filtering behaviour as the default, but a different destination or output format:

```c if (g_log_writer_default_would_drop (log_level, log_domain)) 

return G_LOG_WRITER_HANDLED;

]|

or to skip an expensive computation if it is only needed for a debugging message, and `G_MESSAGES_DEBUG` and `DEBUG_INVOCATION` are not set:

```c if (!g_log_writer_default_would_drop (G_LOG_LEVEL_DEBUG, G_LOG_DOMAIN)) 

{
  g_autofree gchar *result = expensive_computation (my_object);

  g_debug ("my_object result: %s", result);
}

```

func LogWriterFormatFields 

func LogWriterFormatFields(LogLevelVar LogLevelFlags, FieldsVar []LogField, NFieldsVar uint, UseColorVar bool) string

Format a structured log message as a string suitable for outputting to the terminal (or elsewhere).

This will include the values of all fields it knows how to interpret, which includes `MESSAGE` and `GLIB_DOMAIN` (see the documentation for [func@GLib.log_structured]). It does not include values from unknown fields.

The returned string does **not** have a trailing new-line character. It is encoded in the character set of the current locale, which is not necessarily UTF-8.

func LogWriterIsJournald 

func LogWriterIsJournald(OutputFdVar int) bool

Check whether the given @output_fd file descriptor is a connection to the systemd journal, or something else (like a log file or `stdout` or `stderr`).

Invalid file descriptors are accepted and return `FALSE`, which allows for the following construct without needing any additional error handling: ```c is_journald = g_log_writer_is_journald (fileno (stderr)); ```

func LogWriterSupportsColor 

func LogWriterSupportsColor(OutputFdVar int) bool

Check whether the given @output_fd file descriptor supports [ANSI color escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code).

If so, they can safely be used when formatting log messages.

func Logv 

func Logv(LogDomainVar *string, LogLevelVar LogLevelFlags, FormatVar string, ArgsVar []interface{})

Logs an error or debugging message.

If the log level has been set as fatal, [func@GLib.BREAKPOINT] is called to terminate the program. See the documentation for [func@GLib.BREAKPOINT] for details of the debugging options this provides.

If [func@GLib.log_default_handler] is used as the log handler function, a new-line character will automatically be appended to @..., and need not be entered manually.

If [structured logging is enabled](logging.html#using-structured-logging) this will output via the structured log writer function (see [func@GLib.log_set_writer_func]).

The `log_domain` parameter can be set to `NULL` or an empty string to use the default application domain.

func Lstat 

func Lstat(FilenameVar string, BufVar *StatBuf) int

A wrapper for the POSIX lstat() function. The lstat() function is like stat() except that in the case of symbolic links, it returns information about the symbolic link itself and not the file that it refers to. If the system does not support symbolic links g_lstat() is identical to g_stat().

See your C library manual for more details about lstat().

func MainContextGLibType 

func MainContextGLibType() types.GType

func MainDepth 

func MainDepth() int

Returns the depth of the stack of calls to [method@GLib.MainContext.dispatch] on any #GMainContext in the current thread.

That is, when called from the top level, it gives `0`. When called from within a callback from [method@GLib.MainContext.iteration] (or [method@GLib.MainLoop.run], etc.) it returns `1`. When called from within a callback to a recursive call to [method@GLib.MainContext.iteration], it returns `2`. And so forth.

This function is useful in a situation like the following: Imagine an extremely simple ‘garbage collected’ system.

```c static GList *free_list;

gpointer allocate_memory (gsize size) 

{
  gpointer result = g_malloc (size);
  free_list = g_list_prepend (free_list, result);
  return result;
}

void free_allocated_memory (void) 

{
  GList *l;
  for (l = free_list; l; l = l-&gt;next);
    g_free (l-&gt;data);
  g_list_free (free_list);
  free_list = NULL;
 }

[...]

while (TRUE); 

{
  g_main_context_iteration (NULL, TRUE);
  free_allocated_memory();
 }

```

This works from an application, however, if you want to do the same thing from a library, it gets more difficult, since you no longer control the main loop. You might think you can simply use an idle function to make the call to `free_allocated_memory()`, but that doesn’t work, since the idle function could be called from a recursive callback. This can be fixed by using [func@GLib.main_depth]

```c gpointer allocate_memory (gsize size) 

{
  FreeListBlock *block = g_new (FreeListBlock, 1);
  block-&gt;mem = g_malloc (size);
  block-&gt;depth = g_main_depth ();
  free_list = g_list_prepend (free_list, block);
  return block-&gt;mem;
}

void free_allocated_memory (void) 

{
  GList *l;

  int depth = g_main_depth ();
  for (l = free_list; l; );
    {
      GList *next = l-&gt;next;
      FreeListBlock *block = l-&gt;data;
      if (block-&gt;depth &gt; depth)
        {
          g_free (block-&gt;mem);
          g_free (block);
          free_list = g_list_delete_link (free_list, l);
        }

      l = next;
    }
  }

```

There is a temptation to use [func@GLib.main_depth] to solve problems with reentrancy. For instance, while waiting for data to be received from the network in response to a menu item, the menu item might be selected again. It might seem that one could make the menu item’s callback return immediately and do nothing if [func@GLib.main_depth] returns a value greater than 1. However, this should be avoided since the user then sees selecting the menu item do nothing. Furthermore, you’ll find yourself adding these checks all over your code, since there are doubtless many, many things that the user could do. Instead, you can use the following techniques:

  1. Use `gtk_widget_set_sensitive()` or modal dialogs to prevent the user from interacting with elements while the main loop is recursing.

  2. Avoid main loop recursion in situations where you can’t handle arbitrary callbacks. Instead, structure your code so that you simply return to the main loop and then get called again when there is more work to do.

func MainLoopGLibType 

func MainLoopGLibType() types.GType

func Malloc 

func Malloc(NBytesVar uint) uintptr

Allocates @n_bytes bytes of memory. If @n_bytes is 0 it returns %NULL.

If the allocation fails (because the system is out of memory), the program is terminated.

func Malloc0 

func Malloc0(NBytesVar uint) uintptr

Allocates @n_bytes bytes of memory, initialized to 0's. If @n_bytes is 0 it returns %NULL.

If the allocation fails (because the system is out of memory), the program is terminated.

func Malloc0N 

func Malloc0N(NBlocksVar uint, NBlockBytesVar uint) uintptr

This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication.

If the allocation fails (because the system is out of memory), the program is terminated.

func MallocN 

func MallocN(NBlocksVar uint, NBlockBytesVar uint) uintptr

This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication.

If the allocation fails (because the system is out of memory), the program is terminated.

func MappedFileGLibType 

func MappedFileGLibType() types.GType

func MarkupCollectAttributes 

func MarkupCollectAttributes(ElementNameVar string, AttributeNamesVar string, AttributeValuesVar string, ErrorVar **Error, FirstTypeVar MarkupCollectType, FirstAttrVar string, varArgs ...interface{}) bool

Collects the attributes of the element from the data passed to the #GMarkupParser start_element function, dealing with common error conditions and supporting boolean values.

This utility function is not required to write a parser but can save a lot of typing.

The @element_name, @attribute_names, @attribute_values and @error parameters passed to the start_element callback should be passed unmodified to this function.

Following these arguments is a list of "supported" attributes to collect. It is an error to specify multiple attributes with the same name. If any attribute not in the list appears in the @attribute_names array then an unknown attribute error will result.

The #GMarkupCollectType field allows specifying the type of collection to perform and if a given attribute must appear or is optional.

The attribute name is simply the name of the attribute to collect.

The pointer should be of the appropriate type (see the descriptions under #GMarkupCollectType) and may be %NULL in case a particular attribute is to be allowed but ignored.

This function deals with issuing errors for missing attributes (of type %G_MARKUP_ERROR_MISSING_ATTRIBUTE), unknown attributes (of type %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE) and duplicate attributes (of type %G_MARKUP_ERROR_INVALID_CONTENT) as well as parse errors for boolean-valued attributes (again of type %G_MARKUP_ERROR_INVALID_CONTENT). In all of these cases %FALSE will be returned and @error will be set as appropriate.

func MarkupEscapeText 

func MarkupEscapeText(TextVar string, LengthVar int) string

Escapes text so that the markup parser will parse it verbatim. Less than, greater than, ampersand, etc. are replaced with the corresponding entities. This function would typically be used when writing out a file to be parsed with the markup parser.

Note that this function doesn't protect whitespace and line endings from being processed according to the XML rules for normalization of line endings and attribute values.

Note also that this function will produce character references in the range of &amp;#x1; ... &amp;#x1f; for all control sequences except for tabstop, newline and carriage return. The character references in this range are not valid XML 1.0, but they are valid XML 1.1 and will be accepted by the GMarkup parser.

func MarkupParseContextGLibType 

func MarkupParseContextGLibType() types.GType

func MarkupPrintfEscaped 

func MarkupPrintfEscaped(FormatVar string, varArgs ...interface{}) string

Formats arguments according to @format, escaping all string and character arguments in the fashion of g_markup_escape_text(). This is useful when you want to insert literal strings into XML-style markup output, without having to worry that the strings might themselves contain markup.

|[&lt;!-- language="C" --&gt; const char *store = "Fortnum &amp; Mason"; const char *item = "Tea"; char *output;

output = g_markup_printf_escaped ("&lt;purchase&gt;" 

"&lt;store&gt;%s&lt;/store&gt;"
"&lt;item&gt;%s&lt;/item&gt;"
"&lt;/purchase&gt;",
store, item);

]|

func MarkupVprintfEscaped 

func MarkupVprintfEscaped(FormatVar string, ArgsVar []interface{}) string

Formats the data in @args according to @format, escaping all string and character arguments in the fashion of g_markup_escape_text(). See g_markup_printf_escaped().

func MatchInfoGLibType 

func MatchInfoGLibType() types.GType

func MemChunkInfo 

func MemChunkInfo()

func MemIsSystemMalloc 

func MemIsSystemMalloc() bool

Checks whether the allocator used by g_malloc() is the system's malloc implementation. If it returns %TRUE memory allocated with malloc() can be used interchangeably with memory allocated using g_malloc(). This function is useful for avoiding an extra copy of allocated memory returned by a non-GLib-based API.

func MemProfile 

func MemProfile()

GLib used to support some tools for memory profiling, but this no longer works. There are many other useful tools for memory profiling these days which can be used instead.

func MemSetVtable 

func MemSetVtable(VtableVar *MemVTable)

This function used to let you override the memory allocation function. However, its use was incompatible with the use of global constructors in GLib and GIO, because those use the GLib allocators before main is reached. Therefore this function is now deprecated and is just a stub.

func Memdup 

func Memdup(MemVar uintptr, ByteSizeVar uint) uintptr

Allocates @byte_size bytes of memory, and copies @byte_size bytes into it from @mem. If @mem is `NULL` it returns `NULL`.

func Memdup2 

func Memdup2(MemVar uintptr, ByteSizeVar uint) uintptr

Allocates @byte_size bytes of memory, and copies @byte_size bytes into it from @mem. If @mem is `NULL` it returns `NULL`.

This replaces [func@GLib.memdup], which was prone to integer overflows when converting the argument from a `gsize` to a `guint`.

func Mkdir 

func Mkdir(FilenameVar string, ModeVar int) int

A wrapper for the POSIX mkdir() function. The mkdir() function attempts to create a directory with the given name and permissions. The mode argument is ignored on Windows.

See your C library manual for more details about mkdir().

func MkdirWithParents 

func MkdirWithParents(PathnameVar string, ModeVar int) int

Create a directory if it doesn't already exist. Create intermediate parent directories as needed, too.

func Mkdtemp 

func Mkdtemp(TmplVar string) string

Creates a temporary directory in the current directory.

See the [`mkdtemp()`](man:mkdtemp(3)) documentation on most UNIX-like systems.

The parameter is a string that should follow the rules for mkdtemp() templates, i.e. contain the string "XXXXXX". g_mkdtemp() is slightly more flexible than mkdtemp() in that the sequence does not have to occur at the very end of the template. The X string will be modified to form the name of a directory that didn't exist. The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8.

If you are going to be creating a temporary directory inside the directory returned by g_get_tmp_dir(), you might want to use g_dir_make_tmp() instead.

func MkdtempFull 

func MkdtempFull(TmplVar string, ModeVar int) string

Creates a temporary directory in the current directory.

See the [`mkdtemp()`](man:mkdtemp(3)) documentation on most UNIX-like systems.

The parameter is a string that should follow the rules for mkdtemp() templates, i.e. contain the string "XXXXXX". g_mkdtemp_full() is slightly more flexible than mkdtemp() in that the sequence does not have to occur at the very end of the template and you can pass a @mode. The X string will be modified to form the name of a directory that didn't exist. The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8.

If you are going to be creating a temporary directory inside the directory returned by g_get_tmp_dir(), you might want to use g_dir_make_tmp() instead.

func Mkstemp 

func Mkstemp(TmplVar string) int

Opens a temporary file in the current directory.

See the [`mkstemp()`](man:mkstemp(3)) documentation on most UNIX-like systems.

The parameter is a string that should follow the rules for mkstemp() templates, i.e. contain the string "XXXXXX". g_mkstemp() is slightly more flexible than mkstemp() in that the sequence does not have to occur at the very end of the template. The X string will be modified to form the name of a file that didn't exist. The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8.

func MkstempFull 

func MkstempFull(TmplVar string, FlagsVar int, ModeVar int) int

Opens a temporary file in the current directory.

See the [`mkstemp()`](man:mkstemp(3)) documentation on most UNIX-like systems.

The parameter is a string that should follow the rules for mkstemp() templates, i.e. contain the string "XXXXXX". g_mkstemp_full() is slightly more flexible than mkstemp() in that the sequence does not have to occur at the very end of the template and you can pass a @mode and additional @flags. The X string will be modified to form the name of a file that didn't exist. The string should be in the GLib file name encoding. Most importantly, on Windows it should be in UTF-8.

func NewCallback 

func NewCallback(fnPtr interface{}) uintptr

NewCallback is an alias to purego.NewCallback

func NewCallbackNullable 

func NewCallbackNullable(fn interface{}) uintptr

NewCallbackNullable is an alias to purego.NewCallback that returns a null pointer for null functions

func NewFileTest 

func NewFileTest(FilenameVar string, TestVar FileTest) bool

Returns %TRUE if any of the tests in the bitfield @test are %TRUE. For example, `(G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)` will return %TRUE if the file exists; the check whether it's a directory doesn't matter since the existence test is %TRUE. With the current set of available tests, there's no point passing in more than one test at a time.

Apart from %G_FILE_TEST_IS_SYMLINK all tests follow symbolic links, so for a symbolic link to a regular file g_file_test() will return %TRUE for both %G_FILE_TEST_IS_SYMLINK and %G_FILE_TEST_IS_REGULAR.

Note, that for a dangling symbolic link g_file_test() will return %TRUE for %G_FILE_TEST_IS_SYMLINK and %FALSE for all other flags.

You should never use g_file_test() to test whether it is safe to perform an operation, because there is always the possibility of the condition changing before you actually perform the operation, see [TOCTOU](https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use).

For example, you might think you could use %G_FILE_TEST_IS_SYMLINK to know whether it is safe to write to a file without being tricked into writing into a different location. It doesn't work!

|[&lt;!-- language="C" --&gt; 

// DON'T DO THIS
if (!g_file_test (filename, G_FILE_TEST_IS_SYMLINK))
  {
    fd = g_open (filename, O_WRONLY);
    // write to fd
  }

// DO THIS INSTEAD
fd = g_open (filename, O_WRONLY | O_NOFOLLOW | O_CLOEXEC);
if (fd == -1)
  {
    // check error
    if (errno == ELOOP)
      // file is a symlink and can be ignored
    else
      // handle errors as before
  }
else
  {
    // write to fd
  }

]|

Another thing to note is that %G_FILE_TEST_EXISTS and %G_FILE_TEST_IS_EXECUTABLE are implemented using the access() system call. This usually doesn't matter, but if your program is setuid or setgid it means that these tests will give you the answer for the real user ID and group ID, rather than the effective user ID and group ID.

On Windows, there are no symlinks, so testing for %G_FILE_TEST_IS_SYMLINK will always return %FALSE. Testing for %G_FILE_TEST_IS_EXECUTABLE will just check that the file exists and its name indicates that it is executable, checking for well-known extensions and those listed in the `PATHEXT` environment variable.

func NodePopAllocator 

func NodePopAllocator()

func NodePushAllocator 

func NodePushAllocator(AllocatorVar *Allocator)

func NormalizeModeGLibType 

func NormalizeModeGLibType() types.GType

func NullifyPointer 

func NullifyPointer(NullifyLocationVar uintptr)

Set the pointer at the specified location to %NULL.

func OnErrorQuery 

func OnErrorQuery(PrgNameVar string)

Prompts the user with `[E]xit, [H]alt, show [S]tack trace or [P]roceed`. This function is intended to be used for debugging use only. The following example shows how it can be used together with the g_log() functions.

|[&lt;!-- language="C" --&gt; #include &lt;glib.h&gt;

static void log_handler (const gchar *log_domain, 

GLogLevelFlags log_level,
const gchar   *message,
gpointer       user_data)

{
  g_log_default_handler (log_domain, log_level, message, user_data);

  g_on_error_query (MY_PROGRAM_NAME);
}

int main (int argc, char *argv[]) 

{
  g_log_set_handler (MY_LOG_DOMAIN,
                     G_LOG_LEVEL_WARNING |
                     G_LOG_LEVEL_ERROR |
                     G_LOG_LEVEL_CRITICAL,
                     log_handler,
                     NULL);
  ...

]|

If "[E]xit" is selected, the application terminates with a call to _exit(0).

If "[S]tack" trace is selected, g_on_error_stack_trace() is called. This invokes gdb, which attaches to the current process and shows a stack trace. The prompt is then shown again.

If "[P]roceed" is selected, the function returns.

This function may cause different actions on non-UNIX platforms.

On Windows consider using the `G_DEBUGGER` environment variable (see [Running GLib Applications](running.html)) and calling g_on_error_stack_trace() instead.

func OnErrorStackTrace 

func OnErrorStackTrace(PrgNameVar *string)

Invokes gdb, which attaches to the current process and shows a stack trace. Called by g_on_error_query() when the "[S]tack trace" option is selected. You can get the current process's program name with g_get_prgname(), assuming that you have called gtk_init() or gdk_init().

This function may cause different actions on non-UNIX platforms.

When running on Windows, this function is *not* called by g_on_error_query(). If called directly, it will raise an exception, which will crash the program. If the `G_DEBUGGER` environment variable is set, a debugger will be invoked to attach and handle that exception (see [Running GLib Applications](running.html)).

func OnceInitEnter 

func OnceInitEnter(LocationVar *uintptr) bool

Function to be called when starting a critical initialization section. The argument @location must point to a static 0-initialized variable that will be set to a value other than 0 at the end of the initialization section. In combination with g_once_init_leave() and the unique address @value_location, it can be ensured that an initialization section will be executed only once during a program's life time, and that concurrent threads are blocked until initialization completed. To be used in constructs like this:

|[&lt;!-- language="C" --&gt; 

static gsize initialization_value = 0;

if (g_once_init_enter (&amp;initialization_value))
  {
    gsize setup_value = 42; // initialization code here

    g_once_init_leave (&amp;initialization_value, setup_value);
  }

// use initialization_value here

]|

While @location has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func OnceInitEnterImpl 

func OnceInitEnterImpl(LocationVar uint) bool

func OnceInitEnterPointer 

func OnceInitEnterPointer(LocationVar uintptr) bool

This functions behaves in the same way as g_once_init_enter(), but can can be used to initialize pointers (or #guintptr) instead of #gsize.

|[&lt;!-- language="C" --&gt; 

static MyStruct *interesting_struct = NULL;

if (g_once_init_enter_pointer (&amp;interesting_struct))
  {
    MyStruct *setup_value = allocate_my_struct (); // initialization code here

    g_once_init_leave_pointer (&amp;interesting_struct, g_steal_pointer (&amp;setup_value));
  }

// use interesting_struct here

]|

func OnceInitLeave 

func OnceInitLeave(LocationVar *uintptr, ResultVar uint)

Counterpart to g_once_init_enter(). Expects a location of a static 0-initialized initialization variable, and an initialization value other than 0. Sets the variable to the initialization value, and releases concurrent threads blocking in g_once_init_enter() on this initialization variable.

While @location has a `volatile` qualifier, this is a historical artifact and the pointer passed to it should not be `volatile`.

func OnceInitLeavePointer 

func OnceInitLeavePointer(LocationVar uintptr, ResultVar uintptr)

Counterpart to g_once_init_enter_pointer(). Expects a location of a static `NULL`-initialized initialization variable, and an initialization value other than `NULL`. Sets the variable to the initialization value, and releases concurrent threads blocking in g_once_init_enter_pointer() on this initialization variable.

This functions behaves in the same way as g_once_init_leave(), but can be used to initialize pointers (or #guintptr) instead of #gsize.

func Open 

func Open(FilenameVar string, FlagsVar int, ModeVar int) int

A wrapper for the POSIX open() function. The open() function is used to convert a pathname into a file descriptor.

On POSIX systems file descriptors are implemented by the operating system. On Windows, it's the C library that implements open() and file descriptors. The actual Win32 API for opening files is quite different, see MSDN documentation for CreateFile(). The Win32 API uses file handles, which are more randomish integers, not small integers like file descriptors.

Because file descriptors are specific to the C library on Windows, the file descriptor returned by this function makes sense only to functions in the same C library. Thus if the GLib-using code uses a different C library than GLib does, the file descriptor returned by this function cannot be passed to C library functions like write() or read().

See your C library manual for more details about open().

func OptionGroupGLibType 

func OptionGroupGLibType() types.GType

func ParseDebugString 

func ParseDebugString(StringVar *string, KeysVar []DebugKey, NkeysVar uint) uint

Parses a string containing debugging options into a %guint containing bit flags. This is used within GDK and GTK to parse the debug options passed on the command line or through environment variables.

If @string is equal to "all", all flags are set. Any flags specified along with "all" in @string are inverted; thus, "all,foo,bar" or "foo,bar,all" sets all flags except those corresponding to "foo" and "bar".

If @string is equal to "help", all the available keys in @keys are printed out to standard error.

func PathBufEqual 

func PathBufEqual(V1Var uintptr, V2Var uintptr) bool

Compares two path buffers for equality and returns `TRUE` if they are equal.

The paths inside the path buffers are not going to be normalized, so `X/Y/Z/A/..`, `X/./Y/Z` and `X/Y/Z` are not going to be considered equal.

This function can be passed to g_hash_table_new() as the `key_equal_func` parameter.

func PathGetBasename 

func PathGetBasename(FileNameVar string) string

Gets the last component of the filename.

If @file_name ends with a directory separator it gets the component before the last slash. If @file_name consists only of directory separators (and on Windows, possibly a drive letter), a single separator is returned. If @file_name is empty, it gets ".".

func PathGetDirname 

func PathGetDirname(FileNameVar string) string

Gets the directory components of a file name. For example, the directory component of `/usr/bin/test` is `/usr/bin`. The directory component of `/` is `/`.

If the file name has no directory components "." is returned. The returned string should be freed when no longer needed.

func PathIsAbsolute 

func PathIsAbsolute(FileNameVar string) bool

Returns %TRUE if the given @file_name is an absolute file name. Note that this is a somewhat vague concept on Windows.

On POSIX systems, an absolute file name is well-defined. It always starts from the single root directory. For example "/usr/local".

On Windows, the concepts of current drive and drive-specific current directory introduce vagueness. This function interprets as an absolute file name one that either begins with a directory separator such as "\Users\tml" or begins with the root on a drive, for example "C:\Windows". The first case also includes UNC paths such as "\\\\myserver\docs\foo". In all cases, either slashes or backslashes are accepted.

Note that a file name relative to the current drive root does not truly specify a file uniquely over time and across processes, as the current drive is a per-process value and can be changed.

File names relative the current directory on some specific drive, such as "D:foo/bar", are not interpreted as absolute by this function, but they obviously are not relative to the normal current directory as returned by getcwd() or g_get_current_dir() either. Such paths should be avoided, or need to be handled using Windows-specific code.

func PathSkipRoot 

func PathSkipRoot(FileNameVar string) string

Returns a pointer into @file_name after the root component, i.e. after the "/" in UNIX or "C:\" under Windows. If @file_name is not an absolute path it returns %NULL.

func PatternMatch 

func PatternMatch(PspecVar *PatternSpec, StringLengthVar uint, StringVar string, StringReversedVar *string) bool

Matches a string against a compiled pattern.

Passing the correct length of the string given is mandatory. The reversed string can be omitted by passing `NULL`, this is more efficient if the reversed version of the string to be matched is not at hand, as `g_pattern_match()` will only construct it if the compiled pattern requires reverse matches.

Note that, if the user code will (possibly) match a string against a multitude of patterns containing wildcards, chances are high that some patterns will require a reversed string. In this case, it’s more efficient to provide the reversed string to avoid multiple constructions thereof in the various calls to `g_pattern_match()`.

Note also that the reverse of a UTF-8 encoded string can in general not be obtained by [func@GLib.strreverse]. This works only if the string does not contain any multibyte characters. GLib offers the [func@GLib.utf8_strreverse] function to reverse UTF-8 encoded strings.

func PatternMatchSimple 

func PatternMatchSimple(PatternVar string, StringVar string) bool

Matches a string against a pattern given as a string.

If this function is to be called in a loop, it’s more efficient to compile the pattern once with [ctor@GLib.PatternSpec.new] and call [method@GLib.PatternSpec.match_string] repeatedly.

func PatternMatchString 

func PatternMatchString(PspecVar *PatternSpec, StringVar string) bool

Matches a string against a compiled pattern.

If the string is to be matched against more than one pattern, consider using [method@GLib.PatternSpec.match] instead while supplying the reversed string.

func PatternSpecGLibType 

func PatternSpecGLibType() types.GType

func PointerBitLock 

func PointerBitLock(AddressVar uintptr, LockBitVar int)

This is equivalent to g_bit_lock, but working on pointers (or other pointer-sized values).

For portability reasons, you may only lock on the bottom 32 bits of the pointer.

While @address has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`.

func PointerBitLockAndGet 

func PointerBitLockAndGet(AddressVar uintptr, LockBitVar uint, OutPtrVar *uintptr)

This is equivalent to g_bit_lock, but working on pointers (or other pointer-sized values).

For portability reasons, you may only lock on the bottom 32 bits of the pointer.

func PointerBitLockMaskPtr 

func PointerBitLockMaskPtr(PtrVar uintptr, LockBitVar uint, SetVar bool, PreserveMaskVar uintptr, PreservePtrVar uintptr) uintptr

This mangles @ptr as g_pointer_bit_lock() and g_pointer_bit_unlock() do.

func PointerBitTrylock 

func PointerBitTrylock(AddressVar uintptr, LockBitVar int) bool

This is equivalent to g_bit_trylock(), but working on pointers (or other pointer-sized values).

For portability reasons, you may only lock on the bottom 32 bits of the pointer.

While @address has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`.

func PointerBitUnlock 

func PointerBitUnlock(AddressVar uintptr, LockBitVar int)

This is equivalent to g_bit_unlock, but working on pointers (or other pointer-sized values).

For portability reasons, you may only lock on the bottom 32 bits of the pointer.

While @address has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`.

func PointerBitUnlockAndSet 

func PointerBitUnlockAndSet(AddressVar uintptr, LockBitVar uint, PtrVar uintptr, PreserveMaskVar uintptr)

This is equivalent to g_pointer_bit_unlock() and atomically setting the pointer value.

Note that the lock bit will be cleared from the pointer. If the unlocked pointer that was set is not identical to @ptr, an assertion fails. In other words, @ptr must have @lock_bit unset. This also means, you usually can only use this on the lowest bits.

func Poll 

func Poll(FdsVar *PollFD, NfdsVar uint, TimeoutVar int) int

Polls @fds, as with the poll() system call, but portably. (On systems that don't have poll(), it is emulated using select().) This is used internally by #GMainContext, but it can be called directly if you need to block until a file descriptor is ready, but don't want to run the full main loop.

Each element of @fds is a #GPollFD describing a single file descriptor to poll. The @fd field indicates the file descriptor, and the @events field indicates the events to poll for. On return, the @revents fields will be filled with the events that actually occurred.

On POSIX systems, the file descriptors in @fds can be any sort of file descriptor, but the situation is much more complicated on Windows. If you need to use g_poll() in code that has to run on Windows, the easiest solution is to construct all of your #GPollFDs with g_io_channel_win32_make_pollfd().

func PollFDGLibType 

func PollFDGLibType() types.GType

func PrefixError 

func PrefixError(ErrVar **Error, FormatVar string, varArgs ...interface{})

Formats a string according to @format and prefix it to an existing error message. If @err is %NULL (ie: no error variable) then do nothing.

If `*err` is %NULL (ie: an error variable is present but there is no error condition) then also do nothing.

func PrefixErrorLiteral 

func PrefixErrorLiteral(ErrVar **Error, PrefixVar string)

Prefixes @prefix to an existing error message. If @err or `*err` is %NULL (i.e.: no error variable) then do nothing.

func Print 

func Print(FormatVar string, varArgs ...interface{})

Outputs a formatted message via the print handler.

The default print handler outputs the encoded message to `stdout`, without appending a trailing new-line character. Typically, @format should end with its own new-line character.

This function should not be used from within libraries for debugging messages, since it may be redirected by applications to special purpose message windows or even files. Instead, libraries should use [func@GLib.log], [func@GLib.log_structured], or the convenience macros [func@GLib.message], [func@GLib.warning] and [func@GLib.error].

func Printerr 

func Printerr(FormatVar string, varArgs ...interface{})

Outputs a formatted message via the error message handler.

The default handler outputs the encoded message to `stderr`, without appending a trailing new-line character. Typically, @format should end with its own new-line character.

This function should not be used from within libraries. Instead [func@GLib.log] or [func@GLib.log_structured] should be used, or the convenience macros [func@GLib.message], [func@GLib.warning] and [func@GLib.error].

func Printf 

func Printf(FormatVar string, varArgs ...interface{}) int

An implementation of the standard `printf()` function which supports positional parameters, as specified in the Single Unix Specification.

As with the standard `printf()`, this does not automatically append a trailing new-line character to the message, so typically @format should end with its own new-line character.

`glib/gprintf.h` must be explicitly included in order to use this function.

func PrintfStringUpperBound 

func PrintfStringUpperBound(FormatVar string, ArgsVar []interface{}) uint

Calculates the maximum space needed to store the output of the `sprintf()` function.

If @format or @args are invalid, `0` is returned. This could happen if, for example, @format contains an `%lc` or `%ls` placeholder and @args contains a wide character which cannot be represented in multibyte encoding. `0` can also be returned legitimately if, for example, @format is `%s` and @args is an empty string. The caller is responsible for differentiating these two return cases if necessary. It is recommended to not use `%lc` or `%ls` placeholders in any case, as their behaviour is locale-dependent.

func PropagateError 

func PropagateError(DestVar **Error, SrcVar *Error)

If @dest is %NULL, free @src; otherwise, moves @src into `*dest`. The error variable @dest points to must be %NULL.

@src must be non-%NULL.

Note that @src is no longer valid after this call. If you want to keep using the same GError*, you need to set it to %NULL after calling this function on it.

func PropagatePrefixedError 

func PropagatePrefixedError(DestVar **Error, SrcVar *Error, FormatVar string, varArgs ...interface{})

If @dest is %NULL, free @src; otherwise, moves @src into `*dest`. `*dest` must be %NULL. After the move, add a prefix as with g_prefix_error().

func PtrArrayFind 

func PtrArrayFind(HaystackVar []uintptr, NeedleVar uintptr, IndexVar *uint) bool

Checks whether @needle exists in @haystack. If the element is found, true is returned and the element’s index is returned in @index_ (if non-`NULL`). Otherwise, false is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned.

This does pointer comparisons only. If you want to use more complex equality checks, such as string comparisons, use [func@GLib.PtrArray.find_with_equal_func].

func PtrArrayFindWithEqualFunc 

func PtrArrayFindWithEqualFunc(HaystackVar []uintptr, NeedleVar uintptr, EqualFuncVar *EqualFunc, IndexVar *uint) bool

Checks whether @needle exists in @haystack, using the given @equal_func. If the element is found, true is returned and the element’s index is returned in @index_ (if non-`NULL`). Otherwise, false is returned and @index_ is undefined. If @needle exists multiple times in @haystack, the index of the first instance is returned.

@equal_func is called with the element from the array as its first parameter, and @needle as its second parameter. If @equal_func is `NULL`, pointer equality is used.

func PtrArrayGLibType 

func PtrArrayGLibType() types.GType

func PtrArrayNewFromArray 

func PtrArrayNewFromArray(DataVar []uintptr, LenVar uint, CopyFuncVar *CopyFunc, CopyFuncUserDataVar uintptr, ElementFreeFuncVar *DestroyNotify) uintptr

Creates a new `GPtrArray`, copying @len pointers from @data, and setting the array’s reference count to 1.

This avoids having to manually add each element one by one.

If @copy_func is provided, then it is used to copy each element before adding them to the new array. If it is `NULL` then the pointers are copied directly.

It also sets @element_free_func for freeing each element when the array is destroyed either via [func@GLib.PtrArray.unref], when [func@GLib.PtrArray.free] is called with @free_segment set to true or when removing elements.

Do not use it if @len is greater than [`G_MAXUINT`](types.html#guint). `GPtrArray` stores the length of its data in `guint`, which may be shorter than `gsize`.

func PtrArrayNewFromNullTerminatedArray 

func PtrArrayNewFromNullTerminatedArray(DataVar []uintptr, CopyFuncVar *CopyFunc, CopyFuncUserDataVar uintptr, ElementFreeFuncVar *DestroyNotify) uintptr

Creates a new `GPtrArray` copying the pointers from @data after having computed the length of it and with a reference count of 1. This avoids having to manually add each element one by one. If @copy_func is provided, then it is used to copy the data in the new array. It also sets @element_free_func for freeing each element when the array is destroyed either via [func@GLib.PtrArray.unref], when [func@GLib.PtrArray.free] is called with @free_segment set to true or when removing elements.

Do not use it if the @data has more than [`G_MAXUINT`](types.html#guint) elements. `GPtrArray` stores the length of its data in `guint`, which may be shorter than `gsize`.

func PtrArrayNewTake 

func PtrArrayNewTake(DataVar []uintptr, LenVar uint, ElementFreeFuncVar *DestroyNotify) uintptr

Creates a new `GPtrArray` with @data as pointers, @len as length and a reference count of 1.

This avoids having to copy such data manually. After this call, @data belongs to the `GPtrArray` and may no longer be modified by the caller. The memory of @data has to be dynamically allocated and will eventually be freed with [func@GLib.free].

It also sets @element_free_func for freeing each element when the array is destroyed either via [func@GLib.PtrArray.unref], when [func@GLib.PtrArray.free] is called with @free_segment set to true or when removing elements.

Do not use it if @len is greater than [`G_MAXUINT`](types.html#guint). `GPtrArray` stores the length of its data in `guint`, which may be shorter than `gsize`.

func PtrArrayNewTakeNullTerminated 

func PtrArrayNewTakeNullTerminated(DataVar []uintptr, ElementFreeFuncVar *DestroyNotify) uintptr

Creates a new `GPtrArray` with @data as pointers, computing the length of it and setting the reference count to 1.

This avoids having to copy such data manually. After this call, @data belongs to the `GPtrArray` and may no longer be modified by the caller. The memory of @data has to be dynamically allocated and will eventually be freed with [func@GLib.free].

The length is calculated by iterating through @data until the first `NULL` element is found.

It also sets @element_free_func for freeing each element when the array is destroyed either via [func@GLib.PtrArray.unref], when [func@GLib.PtrArray.free] is called with @free_segment set to true or when removing elements.

Do not use it if the @data length is greater than [`G_MAXUINT`](types.html#guint). `GPtrArray` stores the length of its data in `guint`, which may be shorter than `gsize`.

func QsortWithData 

func QsortWithData(PbaseVar uintptr, TotalElemsVar int, SizeVar uint, CompareFuncVar *CompareDataFunc, UserDataVar uintptr)

This is just like the standard C [`qsort()`](man:qsort(3)) function, but the comparison routine accepts a user data argument (like [`qsort_r()`](man:qsort_r(3))).

Unlike `qsort()`, this is guaranteed to be a stable sort (since GLib 2.32).

func QuarkToString 

func QuarkToString(QuarkVar Quark) string

Gets the string associated with the given #GQuark.

func RandGLibType 

func RandGLibType() types.GType

func RandomDouble 

func RandomDouble() float64

Returns a random #gdouble equally distributed over the range [0..1).

func RandomDoubleRange 

func RandomDoubleRange(BeginVar float64, EndVar float64) float64

Returns a random #gdouble equally distributed over the range [@begin..@end).

func RandomInt 

func RandomInt() uint32

Return a random #guint32 equally distributed over the range [0..2^32-1].

func RandomIntRange 

func RandomIntRange(BeginVar int32, EndVar int32) int32

Returns a random #gint32 equally distributed over the range [@begin..@end-1].

func RandomSetSeed 

func RandomSetSeed(SeedVar uint32)

Sets the seed for the global random number generator, which is used by the g_random_* functions, to @seed.

func RcBoxAcquire 

func RcBoxAcquire(MemBlockVar uintptr) uintptr

Acquires a reference on the data pointed by @mem_block.

func RcBoxAlloc 

func RcBoxAlloc(BlockSizeVar uint) uintptr

Allocates @block_size bytes of memory, and adds reference counting semantics to it.

The data will be freed when its reference count drops to zero.

The allocated data is guaranteed to be suitably aligned for any built-in type.

func RcBoxAlloc0 

func RcBoxAlloc0(BlockSizeVar uint) uintptr

Allocates @block_size bytes of memory, and adds reference counting semantics to it.

The contents of the returned data is set to zero.

The data will be freed when its reference count drops to zero.

The allocated data is guaranteed to be suitably aligned for any built-in type.

func RcBoxDup 

func RcBoxDup(BlockSizeVar uint, MemBlockVar uintptr) uintptr

Allocates a new block of data with reference counting semantics, and copies @block_size bytes of @mem_block into it.

func RcBoxGetSize 

func RcBoxGetSize(MemBlockVar uintptr) uint

Retrieves the size of the reference counted data pointed by @mem_block.

func RcBoxRelease 

func RcBoxRelease(MemBlockVar uintptr)

Releases a reference on the data pointed by @mem_block.

If the reference was the last one, it will free the resources allocated for @mem_block.

func RcBoxReleaseFull 

func RcBoxReleaseFull(MemBlockVar uintptr, ClearFuncVar *DestroyNotify)

Releases a reference on the data pointed by @mem_block.

If the reference was the last one, it will call @clear_func to clear the contents of @mem_block, and then will free the resources allocated for @mem_block.

func Realloc 

func Realloc(MemVar uintptr, NBytesVar uint) uintptr

Reallocates the memory pointed to by @mem, so that it now has space for @n_bytes bytes of memory. It returns the new address of the memory, which may have been moved. @mem may be %NULL, in which case it's considered to have zero-length. @n_bytes may be 0, in which case %NULL will be returned and @mem will be freed unless it is %NULL.

If the allocation fails (because the system is out of memory), the program is terminated.

func ReallocN 

func ReallocN(MemVar uintptr, NBlocksVar uint, NBlockBytesVar uint) uintptr

This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication.

If the allocation fails (because the system is out of memory), the program is terminated.

func RefCountCompare 

func RefCountCompare(RcVar int, ValVar int) bool

Compares the current value of @rc with @val.

func RefCountDec 

func RefCountDec(RcVar *int) bool

Decreases the reference count.

If %TRUE is returned, the reference count reached 0. After this point, @rc is an undefined state and must be reinitialized with g_ref_count_init() to be used again.

func RefCountInc 

func RefCountInc(RcVar *int)

Increases the reference count.

func RefCountInit 

func RefCountInit(RcVar *int)

Initializes a reference count variable to 1.

func RefStringAcquire 

func RefStringAcquire(StrVar string) string

Acquires a reference on a string.

func RefStringEqual 

func RefStringEqual(Str1Var string, Str2Var string) bool

Compares two ref-counted strings for byte-by-byte equality.

It can be passed to [func@GLib.HashTable.new] as the key equality function, and behaves exactly the same as [func@GLib.str_equal] (or `strcmp()`), but can return slightly faster as it can check the string lengths before checking all the bytes.

func RefStringLength 

func RefStringLength(StrVar string) uint

Retrieves the length of @str.

func RefStringNew 

func RefStringNew(StrVar string) string

Creates a new reference counted string and copies the contents of @str into it.

func RefStringNewIntern 

func RefStringNewIntern(StrVar string) string

Creates a new reference counted string and copies the content of @str into it.

If you call this function multiple times with the same @str, or with the same contents of @str, it will return a new reference, instead of creating a new string.

func RefStringNewLen 

func RefStringNewLen(StrVar string, LenVar int) string

Creates a new reference counted string and copies the contents of @str into it, up to @len bytes.

Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that @str has at least @len addressable bytes.

func RefStringRelease 

func RefStringRelease(StrVar string)

Releases a reference on a string; if it was the last reference, the resources allocated by the string are freed as well.

func RegexCheckReplacement 

func RegexCheckReplacement(ReplacementVar string, HasReferencesVar *bool) (bool, error)

Checks whether @replacement is a valid replacement string (see g_regex_replace()), i.e. that all escape sequences in it are valid.

If @has_references is not %NULL then @replacement is checked for pattern references. For instance, replacement text 'foo\n' does not contain references and may be evaluated without information about actual match, but '\0\1' (whole match followed by first subpattern) requires valid #GMatchInfo object.

func RegexEscapeNul 

func RegexEscapeNul(StringVar string, LengthVar int) string

Escapes the nul characters in @string to "\x00". It can be used to compile a regex with embedded nul characters.

For completeness, @length can be -1 for a nul-terminated string. In this case the output string will be of course equal to @string.

func RegexEscapeString 

func RegexEscapeString(StringVar string, LengthVar int) string

Escapes the special characters used for regular expressions in @string, for instance "a.b*c" becomes "a\.b\*c". This function is useful to dynamically generate regular expressions.

@string can contain nul characters that are replaced with "\0", in this case remember to specify the correct length of @string in @length.

func RegexGLibType 

func RegexGLibType() types.GType

func RegexMatchSimple 

func RegexMatchSimple(PatternVar string, StringVar string, CompileOptionsVar RegexCompileFlags, MatchOptionsVar RegexMatchFlags) bool

Scans for a match in @string for @pattern.

This function is equivalent to g_regex_match() but it does not require to compile the pattern with g_regex_new(), avoiding some lines of code when you need just to do a match without extracting substrings, capture counts, and so on.

If this function is to be called on the same @pattern more than once, it's more efficient to compile the pattern once with g_regex_new() and then use g_regex_match().

func RegexSplitSimple 

func RegexSplitSimple(PatternVar string, StringVar string, CompileOptionsVar RegexCompileFlags, MatchOptionsVar RegexMatchFlags) []string

Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first token.

This function is equivalent to g_regex_split() but it does not require to compile the pattern with g_regex_new(), avoiding some lines of code when you need just to do a split without extracting substrings, capture counts, and so on.

If this function is to be called on the same @pattern more than once, it's more efficient to compile the pattern once with g_regex_new() and then use g_regex_split().

As a special case, the result of splitting the empty string "" is an empty vector, not a vector containing a single string. The reason for this special case is that being able to represent an empty vector is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling this function.

A pattern that can match empty strings splits @string into separate characters wherever it matches the empty string between characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c".

func ReloadUserSpecialDirsCache 

func ReloadUserSpecialDirsCache()

Resets the cache used for g_get_user_special_dir(), so that the latest on-disk version is used. Call this only if you just changed the data on disk yourself.

Due to thread safety issues this may cause leaking of strings that were previously returned from g_get_user_special_dir() that can't be freed. We ensure to only leak the data for the directories that actually changed value though.

func Remove 

func Remove(FilenameVar string) int

A wrapper for the POSIX remove() function. The remove() function deletes a name from the filesystem.

See your C library manual for more details about how remove() works on your system. On Unix, remove() removes also directories, as it calls unlink() for files and rmdir() for directories. On Windows, although remove() in the C library only works for files, this function tries first remove() and then if that fails rmdir(), and thus works for both files and directories. Note however, that on Windows, it is in general not possible to remove a file that is open to some process, or mapped into memory.

If this function fails on Windows you can't infer too much from the errno value. rmdir() is tried regardless of what caused remove() to fail. Any errno value set by remove() will be overwritten by that set by rmdir().

func RemoveCallback 

func RemoveCallback(cbPtr uintptr)

RemoveCallback removes a callback from the registry. Users should not need to call this.

func RemoveCallbackByHandler 

func RemoveCallbackByHandler(handlerID uint)

RemoveCallbackByHandler removes a callback from the registry using a signal handler ID.

func Rename 

func Rename(OldfilenameVar string, NewfilenameVar string) int

A wrapper for the POSIX rename() function. The rename() function renames a file, moving it between directories if required.

See your C library manual for more details about how rename() works on your system. It is not possible in general on Windows to rename a file that is open to some process.

func ReturnIfFailWarning 

func ReturnIfFailWarning(LogDomainVar *string, PrettyFunctionVar string, ExpressionVar *string)

Internal function used to print messages from the public [func@GLib.return_if_fail] and [func@GLib.return_val_if_fail] macros.

func Rmdir 

func Rmdir(FilenameVar string) int

A wrapper for the POSIX rmdir() function. The rmdir() function deletes a directory from the filesystem.

See your C library manual for more details about how rmdir() works on your system.

func SaveCallback 

func SaveCallback(cbPtr uintptr, refPtr uintptr)

SaveCallback saves a reference to the callback value. Users should not need to call this.

func SaveCallbackWithClosure 

func SaveCallbackWithClosure(cbPtr uintptr, refPtr uintptr, closure interface{})

SaveCallbackWithClosure saves a reference to the callback value and retains the provided closure to prevent it from being garbage collected. Users should not need to call this.

func SaveHandlerMapping 

func SaveHandlerMapping(handlerID uint, cbPtr uintptr)

SaveHandlerMapping records a signal handler ID → callback pointer mapping so DisconnectSignal can clean up the callback registry.

func SequenceForeachRange 

func SequenceForeachRange(BeginVar *SequenceIter, EndVar *SequenceIter, FuncVar *Func, UserDataVar uintptr)

Calls @func for each item in the range (@begin, @end) passing @user_data to the function. @func must not modify the sequence itself.

func SequenceGet 

func SequenceGet(IterVar *SequenceIter) uintptr

Returns the data that @iter points to.

func SequenceMove 

func SequenceMove(SrcVar *SequenceIter, DestVar *SequenceIter)

Moves the item pointed to by @src to the position indicated by @dest. After calling this function @dest will point to the position immediately after @src. It is allowed for @src and @dest to point into different sequences.

func SequenceMoveRange 

func SequenceMoveRange(DestVar *SequenceIter, BeginVar *SequenceIter, EndVar *SequenceIter)

Inserts the (@begin, @end) range at the destination pointed to by @dest. The @begin and @end iters must point into the same sequence. It is allowed for @dest to point to a different sequence than the one pointed into by @begin and @end.

If @dest is %NULL, the range indicated by @begin and @end is removed from the sequence. If @dest points to a place within the (@begin, @end) range, the range does not move.

func SequenceRemove 

func SequenceRemove(IterVar *SequenceIter)

Removes the item pointed to by @iter. It is an error to pass the end iterator to this function.

If the sequence has a data destroy function associated with it, this function is called on the data for the removed item.

func SequenceRemoveRange 

func SequenceRemoveRange(BeginVar *SequenceIter, EndVar *SequenceIter)

Removes all items in the (@begin, @end) range.

If the sequence has a data destroy function associated with it, this function is called on the data for the removed items.

func SequenceSet 

func SequenceSet(IterVar *SequenceIter, DataVar uintptr)

Changes the data for the item pointed to by @iter to be @data. If the sequence has a data destroy function associated with it, that function is called on the existing data that @iter pointed to.

func SequenceSortChanged 

func SequenceSortChanged(IterVar *SequenceIter, CmpFuncVar *CompareDataFunc, CmpDataVar uintptr)

Moves the data pointed to by @iter to a new position as indicated by @cmp_func. This function should be called for items in a sequence already sorted according to @cmp_func whenever some aspect of an item changes so that @cmp_func may return different values for that item.

@cmp_func is called with two items of the @seq, and @cmp_data. It should return 0 if the items are equal, a negative value if the first item comes before the second, and a positive value if the second item comes before the first.

func SequenceSortChangedIter 

func SequenceSortChangedIter(IterVar *SequenceIter, IterCmpVar *SequenceIterCompareFunc, CmpDataVar uintptr)

Like g_sequence_sort_changed(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

@iter_cmp is called with two iterators pointing into the #GSequence that @iter points into. It should return 0 if the iterators are equal, a negative value if the first iterator comes before the second, and a positive value if the second iterator comes before the first.

func SequenceSwap 

func SequenceSwap(AVar *SequenceIter, BVar *SequenceIter)

Swaps the items pointed to by @a and @b. It is allowed for @a and @b to point into difference sequences.

func SetApplicationName 

func SetApplicationName(ApplicationNameVar string)

Sets a human-readable name for the application. This name should be localized if possible, and is intended for display to the user. Contrast with g_set_prgname(), which sets a non-localized name. g_set_prgname() will be called automatically by gtk_init(), but g_set_application_name() will not.

Note that for thread safety reasons, this function can only be called once.

The application name will be used in contexts such as error messages, or when displaying an application's name in the task list.

func SetError 

func SetError(ErrVar **Error, DomainVar Quark, CodeVar int, FormatVar string, varArgs ...interface{})

Does nothing if @err is %NULL; if @err is non-%NULL, then `*err` must be %NULL. A new #GError is created and assigned to `*err`.

func SetErrorLiteral 

func SetErrorLiteral(ErrVar **Error, DomainVar Quark, CodeVar int, MessageVar string)

Does nothing if @err is %NULL; if @err is non-%NULL, then `*err` must be %NULL. A new #GError is created and assigned to `*err`. Unlike g_set_error(), @message is not a printf()-style format string. Use this function if @message contains text you don't have control over, that could include printf() escape sequences.

func SetPrgname 

func SetPrgname(PrgnameVar string)

Sets the name of the program. This name should not be localized, in contrast to g_set_application_name().

If you are using #GApplication the program name is set in g_application_run(). In case of GDK or GTK it is set in gdk_init(), which is called by gtk_init() and the #GtkApplication::startup handler. By default, the program name is found by taking the last component of @argv[0].

Since GLib 2.72, this function can be called multiple times and is fully thread safe. Prior to GLib 2.72, this function could only be called once per process.

See the [GTK documentation](https://docs.gtk.org/gtk4/migrating-3to4.html#set-a-proper-application-id) for requirements on integrating g_set_prgname() with GTK applications.

func SetPrintHandler 

func SetPrintHandler(FuncVar *PrintFunc) uintptr

Sets the print handler to @func, or resets it to the default GLib handler if `NULL`.

Any messages passed to [func@GLib.print] will be output via the new handler. The default handler outputs the encoded message to `stdout`. By providing your own handler you can redirect the output, to a GTK widget or a log file for example.

Since 2.76 this functions always returns a valid [type@GLib.PrintFunc], and never returns `NULL`. If no custom print handler was set, it will return the GLib default print handler and that can be re-used to decorate its output and/or to write to `stderr` in all platforms. Before GLib 2.76, this was `NULL`.

func SetPrinterrHandler 

func SetPrinterrHandler(FuncVar *PrintFunc) uintptr

Sets the handler for printing error messages to @func, or resets it to the default GLib handler if `NULL`.

Any messages passed to [func@GLib.printerr] will be output via the new handler. The default handler outputs the encoded message to `stderr`. By providing your own handler you can redirect the output, to a GTK widget or a log file for example.

Since 2.76 this functions always returns a valid [type@GLib.PrintFunc], and never returns `NULL`. If no custom error print handler was set, it will return the GLib default error print handler and that can be re-used to decorate its output and/or to write to `stderr` in all platforms. Before GLib 2.76, this was `NULL`.

func Setenv 

func Setenv(VariableVar string, ValueVar string, OverwriteVar bool) bool

Sets an environment variable. On UNIX, both the variable's name and value can be arbitrary byte strings, except that the variable's name cannot contain '='. On Windows, they should be in UTF-8.

Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed.

You should be mindful of the fact that environment variable handling in UNIX is not thread-safe, and your program may crash if one thread calls g_setenv() while another thread is calling getenv(). (And note that many functions, such as gettext(), call getenv() internally.) This function is only safe to use at the very start of your program, before creating any other threads (or creating objects that create worker threads of their own).

If you need to set up the environment for a child process, you can use g_get_environ() to get an environment array, modify that with g_environ_setenv() and g_environ_unsetenv(), and then pass that array directly to execvpe(), g_spawn_async(), or the like.

func ShellParseArgv 

func ShellParseArgv(CommandLineVar string, ArgcpVar *int, ArgvpVar *[]string) (bool, error)

Parses a command line into an argument vector, in much the same way the shell would, but without many of the expansions the shell would perform (variable expansion, globs, operators, filename expansion, etc. are not supported).

The results are defined to be the same as those you would get from a UNIX98 `/bin/sh`, as long as the input contains none of the unsupported shell expansions. If the input does contain such expansions, they are passed through literally.

Possible errors are those from the %G_SHELL_ERROR domain.

In particular, if @command_line is an empty string (or a string containing only whitespace), %G_SHELL_ERROR_EMPTY_STRING will be returned. It’s guaranteed that @argvp will be a non-empty array if this function returns successfully.

Free the returned vector with g_strfreev().

func ShellQuote 

func ShellQuote(UnquotedStringVar string) string

Quotes a string so that the shell (/bin/sh) will interpret the quoted string to mean @unquoted_string.

If you pass a filename to the shell, for example, you should first quote it with this function.

The return value must be freed with g_free().

The quoting style used is undefined (single or double quotes may be used).

func ShellUnquote 

func ShellUnquote(QuotedStringVar string) (string, error)

Unquotes a string as the shell (/bin/sh) would.

This function only handles quotes; if a string contains file globs, arithmetic operators, variables, backticks, redirections, or other special-to-the-shell features, the result will be different from the result a real shell would produce (the variables, backticks, etc. will be passed through literally instead of being expanded).

This function is guaranteed to succeed if applied to the result of g_shell_quote(). If it fails, it returns %NULL and sets the error.

The @quoted_string need not actually contain quoted or escaped text; g_shell_unquote() simply goes through the string and unquotes/unescapes anything that the shell would. Both single and double quotes are handled, as are escapes including escaped newlines.

The return value must be freed with g_free().

Possible errors are in the %G_SHELL_ERROR domain.

Shell quoting rules are a bit strange. Single quotes preserve the literal string exactly. escape sequences are not allowed; not even `\'` - if you want a `'` in the quoted text, you have to do something like `'foo'\”bar'`. Double quotes allow `$`, ```, `"`, `\`, and newline to be escaped with backslash. Otherwise double quotes preserve things literally.

func SliceAlloc 

func SliceAlloc(BlockSizeVar uint) uintptr

Allocates a block of memory from the libc allocator.

The block address handed out can be expected to be aligned to at least `1 * sizeof (void*)`.

Since GLib 2.76 this always uses the system malloc() implementation internally.

func SliceAlloc0 

func SliceAlloc0(BlockSizeVar uint) uintptr

Allocates a block of memory via g_slice_alloc() and initializes the returned memory to 0.

Since GLib 2.76 this always uses the system malloc() implementation internally.

func SliceCopy 

func SliceCopy(BlockSizeVar uint, MemBlockVar uintptr) uintptr

Allocates a block of memory from the slice allocator and copies @block_size bytes into it from @mem_block.

@mem_block must be non-%NULL if @block_size is non-zero.

Since GLib 2.76 this always uses the system malloc() implementation internally.

func SliceFree1 

func SliceFree1(BlockSizeVar uint, MemBlockVar uintptr)

Frees a block of memory.

The memory must have been allocated via g_slice_alloc() or g_slice_alloc0() and the @block_size has to match the size specified upon allocation. Note that the exact release behaviour can be changed with the [`G_DEBUG=gc-friendly`](running.html#environment-variables) environment variable.

If @mem_block is %NULL, this function does nothing.

Since GLib 2.76 this always uses the system free_sized() implementation internally.

func SliceFreeChainWithOffset 

func SliceFreeChainWithOffset(BlockSizeVar uint, MemChainVar uintptr, NextOffsetVar uint)

Frees a linked list of memory blocks of structure type @type.

The memory blocks must be equal-sized, allocated via g_slice_alloc() or g_slice_alloc0() and linked together by a @next pointer (similar to #GSList). The offset of the @next field in each block is passed as third argument. Note that the exact release behaviour can be changed with the [`G_DEBUG=gc-friendly`](running.html#environment-variables) environment variable.

If @mem_chain is %NULL, this function does nothing.

Since GLib 2.76 this always uses the system free_sized() implementation internally.

func SliceGetConfig 

func SliceGetConfig(CkeyVar SliceConfig) int64

func SliceGetConfigState 

func SliceGetConfigState(CkeyVar SliceConfig, AddressVar int64, NValuesVar uint) int64

func SliceSetConfig 

func SliceSetConfig(CkeyVar SliceConfig, ValueVar int64)

func SlistPopAllocator 

func SlistPopAllocator()

func SlistPushAllocator 

func SlistPushAllocator(AllocatorVar *Allocator)

func Snprintf 

func Snprintf(StringVar string, NVar uint, FormatVar string, varArgs ...interface{}) int

A safer form of the standard sprintf() function. The output is guaranteed to not exceed @n characters (including the terminating nul character), so it is easy to ensure that a buffer overflow cannot occur.

See also [func@GLib.strdup_printf].

In versions of GLib prior to 1.2.3, this function may return -1 if the output was truncated, and the truncated string may not be nul-terminated. In versions prior to 1.3.12, this function returns the length of the output string.

The return value of g_snprintf() conforms to the snprintf() function as standardized in ISO C99. Note that this is different from traditional `snprintf()`, which returns the length of the output string.

The format string may contain positional parameters, as specified in the Single Unix Specification.

func SortArray 

func SortArray(ArrayVar []uintptr, NElementsVar uint, ElementSizeVar uint, CompareFuncVar *CompareDataFunc, UserDataVar uintptr)

This is just like the standard C [`qsort()`](man:qsort(3)) function, but the comparison routine accepts a user data argument (like [`qsort_r()`](man:qsort_r(3))).

Unlike `qsort()`, this is guaranteed to be a stable sort.

func SourceGLibType 

func SourceGLibType() types.GType

func SourceRemove 

func SourceRemove(TagVar uint) bool

Removes the source with the given ID from the default main context.

You must use [method@GLib.Source.destroy] for sources added to a non-default main context.

The ID of a [struct@GLib.Source] is given by [method@GLib.Source.get_id], or will be returned by the functions [method@GLib.Source.attach], [func@GLib.idle_add], [func@GLib.idle_add_full], [func@GLib.timeout_add], [func@GLib.timeout_add_full], [func@GLib.child_watch_add], [func@GLib.child_watch_add_full], [func@GLib.io_add_watch], and [func@GLib.io_add_watch_full].

It is a programmer error to attempt to remove a non-existent source.

More specifically: source IDs can be reissued after a source has been destroyed and therefore it is never valid to use this function with a source ID which may have already been removed. An example is when scheduling an idle to run in another thread with [func@GLib.idle_add]: the idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source.

func SourceRemoveByFuncsUserData 

func SourceRemoveByFuncsUserData(FuncsVar *SourceFuncs, UserDataVar uintptr) bool

Removes a source from the default main loop context given the source functions and user data.

If multiple sources exist with the same source functions and user data, only one will be destroyed.

func SourceRemoveByUserData 

func SourceRemoveByUserData(UserDataVar uintptr) bool

Removes a source from the default main loop context given the user data for the callback.

If multiple sources exist with the same user data, only one will be destroyed.

func SourceSetNameById 

func SourceSetNameById(TagVar uint, NameVar string)

Sets the name of a source using its ID.

This is a convenience utility to set source names from the return value of [func@GLib.idle_add], [func@GLib.timeout_add], etc.

It is a programmer error to attempt to set the name of a non-existent source.

More specifically: source IDs can be reissued after a source has been destroyed and therefore it is never valid to use this function with a source ID which may have already been removed. An example is when scheduling an idle to run in another thread with [func@GLib.idle_add]: the idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source.

func SpacedPrimesClosest 

func SpacedPrimesClosest(NumVar uint) uint

Gets the smallest prime number from a built-in array of primes which is larger than @num. This is used within GLib to calculate the optimum size of a #GHashTable.

The built-in array of primes ranges from 11 to 13845163 such that each prime is approximately 1.5-2 times the previous prime.

func SpawnAsync 

func SpawnAsync(WorkingDirectoryVar *string, ArgvVar []string, EnvpVar []string, FlagsVar SpawnFlags, ChildSetupVar *SpawnChildSetupFunc, UserDataVar uintptr, ChildPidVar *Pid) (bool, error)

Executes a child program asynchronously.

See g_spawn_async_with_pipes_and_fds() for a full description; this function simply calls the g_spawn_async_with_pipes() without any pipes, which in turn calls g_spawn_async_with_pipes_and_fds().

You should call g_spawn_close_pid() on the returned child process reference when you don't need it any more.

If you are writing a GTK application, and the program you are spawning is a graphical application too, then to ensure that the spawned program opens its windows on the right screen, you may want to use #GdkAppLaunchContext, #GAppLaunchContext, or set the %DISPLAY environment variable.

Note that the returned @child_pid on Windows is a handle to the child process and not its identifier. Process handles and process identifiers are different concepts on Windows.

func SpawnAsyncWithFds 

func SpawnAsyncWithFds(WorkingDirectoryVar *string, ArgvVar []string, EnvpVar []string, FlagsVar SpawnFlags, ChildSetupVar *SpawnChildSetupFunc, UserDataVar uintptr, ChildPidVar *Pid, StdinFdVar int, StdoutFdVar int, StderrFdVar int) (bool, error)

Executes a child program asynchronously.

Identical to g_spawn_async_with_pipes_and_fds() but with `n_fds` set to zero, so no FD assignments are used.

func SpawnAsyncWithPipes 

func SpawnAsyncWithPipes(WorkingDirectoryVar *string, ArgvVar []string, EnvpVar []string, FlagsVar SpawnFlags, ChildSetupVar *SpawnChildSetupFunc, UserDataVar uintptr, ChildPidVar *Pid, StandardInputVar *int, StandardOutputVar *int, StandardErrorVar *int) (bool, error)

Identical to g_spawn_async_with_pipes_and_fds() but with `n_fds` set to zero, so no FD assignments are used.

func SpawnAsyncWithPipesAndFds 

func SpawnAsyncWithPipesAndFds(WorkingDirectoryVar *string, ArgvVar []string, EnvpVar []string, FlagsVar SpawnFlags, ChildSetupVar *SpawnChildSetupFunc, UserDataVar uintptr, StdinFdVar int, StdoutFdVar int, StderrFdVar int, SourceFdsVar []int, TargetFdsVar []int, NFdsVar uint, ChildPidOutVar *Pid, StdinPipeOutVar *int, StdoutPipeOutVar *int, StderrPipeOutVar *int) (bool, error)

Executes a child program asynchronously (your program will not block waiting for the child to exit).

The child program is specified by the only argument that must be provided, @argv. @argv should be a %NULL-terminated array of strings, to be passed as the argument vector for the child. The first string in @argv is of course the name of the program to execute. By default, the name of the program must be a full path. If @flags contains the %G_SPAWN_SEARCH_PATH flag, the `PATH` environment variable is used to search for the executable. If @flags contains the %G_SPAWN_SEARCH_PATH_FROM_ENVP flag, the `PATH` variable from @envp is used to search for the executable. If both the %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP flags are set, the `PATH` variable from @envp takes precedence over the environment variable.

If the program name is not a full path and %G_SPAWN_SEARCH_PATH flag is not used, then the program will be run from the current directory (or @working_directory, if specified); this might be unexpected or even dangerous in some cases when the current directory is world-writable.

On Windows, note that all the string or string vector arguments to this function and the other `g_spawn*()` functions are in UTF-8, the GLib file name encoding. Unicode characters that are not part of the system codepage passed in these arguments will be correctly available in the spawned program only if it uses wide character API to retrieve its command line. For C programs built with Microsoft's tools it is enough to make the program have a `wmain()` instead of `main()`. `wmain()` has a wide character argument vector as parameter.

At least currently, mingw doesn't support `wmain()`, so if you use mingw to develop the spawned program, it should call g_win32_get_command_line() to get arguments in UTF-8.

On Windows the low-level child process creation API `CreateProcess()` doesn't use argument vectors, but a command line. The C runtime library's `spawn*()` family of functions (which g_spawn_async_with_pipes() eventually calls) paste the argument vector elements together into a command line, and the C runtime startup code does a corresponding reconstruction of an argument vector from the command line, to be passed to `main()`. Complications arise when you have argument vector elements that contain spaces or double quotes. The `spawn*()` functions don't do any quoting or escaping, but on the other hand the startup code does do unquoting and unescaping in order to enable receiving arguments with embedded spaces or double quotes. To work around this asymmetry, g_spawn_async_with_pipes() will do quoting and escaping on argument vector elements that need it before calling the C runtime `spawn()` function.

The returned @child_pid on Windows is a handle to the child process, not its identifier. Process handles and process identifiers are different concepts on Windows.

@envp is a %NULL-terminated array of strings, where each string has the form `KEY=VALUE`. This will become the child's environment. If @envp is %NULL, the child inherits its parent's environment.

@flags should be the bitwise OR of any flags you want to affect the function's behaviour. The %G_SPAWN_DO_NOT_REAP_CHILD means that the child will not automatically be reaped; you must use a child watch (g_child_watch_add()) to be notified about the death of the child process, otherwise it will stay around as a zombie process until this process exits. Eventually you must call g_spawn_close_pid() on the @child_pid, in order to free resources which may be associated with the child process. (On Unix, using a child watch is equivalent to calling waitpid() or handling the `SIGCHLD` signal manually. On Windows, calling g_spawn_close_pid() is equivalent to calling `CloseHandle()` on the process handle returned in @child_pid). See g_child_watch_add().

Open UNIX file descriptors marked as `FD_CLOEXEC` will be automatically closed in the child process. %G_SPAWN_LEAVE_DESCRIPTORS_OPEN means that other open file descriptors will be inherited by the child; otherwise all descriptors except stdin/stdout/stderr will be closed before calling `exec()` in the child. %G_SPAWN_SEARCH_PATH means that @argv[0] need not be an absolute path, it will be looked for in the `PATH` environment variable. %G_SPAWN_SEARCH_PATH_FROM_ENVP means need not be an absolute path, it will be looked for in the `PATH` variable from @envp. If both %G_SPAWN_SEARCH_PATH and %G_SPAWN_SEARCH_PATH_FROM_ENVP are used, the value from @envp takes precedence over the environment.

%G_SPAWN_CHILD_INHERITS_STDIN means that the child will inherit the parent's standard input (by default, the child's standard input is attached to `/dev/null`). %G_SPAWN_STDIN_FROM_DEV_NULL explicitly imposes the default behavior. Both flags cannot be enabled at the same time and, in both cases, the @stdin_pipe_out argument is ignored.

%G_SPAWN_STDOUT_TO_DEV_NULL means that the child's standard output will be discarded (by default, it goes to the same location as the parent's standard output). %G_SPAWN_CHILD_INHERITS_STDOUT explicitly imposes the default behavior. Both flags cannot be enabled at the same time and, in both cases, the @stdout_pipe_out argument is ignored.

%G_SPAWN_STDERR_TO_DEV_NULL means that the child's standard error will be discarded (by default, it goes to the same location as the parent's standard error). %G_SPAWN_CHILD_INHERITS_STDERR explicitly imposes the default behavior. Both flags cannot be enabled at the same time and, in both cases, the @stderr_pipe_out argument is ignored.

It is valid to pass the same FD in multiple parameters (e.g. you can pass a single FD for both @stdout_fd and @stderr_fd, and include it in @source_fds too).

@source_fds and @target_fds allow zero or more FDs from this process to be remapped to different FDs in the spawned process. If @n_fds is greater than zero, @source_fds and @target_fds must both be non-%NULL and the same length. Each FD in @source_fds is remapped to the FD number at the same index in @target_fds. The source and target FD may be equal to simply propagate an FD to the spawned process. FD remappings are processed after standard FDs, so any target FDs which equal @stdin_fd, @stdout_fd or @stderr_fd will overwrite them in the spawned process.

@source_fds is supported on Windows since 2.72.

%G_SPAWN_FILE_AND_ARGV_ZERO means that the first element of @argv is the file to execute, while the remaining elements are the actual argument vector to pass to the file. Normally g_spawn_async_with_pipes() uses @argv[0] as the file to execute, and passes all of @argv to the child.

@child_setup and @user_data are a function and user data. On POSIX platforms, the function is called in the child after GLib has performed all the setup it plans to perform (including creating pipes, closing file descriptors, etc.) but before calling `exec()`. That is, @child_setup is called just before calling `exec()` in the child. Obviously actions taken in this function will only affect the child, not the parent.

On Windows, there is no separate `fork()` and `exec()` functionality. Child processes are created and run with a single API call, `CreateProcess()`. There is no sensible thing @child_setup could be used for on Windows so it is ignored and not called.

If non-%NULL, @child_pid will on Unix be filled with the child's process ID. You can use the process ID to send signals to the child, or to use g_child_watch_add() (or `waitpid()`) if you specified the %G_SPAWN_DO_NOT_REAP_CHILD flag. On Windows, @child_pid will be filled with a handle to the child process only if you specified the %G_SPAWN_DO_NOT_REAP_CHILD flag. You can then access the child process using the Win32 API, for example wait for its termination with the `WaitFor*()` functions, or examine its exit code with `GetExitCodeProcess()`. You should close the handle with `CloseHandle()` or g_spawn_close_pid() when you no longer need it.

If non-%NULL, the @stdin_pipe_out, @stdout_pipe_out, @stderr_pipe_out locations will be filled with file descriptors for writing to the child's standard input or reading from its standard output or standard error. The caller of g_spawn_async_with_pipes() must close these file descriptors when they are no longer in use. If these parameters are %NULL, the corresponding pipe won't be created.

If @stdin_pipe_out is %NULL, the child's standard input is attached to `/dev/null` unless %G_SPAWN_CHILD_INHERITS_STDIN is set.

If @stderr_pipe_out is NULL, the child's standard error goes to the same location as the parent's standard error unless %G_SPAWN_STDERR_TO_DEV_NULL is set.

If @stdout_pipe_out is NULL, the child's standard output goes to the same location as the parent's standard output unless %G_SPAWN_STDOUT_TO_DEV_NULL is set.

@error can be %NULL to ignore errors, or non-%NULL to report errors. If an error is set, the function returns %FALSE. Errors are reported even if they occur in the child (for example if the executable in `@argv[0]` is not found). Typically the `message` field of returned errors should be displayed to users. Possible errors are those from the %G_SPAWN_ERROR domain.

If an error occurs, @child_pid, @stdin_pipe_out, @stdout_pipe_out, and @stderr_pipe_out will not be filled with valid values.

If @child_pid is not %NULL and an error does not occur then the returned process reference must be closed using g_spawn_close_pid().

On modern UNIX platforms, GLib can use an efficient process launching codepath driven internally by `posix_spawn()`. This has the advantage of avoiding the fork-time performance costs of cloning the parent process address space, and avoiding associated memory overcommit checks that are not relevant in the context of immediately executing a distinct process. This optimized codepath will be used provided that the following conditions are met:

  1. %G_SPAWN_DO_NOT_REAP_CHILD is set
  2. %G_SPAWN_LEAVE_DESCRIPTORS_OPEN is set
  3. %G_SPAWN_SEARCH_PATH_FROM_ENVP is not set
  4. @working_directory is %NULL
  5. @child_setup is %NULL
  6. The program is of a recognised binary format, or has a shebang. Otherwise, GLib will have to execute the program through the shell, which is not done using the optimized codepath.

If you are writing a GTK application, and the program you are spawning is a graphical application too, then to ensure that the spawned program opens its windows on the right screen, you may want to use #GdkAppLaunchContext, #GAppLaunchContext, or set the `DISPLAY` environment variable.

func SpawnCheckExitStatus 

func SpawnCheckExitStatus(WaitStatusVar int) (bool, error)

An old name for g_spawn_check_wait_status(), deprecated because its name is misleading.

Despite the name of the function, @wait_status must be the wait status as returned by g_spawn_sync(), g_subprocess_get_status(), `waitpid()`, etc. On Unix platforms, it is incorrect for it to be the exit status as passed to `exit()` or returned by g_subprocess_get_exit_status() or `WEXITSTATUS()`.

func SpawnCheckWaitStatus 

func SpawnCheckWaitStatus(WaitStatusVar int) (bool, error)

Set @error if @wait_status indicates the child exited abnormally (e.g. with a nonzero exit code, or via a fatal signal).

The g_spawn_sync() and g_child_watch_add() family of APIs return the status of subprocesses encoded in a platform-specific way. On Unix, this is guaranteed to be in the same format waitpid() returns, and on Windows it is guaranteed to be the result of GetExitCodeProcess().

Prior to the introduction of this function in GLib 2.34, interpreting @wait_status required use of platform-specific APIs, which is problematic for software using GLib as a cross-platform layer.

Additionally, many programs simply want to determine whether or not the child exited successfully, and either propagate a #GError or print a message to standard error. In that common case, this function can be used. Note that the error message in @error will contain human-readable information about the wait status.

The @domain and @code of @error have special semantics in the case where the process has an "exit code", as opposed to being killed by a signal. On Unix, this happens if WIFEXITED() would be true of @wait_status. On Windows, it is always the case.

The special semantics are that the actual exit code will be the code set in @error, and the domain will be %G_SPAWN_EXIT_ERROR. This allows you to differentiate between different exit codes.

If the process was terminated by some means other than an exit status (for example if it was killed by a signal), the domain will be %G_SPAWN_ERROR and the code will be %G_SPAWN_ERROR_FAILED.

This function just offers convenience; you can of course also check the available platform via a macro such as %G_OS_UNIX, and use WIFEXITED() and WEXITSTATUS() on @wait_status directly. Do not attempt to scan or parse the error message string; it may be translated and/or change in future versions of GLib.

Prior to version 2.70, g_spawn_check_exit_status() provides the same functionality, although under a misleading name.

func SpawnClosePid 

func SpawnClosePid(PidVar Pid)

On some platforms, notably Windows, the #GPid type represents a resource which must be closed to prevent resource leaking. g_spawn_close_pid() is provided for this purpose. It should be used on all platforms, even though it doesn't do anything under UNIX.

func SpawnCommandLineAsync 

func SpawnCommandLineAsync(CommandLineVar string) (bool, error)

A simple version of g_spawn_async() that parses a command line with g_shell_parse_argv() and passes it to g_spawn_async().

Runs a command line in the background. Unlike g_spawn_async(), the %G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note that %G_SPAWN_SEARCH_PATH can have security implications, so consider using g_spawn_async() directly if appropriate. Possible errors are those from g_shell_parse_argv() and g_spawn_async().

The same concerns on Windows apply as for g_spawn_command_line_sync().

func SpawnCommandLineSync 

func SpawnCommandLineSync(CommandLineVar string, StandardOutputVar *[]byte, StandardErrorVar *[]byte, WaitStatusVar *int) (bool, error)

A simple version of g_spawn_sync() with little-used parameters removed, taking a command line instead of an argument vector.

See g_spawn_sync() for full details.

The @command_line argument will be parsed by g_shell_parse_argv().

Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag is enabled. Note that %G_SPAWN_SEARCH_PATH can have security implications, so consider using g_spawn_sync() directly if appropriate.

Possible errors are those from g_spawn_sync() and those from g_shell_parse_argv().

If @wait_status is non-%NULL, the platform-specific status of the child is stored there; see the documentation of g_spawn_check_wait_status() for how to use and interpret this. On Unix platforms, note that it is usually not equal to the integer passed to `exit()` or returned from `main()`.

On Windows, please note the implications of g_shell_parse_argv() parsing @command_line. Parsing is done according to Unix shell rules, not Windows command interpreter rules. Space is a separator, and backslashes are special. Thus you cannot simply pass a @command_line containing canonical Windows paths, like "c:\\program files\\app\\app.exe", as the backslashes will be eaten, and the space will act as a separator. You need to enclose such paths with single quotes, like "'c:\\program files\\app\\app.exe' 'e:\\folder\\argument.txt'".

func SpawnSync 

func SpawnSync(WorkingDirectoryVar *string, ArgvVar []string, EnvpVar []string, FlagsVar SpawnFlags, ChildSetupVar *SpawnChildSetupFunc, UserDataVar uintptr, StandardOutputVar *[]byte, StandardErrorVar *[]byte, WaitStatusVar *int) (bool, error)

Executes a child synchronously (waits for the child to exit before returning).

All output from the child is stored in @standard_output and @standard_error, if those parameters are non-%NULL. Note that you must set the %G_SPAWN_STDOUT_TO_DEV_NULL and %G_SPAWN_STDERR_TO_DEV_NULL flags when passing %NULL for @standard_output and @standard_error.

If @wait_status is non-%NULL, the platform-specific status of the child is stored there; see the documentation of g_spawn_check_wait_status() for how to use and interpret this. On Unix platforms, note that it is usually not equal to the integer passed to `exit()` or returned from `main()`.

Note that it is invalid to pass %G_SPAWN_DO_NOT_REAP_CHILD in @flags, and on POSIX platforms, the same restrictions as for g_child_watch_source_new() apply.

If an error occurs, no data is returned in @standard_output, @standard_error, or @wait_status.

This function calls g_spawn_async_with_pipes() internally; see that function for full details on the other parameters and details on how these functions work on Windows.

func Sprintf 

func Sprintf(StringVar string, FormatVar string, varArgs ...interface{}) int

An implementation of the standard `sprintf()` function which supports positional parameters, as specified in the Single Unix Specification.

Note that it is usually better to use [func@GLib.snprintf], to avoid the risk of buffer overflow.

`glib/gprintf.h` must be explicitly included in order to use this function.

See also [func@GLib.strdup_printf].

func Stat 

func Stat(FilenameVar string, BufVar *StatBuf) int

A wrapper for the POSIX stat() function. The stat() function returns information about a file. On Windows the stat() function in the C library checks only the FAT-style READONLY attribute and does not look at the ACL at all. Thus on Windows the protection bits in the @st_mode field are a fabrication of little use.

On Windows the Microsoft C libraries have several variants of the stat struct and stat() function with names like _stat(), _stat32(), _stat32i64() and _stat64i32(). The one used here is for 32-bit code the one with 32-bit size and time fields, specifically called _stat32().

In Microsoft's compiler, by default struct stat means one with 64-bit time fields while in MinGW struct stat is the legacy one with 32-bit fields. To hopefully clear up this messs, the gstdio.h header defines a type #GStatBuf which is the appropriate struct type depending on the platform and/or compiler being used. On POSIX it is just struct stat, but note that even on POSIX platforms, stat() might be a macro.

See your C library manual for more details about stat().

func Stpcpy 

func Stpcpy(DestVar string, SrcVar string) string

Copies a nul-terminated string into the destination buffer, including the trailing nul byte, and returns a pointer to the trailing nul byte in `dest`. The return value is useful for concatenating multiple strings without having to repeatedly scan for the end.

func StrEqual 

func StrEqual(V1Var uintptr, V2Var uintptr) bool

Compares two strings for byte-by-byte equality and returns %TRUE if they are equal. It can be passed to g_hash_table_new() as the @key_equal_func parameter, when using non-%NULL strings as keys in a #GHashTable.

This function is typically used for hash table comparisons, but can be used for general purpose comparisons of non-%NULL strings. For a %NULL-safe string comparison function, see g_strcmp0().

func StrHasPrefix 

func StrHasPrefix(StrVar string, PrefixVar string) bool

Looks whether the string @str begins with @prefix.

func StrHasSuffix 

func StrHasSuffix(StrVar string, SuffixVar string) bool

Looks whether a string ends with @suffix.

func StrHash 

func StrHash(VVar uintptr) uint

Converts a string to a hash value.

This function implements the widely used "djb" hash apparently posted by Daniel Bernstein to comp.lang.c some time ago. The 32 bit unsigned hash value starts at 5381 and for each byte 'c' in the string, is updated: `hash = hash * 33 + c`. This function uses the signed value of each byte.

It can be passed to g_hash_table_new() as the @hash_func parameter, when using non-%NULL strings as keys in a #GHashTable.

Note that this function may not be a perfect fit for all use cases. For example, it produces some hash collisions with strings as short as 2.

func StrIsAscii 

func StrIsAscii(StrVar string) bool

Determines if a string is pure ASCII. A string is pure ASCII if it contains no bytes with the high bit set.

func StrMatchString 

func StrMatchString(SearchTermVar string, PotentialHitVar string, AcceptAlternatesVar bool) bool

Checks if a search conducted for @search_term should match @potential_hit.

This function calls [func@GLib.str_tokenize_and_fold] on both @search_term and @potential_hit. ASCII alternates are never taken for @search_term but will be taken for @potential_hit according to the value of @accept_alternates.

A hit occurs when each folded token in @search_term is a prefix of a folded token from @potential_hit.

Depending on how you're performing the search, it will typically be faster to call `g_str_tokenize_and_fold()` on each string in your corpus and build an index on the returned folded tokens, then call `g_str_tokenize_and_fold()` on the search term and perform lookups into that index.

As some examples, searching for ‘fred’ would match the potential hit ‘Smith, Fred’ and also ‘Frédéric’. Searching for ‘Fréd’ would match ‘Frédéric’ but not ‘Frederic’ (due to the one-directional nature of accent matching). Searching ‘fo’ would match ‘Foo’ and ‘Bar Foo Baz’, but not ‘SFO’ (because no word has ‘fo’ as a prefix).

func StrToAscii 

func StrToAscii(StrVar string, FromLocaleVar *string) string

Transliterate @str to plain ASCII.

For best results, @str should be in composed normalised form.

This function performs a reasonably good set of character replacements. The particular set of replacements that is done may change by version or even by runtime environment.

If the source language of @str is known, it can used to improve the accuracy of the translation by passing it as @from_locale. It should be a valid POSIX locale string (of the form `language[_territory][.codeset][@modifier]`).

If @from_locale is %NULL then the current locale is used.

If you want to do translation for no specific locale, and you want it to be done independently of the currently locale, specify `"C"` for @from_locale.

func StrTokenizeAndFold 

func StrTokenizeAndFold(StringVar string, TranslitLocaleVar *string, AsciiAlternatesVar *[]string) []string

Tokenizes @string and performs folding on each token.

A token is a non-empty sequence of alphanumeric characters in the source string, separated by non-alphanumeric characters. An "alphanumeric" character for this purpose is one that matches [func@GLib.unichar_isalnum] or [func@GLib.unichar_ismark].

Each token is then (Unicode) normalised and case-folded. If @ascii_alternates is non-`NULL` and some of the returned tokens contain non-ASCII characters, ASCII alternatives will be generated.

The number of ASCII alternatives that are generated and the method for doing so is unspecified, but @translit_locale (if specified) may improve the transliteration if the language of the source string is known.

func Strcanon 

func Strcanon(StringVar string, ValidCharsVar string, SubstitutorVar byte) string

For each character in @string, if the character is not in @valid_chars, replaces the character with @substitutor.

Modifies @string in place, and return @string itself, not a copy. The return value is to allow nesting such as: ```C g_ascii_strup (g_strcanon (str, "abc", '?')) ```

In order to modify a copy, you may use [func@GLib.strdup]: ```C reformatted = g_strcanon (g_strdup (const_str), "abc", '?'); … g_free (reformatted); ```

func Strcasecmp 

func Strcasecmp(S1Var string, S2Var string) int

A case-insensitive string comparison, corresponding to the standard `strcasecmp()` function on platforms which support it.

func Strchomp 

func Strchomp(StringVar string) string

Removes trailing whitespace from a string.

This function doesn't allocate or reallocate any memory; it modifies @string in place. Therefore, it cannot be used on statically allocated strings.

The pointer to @string is returned to allow the nesting of functions.

Also see [func@GLib.strchug] and [func@GLib.strstrip].

func Strchug 

func Strchug(StringVar string) string

Removes leading whitespace from a string, by moving the rest of the characters forward.

This function doesn't allocate or reallocate any memory; it modifies @string in place. Therefore, it cannot be used on statically allocated strings.

The pointer to @string is returned to allow the nesting of functions.

Also see [func@GLib.strchomp] and [func@GLib.strstrip].

func Strcmp0 

func Strcmp0(Str1Var *string, Str2Var *string) int

Compares @str1 and @str2 like `strcmp()`.

Handles `NULL` gracefully by sorting it before non-`NULL` strings. Comparing two `NULL` pointers returns 0.

func Strcompress 

func Strcompress(SourceVar string) string

Makes a copy of a string replacing C string-style escape sequences with their one byte equivalent:

[func@GLib.strescape] does the reverse conversion.

func Strconcat 

func Strconcat(String1Var string, varArgs ...interface{}) string

Concatenates all of the given strings into one long string.

The variable argument list must end with `NULL`. If you forget the `NULL`, `g_strconcat()` will start appending random memory junk to your string.

Note that this function is usually not the right function to use to assemble a translated message from pieces, since proper translation often requires the pieces to be reordered.

func Strdelimit 

func Strdelimit(StringVar string, DelimitersVar *string, NewDelimiterVar byte) string

Converts any delimiter characters in @string to @new_delimiter.

Any characters in @string which are found in @delimiters are changed to the @new_delimiter character. Modifies @string in place, and returns @string itself, not a copy.

The return value is to allow nesting such as: ```C g_ascii_strup (g_strdelimit (str, "abc", '?')) ```

In order to modify a copy, you may use [func@GLib.strdup]: ```C reformatted = g_strdelimit (g_strdup (const_str), "abc", '?'); … g_free (reformatted); ```

func Strdown 

func Strdown(StringVar string) string

Converts a string to lower case.

func Strdup 

func Strdup(StrVar *string) string

Duplicates a string. If @str is `NULL` it returns `NULL`.

func StrdupPrintf 

func StrdupPrintf(FormatVar string, varArgs ...interface{}) string

Similar to the standard C `sprintf()` function but safer, since it calculates the maximum space required and allocates memory to hold the result.

The returned string is guaranteed to be non-NULL, unless @format contains `%lc` or `%ls` conversions, which can fail if no multibyte representation is available for the given character.

func StrdupVprintf 

func StrdupVprintf(FormatVar string, ArgsVar []interface{}) string

Similar to the standard C `vsprintf()` function but safer, since it calculates the maximum space required and allocates memory to hold the result.

The returned string is guaranteed to be non-NULL, unless @format contains `%lc` or `%ls` conversions, which can fail if no multibyte representation is available for the given character.

See also [func@GLib.vasprintf], which offers the same functionality, but additionally returns the length of the allocated string.

func Strdupv 

func Strdupv(StrArrayVar []string) []string

Copies an array of strings. The copy is a deep copy; each string is also copied.

If called on a `NULL` value, `g_strdupv()` simply returns `NULL`.

func Strerror 

func Strerror(ErrnumVar int) string

Returns a string corresponding to the given error code, e.g. "no such process".

Unlike `strerror()`, this always returns a string in UTF-8 encoding, and the pointer is guaranteed to remain valid for the lifetime of the process. If the error code is unknown, it returns a string like “Unknown error &lt;code\&gt;”.

Note that the string may be translated according to the current locale.

The value of `errno` will not be changed by this function. However, it may be changed by intermediate function calls, so you should save its value as soon as the call returns: ```C int saved_errno;

ret = read (blah); saved_errno = errno;

g_strerror (saved_errno); ```

func Strescape 

func Strescape(SourceVar string, ExceptionsVar *string) string

It replaces the following special characters in the string @source with their corresponding C escape sequence:

| Symbol | Escape | |-----------------------------------------------------------------------------|--------| | [U+0008 Backspace](https://en.wikipedia.org/wiki/Backspace) | `\b` | | [U+000C Form Feed](https://en.wikipedia.org/wiki/Form_feed) | `\f` | | [U+000A Line Feed](https://en.wikipedia.org/wiki/Newline) | `\n` | | [U+000D Carriage Return](https://en.wikipedia.org/wiki/Carriage_return) | `\r` | | [U+0009 Horizontal Tabulation](https://en.wikipedia.org/wiki/Tab_character) | `\t` | | [U+000B Vertical Tabulation](https://en.wikipedia.org/wiki/Vertical_Tab) | `\v` |

It also inserts a backslash (`\`) before any backslash or a double quote (`"`). Additionally all characters in the range 0x01-0x1F (everything below SPACE) and in the range 0x7F-0xFF (all non-ASCII chars) are replaced with a backslash followed by their octal representation. Characters supplied in @exceptions are not escaped.

[func@GLib.strcompress] does the reverse conversion.

func Strfreev 

func Strfreev(StrArrayVar []string)

Frees an array of strings, as well as each string it contains.

If @str_array is `NULL`, this function simply returns.

func StringGLibType 

func StringGLibType() types.GType

func StripContext 

func StripContext(MsgidVar string, MsgvalVar string) string

An auxiliary function for gettext() support (see Q_()).

func Strjoin 

func Strjoin(SeparatorVar *string, varArgs ...interface{}) string

Joins a number of strings together to form one long string, with the optional @separator inserted between each of them.

func Strjoinv 

func Strjoinv(SeparatorVar *string, StrArrayVar []string) string

Joins an array of strings together to form one long string, with the optional @separator inserted between each of them.

If @str_array has no items, the return value will be an empty string. If @str_array contains a single item, @separator will not appear in the resulting string.

func Strlcat 

func Strlcat(DestVar string, SrcVar string, DestSizeVar uint) uint

Portability wrapper that calls `strlcat()` on systems which have it, and emulates it otherwise. Appends nul-terminated @src string to @dest, guaranteeing nul-termination for @dest. The total size of @dest won't exceed @dest_size.

At most @dest_size - 1 characters will be copied. Unlike `strncat()`, @dest_size is the full size of dest, not the space left over. This function does not allocate memory. It always nul-terminates (unless @dest_size == 0 or there were no nul characters in the @dest_size characters of dest to start with).

Caveat: this is supposedly a more secure alternative to `strcat()` or `strncat()`, but for real security [func@GLib.strconcat] is harder to mess up.

func Strlcpy 

func Strlcpy(DestVar string, SrcVar string, DestSizeVar uint) uint

Portability wrapper that calls `strlcpy()` on systems which have it, and emulates `strlcpy()` otherwise. Copies @src to @dest; @dest is guaranteed to be nul-terminated; @src must be nul-terminated; @dest_size is the buffer size, not the number of bytes to copy.

At most @dest_size - 1 characters will be copied. Always nul-terminates (unless @dest_size is 0). This function does not allocate memory. Unlike `strncpy()`, this function doesn't pad @dest (so it's often faster). It returns the size of the attempted result, `strlen (src)`, so if @retval &gt;= @dest_size, truncation occurred.

Caveat: `strlcpy()` is supposedly more secure than `strcpy()` or `strncpy()`, but if you really want to avoid screwups, [func@GLib.strdup] is an even better idea.

func Strncasecmp 

func Strncasecmp(S1Var string, S2Var string, NVar uint) int

A case-insensitive string comparison, corresponding to the standard `strncasecmp()` function on platforms which support it. It is similar to [func@GLib.strcasecmp] except it only compares the first @n characters of the strings.

func Strndup 

func Strndup(StrVar *string, NVar uint) string

Duplicates the first @n bytes of a string, returning a newly-allocated buffer @n + 1 bytes long which will always be nul-terminated. If @str is less than @n bytes long the buffer is padded with nuls. If @str is `NULL` it returns `NULL`.

To copy a number of characters from a UTF-8 encoded string, use [func@GLib.utf8_strncpy] instead.

func Strnfill 

func Strnfill(LengthVar uint, FillCharVar byte) string

Creates a new string @length bytes long filled with @fill_char.

func Strreverse 

func Strreverse(StringVar string) string

Reverses all of the bytes in a string. For example, `g_strreverse ("abcdef")` will result in "fedcba".

Note that `g_strreverse()` doesn't work on UTF-8 strings containing multibyte characters. For that purpose, use [func@GLib.utf8_strreverse].

func Strrstr 

func Strrstr(HaystackVar string, NeedleVar string) string

Searches the string @haystack for the last occurrence of the string @needle.

The fact that this function returns `gchar *` rather than `const gchar *` is a historical artifact.

func StrrstrLen 

func StrrstrLen(HaystackVar string, HaystackLenVar int, NeedleVar string) string

Searches the string @haystack for the last occurrence of the string @needle, limiting the length of the search to @haystack_len.

The fact that this function returns `gchar *` rather than `const gchar *` is a historical artifact.

func Strsignal 

func Strsignal(SignumVar int) string

Returns a string describing the given signal, e.g. "Segmentation fault". If the signal is unknown, it returns “unknown signal (&lt;signum\&gt;)”.

You should use this function in preference to `strsignal()`, because it returns a string in UTF-8 encoding, and since not all platforms support the `strsignal()` function.

func Strsplit 

func Strsplit(StringVar string, DelimiterVar string, MaxTokensVar int) []string

Splits a string into a maximum of @max_tokens pieces, using the given @delimiter. If @max_tokens is reached, the remainder of @string is appended to the last token.

As an example, the result of `g_strsplit (":a:bc::d:", ":", -1)` is an array containing the six strings "", "a", "bc", "", "d" and "".

As a special case, the result of splitting the empty string "" is an empty array, not an array containing a single string. The reason for this special case is that being able to represent an empty array is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling `g_strsplit()`.

func StrsplitSet 

func StrsplitSet(StringVar string, DelimitersVar []byte, MaxTokensVar int) []string

Splits @string into a number of tokens not containing any of the bytes in @delimiters.

A token is the (possibly empty) longest string that does not contain any of the bytes in @delimiters. Note that separators will only be single bytes from @delimiters. If @max_tokens is reached, the remainder is appended to the last token.

For example, the result of `g_strsplit_set ("abc:def/ghi", ":/", -1)` is an array containing the three strings `"abc"`, `"def"`, and `"ghi"`.

The result of `g_strsplit_set (":def/ghi:/x", ":/", -1)` is an array containing the five strings `""`, `"def"`, `"ghi"`, `""`, `"x"`.

As a special case, the result of splitting the empty string `""` is an empty array, not an array containing a single string. The reason for this special case is that being able to represent an empty array is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling `g_strsplit_set()`.

Note that this function works on bytes not characters, so it can't be used to delimit UTF-8 strings for anything but ASCII characters.

func StrstrLen 

func StrstrLen(HaystackVar string, HaystackLenVar int, NeedleVar string) string

Searches the string @haystack for the first occurrence of the string @needle, limiting the length of the search to @haystack_len or a nul terminator byte (whichever is reached first).

A length of `-1` can be used to mean “search the entire string”, like `strstr()`.

The fact that this function returns `gchar *` rather than `const gchar *` is a historical artifact.

func Strtod 

func Strtod(NptrVar string, EndptrVar *string) float64

Converts a string to a floating point value.

It calls the standard `strtod()` function to handle the conversion, but if the string is not completely converted it attempts the conversion again with [func@GLib.ascii_strtod], and returns the best match.

This function should seldom be used. The normal situation when reading numbers not for human consumption is to use [func@GLib.ascii_strtod]. Only when you know that you must expect both locale formatted and C formatted numbers should you use this. Make sure that you don't pass strings such as comma separated lists of values, since the commas may be interpreted as a decimal point in some locales, causing unexpected results.

func Strup 

func Strup(StringVar string) string

Converts a string to upper case.

func StrvBuilderGLibType 

func StrvBuilderGLibType() types.GType

func StrvContains 

func StrvContains(StrvVar []string, StrVar string) bool

Checks if an array of strings contains the string @str according to [func@GLib.str_equal]. @strv must not be `NULL`.

func StrvEqual 

func StrvEqual(Strv1Var []string, Strv2Var []string) bool

Checks if two arrays of strings contain exactly the same elements in exactly the same order.

Elements are compared using [func@GLib.str_equal]. To match independently of order, sort the arrays first (using [func@GLib.qsort_with_data] or similar).

Two empty arrays are considered equal. Neither @strv1 nor @strv2 may be `NULL`.

func StrvGetType 

func StrvGetType() types.GType

func StrvLength 

func StrvLength(StrArrayVar []string) uint

Returns the length of an array of strings. @str_array must not be `NULL`.

func TestAddDataFunc 

func TestAddDataFunc(TestpathVar string, TestDataVar uintptr, TestFuncVar *TestDataFunc)

Creates a new test case.

This function is similar to [func@GLib.test_create_case]. However the test is assumed to use no fixture, and test suites are automatically created on the fly and added to the root fixture, based on the /-separated portions of @testpath. The @test_data argument will be passed as first argument to @test_func.

If @testpath includes the component "subprocess" anywhere in it, the test will be skipped by default, and only run if explicitly required via the `-p` command-line option or [func@GLib.test_trap_subprocess].

No component of @testpath may start with a dot (`.`) if the [const@GLib.TEST_OPTION_ISOLATE_DIRS] option is being used; and it is recommended to do so even if it isn’t.

func TestAddDataFuncFull 

func TestAddDataFuncFull(TestpathVar string, TestDataVar uintptr, TestFuncVar *TestDataFunc, DataFreeFuncVar *DestroyNotify)

Creates a new test case.

In contrast to [func@GLib.test_add_data_func], this function is freeing @test_data after the test run is complete.

func TestAddFunc 

func TestAddFunc(TestpathVar string, TestFuncVar *TestFunc)

Creates a new test case.

This function is similar to [func@GLib.test_create_case]. However the test is assumed to use no fixture, and test suites are automatically created on the fly and added to the root fixture, based on the /-separated portions of @testpath.

If @testpath includes the component "subprocess" anywhere in it, the test will be skipped by default, and only run if explicitly required via the `-p` command-line option or [func@GLib.test_trap_subprocess].

No component of @testpath may start with a dot (`.`) if the [const@GLib.TEST_OPTION_ISOLATE_DIRS] option is being used; and it is recommended to do so even if it isn’t.

func TestAddVtable 

func TestAddVtable(TestpathVar string, DataSizeVar uint, TestDataVar uintptr, DataSetupVar *TestFixtureFunc, DataTestVar *TestFixtureFunc, DataTeardownVar *TestFixtureFunc)

func TestAssertExpectedMessagesInternal 

func TestAssertExpectedMessagesInternal(DomainVar string, FileVar string, LineVar int, FuncVar string)

func TestBug 

func TestBug(BugUriSnippetVar string)

Adds a message to test reports that associates a bug URI with a test case.

Bug URIs are constructed from a base URI set with [func@GLib.test_bug_base] and @bug_uri_snippet. If [func@GLib.test_bug_base] has not been called, it is assumed to be the empty string, so a full URI can be provided to [func@GLib.test_bug] instead.

See also [func@GLib.test_summary].

Since GLib 2.70, the base URI is not prepended to @bug_uri_snippet if it is already a valid URI.

func TestBugBase 

func TestBugBase(UriPatternVar string)

Specifies the base URI for bug reports.

The base URI is used to construct bug report messages for [func@GLib.test_message] when [func@GLib.test_bug] is called. Calling this function outside of a test case sets the default base URI for all test cases. Calling it from within a test case changes the base URI for the scope of the test case only. Bug URIs are constructed by appending a bug specific URI portion to @uri_pattern, or by replacing the special string `%s` within @uri_pattern if that is present.

If [func@GLib.test_bug_base] is not called, bug URIs are formed solely from the value provided by [func@GLib.test_bug].

func TestBuildFilename 

func TestBuildFilename(FileTypeVar TestFileType, FirstPathVar string, varArgs ...interface{}) string

Creates the pathname to a data file that is required for a test.

This function is conceptually similar to [func@GLib.build_filename] except that the first argument has been replaced with a [enum@GLib.TestFileType] argument.

The data file should either have been distributed with the module containing the test ([enum@GLib.TestFileType.dist] or built as part of the buildcsystem of that module ([enum@GLib.TestFileType.built]).

In order for this function to work in srcdir != builddir situations, the `G_TEST_SRCDIR` and `G_TEST_BUILDDIR` environment variables need to have been defined. As of 2.38, this is done by the glib.mk that is included in GLib. Please ensure that your copy is up to date before using this function.

In case neither variable is set, this function will fall back to using the dirname portion of `argv[0]`, possibly removing ".libs". This allows for casual running of tests directly from the commandline in the srcdir == builddir case and should also support running of installed tests, assuming the data files have been installed in the same relative path as the test binary.

func TestDisableCrashReporting 

func TestDisableCrashReporting()

Attempts to disable system crash reporting infrastructure.

This function should be called before exercising code paths that are expected or intended to crash, to avoid wasting resources in system-wide crash collection infrastructure such as systemd-coredump or abrt.

func TestExpectMessage 

func TestExpectMessage(LogDomainVar *string, LogLevelVar LogLevelFlags, PatternVar string)

Indicates that a message with the given @log_domain and @log_level, with text matching @pattern, is expected to be logged.

When this message is logged, it will not be printed, and the test case will not abort.

This API may only be used with the old logging API ([func@GLib.log] without `G_LOG_USE_STRUCTURED` defined). It will not work with the structured logging API. See [Testing for Messages](logging.html#testing-for-messages).

Use [func@GLib.test_assert_expected_messages] to assert that all previously-expected messages have been seen and suppressed.

You can call this multiple times in a row, if multiple messages are expected as a result of a single call. (The messages must appear in the same order as the calls to [func@GLib.test_expect_message].)

For example:

```c // g_main_context_push_thread_default() should fail if the // context is already owned by another thread. g_test_expect_message (G_LOG_DOMAIN, 

G_LOG_LEVEL_CRITICAL,
"assertion*acquired_context*failed");

g_main_context_push_thread_default (bad_context); g_test_assert_expected_messages (); ```

Note that you cannot use this to test [func@GLib.error] messages, since [func@GLib.error] intentionally never returns even if the program doesn’t abort; use [func@GLib.test_trap_subprocess] in this case.

If messages at [flags@GLib.LogLevelFlags.LEVEL_DEBUG] are emitted, but not explicitly expected via [func@GLib.test_expect_message] then they will be ignored.

func TestFail 

func TestFail()

Indicates that a test failed.

This function can be called multiple times from the same test. You can use this function if your test failed in a recoverable way.

Do not use this function if the failure of a test could cause other tests to malfunction.

Calling this function will not stop the test from running, you need to return from the test function yourself. So you can produce additional diagnostic messages or even continue running the test.

If not called from inside a test, this function does nothing.

Note that unlike [func@GLib.test_skip] and [func@GLib.test_incomplete], this function does not log a message alongside the test failure. If details of the test failure are available, either log them with [func@GLib.test_message] before [func@GLib.test_fail], or use [func@GLib.test_fail_printf] instead.

func TestFailPrintf 

func TestFailPrintf(FormatVar string, varArgs ...interface{})

Indicates that a test failed and records a message.

Also see [func@GLib.test_fail].

The message is formatted as if by [func@GLib.strdup_printf].

func TestFailed 

func TestFailed() bool

Returns whether a test has already failed.

This will be the case when [func@GLib.test_fail], [func@GLib.test_incomplete] or [func@GLib.test_skip] have been called, but also if an assertion has failed.

This can be useful to return early from a test if continuing after a failed assertion might be harmful.

The return value of this function is only meaningful if it is called from inside a test function.

func TestGetDir 

func TestGetDir(FileTypeVar TestFileType) string

Gets the pathname of the directory containing test files of the type specified by @file_type.

This is approximately the same as calling `g_test_build_filename(".")`, but you don't need to free the return value.

func TestGetFilename 

func TestGetFilename(FileTypeVar TestFileType, FirstPathVar string, varArgs ...interface{}) string

Gets the pathname to a data file that is required for a test.

This is the same as [func@GLib.test_build_filename] with two differences. The first difference is that you must only use this function from within a testcase function. The second difference is that you need not free the return value — it will be automatically freed when the testcase finishes running.

It is safe to use this function from a thread inside of a testcase but you must ensure that all such uses occur before the main testcase function returns (ie: it is best to ensure that all threads have been joined).

func TestGetPath 

func TestGetPath() string

Gets the test path for the test currently being run.

In essence, it will be the same string passed as the first argument to e.g. [func@GLib.test_add] when the test was added.

This function returns a valid string only within a test function.

Note that this is a test path, not a file system path.

func TestIncomplete 

func TestIncomplete(MsgVar *string)

Indicates that a test failed because of some incomplete functionality.

This function can be called multiple times from the same test.

Calling this function will not stop the test from running, you need to return from the test function yourself. So you can produce additional diagnostic messages or even continue running the test.

If not called from inside a test, this function does nothing.

func TestIncompletePrintf 

func TestIncompletePrintf(FormatVar string, varArgs ...interface{})

Indicates that a test failed because of some incomplete functionality.

Equivalent to [func@GLib.test_incomplete], but the explanation is formatted as if by [func@GLib.strdup_printf].

func TestInit 

func TestInit(ArgcVar int, ArgvVar string, varArgs ...interface{})

Initializes the GLib testing framework.

This includes seeding the test random number generator, setting the program name, and parsing test-related commandline args.

This should be called before calling any other `g_test_*()` functions.

The following arguments are understood:

  • `-l`: List test cases available in a test executable.

  • `--seed=SEED`: Provide a random seed to reproduce test runs using random numbers.

  • `--verbose`: Run tests verbosely.

  • `-q`, `--quiet`: Run tests quietly.

  • `-p PATH`: Execute all tests matching the given path.

  • `-s PATH`: Skip all tests matching the given path. This can also be used to force a test to run that would otherwise be skipped (ie, a test whose name contains "/subprocess").

  • `-m {perf|slow|thorough|quick|undefined|no-undefined}`: Execute tests according to these test modes:

    `perf`: Performance tests, may take long and report results (off by default).

    `slow`, `thorough`: Slow and thorough tests, may take quite long and maximize coverage (off by default).

    `quick`: Quick tests, should run really quickly and give good coverage (the default).

    `undefined`: Tests for undefined behaviour, may provoke programming errors under [func@GLib.test_trap_subprocess] or [func@GLib.test_expect_message] to check that appropriate assertions or warnings are given (the default).

    `no-undefined`: Avoid tests for undefined behaviour.

- `--debug-log`: Debug test logging output.

Any parsed arguments are removed from @argv, and @argc is adjust accordingly.

The following options are supported:

  • `G_TEST_OPTION_NO_PRGNAME`: Causes g_test_init() to not call [func@GLib.set_prgname]. Since. 2.84
  • `G_TEST_OPTION_ISOLATE_DIRS`: Creates a unique temporary directory for each unit test and sets XDG directories to point there for the duration of the unit test. See [const@GLib.TEST_OPTION_ISOLATE_DIRS].
  • `G_TEST_OPTION_NONFATAL_ASSERTIONS`: This has the same effect as [func@GLib.test_set_nonfatal_assertions]. Since 2.84

Since 2.58, if tests are compiled with `G_DISABLE_ASSERT` defined, `g_test_init()` will print an error and exit. This is to prevent no-op tests from being executed, as [func@GLib.assert] is commonly (erroneously) used in unit tests, and is a no-op when compiled with `G_DISABLE_ASSERT`. Ensure your tests are compiled without `G_DISABLE_ASSERT` defined.

func TestLogSetFatalHandler 

func TestLogSetFatalHandler(LogFuncVar *TestLogFatalFunc, UserDataVar uintptr)

Installs a non-error fatal log handler which can be used to decide whether log messages which are counted as fatal abort the program.

The use case here is that you are running a test case that depends on particular libraries or circumstances and cannot prevent certain known critical or warning messages. So you install a handler that compares the domain and message to precisely not abort in such a case.

Note that the handler is reset at the beginning of any test case, so you have to set it inside each test function which needs the special behavior.

This handler has no effect on g_error messages.

This handler also has no effect on structured log messages (using [func@GLib.log_structured] or [func@GLib.log_structured_array]). To change the fatal behaviour for specific log messages, programs must install a custom log writer function using [func@GLib.log_set_writer_func].See [Using Structured Logging](logging.html#using-structured-logging).

func TestLogTypeName 

func TestLogTypeName(LogTypeVar TestLogType) string

func TestMaximizedResult 

func TestMaximizedResult(MaximizedQuantityVar float64, FormatVar string, varArgs ...interface{})

Reports the result of a performance or measurement test.

The test should generally strive to maximize the reported quantities (larger values are better than smaller ones), this and @maximized_quantity can determine sorting order for test result reports.

func TestMessage 

func TestMessage(FormatVar string, varArgs ...interface{})

Adds a message to the test report.

func TestMinimizedResult 

func TestMinimizedResult(MinimizedQuantityVar float64, FormatVar string, varArgs ...interface{})

Reports the result of a performance or measurement test.

The test should generally strive to minimize the reported quantities (smaller values are better than larger ones), this and @minimized_quantity can determine sorting order for test result reports.

func TestQueueDestroy 

func TestQueueDestroy(DestroyFuncVar *DestroyNotify, DestroyDataVar uintptr)

Enqueues a callback @destroy_func to be executed during the next test case teardown phase.

This is most useful to auto destroy allocated test resources at the end of a test run. Resources are released in reverse queue order, that means enqueueing callback `A` before callback `B` will cause `B()` to be called before `A()` during teardown.

func TestQueueFree 

func TestQueueFree(GfreePointerVar uintptr)

Enqueues a pointer to be released with [func@GLib.free] during the next teardown phase.

This is equivalent to calling [func@GLib.test_queue_destroy] with a destroy callback of [func@GLib.free].

func TestRandDouble 

func TestRandDouble() float64

Gets a reproducible random floating point number.

See [func@GLib.test_rand_int] for details on test case random numbers.

func TestRandDoubleRange 

func TestRandDoubleRange(RangeStartVar float64, RangeEndVar float64) float64

Gets a reproducible random floating point number out of a specified range.

See [func@GLib.test_rand_int] for details on test case random numbers.

func TestRandInt 

func TestRandInt() int32

Gets a reproducible random integer number.

The random numbers generated by the g_test_rand_*() family of functions change with every new test program start, unless the --seed option is given when starting test programs.

For individual test cases however, the random number generator is reseeded, to avoid dependencies between tests and to make --seed effective for all test cases.

func TestRandIntRange 

func TestRandIntRange(BeginVar int32, EndVar int32) int32

Gets a reproducible random integer number out of a specified range.

See [func@GLib.test_rand_int] for details on test case random numbers.

func TestRun 

func TestRun() int

Runs all tests under the toplevel suite.

The toplevel suite can be retrieved with [func@GLib.test_get_root].

Similar to [func@GLib.test_run_suite], the test cases to be run are filtered according to test path arguments (`-p testpath` and `-s testpath`) as parsed by [func@GLib.test_init]. [func@GLib.test_run_suite] or [func@GLib.test_run] may only be called once in a program.

In general, the tests and sub-suites within each suite are run in the order in which they are defined. However, note that prior to GLib 2.36, there was a bug in the `g_test_add_*` functions which caused them to create multiple suites with the same name, meaning that if you created tests "/foo/simple", "/bar/simple", and "/foo/using-bar" in that order, they would get run in that order (since [func@GLib.test_run] would run the first "/foo" suite, then the "/bar" suite, then the second "/foo" suite). As of 2.36, this bug is fixed, and adding the tests in that order would result in a running order of "/foo/simple", "/foo/using-bar", "/bar/simple". If this new ordering is sub-optimal (because it puts more-complicated tests before simpler ones, making it harder to figure out exactly what has failed), you can fix it by changing the test paths to group tests by suite in a way that will result in the desired running order. Eg, "/simple/foo", "/simple/bar", "/complex/foo-using-bar".

However, you should never make the actual result of a test depend on the order that tests are run in. If you need to ensure that some particular code runs before or after a given test case, use [func@GLib.test_add], which lets you specify setup and teardown functions.

If all tests are skipped or marked as incomplete (expected failures), this function will return 0 if producing TAP output, or 77 (treated as "skip test" by Automake) otherwise.

func TestRunSuite 

func TestRunSuite(SuiteVar *TestSuite) int

Executes the tests within @suite and all nested test suites.

The test suites to be executed are filtered according to test path arguments (`-p testpath` and `-s testpath`) as parsed by [func@GLib.test_init]. See the [func@GLib.test_run] documentation for more information on the order that tests are run in.

[func@GLib.test_run_suite] or [func@GLib.test_run] may only be called once in a program.

func TestSetNonfatalAssertions 

func TestSetNonfatalAssertions()

Changes the behaviour of the various assertion macros.

The `g_assert_*()` macros, `g_test_assert_expected_messages()` and the various `g_test_trap_assert_*()` macros are changed to not abort to program.

Instead, they will call [func@GLib.test_fail] and continue. (This also changes the behavior of [func@GLib.test_fail] so that it will not cause the test program to abort after completing the failed test.)

Note that the [func@GLib.assert_not_reached] and [func@GLib.assert] macros are not affected by this.

This function can only be called after [func@GLib.test_init].

func TestSkip 

func TestSkip(MsgVar *string)

Indicates that a test was skipped.

Calling this function will not stop the test from running, you need to return from the test function yourself. So you can produce additional diagnostic messages or even continue running the test.

If not called from inside a test, this function does nothing.

func TestSkipPrintf 

func TestSkipPrintf(FormatVar string, varArgs ...interface{})

Indicates that a test was skipped.

Equivalent to [func@GLib.test_skip], but the explanation is formatted as if by [func@GLib.strdup_printf].

func TestSubprocess 

func TestSubprocess() bool

Returns true if the test program is running under [func@GLib.test_trap_subprocess].

func TestSummary 

func TestSummary(SummaryVar string)

Sets the summary for a test.

This may be included in test report output, and is useful documentation for anyone reading the source code or modifying a test in future. It must be a single line, and it should summarise what the test checks, and how.

This should be called at the top of a test function.

For example:

```c static void test_array_sort (void) 

{
  g_test_summary ("Test my_array_sort() sorts the array correctly and stably, "
                  "including testing zero length and one-element arrays.");

  // ...
}

```

See also [func@GLib.test_bug].

func TestTimerElapsed 

func TestTimerElapsed() float64

Gets the number of seconds since the last start of the timer with [func@GLib.test_timer_start].

func TestTimerLast 

func TestTimerLast() float64

Reports the last result of [func@GLib.test_timer_elapsed].

func TestTimerStart 

func TestTimerStart()

Starts a timing test.

Call [func@GLib.test_timer_elapsed] when the task is supposed to be done. Call this function again to restart the timer.

func TestTrapAssertions 

func TestTrapAssertions(DomainVar string, FileVar string, LineVar int, FuncVar string, AssertionFlagsVar uint64, PatternVar string)

func TestTrapFork 

func TestTrapFork(UsecTimeoutVar uint64, TestTrapFlagsVar TestTrapFlags) bool

Forks the current test program to execute a test case that might not return or that might abort.

If @usec_timeout is non-0, the forked test case is aborted and considered failing if its run time exceeds it.

The forking behavior can be configured with [flags@GLib.TestTrapFlags] flags.

In the following example, the test code forks, the forked child process produces some sample output and exits successfully. The forking parent process then asserts successful child program termination and validates child program outputs.

```c 

static void
test_fork_patterns (void)
{
  if (g_test_trap_fork (0, G_TEST_TRAP_SILENCE_STDOUT | G_TEST_TRAP_SILENCE_STDERR))
    {
      g_print ("some stdout text: somagic17

"); 

g_printerr ("some stderr text: semagic43

"); 

      exit (0); // successful test run
    }
  g_test_trap_assert_passed ();
  g_test_trap_assert_stdout ("*somagic17*");
  g_test_trap_assert_stderr ("*semagic43*");
}

```

func TestTrapHasPassed 

func TestTrapHasPassed() bool

Checks the result of the last [func@GLib.test_trap_subprocess] call.

func TestTrapHasSkipped added in v0.5.0 

func TestTrapHasSkipped() bool

Checks the result of the last [func@GLib.test_trap_subprocess] call.

func TestTrapReachedTimeout 

func TestTrapReachedTimeout() bool

Checks the result of the last [func@GLib.test_trap_subprocess] call.

func TestTrapSubprocess 

func TestTrapSubprocess(TestPathVar *string, UsecTimeoutVar uint64, TestFlagsVar TestSubprocessFlags)

Respawns the test program to run only @test_path in a subprocess.

This is equivalent to calling [func@GLib.test_trap_subprocess_with_envp] with `envp` set to `NULL`. See the documentation for that function for full details.

func TestTrapSubprocessWithEnvp 

func TestTrapSubprocessWithEnvp(TestPathVar *string, EnvpVar []string, UsecTimeoutVar uint64, TestFlagsVar TestSubprocessFlags)

Respawns the test program to run only @test_path in a subprocess with a given environment.

This can be used for a test case that might not return, or that might abort.

If @test_path is `NULL` then the same test is re-run in a subprocess. You can use [func@GLib.test_subprocess] to determine whether the test is in a subprocess or not.

@test_path can also be the name of the parent test, followed by "`/subprocess/`" and then a name for the specific subtest (or just ending with "`/subprocess`" if the test only has one child test); tests with names of this form will automatically be skipped in the parent process.

If @envp is `NULL`, the parent process’ environment will be inherited.

If @usec_timeout is non-0, the test subprocess is aborted and considered failing if its run time exceeds it.

The subprocess behavior can be configured with [flags@GLib.TestSubprocessFlags] flags.

You can use methods such as [func@GLib.test_trap_assert_passed], [func@GLib.test_trap_assert_failed], and [func@GLib.test_trap_assert_stderr] to check the results of the subprocess. (But note that [func@GLib.test_trap_assert_stdout] and [func@GLib.test_trap_assert_stderr] cannot be used if @test_flags specifies that the child should inherit the parent stdout/stderr.)

If your `main ()` needs to behave differently in the subprocess, you can call [func@GLib.test_subprocess] (after calling [func@GLib.test_init]) to see whether you are in a subprocess.

Internally, this function tracks the child process using [func@GLib.child_watch_source_new], so your process must not ignore `SIGCHLD`, and must not attempt to watch or wait for the child process via another mechanism.

The following example tests that calling `my_object_new(1000000)` will abort with an error message.

```c 

static void
test_create_large_object (void)
{
  if (g_test_subprocess ())
    {
      my_object_new (1000000);
      return;
    }

  // Reruns this same test in a subprocess
  g_test_trap_subprocess (NULL, 0, G_TEST_SUBPROCESS_DEFAULT);
  g_test_trap_assert_failed ();
  g_test_trap_assert_stderr ("*ERROR*too large*");
}

static void
test_different_username (void)
{
  if (g_test_subprocess ())
    {
      // Code under test goes here
      g_message ("Username is now simulated as %s", g_getenv ("USER"));
      return;
    }

  // Reruns this same test in a subprocess
  g_auto(GStrv) envp = g_get_environ ();
  envp = g_environ_setenv (g_steal_pointer (&amp;envp), "USER", "charlie", TRUE);
  g_test_trap_subprocess_with_envp (NULL, envp, 0, G_TEST_SUBPROCESS_DEFAULT);
  g_test_trap_assert_passed ();
  g_test_trap_assert_stdout ("Username is now simulated as charlie");
}

int
main (int argc, char **argv)
{
  g_test_init (&amp;argc, &amp;argv, NULL);

  g_test_add_func ("/myobject/create-large-object",
                   test_create_large_object);
  g_test_add_func ("/myobject/different-username",
                   test_different_username);
  return g_test_run ();
}

```

func ThreadExit 

func ThreadExit(RetvalVar uintptr)

Terminates the current thread.

If another thread is waiting for us using g_thread_join() then the waiting thread will be woken up and get @retval as the return value of g_thread_join().

Calling g_thread_exit() with a parameter @retval is equivalent to returning @retval from the function @func, as given to g_thread_new().

You must only call g_thread_exit() from a thread that you created yourself with g_thread_new() or related APIs. You must not call this function from a thread created with another threading library or or from within a #GThreadPool.

func ThreadForeach 

func ThreadForeach(ThreadFuncVar *Func, UserDataVar uintptr)

Call @thread_func on all #GThreads that have been created with g_thread_create().

Note that threads may decide to exit while @thread_func is running, so without intimate knowledge about the lifetime of foreign threads, @thread_func shouldn't access the GThread* pointer passed in as first argument. However, @thread_func will not be called for threads which are known to have exited already.

Due to thread lifetime checks, this function has an execution complexity which is quadratic in the number of existing threads.

func ThreadGLibType 

func ThreadGLibType() types.GType

func ThreadGetInitialized 

func ThreadGetInitialized() bool

Indicates if g_thread_init() has been called.

func ThreadInit 

func ThreadInit(VtableVar uintptr)

If you use GLib from more than one thread, you must initialize the thread system by calling g_thread_init().

Since version 2.24, calling g_thread_init() multiple times is allowed, but nothing happens except for the first call.

Since version 2.32, GLib does not support custom thread implementations anymore and the @vtable parameter is ignored and you should pass %NULL.

::: note 

g_thread_init() must not be called directly or indirectly in a
callback from GLib. Also no mutexes may be currently locked
while calling g_thread_init().

::: note 

To use g_thread_init() in your program, you have to link with
the libraries that the command `pkg-config --libs gthread-2.0`
outputs. This is not the case for all the other thread-related
functions of GLib. Those can be used without having to link
with the thread libraries.

func ThreadInitWithErrorcheckMutexes 

func ThreadInitWithErrorcheckMutexes(VtableVar uintptr)

func ThreadPoolGetMaxIdleTime 

func ThreadPoolGetMaxIdleTime() uint

This function will return the maximum @interval that a thread will wait in the thread pool for new tasks before being stopped.

If this function returns 0, threads waiting in the thread pool for new work are not stopped.

func ThreadPoolGetMaxUnusedThreads 

func ThreadPoolGetMaxUnusedThreads() int

Returns the maximal allowed number of unused threads.

func ThreadPoolGetNumUnusedThreads 

func ThreadPoolGetNumUnusedThreads() uint

Returns the number of currently unused threads.

func ThreadPoolSetMaxIdleTime 

func ThreadPoolSetMaxIdleTime(IntervalVar uint)

This function will set the maximum @interval that a thread waiting in the pool for new tasks can be idle for before being stopped. This function is similar to calling g_thread_pool_stop_unused_threads() on a regular timeout, except this is done on a per thread basis.

By setting @interval to 0, idle threads will not be stopped.

The default value is 15000 (15 seconds).

func ThreadPoolSetMaxUnusedThreads 

func ThreadPoolSetMaxUnusedThreads(MaxThreadsVar int)

Sets the maximal number of unused threads to @max_threads. If @max_threads is -1, no limit is imposed on the number of unused threads.

The default value is 8 since GLib 2.84. Previously the default value was 2.

func ThreadPoolStopUnusedThreads 

func ThreadPoolStopUnusedThreads()

Stops all currently unused threads. This does not change the maximal number of unused threads. This function can be used to regularly stop all unused threads e.g. from g_timeout_add().

func ThreadYield 

func ThreadYield()

Causes the calling thread to voluntarily relinquish the CPU, so that other threads can run.

This function is often used as a method to make busy wait less evil.

func TimeValFromIso8601 

func TimeValFromIso8601(IsoDateVar string, TimeVar *TimeVal) bool

Converts a string containing an ISO 8601 encoded date and time to a #GTimeVal and puts it into @time_.

@iso_date must include year, month, day, hours, minutes, and seconds. It can optionally include fractions of a second and a time zone indicator. (In the absence of any time zone indication, the timestamp is assumed to be in local time.)

Any leading or trailing space in @iso_date is ignored.

This function was deprecated, along with #GTimeVal itself, in GLib 2.62. Equivalent functionality is available using code like: |[ GDateTime *dt = g_date_time_new_from_iso8601 (iso8601_string, NULL); gint64 time_val = g_date_time_to_unix (dt); g_date_time_unref (dt); ]|

func TimeZoneGLibType 

func TimeZoneGLibType() types.GType

func TimeoutAdd 

func TimeoutAdd(IntervalVar uint, FunctionVar *SourceFunc, DataVar uintptr) uint

Sets a function to be called at regular intervals, with the default priority, [const@GLib.PRIORITY_DEFAULT].

The given @function is called repeatedly until it returns [const@GLib.SOURCE_REMOVE], at which point the timeout is automatically destroyed and the function will not be called again. The first call to the function will be at the end of the first @interval.

Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to ‘catch up’ time lost in delays).

See [main loop memory management](main-loop.html#memory-management-of-sources) for details on how to handle the return value and memory management of @data.

If you want to have a timer in the ‘seconds’ range and do not care about the exact time of the first call of the timer, use the [func@GLib.timeout_add_seconds] function; this function allows for more optimizations and more efficient system power usage.

This internally creates a main loop source using [func@GLib.timeout_source_new] and attaches it to the global [struct@GLib.MainContext] using [method@GLib.Source.attach], so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context.

It is safe to call this function from any thread.

The interval given is in terms of monotonic time, not wall clock time. See [func@GLib.get_monotonic_time].

func TimeoutAddFull 

func TimeoutAddFull(PriorityVar int, IntervalVar uint, FunctionVar *SourceFunc, DataVar uintptr, NotifyVar *DestroyNotify) uint

Sets a function to be called at regular intervals, with the given priority.

The function is called repeatedly until it returns [const@GLib.SOURCE_REMOVE], at which point the timeout is automatically destroyed and the function will not be called again. The @notify function is called when the timeout is destroyed. The first call to the function will be at the end of the first @interval.

Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to ‘catch up’ time lost in delays).

See [main loop memory management](main-loop.html#memory-management-of-sources) for details on how to handle the return value and memory management of @data.

This internally creates a main loop source using [func@GLib.timeout_source_new] and attaches it to the global [struct@GLib.MainContext] using [method@GLib.Source.attach], so the callback will be invoked in whichever thread is running that main context. You can do these steps manually if you need greater control or to use a custom main context.

The interval given is in terms of monotonic time, not wall clock time. See [func@GLib.get_monotonic_time].

func TimeoutAddOnce 

func TimeoutAddOnce(IntervalVar uint, FunctionVar *SourceOnceFunc, DataVar uintptr) uint

Sets a function to be called after @interval milliseconds have elapsed, with the default priority, [const@GLib.PRIORITY_DEFAULT].

The given @function is called once and then the source will be automatically removed from the main context.

This function otherwise behaves like [func@GLib.timeout_add].

func TimeoutAddSeconds 

func TimeoutAddSeconds(IntervalVar uint, FunctionVar *SourceFunc, DataVar uintptr) uint

Sets a function to be called at regular intervals with the default priority, [const@GLib.PRIORITY_DEFAULT].

The function is called repeatedly until it returns [const@GLib.SOURCE_REMOVE], at which point the timeout is automatically destroyed and the function will not be called again.

This internally creates a main loop source using [func@GLib.timeout_source_new_seconds] and attaches it to the main loop context using [method@GLib.Source.attach]. You can do these steps manually if you need greater control. Also see [func@GLib.timeout_add_seconds_full].

It is safe to call this function from any thread.

Note that the first call of the timer may not be precise for timeouts of one second. If you need finer precision and have such a timeout, you may want to use [func@GLib.timeout_add] instead.

See [main loop memory management](main-loop.html#memory-management-of-sources) for details on how to handle the return value and memory management of @data.

The interval given is in terms of monotonic time, not wall clock time. See [func@GLib.get_monotonic_time].

func TimeoutAddSecondsFull 

func TimeoutAddSecondsFull(PriorityVar int, IntervalVar uint, FunctionVar *SourceFunc, DataVar uintptr, NotifyVar *DestroyNotify) uint

Sets a function to be called at regular intervals, with @priority.

The function is called repeatedly until it returns [const@GLib.SOURCE_REMOVE], at which point the timeout is automatically destroyed and the function will not be called again.

Unlike [func@GLib.timeout_add], this function operates at whole second granularity. The initial starting point of the timer is determined by the implementation and the implementation is expected to group multiple timers together so that they fire all at the same time. To allow this grouping, the @interval to the first timer is rounded and can deviate up to one second from the specified interval. Subsequent timer iterations will generally run at the specified interval.

Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given @interval

See [main loop memory management](main-loop.html#memory-management-of-sources) for details on how to handle the return value and memory management of @data.

If you want timing more precise than whole seconds, use [func@GLib.timeout_add] instead.

The grouping of timers to fire at the same time results in a more power and CPU efficient behavior so if your timer is in multiples of seconds and you don’t require the first timer exactly one second from now, the use of [func@GLib.timeout_add_seconds] is preferred over [func@GLib.timeout_add].

This internally creates a main loop source using [func@GLib.timeout_source_new_seconds] and attaches it to the main loop context using [method@GLib.Source.attach]. You can do these steps manually if you need greater control.

It is safe to call this function from any thread.

The interval given is in terms of monotonic time, not wall clock time. See [func@GLib.get_monotonic_time].

func TimeoutAddSecondsOnce 

func TimeoutAddSecondsOnce(IntervalVar uint, FunctionVar *SourceOnceFunc, DataVar uintptr) uint

This function behaves like [func@GLib.timeout_add_once] but with a range in seconds.

func TrashStackHeight 

func TrashStackHeight(StackPVar **TrashStack) uint

Returns the height of a #GTrashStack.

Note that execution of this function is of O(N) complexity where N denotes the number of items on the stack.

func TrashStackPeek 

func TrashStackPeek(StackPVar **TrashStack) uintptr

Returns the element at the top of a #GTrashStack which may be %NULL.

func TrashStackPop 

func TrashStackPop(StackPVar **TrashStack) uintptr

Pops a piece of memory off a #GTrashStack.

func TrashStackPush 

func TrashStackPush(StackPVar **TrashStack, DataPVar uintptr)

Pushes a piece of memory onto a #GTrashStack.

func TreeGLibType 

func TreeGLibType() types.GType

func TryMalloc 

func TryMalloc(NBytesVar uint) uintptr

Attempts to allocate @n_bytes, and returns %NULL on failure. Contrast with g_malloc(), which aborts the program on failure.

func TryMalloc0 

func TryMalloc0(NBytesVar uint) uintptr

Attempts to allocate @n_bytes, initialized to 0's, and returns %NULL on failure. Contrast with g_malloc0(), which aborts the program on failure.

func TryMalloc0N 

func TryMalloc0N(NBlocksVar uint, NBlockBytesVar uint) uintptr

This function is similar to g_try_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication.

func TryMallocN 

func TryMallocN(NBlocksVar uint, NBlockBytesVar uint) uintptr

This function is similar to g_try_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication.

func TryRealloc 

func TryRealloc(MemVar uintptr, NBytesVar uint) uintptr

Attempts to realloc @mem to a new size, @n_bytes, and returns %NULL on failure. Contrast with g_realloc(), which aborts the program on failure.

If @mem is %NULL, behaves the same as g_try_malloc().

func TryReallocN 

func TryReallocN(MemVar uintptr, NBlocksVar uint, NBlockBytesVar uint) uintptr

This function is similar to g_try_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, but care is taken to detect possible overflow during multiplication.

func Ucs4ToUtf8 

func Ucs4ToUtf8(StrVar []uint32, LenVar int, ItemsReadVar *int, ItemsWrittenVar *int) (string, error)

Convert a string from a 32-bit fixed width representation as UCS-4. to UTF-8.

The result will be terminated with a nul byte.

func Ucs4ToUtf16 

func Ucs4ToUtf16(StrVar []uint32, LenVar int, ItemsReadVar *int, ItemsWrittenVar *int) (uint16, error)

Convert a string from UCS-4 to UTF-16.

A nul character (U+0000) will be added to the result after the converted text.

func UnicharCombiningClass 

func UnicharCombiningClass(UcVar uint32) int

Determines the canonical combining class of a Unicode character.

func UnicharCompose 

func UnicharCompose(AVar uint32, BVar uint32, ChVar *uint32) bool

Performs a single composition step of the Unicode canonical composition algorithm.

This function includes algorithmic Hangul Jamo composition, but it is not exactly the inverse of g_unichar_decompose(). No composition can have either of @a or @b equal to zero. To be precise, this function composes if and only if there exists a Primary Composite P which is canonically equivalent to the sequence &lt;@a,@b&gt;. See the Unicode Standard for the definition of Primary Composite.

If @a and @b do not compose a new character, @ch is set to zero.

See [UAX#15](http://unicode.org/reports/tr15/) for details.

func UnicharDecompose 

func UnicharDecompose(ChVar uint32, AVar *uint32, BVar *uint32) bool

Performs a single decomposition step of the Unicode canonical decomposition algorithm.

This function does not include compatibility decompositions. It does, however, include algorithmic Hangul Jamo decomposition, as well as 'singleton' decompositions which replace a character by a single other character. In the case of singletons `*b` will be set to zero.

If @ch is not decomposable, `*a` is set to @ch and `*b` is set to zero.

Note that the way Unicode decomposition pairs are defined, it is guaranteed that @b would not decompose further, but @a may itself decompose. To get the full canonical decomposition for @ch, one would need to recursively call this function on @a. Or use g_unichar_fully_decompose().

See [UAX#15](http://unicode.org/reports/tr15/) for details.

func UnicharDigitValue 

func UnicharDigitValue(CVar uint32) int

Determines the numeric value of a character as a decimal digit.

func UnicharFullyDecompose 

func UnicharFullyDecompose(ChVar uint32, CompatVar bool, ResultVar *uint32, ResultLenVar uint) uint

Computes the canonical or compatibility decomposition of a Unicode character. For compatibility decomposition, pass %TRUE for @compat; for canonical decomposition pass %FALSE for @compat.

The decomposed sequence is placed in @result. Only up to @result_len characters are written into @result. The length of the full decomposition (irrespective of @result_len) is returned by the function. For canonical decomposition, currently all decompositions are of length at most 4, but this may change in the future (very unlikely though). At any rate, Unicode does guarantee that a buffer of length 18 is always enough for both compatibility and canonical decompositions, so that is the size recommended. This is provided as %G_UNICHAR_MAX_DECOMPOSITION_LENGTH.

See [UAX#15](http://unicode.org/reports/tr15/) for details.

func UnicharGetMirrorChar 

func UnicharGetMirrorChar(ChVar uint32, MirroredChVar *uint32) bool

In Unicode, some characters are "mirrored". This means that their images are mirrored horizontally in text that is laid out from right to left. For instance, "(" would become its mirror image, ")", in right-to-left text.

If @ch has the Unicode mirrored property and there is another unicode character that typically has a glyph that is the mirror image of @ch's glyph and @mirrored_ch is set, it puts that character in the address pointed to by @mirrored_ch. Otherwise the original character is put.

func UnicharIsalnum 

func UnicharIsalnum(CVar uint32) bool

Determines whether a character is alphanumeric. Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIsalpha 

func UnicharIsalpha(CVar uint32) bool

Determines whether a character is alphabetic (i.e. a letter). Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIscntrl 

func UnicharIscntrl(CVar uint32) bool

Determines whether a character is a control character. Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIsdefined 

func UnicharIsdefined(CVar uint32) bool

Determines if a given character is assigned in the Unicode standard.

func UnicharIsdigit 

func UnicharIsdigit(CVar uint32) bool

Determines whether a character is numeric (i.e. a digit). This covers ASCII 0-9 and also digits in other languages/scripts. Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIsgraph 

func UnicharIsgraph(CVar uint32) bool

Determines whether a character is printable and not a space (returns %FALSE for control characters, format characters, and spaces). g_unichar_isprint() is similar, but returns %TRUE for spaces. Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIslower 

func UnicharIslower(CVar uint32) bool

Determines whether a character is a lowercase letter. Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIsmark 

func UnicharIsmark(CVar uint32) bool

Determines whether a character is a mark (non-spacing mark, combining mark, or enclosing mark in Unicode speak). Given some UTF-8 text, obtain a character value with g_utf8_get_char().

Note: in most cases where isalpha characters are allowed, ismark characters should be allowed to as they are essential for writing most European languages as well as many non-Latin scripts.

func UnicharIsprint 

func UnicharIsprint(CVar uint32) bool

Determines whether a character is printable. Unlike g_unichar_isgraph(), returns %TRUE for spaces. Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIspunct 

func UnicharIspunct(CVar uint32) bool

Determines whether a character is punctuation or a symbol. Given some UTF-8 text, obtain a character value with g_utf8_get_char().

func UnicharIsspace 

func UnicharIsspace(CVar uint32) bool

Determines whether a character is a space, tab, or line separator (newline, carriage return, etc.). Given some UTF-8 text, obtain a character value with g_utf8_get_char().

(Note: don't use this to do word breaking; you have to use Pango or equivalent to get word breaking right, the algorithm is fairly complex.)

func UnicharIstitle 

func UnicharIstitle(CVar uint32) bool

Determines if a character is titlecase. Some characters in Unicode which are composites, such as the DZ digraph have three case variants instead of just two. The titlecase form is used at the beginning of a word where only the first letter is capitalized. The titlecase form of the DZ digraph is U+01F2 LATIN CAPITAL LETTTER D WITH SMALL LETTER Z.

func UnicharIsupper 

func UnicharIsupper(CVar uint32) bool

Determines if a character is uppercase.

func UnicharIswide 

func UnicharIswide(CVar uint32) bool

Determines if a character is typically rendered in a double-width cell.

func UnicharIswideCjk 

func UnicharIswideCjk(CVar uint32) bool

Determines if a character is typically rendered in a double-width cell under legacy East Asian locales. If a character is wide according to g_unichar_iswide(), then it is also reported wide with this function, but the converse is not necessarily true. See the [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/) for details.

If a character passes the g_unichar_iswide() test then it will also pass this test, but not the other way around. Note that some characters may pass both this test and g_unichar_iszerowidth().

func UnicharIsxdigit 

func UnicharIsxdigit(CVar uint32) bool

Determines if a character is a hexadecimal digit.

func UnicharIszerowidth 

func UnicharIszerowidth(CVar uint32) bool

Determines if a given character typically takes zero width when rendered. The return value is %TRUE for all non-spacing and enclosing marks (e.g., combining accents), format characters, zero-width space, but not U+00AD SOFT HYPHEN.

A typical use of this function is with one of g_unichar_iswide() or g_unichar_iswide_cjk() to determine the number of cells a string occupies when displayed on a grid display (terminals). However, note that not all terminals support zero-width rendering of zero-width marks.

func UnicharToUtf8 

func UnicharToUtf8(CVar uint32, OutbufVar *string) int

Converts a single character to UTF-8.

func UnicharTolower 

func UnicharTolower(CVar uint32) uint32

Converts a character to lower case.

func UnicharTotitle 

func UnicharTotitle(CVar uint32) uint32

Converts a character to the titlecase.

func UnicharToupper 

func UnicharToupper(CVar uint32) uint32

Converts a character to uppercase.

func UnicharValidate 

func UnicharValidate(ChVar uint32) bool

Checks whether @ch is a valid Unicode character.

Some possible integer values of @ch will not be valid. U+0000 is considered a valid character, though it’s normally a string terminator.

func UnicharXdigitValue 

func UnicharXdigitValue(CVar uint32) int

Determines the numeric value of a character as a hexadecimal digit.

func UnicodeBreakTypeGLibType 

func UnicodeBreakTypeGLibType() types.GType

func UnicodeCanonicalDecomposition 

func UnicodeCanonicalDecomposition(ChVar uint32, ResultLenVar uint) uint32

Computes the canonical decomposition of a Unicode character.

func UnicodeCanonicalOrdering 

func UnicodeCanonicalOrdering(StringVar []uint32, LenVar uint)

Computes the canonical ordering of a string in-place. This rearranges decomposed characters in the string according to their combining classes. See the Unicode manual for more information.

func UnicodeScriptGLibType 

func UnicodeScriptGLibType() types.GType

func UnicodeScriptToIso15924 

func UnicodeScriptToIso15924(ScriptVar UnicodeScript) uint32

Looks up the ISO 15924 code for @script. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is 'Arab'. The four letter codes are encoded as a @guint32 by this function in a big-endian fashion. That is, the code returned for Arabic is 0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc).

See [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) for details.

func UnicodeTypeGLibType 

func UnicodeTypeGLibType() types.GType
func Unlink(FilenameVar string) int

A wrapper for the POSIX unlink() function. The unlink() function deletes a name from the filesystem. If this was the last link to the file and no processes have it opened, the diskspace occupied by the file is freed.

See your C library manual for more details about unlink(). Note that on Windows, it is in general not possible to delete files that are open to some process, or mapped into memory.

func UnrefCallback 

func UnrefCallback(fnPtr interface{}) error

UnrefCallbackValue unreferences the provided callback by reflect.value to free a purego slot

NOTE: Windows does not support unreferencing callbacks, so on that platform this operation is a NOOP, callback memory is never freed, and there is a limit on maximum total callbacks. See the purego documentation for further details.

func Unsetenv 

func Unsetenv(VariableVar string)

Removes an environment variable from the environment.

Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed.

You should be mindful of the fact that environment variable handling in UNIX is not thread-safe, and your program may crash if one thread calls g_unsetenv() while another thread is calling getenv(). (And note that many functions, such as gettext(), call getenv() internally.) This function is only safe to use at the very start of your program, before creating any other threads (or creating objects that create worker threads of their own).

If you need to set up the environment for a child process, you can use g_get_environ() to get an environment array, modify that with g_environ_setenv() and g_environ_unsetenv(), and then pass that array directly to execvpe(), g_spawn_async(), or the like.

func UriEscapeBytes 

func UriEscapeBytes(UnescapedVar []byte, LengthVar uint, ReservedCharsAllowedVar *string) string

Escapes arbitrary data for use in a URI.

Normally all characters that are not ‘unreserved’ (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in @reserved_chars_allowed they are not escaped. This is useful for the ‘reserved’ characters in the URI specification, since those are allowed unescaped in some portions of a URI.

Though technically incorrect, this will also allow escaping nul bytes as `%“00`.

func UriEscapeString 

func UriEscapeString(UnescapedVar string, ReservedCharsAllowedVar *string, AllowUtf8Var bool) string

Escapes a string for use in a URI.

Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in @reserved_chars_allowed they are not escaped. This is useful for the "reserved" characters in the URI specification, since those are allowed unescaped in some portions of a URI.

func UriGLibType 

func UriGLibType() types.GType

func UriIsValid 

func UriIsValid(UriStringVar string, FlagsVar UriFlags) (bool, error)

Parses @uri_string according to @flags, to determine whether it is a valid [absolute URI](#relative-and-absolute-uris), i.e. it does not need to be resolved relative to another URI using g_uri_parse_relative().

If it’s not a valid URI, an error is returned explaining how it’s invalid.

See g_uri_split(), and the definition of #GUriFlags, for more information on the effect of @flags.

func UriJoin 

func UriJoin(FlagsVar UriFlags, SchemeVar *string, UserinfoVar *string, HostVar *string, PortVar int, PathVar string, QueryVar *string, FragmentVar *string) string

Joins the given components together according to @flags to create an absolute URI string. @path may not be %NULL (though it may be the empty string).

When @host is present, @path must either be empty or begin with a slash (`/`) character. When @host is not present, @path cannot begin with two slash characters (`//`). See [RFC 3986, section 3](https://tools.ietf.org/html/rfc3986#section-3).

See also g_uri_join_with_user(), which allows specifying the components of the ‘userinfo’ separately.

%G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set in @flags.

func UriJoinWithUser 

func UriJoinWithUser(FlagsVar UriFlags, SchemeVar *string, UserVar *string, PasswordVar *string, AuthParamsVar *string, HostVar *string, PortVar int, PathVar string, QueryVar *string, FragmentVar *string) string

Joins the given components together according to @flags to create an absolute URI string. @path may not be %NULL (though it may be the empty string).

In contrast to g_uri_join(), this allows specifying the components of the ‘userinfo’ separately. It otherwise behaves the same.

%G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS are ignored if set in @flags.

func UriListExtractUris 

func UriListExtractUris(UriListVar string) []string

Splits an URI list conforming to the text/uri-list mime type defined in RFC 2483 into individual URIs, discarding any comments. The URIs are not validated.

func UriParseScheme 

func UriParseScheme(UriVar string) string

Gets the scheme portion of a URI string. [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include `file`, `https`, `svn+ssh`, etc.

func UriPeekScheme 

func UriPeekScheme(UriVar string) string

Gets the scheme portion of a URI string. [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] ]| Common schemes include `file`, `https`, `svn+ssh`, etc.

Unlike g_uri_parse_scheme(), the returned scheme is normalized to all-lowercase and does not need to be freed.

func UriResolveRelative 

func UriResolveRelative(BaseUriStringVar *string, UriRefVar string, FlagsVar UriFlags) (string, error)

Parses @uri_ref according to @flags and, if it is a [relative URI](#relative-and-absolute-uris), resolves it relative to @base_uri_string. If the result is not a valid absolute URI, it will be discarded, and an error returned.

(If @base_uri_string is %NULL, this just returns @uri_ref, or %NULL if @uri_ref is invalid or not absolute.)

func UriSplit 

func UriSplit(UriRefVar string, FlagsVar UriFlags, SchemeVar *string, UserinfoVar *string, HostVar *string, PortVar *int, PathVar *string, QueryVar *string, FragmentVar *string) (bool, error)

Parses @uri_ref (which can be an [absolute or relative URI](#relative-and-absolute-uris)) according to @flags, and returns the pieces. Any component that doesn't appear in @uri_ref will be returned as %NULL (but note that all URIs always have a path component, though it may be the empty string).

If @flags contains %G_URI_FLAGS_ENCODED, then `%`-encoded characters in @uri_ref will remain encoded in the output strings. (If not, then all such characters will be decoded.) Note that decoding will only work if the URI components are ASCII or UTF-8, so you will need to use %G_URI_FLAGS_ENCODED if they are not.

Note that the %G_URI_FLAGS_HAS_PASSWORD and %G_URI_FLAGS_HAS_AUTH_PARAMS @flags are ignored by g_uri_split(), since it always returns only the full userinfo; use g_uri_split_with_user() if you want it split up.

func UriSplitNetwork 

func UriSplitNetwork(UriStringVar string, FlagsVar UriFlags, SchemeVar *string, HostVar *string, PortVar *int) (bool, error)

Parses @uri_string (which must be an [absolute URI](#relative-and-absolute-uris)) according to @flags, and returns the pieces relevant to connecting to a host. See the documentation for g_uri_split() for more details; this is mostly a wrapper around that function with simpler arguments. However, it will return an error if @uri_string is a relative URI, or does not contain a hostname component.

func UriSplitWithUser 

func UriSplitWithUser(UriRefVar string, FlagsVar UriFlags, SchemeVar *string, UserVar *string, PasswordVar *string, AuthParamsVar *string, HostVar *string, PortVar *int, PathVar *string, QueryVar *string, FragmentVar *string) (bool, error)

Parses @uri_ref (which can be an [absolute or relative URI](#relative-and-absolute-uris)) according to @flags, and returns the pieces. Any component that doesn't appear in @uri_ref will be returned as %NULL (but note that all URIs always have a path component, though it may be the empty string).

See g_uri_split(), and the definition of #GUriFlags, for more information on the effect of @flags. Note that @password will only be parsed out if @flags contains %G_URI_FLAGS_HAS_PASSWORD, and @auth_params will only be parsed out if @flags contains %G_URI_FLAGS_HAS_AUTH_PARAMS.

func UriUnescapeSegment 

func UriUnescapeSegment(EscapedStringVar *string, EscapedStringEndVar *string, IllegalCharactersVar *string) string

Unescapes a segment of an escaped string.

If any of the characters in @illegal_characters or the NUL character appears as an escaped character in @escaped_string, then that is an error and %NULL will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

Note: `NUL` byte is not accepted in the output, in contrast to g_uri_unescape_bytes().

func UriUnescapeString 

func UriUnescapeString(EscapedStringVar string, IllegalCharactersVar *string) string

Unescapes a whole escaped string.

If any of the characters in @illegal_characters or the NUL character appears as an escaped character in @escaped_string, then that is an error and %NULL will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

func Usleep 

func Usleep(MicrosecondsVar uint)

Pauses the current thread for the given number of microseconds.

There are 1 million microseconds per second (represented by the %G_USEC_PER_SEC macro). g_usleep() may have limited precision, depending on hardware and operating system; don't rely on the exact length of the sleep.

func Utf8Casefold 

func Utf8Casefold(StrVar string, LenVar int) string

Converts a string into a form that is independent of case. The result will not correspond to any particular case, but can be compared for equality or ordered with the results of calling g_utf8_casefold() on other strings.

Note that calling g_utf8_casefold() followed by g_utf8_collate() is only an approximation to the correct linguistic case insensitive ordering, though it is a fairly good one. Getting this exactly right would require a more sophisticated collation function that takes case sensitivity into account. GLib does not currently provide such a function.

func Utf8Collate 

func Utf8Collate(Str1Var string, Str2Var string) int

Compares two strings for ordering using the linguistically correct rules for the [current locale](running.html#locale). When sorting a large number of strings, it will be significantly faster to obtain collation keys with g_utf8_collate_key() and compare the keys with strcmp() when sorting instead of sorting the original strings.

If the two strings are not comparable due to being in different collation sequences, the result is undefined. This can happen if the strings are in different language scripts, for example.

func Utf8CollateKey 

func Utf8CollateKey(StrVar string, LenVar int) string

Converts a string into a collation key that can be compared with other collation keys produced by the same function using strcmp().

The results of comparing the collation keys of two strings with strcmp() will always be the same as comparing the two original keys with g_utf8_collate().

Note that this function depends on the [current locale](running.html#locale).

Note that the returned string is not guaranteed to be in any encoding, especially UTF-8. The returned value is meant to be used only for comparisons.

func Utf8CollateKeyForFilename 

func Utf8CollateKeyForFilename(StrVar string, LenVar int) string

Converts a string into a collation key that can be compared with other collation keys produced by the same function using strcmp().

In order to sort filenames correctly, this function treats the dot '.' as a special case. Most dictionary orderings seem to consider it insignificant, thus producing the ordering "event.c" "eventgenerator.c" "event.h" instead of "event.c" "event.h" "eventgenerator.c". Also, we would like to treat numbers intelligently so that "file1" "file10" "file5" is sorted as "file1" "file5" "file10".

Note that this function depends on the [current locale](running.html#locale).

Note that the returned string is not guaranteed to be in any encoding, especially UTF-8. The returned value is meant to be used only for comparisons.

func Utf8FindNextChar 

func Utf8FindNextChar(PVar string, EndVar *string) string

Finds the start of the next UTF-8 character in the string after @p.

@p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than it starts with an appropriate byte.

If @end is `NULL`, the return value will never be `NULL`: if the end of the string is reached, a pointer to the terminating nul byte is returned. If @end is non-`NULL`, the return value will be `NULL` if the end of the string is reached.

func Utf8FindPrevChar 

func Utf8FindPrevChar(StrVar string, PVar string) string

Given a position @p with a UTF-8 encoded string @str, find the start of the previous UTF-8 character starting before @p. Returns `NULL` if no UTF-8 characters are present in @str before @p.

@p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than it starts with an appropriate byte.

func Utf8GetChar 

func Utf8GetChar(PVar string) uint32

Converts a sequence of bytes encoded as UTF-8 to a Unicode character.

If @p does not point to a valid UTF-8 encoded character, results are undefined. If you are not sure that the bytes are complete valid Unicode characters, you should use [func@GLib.utf8_get_char_validated] instead.

func Utf8GetCharValidated 

func Utf8GetCharValidated(PVar string, MaxLenVar int) uint32

Convert a sequence of bytes encoded as UTF-8 to a Unicode character.

This function checks for incomplete characters, for invalid characters such as characters that are out of the range of Unicode, and for overlong encodings of valid characters.

Note that [func@GLib.utf8_get_char_validated] returns `(gunichar)-2` if @max_len is positive and any of the bytes in the first UTF-8 character sequence are nul.

func Utf8MakeValid 

func Utf8MakeValid(StrVar string, LenVar int) string

If the provided string is valid UTF-8, return a copy of it. If not, return a copy in which bytes that could not be interpreted as valid Unicode are replaced with the Unicode replacement character (U+FFFD).

For example, this is an appropriate function to use if you have received a string that was incorrectly declared to be UTF-8, and you need a valid UTF-8 version of it that can be logged or displayed to the user, with the assumption that it is close enough to ASCII or UTF-8 to be mostly readable as-is.

func Utf8Normalize 

func Utf8Normalize(StrVar string, LenVar int, ModeVar NormalizeMode) string

Converts a string into canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. The string has to be valid UTF-8, otherwise %NULL is returned. You should generally call g_utf8_normalize() before comparing two Unicode strings.

The normalization mode %G_NORMALIZE_DEFAULT only standardizes differences that do not affect the text content, such as the above-mentioned accent representation. %G_NORMALIZE_ALL also standardizes the "compatibility" characters in Unicode, such as SUPERSCRIPT THREE to the standard forms (in this case DIGIT THREE). Formatting information may be lost but for most text operations such characters should be considered the same.

%G_NORMALIZE_DEFAULT_COMPOSE and %G_NORMALIZE_ALL_COMPOSE are like %G_NORMALIZE_DEFAULT and %G_NORMALIZE_ALL, but returned a result with composed forms rather than a maximally decomposed form. This is often useful if you intend to convert the string to a legacy encoding or pass it to a system with less capable Unicode handling.

func Utf8OffsetToPointer 

func Utf8OffsetToPointer(StrVar string, OffsetVar int) string

Converts from an integer character offset to a pointer to a position within the string.

Since 2.10, this function allows to pass a negative @offset to step backwards. It is usually worth stepping backwards from the end instead of forwards if @offset is in the last fourth of the string, since moving forward is about 3 times faster than moving backward.

Note that this function doesn’t abort when reaching the end of @str. Therefore you should be sure that @offset is within string boundaries before calling that function. Call [func@GLib.utf8_strlen] when unsure. This limitation exists as this function is called frequently during text rendering and therefore has to be as fast as possible.

func Utf8PointerToOffset 

func Utf8PointerToOffset(StrVar string, PosVar string) int

Converts from a pointer to position within a string to an integer character offset.

Since 2.10, this function allows @pos to be before @str, and returns a negative offset in this case.

func Utf8PrevChar 

func Utf8PrevChar(PVar string) string

Finds the previous UTF-8 character in the string before @p.

@p does not have to be at the beginning of a UTF-8 character. No check is made to see if the character found is actually valid other than it starts with an appropriate byte. If @p might be the first character of the string, you must use [func@GLib.utf8_find_prev_char] instead.

func Utf8Strchr 

func Utf8Strchr(PVar string, LenVar int, CVar uint32) string

Finds the leftmost occurrence of the given Unicode character in a UTF-8 encoded string, while limiting the search to @len bytes.

If @len is `-1`, allow unbounded search.

func Utf8Strdown 

func Utf8Strdown(StrVar string, LenVar int) string

Converts all Unicode characters in the string that have a case to lowercase. The exact manner that this is done depends on the current locale, and may result in the number of characters in the string changing.

func Utf8Strlen 

func Utf8Strlen(PVar string, MaxVar int) int

Computes the length of the string in characters, not including the terminating nul character. If the @max’th byte falls in the middle of a character, the last (partial) character is not counted.

func Utf8Strncpy 

func Utf8Strncpy(DestVar string, SrcVar string, NVar uint) string

Like the standard C [`strncpy()`](man:strncpy) function, but copies a given number of characters instead of a given number of bytes.

The @src string must be valid UTF-8 encoded text. (Use [func@GLib.utf8_validate] on all text before trying to use UTF-8 utility functions with it.)

Note you must ensure @dest is at least 4 * @n + 1 to fit the largest possible UTF-8 characters

func Utf8Strrchr 

func Utf8Strrchr(PVar string, LenVar int, CVar uint32) string

Find the rightmost occurrence of the given Unicode character in a UTF-8 encoded string, while limiting the search to @len bytes.

If @len is `-1`, allow unbounded search.

func Utf8Strreverse 

func Utf8Strreverse(StrVar string, LenVar int) string

Reverses a UTF-8 string.

@str must be valid UTF-8 encoded text. (Use [func@GLib.utf8_validate] on all text before trying to use UTF-8 utility functions with it.)

This function is intended for programmatic uses of reversed strings. It pays no attention to decomposed characters, combining marks, byte order marks, directional indicators (LRM, LRO, etc) and similar characters which might need special handling when reversing a string for display purposes.

Note that unlike [func@GLib.strreverse], this function returns newly-allocated memory, which should be freed with [func@GLib.free] when no longer needed.

func Utf8Strup 

func Utf8Strup(StrVar string, LenVar int) string

Converts all Unicode characters in the string that have a case to uppercase. The exact manner that this is done depends on the current locale, and may result in the number of characters in the string increasing. (For instance, the German ess-zet will be changed to SS.)

func Utf8Substring 

func Utf8Substring(StrVar string, StartPosVar int, EndPosVar int) string

Copies a substring out of a UTF-8 encoded string. The substring will contain @end_pos - @start_pos characters.

Since GLib 2.72, `-1` can be passed to @end_pos to indicate the end of the string.

func Utf8ToUcs4 

func Utf8ToUcs4(StrVar string, LenVar int, ItemsReadVar *int, ItemsWrittenVar *int) (uint32, error)

Convert a string from UTF-8 to a 32-bit fixed width representation as UCS-4.

A trailing nul character (U+0000) will be added to the string after the converted text.

func Utf8ToUcs4Fast 

func Utf8ToUcs4Fast(StrVar string, LenVar int, ItemsWrittenVar *int) uint32

Convert a string from UTF-8 to a 32-bit fixed width representation as UCS-4, assuming valid UTF-8 input.

This function is roughly twice as fast as [func@GLib.utf8_to_ucs4] but does no error checking on the input. A trailing nul character (U+0000) will be added to the string after the converted text.

func Utf8ToUtf16 

func Utf8ToUtf16(StrVar string, LenVar int, ItemsReadVar *int, ItemsWrittenVar *int) (uint16, error)

Convert a string from UTF-8 to UTF-16.

A nul character (U+0000) will be added to the result after the converted text.

func Utf8TruncateMiddle 

func Utf8TruncateMiddle(StringVar string, TruncateLengthVar uint) string

Cuts off the middle of the string, preserving half of @truncate_length characters at the beginning and half at the end.

If @string is already short enough, this returns a copy of @string. If @truncate_length is `0`, an empty string is returned.

func Utf8Validate 

func Utf8Validate(StrVar []byte, MaxLenVar int, EndVar *[]byte) bool

Validates UTF-8 encoded text.

@str is the text to validate; if @str is nul-terminated, then @max_len can be `-1`, otherwise @max_len should be the number of bytes to validate.

If @end is non-`NULL`, then the end of the valid range will be stored there. This is the first byte of the first invalid character if some bytes were invalid, or the end of the text being validated otherwise — either the trailing nul byte, or the first byte beyond @max_len (if it’s positive).

Note that `g_utf8_validate()` returns `FALSE` if @max_len is positive and any of the @max_len bytes are nul.

Returns `TRUE` if all of @str was valid. Many GLib and GTK routines require valid UTF-8 as input; so data read from a file or the network should be checked with `g_utf8_validate()` before doing anything else with it.

func Utf8ValidateLen 

func Utf8ValidateLen(StrVar []byte, MaxLenVar uint, EndVar *[]byte) bool

Validates UTF-8 encoded text.

As with [func@GLib.utf8_validate], but @max_len must be set, and hence this function will always return `FALSE` if any of the bytes of @str are nul.

func Utf16ToUcs4 

func Utf16ToUcs4(StrVar []uint16, LenVar int, ItemsReadVar *int, ItemsWrittenVar *int) (uint32, error)

Convert a string from UTF-16 to UCS-4.

The result will be nul-terminated.

func Utf16ToUtf8 

func Utf16ToUtf8(StrVar []uint16, LenVar int, ItemsReadVar *int, ItemsWrittenVar *int) (string, error)

Convert a string from UTF-16 to UTF-8.

The result will be terminated with a nul byte.

Note that the input is expected to be already in native endianness, an initial byte-order-mark character is not handled specially. [func@GLib.convert] can be used to convert a byte buffer of UTF-16 data of ambiguous endianness.

Further note that this function does not validate the result string; it may (for example) include embedded nul characters. The only validation done by this function is to ensure that the input can be correctly interpreted as UTF-16, i.e. it doesn’t contain unpaired surrogates or partial character sequences.

func Utime 

func Utime(FilenameVar string, UtbVar uintptr) int

A wrapper for the POSIX utime() function. The utime() function sets the access and modification timestamps of a file.

See your C library manual for more details about how utime() works on your system.

func UuidStringIsValid 

func UuidStringIsValid(StrVar string) bool

Parses the string @str and verify if it is a UUID.

The function accepts the following syntax:

- simple forms (e.g. `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`)

Note that hyphens are required within the UUID string itself, as per the aforementioned RFC.

func UuidStringRandom 

func UuidStringRandom() string

Generates a random UUID (RFC 4122 version 4) as a string. It has the same randomness guarantees as #GRand, so must not be used for cryptographic purposes such as key generation, nonces, salts or one-time pads.

func VariantBuilderGLibType 

func VariantBuilderGLibType() types.GType

func VariantDictGLibType 

func VariantDictGLibType() types.GType

func VariantGLibType 

func VariantGLibType() types.GType

func VariantGetGtype 

func VariantGetGtype() types.GType

func VariantIsObjectPath 

func VariantIsObjectPath(StringVar string) bool

Determines if a given string is a valid D-Bus object path. You should ensure that a string is a valid D-Bus object path before passing it to g_variant_new_object_path().

A valid object path starts with `/` followed by zero or more sequences of characters separated by `/` characters. Each sequence must contain only the characters `[A-Z][a-z][0-9]_`. No sequence (including the one following the final `/` character) may be empty.

func VariantIsSignature 

func VariantIsSignature(StringVar string) bool

Determines if a given string is a valid D-Bus type signature. You should ensure that a string is a valid D-Bus type signature before passing it to g_variant_new_signature().

D-Bus type signatures consist of zero or more definite #GVariantType strings in sequence.

func VariantParseErrorPrintContext 

func VariantParseErrorPrintContext(ErrorVar *Error, SourceStrVar string) string

Pretty-prints a message showing the context of a #GVariant parse error within the string for which parsing was attempted.

The resulting string is suitable for output to the console or other monospace media where newlines are treated in the usual way.

The message will typically look something like one of the following:

|[ unterminated string constant: 

(1, 2, 3, 'abc
          ^^^^

]|

or

|[ unable to find a common type: 

[1, 2, 3, 'str']
 ^        ^^^^^

]|

The format of the message may change in a future version.

@error must have come from a failed attempt to g_variant_parse() and @source_str must be exactly the same string that caused the error. If @source_str was not nul-terminated when you passed it to g_variant_parse() then you must add nul termination before using this function.

func VariantTypeGLibType 

func VariantTypeGLibType() types.GType

func VariantTypeStringGetDepth 

func VariantTypeStringGetDepth(TypeStringVar string) uint

func VariantTypeStringIsValid 

func VariantTypeStringIsValid(TypeStringVar string) bool

Checks if @type_string is a valid [GVariant type string](./struct.VariantType.html#gvariant-type-strings).

This call is equivalent to calling [func@GLib.VariantType.string_scan] and confirming that the following character is a nul terminator.

func VariantTypeStringScan 

func VariantTypeStringScan(StringVar string, LimitVar *string, EndptrVar *string) bool

Scan for a single complete and valid GVariant type string in @string.

The memory pointed to by @limit (or bytes beyond it) is never accessed.

If a valid type string is found, @endptr is updated to point to the first character past the end of the string that was found and %TRUE is returned.

If there is no valid type string starting at @string, or if the type string does not end before @limit then %FALSE is returned.

For the simple case of checking if a string is a valid type string, see [func@GLib.VariantType.string_is_valid].

func Vasprintf 

func Vasprintf(StringVar *string, FormatVar string, ArgsVar []interface{}) int

An implementation of the GNU `vasprintf()` function which supports positional parameters, as specified in the Single Unix Specification. This function is similar to [func@GLib.vsprintf], except that it allocates a string to hold the output, instead of putting the output in a buffer you allocate in advance.

The returned value in @string is guaranteed to be non-`NULL`, unless @format contains `%lc` or `%ls` conversions, which can fail if no multibyte representation is available for the given character.

`glib/gprintf.h` must be explicitly included in order to use this function.

func Vfprintf 

func Vfprintf(FileVar uintptr, FormatVar string, ArgsVar []interface{}) int

An implementation of the standard `fprintf()` function which supports positional parameters, as specified in the Single Unix Specification.

`glib/gprintf.h` must be explicitly included in order to use this function.

func Vprintf 

func Vprintf(FormatVar string, ArgsVar []interface{}) int

An implementation of the standard `vprintf()` function which supports positional parameters, as specified in the Single Unix Specification.

`glib/gprintf.h` must be explicitly included in order to use this function.

func Vsnprintf 

func Vsnprintf(StringVar string, NVar uint, FormatVar string, ArgsVar []interface{}) int

A safer form of the standard `vsprintf()` function. The output is guaranteed to not exceed @n characters (including the terminating nul character), so it is easy to ensure that a buffer overflow cannot occur.

See also [func@GLib.strdup_vprintf].

In versions of GLib prior to 1.2.3, this function may return -1 if the output was truncated, and the truncated string may not be nul-terminated. In versions prior to 1.3.12, this function returns the length of the output string.

The return value of `g_vsnprintf()` conforms to the `vsnprintf()` function as standardized in ISO C99. Note that this is different from traditional `vsnprintf()`, which returns the length of the output string.

The format string may contain positional parameters, as specified in the Single Unix Specification.

func Vsprintf 

func Vsprintf(StringVar string, FormatVar string, ArgsVar []interface{}) int

An implementation of the standard `vsprintf()` function which supports positional parameters, as specified in the Single Unix Specification.

`glib/gprintf.h` must be explicitly included in order to use this function.

func WarnMessage 

func WarnMessage(DomainVar *string, FileVar string, LineVar int, FuncVar string, WarnexprVar *string)

Internal function used to print messages from the public [func@GLib.warn_if_reached] and [func@GLib.warn_if_fail] macros.

Types

type Allocator 

type Allocator struct {
	// contains filtered or unexported fields
}

func (*Allocator) Free 

func (x *Allocator) Free()

func (*Allocator) GoPointer 

func (x *Allocator) GoPointer() uintptr

type Array 

type Array struct {
	Data uintptr

	Len uint
	// contains filtered or unexported fields
}

Contains the public fields of a `GArray`.

func (*Array) GoPointer 

func (x *Array) GoPointer() uintptr

type AsciiType 

type AsciiType int
const (
	GAsciiAlnumValue AsciiType = 1

	GAsciiAlphaValue AsciiType = 2

	GAsciiCntrlValue AsciiType = 4

	GAsciiDigitValue AsciiType = 8

	GAsciiGraphValue AsciiType = 16

	GAsciiLowerValue AsciiType = 32

	GAsciiPrintValue AsciiType = 64

	GAsciiPunctValue AsciiType = 128

	GAsciiSpaceValue AsciiType = 256

	GAsciiUpperValue AsciiType = 512

	GAsciiXdigitValue AsciiType = 1024
)

type AsyncQueue 

type AsyncQueue struct {
	// contains filtered or unexported fields
}

An opaque data structure which represents an asynchronous queue.

It should only be accessed through the `g_async_queue_*` functions.

func AsyncQueueNew 

func AsyncQueueNew() *AsyncQueue

Creates a new asynchronous queue.

func AsyncQueueNewFull 

func AsyncQueueNewFull(ItemFreeFuncVar *DestroyNotify) *AsyncQueue

Creates a new asynchronous queue and sets up a destroy notify function that is used to free any remaining queue items when the queue is destroyed after the final unref.

func (*AsyncQueue) GoPointer 

func (x *AsyncQueue) GoPointer() uintptr

func (*AsyncQueue) Length 

func (x *AsyncQueue) Length() int

Returns the length of the queue.

Actually this function returns the number of data items in the queue minus the number of waiting threads, so a negative value means waiting threads, and a positive value means available entries in the @queue. A return value of 0 could mean n entries in the queue and n threads waiting. This can happen due to locking of the queue or due to scheduling.

func (*AsyncQueue) LengthUnlocked 

func (x *AsyncQueue) LengthUnlocked() int

Returns the length of the queue.

Actually this function returns the number of data items in the queue minus the number of waiting threads, so a negative value means waiting threads, and a positive value means available entries in the @queue. A return value of 0 could mean n entries in the queue and n threads waiting. This can happen due to locking of the queue or due to scheduling.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) Lock 

func (x *AsyncQueue) Lock()

Acquires the @queue's lock. If another thread is already holding the lock, this call will block until the lock becomes available.

Call g_async_queue_unlock() to drop the lock again.

While holding the lock, you can only call the g_async_queue_*_unlocked() functions on @queue. Otherwise, deadlock may occur.

func (*AsyncQueue) Pop 

func (x *AsyncQueue) Pop() uintptr

Pops data from the @queue. If @queue is empty, this function blocks until data becomes available.

func (*AsyncQueue) PopUnlocked 

func (x *AsyncQueue) PopUnlocked() uintptr

Pops data from the @queue. If @queue is empty, this function blocks until data becomes available.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) Push 

func (x *AsyncQueue) Push(DataVar uintptr)

Pushes the @data into the @queue.

The @data parameter must not be %NULL.

func (*AsyncQueue) PushFront 

func (x *AsyncQueue) PushFront(ItemVar uintptr)

Pushes the @item into the @queue. @item must not be %NULL. In contrast to g_async_queue_push(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue.

func (*AsyncQueue) PushFrontUnlocked 

func (x *AsyncQueue) PushFrontUnlocked(ItemVar uintptr)

Pushes the @item into the @queue. @item must not be %NULL. In contrast to g_async_queue_push_unlocked(), this function pushes the new item ahead of the items already in the queue, so that it will be the next one to be popped off the queue.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) PushSorted 

func (x *AsyncQueue) PushSorted(DataVar uintptr, FuncVar *CompareDataFunc, UserDataVar uintptr)

Inserts @data into @queue using @func to determine the new position.

This function requires that the @queue is sorted before pushing on new elements, see g_async_queue_sort().

This function will lock @queue before it sorts the queue and unlock it when it is finished.

For an example of @func see g_async_queue_sort().

func (*AsyncQueue) PushSortedUnlocked 

func (x *AsyncQueue) PushSortedUnlocked(DataVar uintptr, FuncVar *CompareDataFunc, UserDataVar uintptr)

Inserts @data into @queue using @func to determine the new position.

The sort function @func is passed two elements of the @queue. It should return 0 if they are equal, a negative value if the first element should be higher in the @queue or a positive value if the first element should be lower in the @queue than the second element.

This function requires that the @queue is sorted before pushing on new elements, see g_async_queue_sort().

This function must be called while holding the @queue's lock.

For an example of @func see g_async_queue_sort().

func (*AsyncQueue) PushUnlocked 

func (x *AsyncQueue) PushUnlocked(DataVar uintptr)

Pushes the @data into the @queue.

The @data parameter must not be %NULL.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) Ref 

func (x *AsyncQueue) Ref() *AsyncQueue

Increases the reference count of the asynchronous @queue by 1. You do not need to hold the lock to call this function.

func (*AsyncQueue) RefUnlocked 

func (x *AsyncQueue) RefUnlocked()

Increases the reference count of the asynchronous @queue by 1.

func (*AsyncQueue) Remove 

func (x *AsyncQueue) Remove(ItemVar uintptr) bool

Remove an item from the queue.

func (*AsyncQueue) RemoveUnlocked 

func (x *AsyncQueue) RemoveUnlocked(ItemVar uintptr) bool

Remove an item from the queue.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) Sort 

func (x *AsyncQueue) Sort(FuncVar *CompareDataFunc, UserDataVar uintptr)

Sorts @queue using @func.

The sort function @func is passed two elements of the @queue. It should return 0 if they are equal, a negative value if the first element should be higher in the @queue or a positive value if the first element should be lower in the @queue than the second element.

This function will lock @queue before it sorts the queue and unlock it when it is finished.

If you were sorting a list of priority numbers to make sure the lowest priority would be at the top of the queue, you could use: |[&lt;!-- language="C" --&gt; 

gint32 id1;
gint32 id2;

id1 = GPOINTER_TO_INT (element1);
id2 = GPOINTER_TO_INT (element2);

return (id1 &gt; id2 ? +1 : id1 == id2 ? 0 : -1);

]|

func (*AsyncQueue) SortUnlocked 

func (x *AsyncQueue) SortUnlocked(FuncVar *CompareDataFunc, UserDataVar uintptr)

Sorts @queue using @func.

The sort function @func is passed two elements of the @queue. It should return 0 if they are equal, a negative value if the first element should be higher in the @queue or a positive value if the first element should be lower in the @queue than the second element.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) TimedPop 

func (x *AsyncQueue) TimedPop(EndTimeVar *TimeVal) uintptr

Pops data from the @queue. If the queue is empty, blocks until @end_time or until data becomes available.

If no data is received before @end_time, %NULL is returned.

To easily calculate @end_time, a combination of g_get_real_time() and g_time_val_add() can be used.

func (*AsyncQueue) TimedPopUnlocked 

func (x *AsyncQueue) TimedPopUnlocked(EndTimeVar *TimeVal) uintptr

Pops data from the @queue. If the queue is empty, blocks until @end_time or until data becomes available.

If no data is received before @end_time, %NULL is returned.

To easily calculate @end_time, a combination of g_get_real_time() and g_time_val_add() can be used.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) TimeoutPop 

func (x *AsyncQueue) TimeoutPop(TimeoutVar uint64) uintptr

Pops data from the @queue. If the queue is empty, blocks for @timeout microseconds, or until data becomes available.

If no data is received before the timeout, %NULL is returned.

func (*AsyncQueue) TimeoutPopUnlocked 

func (x *AsyncQueue) TimeoutPopUnlocked(TimeoutVar uint64) uintptr

Pops data from the @queue. If the queue is empty, blocks for @timeout microseconds, or until data becomes available.

If no data is received before the timeout, %NULL is returned.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) TryPop 

func (x *AsyncQueue) TryPop() uintptr

Tries to pop data from the @queue. If no data is available, %NULL is returned.

func (*AsyncQueue) TryPopUnlocked 

func (x *AsyncQueue) TryPopUnlocked() uintptr

Tries to pop data from the @queue. If no data is available, %NULL is returned.

This function must be called while holding the @queue's lock.

func (*AsyncQueue) Unlock 

func (x *AsyncQueue) Unlock()

Releases the queue's lock.

Calling this function when you have not acquired the with g_async_queue_lock() leads to undefined behaviour.

func (*AsyncQueue) Unref 

func (x *AsyncQueue) Unref()

Decreases the reference count of the asynchronous @queue by 1.

If the reference count went to 0, the @queue will be destroyed and the memory allocated will be freed. So you are not allowed to use the @queue afterwards, as it might have disappeared. You do not need to hold the lock to call this function.

func (*AsyncQueue) UnrefAndUnlock 

func (x *AsyncQueue) UnrefAndUnlock()

Decreases the reference count of the asynchronous @queue by 1 and releases the lock. This function must be called while holding the @queue's lock. If the reference count went to 0, the @queue will be destroyed and the memory allocated will be freed.

type BookmarkFile 

type BookmarkFile struct {
	// contains filtered or unexported fields
}

`GBookmarkFile` lets you parse, edit or create files containing bookmarks.

Bookmarks refer to a URI, along with some meta-data about the resource pointed by the URI like its MIME type, the application that is registering the bookmark and the icon that should be used to represent the bookmark. The data is stored using the [Desktop Bookmark Specification](https://www.freedesktop.org/wiki/Specifications/desktop-bookmark-spec/).

The syntax of the bookmark files is described in detail inside the Desktop Bookmark Specification, here is a quick summary: bookmark files use a sub-class of the XML Bookmark Exchange Language specification, consisting of valid UTF-8 encoded XML, under the `&lt;xbel&gt;` root element; each bookmark is stored inside a `&lt;bookmark&gt;` element, using its URI: no relative paths can be used inside a bookmark file. The bookmark may have a user defined title and description, to be used instead of the URI. Under the `&lt;metadata&gt;` element, with its owner attribute set to `http://freedesktop.org`, is stored the meta-data about a resource pointed by its URI. The meta-data consists of the resource's MIME type; the applications that have registered a bookmark; the groups to which a bookmark belongs to; a visibility flag, used to set the bookmark as "private" to the applications and groups that has it registered; the URI and MIME type of an icon, to be used when displaying the bookmark inside a GUI.

Here is an example of a bookmark file: [bookmarks.xbel](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/glib/tests/bookmarks.xbel)

A bookmark file might contain more than one bookmark; each bookmark is accessed through its URI.

The important caveat of bookmark files is that when you add a new bookmark you must also add the application that is registering it, using [method@GLib.BookmarkFile.add_application] or [method@GLib.BookmarkFile.set_application_info]. If a bookmark has no applications then it won't be dumped when creating the on disk representation, using [method@GLib.BookmarkFile.to_data] or [method@GLib.BookmarkFile.to_file].

func NewBookmarkFile 

func NewBookmarkFile() *BookmarkFile

Creates a new empty #GBookmarkFile object.

Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data() or g_bookmark_file_load_from_data_dirs() to read an existing bookmark file.

func (*BookmarkFile) AddApplication 

func (x *BookmarkFile) AddApplication(UriVar string, NameVar *string, ExecVar *string)

Adds the application with @name and @exec to the list of applications that have registered a bookmark for @uri into @bookmark.

Every bookmark inside a #GBookmarkFile must have at least an application registered. Each application must provide a name, a command line useful for launching the bookmark, the number of times the bookmark has been registered by the application and the last time the application registered this bookmark.

If @name is %NULL, the name of the application will be the same returned by g_get_application_name(); if @exec is %NULL, the command line will be a composition of the program name as returned by g_get_prgname() and the "\%u" modifier, which will be expanded to the bookmark's URI.

This function will automatically take care of updating the registrations count and timestamping in case an application with the same @name had already registered a bookmark for @uri inside @bookmark.

If no bookmark for @uri is found, one is created.

func (*BookmarkFile) AddGroup 

func (x *BookmarkFile) AddGroup(UriVar string, GroupVar string)

Adds @group to the list of groups to which the bookmark for @uri belongs to.

If no bookmark for @uri is found then it is created.

func (*BookmarkFile) Copy 

func (x *BookmarkFile) Copy() *BookmarkFile

Deeply copies a @bookmark #GBookmarkFile object to a new one.

func (*BookmarkFile) Free 

func (x *BookmarkFile) Free()

Frees a #GBookmarkFile.

func (*BookmarkFile) GetAdded 

func (x *BookmarkFile) GetAdded(UriVar string) (int, error)

Gets the time the bookmark for @uri was added to @bookmark

In the event the URI cannot be found, -1 is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetAddedDateTime 

func (x *BookmarkFile) GetAddedDateTime(UriVar string) (*DateTime, error)

Gets the time the bookmark for @uri was added to @bookmark

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetAppInfo 

func (x *BookmarkFile) GetAppInfo(UriVar string, NameVar string, ExecVar *string, CountVar *uint, StampVar *int) (bool, error)

Gets the registration information of @app_name for the bookmark for @uri. See g_bookmark_file_set_application_info() for more information about the returned data.

The string returned in @app_exec must be freed.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that no application with name @app_name has registered a bookmark for @uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting the command line fails, an error of the %G_SHELL_ERROR domain is set and %FALSE is returned.

func (*BookmarkFile) GetApplicationInfo 

func (x *BookmarkFile) GetApplicationInfo(UriVar string, NameVar string, ExecVar *string, CountVar *uint, StampVar **DateTime) (bool, error)

Gets the registration information of @app_name for the bookmark for @uri. See g_bookmark_file_set_application_info() for more information about the returned data.

The string returned in @app_exec must be freed.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that no application with name @app_name has registered a bookmark for @uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting the command line fails, an error of the %G_SHELL_ERROR domain is set and %FALSE is returned.

func (*BookmarkFile) GetApplications 

func (x *BookmarkFile) GetApplications(UriVar string, LengthVar *uint) ([]string, error)

Retrieves the names of the applications that have registered the bookmark for @uri.

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetDescription 

func (x *BookmarkFile) GetDescription(UriVar string) (string, error)

Retrieves the description of the bookmark for @uri.

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetGroups 

func (x *BookmarkFile) GetGroups(UriVar string, LengthVar *uint) ([]string, error)

Retrieves the list of group names of the bookmark for @uri.

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

The returned array is %NULL terminated, so @length may optionally be %NULL.

func (*BookmarkFile) GetIcon 

func (x *BookmarkFile) GetIcon(UriVar string, HrefVar *string, MimeTypeVar *string) (bool, error)

Gets the icon of the bookmark for @uri.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetIsPrivate 

func (x *BookmarkFile) GetIsPrivate(UriVar string) (bool, error)

Gets whether the private flag of the bookmark for @uri is set.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that the private flag cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

func (*BookmarkFile) GetMimeType 

func (x *BookmarkFile) GetMimeType(UriVar string) (string, error)

Retrieves the MIME type of the resource pointed by @uri.

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that the MIME type cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

func (*BookmarkFile) GetModified 

func (x *BookmarkFile) GetModified(UriVar string) (int, error)

Gets the time when the bookmark for @uri was last modified.

In the event the URI cannot be found, -1 is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetModifiedDateTime 

func (x *BookmarkFile) GetModifiedDateTime(UriVar string) (*DateTime, error)

Gets the time when the bookmark for @uri was last modified.

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetSize 

func (x *BookmarkFile) GetSize() int

Gets the number of bookmarks inside @bookmark.

func (*BookmarkFile) GetTitle 

func (x *BookmarkFile) GetTitle(UriVar *string) (string, error)

Returns the title of the bookmark for @uri.

If @uri is %NULL, the title of @bookmark is returned.

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetUris 

func (x *BookmarkFile) GetUris(LengthVar *uint) []string

Returns all URIs of the bookmarks in the bookmark file @bookmark. The array of returned URIs will be %NULL-terminated, so @length may optionally be %NULL.

func (*BookmarkFile) GetVisited 

func (x *BookmarkFile) GetVisited(UriVar string) (int, error)

Gets the time the bookmark for @uri was last visited.

In the event the URI cannot be found, -1 is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GetVisitedDateTime 

func (x *BookmarkFile) GetVisitedDateTime(UriVar string) (*DateTime, error)

Gets the time the bookmark for @uri was last visited.

In the event the URI cannot be found, %NULL is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) GoPointer 

func (x *BookmarkFile) GoPointer() uintptr

func (*BookmarkFile) HasApplication 

func (x *BookmarkFile) HasApplication(UriVar string, NameVar string) (bool, error)

Checks whether the bookmark for @uri inside @bookmark has been registered by application @name.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) HasGroup 

func (x *BookmarkFile) HasGroup(UriVar string, GroupVar string) (bool, error)

Checks whether @group appears in the list of groups to which the bookmark for @uri belongs to.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) HasItem 

func (x *BookmarkFile) HasItem(UriVar string) bool

Looks whether the desktop bookmark has an item with its URI set to @uri.

func (*BookmarkFile) LoadFromData 

func (x *BookmarkFile) LoadFromData(DataVar []byte, LengthVar uint) (bool, error)

Loads a bookmark file from memory into an empty #GBookmarkFile structure. If the object cannot be created then @error is set to a #GBookmarkFileError.

func (*BookmarkFile) LoadFromDataDirs 

func (x *BookmarkFile) LoadFromDataDirs(FileVar string, FullPathVar *string) (bool, error)

This function looks for a desktop bookmark file named @file in the paths returned from g_get_user_data_dir() and g_get_system_data_dirs(), loads the file into @bookmark and returns the file's full path in @full_path. If the file could not be loaded then @error is set to either a #GFileError or #GBookmarkFileError.

func (*BookmarkFile) LoadFromFile 

func (x *BookmarkFile) LoadFromFile(FilenameVar string) (bool, error)

Loads a desktop bookmark file into an empty #GBookmarkFile structure. If the file could not be loaded then @error is set to either a #GFileError or #GBookmarkFileError.

func (*BookmarkFile) MoveItem 

func (x *BookmarkFile) MoveItem(OldUriVar string, NewUriVar *string) (bool, error)

Changes the URI of a bookmark item from @old_uri to @new_uri. Any existing bookmark for @new_uri will be overwritten. If @new_uri is %NULL, then the bookmark is removed.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.

func (*BookmarkFile) RemoveApplication 

func (x *BookmarkFile) RemoveApplication(UriVar string, NameVar string) (bool, error)

Removes application registered with @name from the list of applications that have registered a bookmark for @uri inside @bookmark.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event that no application with name @app_name has registered a bookmark for @uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.

func (*BookmarkFile) RemoveGroup 

func (x *BookmarkFile) RemoveGroup(UriVar string, GroupVar string) (bool, error)

Removes @group from the list of groups to which the bookmark for @uri belongs to.

In the event the URI cannot be found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND. In the event no group was defined, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.

func (*BookmarkFile) RemoveItem 

func (x *BookmarkFile) RemoveItem(UriVar string) (bool, error)

Removes the bookmark for @uri from the bookmark file @bookmark.

func (*BookmarkFile) SetAdded 

func (x *BookmarkFile) SetAdded(UriVar string, AddedVar int)

Sets the time the bookmark for @uri was added into @bookmark.

If no bookmark for @uri is found then it is created.

func (*BookmarkFile) SetAddedDateTime 

func (x *BookmarkFile) SetAddedDateTime(UriVar string, AddedVar *DateTime)

Sets the time the bookmark for @uri was added into @bookmark.

If no bookmark for @uri is found then it is created.

func (*BookmarkFile) SetAppInfo 

func (x *BookmarkFile) SetAppInfo(UriVar string, NameVar string, ExecVar string, CountVar int, StampVar int) (bool, error)

Sets the meta-data of application @name inside the list of applications that have registered a bookmark for @uri inside @bookmark.

You should rarely use this function; use g_bookmark_file_add_application() and g_bookmark_file_remove_application() instead.

@name can be any UTF-8 encoded string used to identify an application. @exec can have one of these two modifiers: "\%f", which will be expanded as the local file name retrieved from the bookmark's URI; "\%u", which will be expanded as the bookmark's URI. The expansion is done automatically when retrieving the stored command line using the g_bookmark_file_get_application_info() function. @count is the number of times the application has registered the bookmark; if is &lt; 0, the current registration count will be increased by one, if is 0, the application with @name will be removed from the list of registered applications. @stamp is the Unix time of the last registration; if it is -1, the current time will be used.

If you try to remove an application by setting its registration count to zero, and no bookmark for @uri is found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly, in the event that no application @name has registered a bookmark for @uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark for @uri is found, one is created.

func (*BookmarkFile) SetApplicationInfo 

func (x *BookmarkFile) SetApplicationInfo(UriVar string, NameVar string, ExecVar string, CountVar int, StampVar *DateTime) (bool, error)

Sets the meta-data of application @name inside the list of applications that have registered a bookmark for @uri inside @bookmark.

You should rarely use this function; use g_bookmark_file_add_application() and g_bookmark_file_remove_application() instead.

@name can be any UTF-8 encoded string used to identify an application. @exec can have one of these two modifiers: "\%f", which will be expanded as the local file name retrieved from the bookmark's URI; "\%u", which will be expanded as the bookmark's URI. The expansion is done automatically when retrieving the stored command line using the g_bookmark_file_get_application_info() function. @count is the number of times the application has registered the bookmark; if is &lt; 0, the current registration count will be increased by one, if is 0, the application with @name will be removed from the list of registered applications. @stamp is the Unix time of the last registration.

If you try to remove an application by setting its registration count to zero, and no bookmark for @uri is found, %FALSE is returned and @error is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly, in the event that no application @name has registered a bookmark for @uri, %FALSE is returned and error is set to %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. Otherwise, if no bookmark for @uri is found, one is created.

func (*BookmarkFile) SetDescription 

func (x *BookmarkFile) SetDescription(UriVar *string, DescriptionVar string)

Sets @description as the description of the bookmark for @uri.

If @uri is %NULL, the description of @bookmark is set.

If a bookmark for @uri cannot be found then it is created.

func (*BookmarkFile) SetGroups 

func (x *BookmarkFile) SetGroups(UriVar string, GroupsVar []string, LengthVar uint)

Sets a list of group names for the item with URI @uri. Each previously set group name list is removed.

If @uri cannot be found then an item for it is created.

func (*BookmarkFile) SetIcon 

func (x *BookmarkFile) SetIcon(UriVar string, HrefVar *string, MimeTypeVar string)

Sets the icon for the bookmark for @uri. If @href is %NULL, unsets the currently set icon. @href can either be a full URL for the icon file or the icon name following the Icon Naming specification.

If no bookmark for @uri is found one is created.

func (*BookmarkFile) SetIsPrivate 

func (x *BookmarkFile) SetIsPrivate(UriVar string, IsPrivateVar bool)

Sets the private flag of the bookmark for @uri.

If a bookmark for @uri cannot be found then it is created.

func (*BookmarkFile) SetMimeType 

func (x *BookmarkFile) SetMimeType(UriVar string, MimeTypeVar string)

Sets @mime_type as the MIME type of the bookmark for @uri.

If a bookmark for @uri cannot be found then it is created.

func (*BookmarkFile) SetModified 

func (x *BookmarkFile) SetModified(UriVar string, ModifiedVar int)

Sets the last time the bookmark for @uri was last modified.

If no bookmark for @uri is found then it is created.

The "modified" time should only be set when the bookmark's meta-data was actually changed. Every function of #GBookmarkFile that modifies a bookmark also changes the modification time, except for g_bookmark_file_set_visited_date_time().

func (*BookmarkFile) SetModifiedDateTime 

func (x *BookmarkFile) SetModifiedDateTime(UriVar string, ModifiedVar *DateTime)

Sets the last time the bookmark for @uri was last modified.

If no bookmark for @uri is found then it is created.

The "modified" time should only be set when the bookmark's meta-data was actually changed. Every function of #GBookmarkFile that modifies a bookmark also changes the modification time, except for g_bookmark_file_set_visited_date_time().

func (*BookmarkFile) SetTitle 

func (x *BookmarkFile) SetTitle(UriVar *string, TitleVar string)

Sets @title as the title of the bookmark for @uri inside the bookmark file @bookmark.

If @uri is %NULL, the title of @bookmark is set.

If a bookmark for @uri cannot be found then it is created.

func (*BookmarkFile) SetVisited 

func (x *BookmarkFile) SetVisited(UriVar string, VisitedVar int)

Sets the time the bookmark for @uri was last visited.

If no bookmark for @uri is found then it is created.

The "visited" time should only be set if the bookmark was launched, either using the command line retrieved by g_bookmark_file_get_application_info() or by the default application for the bookmark's MIME type, retrieved using g_bookmark_file_get_mime_type(). Changing the "visited" time does not affect the "modified" time.

func (*BookmarkFile) SetVisitedDateTime 

func (x *BookmarkFile) SetVisitedDateTime(UriVar string, VisitedVar *DateTime)

Sets the time the bookmark for @uri was last visited.

If no bookmark for @uri is found then it is created.

The "visited" time should only be set if the bookmark was launched, either using the command line retrieved by g_bookmark_file_get_application_info() or by the default application for the bookmark's MIME type, retrieved using g_bookmark_file_get_mime_type(). Changing the "visited" time does not affect the "modified" time.

func (*BookmarkFile) ToData 

func (x *BookmarkFile) ToData(LengthVar *uint) (uintptr, error)

This function outputs @bookmark as a string.

func (*BookmarkFile) ToFile 

func (x *BookmarkFile) ToFile(FilenameVar string) (bool, error)

This function outputs @bookmark into a file. The write process is guaranteed to be atomic by using g_file_set_contents() internally.

type BookmarkFileError 

type BookmarkFileError int

Error codes returned by bookmark file parsing. 

const (

	// URI was ill-formed
	GBookmarkFileErrorInvalidUriValue BookmarkFileError = 0
	// a requested field was not found
	GBookmarkFileErrorInvalidValueValue BookmarkFileError = 1
	// a requested application did
	//     not register a bookmark
	GBookmarkFileErrorAppNotRegisteredValue BookmarkFileError = 2
	// a requested URI was not found
	GBookmarkFileErrorUriNotFoundValue BookmarkFileError = 3
	// document was ill formed
	GBookmarkFileErrorReadValue BookmarkFileError = 4
	// the text being parsed was
	//     in an unknown encoding
	GBookmarkFileErrorUnknownEncodingValue BookmarkFileError = 5
	// an error occurred while writing
	GBookmarkFileErrorWriteValue BookmarkFileError = 6
	// requested file was not found
	GBookmarkFileErrorFileNotFoundValue BookmarkFileError = 7
)

type ByteArray 

type ByteArray struct {
	Data byte

	Len uint
	// contains filtered or unexported fields
}

Contains the public fields of a `GByteArray`.

func (*ByteArray) GoPointer 

func (x *ByteArray) GoPointer() uintptr

type Bytes 

type Bytes struct {
	// contains filtered or unexported fields
}

A simple reference counted data type representing an immutable sequence of zero or more bytes from an unspecified origin.

The purpose of a `GBytes` is to keep the memory region that it holds alive for as long as anyone holds a reference to the bytes. When the last reference count is dropped, the memory is released. Multiple unrelated callers can use byte data in the `GBytes` without coordinating their activities, resting assured that the byte data will not change or move while they hold a reference.

A `GBytes` can come from many different origins that may have different procedures for freeing the memory region. Examples are memory from [func@GLib.malloc], from memory slices, from a [struct@GLib.MappedFile] or memory from other allocators.

`GBytes` work well as keys in [struct@GLib.HashTable]. Use [method@GLib.Bytes.equal] and [method@GLib.Bytes.hash] as parameters to [func@GLib.HashTable.new] or [func@GLib.HashTable.new_full]. `GBytes` can also be used as keys in a [struct@GLib.Tree] by passing the [method@GLib.Bytes.compare] function to [ctor@GLib.Tree.new].

The data pointed to by this bytes must not be modified. For a mutable array of bytes see [struct@GLib.ByteArray]. Use [method@GLib.Bytes.unref_to_array] to create a mutable array for a `GBytes` sequence. To create an immutable `GBytes` from a mutable [struct@GLib.ByteArray], use the [func@GLib.ByteArray.free_to_bytes] function.

func ByteArrayFreeToBytes 

func ByteArrayFreeToBytes(ArrayVar []byte) *Bytes

Transfers the data from the `GByteArray` into a new immutable [struct@GLib.Bytes].

The `GByteArray` is freed unless the reference count of @array is greater than one, in which the `GByteArray` wrapper is preserved but the size of @array will be set to zero.

This is identical to using [ctor@GLib.Bytes.new_take] and [func@GLib.ByteArray.free] together.

func NewBytes 

func NewBytes(DataVar []byte, SizeVar uint) *Bytes

Creates a new [struct@GLib.Bytes] from @data.

@data is copied. If @size is 0, @data may be `NULL`.

As an optimization, [ctor@GLib.Bytes.new] may avoid an extra allocation by copying the data within the resulting bytes structure if sufficiently small (since GLib 2.84).

func NewBytesFromBytes added in v0.5.0 

func NewBytesFromBytes(BytesVar *Bytes, OffsetVar uint, LengthVar uint) *Bytes

Creates a [struct@GLib.Bytes] which is a subsection of another `GBytes`.

The @offset + @length may not be longer than the size of @bytes.

A reference to @bytes will be held by the newly created `GBytes` until the byte data is no longer needed.

Since 2.56, if @offset is 0 and @length matches the size of @bytes, then @bytes will be returned with the reference count incremented by 1. If @bytes is a slice of another `GBytes`, then the resulting `GBytes` will reference the same `GBytes` instead of @bytes. This allows consumers to simplify the usage of `GBytes` when asynchronously writing to streams.

func NewBytesStatic 

func NewBytesStatic(DataVar []byte, SizeVar uint) *Bytes

Creates a new [struct@GLib.Bytes] from static data.

@data must be static (ie: never modified or freed). It may be `NULL` if @size is 0.

func NewBytesTake 

func NewBytesTake(DataVar uintptr, SizeVar uint) *Bytes

Creates a new [struct@GLib.Bytes] from @data.

After this call, @data belongs to the `GBytes` and may no longer be modified by the caller. The memory of @data has to be dynamically allocated and will eventually be freed with [func@GLib.free].

For creating `GBytes` with memory from other allocators, see [ctor@GLib.Bytes.new_with_free_func].

@data may be `NULL` if @size is 0.

func NewBytesWithFreeFunc 

func NewBytesWithFreeFunc(DataVar []byte, SizeVar uint, FreeFuncVar *DestroyNotify, UserDataVar uintptr) *Bytes

Creates a [struct@GLib.Bytes] from @data.

When the last reference is dropped, @free_func will be called with the @user_data argument.

@data must not be modified after this call is made until @free_func has been called to indicate that the bytes is no longer in use.

@data may be `NULL` if @size is 0.

func UriUnescapeBytes 

func UriUnescapeBytes(EscapedStringVar string, LengthVar int, IllegalCharactersVar *string) (*Bytes, error)

Unescapes a segment of an escaped string as binary data.

Note that in contrast to g_uri_unescape_string(), this does allow nul bytes to appear in the output.

If any of the characters in @illegal_characters appears as an escaped character in @escaped_string, then that is an error and %NULL will be returned. This is useful if you want to avoid for instance having a slash being expanded in an escaped path element, which might confuse pathname handling.

func (*Bytes) Compare 

func (x *Bytes) Compare(Bytes2Var uintptr) int

Compares the two [struct@GLib.Bytes] values.

This function can be used to sort `GBytes` instances in lexicographical order.

If @bytes1 and @bytes2 have different length but the shorter one is a prefix of the longer one then the shorter one is considered to be less than the longer one. Otherwise the first byte where both differ is used for comparison. If @bytes1 has a smaller value at that position it is considered less, otherwise greater than @bytes2.

func (*Bytes) Equal 

func (x *Bytes) Equal(Bytes2Var uintptr) bool

Compares the two [struct@GLib.Bytes] values being pointed to and returns `TRUE` if they are equal.

This function can be passed to [func@GLib.HashTable.new] as the @key_equal_func parameter, when using non-`NULL` `GBytes` pointers as keys in a [struct@GLib.HashTable].

func (*Bytes) GetData 

func (x *Bytes) GetData(SizeVar *uint) uintptr

Get the byte data in the [struct@GLib.Bytes].

This data should not be modified.

This function will always return the same pointer for a given `GBytes`.

`NULL` may be returned if @size is 0. This is not guaranteed, as the `GBytes` may represent an empty string with @data non-`NULL` and @size as 0. `NULL` will not be returned if @size is non-zero.

func (*Bytes) GetRegion 

func (x *Bytes) GetRegion(ElementSizeVar uint, OffsetVar uint, NElementsVar uint) uintptr

Gets a pointer to a region in @bytes.

The region starts at @offset many bytes from the start of the data and contains @n_elements many elements of @element_size size.

@n_elements may be zero, but @element_size must always be non-zero. Ideally, @element_size is a static constant (eg: `sizeof` a struct).

This function does careful bounds checking (including checking for arithmetic overflows) and returns a non-`NULL` pointer if the specified region lies entirely within the @bytes. If the region is in some way out of range, or if an overflow has occurred, then `NULL` is returned.

Note: it is possible to have a valid zero-size region. In this case, the returned pointer will be equal to the base pointer of the data of @bytes, plus @offset. This will be non-`NULL` except for the case where @bytes itself was a zero-sized region. Since it is unlikely that you will be using this function to check for a zero-sized region in a zero-sized @bytes, `NULL` effectively always means ‘error’.

func (*Bytes) GetSize 

func (x *Bytes) GetSize() uint

Get the size of the byte data in the [struct@GLib.Bytes].

This function will always return the same value for a given `GBytes`.

func (*Bytes) GoPointer 

func (x *Bytes) GoPointer() uintptr

func (*Bytes) Hash 

func (x *Bytes) Hash() uint

Creates an integer hash code for the byte data in the [struct@GLib.Bytes].

This function can be passed to [func@GLib.HashTable.new] as the @key_hash_func parameter, when using non-`NULL` `GBytes` pointers as keys in a [struct@GLib.HashTable].

func (*Bytes) Ref 

func (x *Bytes) Ref() *Bytes

Increase the reference count on @bytes.

func (*Bytes) Unref 

func (x *Bytes) Unref()

Releases a reference on @bytes.

This may result in the bytes being freed. If @bytes is `NULL`, it will return immediately.

func (*Bytes) UnrefToArray 

func (x *Bytes) UnrefToArray() uintptr

Unreferences the bytes, and returns a new mutable [struct@GLib.ByteArray] containing the same byte data.

As an optimization, the byte data is transferred to the array without copying if this was the last reference to @bytes and @bytes was created with [ctor@GLib.Bytes.new], [ctor@GLib.Bytes.new_take] or [func@GLib.ByteArray.free_to_bytes] and the buffer was larger than the size [struct@GLib.Bytes] may internalize within its allocation. In all other cases the data is copied.

Do not use it if @bytes contains more than %G_MAXUINT bytes. [struct@GLib.ByteArray] stores the length of its data in `guint`, which may be shorter than `gsize`, that @bytes is using.

func (*Bytes) UnrefToData 

func (x *Bytes) UnrefToData(SizeVar *uint) uintptr

Unreferences the bytes, and returns a pointer the same byte data contents.

As an optimization, the byte data is returned without copying if this was the last reference to @bytes and @bytes was created with [ctor@GLib.Bytes.new], [ctor@GLib.Bytes.new_take] or [func@GLib.ByteArray.free_to_bytes] and the buffer was larger than the size [struct@GLib.Bytes] may internalize within its allocation. In all other cases the data is copied.

type Cache 

type Cache struct {
	// contains filtered or unexported fields
}

A `GCache` allows sharing of complex data structures, in order to save system resources.

`GCache` uses keys and values. A `GCache` key describes the properties of a particular resource. A `GCache` value is the actual resource.

`GCache` has been marked as deprecated, since this API is rarely used and not very actively maintained.

func (*Cache) Destroy 

func (x *Cache) Destroy()

Frees the memory allocated for the #GCache.

Note that it does not destroy the keys and values which were contained in the #GCache.

func (*Cache) GoPointer 

func (x *Cache) GoPointer() uintptr

func (*Cache) Insert 

func (x *Cache) Insert(KeyVar uintptr) uintptr

Gets the value corresponding to the given key, creating it if necessary. It first checks if the value already exists in the #GCache, by using the @key_equal_func function passed to g_cache_new(). If it does already exist it is returned, and its reference count is increased by one. If the value does not currently exist, if is created by calling the @value_new_func. The key is duplicated by calling @key_dup_func and the duplicated key and value are inserted into the #GCache.

func (*Cache) KeyForeach 

func (x *Cache) KeyForeach(FuncVar *HFunc, UserDataVar uintptr)

Calls the given function for each of the keys in the #GCache.

NOTE @func is passed three parameters, the value and key of a cache entry and the @user_data. The order of value and key is different from the order in which g_hash_table_foreach() passes key-value pairs to its callback function !

func (*Cache) Remove 

func (x *Cache) Remove(ValueVar uintptr)

Decreases the reference count of the given value. If it drops to 0 then the value and its corresponding key are destroyed, using the @value_destroy_func and @key_destroy_func passed to g_cache_new().

func (*Cache) ValueForeach 

func (x *Cache) ValueForeach(FuncVar *HFunc, UserDataVar uintptr)

Calls the given function for each of the values in the #GCache.

type CacheDestroyFunc 

type CacheDestroyFunc func(uintptr)

Specifies the type of the @value_destroy_func and @key_destroy_func functions passed to g_cache_new(). The functions are passed a pointer to the #GCache key or #GCache value and should free any memory and other resources associated with it.

type CacheDupFunc 

type CacheDupFunc func(uintptr) uintptr

Specifies the type of the @key_dup_func function passed to g_cache_new(). The function is passed a key (__not__ a value as the prototype implies) and should return a duplicate of the key.

type CacheNewFunc 

type CacheNewFunc func(uintptr) uintptr

Specifies the type of the @value_new_func function passed to g_cache_new(). It is passed a #GCache key and should create the value corresponding to the key.

type Checksum 

type Checksum struct {
	// contains filtered or unexported fields
}

GLib provides a generic API for computing checksums (or ‘digests’) for a sequence of arbitrary bytes, using various hashing algorithms like MD5, SHA-1 and SHA-256. Checksums are commonly used in various environments and specifications.

To create a new `GChecksum`, use [ctor@GLib.Checksum.new]. To free a `GChecksum`, use [method@GLib.Checksum.free].

GLib supports incremental checksums using the `GChecksum` data structure, by calling [method@GLib.Checksum.update] as long as there’s data available and then using [method@GLib.Checksum.get_string] or [method@GLib.Checksum.get_digest] to compute the checksum and return it either as a string in hexadecimal form, or as a raw sequence of bytes. To compute the checksum for binary blobs and nul-terminated strings in one go, use the convenience functions [func@GLib.compute_checksum_for_data] and [func@GLib.compute_checksum_for_string], respectively.

func NewChecksum 

func NewChecksum(ChecksumTypeVar ChecksumType) *Checksum

Creates a new #GChecksum, using the checksum algorithm @checksum_type. If the @checksum_type is not known, %NULL is returned. A #GChecksum can be used to compute the checksum, or digest, of an arbitrary binary blob, using different hashing algorithms.

A #GChecksum works by feeding a binary blob through g_checksum_update() until there is data to be checked; the digest can then be extracted using g_checksum_get_string(), which will return the checksum as a hexadecimal string; or g_checksum_get_digest(), which will return a vector of raw bytes. Once either g_checksum_get_string() or g_checksum_get_digest() have been called on a #GChecksum, the checksum will be closed and it won't be possible to call g_checksum_update() on it anymore.

func (*Checksum) Copy 

func (x *Checksum) Copy() *Checksum

Copies a #GChecksum. If @checksum has been closed, by calling g_checksum_get_string() or g_checksum_get_digest(), the copied checksum will be closed as well.

func (*Checksum) Free 

func (x *Checksum) Free()

Frees the memory allocated for @checksum.

func (*Checksum) GetDigest 

func (x *Checksum) GetDigest(BufferVar []byte, DigestLenVar *uint)

Gets the digest from @checksum as a raw binary vector and places it into @buffer. The size of the digest depends on the type of checksum.

Once this function has been called, the #GChecksum is closed and can no longer be updated with g_checksum_update().

func (*Checksum) GetString 

func (x *Checksum) GetString() string

Gets the digest as a hexadecimal string.

Once this function has been called the #GChecksum can no longer be updated with g_checksum_update().

The hexadecimal characters will be lower case.

func (*Checksum) GoPointer 

func (x *Checksum) GoPointer() uintptr

func (*Checksum) Reset 

func (x *Checksum) Reset()

Resets the state of the @checksum back to its initial state.

func (*Checksum) Update 

func (x *Checksum) Update(DataVar []byte, LengthVar int)

Feeds @data into an existing #GChecksum. The checksum must still be open, that is g_checksum_get_string() or g_checksum_get_digest() must not have been called on @checksum.

type ChecksumType 

type ChecksumType int

The hashing algorithm to be used by #GChecksum when performing the digest of some data.

Note that the #GChecksumType enumeration may be extended at a later date to include new hashing algorithm types. 

const (

	// Use the MD5 hashing algorithm
	GChecksumMd5Value ChecksumType = 0
	// Use the SHA-1 hashing algorithm
	GChecksumSha1Value ChecksumType = 1
	// Use the SHA-256 hashing algorithm
	GChecksumSha256Value ChecksumType = 2
	// Use the SHA-512 hashing algorithm (Since: 2.36)
	GChecksumSha512Value ChecksumType = 3
	// Use the SHA-384 hashing algorithm (Since: 2.51)
	GChecksumSha384Value ChecksumType = 4
)

type ChildWatchFunc 

type ChildWatchFunc func(Pid, int, uintptr)

Prototype of a #GChildWatchSource callback, called when a child process has exited.

To interpret @wait_status, see the documentation for [func@GLib.spawn_check_wait_status]. In particular, on Unix platforms, note that it is usually not equal to the integer passed to `exit()` or returned from `main()`.

type ClearHandleFunc 

type ClearHandleFunc func(uint)

Specifies the type of function passed to [func@GLib.clear_handle_id] The implementation is expected to free the resource identified by @handle_id; for instance, if @handle_id is a [struct@GLib.Source] ID, [func@GLib.Source.remove] can be used.

type CompareDataFunc 

type CompareDataFunc func(uintptr, uintptr, uintptr) int

Specifies the type of a comparison function used to compare two values. The function should return a negative integer if the first value comes before the second, 0 if they are equal, or a positive integer if the first value comes after the second.

type CompareFunc 

type CompareFunc func(uintptr, uintptr) int

Specifies the type of a comparison function used to compare two values. The function should return a negative integer if the first value comes before the second, 0 if they are equal, or a positive integer if the first value comes after the second.

type Completion 

type Completion struct {
	Items *List

	Func CompletionFunc

	Prefix uintptr

	Cache *List

	StrncmpFunc CompletionStrncmpFunc
	// contains filtered or unexported fields
}

`GCompletion` provides support for automatic completion of a string using any group of target strings. It is typically used for file name completion as is common in many UNIX shells.

A `GCompletion` is created using [func@GLib.Completion.new]. Target items are added and removed with [method@GLib.Completion.add_items], [method@GLib.Completion.remove_items] and [method@GLib.Completion.clear_items]. A completion attempt is requested with [method@GLib.Completion.complete] or [method@GLib.Completion.complete_utf8]. When no longer needed, the `GCompletion` is freed with [method@GLib.Completion.free].

Items in the completion can be simple strings (e.g. filenames), or pointers to arbitrary data structures. If data structures are used you must provide a [type@GLib.CompletionFunc] in [func@GLib.Completion.new], which retrieves the item’s string from the data structure. You can change the way in which strings are compared by setting a different [type@GLib.CompletionStrncmpFunc] in [method@GLib.Completion.set_compare].

`GCompletion` has been marked as deprecated, since this API is rarely used and not very actively maintained.

func (*Completion) AddItems 

func (x *Completion) AddItems(ItemsVar *List)

Adds items to the #GCompletion.

func (*Completion) ClearItems 

func (x *Completion) ClearItems()

Removes all items from the #GCompletion. The items are not freed, so if the memory was dynamically allocated, it should be freed after calling this function.

func (*Completion) Complete 

func (x *Completion) Complete(PrefixVar string, NewPrefixVar string) *List

Attempts to complete the string @prefix using the #GCompletion target items.

func (*Completion) CompleteUtf8 

func (x *Completion) CompleteUtf8(PrefixVar string, NewPrefixVar string) *List

Attempts to complete the string @prefix using the #GCompletion target items. In contrast to g_completion_complete(), this function returns the largest common prefix that is a valid UTF-8 string, omitting a possible common partial character.

You should use this function instead of g_completion_complete() if your items are UTF-8 strings.

func (*Completion) Free 

func (x *Completion) Free()

Frees all memory used by the #GCompletion. The items are not freed, so if the memory was dynamically allocated, it should be freed after calling this function.

func (*Completion) GoPointer 

func (x *Completion) GoPointer() uintptr

func (*Completion) RemoveItems 

func (x *Completion) RemoveItems(ItemsVar *List)

Removes items from a #GCompletion. The items are not freed, so if the memory was dynamically allocated, free @items with g_list_free_full() after calling this function.

func (*Completion) SetCompare 

func (x *Completion) SetCompare(StrncmpFuncVar *CompletionStrncmpFunc)

Sets the function to use for string comparisons. The default string comparison function is strncmp().

type CompletionFunc 

type CompletionFunc func(uintptr) string

Specifies the type of the function passed to g_completion_new(). It should return the string corresponding to the given target item. This is used when you use data structures as #GCompletion items.

type CompletionStrncmpFunc 

type CompletionStrncmpFunc func(string, string, uint) int

Specifies the type of the function passed to g_completion_set_compare(). This is used when you use strings as #GCompletion items.

type Cond 

type Cond struct {
	P uintptr

	I [2]uint
	// contains filtered or unexported fields
}

The #GCond struct is an opaque data structure that represents a condition. Threads can block on a #GCond if they find a certain condition to be false. If other threads change the state of this condition they signal the #GCond, and that causes the waiting threads to be woken up.

Consider the following example of a shared variable. One or more threads can wait for data to be published to the variable and when another thread publishes the data, it can signal one of the waiting threads to wake up to collect the data.

Here is an example for using GCond to block a thread until a condition is satisfied: |[&lt;!-- language="C" --&gt; 

gpointer current_data = NULL;
GMutex data_mutex;
GCond data_cond;

void
push_data (gpointer data)
{
  g_mutex_lock (&amp;data_mutex);
  current_data = data;
  g_cond_signal (&amp;data_cond);
  g_mutex_unlock (&amp;data_mutex);
}

gpointer
pop_data (void)
{
  gpointer data;

  g_mutex_lock (&amp;data_mutex);
  while (!current_data)
    g_cond_wait (&amp;data_cond, &amp;data_mutex);
  data = current_data;
  current_data = NULL;
  g_mutex_unlock (&amp;data_mutex);

  return data;
}

]| Whenever a thread calls pop_data() now, it will wait until current_data is non-%NULL, i.e. until some other thread has called push_data().

The example shows that use of a condition variable must always be paired with a mutex. Without the use of a mutex, there would be a race between the check of @current_data by the while loop in pop_data() and waiting. Specifically, another thread could set @current_data after the check, and signal the cond (with nobody waiting on it) before the first thread goes to sleep. #GCond is specifically useful for its ability to release the mutex and go to sleep atomically.

It is also important to use the g_cond_wait() and g_cond_wait_until() functions only inside a loop which checks for the condition to be true. See g_cond_wait() for an explanation of why the condition may not be true even after it returns.

If a #GCond is allocated in static storage then it can be used without initialisation. Otherwise, you should call g_cond_init() on it and g_cond_clear() when done.

A #GCond should only be accessed via the g_cond_ functions.

func CondNew 

func CondNew() *Cond

Allocates and initializes a new #GCond.

func (*Cond) Broadcast 

func (x *Cond) Broadcast()

If threads are waiting for @cond, all of them are unblocked. If no threads are waiting for @cond, this function has no effect. It is good practice to lock the same mutex as the waiting threads while calling this function, though not required.

func (*Cond) Clear 

func (x *Cond) Clear()

Frees the resources allocated to a #GCond with g_cond_init().

This function should not be used with a #GCond that has been statically allocated.

Calling g_cond_clear() for a #GCond on which threads are blocking leads to undefined behaviour.

func (*Cond) Free 

func (x *Cond) Free()

Destroys a #GCond that has been created with g_cond_new().

Calling g_cond_free() for a #GCond on which threads are blocking leads to undefined behaviour.

func (*Cond) GoPointer 

func (x *Cond) GoPointer() uintptr

func (*Cond) Init 

func (x *Cond) Init()

Initialises a #GCond so that it can be used.

This function is useful to initialise a #GCond that has been allocated as part of a larger structure. It is not necessary to initialise a #GCond that has been statically allocated.

To undo the effect of g_cond_init() when a #GCond is no longer needed, use g_cond_clear().

Calling g_cond_init() on an already-initialised #GCond leads to undefined behaviour.

func (*Cond) Signal 

func (x *Cond) Signal()

If threads are waiting for @cond, at least one of them is unblocked. If no threads are waiting for @cond, this function has no effect. It is good practice to hold the same lock as the waiting thread while calling this function, though not required.

func (*Cond) TimedWait 

func (x *Cond) TimedWait(MutexVar *Mutex, AbsTimeVar *TimeVal) bool

Waits until this thread is woken up on @cond, but not longer than until the time specified by @abs_time. The @mutex is unlocked before falling asleep and locked again before resuming.

If @abs_time is %NULL, g_cond_timed_wait() acts like g_cond_wait().

This function can be used even if g_thread_init() has not yet been called, and, in that case, will immediately return %TRUE.

To easily calculate @abs_time a combination of g_get_real_time() and g_time_val_add() can be used.

func (*Cond) Wait 

func (x *Cond) Wait(MutexVar *Mutex)

Atomically releases @mutex and waits until @cond is signalled. When this function returns, @mutex is locked again and owned by the calling thread.

When using condition variables, it is possible that a spurious wakeup may occur (ie: g_cond_wait() returns even though g_cond_signal() was not called). It's also possible that a stolen wakeup may occur. This is when g_cond_signal() is called, but another thread acquires @mutex before this thread and modifies the state of the program in such a way that when g_cond_wait() is able to return, the expected condition is no longer met.

For this reason, g_cond_wait() must always be used in a loop. See the documentation for #GCond for a complete example.

func (*Cond) WaitUntil 

func (x *Cond) WaitUntil(MutexVar *Mutex, EndTimeVar int64) bool

Waits until either @cond is signalled or @end_time has passed.

As with g_cond_wait() it is possible that a spurious or stolen wakeup could occur. For that reason, waiting on a condition variable should always be in a loop, based on an explicitly-checked predicate.

%TRUE is returned if the condition variable was signalled (or in the case of a spurious wakeup). %FALSE is returned if @end_time has passed.

The following code shows how to correctly perform a timed wait on a condition variable (extending the example presented in the documentation for #GCond):

|[&lt;!-- language="C" --&gt; gpointer pop_data_timed (void) 

{
  gint64 end_time;
  gpointer data;

  g_mutex_lock (&amp;data_mutex);

  end_time = g_get_monotonic_time () + 5 * G_TIME_SPAN_SECOND;
  while (!current_data)
    if (!g_cond_wait_until (&amp;data_cond, &amp;data_mutex, end_time))
      {
        // timeout has passed.
        g_mutex_unlock (&amp;data_mutex);
        return NULL;
      }

  // there is data for us
  data = current_data;
  current_data = NULL;

  g_mutex_unlock (&amp;data_mutex);

  return data;
}

]|

Notice that the end time is calculated once, before entering the loop and reused. This is the motivation behind the use of absolute time on this API -- if a relative time of 5 seconds were passed directly to the call and a spurious wakeup occurred, the program would have to start over waiting again (which would lead to a total wait time of more than 5 seconds).

type ConvertError 

type ConvertError int

Error codes returned by character set conversion routines. 

const (

	// Conversion between the requested character
	//     sets is not supported.
	GConvertErrorNoConversionValue ConvertError = 0
	// Invalid byte sequence in conversion input;
	//    or the character sequence could not be represented in the target
	//    character set.
	GConvertErrorIllegalSequenceValue ConvertError = 1
	// Conversion failed for some reason.
	GConvertErrorFailedValue ConvertError = 2
	// Partial character sequence at end of input.
	GConvertErrorPartialInputValue ConvertError = 3
	// URI is invalid.
	GConvertErrorBadUriValue ConvertError = 4
	// Pathname is not an absolute path.
	GConvertErrorNotAbsolutePathValue ConvertError = 5
	// No memory available. Since: 2.40
	GConvertErrorNoMemoryValue ConvertError = 6
	// An embedded NUL character is present in
	//     conversion output where a NUL-terminated string is expected.
	//     Since: 2.56
	GConvertErrorEmbeddedNulValue ConvertError = 7
)

type CopyFunc 

type CopyFunc func(uintptr, uintptr) uintptr

A function of this signature is used to copy the node data when doing a deep-copy of a tree.

type Data 

type Data struct {
	// contains filtered or unexported fields
}

An opaque data structure that represents a keyed data list.

See also: [Keyed data lists](datalist-and-dataset.html).

func (*Data) GoPointer 

func (x *Data) GoPointer() uintptr

type DataForeachFunc 

type DataForeachFunc func(Quark, uintptr, uintptr)

Specifies the type of function passed to g_dataset_foreach(). It is called with each #GQuark id and associated data element, together with the @user_data parameter supplied to g_dataset_foreach().

type Date 

type Date struct {
	JulianDays uint

	Julian uint

	Dmy uint

	Day uint

	Month uint

	Year uint
	// contains filtered or unexported fields
}

`GDate` is a struct for calendrical calculations.

The `GDate` data structure represents a day between January 1, Year 1, and sometime a few thousand years in the future (right now it will go to the year 65535 or so, but [method@GLib.Date.set_parse] only parses up to the year 8000 or so - just count on "a few thousand"). `GDate` is meant to represent everyday dates, not astronomical dates or historical dates or ISO timestamps or the like. It extrapolates the current Gregorian calendar forward and backward in time; there is no attempt to change the calendar to match time periods or locations. `GDate` does not store time information; it represents a day.

The `GDate` implementation has several nice features; it is only a 64-bit struct, so storing large numbers of dates is very efficient. It can keep both a Julian and day-month-year representation of the date, since some calculations are much easier with one representation or the other. A Julian representation is simply a count of days since some fixed day in the past; for #GDate the fixed day is January 1, 1 AD. ("Julian" dates in the #GDate API aren't really Julian dates in the technical sense; technically, Julian dates count from the start of the Julian period, Jan 1, 4713 BC).

`GDate` is simple to use. First you need a "blank" date; you can get a dynamically allocated date from [ctor@GLib.Date.new], or you can declare an automatic variable or array and initialize it by calling [method@GLib.Date.clear]. A cleared date is safe; it's safe to call [method@GLib.Date.set_dmy] and the other mutator functions to initialize the value of a cleared date. However, a cleared date is initially invalid, meaning that it doesn't represent a day that exists. It is undefined to call any of the date calculation routines on an invalid date. If you obtain a date from a user or other unpredictable source, you should check its validity with the [method@GLib.Date.valid] predicate. [method@GLib.Date.valid] is also used to check for errors with [method@GLib.Date.set_parse] and other functions that can fail. Dates can be invalidated by calling [method@GLib.Date.clear] again.

It is very important to use the API to access the `GDate` struct. Often only the day-month-year or only the Julian representation is valid. Sometimes neither is valid. Use the API.

GLib also features `GDateTime` which represents a precise time.

func NewDate 

func NewDate() *Date

Allocates a #GDate and initializes it to a safe state. The new date will be cleared (as if you'd called g_date_clear()) but invalid (it won't represent an existing day). Free the return value with g_date_free().

func NewDateDmy 

func NewDateDmy(DayVar DateDay, MonthVar DateMonth, YearVar DateYear) *Date

Create a new #GDate representing the given day-month-year triplet.

The triplet you pass in must represent a valid date. Use g_date_valid_dmy() if needed to validate it. The returned #GDate is guaranteed to be non-%NULL and valid.

func NewDateJulian 

func NewDateJulian(JulianDayVar uint32) *Date

Create a new #GDate representing the given Julian date.

The @julian_day you pass in must be valid. Use g_date_valid_julian() if needed to validate it. The returned #GDate is guaranteed to be non-%NULL and valid.

func (*Date) AddDays 

func (x *Date) AddDays(NDaysVar uint)

Increments a date some number of days. To move forward by weeks, add weeks*7 days. The date must be valid.

func (*Date) AddMonths 

func (x *Date) AddMonths(NMonthsVar uint)

Increments a date by some number of months. If the day of the month is greater than 28, this routine may change the day of the month (because the destination month may not have the current day in it). The date must be valid.

func (*Date) AddYears 

func (x *Date) AddYears(NYearsVar uint)

Increments a date by some number of years. If the date is February 29, and the destination year is not a leap year, the date will be changed to February 28. The date must be valid.

func (*Date) Clamp 

func (x *Date) Clamp(MinDateVar *Date, MaxDateVar *Date)

If @date is prior to @min_date, sets @date equal to @min_date. If @date falls after @max_date, sets @date equal to @max_date. Otherwise, @date is unchanged. Either of @min_date and @max_date may be %NULL. All non-%NULL dates must be valid.

func (*Date) Clear 

func (x *Date) Clear(NDatesVar uint)

Initializes one or more #GDate structs to a safe but invalid state. The cleared dates will not represent an existing date, but will not contain garbage. Useful to init a date declared on the stack. Validity can be tested with g_date_valid().

func (*Date) Compare 

func (x *Date) Compare(RhsVar *Date) int

qsort()-style comparison function for dates. Both dates must be valid.

func (*Date) Copy 

func (x *Date) Copy() *Date

Copies a GDate to a newly-allocated GDate. If the input was invalid (as determined by g_date_valid()), the invalid state will be copied as is into the new object.

func (*Date) DaysBetween 

func (x *Date) DaysBetween(Date2Var *Date) int

Computes the number of days between two dates. If @date2 is prior to @date1, the returned value is negative. Both dates must be valid.

func (*Date) Free 

func (x *Date) Free()

Frees a #GDate returned from g_date_new().

func (*Date) GetDay 

func (x *Date) GetDay() DateDay

Returns the day of the month. The date must be valid.

func (*Date) GetDayOfYear 

func (x *Date) GetDayOfYear() uint

Returns the day of the year, where Jan 1 is the first day of the year. The date must be valid.

func (*Date) GetIso8601WeekOfYear 

func (x *Date) GetIso8601WeekOfYear() uint

Returns the week of the year, where weeks are interpreted according to ISO 8601.

func (*Date) GetJulian 

func (x *Date) GetJulian() uint32

Returns the Julian day or "serial number" of the #GDate. The Julian day is simply the number of days since January 1, Year 1; i.e., January 1, Year 1 is Julian day 1; January 2, Year 1 is Julian day 2, etc. The date must be valid.

func (*Date) GetMondayWeekOfYear 

func (x *Date) GetMondayWeekOfYear() uint

Returns the week of the year, where weeks are understood to start on Monday. If the date is before the first Monday of the year, return 0. The date must be valid.

func (*Date) GetMonth 

func (x *Date) GetMonth() DateMonth

Returns the month of the year. The date must be valid.

func (*Date) GetSundayWeekOfYear 

func (x *Date) GetSundayWeekOfYear() uint

Returns the week of the year during which this date falls, if weeks are understood to begin on Sunday. The date must be valid. Can return 0 if the day is before the first Sunday of the year.

func (*Date) GetWeekOfYear 

func (x *Date) GetWeekOfYear(FirstDayOfWeekVar DateWeekday) uint

Calculates the week of the year during which this date falls.

The result depends on which day is considered the first day of the week, which varies by locale. Both `date` and `first_day_of_week` must be valid.

If @date is before the start of the first week of the year (for example, before the first Monday in January if @first_day_of_week is [enum@GLib.DateWeekday.MONDAY]) then zero will be returned.

func (*Date) GetWeekday 

func (x *Date) GetWeekday() DateWeekday

Returns the day of the week for a #GDate. The date must be valid.

func (*Date) GetYear 

func (x *Date) GetYear() DateYear

Returns the year of a #GDate. The date must be valid.

func (*Date) GoPointer 

func (x *Date) GoPointer() uintptr

func (*Date) IsFirstOfMonth 

func (x *Date) IsFirstOfMonth() bool

Returns %TRUE if the date is on the first of a month. The date must be valid.

func (*Date) IsLastOfMonth 

func (x *Date) IsLastOfMonth() bool

Returns %TRUE if the date is the last day of the month. The date must be valid.

func (*Date) Order 

func (x *Date) Order(Date2Var *Date)

Checks if @date1 is less than or equal to @date2, and swap the values if this is not the case.

func (*Date) SetDay 

func (x *Date) SetDay(DayVar DateDay)

Sets the day of the month for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

func (*Date) SetDmy 

func (x *Date) SetDmy(DayVar DateDay, MonthVar DateMonth, YVar DateYear)

Sets the value of a #GDate from a day, month, and year. The day-month-year triplet must be valid; if you aren't sure it is, call g_date_valid_dmy() to check before you set it.

func (*Date) SetJulian 

func (x *Date) SetJulian(JulianDateVar uint32)

Sets the value of a #GDate from a Julian day number.

func (*Date) SetMonth 

func (x *Date) SetMonth(MonthVar DateMonth)

Sets the month of the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

func (*Date) SetParse 

func (x *Date) SetParse(StrVar string)

Parses a user-inputted string @str, and try to figure out what date it represents, taking the [current locale](running.html#locale) into account. If the string is successfully parsed, the date will be valid after the call. Otherwise, it will be invalid. You should check using g_date_valid() to see whether the parsing succeeded.

This function is not appropriate for file formats and the like; it isn't very precise, and its exact behavior varies with the locale. It's intended to be a heuristic routine that guesses what the user means by a given string (and it does work pretty well in that capacity).

func (*Date) SetTime 

func (x *Date) SetTime(TimeVar Time)

Sets the value of a date from a #GTime value. The time to date conversion is done using the user's current timezone.

func (*Date) SetTimeT 

func (x *Date) SetTimeT(TimetVar int)

Sets the value of a date to the date corresponding to a time specified as a time_t. The time to date conversion is done using the user's current timezone.

To set the value of a date to the current day, you could write: |[&lt;!-- language="C" --&gt; 

time_t now = time (NULL);
if (now == (time_t) -1)
  // handle the error
g_date_set_time_t (date, now);

]|

func (*Date) SetTimeVal 

func (x *Date) SetTimeVal(TimevalVar *TimeVal)

Sets the value of a date from a #GTimeVal value. Note that the @tv_usec member is ignored, because #GDate can't make use of the additional precision.

The time to date conversion is done using the user's current timezone.

func (*Date) SetYear 

func (x *Date) SetYear(YearVar DateYear)

Sets the year for a #GDate. If the resulting day-month-year triplet is invalid, the date will be invalid.

func (*Date) SubtractDays 

func (x *Date) SubtractDays(NDaysVar uint)

Moves a date some number of days into the past. To move by weeks, just move by weeks*7 days. The date must be valid.

func (*Date) SubtractMonths 

func (x *Date) SubtractMonths(NMonthsVar uint)

Moves a date some number of months into the past. If the current day of the month doesn't exist in the destination month, the day of the month may change. The date must be valid.

func (*Date) SubtractYears 

func (x *Date) SubtractYears(NYearsVar uint)

Moves a date some number of years into the past. If the current day doesn't exist in the destination year (i.e. it's February 29 and you move to a non-leap-year) then the day is changed to February 29. The date must be valid.

func (*Date) ToStructTm 

func (x *Date) ToStructTm(TmVar uintptr)

Fills in the date-related bits of a struct tm using the @date value. Initializes the non-date parts with something safe but meaningless.

func (*Date) Valid 

func (x *Date) Valid() bool

Returns %TRUE if the #GDate represents an existing day. The date must not contain garbage; it should have been initialized with g_date_clear() if it wasn't allocated by one of the g_date_new() variants.

type DateDMY 

type DateDMY int

This enumeration isn't used in the API, but may be useful if you need to mark a number as a day, month, or year. 

const (

	// a day
	GDateDayValue DateDMY = 0
	// a month
	GDateMonthValue DateDMY = 1
	// a year
	GDateYearValue DateDMY = 2
)

type DateDay 

type DateDay = byte

Integer representing a day of the month; between 1 and 31.

The %G_DATE_BAD_DAY value represents an invalid day of the month.

type DateMonth 

type DateMonth int

Enumeration representing a month; values are %G_DATE_JANUARY, %G_DATE_FEBRUARY, etc. %G_DATE_BAD_MONTH is the invalid value. 

const (

	// invalid value
	GDateBadMonthValue DateMonth = 0
	// January
	GDateJanuaryValue DateMonth = 1
	// February
	GDateFebruaryValue DateMonth = 2
	// March
	GDateMarchValue DateMonth = 3
	// April
	GDateAprilValue DateMonth = 4
	// May
	GDateMayValue DateMonth = 5
	// June
	GDateJuneValue DateMonth = 6
	// July
	GDateJulyValue DateMonth = 7
	// August
	GDateAugustValue DateMonth = 8
	// September
	GDateSeptemberValue DateMonth = 9
	// October
	GDateOctoberValue DateMonth = 10
	// November
	GDateNovemberValue DateMonth = 11
	// December
	GDateDecemberValue DateMonth = 12
)

type DateTime 

type DateTime struct {
	// contains filtered or unexported fields
}

`GDateTime` is a structure that combines a Gregorian date and time into a single structure.

`GDateTime` provides many conversion and methods to manipulate dates and times. Time precision is provided down to microseconds and the time can range (proleptically) from 0001-01-01 00:00:00 to 9999-12-31 23:59:59.999999. `GDateTime` follows POSIX time in the sense that it is oblivious to leap seconds.

`GDateTime` is an immutable object; once it has been created it cannot be modified further. All modifiers will create a new `GDateTime`. Nearly all such functions can fail due to the date or time going out of range, in which case %NULL will be returned.

`GDateTime` is reference counted: the reference count is increased by calling [method@GLib.DateTime.ref] and decreased by calling [method@GLib.DateTime.unref]. When the reference count drops to 0, the resources allocated by the `GDateTime` structure are released.

Many parts of the API may produce non-obvious results. As an example, adding two months to January 31st will yield March 31st whereas adding one month and then one month again will yield either March 28th or March 29th. Also note that adding 24 hours is not always the same as adding one day (since days containing daylight savings time transitions are either 23 or 25 hours in length).

func NewDateTime 

func NewDateTime(TzVar *TimeZone, YearVar int, MonthVar int, DayVar int, HourVar int, MinuteVar int, SecondsVar float64) *DateTime

Creates a new #GDateTime corresponding to the given date and time in the time zone @tz.

The @year must be between 1 and 9999, @month between 1 and 12 and @day between 1 and 28, 29, 30 or 31 depending on the month and the year.

@hour must be between 0 and 23 and @minute must be between 0 and 59.

@seconds must be at least 0.0 and must be strictly less than 60.0. It will be rounded down to the nearest microsecond.

If the given time is not representable in the given time zone (for example, 02:30 on March 14th 2010 in Toronto, due to daylight savings time) then the time will be rounded up to the nearest existing time (in this case, 03:00). If this matters to you then you should verify the return value for containing the same as the numbers you gave.

In the case that the given time is ambiguous in the given time zone (for example, 01:30 on November 7th 2010 in Toronto, due to daylight savings time) then the time falling within standard (ie: non-daylight) time is taken.

It not considered a programmer error for the values to this function to be out of range, but in the case that they are, the function will return %NULL.

You should release the return value by calling g_date_time_unref() when you are done with it.

func NewDateTimeFromIso8601 

func NewDateTimeFromIso8601(TextVar string, DefaultTzVar *TimeZone) *DateTime

Creates a #GDateTime corresponding to the given [ISO 8601 formatted string](https://en.wikipedia.org/wiki/ISO_8601) @text. ISO 8601 strings of the form `&lt;date&gt;&lt;sep&gt;&lt;time&gt;&lt;tz&gt;` are supported, with some extensions from [RFC 3339](https://tools.ietf.org/html/rfc3339) as mentioned below.

Note that as #GDateTime "is oblivious to leap seconds", leap seconds information in an ISO-8601 string will be ignored, so a `23:59:60` time would be parsed as `23:59:59`.

`&lt;sep&gt;` is the separator and can be either 'T', 't' or ' '. The latter two separators are an extension from [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6).

`&lt;date&gt;` is in the form:

  • `YYYY-MM-DD` - Year/month/day, e.g. 2016-08-24.
  • `YYYYMMDD` - Same as above without dividers.
  • `YYYY-DDD` - Ordinal day where DDD is from 001 to 366, e.g. 2016-237.
  • `YYYYDDD` - Same as above without dividers.
  • `YYYY-Www-D` - Week day where ww is from 01 to 52 and D from 1-7, e.g. 2016-W34-3.
  • `YYYYWwwD` - Same as above without dividers.

`&lt;time&gt;` is in the form:

- `hh:mm:ss(.sss)` - Hours, minutes, seconds (subseconds), e.g. 22:10:42.123. - `hhmmss(.sss)` - Same as above without dividers.

`&lt;tz&gt;` is an optional timezone suffix of the form:

- `Z` - UTC. - `+hh:mm` or `-hh:mm` - Offset from UTC in hours and minutes, e.g. +12:00. - `+hh` or `-hh` - Offset from UTC in hours, e.g. +12.

If the timezone is not provided in @text it must be provided in @default_tz (this field is otherwise ignored).

This call can fail (returning %NULL) if @text is not a valid ISO 8601 formatted string.

You should release the return value by calling g_date_time_unref() when you are done with it.

func NewDateTimeFromTimevalLocal 

func NewDateTimeFromTimevalLocal(TvVar *TimeVal) *DateTime

Creates a #GDateTime corresponding to the given #GTimeVal @tv in the local time zone.

The time contained in a #GTimeVal is always stored in the form of seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the local time offset.

This call can fail (returning %NULL) if @tv represents a time outside of the supported range of #GDateTime.

You should release the return value by calling g_date_time_unref() when you are done with it.

func NewDateTimeFromTimevalUtc 

func NewDateTimeFromTimevalUtc(TvVar *TimeVal) *DateTime

Creates a #GDateTime corresponding to the given #GTimeVal @tv in UTC.

The time contained in a #GTimeVal is always stored in the form of seconds elapsed since 1970-01-01 00:00:00 UTC.

This call can fail (returning %NULL) if @tv represents a time outside of the supported range of #GDateTime.

You should release the return value by calling g_date_time_unref() when you are done with it.

func NewDateTimeFromUnixLocal 

func NewDateTimeFromUnixLocal(TVar int64) *DateTime

Creates a #GDateTime corresponding to the given Unix time @t in the local time zone.

Unix time is the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC, regardless of the local time offset.

This call can fail (returning %NULL) if @t represents a time outside of the supported range of #GDateTime.

You should release the return value by calling g_date_time_unref() when you are done with it.

func NewDateTimeFromUnixLocalUsec 

func NewDateTimeFromUnixLocalUsec(UsecsVar int64) *DateTime

Creates a [struct@GLib.DateTime] corresponding to the given Unix time @t in the local time zone.

Unix time is the number of microseconds that have elapsed since 1970-01-01 00:00:00 UTC, regardless of the local time offset.

This call can fail (returning `NULL`) if @t represents a time outside of the supported range of #GDateTime.

You should release the return value by calling [method@GLib.DateTime.unref] when you are done with it.

func NewDateTimeFromUnixUtc 

func NewDateTimeFromUnixUtc(TVar int64) *DateTime

Creates a #GDateTime corresponding to the given Unix time @t in UTC.

Unix time is the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.

This call can fail (returning %NULL) if @t represents a time outside of the supported range of #GDateTime.

You should release the return value by calling g_date_time_unref() when you are done with it.

func NewDateTimeFromUnixUtcUsec 

func NewDateTimeFromUnixUtcUsec(UsecsVar int64) *DateTime

Creates a [struct@GLib.DateTime] corresponding to the given Unix time @t in UTC.

Unix time is the number of microseconds that have elapsed since 1970-01-01 00:00:00 UTC.

This call can fail (returning `NULL`) if @t represents a time outside of the supported range of #GDateTime.

You should release the return value by calling [method@GLib.DateTime.unref] when you are done with it.

func NewDateTimeLocal 

func NewDateTimeLocal(YearVar int, MonthVar int, DayVar int, HourVar int, MinuteVar int, SecondsVar float64) *DateTime

Creates a new #GDateTime corresponding to the given date and time in the local time zone.

This call is equivalent to calling g_date_time_new() with the time zone returned by g_time_zone_new_local().

func NewDateTimeNow 

func NewDateTimeNow(TzVar *TimeZone) *DateTime

Creates a #GDateTime corresponding to this exact instant in the given time zone @tz. The time is as accurate as the system allows, to a maximum accuracy of 1 microsecond.

This function will always succeed unless GLib is still being used after the year 9999.

You should release the return value by calling g_date_time_unref() when you are done with it.

func NewDateTimeNowLocal 

func NewDateTimeNowLocal() *DateTime

Creates a #GDateTime corresponding to this exact instant in the local time zone.

This is equivalent to calling g_date_time_new_now() with the time zone returned by g_time_zone_new_local().

func NewDateTimeNowUtc 

func NewDateTimeNowUtc() *DateTime

Creates a #GDateTime corresponding to this exact instant in UTC.

This is equivalent to calling g_date_time_new_now() with the time zone returned by g_time_zone_new_utc().

func NewDateTimeUtc 

func NewDateTimeUtc(YearVar int, MonthVar int, DayVar int, HourVar int, MinuteVar int, SecondsVar float64) *DateTime

Creates a new #GDateTime corresponding to the given date and time in UTC.

This call is equivalent to calling g_date_time_new() with the time zone returned by g_time_zone_new_utc().

func (*DateTime) Add 

func (x *DateTime) Add(TimespanVar TimeSpan) *DateTime

Creates a copy of @datetime and adds the specified timespan to the copy.

func (*DateTime) AddDays 

func (x *DateTime) AddDays(DaysVar int) *DateTime

Creates a copy of @datetime and adds the specified number of days to the copy. Add negative values to subtract days.

func (*DateTime) AddFull 

func (x *DateTime) AddFull(YearsVar int, MonthsVar int, DaysVar int, HoursVar int, MinutesVar int, SecondsVar float64) *DateTime

Creates a new #GDateTime adding the specified values to the current date and time in @datetime. Add negative values to subtract.

func (*DateTime) AddHours 

func (x *DateTime) AddHours(HoursVar int) *DateTime

Creates a copy of @datetime and adds the specified number of hours. Add negative values to subtract hours.

func (*DateTime) AddMinutes 

func (x *DateTime) AddMinutes(MinutesVar int) *DateTime

Creates a copy of @datetime adding the specified number of minutes. Add negative values to subtract minutes.

func (*DateTime) AddMonths 

func (x *DateTime) AddMonths(MonthsVar int) *DateTime

Creates a copy of @datetime and adds the specified number of months to the copy. Add negative values to subtract months.

The day of the month of the resulting #GDateTime is clamped to the number of days in the updated calendar month. For example, if adding 1 month to 31st January 2018, the result would be 28th February 2018. In 2020 (a leap year), the result would be 29th February.

func (*DateTime) AddSeconds 

func (x *DateTime) AddSeconds(SecondsVar float64) *DateTime

Creates a copy of @datetime and adds the specified number of seconds. Add negative values to subtract seconds.

func (*DateTime) AddWeeks 

func (x *DateTime) AddWeeks(WeeksVar int) *DateTime

Creates a copy of @datetime and adds the specified number of weeks to the copy. Add negative values to subtract weeks.

func (*DateTime) AddYears 

func (x *DateTime) AddYears(YearsVar int) *DateTime

Creates a copy of @datetime and adds the specified number of years to the copy. Add negative values to subtract years.

As with g_date_time_add_months(), if the resulting date would be 29th February on a non-leap year, the day will be clamped to 28th February.

func (*DateTime) Compare 

func (x *DateTime) Compare(Dt2Var uintptr) int

A comparison function for #GDateTimes that is suitable as a #GCompareFunc. Both #GDateTimes must be non-%NULL.

func (*DateTime) Difference 

func (x *DateTime) Difference(BeginVar *DateTime) TimeSpan

Calculates the difference in time between @end and @begin. The #GTimeSpan that is returned is effectively @end - @begin (ie: positive if the first parameter is larger).

func (*DateTime) Equal 

func (x *DateTime) Equal(Dt2Var uintptr) bool

Checks to see if @dt1 and @dt2 are equal.

Equal here means that they represent the same moment after converting them to the same time zone.

func (*DateTime) Format 

func (x *DateTime) Format(FormatVar string) string

Creates a newly allocated string representing the requested @format.

The format strings understood by this function are a subset of the `strftime()` format language as specified by C99. The `%D`, `%U` and `%W` conversions are not supported, nor is the `E` modifier. The GNU extensions `%k`, `%l`, `%s` and `%P` are supported, however, as are the `0`, `_` and `-` modifiers. The Python extension `%f` is also supported.

In contrast to `strftime()`, this function always produces a UTF-8 string, regardless of the current locale. Note that the rendering of many formats is locale-dependent and may not match the `strftime()` output exactly.

The following format specifiers are supported:

  • `%a`: the abbreviated weekday name according to the current locale
  • `%A`: the full weekday name according to the current locale
  • `%b`: the abbreviated month name according to the current locale
  • `%B`: the full month name according to the current locale
  • `%c`: the preferred date and time representation for the current locale
  • `%C`: the century number (year/100) as a 2-digit integer (00-99)
  • `%d`: the day of the month as a decimal number (range 01 to 31)
  • `%e`: the day of the month as a decimal number (range 1 to 31); single digits are preceded by a figure space (U+2007)
  • `%F`: equivalent to `%Y-%m-%d` (the ISO 8601 date format)
  • `%g`: the last two digits of the ISO 8601 week-based year as a decimal number (00-99). This works well with `%V` and `%u`.
  • `%G`: the ISO 8601 week-based year as a decimal number. This works well with `%V` and `%u`.
  • `%h`: equivalent to `%b`
  • `%H`: the hour as a decimal number using a 24-hour clock (range 00 to 23)
  • `%I`: the hour as a decimal number using a 12-hour clock (range 01 to 12)
  • `%j`: the day of the year as a decimal number (range 001 to 366)
  • `%k`: the hour (24-hour clock) as a decimal number (range 0 to 23); single digits are preceded by a figure space (U+2007)
  • `%l`: the hour (12-hour clock) as a decimal number (range 1 to 12); single digits are preceded by a figure space (U+2007)
  • `%m`: the month as a decimal number (range 01 to 12)
  • `%M`: the minute as a decimal number (range 00 to 59)
  • `%f`: the microsecond as a decimal number (range 000000 to 999999)
  • `%p`: either ‘AM’ or ‘PM’ according to the given time value, or the corresponding strings for the current locale. Noon is treated as ‘PM’ and midnight as ‘AM’. Use of this format specifier is discouraged, as many locales have no concept of AM/PM formatting. Use `%c` or `%X` instead.
  • `%P`: like `%p` but lowercase: ‘am’ or ‘pm’ or a corresponding string for the current locale. Use of this format specifier is discouraged, as many locales have no concept of AM/PM formatting. Use `%c` or `%X` instead.
  • `%r`: the time in a.m. or p.m. notation. Use of this format specifier is discouraged, as many locales have no concept of AM/PM formatting. Use `%c` or `%X` instead.
  • `%R`: the time in 24-hour notation (`%H:%M`)
  • `%s`: the number of seconds since the Epoch, that is, since 1970-01-01 00:00:00 UTC
  • `%S`: the second as a decimal number (range 00 to 60)
  • `%t`: a tab character
  • `%T`: the time in 24-hour notation with seconds (`%H:%M:%S`)
  • `%u`: the ISO 8601 standard day of the week as a decimal, range 1 to 7, Monday being 1. This works well with `%G` and `%V`.
  • `%V`: the ISO 8601 standard week number of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the new year. See g_date_time_get_week_of_year(). This works well with `%G` and `%u`.
  • `%w`: the day of the week as a decimal, range 0 to 6, Sunday being 0. This is not the ISO 8601 standard format — use `%u` instead.
  • `%x`: the preferred date representation for the current locale without the time
  • `%X`: the preferred time representation for the current locale without the date
  • `%y`: the year as a decimal number without the century
  • `%Y`: the year as a decimal number including the century
  • `%z`: the time zone as an offset from UTC (`+hhmm`)
  • `%:z`: the time zone as an offset from UTC (`+hh:mm`). This is a gnulib `strftime()` extension. Since: 2.38
  • `%::z`: the time zone as an offset from UTC (`+hh:mm:ss`). This is a gnulib `strftime()` extension. Since: 2.38
  • `%:::z`: the time zone as an offset from UTC, with `:` to necessary precision (e.g., `-04`, `+05:30`). This is a gnulib `strftime()` extension. Since: 2.38
  • `%Z`: the time zone or name or abbreviation
  • `%%`: a literal `%` character

Some conversion specifications can be modified by preceding the conversion specifier by one or more modifier characters.

The following modifiers are supported for many of the numeric conversions:

  • `O`: Use alternative numeric symbols, if the current locale supports those.
  • `_`: Pad a numeric result with spaces. This overrides the default padding for the specifier.
  • `-`: Do not pad a numeric result. This overrides the default padding for the specifier.
  • `0`: Pad a numeric result with zeros. This overrides the default padding for the specifier.

The following modifiers are supported for many of the alphabetic conversions:

  • `^`: Use upper case if possible. This is a gnulib `strftime()` extension. Since: 2.80
  • `#`: Use opposite case if possible. This is a gnulib `strftime()` extension. Since: 2.80

Additionally, when `O` is used with `B`, `b`, or `h`, it produces the alternative form of a month name. The alternative form should be used when the month name is used without a day number (e.g., standalone). It is required in some languages (Baltic, Slavic, Greek, and more) due to their grammatical rules. For other languages there is no difference. `%OB` is a GNU and BSD `strftime()` extension expected to be added to the future POSIX specification, `%Ob` and `%Oh` are GNU `strftime()` extensions. Since: 2.56

Since GLib 2.80, when `E` is used with `%c`, `%C`, `%x`, `%X`, `%y` or `%Y`, the date is formatted using an alternate era representation specific to the locale. This is typically used for the Thai solar calendar or Japanese era names, for example.

  • `%Ec`: the preferred date and time representation for the current locale, using the alternate era representation
  • `%EC`: the name of the era
  • `%Ex`: the preferred date representation for the current locale without the time, using the alternate era representation
  • `%EX`: the preferred time representation for the current locale without the date, using the alternate era representation
  • `%Ey`: the year since the beginning of the era denoted by the `%EC` specifier
  • `%EY`: the full alternative year representation

func (*DateTime) FormatIso8601 

func (x *DateTime) FormatIso8601() string

Format @datetime in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), including the date, time and time zone, and return that as a UTF-8 encoded string.

Since GLib 2.66, this will output to sub-second precision if needed.

func (*DateTime) GetDayOfMonth 

func (x *DateTime) GetDayOfMonth() int

Retrieves the day of the month represented by @datetime in the gregorian calendar.

func (*DateTime) GetDayOfWeek 

func (x *DateTime) GetDayOfWeek() int

Retrieves the ISO 8601 day of the week on which @datetime falls (1 is Monday, 2 is Tuesday... 7 is Sunday).

func (*DateTime) GetDayOfYear 

func (x *DateTime) GetDayOfYear() int

Retrieves the day of the year represented by @datetime in the Gregorian calendar.

func (*DateTime) GetHour 

func (x *DateTime) GetHour() int

Retrieves the hour of the day represented by @datetime

func (*DateTime) GetMicrosecond 

func (x *DateTime) GetMicrosecond() int

Retrieves the microsecond of the date represented by @datetime

func (*DateTime) GetMinute 

func (x *DateTime) GetMinute() int

Retrieves the minute of the hour represented by @datetime

func (*DateTime) GetMonth 

func (x *DateTime) GetMonth() int

Retrieves the month of the year represented by @datetime in the Gregorian calendar.

func (*DateTime) GetSecond 

func (x *DateTime) GetSecond() int

Retrieves the second of the minute represented by @datetime

func (*DateTime) GetSeconds 

func (x *DateTime) GetSeconds() float64

Retrieves the number of seconds since the start of the last minute, including the fractional part.

func (*DateTime) GetTimezone 

func (x *DateTime) GetTimezone() *TimeZone

Get the time zone for this @datetime.

func (*DateTime) GetTimezoneAbbreviation 

func (x *DateTime) GetTimezoneAbbreviation() string

Determines the time zone abbreviation to be used at the time and in the time zone of @datetime.

For example, in Toronto this is currently "EST" during the winter months and "EDT" during the summer months when daylight savings time is in effect.

func (*DateTime) GetUtcOffset 

func (x *DateTime) GetUtcOffset() TimeSpan

Determines the offset to UTC in effect at the time and in the time zone of @datetime.

The offset is the number of microseconds that you add to UTC time to arrive at local time for the time zone (ie: negative numbers for time zones west of GMT, positive numbers for east).

If @datetime represents UTC time, then the offset is always zero.

func (*DateTime) GetWeekNumberingYear 

func (x *DateTime) GetWeekNumberingYear() int

Returns the ISO 8601 week-numbering year in which the week containing @datetime falls.

This function, taken together with g_date_time_get_week_of_year() and g_date_time_get_day_of_week() can be used to determine the full ISO week date on which @datetime falls.

This is usually equal to the normal Gregorian year (as returned by g_date_time_get_year()), except as detailed below:

For Thursday, the week-numbering year is always equal to the usual calendar year. For other days, the number is such that every day within a complete week (Monday to Sunday) is contained within the same week-numbering year.

For Monday, Tuesday and Wednesday occurring near the end of the year, this may mean that the week-numbering year is one greater than the calendar year (so that these days have the same week-numbering year as the Thursday occurring early in the next year).

For Friday, Saturday and Sunday occurring near the start of the year, this may mean that the week-numbering year is one less than the calendar year (so that these days have the same week-numbering year as the Thursday occurring late in the previous year).

An equivalent description is that the week-numbering year is equal to the calendar year containing the majority of the days in the current week (Monday to Sunday).

Note that January 1 0001 in the proleptic Gregorian calendar is a Monday, so this function never returns 0.

func (*DateTime) GetWeekOfYear 

func (x *DateTime) GetWeekOfYear() int

Returns the ISO 8601 week number for the week containing @datetime. The ISO 8601 week number is the same for every day of the week (from Moday through Sunday). That can produce some unusual results (described below).

The first week of the year is week 1. This is the week that contains the first Thursday of the year. Equivalently, this is the first week that has more than 4 of its days falling within the calendar year.

The value 0 is never returned by this function. Days contained within a year but occurring before the first ISO 8601 week of that year are considered as being contained in the last week of the previous year. Similarly, the final days of a calendar year may be considered as being part of the first ISO 8601 week of the next year if 4 or more days of that week are contained within the new year.

func (*DateTime) GetYear 

func (x *DateTime) GetYear() int

Retrieves the year represented by @datetime in the Gregorian calendar.

func (*DateTime) GetYmd 

func (x *DateTime) GetYmd(YearVar *int, MonthVar *int, DayVar *int)

Retrieves the Gregorian day, month, and year of a given #GDateTime.

func (*DateTime) GoPointer 

func (x *DateTime) GoPointer() uintptr

func (*DateTime) Hash 

func (x *DateTime) Hash() uint

Hashes @datetime into a #guint, suitable for use within #GHashTable.

func (*DateTime) IsDaylightSavings 

func (x *DateTime) IsDaylightSavings() bool

Determines if daylight savings time is in effect at the time and in the time zone of @datetime.

func (*DateTime) Ref 

func (x *DateTime) Ref() *DateTime

Atomically increments the reference count of @datetime by one.

func (*DateTime) ToLocal 

func (x *DateTime) ToLocal() *DateTime

Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in the local time zone.

This call is equivalent to calling g_date_time_to_timezone() with the time zone returned by g_time_zone_new_local().

func (*DateTime) ToTimeval 

func (x *DateTime) ToTimeval(TvVar *TimeVal) bool

Stores the instant in time that @datetime represents into @tv.

The time contained in a #GTimeVal is always stored in the form of seconds elapsed since 1970-01-01 00:00:00 UTC, regardless of the time zone associated with @datetime.

On systems where 'long' is 32bit (ie: all 32bit systems and all Windows systems), a #GTimeVal is incapable of storing the entire range of values that #GDateTime is capable of expressing. On those systems, this function returns %FALSE to indicate that the time is out of range.

On systems where 'long' is 64bit, this function never fails.

func (*DateTime) ToTimezone 

func (x *DateTime) ToTimezone(TzVar *TimeZone) *DateTime

Create a new #GDateTime corresponding to the same instant in time as @datetime, but in the time zone @tz.

This call can fail in the case that the time goes out of bounds. For example, converting 0001-01-01 00:00:00 UTC to a time zone west of Greenwich will fail (due to the year 0 being out of range).

func (*DateTime) ToUnix 

func (x *DateTime) ToUnix() int64

Gives the Unix time corresponding to @datetime, rounding down to the nearest second.

Unix time is the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC, regardless of the time zone associated with @datetime.

func (*DateTime) ToUnixUsec 

func (x *DateTime) ToUnixUsec() int64

Gives the Unix time corresponding to @datetime, in microseconds.

Unix time is the number of microseconds that have elapsed since 1970-01-01 00:00:00 UTC, regardless of the time zone associated with @datetime.

func (*DateTime) ToUtc 

func (x *DateTime) ToUtc() *DateTime

Creates a new #GDateTime corresponding to the same instant in time as @datetime, but in UTC.

This call is equivalent to calling g_date_time_to_timezone() with the time zone returned by g_time_zone_new_utc().

func (*DateTime) Unref 

func (x *DateTime) Unref()

Atomically decrements the reference count of @datetime by one.

When the reference count reaches zero, the resources allocated by @datetime are freed

type DateWeekday 

type DateWeekday int

Enumeration representing a day of the week; %G_DATE_MONDAY, %G_DATE_TUESDAY, etc. %G_DATE_BAD_WEEKDAY is an invalid weekday. 

const (

	// invalid value
	GDateBadWeekdayValue DateWeekday = 0
	// Monday
	GDateMondayValue DateWeekday = 1
	// Tuesday
	GDateTuesdayValue DateWeekday = 2
	// Wednesday
	GDateWednesdayValue DateWeekday = 3
	// Thursday
	GDateThursdayValue DateWeekday = 4
	// Friday
	GDateFridayValue DateWeekday = 5
	// Saturday
	GDateSaturdayValue DateWeekday = 6
	// Sunday
	GDateSundayValue DateWeekday = 7
)

type DateYear 

type DateYear = uint16

Integer type representing a year.

The %G_DATE_BAD_YEAR value is the invalid value. The year must be 1 or higher; negative ([BCE](https://en.wikipedia.org/wiki/Common_Era)) years are not allowed.

The year is represented with four digits.

type DebugKey 

type DebugKey struct {
	Key uintptr

	Value uint
	// contains filtered or unexported fields
}

Associates a string with a bit flag. Used in g_parse_debug_string().

func (*DebugKey) GoPointer 

func (x *DebugKey) GoPointer() uintptr

type DestroyNotify 

type DestroyNotify func(uintptr)

Specifies the type of function which is called when a data element is destroyed. It is passed the pointer to the data element and should free any memory and resources allocated for it.

type Dir 

type Dir struct {
	// contains filtered or unexported fields
}

An opaque structure representing an opened directory.

func DirOpen 

func DirOpen(PathVar string, FlagsVar uint) (*Dir, error)

Opens a directory for reading. The names of the files in the directory can then be retrieved using g_dir_read_name(). Note that the ordering is not defined.

func (*Dir) Close 

func (x *Dir) Close()

Closes the directory immediately and decrements the reference count.

Once the reference count reaches zero, the `GDir` structure itself will be freed. Prior to GLib 2.80, `GDir` was not reference counted.

It is an error to call any of the `GDir` methods other than [method@GLib.Dir.ref] and [method@GLib.Dir.unref] on a `GDir` after calling [method@GLib.Dir.close] on it.

func (*Dir) GoPointer 

func (x *Dir) GoPointer() uintptr

func (*Dir) ReadName 

func (x *Dir) ReadName() string

Retrieves the name of another entry in the directory, or %NULL. The order of entries returned from this function is not defined, and may vary by file system or other operating-system dependent factors.

%NULL may also be returned in case of errors. On Unix, you can check `errno` to find out if %NULL was returned because of an error.

On Unix, the '.' and '..' entries are omitted, and the returned name is in the on-disk encoding.

On Windows, as is true of all GLib functions which operate on filenames, the returned name is in UTF-8.

func (*Dir) Ref 

func (x *Dir) Ref() *Dir

Increment the reference count of `dir`.

func (*Dir) Rewind 

func (x *Dir) Rewind()

Resets the given directory. The next call to g_dir_read_name() will return the first entry again.

func (*Dir) Unref 

func (x *Dir) Unref()

Decrements the reference count of `dir`.

Once the reference count reaches zero, the directory will be closed and all resources associated with it will be freed. If [method@GLib.Dir.close] is called when the reference count is greater than zero, the directory is closed but the `GDir` structure will not be freed until its reference count reaches zero.

It is an error to call any of the `GDir` methods other than [method@GLib.Dir.ref] and [method@GLib.Dir.unref] on a `GDir` after calling [method@GLib.Dir.close] on it.

type DoubleIEEE754 

type DoubleIEEE754 = uintptr

The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign, mantissa and exponent of IEEE floats and doubles. These unions are defined as appropriate for a given platform. IEEE floats and doubles are supported (used for storage) by at least Intel, PPC and Sparc.

type DuplicateFunc 

type DuplicateFunc func(uintptr, uintptr) uintptr

The type of functions that are used to 'duplicate' an object. What this means depends on the context, it could just be incrementing the reference count, if @data is a ref-counted object.

type EqualFunc 

type EqualFunc func(uintptr, uintptr) bool

Specifies the type of a function used to test two values for equality. The function should return %TRUE if both values are equal and %FALSE otherwise.

type EqualFuncFull 

type EqualFuncFull func(uintptr, uintptr, uintptr) bool

Specifies the type of a function used to test two values for equality. The function should return %TRUE if both values are equal and %FALSE otherwise.

This is a version of #GEqualFunc which provides a @user_data closure from the caller.

type Error 

type Error struct {
	Domain Quark

	Code int32

	Message uintptr
	// contains filtered or unexported fields
}

The `GError` structure contains information about an error that has occurred.

func NewError 

func NewError(DomainVar Quark, CodeVar int, FormatVar string, varArgs ...interface{}) *Error

Creates a new #GError with the given @domain and @code, and a message formatted with @format.

func NewErrorLiteral 

func NewErrorLiteral(DomainVar Quark, CodeVar int, MessageVar string) *Error

Creates a new #GError; unlike g_error_new(), @message is not a printf()-style format string. Use this function if @message contains text you don't have control over, that could include printf() escape sequences.

func NewErrorValist 

func NewErrorValist(DomainVar Quark, CodeVar int, FormatVar string, ArgsVar []interface{}) *Error

Creates a new #GError with the given @domain and @code, and a message formatted with @format.

func (*Error) Copy 

func (x *Error) Copy() *Error

Makes a copy of @error.

func (*Error) Error 

func (e *Error) Error() string

func (*Error) Free 

func (x *Error) Free()

Frees a #GError and associated resources.

func (*Error) GoPointer 

func (x *Error) GoPointer() uintptr

func (*Error) Matches 

func (x *Error) Matches(DomainVar Quark, CodeVar int) bool

Returns %TRUE if @error matches @domain and @code, %FALSE otherwise. In particular, when @error is %NULL, %FALSE will be returned.

If @domain contains a `FAILED` (or otherwise generic) error code, you should generally not check for it explicitly, but should instead treat any not-explicitly-recognized error code as being equivalent to the `FAILED` code. This way, if the domain is extended in the future to provide a more specific error code for a certain case, your code will still work.

func (*Error) MessageGo 

func (e *Error) MessageGo() string

type ErrorClearFunc 

type ErrorClearFunc func(*Error)

Specifies the type of function which is called when an extended error instance is freed. It is passed the error pointer about to be freed, and should free the error's private data fields.

Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it already takes care of getting the private data from @error.

type ErrorCopyFunc 

type ErrorCopyFunc func(*Error, *Error)

Specifies the type of function which is called when an extended error instance is copied. It is passed the pointer to the destination error and source error, and should copy only the fields of the private data from @src_error to @dest_error.

Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it already takes care of getting the private data from @src_error and @dest_error.

type ErrorInitFunc 

type ErrorInitFunc func(*Error)

Specifies the type of function which is called just after an extended error instance is created and its fields filled. It should only initialize the fields in the private data, which can be received with the generated `*_get_private()` function.

Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it already takes care of getting the private data from @error.

type ErrorType 

type ErrorType int

The possible errors, used in the @v_error field of #GTokenValue, when the token is a %G_TOKEN_ERROR. 

const (

	// unknown error
	GErrUnknownValue ErrorType = 0
	// unexpected end of file
	GErrUnexpEofValue ErrorType = 1
	// unterminated string constant
	GErrUnexpEofInStringValue ErrorType = 2
	// unterminated comment
	GErrUnexpEofInCommentValue ErrorType = 3
	// non-digit character in a number
	GErrNonDigitInConstValue ErrorType = 4
	// digit beyond radix in a number
	GErrDigitRadixValue ErrorType = 5
	// non-decimal floating point number
	GErrFloatRadixValue ErrorType = 6
	// malformed floating point number
	GErrFloatMalformedValue ErrorType = 7
)

type FileError 

type FileError int

Values corresponding to @errno codes returned from file operations on UNIX. Unlike @errno codes, GFileError values are available on all systems, even Windows. The exact meaning of each code depends on what sort of file operation you were performing; the UNIX documentation gives more details. The following error code descriptions come from the GNU C Library manual, and are under the copyright of that manual.

It's not very portable to make detailed assumptions about exactly which errors will be returned from a given operation. Some errors don't occur on some systems, etc., sometimes there are subtle differences in when a system will report a given error, etc. 

const (

	// Operation not permitted; only the owner of
	//     the file (or other resource) or processes with special privileges
	//     can perform the operation.
	GFileErrorExistValue FileError = 0
	// File is a directory; you cannot open a directory
	//     for writing, or create or remove hard links to it.
	GFileErrorIsdirValue FileError = 1
	// Permission denied; the file permissions do not
	//     allow the attempted operation.
	GFileErrorAccesValue FileError = 2
	// Filename too long.
	GFileErrorNametoolongValue FileError = 3
	// No such file or directory. This is a "file
	//     doesn't exist" error for ordinary files that are referenced in
	//     contexts where they are expected to already exist.
	GFileErrorNoentValue FileError = 4
	// A file that isn't a directory was specified when
	//     a directory is required.
	GFileErrorNotdirValue FileError = 5
	// No such device or address. The system tried to
	//     use the device represented by a file you specified, and it
	//     couldn't find the device. This can mean that the device file was
	//     installed incorrectly, or that the physical device is missing or
	//     not correctly attached to the computer.
	GFileErrorNxioValue FileError = 6
	// The underlying file system of the specified file
	//     does not support memory mapping.
	GFileErrorNodevValue FileError = 7
	// The directory containing the new link can't be
	//     modified because it's on a read-only file system.
	GFileErrorRofsValue FileError = 8
	// Text file busy.
	GFileErrorTxtbsyValue FileError = 9
	// You passed in a pointer to bad memory.
	//     (GLib won't reliably return this, don't pass in pointers to bad
	//     memory.)
	GFileErrorFaultValue FileError = 10
	// Too many levels of symbolic links were encountered
	//     in looking up a file name. This often indicates a cycle of symbolic
	//     links.
	GFileErrorLoopValue FileError = 11
	// No space left on device; write operation on a
	//     file failed because the disk is full.
	GFileErrorNospcValue FileError = 12
	// No memory available. The system cannot allocate
	//     more virtual memory because its capacity is full.
	GFileErrorNomemValue FileError = 13
	// The current process has too many files open and
	//     can't open any more. Duplicate descriptors do count toward this
	//     limit.
	GFileErrorMfileValue FileError = 14
	// There are too many distinct file openings in the
	//     entire system.
	GFileErrorNfileValue FileError = 15
	// Bad file descriptor; for example, I/O on a
	//     descriptor that has been closed or reading from a descriptor open
	//     only for writing (or vice versa).
	GFileErrorBadfValue FileError = 16
	// Invalid argument. This is used to indicate
	//     various kinds of problems with passing the wrong argument to a
	//     library function.
	GFileErrorInvalValue FileError = 17
	// Broken pipe; there is no process reading from the
	//     other end of a pipe. Every library function that returns this
	//     error code also generates a 'SIGPIPE' signal; this signal
	//     terminates the program if not handled or blocked. Thus, your
	//     program will never actually see this code unless it has handled
	//     or blocked 'SIGPIPE'.
	GFileErrorPipeValue FileError = 18
	// Resource temporarily unavailable; the call might
	//     work if you try again later.
	GFileErrorAgainValue FileError = 19
	// Interrupted function call; an asynchronous signal
	//     occurred and prevented completion of the call. When this
	//     happens, you should try the call again.
	GFileErrorIntrValue FileError = 20
	// Input/output error; usually used for physical read
	//    or write errors. i.e. the disk or other physical device hardware
	//    is returning errors.
	GFileErrorIoValue FileError = 21
	// Operation not permitted; only the owner of the
	//    file (or other resource) or processes with special privileges can
	//    perform the operation.
	GFileErrorPermValue FileError = 22
	// Function not implemented; this indicates that
	//    the system is missing some functionality.
	GFileErrorNosysValue FileError = 23
	// Does not correspond to a UNIX error code; this
	//    is the standard "failed for unspecified reason" error code present
	//    in all #GError error code enumerations. Returned if no specific
	//    code applies.
	GFileErrorFailedValue FileError = 24
)

func FileErrorFromErrno 

func FileErrorFromErrno(ErrNoVar int) FileError

Gets a #GFileError constant based on the passed-in @err_no.

For example, if you pass in `EEXIST` this function returns %G_FILE_ERROR_EXIST. Unlike `errno` values, you can portably assume that all #GFileError values will exist.

Normally a #GFileError value goes into a #GError returned from a function that manipulates files. So you would use g_file_error_from_errno() when constructing a #GError.

type FileSetContentsFlags 

type FileSetContentsFlags int

Flags to pass to g_file_set_contents_full() to affect its safety and performance. 

const (

	// No guarantees about file consistency or durability.
	//   The most dangerous setting, which is slightly faster than other settings.
	GFileSetContentsNoneValue FileSetContentsFlags = 0
	// Guarantee file consistency: after a crash,
	//   either the old version of the file or the new version of the file will be
	//   available, but not a mixture. On Unix systems this equates to an `fsync()`
	//   on the file and use of an atomic `rename()` of the new version of the file
	//   over the old.
	GFileSetContentsConsistentValue FileSetContentsFlags = 1
	// Guarantee file durability: after a crash, the
	//   new version of the file will be available. On Unix systems this equates to
	//   an `fsync()` on the file (if %G_FILE_SET_CONTENTS_CONSISTENT is unset), or
	//   the effects of %G_FILE_SET_CONTENTS_CONSISTENT plus an `fsync()` on the
	//   directory containing the file after calling `rename()`.
	GFileSetContentsDurableValue FileSetContentsFlags = 2
	// Only apply consistency and durability
	//   guarantees if the file already exists. This may speed up file operations
	//   if the file doesn’t currently exist, but may result in a corrupted version
	//   of the new file if the system crashes while writing it.
	GFileSetContentsOnlyExistingValue FileSetContentsFlags = 4
)

type FileTest 

type FileTest int

A test to perform on a file using g_file_test(). 

const (

	// %TRUE if the file is a regular file
	//     (not a directory). Note that this test will also return %TRUE
	//     if the tested file is a symlink to a regular file.
	GFileTestIsRegularValue FileTest = 1
	// %TRUE if the file is a symlink.
	GFileTestIsSymlinkValue FileTest = 2
	// %TRUE if the file is a directory.
	GFileTestIsDirValue FileTest = 4
	// %TRUE if the file is executable.
	GFileTestIsExecutableValue FileTest = 8
	// %TRUE if the file exists. It may or may not
	//     be a regular file.
	GFileTestExistsValue FileTest = 16
)

type FloatIEEE754 

type FloatIEEE754 = uintptr

The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the sign, mantissa and exponent of IEEE floats and doubles. These unions are defined as appropriate for a given platform. IEEE floats and doubles are supported (used for storage) by at least Intel, PPC and Sparc.

type FormatSizeFlags 

type FormatSizeFlags int

Flags to modify the format of the string returned by g_format_size_full(). 

const (

	// behave the same as g_format_size()
	GFormatSizeDefaultValue FormatSizeFlags = 0
	// include the exact number of bytes as part
	//     of the returned string.  For example, "45.6 kB (45,612 bytes)".
	GFormatSizeLongFormatValue FormatSizeFlags = 1
	// use IEC (base 1024) units with "KiB"-style
	//     suffixes. IEC units should only be used for reporting things with
	//     a strong "power of 2" basis, like RAM sizes or RAID stripe sizes.
	//     Network and storage sizes should be reported in the normal SI units.
	GFormatSizeIecUnitsValue FormatSizeFlags = 2
	// set the size as a quantity in bits, rather than
	//     bytes, and return units in bits. For example, ‘Mbit’ rather than ‘MB’.
	GFormatSizeBitsValue FormatSizeFlags = 4
	// return only value, without unit; this should
	//     not be used together with @G_FORMAT_SIZE_LONG_FORMAT
	//     nor @G_FORMAT_SIZE_ONLY_UNIT. Since: 2.74
	GFormatSizeOnlyValueValue FormatSizeFlags = 8
	// return only unit, without value; this should
	//     not be used together with @G_FORMAT_SIZE_LONG_FORMAT
	//     nor @G_FORMAT_SIZE_ONLY_VALUE. Since: 2.74
	GFormatSizeOnlyUnitValue FormatSizeFlags = 16
)

type FreeFunc 

type FreeFunc func(uintptr)

Declares a type of function which takes an arbitrary data pointer argument and has no return value. It is not currently used in GLib or GTK.

type Func 

type Func func(uintptr, uintptr)

Specifies the type of functions passed to g_list_foreach() and g_slist_foreach().

type HFunc 

type HFunc func(uintptr, uintptr, uintptr)

Specifies the type of the function passed to g_hash_table_foreach(). It is called with each key/value pair, together with the @user_data parameter which is passed to g_hash_table_foreach().

type HRFunc 

type HRFunc func(uintptr, uintptr, uintptr) bool

Specifies the type of the function passed to [func@GLib.HashTable.find], [func@GLib.HashTable.foreach_remove], and [func@GLib.HashTable.foreach_steal].

The function is called with each key/value pair, together with the @user_data parameter passed to the calling function.

The function should return true if the key/value pair should be selected, meaning it has been found or it should be removed from the [struct@GLib.HashTable], depending on the calling function.

type HashFunc 

type HashFunc func(uintptr) uint

Specifies the type of the hash function which is passed to [func@HashTable.new] when a [struct@HashTable] is created.

The function is passed a key and should return an `unsigned int` hash value. The functions [func@direct_hash], [func@int_hash] and [func@str_hash] provide hash functions which can be used when the key is a `void*`, `int*`, and `char*` respectively.

[func@direct_hash] is also the appropriate hash function for keys of the form [`GINT_TO_POINTER (n)`](conversion-macros.html#gint-to-pointer) (or similar macros).

A good hash functions should produce hash values that are evenly distributed over a fairly large range. The modulus is taken with the hash table size (a prime number) to find the 'bucket' to place each key into. The function should also be very fast, since it is called for each key lookup.

Note that the hash functions provided by GLib have these qualities, but are not particularly robust against manufactured keys that cause hash collisions. Therefore, you should consider choosing a more secure hash function when using a [struct@HashTable] with keys that originate in untrusted data (such as HTTP requests). Using [func@str_hash] in that situation might make your application vulnerable to [Algorithmic Complexity Attacks](https://lwn.net/Articles/474912/).

The key to choosing a good hash is unpredictability. Even cryptographic hashes are very easy to find collisions for when the remainder is taken modulo a somewhat predictable prime number. There must be an element of randomness that an attacker is unable to guess.

type HashTable 

type HashTable struct {
	// contains filtered or unexported fields
}

The #GHashTable struct is an opaque data structure to represent a [Hash Table](data-structures.html#hash-tables). It should only be accessed via the following functions.

func HashTableNewSimilar 

func HashTableNewSimilar(OtherHashTableVar *HashTable) *HashTable

Creates a new #GHashTable like g_hash_table_new_full() with a reference count of 1.

It inherits the hash function, the key equal function, the key destroy function, as well as the value destroy function, from @other_hash_table.

The returned hash table will be empty; it will not contain the keys or values from @other_hash_table.

func HashTableRef 

func HashTableRef(HashTableVar *HashTable) *HashTable

Atomically increments the reference count of @hash_table by one. This function is MT-safe and may be called from any thread.

func UriParseParams 

func UriParseParams(ParamsVar string, LengthVar int, SeparatorsVar string, FlagsVar UriParamsFlags) (*HashTable, error)

Many URI schemes include one or more attribute/value pairs as part of the URI value. This method can be used to parse them into a hash table. When an attribute has multiple occurrences, the last value is the final returned value. If you need to handle repeated attributes differently, use #GUriParamsIter.

The @params string is assumed to still be `%`-encoded, but the returned values will be fully decoded. (Thus it is possible that the returned values may contain `=` or @separators, if the value was encoded in the input.) Invalid `%`-encoding is treated as with the %G_URI_FLAGS_PARSE_RELAXED rules for g_uri_parse(). (However, if @params is the path or query string from a #GUri that was parsed without %G_URI_FLAGS_PARSE_RELAXED and %G_URI_FLAGS_ENCODED, then you already know that it does not contain any invalid encoding.)

%G_URI_PARAMS_WWW_FORM is handled as documented for g_uri_params_iter_init().

If %G_URI_PARAMS_CASE_INSENSITIVE is passed to @flags, attributes will be compared case-insensitively, so a params string `attr=123&amp;Attr=456` will only return a single attribute–value pair, `Attr=456`. Case will be preserved in the returned attributes.

If @params cannot be parsed (for example, it contains two @separators characters in a row), then @error is set and %NULL is returned.

func (*HashTable) GoPointer 

func (x *HashTable) GoPointer() uintptr

type HashTableIter 

type HashTableIter struct {
	Dummy1 uintptr

	Dummy2 uintptr

	Dummy3 uintptr

	Dummy4 int

	Dummy5 bool

	Dummy6 uintptr
	// contains filtered or unexported fields
}

A GHashTableIter structure represents an iterator that can be used to iterate over the elements of a #GHashTable. GHashTableIter structures are typically allocated on the stack and then initialized with g_hash_table_iter_init().

The iteration order of a #GHashTableIter over the keys/values in a hash table is not defined.

func (*HashTableIter) GetHashTable 

func (x *HashTableIter) GetHashTable() *HashTable

Returns the #GHashTable associated with @iter.

func (*HashTableIter) GoPointer 

func (x *HashTableIter) GoPointer() uintptr

func (*HashTableIter) Init 

func (x *HashTableIter) Init(HashTableVar *HashTable)

Initializes a key/value pair iterator and associates it with @hash_table. Modifying the hash table after calling this function invalidates the returned iterator.

The iteration order of a #GHashTableIter over the keys/values in a hash table is not defined.

|[&lt;!-- language="C" --&gt; GHashTableIter iter; gpointer key, value;

g_hash_table_iter_init (&amp;iter, hash_table); while (g_hash_table_iter_next (&amp;iter, &amp;key, &amp;value)) 

{
  // do something with key and value
}

]|

func (*HashTableIter) Next 

func (x *HashTableIter) Next(KeyVar *uintptr, ValueVar *uintptr) bool

Advances @iter and retrieves the key and/or value that are now pointed to as a result of this advancement. If %FALSE is returned, @key and @value are not set, and the iterator becomes invalid.

func (*HashTableIter) Remove 

func (x *HashTableIter) Remove()

Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned %TRUE, and cannot be called more than once for the same key/value pair.

If the #GHashTable was created using g_hash_table_new_full(), the key and value are freed using the supplied destroy functions, otherwise you have to make sure that any dynamically allocated values are freed yourself.

It is safe to continue iterating the #GHashTable afterward: |[&lt;!-- language="C" --&gt; while (g_hash_table_iter_next (&amp;iter, &amp;key, &amp;value)) 

{
  if (condition)
    g_hash_table_iter_remove (&amp;iter);
}

]|

func (*HashTableIter) Replace 

func (x *HashTableIter) Replace(ValueVar uintptr)

Replaces the value currently pointed to by the iterator from its associated #GHashTable. Can only be called after g_hash_table_iter_next() returned %TRUE.

If you supplied a @value_destroy_func when creating the #GHashTable, the old value is freed using that function.

func (*HashTableIter) Steal 

func (x *HashTableIter) Steal()

Removes the key/value pair currently pointed to by the iterator from its associated #GHashTable, without calling the key and value destroy functions. Can only be called after g_hash_table_iter_next() returned %TRUE, and cannot be called more than once for the same key/value pair.

type Hmac 

type Hmac struct {
	// contains filtered or unexported fields
}

HMACs should be used when producing a cookie or hash based on data and a key. Simple mechanisms for using SHA1 and other algorithms to digest a key and data together are vulnerable to various security issues. [HMAC](http://en.wikipedia.org/wiki/HMAC) uses algorithms like SHA1 in a secure way to produce a digest of a key and data.

Both the key and data are arbitrary byte arrays of bytes or characters.

Support for HMAC Digests has been added in GLib 2.30, and support for SHA-512 in GLib 2.42. Support for SHA-384 was added in GLib 2.52.

To create a new `GHmac`, use [ctor@GLib.Hmac.new]. To free a `GHmac`, use [method@GLib.Hmac.unref].

func NewHmac 

func NewHmac(DigestTypeVar ChecksumType, KeyVar []byte, KeyLenVar uint) *Hmac

Creates a new #GHmac, using the digest algorithm @digest_type. If the @digest_type is not known, %NULL is returned. A #GHmac can be used to compute the HMAC of a key and an arbitrary binary blob, using different hashing algorithms.

A #GHmac works by feeding a binary blob through g_hmac_update() until the data is complete; the digest can then be extracted using g_hmac_get_string(), which will return the checksum as a hexadecimal string; or g_hmac_get_digest(), which will return a array of raw bytes. Once either g_hmac_get_string() or g_hmac_get_digest() have been called on a #GHmac, the HMAC will be closed and it won't be possible to call g_hmac_update() on it anymore.

Support for digests of type %G_CHECKSUM_SHA512 has been added in GLib 2.42. Support for %G_CHECKSUM_SHA384 was added in GLib 2.52.

func (*Hmac) Copy 

func (x *Hmac) Copy() *Hmac

Copies a #GHmac. If @hmac has been closed, by calling g_hmac_get_string() or g_hmac_get_digest(), the copied HMAC will be closed as well.

func (*Hmac) GetDigest 

func (x *Hmac) GetDigest(BufferVar []byte, DigestLenVar *uint)

Gets the digest from @checksum as a raw binary array and places it into @buffer. The size of the digest depends on the type of checksum.

Once this function has been called, the #GHmac is closed and can no longer be updated with g_checksum_update().

func (*Hmac) GetString 

func (x *Hmac) GetString() string

Gets the HMAC as a hexadecimal string.

Once this function has been called the #GHmac can no longer be updated with g_hmac_update().

The hexadecimal characters will be lower case.

func (*Hmac) GoPointer 

func (x *Hmac) GoPointer() uintptr

func (*Hmac) Ref 

func (x *Hmac) Ref() *Hmac

Atomically increments the reference count of @hmac by one.

This function is MT-safe and may be called from any thread.

func (*Hmac) Unref 

func (x *Hmac) Unref()

Atomically decrements the reference count of @hmac by one.

If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread. Frees the memory allocated for @hmac.

func (*Hmac) Update 

func (x *Hmac) Update(DataVar []byte, LengthVar int)

Feeds @data into an existing #GHmac.

The HMAC must still be open, that is g_hmac_get_string() or g_hmac_get_digest() must not have been called on @hmac.

type Hook 

type Hook struct {
	Data uintptr

	Next *Hook

	Prev *Hook

	RefCount uint

	HookId uint

	Flags uint

	Func uintptr

	Destroy DestroyNotify
	// contains filtered or unexported fields
}

The #GHook struct represents a single hook function in a #GHookList.

func (*Hook) CompareIds 

func (x *Hook) CompareIds(SiblingVar *Hook) int

Compares the ids of two #GHook elements, returning a negative value if the second id is greater than the first.

func (*Hook) GoPointer 

func (x *Hook) GoPointer() uintptr

type HookCheckFunc 

type HookCheckFunc func(uintptr) bool

Defines the type of a hook function that can be invoked by g_hook_list_invoke_check().

type HookCheckMarshaller 

type HookCheckMarshaller func(*Hook, uintptr) bool

Defines the type of function used by g_hook_list_marshal_check().

type HookCompareFunc 

type HookCompareFunc func(*Hook, *Hook) int

Defines the type of function used to compare #GHook elements in g_hook_insert_sorted().

type HookFinalizeFunc 

type HookFinalizeFunc func(*HookList, *Hook)

Defines the type of function to be called when a hook in a list of hooks gets finalized.

type HookFindFunc 

type HookFindFunc func(*Hook, uintptr) bool

Defines the type of the function passed to g_hook_find().

type HookFlagMask 

type HookFlagMask int

Flags used internally in the #GHook implementation. 

const (

	// set if the hook has not been destroyed
	GHookFlagActiveValue HookFlagMask = 1
	// set if the hook is currently being run
	GHookFlagInCallValue HookFlagMask = 2

	GHookFlagReserved1Value HookFlagMask = 4
)

type HookFunc 

type HookFunc func(uintptr)

Defines the type of a hook function that can be invoked by g_hook_list_invoke().

type HookList 

type HookList struct {
	SeqId uint

	HookSize uint

	IsSetup uint

	Hooks *Hook

	Dummy3 uintptr

	FinalizeHook HookFinalizeFunc

	Dummy [2]uintptr
	// contains filtered or unexported fields
}

The #GHookList struct represents a list of hook functions.

func (*HookList) Clear 

func (x *HookList) Clear()

Removes all the #GHook elements from a #GHookList.

func (*HookList) GoPointer 

func (x *HookList) GoPointer() uintptr

func (*HookList) Init 

func (x *HookList) Init(HookSizeVar uint)

Initializes a #GHookList. This must be called before the #GHookList is used.

func (*HookList) Invoke 

func (x *HookList) Invoke(MayRecurseVar bool)

Calls all of the #GHook functions in a #GHookList.

func (*HookList) InvokeCheck 

func (x *HookList) InvokeCheck(MayRecurseVar bool)

Calls all of the #GHook functions in a #GHookList. Any function which returns %FALSE is removed from the #GHookList.

func (*HookList) Marshal 

func (x *HookList) Marshal(MayRecurseVar bool, MarshallerVar *HookMarshaller, MarshalDataVar uintptr)

Calls a function on each valid #GHook.

func (*HookList) MarshalCheck 

func (x *HookList) MarshalCheck(MayRecurseVar bool, MarshallerVar *HookCheckMarshaller, MarshalDataVar uintptr)

Calls a function on each valid #GHook and destroys it if the function returns %FALSE.

type HookMarshaller 

type HookMarshaller func(*Hook, uintptr)

Defines the type of function used by g_hook_list_marshal().

type IConv 

type IConv struct {
	// contains filtered or unexported fields
}

The GIConv struct wraps an iconv() conversion descriptor. It contains private data and should only be accessed using the following functions.

func (*IConv) Close 

func (x *IConv) Close() int

Same as the standard UNIX routine iconv_close(), but may be implemented via libiconv on UNIX flavors that lack a native implementation. Should be called to clean up the conversion descriptor from g_iconv_open() when you are done converting things.

GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers.

func (*IConv) GIconv 

func (x *IConv) GIconv(InbufVar string, InbytesLeftVar *uint, OutbufVar string, OutbytesLeftVar *uint) uint

Same as the standard UNIX routine iconv(), but may be implemented via libiconv on UNIX flavors that lack a native implementation.

GLib provides g_convert() and g_locale_to_utf8() which are likely more convenient than the raw iconv wrappers.

Note that the behaviour of iconv() for characters which are valid in the input character set, but which have no representation in the output character set, is implementation defined. This function may return success (with a positive number of non-reversible conversions as replacement characters were used), or it may return -1 and set an error such as %EILSEQ, in such a situation.

See [`iconv(3posix)`](man:iconv(3posix)) and [`iconv(3)`](man:iconv(3)) for more details about behavior when an error occurs.

func (*IConv) GoPointer 

func (x *IConv) GoPointer() uintptr

type IOChannel 

type IOChannel struct {
	RefCount int32

	Funcs *IOFuncs

	Encoding uintptr

	ReadCd uintptr

	WriteCd uintptr

	LineTerm uintptr

	LineTermLen uint

	BufSize uint

	ReadBuf *String

	EncodedReadBuf *String

	WriteBuf *String

	PartialWriteBuf [6]byte

	UseBuffer uint

	DoEncode uint

	CloseOnUnref uint

	IsReadable uint

	IsWriteable uint

	IsSeekable uint

	Reserved1 uintptr

	Reserved2 uintptr
	// contains filtered or unexported fields
}

The `GIOChannel` data type aims to provide a portable method for using file descriptors, pipes, and sockets, and integrating them into the main event loop (see [struct@GLib.MainContext]). Currently, full support is available on UNIX platforms; support for Windows is only partially complete.

To create a new `GIOChannel` on UNIX systems use [ctor@GLib.IOChannel.unix_new]. This works for plain file descriptors, pipes and sockets. Alternatively, a channel can be created for a file in a system independent manner using [ctor@GLib.IOChannel.new_file].

Once a `GIOChannel` has been created, it can be used in a generic manner with the functions [method@GLib.IOChannel.read_chars], [method@GLib.IOChannel.write_chars], [method@GLib.IOChannel.seek_position], and [method@GLib.IOChannel.shutdown].

To add a `GIOChannel` to the main event loop, use [func@GLib.io_add_watch] or [func@GLib.io_add_watch_full]. Here you specify which events you are interested in on the `GIOChannel`, and provide a function to be called whenever these events occur.

`GIOChannel` instances are created with an initial reference count of 1. [method@GLib.IOChannel.ref] and [method@GLib.IOChannel.unref] can be used to increment or decrement the reference count respectively. When the reference count falls to 0, the `GIOChannel` is freed. (Though it isn’t closed automatically, unless it was created using [ctor@GLib.IOChannel.new_file].) Using [func@GLib.io_add_watch] or [func@GLib.io_add_watch_full] increments a channel’s reference count.

The new functions [method@GLib.IOChannel.read_chars], [method@GLib.IOChannel.read_line], [method@GLib.IOChannel.read_line_string], [method@GLib.IOChannel.read_to_end], [method@GLib.IOChannel.write_chars], [method@GLib.IOChannel.seek_position], and [method@GLib.IOChannel.flush] should not be mixed with the deprecated functions [method@GLib.IOChannel.read], [method@GLib.IOChannel.write], and [method@GLib.IOChannel.seek] on the same channel.

func IOChannelUnixNew 

func IOChannelUnixNew(FdVar int) *IOChannel

Creates a new #GIOChannel given a file descriptor. On UNIX systems this works for plain files, pipes, and sockets.

The returned #GIOChannel has a reference count of 1.

The default encoding for #GIOChannel is UTF-8. If your application is reading output from a command using via pipe, you may need to set the encoding to the encoding of the current locale (see g_get_charset()) with the g_io_channel_set_encoding() function. By default, the fd passed will not be closed when the final reference to the #GIOChannel data structure is dropped.

If you want to read raw binary data without interpretation, then call the g_io_channel_set_encoding() function with %NULL for the encoding argument.

This function is available in GLib on Windows, too, but you should avoid using it on Windows. The domain of file descriptors and sockets overlap. There is no way for GLib to know which one you mean in case the argument you pass to this function happens to be both a valid file descriptor and socket. If that happens a warning is issued, and GLib assumes that it is the file descriptor you mean.

func NewIOChannelFile 

func NewIOChannelFile(FilenameVar string, ModeVar string) (*IOChannel, error)

Open a file @filename as a #GIOChannel using mode @mode. This channel will be closed when the last reference to it is dropped, so there is no need to call g_io_channel_close() (though doing so will not cause problems, as long as no attempt is made to access the channel after it is closed).

func (*IOChannel) Close 

func (x *IOChannel) Close()

Close an IO channel. Any pending data to be written will be flushed, ignoring errors. The channel will not be freed until the last reference is dropped using g_io_channel_unref().

func (*IOChannel) Flush 

func (x *IOChannel) Flush() (IOStatus, error)

Flushes the write buffer for the GIOChannel.

func (*IOChannel) GetBufferCondition 

func (x *IOChannel) GetBufferCondition() IOCondition

This function returns a #GIOCondition depending on whether there is data to be read/space to write data in the internal buffers in the #GIOChannel. Only the flags %G_IO_IN and %G_IO_OUT may be set.

func (*IOChannel) GetBufferSize 

func (x *IOChannel) GetBufferSize() uint

Gets the buffer size.

func (*IOChannel) GetBuffered 

func (x *IOChannel) GetBuffered() bool

Returns whether @channel is buffered.

func (*IOChannel) GetCloseOnUnref 

func (x *IOChannel) GetCloseOnUnref() bool

Returns whether the file/socket/whatever associated with @channel will be closed when @channel receives its final unref and is destroyed. The default value of this is %TRUE for channels created by g_io_channel_new_file (), and %FALSE for all other channels.

func (*IOChannel) GetEncoding 

func (x *IOChannel) GetEncoding() string

Gets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The encoding %NULL makes the channel safe for binary data.

func (*IOChannel) GetFlags 

func (x *IOChannel) GetFlags() IOFlags

Gets the current flags for a #GIOChannel, including read-only flags such as %G_IO_FLAG_IS_READABLE.

The values of the flags %G_IO_FLAG_IS_READABLE and %G_IO_FLAG_IS_WRITABLE are cached for internal use by the channel when it is created. If they should change at some later point (e.g. partial shutdown of a socket with the UNIX shutdown() function), the user should immediately call g_io_channel_get_flags() to update the internal values of these flags.

func (*IOChannel) GetLineTerm 

func (x *IOChannel) GetLineTerm(LengthVar *int) string

This returns the string that #GIOChannel uses to determine where in the file a line break occurs. A value of %NULL indicates autodetection. Since 2.84, the return value is always nul-terminated.

func (*IOChannel) GoPointer 

func (x *IOChannel) GoPointer() uintptr

func (*IOChannel) Init 

func (x *IOChannel) Init()

Initializes a #GIOChannel struct.

This is called by each of the above functions when creating a #GIOChannel, and so is not often needed by the application programmer (unless you are creating a new type of #GIOChannel).

func (*IOChannel) Read 

func (x *IOChannel) Read(BufVar string, CountVar uint, BytesReadVar uint) IOError

Reads data from a #GIOChannel.

func (*IOChannel) ReadChars 

func (x *IOChannel) ReadChars(BufVar *[]byte, CountVar uint, BytesReadVar *uint) (IOStatus, error)

Replacement for g_io_channel_read() with the new API.

func (*IOChannel) ReadLine 

func (x *IOChannel) ReadLine(StrReturnVar *string, LengthVar *uint, TerminatorPosVar *uint) (IOStatus, error)

Reads a line, including the terminating character(s), from a #GIOChannel into a newly-allocated string. @str_return will contain allocated memory if the return is %G_IO_STATUS_NORMAL.

func (*IOChannel) ReadLineString 

func (x *IOChannel) ReadLineString(BufferVar *String, TerminatorPosVar uint) (IOStatus, error)

Reads a line from a #GIOChannel, using a #GString as a buffer.

func (*IOChannel) ReadToEnd 

func (x *IOChannel) ReadToEnd(StrReturnVar *[]byte, LengthVar *uint) (IOStatus, error)

Reads all the remaining data from the file.

func (*IOChannel) ReadUnichar 

func (x *IOChannel) ReadUnichar(ThecharVar *uint32) (IOStatus, error)

Reads a Unicode character from @channel. This function cannot be called on a channel with %NULL encoding.

func (*IOChannel) Ref 

func (x *IOChannel) Ref() *IOChannel

Increments the reference count of a #GIOChannel.

func (*IOChannel) Seek 

func (x *IOChannel) Seek(OffsetVar int64, TypeVar SeekType) IOError

Sets the current position in the #GIOChannel, similar to the standard library function fseek().

func (*IOChannel) SeekPosition 

func (x *IOChannel) SeekPosition(OffsetVar int64, TypeVar SeekType) (IOStatus, error)

Replacement for g_io_channel_seek() with the new API.

func (*IOChannel) SetBufferSize 

func (x *IOChannel) SetBufferSize(SizeVar uint)

Sets the buffer size.

func (*IOChannel) SetBuffered 

func (x *IOChannel) SetBuffered(BufferedVar bool)

The buffering state can only be set if the channel's encoding is %NULL. For any other encoding, the channel must be buffered.

A buffered channel can only be set unbuffered if the channel's internal buffers have been flushed. Newly created channels or channels which have returned %G_IO_STATUS_EOF not require such a flush. For write-only channels, a call to g_io_channel_flush () is sufficient. For all other channels, the buffers may be flushed by a call to g_io_channel_seek_position (). This includes the possibility of seeking with seek type %G_SEEK_CUR and an offset of zero. Note that this means that socket-based channels cannot be set unbuffered once they have had data read from them.

On unbuffered channels, it is safe to mix read and write calls from the new and old APIs, if this is necessary for maintaining old code.

The default state of the channel is buffered.

func (*IOChannel) SetCloseOnUnref 

func (x *IOChannel) SetCloseOnUnref(DoCloseVar bool)

Whether to close the channel on the final unref of the #GIOChannel data structure. The default value of this is %TRUE for channels created by g_io_channel_new_file (), and %FALSE for all other channels.

Setting this flag to %TRUE for a channel you have already closed can cause problems when the final reference to the #GIOChannel is dropped.

func (*IOChannel) SetEncoding 

func (x *IOChannel) SetEncoding(EncodingVar *string) (IOStatus, error)

Sets the encoding for the input/output of the channel. The internal encoding is always UTF-8. The default encoding for the external file is UTF-8.

The encoding %NULL is safe to use with binary data.

The encoding can only be set if one of the following conditions is true:

- The channel was just created, and has not been written to or read from yet.

- The channel is write-only.

  • The channel is a file, and the file pointer was just repositioned by a call to g_io_channel_seek_position(). (This flushes all the internal buffers.)

- The current encoding is %NULL or UTF-8.

  • One of the (new API) read functions has just returned %G_IO_STATUS_EOF (or, in the case of g_io_channel_read_to_end(), %G_IO_STATUS_NORMAL).

  • One of the functions g_io_channel_read_chars() or g_io_channel_read_unichar() has returned %G_IO_STATUS_AGAIN or %G_IO_STATUS_ERROR. This may be useful in the case of %G_CONVERT_ERROR_ILLEGAL_SEQUENCE. Returning one of these statuses from g_io_channel_read_line(), g_io_channel_read_line_string(), or g_io_channel_read_to_end() does not guarantee that the encoding can be changed.

Channels which do not meet one of the above conditions cannot call g_io_channel_seek_position() with an offset of %G_SEEK_CUR, and, if they are "seekable", cannot call g_io_channel_write_chars() after calling one of the API "read" functions.

func (*IOChannel) SetFlags 

func (x *IOChannel) SetFlags(FlagsVar IOFlags) (IOStatus, error)

Sets the (writeable) flags in @channel to (@flags &amp; %G_IO_FLAG_SET_MASK).

func (*IOChannel) SetLineTerm 

func (x *IOChannel) SetLineTerm(LineTermVar *string, LengthVar int)

This sets the string that #GIOChannel uses to determine where in the file a line break occurs.

func (*IOChannel) Shutdown 

func (x *IOChannel) Shutdown(FlushVar bool) (IOStatus, error)

Close an IO channel. Any pending data to be written will be flushed if @flush is %TRUE. The channel will not be freed until the last reference is dropped using g_io_channel_unref().

func (*IOChannel) UnixGetFd 

func (x *IOChannel) UnixGetFd() int

Returns the file descriptor of the #GIOChannel.

On Windows this function returns the file descriptor or socket of the #GIOChannel.

func (*IOChannel) Unref 

func (x *IOChannel) Unref()

Decrements the reference count of a #GIOChannel.

func (*IOChannel) Write 

func (x *IOChannel) Write(BufVar string, CountVar uint, BytesWrittenVar uint) IOError

Writes data to a #GIOChannel.

func (*IOChannel) WriteChars 

func (x *IOChannel) WriteChars(BufVar []byte, CountVar int, BytesWrittenVar *uint) (IOStatus, error)

Replacement for g_io_channel_write() with the new API.

On seekable channels with encodings other than %NULL or UTF-8, generic mixing of reading and writing is not allowed. A call to g_io_channel_write_chars () may only be made on a channel from which data has been read in the cases described in the documentation for g_io_channel_set_encoding ().

func (*IOChannel) WriteUnichar 

func (x *IOChannel) WriteUnichar(ThecharVar uint32) (IOStatus, error)

Writes a Unicode character to @channel. This function cannot be called on a channel with %NULL encoding.

type IOChannelError 

type IOChannelError int

Error codes returned by #GIOChannel operations. 

const (

	// File too large.
	GIoChannelErrorFbigValue IOChannelError = 0
	// Invalid argument.
	GIoChannelErrorInvalValue IOChannelError = 1
	// IO error.
	GIoChannelErrorIoValue IOChannelError = 2
	// File is a directory.
	GIoChannelErrorIsdirValue IOChannelError = 3
	// No space left on device.
	GIoChannelErrorNospcValue IOChannelError = 4
	// No such device or address.
	GIoChannelErrorNxioValue IOChannelError = 5
	// Value too large for defined datatype.
	GIoChannelErrorOverflowValue IOChannelError = 6
	// Broken pipe.
	GIoChannelErrorPipeValue IOChannelError = 7
	// Some other error.
	GIoChannelErrorFailedValue IOChannelError = 8
)

func IoChannelErrorFromErrno 

func IoChannelErrorFromErrno(EnVar int) IOChannelError

Converts an `errno` error number to a #GIOChannelError.

type IOCondition 

type IOCondition int

A bitwise combination representing a condition to watch for on an event source. 

const (

	// There is data to read.
	GIoInValue IOCondition = 1
	// Data can be written (without blocking).
	GIoOutValue IOCondition = 4
	// There is urgent data to read.
	GIoPriValue IOCondition = 2
	// Error condition.
	GIoErrValue IOCondition = 8
	// Hung up (the connection has been broken, usually for
	//            pipes and sockets).
	GIoHupValue IOCondition = 16
	// Invalid request. The file descriptor is not open.
	GIoNvalValue IOCondition = 32
)

type IOError 

type IOError int

#GIOError is only used by the deprecated functions g_io_channel_read(), g_io_channel_write(), and g_io_channel_seek(). 

const (

	// no error
	GIoErrorNoneValue IOError = 0
	// an EAGAIN error occurred
	GIoErrorAgainValue IOError = 1
	// an EINVAL error occurred
	GIoErrorInvalValue IOError = 2
	// another error occurred
	GIoErrorUnknownValue IOError = 3
)

type IOFlags 

type IOFlags int

Specifies properties of a #GIOChannel. Some of the flags can only be read with g_io_channel_get_flags(), but not changed with g_io_channel_set_flags(). 

const (

	// no special flags set. Since: 2.74
	GIoFlagNoneValue IOFlags = 0
	// turns on append mode, corresponds to %O_APPEND
	//     (see the documentation of the UNIX open() syscall)
	GIoFlagAppendValue IOFlags = 1
	// turns on nonblocking mode, corresponds to
	//     %O_NONBLOCK/%O_NDELAY (see the documentation of the UNIX open()
	//     syscall)
	GIoFlagNonblockValue IOFlags = 2
	// indicates that the io channel is readable.
	//     This flag cannot be changed.
	GIoFlagIsReadableValue IOFlags = 4
	// indicates that the io channel is writable.
	//     This flag cannot be changed.
	GIoFlagIsWritableValue IOFlags = 8
	// a misspelled version of @G_IO_FLAG_IS_WRITABLE
	//     that existed before the spelling was fixed in GLib 2.30. It is kept
	//     here for compatibility reasons. Deprecated since 2.30
	GIoFlagIsWriteableValue IOFlags = 8
	// indicates that the io channel is seekable,
	//     i.e. that g_io_channel_seek_position() can be used on it.
	//     This flag cannot be changed.
	GIoFlagIsSeekableValue IOFlags = 16
	// the mask that specifies all the valid flags.
	GIoFlagMaskValue IOFlags = 31
	// the mask of the flags that are returned from
	//     g_io_channel_get_flags()
	GIoFlagGetMaskValue IOFlags = 31
	// the mask of the flags that the user can modify
	//     with g_io_channel_set_flags()
	GIoFlagSetMaskValue IOFlags = 3
)

type IOFunc 

type IOFunc func(*IOChannel, IOCondition, uintptr) bool

Specifies the type of function passed to g_io_add_watch() or g_io_add_watch_full(), which is called when the requested condition on a #GIOChannel is satisfied.

type IOFuncs 

type IOFuncs struct {
	// contains filtered or unexported fields
}

A table of functions used to handle different types of #GIOChannel in a generic way.

func (*IOFuncs) GetIoClose 

func (x *IOFuncs) GetIoClose() func(*IOChannel) IOStatus

GetIoClose gets the "io_close" callback function. closes the channel. This is called from 

g_io_channel_close() after flushing the buffers.

func (*IOFuncs) GetIoCreateWatch 

func (x *IOFuncs) GetIoCreateWatch() func(*IOChannel, IOCondition) *Source

GetIoCreateWatch gets the "io_create_watch" callback function. creates a watch on the channel. This call 

corresponds directly to g_io_create_watch().

func (*IOFuncs) GetIoFree 

func (x *IOFuncs) GetIoFree() func(*IOChannel)

GetIoFree gets the "io_free" callback function. called from g_io_channel_unref() when the channel needs to 

be freed.  This function must free the memory associated
with the channel, including freeing the #GIOChannel
structure itself.  The channel buffers have been flushed
and possibly @io_close has been called by the time this
function is called.

func (*IOFuncs) GetIoGetFlags 

func (x *IOFuncs) GetIoGetFlags() func(*IOChannel) IOFlags

GetIoGetFlags gets the "io_get_flags" callback function. gets the #GIOFlags for the channel. This function 

need only return the %G_IO_FLAG_APPEND and
%G_IO_FLAG_NONBLOCK flags; g_io_channel_get_flags()
automatically adds the others as appropriate.

func (*IOFuncs) GetIoRead 

func (x *IOFuncs) GetIoRead() func(*IOChannel, string, uint, uint) IOStatus

GetIoRead gets the "io_read" callback function. reads raw bytes from the channel. This is called from 

various functions such as g_io_channel_read_chars() to
read raw bytes from the channel.  Encoding and buffering
issues are dealt with at a higher level.

func (*IOFuncs) GetIoSeek 

func (x *IOFuncs) GetIoSeek() func(*IOChannel, int64, SeekType) IOStatus

GetIoSeek gets the "io_seek" callback function. seeks the channel. This is called from 

g_io_channel_seek() on channels that support it.

func (*IOFuncs) GetIoSetFlags 

func (x *IOFuncs) GetIoSetFlags() func(*IOChannel, IOFlags) IOStatus

GetIoSetFlags gets the "io_set_flags" callback function. sets the #GIOFlags on the channel. This is called 

from g_io_channel_set_flags() with all flags except
for %G_IO_FLAG_APPEND and %G_IO_FLAG_NONBLOCK masked
out.

func (*IOFuncs) GetIoWrite 

func (x *IOFuncs) GetIoWrite() func(*IOChannel, string, uint, uint) IOStatus

GetIoWrite gets the "io_write" callback function. writes raw bytes to the channel. This is called from 

various functions such as g_io_channel_write_chars() to
write raw bytes to the channel.  Encoding and buffering
issues are dealt with at a higher level.

func (*IOFuncs) GoPointer 

func (x *IOFuncs) GoPointer() uintptr

func (*IOFuncs) OverrideIoClose 

func (x *IOFuncs) OverrideIoClose(cb func(*IOChannel) IOStatus)

OverrideIoClose sets the "io_close" callback function. closes the channel. This is called from 

g_io_channel_close() after flushing the buffers.

func (*IOFuncs) OverrideIoCreateWatch 

func (x *IOFuncs) OverrideIoCreateWatch(cb func(*IOChannel, IOCondition) *Source)

OverrideIoCreateWatch sets the "io_create_watch" callback function. creates a watch on the channel. This call 

corresponds directly to g_io_create_watch().

func (*IOFuncs) OverrideIoFree 

func (x *IOFuncs) OverrideIoFree(cb func(*IOChannel))

OverrideIoFree sets the "io_free" callback function. called from g_io_channel_unref() when the channel needs to 

be freed.  This function must free the memory associated
with the channel, including freeing the #GIOChannel
structure itself.  The channel buffers have been flushed
and possibly @io_close has been called by the time this
function is called.

func (*IOFuncs) OverrideIoGetFlags 

func (x *IOFuncs) OverrideIoGetFlags(cb func(*IOChannel) IOFlags)

OverrideIoGetFlags sets the "io_get_flags" callback function. gets the #GIOFlags for the channel. This function 

need only return the %G_IO_FLAG_APPEND and
%G_IO_FLAG_NONBLOCK flags; g_io_channel_get_flags()
automatically adds the others as appropriate.

func (*IOFuncs) OverrideIoRead 

func (x *IOFuncs) OverrideIoRead(cb func(*IOChannel, string, uint, uint) IOStatus)

OverrideIoRead sets the "io_read" callback function. reads raw bytes from the channel. This is called from 

various functions such as g_io_channel_read_chars() to
read raw bytes from the channel.  Encoding and buffering
issues are dealt with at a higher level.

func (*IOFuncs) OverrideIoSeek 

func (x *IOFuncs) OverrideIoSeek(cb func(*IOChannel, int64, SeekType) IOStatus)

OverrideIoSeek sets the "io_seek" callback function. seeks the channel. This is called from 

g_io_channel_seek() on channels that support it.

func (*IOFuncs) OverrideIoSetFlags 

func (x *IOFuncs) OverrideIoSetFlags(cb func(*IOChannel, IOFlags) IOStatus)

OverrideIoSetFlags sets the "io_set_flags" callback function. sets the #GIOFlags on the channel. This is called 

from g_io_channel_set_flags() with all flags except
for %G_IO_FLAG_APPEND and %G_IO_FLAG_NONBLOCK masked
out.

func (*IOFuncs) OverrideIoWrite 

func (x *IOFuncs) OverrideIoWrite(cb func(*IOChannel, string, uint, uint) IOStatus)

OverrideIoWrite sets the "io_write" callback function. writes raw bytes to the channel. This is called from 

various functions such as g_io_channel_write_chars() to
write raw bytes to the channel.  Encoding and buffering
issues are dealt with at a higher level.

type IOStatus 

type IOStatus int

Statuses returned by most of the #GIOFuncs functions. 

const (

	// An error occurred.
	GIoStatusErrorValue IOStatus = 0
	// Success.
	GIoStatusNormalValue IOStatus = 1
	// End of file.
	GIoStatusEofValue IOStatus = 2
	// Resource temporarily unavailable.
	GIoStatusAgainValue IOStatus = 3
)

type KeyFile 

type KeyFile struct {
	// contains filtered or unexported fields
}

`GKeyFile` parses .ini-like config files.

`GKeyFile` lets you parse, edit or create files containing groups of key-value pairs, which we call ‘key files’ for lack of a better name. Several freedesktop.org specifications use key files. For example, the [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/) and the [Icon Theme Specification](https://specifications.freedesktop.org/icon-theme-spec/latest/).

The syntax of key files is described in detail in the [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/), here is a quick summary: Key files consists of groups of key-value pairs, interspersed with comments.

```txt # this is just an example # there can be comments before the first group

[First Group]

Name=Key File Example\tthis value shows\nescaping

# localized strings are stored in multiple key-value pairs Welcome=Hello Welcome[de]=Hallo Welcome[fr_FR]=Bonjour Welcome[it]=Ciao

[Another Group]

Numbers=2;20;-200;0

Booleans=true;false;true;true ```

Lines beginning with a `#` and blank lines are considered comments.

Groups are started by a header line containing the group name enclosed in `[` and `]`, and ended implicitly by the start of the next group or the end of the file. Each key-value pair must be contained in a group.

Key-value pairs generally have the form `key=value`, with the exception of localized strings, which have the form `key[locale]=value`, with a locale identifier of the form `lang_COUNTRY@MODIFIER` where `COUNTRY` and `MODIFIER` are optional. As a special case, the locale `C` is associated with the untranslated pair `key=value` (since GLib 2.84). Space before and after the `=` character is ignored. Newline, tab, carriage return and backslash characters in value are escaped as `\n`, `\t`, `\r`, and `\\\\`, respectively. To preserve leading spaces in values, these can also be escaped as `\s`.

Key files can store strings (possibly with localized variants), integers, booleans and lists of these. Lists are separated by a separator character, typically `;` or `,`. To use the list separator character in a value in a list, it has to be escaped by prefixing it with a backslash.

This syntax is obviously inspired by the .ini files commonly met on Windows, but there are some important differences:

  • .ini files use the `;` character to begin comments, key files use the `#` character.

  • Key files do not allow for ungrouped keys meaning only comments can precede the first group.

- Key files are always encoded in UTF-8.

  • Key and Group names are case-sensitive. For example, a group called `[GROUP]` is a different from `[group]`.

  • .ini files don’t have a strongly typed boolean entry type, they only have `GetProfileInt()`. In key files, only `true` and `false` (in lower case) are allowed.

Note that in contrast to the [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/), groups in key files may contain the same key multiple times; the last entry wins. Key files may also contain multiple groups with the same name; they are merged together. Another difference is that keys and group names in key files are not restricted to ASCII characters.

Here is an example of loading a key file and reading a value:

```c g_autoptr(GError) error = NULL; g_autoptr(GKeyFile) key_file = g_key_file_new ();

if (!g_key_file_load_from_file (key_file, "key-file.ini", flags, &amp;error)) 

{
  if (!g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT))
    g_warning ("Error loading key file: %s", error-&gt;message);
  return;
}

g_autofree gchar *val = g_key_file_get_string (key_file, "Group Name", "SomeKey", &amp;error); if (val == NULL &amp;&amp; 

  !g_error_matches (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND))
{
  g_warning ("Error finding key in key file: %s", error-&gt;message);
  return;
}

else if (val == NULL) 

{
  // Fall back to a default value.
  val = g_strdup ("default-value");
}

```

Here is an example of creating and saving a key file:

```c g_autoptr(GKeyFile) key_file = g_key_file_new (); const gchar *val = …; g_autoptr(GError) error = NULL;

g_key_file_set_string (key_file, "Group Name", "SomeKey", val);

// Save as a file. if (!g_key_file_save_to_file (key_file, "key-file.ini", &amp;error)) 

{
  g_warning ("Error saving key file: %s", error-&gt;message);
  return;
}

// Or store to a GBytes for use elsewhere. gsize data_len; g_autofree guint8 *data = (guint8 *) g_key_file_to_data (key_file, &amp;data_len, &amp;error); if (data == NULL) 

{
  g_warning ("Error saving key file: %s", error-&gt;message);
  return;
}

g_autoptr(GBytes) bytes = g_bytes_new_take (g_steal_pointer (&amp;data), data_len); ```

func NewKeyFile 

func NewKeyFile() *KeyFile

Creates a new empty [struct@GLib.KeyFile] object.

Use [method@GLib.KeyFile.load_from_file], [method@GLib.KeyFile.load_from_data], [method@GLib.KeyFile.load_from_dirs] or [method@GLib.KeyFile.load_from_data_dirs] to read an existing key file.

func (*KeyFile) Free 

func (x *KeyFile) Free()

Clears all keys and groups from @key_file, and decreases the reference count by 1.

If the reference count reaches zero, frees the key file and all its allocated memory.

func (*KeyFile) GetBoolean 

func (x *KeyFile) GetBoolean(GroupNameVar string, KeyVar string) (bool, error)

Returns the value associated with @key under @group_name as a boolean.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. Likewise, if the value associated with @key cannot be interpreted as a boolean then [error@GLib.KeyFileError.INVALID_VALUE] is returned.

func (*KeyFile) GetBooleanList 

func (x *KeyFile) GetBooleanList(GroupNameVar string, KeyVar string, LengthVar *uint) (uintptr, error)

Returns the values associated with @key under @group_name as booleans.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. Likewise, if the values associated with @key cannot be interpreted as booleans then [error@GLib.KeyFileError.INVALID_VALUE] is returned.

func (*KeyFile) GetComment 

func (x *KeyFile) GetComment(GroupNameVar *string, KeyVar *string) (string, error)

Retrieves a comment above @key from @group_name.

If @key is `NULL` then @comment will be read from above @group_name. If both @key and @group_name are `NULL`, then @comment will be read from above the first group in the file.

Note that the returned string does not include the `#` comment markers, but does include any whitespace after them (on each line). It includes the line breaks between lines, but does not include the final line break.

func (*KeyFile) GetDouble 

func (x *KeyFile) GetDouble(GroupNameVar string, KeyVar string) (float64, error)

Returns the value associated with @key under @group_name as a double.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. Likewise, if the value associated with @key cannot be interpreted as a double then [error@GLib.KeyFileError.INVALID_VALUE] is returned.

func (*KeyFile) GetDoubleList 

func (x *KeyFile) GetDoubleList(GroupNameVar string, KeyVar string, LengthVar *uint) (uintptr, error)

Returns the values associated with @key under @group_name as doubles.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. Likewise, if the values associated with @key cannot be interpreted as doubles then [error@GLib.KeyFileError.INVALID_VALUE] is returned.

func (*KeyFile) GetGroups 

func (x *KeyFile) GetGroups(LengthVar *uint) []string

Returns all groups in the key file loaded with @key_file.

The array of returned groups will be `NULL`-terminated, so @length may optionally be `NULL`.

func (*KeyFile) GetInt64 

func (x *KeyFile) GetInt64(GroupNameVar string, KeyVar string) (int64, error)

Returns the value associated with @key under @group_name as a signed 64-bit integer.

This is similar to [method@GLib.KeyFile.get_integer] but can return 64-bit results without truncation.

func (*KeyFile) GetInteger 

func (x *KeyFile) GetInteger(GroupNameVar string, KeyVar string) (int, error)

Returns the value associated with @key under @group_name as an integer.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. Likewise, if the value associated with @key cannot be interpreted as an integer, or is out of range for a `gint`, then [error@GLib.KeyFileError.INVALID_VALUE] is returned.

func (*KeyFile) GetIntegerList 

func (x *KeyFile) GetIntegerList(GroupNameVar string, KeyVar string, LengthVar *uint) (uintptr, error)

Returns the values associated with @key under @group_name as integers.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. Likewise, if the values associated with @key cannot be interpreted as integers, or are out of range for `gint`, then [error@GLib.KeyFileError.INVALID_VALUE] is returned.

func (*KeyFile) GetKeys 

func (x *KeyFile) GetKeys(GroupNameVar string, LengthVar *uint) ([]string, error)

Returns all keys for the group name @group_name.

The array of returned keys will be `NULL`-terminated, so @length may optionally be `NULL`. If the @group_name cannot be found, [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.

func (*KeyFile) GetLocaleForKey 

func (x *KeyFile) GetLocaleForKey(GroupNameVar string, KeyVar string, LocaleVar *string) string

Returns the actual locale which the result of [method@GLib.KeyFile.get_locale_string] or [method@GLib.KeyFile.get_locale_string_list] came from.

If calling [method@GLib.KeyFile.get_locale_string] or [method@GLib.KeyFile.get_locale_string_list] with exactly the same @key_file, @group_name, @key and @locale, the result of those functions will have originally been tagged with the locale that is the result of this function.

func (*KeyFile) GetLocaleString 

func (x *KeyFile) GetLocaleString(GroupNameVar string, KeyVar string, LocaleVar *string) (string, error)

Returns the value associated with @key under @group_name translated in the given @locale if available.

If @locale is `C` then the untranslated value is returned (since GLib 2.84).

If @locale is `NULL` then the current locale is assumed.

If @locale is to be non-`NULL`, or if the current locale will change over the lifetime of the [struct@GLib.KeyFile], it must be loaded with [flags@GLib.KeyFileFlags.KEEP_TRANSLATIONS] in order to load strings for all locales.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. If the value associated with @key cannot be interpreted or no suitable translation can be found then the untranslated value is returned.

func (*KeyFile) GetLocaleStringList 

func (x *KeyFile) GetLocaleStringList(GroupNameVar string, KeyVar string, LocaleVar *string, LengthVar *uint) ([]string, error)

Returns the values associated with @key under @group_name translated in the given @locale if available.

If @locale is `C` then the untranslated value is returned (since GLib 2.84).

If @locale is `NULL` then the current locale is assumed.

If @locale is to be non-`NULL`, or if the current locale will change over the lifetime of the [struct@GLib.KeyFile], it must be loaded with [flags@GLib.KeyFileFlags.KEEP_TRANSLATIONS] in order to load strings for all locales.

If @key cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. If the values associated with @key cannot be interpreted or no suitable translations can be found then the untranslated values are returned. The returned array is `NULL`-terminated, so @length may optionally be `NULL`.

func (*KeyFile) GetStartGroup 

func (x *KeyFile) GetStartGroup() string

Returns the name of the start group of the file.

func (*KeyFile) GetString 

func (x *KeyFile) GetString(GroupNameVar string, KeyVar string) (string, error)

Returns the string value associated with @key under @group_name.

Unlike [method@GLib.KeyFile.get_value], this function handles escape sequences like `\s`.

If the key cannot be found, [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. If the @group_name cannot be found, [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.

func (*KeyFile) GetStringList 

func (x *KeyFile) GetStringList(GroupNameVar string, KeyVar string, LengthVar *uint) ([]string, error)

Returns the values associated with @key under @group_name.

If the key cannot be found, [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. If the @group_name cannot be found, [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.

func (*KeyFile) GetUint64 

func (x *KeyFile) GetUint64(GroupNameVar string, KeyVar string) (uint64, error)

Returns the value associated with @key under @group_name as an unsigned 64-bit integer.

This is similar to [method@GLib.KeyFile.get_integer] but can return large positive results without truncation.

func (*KeyFile) GetValue 

func (x *KeyFile) GetValue(GroupNameVar string, KeyVar string) (string, error)

Returns the raw value associated with @key under @group_name.

Use [method@GLib.KeyFile.get_string] to retrieve an unescaped UTF-8 string.

If the key cannot be found, [error@GLib.KeyFileError.KEY_NOT_FOUND] is returned. If the @group_name cannot be found, [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.

func (*KeyFile) GoPointer 

func (x *KeyFile) GoPointer() uintptr

func (*KeyFile) HasGroup 

func (x *KeyFile) HasGroup(GroupNameVar string) bool

Looks whether the key file has the group @group_name.

func (*KeyFile) HasKey 

func (x *KeyFile) HasKey(GroupNameVar string, KeyVar string) (bool, error)

Looks whether the key file has the key @key in the group @group_name.

Note that this function does not follow the rules for [struct@GLib.Error] strictly; the return value both carries meaning and signals an error. To use this function, you must pass a [struct@GLib.Error] pointer in @error, and check whether it is not `NULL` to see if an error occurred.

Language bindings should use [method@GLib.KeyFile.get_value] to test whether a key exists.

func (*KeyFile) LoadFromBytes 

func (x *KeyFile) LoadFromBytes(BytesVar *Bytes, FlagsVar KeyFileFlags) (bool, error)

Loads a key file from the data in @bytes into an empty [struct@GLib.KeyFile] structure.

If the object cannot be created then a [error@GLib.KeyFileError] is returned.

func (*KeyFile) LoadFromData 

func (x *KeyFile) LoadFromData(DataVar string, LengthVar uint, FlagsVar KeyFileFlags) (bool, error)

Loads a key file from memory into an empty [struct@GLib.KeyFile] structure.

If the object cannot be created then a [error@GLib.KeyFileError is returned.

func (*KeyFile) LoadFromDataDirs 

func (x *KeyFile) LoadFromDataDirs(FileVar string, FullPathVar *string, FlagsVar KeyFileFlags) (bool, error)

Looks for a key file named @file in the paths returned from [func@GLib.get_user_data_dir] and [func@GLib.get_system_data_dirs].

The search algorithm from [method@GLib.KeyFile.load_from_dirs] is used. If @file is found, it’s loaded into @key_file and its full path is returned in @full_path.

If the file could not be loaded then either a [error@GLib.FileError] or [error@GLib.KeyFileError] is returned.

func (*KeyFile) LoadFromDirs 

func (x *KeyFile) LoadFromDirs(FileVar string, SearchDirsVar []string, FullPathVar *string, FlagsVar KeyFileFlags) (bool, error)

Looks for a key file named @file in the paths specified in @search_dirs, loads the file into @key_file and returns the file’s full path in @full_path.

@search_dirs are checked in the order listed in the array, with the highest priority directory listed first. Within each directory, @file is looked for. If it’s not found, `-` characters in @file are progressively replaced with directory separators to search subdirectories of the search directory. If the file has not been found after all `-` characters have been replaced, the next search directory in @search_dirs is checked.

If the file could not be found in any of the @search_dirs, [error@GLib.KeyFileError.NOT_FOUND] is returned. If the file is found but the OS returns an error when opening or reading the file, a [error@GLib.FileError] is returned. If there is a problem parsing the file, a [error@GLib.KeyFileError] is returned.

func (*KeyFile) LoadFromFile 

func (x *KeyFile) LoadFromFile(FileVar string, FlagsVar KeyFileFlags) (bool, error)

Loads a key file into an empty [struct@GLib.KeyFile] structure.

If the OS returns an error when opening or reading the file, a [error@GLib.FileError] is returned. If there is a problem parsing the file, a [error@GLib.KeyFileError] is returned.

This function will never return a [error@GLib.KeyFileError.NOT_FOUND] error. If the @file is not found, [error@GLib.FileError.NOENT] is returned.

func (*KeyFile) Ref 

func (x *KeyFile) Ref() *KeyFile

Increases the reference count of @key_file.

func (*KeyFile) RemoveComment 

func (x *KeyFile) RemoveComment(GroupNameVar *string, KeyVar *string) (bool, error)

Removes a comment above @key from @group_name.

If @key is `NULL` then @comment will be removed above @group_name. If both @key and @group_name are `NULL`, then @comment will be removed above the first group in the file.

func (*KeyFile) RemoveGroup 

func (x *KeyFile) RemoveGroup(GroupNameVar string) (bool, error)

Removes the specified group, @group_name, from the key file.

func (*KeyFile) RemoveKey 

func (x *KeyFile) RemoveKey(GroupNameVar string, KeyVar string) (bool, error)

Removes @key in @group_name from the key file.

func (*KeyFile) SaveToFile 

func (x *KeyFile) SaveToFile(FilenameVar string) (bool, error)

Writes the contents of @key_file to @filename using [func@GLib.file_set_contents].

If you need stricter guarantees about durability of the written file than are provided by [func@GLib.file_set_contents], use [func@GLib.file_set_contents_full] with the return value of [method@GLib.KeyFile.to_data].

This function can fail for any of the reasons that [func@GLib.file_set_contents] may fail.

func (*KeyFile) SetBoolean 

func (x *KeyFile) SetBoolean(GroupNameVar string, KeyVar string, ValueVar bool)

Associates a new boolean value with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetBooleanList 

func (x *KeyFile) SetBooleanList(GroupNameVar string, KeyVar string, ListVar []bool, LengthVar uint)

Associates a list of boolean values with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetComment 

func (x *KeyFile) SetComment(GroupNameVar *string, KeyVar *string, CommentVar string) (bool, error)

Places a comment above @key from @group_name.

If @key is `NULL` then @comment will be written above @group_name. If both @key and @group_name are `NULL`, then @comment will be written above the first group in the file.

Passing a non-existent @group_name or @key to this function returns false and populates @error. (In contrast, passing a non-existent `group_name` or `key` to [method@GLib.KeyFile.set_string] creates the associated group name and key.)

Note that this function prepends a `#` comment marker to each line of @comment.

func (*KeyFile) SetDouble 

func (x *KeyFile) SetDouble(GroupNameVar string, KeyVar string, ValueVar float64)

Associates a new double value with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetDoubleList 

func (x *KeyFile) SetDoubleList(GroupNameVar string, KeyVar string, ListVar []float64, LengthVar uint)

Associates a list of double values with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetInt64 

func (x *KeyFile) SetInt64(GroupNameVar string, KeyVar string, ValueVar int64)

Associates a new integer value with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetInteger 

func (x *KeyFile) SetInteger(GroupNameVar string, KeyVar string, ValueVar int)

Associates a new integer value with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetIntegerList 

func (x *KeyFile) SetIntegerList(GroupNameVar string, KeyVar string, ListVar []int, LengthVar uint)

Associates a list of integer values with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetListSeparator 

func (x *KeyFile) SetListSeparator(SeparatorVar byte)

Sets the character which is used to separate values in lists.

Typically `;` or `,` are used as separators. The default list separator is `;`.

func (*KeyFile) SetLocaleString 

func (x *KeyFile) SetLocaleString(GroupNameVar string, KeyVar string, LocaleVar string, StringVar string)

Associates a string value for @key and @locale under @group_name.

If the translation for @key cannot be found then it is created.

If @locale is `C` then the untranslated value is set (since GLib 2.84).

func (*KeyFile) SetLocaleStringList 

func (x *KeyFile) SetLocaleStringList(GroupNameVar string, KeyVar string, LocaleVar string, ListVar []string, LengthVar uint)

Associates a list of string values for @key and @locale under @group_name.

If @locale is `C` then the untranslated value is set (since GLib 2.84).

If the translation for @key cannot be found then it is created.

func (*KeyFile) SetString 

func (x *KeyFile) SetString(GroupNameVar string, KeyVar string, StringVar string)

Associates a new string value with @key under @group_name.

If @key cannot be found then it is created. If @group_name cannot be found then it is created. Unlike [method@GLib.KeyFile.set_value], this function handles characters that need escaping, such as newlines.

func (*KeyFile) SetStringList 

func (x *KeyFile) SetStringList(GroupNameVar string, KeyVar string, ListVar []string, LengthVar uint)

Associates a list of string values for @key under @group_name.

If @key cannot be found then it is created. If @group_name cannot be found then it is created.

func (*KeyFile) SetUint64 

func (x *KeyFile) SetUint64(GroupNameVar string, KeyVar string, ValueVar uint64)

Associates a new integer value with @key under @group_name.

If @key cannot be found then it is created.

func (*KeyFile) SetValue 

func (x *KeyFile) SetValue(GroupNameVar string, KeyVar string, ValueVar string)

Associates a new value with @key under @group_name.

If @key cannot be found then it is created. If @group_name cannot be found then it is created. To set an UTF-8 string which may contain characters that need escaping (such as newlines or spaces), use [method@GLib.KeyFile.set_string].

func (*KeyFile) ToData 

func (x *KeyFile) ToData(LengthVar *uint) (string, error)

Outputs @key_file as a string.

Note that this function never reports an error.

func (*KeyFile) Unref 

func (x *KeyFile) Unref()

Decreases the reference count of @key_file by 1.

If the reference count reaches zero, frees the key file and all its allocated memory.

type KeyFileError 

type KeyFileError int

Error codes returned by key file parsing. 

const (

	// the text being parsed was in
	//   an unknown encoding
	GKeyFileErrorUnknownEncodingValue KeyFileError = 0
	// document was ill-formed
	GKeyFileErrorParseValue KeyFileError = 1
	// the file was not found
	GKeyFileErrorNotFoundValue KeyFileError = 2
	// a requested key was not found
	GKeyFileErrorKeyNotFoundValue KeyFileError = 3
	// a requested group was not found
	GKeyFileErrorGroupNotFoundValue KeyFileError = 4
	// a value could not be parsed
	GKeyFileErrorInvalidValueValue KeyFileError = 5
)

type KeyFileFlags 

type KeyFileFlags int

Flags which influence the parsing. 

const (

	// No flags, default behaviour
	GKeyFileNoneValue KeyFileFlags = 0
	// Use this flag if you plan to write the
	//   (possibly modified) contents of the key file back to a file;
	//   otherwise all comments will be lost when the key file is
	//   written back.
	GKeyFileKeepCommentsValue KeyFileFlags = 1
	// Use this flag if you plan to write the
	//   (possibly modified) contents of the key file back to a file;
	//   otherwise only the translations for the current language will be
	//   written back.
	GKeyFileKeepTranslationsValue KeyFileFlags = 2
)

type List 

type List struct {
	Data uintptr

	Next *List

	Prev *List
	// contains filtered or unexported fields
}

The #GList struct is used for each element in a doubly-linked list.

func (*List) GoPointer 

func (x *List) GoPointer() uintptr

type LogField 

type LogField struct {
	Key uintptr

	Value uintptr

	Length int
	// contains filtered or unexported fields
}

Structure representing a single field in a structured log entry. See g_log_structured() for details.

Log fields may contain arbitrary values, including binary with embedded nul bytes. If the field contains a string, the string must be UTF-8 encoded and have a trailing nul byte. Otherwise, @length must be set to a non-negative value.

func (*LogField) GoPointer 

func (x *LogField) GoPointer() uintptr

type LogFunc 

type LogFunc func(string, LogLevelFlags, string, uintptr)

Specifies the prototype of log handler functions.

The default log handler, [func@GLib.log_default_handler], automatically appends a new-line character to @message when printing it. It is advised that any custom log handler functions behave similarly, so that logging calls in user code do not need modifying to add a new-line character to the message if the log handler is changed.

The `log_domain` parameter can be set to `NULL` or an empty string to use the default application domain.

This is not used if structured logging is enabled; see [Using Structured Logging](logging.html#using-structured-logging).

type LogLevelFlags 

type LogLevelFlags int

Flags specifying the level of log messages.

It is possible to change how GLib treats messages of the various levels using [func@GLib.log_set_handler] and [func@GLib.log_set_fatal_mask]. 

const (

	// internal flag
	GLogFlagRecursionValue LogLevelFlags = 1
	// internal flag
	GLogFlagFatalValue LogLevelFlags = 2
	// log level for errors, see [func@GLib.error].
	//   This level is also used for messages produced by [func@GLib.assert].
	GLogLevelErrorValue LogLevelFlags = 4
	// log level for critical warning messages, see
	//   [func@GLib.critical]. This level is also used for messages produced by
	//   [func@GLib.return_if_fail] and [func@GLib.return_val_if_fail].
	GLogLevelCriticalValue LogLevelFlags = 8
	// log level for warnings, see [func@GLib.warning]
	GLogLevelWarningValue LogLevelFlags = 16
	// log level for messages, see [func@GLib.message]
	GLogLevelMessageValue LogLevelFlags = 32
	// log level for informational messages, see [func@GLib.info]
	GLogLevelInfoValue LogLevelFlags = 64
	// log level for debug messages, see [func@GLib.debug]
	GLogLevelDebugValue LogLevelFlags = 128
	// a mask including all log levels
	GLogLevelMaskValue LogLevelFlags = -4
)

func LogGetAlwaysFatal 

func LogGetAlwaysFatal() LogLevelFlags

Gets the current fatal mask.

This is mostly used by custom log writers to make fatal messages (`fatal-warnings`, `fatal-criticals`) work as expected, when using the `G_DEBUG` environment variable (see [Running GLib Applications](running.html)).

An example usage is shown below:

```c static GLogWriterOutput my_custom_log_writer_fn (GLogLevelFlags log_level, 

const GLogField *fields,
gsize n_fields,
gpointer user_data)

{ 

   // abort if the message was fatal
   if (log_level &amp; g_log_get_always_fatal ())
     g_abort ();

   // custom log handling code
   ...
   ...

   // success
   return G_LOG_WRITER_HANDLED;
}

```

func LogSetAlwaysFatal 

func LogSetAlwaysFatal(FatalMaskVar LogLevelFlags) LogLevelFlags

Sets the message levels which are always fatal, in any log domain.

When a message with any of these levels is logged the program terminates. You can only set the levels defined by GLib to be fatal. [flags@GLib.LogLevelFlags.LEVEL_ERROR] is always fatal.

You can also make some message levels fatal at runtime by setting the `G_DEBUG` environment variable (see [Running GLib Applications](running.html)).

Libraries should not call this function, as it affects all messages logged by a process, including those from other libraries.

Structured log messages (using [func@GLib.log_structured] and [func@GLib.log_structured_array]) are fatal only if the default log writer is used; otherwise it is up to the writer function to determine which log messages are fatal. See [Using Structured Logging](logging.html#using-structured-logging).

func LogSetFatalMask 

func LogSetFatalMask(LogDomainVar string, FatalMaskVar LogLevelFlags) LogLevelFlags

Sets the log levels which are fatal in the given domain.

[flags@GLib.LogLevelFlags.LEVEL_ERROR] is always fatal.

This has no effect on structured log messages (using [func@GLib.log_structured] or [func@GLib.log_structured_array]). To change the fatal behaviour for specific log messages, programs must install a custom log writer function using [func@GLib.log_set_writer_func]. See [Using Structured Logging](logging.html#using-structured-logging).

This function is mostly intended to be used with [flags@GLib.LogLevelFlags.LEVEL_CRITICAL]. You should typically not set [flags@GLib.LogLevelFlags.LEVEL_WARNING], [flags@GLib.LogLevelFlags.LEVEL_MESSAGE], [flags@GLib.LogLevelFlags.LEVEL_INFO] or [flags@GLib.LogLevelFlags.LEVEL_DEBUG] as fatal except inside of test programs.

type LogWriterFunc 

type LogWriterFunc func(LogLevelFlags, []LogField, uint, uintptr) LogWriterOutput

Writer function for log entries. A log entry is a collection of one or more #GLogFields, using the standard [field names from journal specification](https://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html). See g_log_structured() for more information.

Writer functions must ignore fields which they do not recognise, unless they can write arbitrary binary output, as field values may be arbitrary binary.

@log_level is guaranteed to be included in @fields as the `PRIORITY` field, but is provided separately for convenience of deciding whether or where to output the log entry.

Writer functions should return %G_LOG_WRITER_HANDLED if they handled the log message successfully or if they deliberately ignored it. If there was an error handling the message (for example, if the writer function is meant to send messages to a remote logging server and there is a network error), it should return %G_LOG_WRITER_UNHANDLED. This allows writer functions to be chained and fall back to simpler handlers in case of failure.

type LogWriterOutput 

type LogWriterOutput int

Return values from #GLogWriterFuncs to indicate whether the given log entry was successfully handled by the writer, or whether there was an error in handling it (and hence a fallback writer should be used).

If a #GLogWriterFunc ignores a log entry, it should return %G_LOG_WRITER_HANDLED. 

const (

	// Log writer has handled the log entry.
	GLogWriterHandledValue LogWriterOutput = 1
	// Log writer could not handle the log entry.
	GLogWriterUnhandledValue LogWriterOutput = 0
)

func LogWriterDefault 

func LogWriterDefault(LogLevelVar LogLevelFlags, FieldsVar []LogField, NFieldsVar uint, UserDataVar uintptr) LogWriterOutput

Format a structured log message and output it to the default log destination for the platform.

On Linux, this is typically the systemd journal, falling back to `stdout` or `stderr` if running from the terminal or if output is being redirected to a file.

Support for other platform-specific logging mechanisms may be added in future. Distributors of GLib may modify this function to impose their own (documented) platform-specific log writing policies.

This is suitable for use as a [type@GLib.LogWriterFunc], and is the default writer used if no other is set using [func@GLib.log_set_writer_func].

As with [func@GLib.log_default_handler], this function drops debug and informational messages unless their log domain (or `all`) is listed in the space-separated `G_MESSAGES_DEBUG` environment variable, or `DEBUG_INVOCATION=1` is set in the environment, or set at runtime by [func@GLib.log_writer_default_set_debug_domains].

[func@GLib.log_writer_default] uses the mask set by [func@GLib.log_set_always_fatal] to determine which messages are fatal. When using a custom writer function instead it is up to the writer function to determine which log messages are fatal.

func LogWriterJournald 

func LogWriterJournald(LogLevelVar LogLevelFlags, FieldsVar []LogField, NFieldsVar uint, UserDataVar uintptr) LogWriterOutput

Format a structured log message and send it to the systemd journal as a set of key–value pairs.

All fields are sent to the journal, but if a field has length zero (indicating program-specific data) then only its key will be sent.

This is suitable for use as a [type@GLib.LogWriterFunc].

If GLib has been compiled without systemd support, this function is still defined, but will always return [enum@GLib.LogWriterOutput.UNHANDLED].

func LogWriterStandardStreams 

func LogWriterStandardStreams(LogLevelVar LogLevelFlags, FieldsVar []LogField, NFieldsVar uint, UserDataVar uintptr) LogWriterOutput

Format a structured log message and print it to either `stdout` or `stderr`, depending on its log level.

[flags@GLib.LogLevelFlags.LEVEL_INFO] and [flags@GLib.LogLevelFlags.LEVEL_DEBUG] messages are sent to `stdout`, or to `stderr` if requested by [func@GLib.log_writer_default_set_use_stderr]; all other log levels are sent to `stderr`. Only fields which are understood by this function are included in the formatted string which is printed.

If the output stream supports [ANSI color escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code), they will be used in the output.

A trailing new-line character is added to the log message when it is printed.

This is suitable for use as a [type@GLib.LogWriterFunc].

func LogWriterSyslog 

func LogWriterSyslog(LogLevelVar LogLevelFlags, FieldsVar []LogField, NFieldsVar uint, UserDataVar uintptr) LogWriterOutput

Format a structured log message and send it to the syslog daemon. Only fields which are understood by this function are included in the formatted string which is printed.

Log facility will be defined via the SYSLOG_FACILITY field and accepts the following values: "auth", "daemon", and "user". If SYSLOG_FACILITY is not specified, LOG_USER facility will be used.

This is suitable for use as a [type@GLib.LogWriterFunc].

If syslog is not supported, this function is still defined, but will always return [enum@GLib.LogWriterOutput.UNHANDLED].

type MainContext 

type MainContext struct {
	// contains filtered or unexported fields
}

The `GMainContext` struct is an opaque data type representing a set of sources to be handled in a main loop.

func MainContextDefault 

func MainContextDefault() *MainContext

Returns the global-default main context.

This is the main context used for main loop functions when a main loop is not explicitly specified, and corresponds to the ‘main’ main loop. See also [func@GLib.MainContext.get_thread_default].

func MainContextGetThreadDefault 

func MainContextGetThreadDefault() *MainContext

Gets the thread-default main context for this thread.

Asynchronous operations that want to be able to be run in contexts other than the default one should call this method or [func@GLib.MainContext.ref_thread_default] to get a [struct@GLib.MainContext] to add their [struct@GLib.Source]s to. (Note that even in single-threaded programs applications may sometimes want to temporarily push a non-default context, so it is not safe to assume that this will always return `NULL` if you are running in the default thread.)

If you need to hold a reference on the context, use [func@GLib.MainContext.ref_thread_default] instead.

func MainContextRefThreadDefault 

func MainContextRefThreadDefault() *MainContext

Gets a reference to the thread-default [struct@GLib.MainContext] for this thread

This is the same as [func@GLib.MainContext.get_thread_default], but it also adds a reference to the returned main context with [method@GLib.MainContext.ref]. In addition, unlike [func@GLib.MainContext.get_thread_default], if the thread-default context is the global-default context, this will return that [struct@GLib.MainContext] (with a ref added to it) rather than returning `NULL`.

func NewMainContext 

func NewMainContext() *MainContext

Creates a new [struct@GLib.MainContext] structure.

func NewMainContextWithFlags 

func NewMainContextWithFlags(FlagsVar MainContextFlags) *MainContext

Creates a new [struct@GLib.MainContext] structure.

func (*MainContext) Acquire 

func (x *MainContext) Acquire() bool

Tries to become the owner of the specified context.

If some other thread is the owner of the context, returns false immediately. Ownership is properly recursive: the owner can require ownership again and will release ownership when [method@GLib.MainContext.release] is called as many times as [method@GLib.MainContext.acquire].

You must be the owner of a context before you can call [method@GLib.MainContext.prepare], [method@GLib.MainContext.query], [method@GLib.MainContext.check], [method@GLib.MainContext.dispatch], [method@GLib.MainContext.release].

Since 2.76 @context can be `NULL` to use the global-default main context.

func (*MainContext) AddPoll 

func (x *MainContext) AddPoll(FdVar *PollFD, PriorityVar int)

Adds a file descriptor to the set of file descriptors polled for this context.

This will very seldom be used directly. Instead a typical event source will use `g_source_add_unix_fd()` instead.

func (*MainContext) Check 

func (x *MainContext) Check(MaxPriorityVar int, FdsVar []PollFD, NFdsVar int) bool

Passes the results of polling back to the main loop.

You should be careful to pass @fds and its length @n_fds as received from [method@GLib.MainContext.query], as this functions relies on assumptions on how @fds is filled.

You must have successfully acquired the context with [method@GLib.MainContext.acquire] before you may call this function.

Since 2.76 @context can be `NULL` to use the global-default main context.

func (*MainContext) Dispatch 

func (x *MainContext) Dispatch()

Dispatches all pending sources.

You must have successfully acquired the context with [method@GLib.MainContext.acquire] before you may call this function.

Since 2.76 @context can be `NULL` to use the global-default main context.

func (*MainContext) FindSourceByFuncsUserData 

func (x *MainContext) FindSourceByFuncsUserData(FuncsVar *SourceFuncs, UserDataVar uintptr) *Source

Finds a source with the given source functions and user data.

If multiple sources exist with the same source function and user data, the first one found will be returned.

func (*MainContext) FindSourceById 

func (x *MainContext) FindSourceById(SourceIdVar uint) *Source

Finds a [struct@GLib.Source] given a pair of context and ID.

It is a programmer error to attempt to look up a non-existent source.

More specifically: source IDs can be reissued after a source has been destroyed and therefore it is never valid to use this function with a source ID which may have already been removed. An example is when scheduling an idle to run in another thread with [func@GLib.idle_add]: the idle may already have run and been removed by the time this function is called on its (now invalid) source ID. This source ID may have been reissued, leading to the operation being performed against the wrong source.

func (*MainContext) FindSourceByUserData 

func (x *MainContext) FindSourceByUserData(UserDataVar uintptr) *Source

Finds a source with the given user data for the callback.

If multiple sources exist with the same user data, the first one found will be returned.

func (*MainContext) GetPollFunc 

func (x *MainContext) GetPollFunc() uintptr

Gets the poll function set by [method@GLib.MainContext.set_poll_func].

func (*MainContext) GoPointer 

func (x *MainContext) GoPointer() uintptr

func (*MainContext) Invoke 

func (x *MainContext) Invoke(FunctionVar *SourceFunc, DataVar uintptr)

Invokes a function in such a way that @context is owned during the invocation of @function.

If @context is `NULL` then the global-default main context — as returned by [func@GLib.MainContext.default] — is used.

If @context is owned by the current thread, @function is called directly. Otherwise, if @context is the thread-default main context of the current thread and [method@GLib.MainContext.acquire] succeeds, then @function is called and [method@GLib.MainContext.release] is called afterwards.

In any other case, an idle source is created to call @function and that source is attached to @context (presumably to be run in another thread). The idle source is attached with [const@GLib.PRIORITY_DEFAULT] priority. If you want a different priority, use [method@GLib.MainContext.invoke_full].

Note that, as with normal idle functions, @function should probably return [const@GLib.SOURCE_REMOVE]. If it returns [const@GLib.SOURCE_CONTINUE], it will be continuously run in a loop (and may prevent this call from returning).

func (*MainContext) InvokeFull 

func (x *MainContext) InvokeFull(PriorityVar int, FunctionVar *SourceFunc, DataVar uintptr, NotifyVar *DestroyNotify)

Invokes a function in such a way that @context is owned during the invocation of @function.

This function is the same as [method@GLib.MainContext.invoke] except that it lets you specify the priority in case @function ends up being scheduled as an idle and also lets you give a [callback@GLib.DestroyNotify] for @data.

The @notify function should not assume that it is called from any particular thread or with any particular context acquired.

func (*MainContext) IsOwner 

func (x *MainContext) IsOwner() bool

Determines whether this thread holds the (recursive) ownership of this [struct@GLib.MainContext].

This is useful to know before waiting on another thread that may be blocking to get ownership of @context.

func (*MainContext) Iteration 

func (x *MainContext) Iteration(MayBlockVar bool) bool

Runs a single iteration for the given main loop.

This involves checking to see if any event sources are ready to be processed, then if no events sources are ready and @may_block is true, waiting for a source to become ready, then dispatching the highest priority events sources that are ready. Otherwise, if @may_block is false, this function does not wait for sources to become ready, and only the highest priority sources which are already ready (if any) will be dispatched.

Note that even when @may_block is true, it is still possible for [method@GLib.MainContext.iteration] to return false, since the wait may be interrupted for other reasons than an event source becoming ready.

func (*MainContext) Pending 

func (x *MainContext) Pending() bool

Checks if any sources have pending events for the given context.

func (*MainContext) PopThreadDefault 

func (x *MainContext) PopThreadDefault()

Pops @context off the thread-default context stack (verifying that it was on the top of the stack).

func (*MainContext) Prepare 

func (x *MainContext) Prepare(PriorityVar *int) bool

Prepares to poll sources within a main loop.

The resulting information for polling is determined by calling [method@GLib.MainContext.query].

You must have successfully acquired the context with [method@GLib.MainContext.acquire] before you may call this function.

func (*MainContext) PushThreadDefault 

func (x *MainContext) PushThreadDefault()

Acquires @context and sets it as the thread-default context for the current thread. This will cause certain asynchronous operations (such as most [Gio](../gio/index.html)-based I/O) which are started in this thread to run under @context and deliver their results to its main loop, rather than running under the global default main context in the main thread. Note that calling this function changes the context returned by [func@GLib.MainContext.get_thread_default], not the one returned by [func@GLib.MainContext.default], so it does not affect the context used by functions like [func@GLib.idle_add].

Normally you would call this function shortly after creating a new thread, passing it a [struct@GLib.MainContext] which will be run by a [struct@GLib.MainLoop] in that thread, to set a new default context for all async operations in that thread. In this case you may not need to ever call [method@GLib.MainContext.pop_thread_default], assuming you want the new [struct@GLib.MainContext] to be the default for the whole lifecycle of the thread.

If you don’t have control over how the new thread was created (e.g. in the new thread isn’t newly created, or if the thread life cycle is managed by a #GThreadPool), it is always suggested to wrap the logic that needs to use the new [struct@GLib.MainContext] inside a [method@GLib.MainContext.push_thread_default] / [method@GLib.MainContext.pop_thread_default] pair, otherwise threads that are re-used will end up never explicitly releasing the [struct@GLib.MainContext] reference they hold.

In some cases you may want to schedule a single operation in a non-default context, or temporarily use a non-default context in the main thread. In that case, you can wrap the call to the asynchronous operation inside a [method@GLib.MainContext.push_thread_default] / [method@GLib.MainContext.pop_thread_default] pair, but it is up to you to ensure that no other asynchronous operations accidentally get started while the non-default context is active.

Beware that libraries that predate this function may not correctly handle being used from a thread with a thread-default context. For example, see `g_file_supports_thread_contexts()`.

func (*MainContext) PusherNew 

func (x *MainContext) PusherNew() *MainContextPusher

Push @main_context as the new thread-default main context for the current thread, using [method@GLib.MainContext.push_thread_default], and return a new [alias@GLib.MainContextPusher]. Pop with g_main_context_pusher_free(). Using [method@GLib.MainContext.pop_thread_default] on @main_context while a [alias@GLib.MainContextPusher] exists for it can lead to undefined behaviour.

Using two [alias@GLib.MainContextPusher]s in the same scope is not allowed, as it leads to an undefined pop order.

This is intended to be used with g_autoptr(). Note that g_autoptr() is only available when using GCC or clang, so the following example will only work with those compilers: |[ typedef struct 

{
  ...
  GMainContext *context;
  ...
} MyObject;

static void my_object_do_stuff (MyObject *self) 

{
  g_autoptr(GMainContextPusher) pusher = g_main_context_pusher_new (self-&gt;context);

  // Code with main context as the thread default here

  if (cond)
    // No need to pop
    return;

  // Optionally early pop
  g_clear_pointer (&amp;pusher, g_main_context_pusher_free);

  // Code with main context no longer the thread default here
}

]|

func (*MainContext) Query 

func (x *MainContext) Query(MaxPriorityVar int, TimeoutVar *int, FdsVar *[]PollFD, NFdsVar int) int

Determines information necessary to poll this main loop.

You should be careful to pass the resulting @fds array and its length @n_fds as-is when calling [method@GLib.MainContext.check], as this function relies on assumptions made when the array is filled.

You must have successfully acquired the context with [method@GLib.MainContext.acquire] before you may call this function.

func (*MainContext) Ref 

func (x *MainContext) Ref() *MainContext

Increases the reference count on a [struct@GLib.MainContext] object by one.

func (*MainContext) Release 

func (x *MainContext) Release()

Releases ownership of a context previously acquired by this thread with [method@GLib.MainContext.acquire].

If the context was acquired multiple times, the ownership will be released only when [method@GLib.MainContext.release] is called as many times as it was acquired.

You must have successfully acquired the context with [method@GLib.MainContext.acquire] before you may call this function.

func (*MainContext) RemovePoll 

func (x *MainContext) RemovePoll(FdVar *PollFD)

Removes file descriptor from the set of file descriptors to be polled for a particular context.

func (*MainContext) SetPollFunc 

func (x *MainContext) SetPollFunc(FuncVar *PollFunc)

Sets the function to use to handle polling of file descriptors.

It will be used instead of the [`poll()`](man:poll(2)) system call (or GLib’s replacement function, which is used where `poll()` isn’t available).

This function could possibly be used to integrate the GLib event loop with an external event loop.

func (*MainContext) Unref 

func (x *MainContext) Unref()

Decreases the reference count on a [struct@GLib.MainContext] object by one. If the result is zero, free the context and free all associated memory.

func (*MainContext) Wait 

func (x *MainContext) Wait(CondVar *Cond, MutexVar *Mutex) bool

Tries to become the owner of the specified context, and waits on @cond if another thread is the owner.

This is the same as [method@GLib.MainContext.acquire], but if another thread is the owner, atomically drop @mutex and wait on @cond until that owner releases ownership or until @cond is signaled, then try again (once) to become the owner.

func (*MainContext) Wakeup 

func (x *MainContext) Wakeup()

Wake up @context if it’s currently blocking in [method@GLib.MainContext.iteration], causing it to stop blocking.

The @context could be blocking waiting for a source to become ready. Otherwise, if @context is not currently blocking, this function causes the next invocation of [method@GLib.MainContext.iteration] to return without blocking.

This API is useful for low-level control over [struct@GLib.MainContext]; for example, integrating it with main loop implementations such as [struct@GLib.MainLoop].

Another related use for this function is when implementing a main loop with a termination condition, computed from multiple threads:

```c 

#define NUM_TASKS 10
static gint tasks_remaining = NUM_TASKS;  // (atomic)
...

while (g_atomic_int_get (&amp;tasks_remaining) != 0)
  g_main_context_iteration (NULL, TRUE);

```

Then in a thread: ```c 

perform_work ();

if (g_atomic_int_dec_and_test (&amp;tasks_remaining))
  g_main_context_wakeup (NULL);

```

type MainContextFlags 

type MainContextFlags int

Flags to pass to [ctor@GLib.MainContext.new_with_flags] which affect the behaviour of a [struct@GLib.MainContext]. 

const (

	// Default behaviour.
	GMainContextFlagsNoneValue MainContextFlags = 0
	// Assume that polling for events will
	// free the thread to process other jobs. That's useful if you're using
	// `g_main_context_{prepare,query,check,dispatch}` to integrate GMainContext in
	// other event loops.
	GMainContextFlagsOwnerlessPollingValue MainContextFlags = 1
)

type MainContextPusher 

type MainContextPusher = uintptr

Opaque type. See g_main_context_pusher_new() for details.

type MainLoop 

type MainLoop struct {
	// contains filtered or unexported fields
}

The `GMainLoop` struct is an opaque data type representing the main event loop of a GLib or GTK application.

func NewMainLoop 

func NewMainLoop(ContextVar *MainContext, IsRunningVar bool) *MainLoop

Creates a new [struct@GLib.MainLoop] structure.

func (*MainLoop) GetContext 

func (x *MainLoop) GetContext() *MainContext

Returns the [struct@GLib.MainContext] of @loop.

func (*MainLoop) GoPointer 

func (x *MainLoop) GoPointer() uintptr

func (*MainLoop) IsRunning 

func (x *MainLoop) IsRunning() bool

Checks to see if the main loop is currently being run via [method@GLib.MainLoop.run].

func (*MainLoop) Quit 

func (x *MainLoop) Quit()

Stops a [struct@GLib.MainLoop] from running. Any calls to [method@GLib.MainLoop.run] for the loop will return.

Note that sources that have already been dispatched when [method@GLib.MainLoop.quit] is called will still be executed.

func (*MainLoop) Ref 

func (x *MainLoop) Ref() *MainLoop

Increases the reference count on a [struct@GLib.MainLoop] object by one.

func (*MainLoop) Run 

func (x *MainLoop) Run()

Runs a main loop until [method@GLib.MainLoop.quit] is called on the loop.

If this is called from the thread of the loop’s [struct@GLib.MainContext], it will process events from the loop, otherwise it will simply wait.

func (*MainLoop) Unref 

func (x *MainLoop) Unref()

Decreases the reference count on a [struct@GLib.MainLoop] object by one.

If the result is zero, the loop and all associated memory are freed.

type MappedFile 

type MappedFile struct {
	// contains filtered or unexported fields
}

The #GMappedFile represents a file mapping created with g_mapped_file_new(). It has only private members and should not be accessed directly.

func NewMappedFile 

func NewMappedFile(FilenameVar string, WritableVar bool) (*MappedFile, error)

Maps a file into memory. On UNIX, this is using the mmap() function.

If @writable is %TRUE, the mapped buffer may be modified, otherwise it is an error to modify the mapped buffer. Modifications to the buffer are not visible to other processes mapping the same file, and are not written back to the file.

Note that modifications of the underlying file might affect the contents of the #GMappedFile. Therefore, mapping should only be used if the file will not be modified, or if all modifications of the file are done atomically (e.g. using g_file_set_contents()).

If @filename is the name of an empty, regular file, the function will successfully return an empty #GMappedFile. In other cases of size 0 (e.g. device files such as /dev/null), @error will be set to the #GFileError value %G_FILE_ERROR_INVAL.

func NewMappedFileFromFd 

func NewMappedFileFromFd(FdVar int, WritableVar bool) (*MappedFile, error)

Maps a file into memory. On UNIX, this is using the mmap() function.

If @writable is %TRUE, the mapped buffer may be modified, otherwise it is an error to modify the mapped buffer. Modifications to the buffer are not visible to other processes mapping the same file, and are not written back to the file.

Note that modifications of the underlying file might affect the contents of the #GMappedFile. Therefore, mapping should only be used if the file will not be modified, or if all modifications of the file are done atomically (e.g. using g_file_set_contents()).

func (*MappedFile) Free 

func (x *MappedFile) Free()

This call existed before #GMappedFile had refcounting and is currently exactly the same as g_mapped_file_unref().

func (*MappedFile) GetBytes 

func (x *MappedFile) GetBytes() *Bytes

Creates a new #GBytes which references the data mapped from @file. The mapped contents of the file must not be modified after creating this bytes object, because a #GBytes should be immutable.

func (*MappedFile) GetContents 

func (x *MappedFile) GetContents() string

Returns the contents of a #GMappedFile.

Note that the contents may not be zero-terminated, even if the #GMappedFile is backed by a text file.

If the file is empty then %NULL is returned.

func (*MappedFile) GetLength 

func (x *MappedFile) GetLength() uint

Returns the length of the contents of a #GMappedFile.

func (*MappedFile) GoPointer 

func (x *MappedFile) GoPointer() uintptr

func (*MappedFile) Ref 

func (x *MappedFile) Ref() *MappedFile

Increments the reference count of @file by one. It is safe to call this function from any thread.

func (*MappedFile) Unref 

func (x *MappedFile) Unref()

Decrements the reference count of @file by one. If the reference count drops to 0, unmaps the buffer of @file and frees it.

It is safe to call this function from any thread.

Since 2.22

type MarkupCollectType 

type MarkupCollectType int

A mixed enumerated type and flags field. You must specify one type (string, strdup, boolean, tristate). Additionally, you may optionally bitwise OR the type with the flag %G_MARKUP_COLLECT_OPTIONAL.

It is likely that this enum will be extended in the future to support other types. 

const (

	// used to terminate the list of attributes
	//     to collect
	GMarkupCollectInvalidValue MarkupCollectType = 0
	// collect the string pointer directly from
	//     the attribute_values[] array. Expects a parameter of type (const
	//     char **). If %G_MARKUP_COLLECT_OPTIONAL is specified and the
	//     attribute isn't present then the pointer will be set to %NULL
	GMarkupCollectStringValue MarkupCollectType = 1
	// as with %G_MARKUP_COLLECT_STRING, but
	//     expects a parameter of type (char **) and g_strdup()s the
	//     returned pointer. The pointer must be freed with g_free()
	GMarkupCollectStrdupValue MarkupCollectType = 2
	// expects a parameter of type (`gboolean *`)
	//     and parses the attribute value as a boolean. Sets %FALSE if the
	//     attribute isn't present. Valid boolean values consist of
	//     (case-insensitive) "false", "f", "no", "n", "0" and "true", "t",
	//     "yes", "y", "1"
	GMarkupCollectBooleanValue MarkupCollectType = 3
	// as with %G_MARKUP_COLLECT_BOOLEAN, but
	//     in the case of a missing attribute a value is set that compares
	//     equal to neither %FALSE nor %TRUE %G_MARKUP_COLLECT_OPTIONAL is
	//     implied
	GMarkupCollectTristateValue MarkupCollectType = 4
	// can be bitwise ORed with the other fields.
	//     If present, allows the attribute not to appear. A default value
	//     is set depending on what value type is used
	GMarkupCollectOptionalValue MarkupCollectType = 65536
)

type MarkupError 

type MarkupError int

Error codes returned by markup parsing. 

const (

	// text being parsed was not valid UTF-8
	GMarkupErrorBadUtf8Value MarkupError = 0
	// document contained nothing, or only whitespace
	GMarkupErrorEmptyValue MarkupError = 1
	// document was ill-formed
	GMarkupErrorParseValue MarkupError = 2
	// error should be set by #GMarkupParser
	//     functions; element wasn't known
	GMarkupErrorUnknownElementValue MarkupError = 3
	// error should be set by #GMarkupParser
	//     functions; attribute wasn't known
	GMarkupErrorUnknownAttributeValue MarkupError = 4
	// error should be set by #GMarkupParser
	//     functions; content was invalid
	GMarkupErrorInvalidContentValue MarkupError = 5
	// error should be set by #GMarkupParser
	//     functions; a required attribute was missing
	GMarkupErrorMissingAttributeValue MarkupError = 6
)

type MarkupParseContext 

type MarkupParseContext struct {
	// contains filtered or unexported fields
}

A parse context is used to parse a stream of bytes that you expect to contain marked-up text.

See g_markup_parse_context_new(), #GMarkupParser, and so on for more details.

func NewMarkupParseContext 

func NewMarkupParseContext(ParserVar *MarkupParser, FlagsVar MarkupParseFlags, UserDataVar uintptr, UserDataDnotifyVar *DestroyNotify) *MarkupParseContext

Creates a new parse context. A parse context is used to parse marked-up documents. You can feed any number of documents into a context, as long as no errors occur; once an error occurs, the parse context can't continue to parse text (you have to free it and create a new parse context).

func (*MarkupParseContext) EndParse 

func (x *MarkupParseContext) EndParse() (bool, error)

Signals to the #GMarkupParseContext that all data has been fed into the parse context with g_markup_parse_context_parse().

This function reports an error if the document isn't complete, for example if elements are still open.

func (*MarkupParseContext) Free 

func (x *MarkupParseContext) Free()

Frees a #GMarkupParseContext.

This function can't be called from inside one of the #GMarkupParser functions or while a subparser is pushed.

func (*MarkupParseContext) GetElement 

func (x *MarkupParseContext) GetElement() string

Retrieves the name of the currently open element.

If called from the start_element or end_element handlers this will give the element_name as passed to those functions. For the parent elements, see g_markup_parse_context_get_element_stack().

func (*MarkupParseContext) GetElementStack 

func (x *MarkupParseContext) GetElementStack() *SList

Retrieves the element stack from the internal state of the parser.

The returned #GSList is a list of strings where the first item is the currently open tag (as would be returned by g_markup_parse_context_get_element()) and the next item is its immediate parent.

This function is intended to be used in the start_element and end_element handlers where g_markup_parse_context_get_element() would merely return the name of the element that is being processed.

func (*MarkupParseContext) GetOffset added in v0.5.0 

func (x *MarkupParseContext) GetOffset() uint

Retrieves the current offset from the beginning of the document, in bytes.

The information is meant to accompany the values returned by [method@GLib.MarkupParseContext.get_position], and comes with the same accuracy guarantees.

func (*MarkupParseContext) GetPosition 

func (x *MarkupParseContext) GetPosition(LineNumberVar *int, CharNumberVar *int)

Retrieves the current line number and the number of the character on that line. Intended for use in error messages; there are no strict semantics for what constitutes the "current" line number other than "the best number we could come up with for error messages."

func (*MarkupParseContext) GetTagStart added in v0.5.0 

func (x *MarkupParseContext) GetTagStart(LineNumberVar *uint, CharNumberVar *uint, OffsetVar *uint)

Retrieves the start position of the current start or end tag.

This function can be used in the `start_element` or `end_element` callbacks to obtain location information for error reporting.

Note that @line_number and @char_number are intended for human readable error messages and are therefore 1-based and in Unicode characters. @offset on the other hand is meant for programmatic use, and thus is 0-based and in bytes.

The information is meant to accompany the values returned by [method@GLib.MarkupParseContext.get_position], and comes with the same accuracy guarantees.

func (*MarkupParseContext) GetUserData 

func (x *MarkupParseContext) GetUserData() uintptr

Returns the user_data associated with @context.

This will either be the user_data that was provided to g_markup_parse_context_new() or to the most recent call of g_markup_parse_context_push().

func (*MarkupParseContext) GoPointer 

func (x *MarkupParseContext) GoPointer() uintptr

func (*MarkupParseContext) Parse 

func (x *MarkupParseContext) Parse(TextVar string, TextLenVar int) (bool, error)

Feed some data to the #GMarkupParseContext.

The data need not be valid UTF-8; an error will be signaled if it's invalid. The data need not be an entire document; you can feed a document into the parser incrementally, via multiple calls to this function. Typically, as you receive data from a network connection or file, you feed each received chunk of data into this function, aborting the process if an error occurs. Once an error is reported, no further data may be fed to the #GMarkupParseContext; all errors are fatal.

func (*MarkupParseContext) Pop 

func (x *MarkupParseContext) Pop() uintptr

Completes the process of a temporary sub-parser redirection.

This function exists to collect the user_data allocated by a matching call to g_markup_parse_context_push(). It must be called in the end_element handler corresponding to the start_element handler during which g_markup_parse_context_push() was called. You must not call this function from the error callback -- the @user_data is provided directly to the callback in that case.

This function is not intended to be directly called by users interested in invoking subparsers. Instead, it is intended to be used by the subparsers themselves to implement a higher-level interface.

func (*MarkupParseContext) Push 

func (x *MarkupParseContext) Push(ParserVar *MarkupParser, UserDataVar uintptr)

Temporarily redirects markup data to a sub-parser.

This function may only be called from the start_element handler of a #GMarkupParser. It must be matched with a corresponding call to g_markup_parse_context_pop() in the matching end_element handler (except in the case that the parser aborts due to an error).

All tags, text and other data between the matching tags is redirected to the subparser given by @parser. @user_data is used as the user_data for that parser. @user_data is also passed to the error callback in the event that an error occurs. This includes errors that occur in subparsers of the subparser.

The end tag matching the start tag for which this call was made is handled by the previous parser (which is given its own user_data) which is why g_markup_parse_context_pop() is provided to allow "one last access" to the @user_data provided to this function. In the case of error, the @user_data provided here is passed directly to the error callback of the subparser and g_markup_parse_context_pop() should not be called. In either case, if @user_data was allocated then it ought to be freed from both of these locations.

This function is not intended to be directly called by users interested in invoking subparsers. Instead, it is intended to be used by the subparsers themselves to implement a higher-level interface.

As an example, see the following implementation of a simple parser that counts the number of tags encountered.

|[&lt;!-- language="C" --&gt; typedef struct 

{
  gint tag_count;
} CounterData;

static void counter_start_element (GMarkupParseContext *context, 

const gchar          *element_name,
const gchar         **attribute_names,
const gchar         **attribute_values,
gpointer              user_data,
GError              **error)

{
  CounterData *data = user_data;

  data-&gt;tag_count++;
}

static void counter_error (GMarkupParseContext *context, 

GError              *error,
gpointer             user_data)

{
  CounterData *data = user_data;

  g_slice_free (CounterData, data);
}

static GMarkupParser counter_subparser = 

{
  counter_start_element,
  NULL,
  NULL,
  NULL,
  counter_error
};

]|

In order to allow this parser to be easily used as a subparser, the following interface is provided:

|[&lt;!-- language="C" --&gt; void start_counting (GMarkupParseContext *context) 

{
  CounterData *data = g_slice_new (CounterData);

  data-&gt;tag_count = 0;
  g_markup_parse_context_push (context, &amp;counter_subparser, data);
}

gint end_counting (GMarkupParseContext *context) 

{
  CounterData *data = g_markup_parse_context_pop (context);
  int result;

  result = data-&gt;tag_count;
  g_slice_free (CounterData, data);

  return result;
}

]|

The subparser would then be used as follows:

|[&lt;!-- language="C" --&gt; static void start_element (context, element_name, ...) 

{
  if (strcmp (element_name, "count-these") == 0)
    start_counting (context);

  // else, handle other tags...
}

static void end_element (context, element_name, ...) 

{
  if (strcmp (element_name, "count-these") == 0)
    g_print ("Counted %d tags\n", end_counting (context));

  // else, handle other tags...
}

]|

func (*MarkupParseContext) Ref 

func (x *MarkupParseContext) Ref() *MarkupParseContext

Increases the reference count of @context.

func (*MarkupParseContext) Unref 

func (x *MarkupParseContext) Unref()

Decreases the reference count of @context. When its reference count drops to 0, it is freed.

type MarkupParseFlags 

type MarkupParseFlags int

Flags that affect the behaviour of the parser. 

const (

	// No special behaviour. Since: 2.74
	GMarkupDefaultFlagsValue MarkupParseFlags = 0
	// flag you should not use
	GMarkupDoNotUseThisUnsupportedFlagValue MarkupParseFlags = 1
	// When this flag is set, CDATA marked
	//     sections are not passed literally to the @passthrough function of
	//     the parser. Instead, the content of the section (without the
	//     `&lt;![CDATA[` and `]]&gt;`) is
	//     passed to the @text function. This flag was added in GLib 2.12
	GMarkupTreatCdataAsTextValue MarkupParseFlags = 2
	// Normally errors caught by GMarkup
	//     itself have line/column information prefixed to them to let the
	//     caller know the location of the error. When this flag is set the
	//     location information is also prefixed to errors generated by the
	//     #GMarkupParser implementation functions
	GMarkupPrefixErrorPositionValue MarkupParseFlags = 4
	// Ignore (don't report) qualified
	//     attributes and tags, along with their contents.  A qualified
	//     attribute or tag is one that contains ':' in its name (ie: is in
	//     another namespace).  Since: 2.40.
	GMarkupIgnoreQualifiedValue MarkupParseFlags = 8
)

type MarkupParser 

type MarkupParser struct {
	// contains filtered or unexported fields
}

Any of the fields in #GMarkupParser can be %NULL, in which case they will be ignored. Except for the @error function, any of these callbacks can set an error; in particular the %G_MARKUP_ERROR_UNKNOWN_ELEMENT, %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE, and %G_MARKUP_ERROR_INVALID_CONTENT errors are intended to be set from these callbacks. If you set an error from a callback, g_markup_parse_context_parse() will report that error back to its caller.

Refer to the [GMarkup](../glib/markup.html) documentation to understand the scope and limitations of `GMarkupParser`. In particular, it is not a full XML parser and it must not be used to process untrusted data.

func (*MarkupParser) GetEndElement 

func (x *MarkupParser) GetEndElement() func(*MarkupParseContext, string, uintptr)

GetEndElement gets the "end_element" callback function. Callback to invoke when the closing tag of an element 

is seen. Note that this is also called for empty tags like
`&lt;empty/&gt;`.

func (*MarkupParser) GetError 

func (x *MarkupParser) GetError() func(*MarkupParseContext, *Error, uintptr)

GetError gets the "error" callback function. Callback to invoke when an error occurs.

func (*MarkupParser) GetPassthrough 

func (x *MarkupParser) GetPassthrough() func(*MarkupParseContext, string, uint, uintptr)

GetPassthrough gets the "passthrough" callback function. Callback to invoke for comments, processing instructions 

and doctype declarations; if you're re-writing the parsed document,
write the passthrough text back out in the same position. If the
%G_MARKUP_TREAT_CDATA_AS_TEXT flag is not set, this function is also
called for CDATA marked sections.

func (*MarkupParser) GetStartElement 

func (x *MarkupParser) GetStartElement() func(*MarkupParseContext, string, string, string, uintptr)

GetStartElement gets the "start_element" callback function. Callback to invoke when the opening tag of an element 

is seen. The callback's @attribute_names and @attribute_values parameters
are %NULL-terminated.

func (*MarkupParser) GetText 

func (x *MarkupParser) GetText() func(*MarkupParseContext, string, uint, uintptr)

GetText gets the "text" callback function. Callback to invoke when some text is seen (text is always 

inside an element). Note that the text of an element may be spread
over multiple calls of this function. If the
%G_MARKUP_TREAT_CDATA_AS_TEXT flag is set, this function is also
called for the content of CDATA marked sections.

func (*MarkupParser) GoPointer 

func (x *MarkupParser) GoPointer() uintptr

func (*MarkupParser) OverrideEndElement 

func (x *MarkupParser) OverrideEndElement(cb func(*MarkupParseContext, string, uintptr))

OverrideEndElement sets the "end_element" callback function. Callback to invoke when the closing tag of an element 

is seen. Note that this is also called for empty tags like
`&lt;empty/&gt;`.

func (*MarkupParser) OverrideError 

func (x *MarkupParser) OverrideError(cb func(*MarkupParseContext, *Error, uintptr))

OverrideError sets the "error" callback function. Callback to invoke when an error occurs.

func (*MarkupParser) OverridePassthrough 

func (x *MarkupParser) OverridePassthrough(cb func(*MarkupParseContext, string, uint, uintptr))

OverridePassthrough sets the "passthrough" callback function. Callback to invoke for comments, processing instructions 

and doctype declarations; if you're re-writing the parsed document,
write the passthrough text back out in the same position. If the
%G_MARKUP_TREAT_CDATA_AS_TEXT flag is not set, this function is also
called for CDATA marked sections.

func (*MarkupParser) OverrideStartElement 

func (x *MarkupParser) OverrideStartElement(cb func(*MarkupParseContext, string, string, string, uintptr))

OverrideStartElement sets the "start_element" callback function. Callback to invoke when the opening tag of an element 

is seen. The callback's @attribute_names and @attribute_values parameters
are %NULL-terminated.

func (*MarkupParser) OverrideText 

func (x *MarkupParser) OverrideText(cb func(*MarkupParseContext, string, uint, uintptr))

OverrideText sets the "text" callback function. Callback to invoke when some text is seen (text is always 

inside an element). Note that the text of an element may be spread
over multiple calls of this function. If the
%G_MARKUP_TREAT_CDATA_AS_TEXT flag is set, this function is also
called for the content of CDATA marked sections.

type MatchInfo 

type MatchInfo struct {
	// contains filtered or unexported fields
}

A GMatchInfo is an opaque struct used to return information about matches.

func (*MatchInfo) ExpandReferences 

func (x *MatchInfo) ExpandReferences(StringToExpandVar string) (string, error)

Returns a new string containing the text in @string_to_expand with references and escape sequences expanded. References refer to the last match done with @string against @regex and have the same syntax used by g_regex_replace().

The @string_to_expand must be UTF-8 encoded even if %G_REGEX_RAW was passed to g_regex_new().

The backreferences are extracted from the string passed to the match function, so you cannot call this function after freeing the string.

@match_info may be %NULL in which case @string_to_expand must not contain references. For instance "foo\n" does not refer to an actual pattern and '\n' merely will be replaced with \n character, while to expand "\0" (whole match) one needs the result of a match. Use g_regex_check_replacement() to find out whether @string_to_expand contains references.

func (*MatchInfo) Fetch 

func (x *MatchInfo) Fetch(MatchNumVar int) string

Retrieves the text matching the @match_num'th capturing parentheses. 0 is the full text of the match, 1 is the first paren set, 2 the second, and so on.

If @match_num is a valid sub pattern but it didn't match anything (e.g. sub pattern 1, matching "b" against "(a)?b") then an empty string is returned.

If the match was obtained using the DFA algorithm, that is using g_regex_match_all() or g_regex_match_all_full(), the retrieved string is not that of a set of parentheses but that of a matched substring. Substrings are matched in reverse order of length, so 0 is the longest match.

The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string.

func (*MatchInfo) FetchAll 

func (x *MatchInfo) FetchAll() []string

Bundles up pointers to each of the matching substrings from a match and stores them in an array of gchar pointers. The first element in the returned array is the match number 0, i.e. the entire matched text.

If a sub pattern didn't match anything (e.g. sub pattern 1, matching "b" against "(a)?b") then an empty string is inserted.

If the last match was obtained using the DFA algorithm, that is using g_regex_match_all() or g_regex_match_all_full(), the retrieved strings are not that matched by sets of parentheses but that of the matched substring. Substrings are matched in reverse order of length, so the first one is the longest match.

The strings are fetched from the string passed to the match function, so you cannot call this function after freeing the string.

func (*MatchInfo) FetchNamed 

func (x *MatchInfo) FetchNamed(NameVar string) string

Retrieves the text matching the capturing parentheses named @name.

If @name is a valid sub pattern name but it didn't match anything (e.g. sub pattern `"X"`, matching `"b"` against `"(?P&lt;X&gt;a)?b"`) then an empty string is returned.

The string is fetched from the string passed to the match function, so you cannot call this function after freeing the string.

func (*MatchInfo) FetchNamedPos 

func (x *MatchInfo) FetchNamedPos(NameVar string, StartPosVar *int, EndPosVar *int) bool

Retrieves the position in bytes of the capturing parentheses named @name.

If @name is a valid sub pattern name but it didn't match anything (e.g. sub pattern `"X"`, matching `"b"` against `"(?P&lt;X&gt;a)?b"`) then @start_pos and @end_pos are set to -1 and %TRUE is returned.

As @end_pos is set to the byte after the final byte of the match (on success), the length of the match can be calculated as `end_pos - start_pos`.

func (*MatchInfo) FetchPos 

func (x *MatchInfo) FetchPos(MatchNumVar int, StartPosVar *int, EndPosVar *int) bool

Returns the start and end positions (in bytes) of a successfully matching capture parenthesis.

Valid values for @match_num are `0` for the full text of the match, `1` for the first paren set, `2` for the second, and so on.

As @end_pos is set to the byte after the final byte of the match (on success), the length of the match can be calculated as `end_pos - start_pos`.

As a best practice, initialize @start_pos and @end_pos to identifiable values, such as `G_MAXINT`, so that you can test if `g_match_info_fetch_pos()` actually changed the value for a given capture parenthesis.

The parameter @match_num corresponds to a matched capture parenthesis. The actual value you use for @match_num depends on the method used to generate @match_info. The following sections describe those methods.

## Methods Using Non-deterministic Finite Automata Matching

The methods [method@GLib.Regex.match] and [method@GLib.Regex.match_full] return a [struct@GLib.MatchInfo] using traditional (greedy) pattern matching, also known as [Non-deterministic Finite Automaton](https://en.wikipedia.org/wiki/Nondeterministic_finite_automaton) (NFA) matching. You pass the returned `GMatchInfo` from these methods to `g_match_info_fetch_pos()` to determine the start and end positions of capture parentheses. The values for @match_num correspond to the capture parentheses in order, with `0` corresponding to the entire matched string.

@match_num can refer to a capture parenthesis with no match. For example, the string `b` matches against the pattern `(a)?b`, but the capture parenthesis `(a)` has no match. In this case, `g_match_info_fetch_pos()` returns true and sets @start_pos and @end_pos to `-1` when called with `match_num` as `1` (for `(a)`).

For an expanded example, a regex pattern is `(a)?(.*?)the (.*)`, and a candidate string is `glib regexes are the best`. In this scenario there are four capture parentheses numbered 0–3: an implicit one for the entire string, and three explicitly declared in the regex pattern.

Given this example, the following table describes the return values from `g_match_info_fetch_pos()` for various values of @match_num.

`match_num` | Contents | Return value | Returned `start_pos` | Returned `end_pos` ----------- | -------- | ------------ | -------------------- | ------------------ 0 | Matches entire string | True | 0 | 25 1 | Does not match first character | True | -1 | -1 2 | All text before `the ` | True | 0 | 17 3 | All text after `the ` | True | 21 | 25 4 | Capture paren out of range | False | Unchanged | Unchanged

The following code sample and output implements this example.

``` { .c } #include &lt;glib.h&gt;

int main (int argc, char *argv[]) 

{
  g_autoptr(GError) local_error = NULL;
  const char *regex_pattern = "(a)?(.*?)the (.*)";
  const char *test_string = "glib regexes are the best";
  g_autoptr(GRegex) regex = NULL;

  regex = g_regex_new (regex_pattern,
                       G_REGEX_DEFAULT,
                       G_REGEX_MATCH_DEFAULT,
                       &amp;local_error);
  if (regex == NULL)
    {
      g_printerr ("Error creating regex: %s\n", local_error-&gt;message);
      return 1;
    }

  g_autoptr(GMatchInfo) match_info = NULL;
  g_regex_match (regex, test_string, G_REGEX_MATCH_DEFAULT, &amp;match_info);

  int n_matched_strings = g_match_info_get_match_count (match_info);

  // Print header line
  g_print ("match_num Contents                  Return value returned start_pos returned end_pos\n");

  // Iterate over each capture paren, including one that is out of range as a demonstration.
  for (int match_num = 0; match_num &lt;= n_matched_strings; match_num++)
    {
      gboolean found_match;
      g_autofree char *paren_string = NULL;
      int start_pos = G_MAXINT;
      int end_pos = G_MAXINT;

      found_match = g_match_info_fetch_pos (match_info,
                                            match_num,
                                            &amp;start_pos,
                                            &amp;end_pos);

      // If no match, display N/A as the found string.
      if (start_pos == G_MAXINT || start_pos == -1)
        paren_string = g_strdup ("N/A");
      else
        paren_string = g_strndup (test_string + start_pos, end_pos - start_pos);

      g_print ("%-9d %-25s %-12d %-18d %d\n", match_num, paren_string, found_match, start_pos, end_pos);
    }

  return 0;
}

```

``` match_num Contents Return value returned start_pos returned end_pos 0 glib regexes are the best 1 0 25 1 N/A 1 -1 -1 2 glib regexes are 1 0 17 3 best 1 21 25 4 N/A 0 2147483647 2147483647 ``` ## Methods Using Deterministic Finite Automata Matching

The methods [method@GLib.Regex.match_all] and [method@GLib.Regex.match_all_full] return a `GMatchInfo` using [Deterministic Finite Automaton](https://en.wikipedia.org/wiki/Deterministic_finite_automaton) (DFA) pattern matching. This algorithm detects overlapping matches. You pass the returned `GMatchInfo` from these methods to `g_match_info_fetch_pos()` to determine the start and end positions of each overlapping match. Use the method [method@GLib.MatchInfo.get_match_count] to determine the number of overlapping matches.

For example, a regex pattern is `&lt;.*&gt;`, and a candidate string is `&lt;a&gt; &lt;b&gt; &lt;c&gt;`. In this scenario there are three implicit capture parentheses: one for the entire string, one for `&lt;a&gt; &lt;b&gt;`, and one for `&lt;a&gt;`.

Given this example, the following table describes the return values from `g_match_info_fetch_pos()` for various values of @match_num.

`match_num` | Contents | Return value | Returned `start_pos` | Returned `end_pos` ----------- | -------- | ------------ | -------------------- | ------------------ 0 | Matches entire string | True | 0 | 11 1 | Matches `&lt;a&gt; &lt;b&gt;` | True | 0 | 7 2 | Matches `&lt;a&gt;` | True | 0 | 3 3 | Capture paren out of range | False | Unchanged | Unchanged

The following code sample and output implements this example.

``` { .c } #include &lt;glib.h&gt;

int main (int argc, char *argv[]) 

{
  g_autoptr(GError) local_error = NULL;
  const char *regex_pattern = "&lt;.*&gt;";
  const char *test_string = "&lt;a&gt; &lt;b&gt; &lt;c&gt;";
  g_autoptr(GRegex) regex = NULL;

  regex = g_regex_new (regex_pattern,
                       G_REGEX_DEFAULT,
                       G_REGEX_MATCH_DEFAULT,
                       &amp;local_error);
  if (regex == NULL)
    {
      g_printerr ("Error creating regex: %s\n", local_error-&gt;message);
      return -1;
    }

  g_autoptr(GMatchInfo) match_info = NULL;
  g_regex_match_all (regex, test_string, G_REGEX_MATCH_DEFAULT, &amp;match_info);

  int n_matched_strings = g_match_info_get_match_count (match_info);

  // Print header line
  g_print ("match_num Contents                  Return value returned start_pos returned end_pos\n");

  // Iterate over each capture paren, including one that is out of range as a demonstration.
  for (int match_num = 0; match_num &lt;= n_matched_strings; match_num++)
    {
      gboolean found_match;
      g_autofree char *paren_string = NULL;
      int start_pos = G_MAXINT;
      int end_pos = G_MAXINT;

      found_match = g_match_info_fetch_pos (match_info, match_num, &amp;start_pos, &amp;end_pos);

      // If no match, display N/A as the found string.
      if (start_pos == G_MAXINT || start_pos == -1)
        paren_string = g_strdup ("N/A");
      else
        paren_string = g_strndup (test_string + start_pos, end_pos - start_pos);

      g_print ("%-9d %-25s %-12d %-18d %d\n", match_num, paren_string, found_match, start_pos, end_pos);
    }

  return 0;
}

```

``` match_num Contents Return value returned start_pos returned end_pos 0 &lt;a&gt; &lt;b&gt; &lt;c&gt; 1 0 11 1 &lt;a&gt; &lt;b&gt; 1 0 7 2 &lt;a&gt; 1 0 3 3 N/A 0 2147483647 2147483647 ```

func (*MatchInfo) Free 

func (x *MatchInfo) Free()

If @match_info is not %NULL, calls g_match_info_unref(); otherwise does nothing.

func (*MatchInfo) GetMatchCount 

func (x *MatchInfo) GetMatchCount() int

Retrieves the number of matched substrings (including substring 0, that is the whole matched text), so 1 is returned if the pattern has no substrings in it and 0 is returned if the match failed.

If the last match was obtained using the DFA algorithm, that is using g_regex_match_all() or g_regex_match_all_full(), the retrieved count is not that of the number of capturing parentheses but that of the number of matched substrings.

func (*MatchInfo) GetRegex 

func (x *MatchInfo) GetRegex() *Regex

Returns #GRegex object used in @match_info. It belongs to Glib and must not be freed. Use g_regex_ref() if you need to keep it after you free @match_info object.

func (*MatchInfo) GetString 

func (x *MatchInfo) GetString() string

Returns the string searched with @match_info. This is the string passed to g_regex_match() or g_regex_replace() so you may not free it before calling this function.

func (*MatchInfo) GoPointer 

func (x *MatchInfo) GoPointer() uintptr

func (*MatchInfo) IsPartialMatch 

func (x *MatchInfo) IsPartialMatch() bool

Usually if the string passed to g_regex_match*() matches as far as it goes, but is too short to match the entire pattern, %FALSE is returned. There are circumstances where it might be helpful to distinguish this case from other cases in which there is no match.

Consider, for example, an application where a human is required to type in data for a field with specific formatting requirements. An example might be a date in the form ddmmmyy, defined by the pattern "^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$". If the application sees the user’s keystrokes one by one, and can check that what has been typed so far is potentially valid, it is able to raise an error as soon as a mistake is made.

GRegex supports the concept of partial matching by means of the %G_REGEX_MATCH_PARTIAL_SOFT and %G_REGEX_MATCH_PARTIAL_HARD flags. When they are used, the return code for g_regex_match() or g_regex_match_full() is, as usual, %TRUE for a complete match, %FALSE otherwise. But, when these functions return %FALSE, you can check if the match was partial calling g_match_info_is_partial_match().

The difference between %G_REGEX_MATCH_PARTIAL_SOFT and %G_REGEX_MATCH_PARTIAL_HARD is that when a partial match is encountered with %G_REGEX_MATCH_PARTIAL_SOFT, matching continues to search for a possible complete match, while with %G_REGEX_MATCH_PARTIAL_HARD matching stops at the partial match. When both %G_REGEX_MATCH_PARTIAL_SOFT and %G_REGEX_MATCH_PARTIAL_HARD are set, the latter takes precedence.

There were formerly some restrictions on the pattern for partial matching. The restrictions no longer apply.

See pcrepartial(3) for more information on partial matching.

func (*MatchInfo) Matches 

func (x *MatchInfo) Matches() bool

Returns whether the previous match operation succeeded.

func (*MatchInfo) Next 

func (x *MatchInfo) Next() (bool, error)

Scans for the next match using the same parameters of the previous call to g_regex_match_full() or g_regex_match() that returned @match_info.

The match is done on the string passed to the match function, so you cannot free it before calling this function.

func (*MatchInfo) Ref 

func (x *MatchInfo) Ref() *MatchInfo

Increases reference count of @match_info by 1.

func (*MatchInfo) Unref 

func (x *MatchInfo) Unref()

Decreases reference count of @match_info by 1. When reference count drops to zero, it frees all the memory associated with the match_info structure.

type MemChunk 

type MemChunk struct {
	// contains filtered or unexported fields
}

func (*MemChunk) Alloc 

func (x *MemChunk) Alloc() uintptr

func (*MemChunk) Alloc0 

func (x *MemChunk) Alloc0() uintptr

func (*MemChunk) Clean 

func (x *MemChunk) Clean()

func (*MemChunk) Destroy 

func (x *MemChunk) Destroy()

func (*MemChunk) Free 

func (x *MemChunk) Free(MemVar uintptr)

func (*MemChunk) GoPointer 

func (x *MemChunk) GoPointer() uintptr

func (*MemChunk) Print 

func (x *MemChunk) Print()

func (*MemChunk) Reset 

func (x *MemChunk) Reset()

type MemVTable 

type MemVTable struct {
	// contains filtered or unexported fields
}

A set of functions used to perform memory allocation. The same #GMemVTable must be used for all allocations in the same program; a call to g_mem_set_vtable(), if it exists, should be prior to any use of GLib.

This functions related to this has been deprecated in 2.46, and no longer work.

func (*MemVTable) GetCalloc 

func (x *MemVTable) GetCalloc() func(uint, uint) uintptr

GetCalloc gets the "calloc" callback function. function to use for allocating zero-filled memory.

func (*MemVTable) GetFree 

func (x *MemVTable) GetFree() func(uintptr)

GetFree gets the "free" callback function. function to use to free memory.

func (*MemVTable) GetMalloc 

func (x *MemVTable) GetMalloc() func(uint) uintptr

GetMalloc gets the "malloc" callback function. function to use for allocating memory.

func (*MemVTable) GetRealloc 

func (x *MemVTable) GetRealloc() func(uintptr, uint) uintptr

GetRealloc gets the "realloc" callback function. function to use for reallocating memory.

func (*MemVTable) GetTryMalloc 

func (x *MemVTable) GetTryMalloc() func(uint) uintptr

GetTryMalloc gets the "try_malloc" callback function. function to use for allocating memory without a default error handler.

func (*MemVTable) GetTryRealloc 

func (x *MemVTable) GetTryRealloc() func(uintptr, uint) uintptr

GetTryRealloc gets the "try_realloc" callback function. function to use for reallocating memory without a default error handler.

func (*MemVTable) GoPointer 

func (x *MemVTable) GoPointer() uintptr

func (*MemVTable) OverrideCalloc 

func (x *MemVTable) OverrideCalloc(cb func(uint, uint) uintptr)

OverrideCalloc sets the "calloc" callback function. function to use for allocating zero-filled memory.

func (*MemVTable) OverrideFree 

func (x *MemVTable) OverrideFree(cb func(uintptr))

OverrideFree sets the "free" callback function. function to use to free memory.

func (*MemVTable) OverrideMalloc 

func (x *MemVTable) OverrideMalloc(cb func(uint) uintptr)

OverrideMalloc sets the "malloc" callback function. function to use for allocating memory.

func (*MemVTable) OverrideRealloc 

func (x *MemVTable) OverrideRealloc(cb func(uintptr, uint) uintptr)

OverrideRealloc sets the "realloc" callback function. function to use for reallocating memory.

func (*MemVTable) OverrideTryMalloc 

func (x *MemVTable) OverrideTryMalloc(cb func(uint) uintptr)

OverrideTryMalloc sets the "try_malloc" callback function. function to use for allocating memory without a default error handler.

func (*MemVTable) OverrideTryRealloc 

func (x *MemVTable) OverrideTryRealloc(cb func(uintptr, uint) uintptr)

OverrideTryRealloc sets the "try_realloc" callback function. function to use for reallocating memory without a default error handler.

type Mutex 

type Mutex = uintptr

The #GMutex struct is an opaque data structure to represent a mutex (mutual exclusion). It can be used to protect data against shared access.

Take for example the following function: |[&lt;!-- language="C" --&gt; 

int
give_me_next_number (void)
{
  static int current_number = 0;

  // now do a very complicated calculation to calculate the new
  // number, this might for example be a random number generator
  current_number = calc_next_number (current_number);

  return current_number;
}

]| It is easy to see that this won't work in a multi-threaded application. There current_number must be protected against shared access. A #GMutex can be used as a solution to this problem: |[&lt;!-- language="C" --&gt; 

int
give_me_next_number (void)
{
  static GMutex mutex;
  static int current_number = 0;
  int ret_val;

  g_mutex_lock (&amp;mutex);
  ret_val = current_number = calc_next_number (current_number);
  g_mutex_unlock (&amp;mutex);

  return ret_val;
}

]| Notice that the #GMutex is not initialised to any particular value. Its placement in static storage ensures that it will be initialised to all-zeros, which is appropriate.

If a #GMutex is placed in other contexts (eg: embedded in a struct) then it must be explicitly initialised using g_mutex_init().

A #GMutex should only be accessed via g_mutex_ functions.

func MutexNew 

func MutexNew() *Mutex

Allocates and initializes a new #GMutex.

type MutexLocker 

type MutexLocker = uintptr

Opaque type. See g_mutex_locker_new() for details.

type Node 

type Node struct {
	Data uintptr

	Next *Node

	Prev *Node

	Parent *Node

	Children *Node
	// contains filtered or unexported fields
}

The #GNode struct represents one node in a [n-ary tree](data-structures.html#n-ary-trees).

func (*Node) ChildIndex 

func (x *Node) ChildIndex(DataVar uintptr) int

Gets the position of the first child of a #GNode which contains the given data.

func (*Node) ChildPosition 

func (x *Node) ChildPosition(ChildVar *Node) int

Gets the position of a #GNode with respect to its siblings. @child must be a child of @node. The first child is numbered 0, the second 1, and so on.

func (*Node) ChildrenForeach 

func (x *Node) ChildrenForeach(FlagsVar TraverseFlags, FuncVar *NodeForeachFunc, DataVar uintptr)

Calls a function for each of the children of a #GNode. Note that it doesn't descend beneath the child nodes. @func must not do anything that would modify the structure of the tree.

func (*Node) Copy 

func (x *Node) Copy() *Node

Recursively copies a #GNode (but does not deep-copy the data inside the nodes, see g_node_copy_deep() if you need that).

func (*Node) CopyDeep 

func (x *Node) CopyDeep(CopyFuncVar *CopyFunc, DataVar uintptr) *Node

Recursively copies a #GNode and its data.

func (*Node) Depth 

func (x *Node) Depth() uint

Gets the depth of a #GNode.

If @node is %NULL the depth is 0. The root node has a depth of 1. For the children of the root node the depth is 2. And so on.

func (*Node) Destroy 

func (x *Node) Destroy()

Removes @root and its children from the tree, freeing any memory allocated.

func (*Node) Find 

func (x *Node) Find(OrderVar TraverseType, FlagsVar TraverseFlags, DataVar uintptr) *Node

Finds a #GNode in a tree.

func (*Node) FindChild 

func (x *Node) FindChild(FlagsVar TraverseFlags, DataVar uintptr) *Node

Finds the first child of a #GNode with the given data.

func (*Node) FirstSibling 

func (x *Node) FirstSibling() *Node

Gets the first sibling of a #GNode. This could possibly be the node itself.

func (*Node) GetRoot 

func (x *Node) GetRoot() *Node

Gets the root of a tree.

func (*Node) GoPointer 

func (x *Node) GoPointer() uintptr

func (*Node) Insert 

func (x *Node) Insert(PositionVar int, NodeVar *Node) *Node

Inserts a #GNode beneath the parent at the given position.

func (*Node) InsertAfter 

func (x *Node) InsertAfter(SiblingVar *Node, NodeVar *Node) *Node

Inserts a #GNode beneath the parent after the given sibling.

func (*Node) InsertBefore 

func (x *Node) InsertBefore(SiblingVar *Node, NodeVar *Node) *Node

Inserts a #GNode beneath the parent before the given sibling.

func (*Node) IsAncestor 

func (x *Node) IsAncestor(DescendantVar *Node) bool

Returns %TRUE if @node is an ancestor of @descendant. This is true if node is the parent of @descendant, or if node is the grandparent of @descendant etc.

func (*Node) LastChild 

func (x *Node) LastChild() *Node

Gets the last child of a #GNode.

func (*Node) LastSibling 

func (x *Node) LastSibling() *Node

Gets the last sibling of a #GNode. This could possibly be the node itself.

func (*Node) MaxHeight 

func (x *Node) MaxHeight() uint

Gets the maximum height of all branches beneath a #GNode. This is the maximum distance from the #GNode to all leaf nodes.

If @root is %NULL, 0 is returned. If @root has no children, 1 is returned. If @root has children, 2 is returned. And so on.

func (*Node) NChildren 

func (x *Node) NChildren() uint

Gets the number of children of a #GNode.

func (*Node) NNodes 

func (x *Node) NNodes(FlagsVar TraverseFlags) uint

Gets the number of nodes in a tree.

func (*Node) NthChild 

func (x *Node) NthChild(NVar uint) *Node

Gets a child of a #GNode, using the given index. The first child is at index 0. If the index is too big, %NULL is returned.

func (*Node) Prepend 

func (x *Node) Prepend(NodeVar *Node) *Node

Inserts a #GNode as the first child of the given parent.

func (*Node) ReverseChildren 

func (x *Node) ReverseChildren()

Reverses the order of the children of a #GNode. (It doesn't change the order of the grandchildren.)

func (*Node) Traverse 

func (x *Node) Traverse(OrderVar TraverseType, FlagsVar TraverseFlags, MaxDepthVar int, FuncVar *NodeTraverseFunc, DataVar uintptr)

Traverses a tree starting at the given root #GNode. It calls the given function for each node visited. The traversal can be halted at any point by returning %TRUE from @func. @func must not do anything that would modify the structure of the tree. 

func (x *Node) Unlink()

Unlinks a #GNode from a tree, resulting in two separate trees.

type NodeForeachFunc 

type NodeForeachFunc func(*Node, uintptr)

Specifies the type of function passed to g_node_children_foreach(). The function is called with each child node, together with the user data passed to g_node_children_foreach().

type NodeTraverseFunc 

type NodeTraverseFunc func(*Node, uintptr) bool

Specifies the type of function passed to g_node_traverse(). The function is called with each of the nodes visited, together with the user data passed to g_node_traverse(). If the function returns %TRUE, then the traversal is stopped.

type NormalizeMode 

type NormalizeMode int

Defines how a Unicode string is transformed in a canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character. Unicode strings should generally be normalized before comparing them. 

const (

	// standardize differences that do not affect the
	//     text content, such as the above-mentioned accent representation
	GNormalizeDefaultValue NormalizeMode = 0
	// another name for %G_NORMALIZE_DEFAULT
	GNormalizeNfdValue NormalizeMode = 0
	// like %G_NORMALIZE_DEFAULT, but with
	//     composed forms rather than a maximally decomposed form
	GNormalizeDefaultComposeValue NormalizeMode = 1
	// another name for %G_NORMALIZE_DEFAULT_COMPOSE
	GNormalizeNfcValue NormalizeMode = 1
	// beyond %G_NORMALIZE_DEFAULT also standardize the
	//     "compatibility" characters in Unicode, such as SUPERSCRIPT THREE
	//     to the standard forms (in this case DIGIT THREE). Formatting
	//     information may be lost but for most text operations such
	//     characters should be considered the same
	GNormalizeAllValue NormalizeMode = 2
	// another name for %G_NORMALIZE_ALL
	GNormalizeNfkdValue NormalizeMode = 2
	// like %G_NORMALIZE_ALL, but with composed
	//     forms rather than a maximally decomposed form
	GNormalizeAllComposeValue NormalizeMode = 3
	// another name for %G_NORMALIZE_ALL_COMPOSE
	GNormalizeNfkcValue NormalizeMode = 3
)

type NumberParserError 

type NumberParserError int

Error codes returned by functions converting a string to a number. 

const (

	// string was not a valid number
	GNumberParserErrorInvalidValue NumberParserError = 0
	// string was a number, but out of bounds
	GNumberParserErrorOutOfBoundsValue NumberParserError = 1
)

type Once 

type Once struct {
	Status OnceStatus

	Retval uintptr
	// contains filtered or unexported fields
}

A #GOnce struct controls a one-time initialization function. Any one-time initialization function must have its own unique #GOnce struct.

func (*Once) GoPointer 

func (x *Once) GoPointer() uintptr

func (*Once) Impl 

func (x *Once) Impl(FuncVar *ThreadFunc, ArgVar uintptr) uintptr

type OnceStatus 

type OnceStatus int

The possible statuses of a one-time initialization function controlled by a #GOnce struct. 

const (

	// the function has not been called yet.
	GOnceStatusNotcalledValue OnceStatus = 0
	// the function call is currently in progress.
	GOnceStatusProgressValue OnceStatus = 1
	// the function has been called.
	GOnceStatusReadyValue OnceStatus = 2
)

type OptionArg 

type OptionArg int

The #GOptionArg enum values determine which type of extra argument the options expect to find. If an option expects an extra argument, it can be specified in several ways; with a short option: `-x arg`, with a long option: `--name arg` or combined in a single argument: `--name=arg`. 

const (

	// No extra argument. This is useful for simple flags or booleans.
	GOptionArgNoneValue OptionArg = 0
	// The option takes a UTF-8 string argument.
	GOptionArgStringValue OptionArg = 1
	// The option takes an integer argument.
	GOptionArgIntValue OptionArg = 2
	// The option provides a callback (of type #GOptionArgFunc)
	//   to parse the extra argument.
	GOptionArgCallbackValue OptionArg = 3
	// The option takes a filename as argument, which will
	//      be in the GLib filename encoding rather than UTF-8.
	GOptionArgFilenameValue OptionArg = 4
	// The option takes a string argument, multiple
	//   uses of the option are collected into an array of strings.
	GOptionArgStringArrayValue OptionArg = 5
	// The option takes a filename as argument,
	//   multiple uses of the option are collected into an array of strings.
	GOptionArgFilenameArrayValue OptionArg = 6
	// The option takes a double argument. The argument
	//   can be formatted either for the user's locale or for the "C" locale.
	//   Since 2.12
	GOptionArgDoubleValue OptionArg = 7
	// The option takes a 64-bit integer. Like
	//   %G_OPTION_ARG_INT but for larger numbers. The number can be in
	//   decimal base, or in hexadecimal (when prefixed with `0x`, for
	//   example, `0xffffffff`). Since 2.12
	GOptionArgInt64Value OptionArg = 8
)

type OptionArgFunc 

type OptionArgFunc func(string, string, uintptr, **Error) bool

The type of function to be passed as callback for %G_OPTION_ARG_CALLBACK options.

type OptionContext 

type OptionContext struct {
	// contains filtered or unexported fields
}

A `GOptionContext` struct defines which options are accepted by the commandline option parser. The struct has only private fields and should not be directly accessed.

func (*OptionContext) AddGroup 

func (x *OptionContext) AddGroup(GroupVar *OptionGroup)

Adds a #GOptionGroup to the @context, so that parsing with @context will recognize the options in the group. Note that this will take ownership of the @group and thus the @group should not be freed.

func (*OptionContext) AddMainEntries 

func (x *OptionContext) AddMainEntries(EntriesVar []OptionEntry, TranslationDomainVar *string)

A convenience function which creates a main group if it doesn't exist, adds the @entries to it and sets the translation domain.

func (*OptionContext) Free 

func (x *OptionContext) Free()

Frees context and all the groups which have been added to it.

Please note that parsed arguments need to be freed separately (see #GOptionEntry).

func (*OptionContext) GetDescription 

func (x *OptionContext) GetDescription() string

Returns the description. See g_option_context_set_description().

func (*OptionContext) GetHelp 

func (x *OptionContext) GetHelp(MainHelpVar bool, GroupVar *OptionGroup) string

Returns a formatted, translated help text for the given context. To obtain the text produced by `--help`, call `g_option_context_get_help (context, TRUE, NULL)`. To obtain the text produced by `--help-all`, call `g_option_context_get_help (context, FALSE, NULL)`. To obtain the help text for an option group, call `g_option_context_get_help (context, FALSE, group)`.

func (*OptionContext) GetHelpEnabled 

func (x *OptionContext) GetHelpEnabled() bool

Returns whether automatic `--help` generation is turned on for @context. See g_option_context_set_help_enabled().

func (*OptionContext) GetIgnoreUnknownOptions 

func (x *OptionContext) GetIgnoreUnknownOptions() bool

Returns whether unknown options are ignored or not. See g_option_context_set_ignore_unknown_options().

func (*OptionContext) GetMainGroup 

func (x *OptionContext) GetMainGroup() *OptionGroup

Returns a pointer to the main group of @context.

func (*OptionContext) GetStrictPosix 

func (x *OptionContext) GetStrictPosix() bool

Returns whether strict POSIX code is enabled.

See g_option_context_set_strict_posix() for more information.

func (*OptionContext) GetSummary 

func (x *OptionContext) GetSummary() string

Returns the summary. See g_option_context_set_summary().

func (*OptionContext) GoPointer 

func (x *OptionContext) GoPointer() uintptr

func (*OptionContext) Parse 

func (x *OptionContext) Parse(ArgcVar *int, ArgvVar *[]string) (bool, error)

Parses the command line arguments, recognizing options which have been added to @context. A side-effect of calling this function is that g_set_prgname() will be called.

If the parsing is successful, any parsed arguments are removed from the array and @argc and @argv are updated accordingly. A '--' option is stripped from @argv unless there are unparsed options before and after it, or some of the options after it start with '-'. In case of an error, @argc and @argv are left unmodified.

If automatic `--help` support is enabled (see g_option_context_set_help_enabled()), and the @argv array contains one of the recognized help options, this function will produce help output to stdout and call `exit (0)`.

Note that function depends on the [current locale](running.html#locale) for automatic character set conversion of string and filename arguments.

func (*OptionContext) ParseStrv 

func (x *OptionContext) ParseStrv(ArgumentsVar *[]string) (bool, error)

Parses the command line arguments.

This function is similar to g_option_context_parse() except that it respects the normal memory rules when dealing with a strv instead of assuming that the passed-in array is the argv of the main function.

In particular, strings that are removed from the arguments list will be freed using g_free().

On Windows, the strings are expected to be in UTF-8. This is in contrast to g_option_context_parse() which expects them to be in the system codepage, which is how they are passed as @argv to main(). See g_win32_get_command_line() for a solution.

This function is useful if you are trying to use #GOptionContext with #GApplication.

func (*OptionContext) SetDescription 

func (x *OptionContext) SetDescription(DescriptionVar *string)

Adds a string to be displayed in `--help` output after the list of options. This text often includes a bug reporting address.

Note that the summary is translated (see g_option_context_set_translate_func()).

func (*OptionContext) SetHelpEnabled 

func (x *OptionContext) SetHelpEnabled(HelpEnabledVar bool)

Enables or disables automatic generation of `--help` output. By default, g_option_context_parse() recognizes `--help`, `-h`, `-?`, `--help-all` and `--help-groupname` and creates suitable output to stdout.

func (*OptionContext) SetIgnoreUnknownOptions 

func (x *OptionContext) SetIgnoreUnknownOptions(IgnoreUnknownVar bool)

Sets whether to ignore unknown options or not. If an argument is ignored, it is left in the @argv array after parsing. By default, g_option_context_parse() treats unknown options as error.

This setting does not affect non-option arguments (i.e. arguments which don't start with a dash). But note that GOption cannot reliably determine whether a non-option belongs to a preceding unknown option.

func (*OptionContext) SetMainGroup 

func (x *OptionContext) SetMainGroup(GroupVar *OptionGroup)

Sets a #GOptionGroup as main group of the @context. This has the same effect as calling g_option_context_add_group(), the only difference is that the options in the main group are treated differently when generating `--help` output.

func (*OptionContext) SetStrictPosix 

func (x *OptionContext) SetStrictPosix(StrictPosixVar bool)

Sets strict POSIX mode.

By default, this mode is disabled.

In strict POSIX mode, the first non-argument parameter encountered (eg: filename) terminates argument processing. Remaining arguments are treated as non-options and are not attempted to be parsed.

If strict POSIX mode is disabled then parsing is done in the GNU way where option arguments can be freely mixed with non-options.

As an example, consider "ls foo -l". With GNU style parsing, this will list "foo" in long mode. In strict POSIX style, this will list the files named "foo" and "-l".

It may be useful to force strict POSIX mode when creating "verb style" command line tools. For example, the "gsettings" command line tool supports the global option "--schemadir" as well as many subcommands ("get", "set", etc.) which each have their own set of arguments. Using strict POSIX mode will allow parsing the global options up to the verb name while leaving the remaining options to be parsed by the relevant subcommand (which can be determined by examining the verb name, which should be present in argv[1] after parsing).

func (*OptionContext) SetSummary 

func (x *OptionContext) SetSummary(SummaryVar *string)

Adds a string to be displayed in `--help` output before the list of options. This is typically a summary of the program functionality.

Note that the summary is translated (see g_option_context_set_translate_func() and g_option_context_set_translation_domain()).

func (*OptionContext) SetTranslateFunc 

func (x *OptionContext) SetTranslateFunc(FuncVar *TranslateFunc, DataVar uintptr, DestroyNotifyVar *DestroyNotify)

Sets the function which is used to translate the contexts user-visible strings, for `--help` output. If @func is %NULL, strings are not translated.

Note that option groups have their own translation functions, this function only affects the @parameter_string (see g_option_context_new()), the summary (see g_option_context_set_summary()) and the description (see g_option_context_set_description()).

If you are using gettext(), you only need to set the translation domain, see g_option_context_set_translation_domain().

func (*OptionContext) SetTranslationDomain 

func (x *OptionContext) SetTranslationDomain(DomainVar string)

A convenience function to use gettext() for translating user-visible strings.

type OptionEntry 

type OptionEntry struct {
	LongName uintptr

	ShortName byte

	Flags int32

	Arg OptionArg

	ArgData uintptr

	Description uintptr

	ArgDescription uintptr
	// contains filtered or unexported fields
}

- %G_OPTION_ARG_NONE: %gboolean

  • %G_OPTION_ARG_STRING: %gchar*

  • %G_OPTION_ARG_INT: %gint

  • %G_OPTION_ARG_FILENAME: %gchar*

  • %G_OPTION_ARG_STRING_ARRAY: %gchar**

  • %G_OPTION_ARG_FILENAME_ARRAY: %gchar**

  • %G_OPTION_ARG_DOUBLE: %gdouble

    If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME, the location will contain a newly allocated string if the option was given. That string needs to be freed by the callee using g_free(). Likewise if @arg type is %G_OPTION_ARG_STRING_ARRAY or %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().

A GOptionEntry struct defines a single option. To have an effect, they must be added to a #GOptionGroup with g_option_context_add_main_entries() or g_option_group_add_entries().

func (*OptionEntry) GoPointer 

func (x *OptionEntry) GoPointer() uintptr

type OptionError 

type OptionError int

Error codes returned by option parsing. 

const (

	// An option was not known to the parser.
	//  This error will only be reported, if the parser hasn't been instructed
	//  to ignore unknown options, see g_option_context_set_ignore_unknown_options().
	GOptionErrorUnknownOptionValue OptionError = 0
	// A value couldn't be parsed.
	GOptionErrorBadValueValue OptionError = 1
	// A #GOptionArgFunc callback failed.
	GOptionErrorFailedValue OptionError = 2
)

type OptionErrorFunc 

type OptionErrorFunc func(*OptionContext, *OptionGroup, uintptr, **Error)

The type of function to be used as callback when a parse error occurs.

type OptionFlags 

type OptionFlags int

Flags which modify individual options. 

const (

	// No flags.
	GOptionFlagNoneValue OptionFlags = 0
	// The option doesn't appear in `--help` output.
	GOptionFlagHiddenValue OptionFlags = 1
	// The option appears in the main section of the
	//   `--help` output, even if it is defined in a group.
	GOptionFlagInMainValue OptionFlags = 2
	// For options of the %G_OPTION_ARG_NONE kind, this
	//   flag indicates that the sense of the option is reversed. i.e. %FALSE will
	//   be stored into the argument rather than %TRUE.
	GOptionFlagReverseValue OptionFlags = 4
	// For options of the %G_OPTION_ARG_CALLBACK kind,
	//   this flag indicates that the callback does not take any argument
	//   (like a %G_OPTION_ARG_NONE option). Since 2.8
	GOptionFlagNoArgValue OptionFlags = 8
	// For options of the %G_OPTION_ARG_CALLBACK
	//   kind, this flag indicates that the argument should be passed to the
	//   callback in the GLib filename encoding rather than UTF-8. Since 2.8
	GOptionFlagFilenameValue OptionFlags = 16
	// For options of the %G_OPTION_ARG_CALLBACK
	//   kind, this flag indicates that the argument supply is optional.
	//   If no argument is given then data of %GOptionParseFunc will be
	//   set to NULL. Since 2.8
	GOptionFlagOptionalArgValue OptionFlags = 32
	// This flag turns off the automatic conflict
	//   resolution which prefixes long option names with `groupname-` if
	//   there is a conflict. This option should only be used in situations
	//   where aliasing is necessary to model some legacy commandline interface.
	//   It is not safe to use this option, unless all option groups are under
	//   your direct control. Since 2.8.
	GOptionFlagNoaliasValue OptionFlags = 64
	// This flag marks the option as deprecated in the `--help`.
	//
	// You should update the description of the option to describe what
	// the user should do in response to the deprecation, for instance:
	// remove the option, or replace it with another one.
	GOptionFlagDeprecatedValue OptionFlags = 128
)

type OptionGroup 

type OptionGroup struct {
	// contains filtered or unexported fields
}

A `GOptionGroup` struct defines the options in a single group. The struct has only private fields and should not be directly accessed.

All options in a group share the same translation function. Libraries which need to parse commandline options are expected to provide a function for getting a `GOptionGroup` holding their options, which the application can then add to its #GOptionContext.

func NewOptionGroup 

func NewOptionGroup(NameVar string, DescriptionVar string, HelpDescriptionVar string, UserDataVar uintptr, DestroyVar *DestroyNotify) *OptionGroup

Creates a new #GOptionGroup.

@description is typically used to provide a title for the group. If so, it is recommended that it’s written in title case, and has a trailing colon so that it matches the style of built-in GLib group titles such as ‘Application Options:’.

func (*OptionGroup) AddEntries 

func (x *OptionGroup) AddEntries(EntriesVar []OptionEntry)

Adds the options specified in @entries to @group.

func (*OptionGroup) Free 

func (x *OptionGroup) Free()

Frees a #GOptionGroup. Note that you must not free groups which have been added to a #GOptionContext.

func (*OptionGroup) GoPointer 

func (x *OptionGroup) GoPointer() uintptr

func (*OptionGroup) Ref 

func (x *OptionGroup) Ref() *OptionGroup

Increments the reference count of @group by one.

func (*OptionGroup) SetErrorHook 

func (x *OptionGroup) SetErrorHook(ErrorFuncVar *OptionErrorFunc)

Associates a function with @group which will be called from g_option_context_parse() when an error occurs.

Note that the user data to be passed to @error_func can be specified when constructing the group with g_option_group_new().

func (*OptionGroup) SetParseHooks 

func (x *OptionGroup) SetParseHooks(PreParseFuncVar *OptionParseFunc, PostParseFuncVar *OptionParseFunc)

Associates two functions with @group which will be called from g_option_context_parse() before the first option is parsed and after the last option has been parsed, respectively.

Note that the user data to be passed to @pre_parse_func and @post_parse_func can be specified when constructing the group with g_option_group_new().

func (*OptionGroup) SetTranslateFunc 

func (x *OptionGroup) SetTranslateFunc(FuncVar *TranslateFunc, DataVar uintptr, DestroyNotifyVar *DestroyNotify)

Sets the function which is used to translate user-visible strings, for `--help` output. Different groups can use different #GTranslateFuncs. If @func is %NULL, strings are not translated.

If you are using gettext(), you only need to set the translation domain, see g_option_group_set_translation_domain().

func (*OptionGroup) SetTranslationDomain 

func (x *OptionGroup) SetTranslationDomain(DomainVar string)

A convenience function to use gettext() for translating user-visible strings.

func (*OptionGroup) Unref 

func (x *OptionGroup) Unref()

Decrements the reference count of @group by one. If the reference count drops to 0, the @group will be freed. and all memory allocated by the @group is released.

type OptionParseFunc 

type OptionParseFunc func(*OptionContext, *OptionGroup, uintptr, **Error) bool

The type of function that can be called before and after parsing.

type PathBuf 

type PathBuf struct {
	Dummy [8]uintptr
	// contains filtered or unexported fields
}

`GPathBuf` is a helper type that allows you to easily build paths from individual elements, using the platform specific conventions for path separators.

```c g_auto (GPathBuf) path;

g_path_buf_init (&amp;path);

g_path_buf_push (&amp;path, "usr"); g_path_buf_push (&amp;path, "bin"); g_path_buf_push (&amp;path, "echo");

g_autofree char *echo = g_path_buf_to_path (&amp;path); g_assert_cmpstr (echo, ==, "/usr/bin/echo"); ```

You can also load a full path and then operate on its components:

```c g_auto (GPathBuf) path;

g_path_buf_init_from_path (&amp;path, "/usr/bin/echo");

g_path_buf_pop (&amp;path); g_path_buf_push (&amp;path, "sh");

g_autofree char *sh = g_path_buf_to_path (&amp;path); g_assert_cmpstr (sh, ==, "/usr/bin/sh"); ```

func (*PathBuf) Clear 

func (x *PathBuf) Clear()

Clears the contents of the path buffer.

This function should be use to free the resources in a stack-allocated `GPathBuf` initialized using g_path_buf_init() or g_path_buf_init_from_path().

func (*PathBuf) ClearToPath 

func (x *PathBuf) ClearToPath() string

Clears the contents of the path buffer and returns the built path.

This function returns `NULL` if the `GPathBuf` is empty.

See also: g_path_buf_to_path()

func (*PathBuf) Copy 

func (x *PathBuf) Copy() *PathBuf

Copies the contents of a path buffer into a new `GPathBuf`.

func (*PathBuf) Free 

func (x *PathBuf) Free()

Frees a `GPathBuf` allocated by g_path_buf_new().

func (*PathBuf) FreeToPath 

func (x *PathBuf) FreeToPath() string

Frees a `GPathBuf` allocated by g_path_buf_new(), and returns the path inside the buffer.

This function returns `NULL` if the `GPathBuf` is empty.

See also: g_path_buf_to_path()

func (*PathBuf) GoPointer 

func (x *PathBuf) GoPointer() uintptr

func (*PathBuf) Init 

func (x *PathBuf) Init() *PathBuf

Initializes a `GPathBuf` instance.

func (*PathBuf) InitFromPath 

func (x *PathBuf) InitFromPath(PathVar *string) *PathBuf

Initializes a `GPathBuf` instance with the given path.

func (*PathBuf) Pop 

func (x *PathBuf) Pop() bool

Removes the last element of the path buffer.

If there is only one element in the path buffer (for example, `/` on Unix-like operating systems or the drive on Windows systems), it will not be removed and %FALSE will be returned instead.

|[&lt;!-- language="C" --&gt; GPathBuf buf, cmp;

g_path_buf_init_from_path (&amp;buf, "/bin/sh");

g_path_buf_pop (&amp;buf); g_path_buf_init_from_path (&amp;cmp, "/bin"); g_assert_true (g_path_buf_equal (&amp;buf, &amp;cmp)); g_path_buf_clear (&amp;cmp);

g_path_buf_pop (&amp;buf); g_path_buf_init_from_path (&amp;cmp, "/"); g_assert_true (g_path_buf_equal (&amp;buf, &amp;cmp)); g_path_buf_clear (&amp;cmp);

g_path_buf_clear (&amp;buf); ]|

func (*PathBuf) Push 

func (x *PathBuf) Push(PathVar string) *PathBuf

Extends the given path buffer with @path.

If @path is absolute, it replaces the current path.

If @path contains a directory separator, the buffer is extended by as many elements the path provides.

On Windows, both forward slashes and backslashes are treated as directory separators. On other platforms, %G_DIR_SEPARATOR_S is the only directory separator.

|[&lt;!-- language="C" --&gt; GPathBuf buf, cmp;

g_path_buf_init_from_path (&amp;buf, "/tmp"); g_path_buf_push (&amp;buf, ".X11-unix/X0"); g_path_buf_init_from_path (&amp;cmp, "/tmp/.X11-unix/X0"); g_assert_true (g_path_buf_equal (&amp;buf, &amp;cmp)); g_path_buf_clear (&amp;cmp);

g_path_buf_push (&amp;buf, "/etc/locale.conf"); g_path_buf_init_from_path (&amp;cmp, "/etc/locale.conf"); g_assert_true (g_path_buf_equal (&amp;buf, &amp;cmp)); g_path_buf_clear (&amp;cmp);

g_path_buf_clear (&amp;buf); ]|

func (*PathBuf) SetExtension 

func (x *PathBuf) SetExtension(ExtensionVar *string) bool

Adds an extension to the file name in the path buffer.

If @extension is `NULL`, the extension will be unset.

If the path buffer does not have a file name set, this function returns `FALSE` and leaves the path buffer unmodified.

func (*PathBuf) SetFilename 

func (x *PathBuf) SetFilename(FileNameVar string) bool

Sets the file name of the path.

If the path buffer is empty, the filename is left unset and this function returns `FALSE`.

If the path buffer only contains the root element (on Unix-like operating systems) or the drive (on Windows), this is the equivalent of pushing the new @file_name.

If the path buffer contains a path, this is the equivalent of popping the path buffer and pushing @file_name, creating a sibling of the original path.

|[&lt;!-- language="C" --&gt; GPathBuf buf, cmp;

g_path_buf_init_from_path (&amp;buf, "/");

g_path_buf_set_filename (&amp;buf, "bar"); g_path_buf_init_from_path (&amp;cmp, "/bar"); g_assert_true (g_path_buf_equal (&amp;buf, &amp;cmp)); g_path_buf_clear (&amp;cmp);

g_path_buf_set_filename (&amp;buf, "baz.txt"); g_path_buf_init_from_path (&amp;cmp, "/baz.txt"); g_assert_true (g_path_buf_equal (&amp;buf, &amp;cmp); g_path_buf_clear (&amp;cmp);

g_path_buf_clear (&amp;buf); ]|

func (*PathBuf) ToPath 

func (x *PathBuf) ToPath() string

Retrieves the built path from the path buffer.

On Windows, the result contains backslashes as directory separators, even if forward slashes were used in input.

If the path buffer is empty, this function returns `NULL`.

type PatternSpec 

type PatternSpec struct {
	// contains filtered or unexported fields
}

A `GPatternSpec` struct is the ‘compiled’ form of a glob-style pattern.

The [func@GLib.pattern_match_simple] and [method@GLib.PatternSpec.match] functions match a string against a pattern containing `*` and `?` wildcards with similar semantics as the standard `glob()` function: `*` matches an arbitrary, possibly empty, string, `?` matches an arbitrary character.

Note that in contrast to [`glob()`](man:glob(3)), the `/` character can be matched by the wildcards, there are no `[…]` character ranges and `*` and `?` can not be escaped to include them literally in a pattern.

When multiple strings must be matched against the same pattern, it is better to compile the pattern to a [struct@GLib.PatternSpec] using [ctor@GLib.PatternSpec.new] and use [method@GLib.PatternSpec.match_string] instead of [func@GLib.pattern_match_simple]. This avoids the overhead of repeated pattern compilation.

func NewPatternSpec 

func NewPatternSpec(PatternVar string) *PatternSpec

Compiles a pattern to a [type@GLib.PatternSpec].

func (*PatternSpec) Copy 

func (x *PatternSpec) Copy() *PatternSpec

Copies @pspec in a new [type@GLib.PatternSpec].

func (*PatternSpec) Equal 

func (x *PatternSpec) Equal(Pspec2Var *PatternSpec) bool

Compares two compiled pattern specs and returns whether they will match the same set of strings.

func (*PatternSpec) Free 

func (x *PatternSpec) Free()

Frees the memory allocated for the [type@GLib.PatternSpec].

func (*PatternSpec) GoPointer 

func (x *PatternSpec) GoPointer() uintptr

func (*PatternSpec) Match 

func (x *PatternSpec) Match(StringLengthVar uint, StringVar string, StringReversedVar *string) bool

Matches a string against a compiled pattern.

Passing the correct length of the string given is mandatory. The reversed string can be omitted by passing `NULL`, this is more efficient if the reversed version of the string to be matched is not at hand, as [method@GLib.PatternSpec.match] will only construct it if the compiled pattern requires reverse matches.

Note that, if the user code will (possibly) match a string against a multitude of patterns containing wildcards, chances are high that some patterns will require a reversed string. In this case, it’s more efficient to provide the reversed string to avoid multiple constructions thereof in the various calls to [method@GLib.PatternSpec.match].

Note also that the reverse of a UTF-8 encoded string can in general not be obtained by [func@GLib.strreverse]. This works only if the string does not contain any multibyte characters. GLib offers the [func@GLib.utf8_strreverse] function to reverse UTF-8 encoded strings.

func (*PatternSpec) MatchString 

func (x *PatternSpec) MatchString(StringVar string) bool

Matches a string against a compiled pattern.

If the string is to be matched against more than one pattern, consider using [method@GLib.PatternSpec.match] instead while supplying the reversed string.

type Pid 

type Pid = int

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).

GPid is used in GLib only for descendant processes spawned with the g_spawn functions.

type PollFD 

type PollFD struct {
	Fd int32

	Events uint16

	Revents uint16
	// contains filtered or unexported fields
}

Represents a file descriptor, which events to poll for, and which events occurred.

func (*PollFD) GoPointer 

func (x *PollFD) GoPointer() uintptr

type PollFunc 

type PollFunc func(*PollFD, uint, int) int

Specifies the type of function passed to g_main_context_set_poll_func(). The semantics of the function should match those of the poll() system call.

type PrintFunc 

type PrintFunc func(string)

Specifies the type of the print handler functions. These are called with the complete formatted string to output.

type Private 

type Private struct {
	P uintptr

	Notify DestroyNotify

	Future [2]uintptr
	// contains filtered or unexported fields
}

The #GPrivate struct is an opaque data structure to represent a thread-local data key. It is approximately equivalent to the pthread_setspecific()/pthread_getspecific() APIs on POSIX and to TlsSetValue()/TlsGetValue() on Windows.

If you don't already know why you might want this functionality, then you probably don't need it.

#GPrivate is a very limited resource (as far as 128 per program, shared between all libraries). It is also not possible to destroy a #GPrivate after it has been used. As such, it is only ever acceptable to use #GPrivate in static scope, and even then sparingly so.

See G_PRIVATE_INIT() for a couple of examples.

The #GPrivate structure should be considered opaque. It should only be accessed via the g_private_ functions.

func PrivateNew 

func PrivateNew(NotifyVar *DestroyNotify) *Private

Creates a new #GPrivate.

func (*Private) Get 

func (x *Private) Get() uintptr

Returns the current value of the thread local variable @key.

If the value has not yet been set in this thread, %NULL is returned. Values are never copied between threads (when a new thread is created, for example).

func (*Private) GoPointer 

func (x *Private) GoPointer() uintptr

func (*Private) Replace 

func (x *Private) Replace(ValueVar uintptr)

Sets the thread local variable @key to have the value @value in the current thread.

This function differs from g_private_set() in the following way: if the previous value was non-%NULL then the #GDestroyNotify handler for @key is run on it.

func (*Private) Set 

func (x *Private) Set(ValueVar uintptr)

Sets the thread local variable @key to have the value @value in the current thread.

This function differs from g_private_replace() in the following way: the #GDestroyNotify for @key is not called on the old value.

type PtrArray 

type PtrArray struct {
	Pdata uintptr

	Len uint
	// contains filtered or unexported fields
}

Contains the public fields of a `GPtrArray`.

func (*PtrArray) GoPointer 

func (x *PtrArray) GoPointer() uintptr

type Quark 

type Quark = uint32

A GQuark is a non-zero integer which uniquely identifies a particular string.

A GQuark value of zero is associated to `NULL`.

Given either the string or the `GQuark` identifier it is possible to retrieve the other.

Quarks are used for both [datasets and keyed data lists](datalist-and-dataset.html).

To create a new quark from a string, use [func@GLib.quark_from_string] or [func@GLib.quark_from_static_string].

To find the string corresponding to a given `GQuark`, use [func@GLib.quark_to_string].

To find the `GQuark` corresponding to a given string, use [func@GLib.quark_try_string].

Another use for the string pool maintained for the quark functions is string interning, using [func@GLib.intern_string] or [func@GLib.intern_static_string]. An interned string is a canonical representation for a string. One important advantage of interned strings is that they can be compared for equality by a simple pointer comparison, rather than using `strcmp()`.

func BookmarkFileErrorQuark 

func BookmarkFileErrorQuark() Quark

func ConvertErrorQuark 

func ConvertErrorQuark() Quark

func ErrorDomainRegister 

func ErrorDomainRegister(ErrorTypeNameVar string, ErrorTypePrivateSizeVar uint, ErrorTypeInitVar *ErrorInitFunc, ErrorTypeCopyVar *ErrorCopyFunc, ErrorTypeClearVar *ErrorClearFunc) Quark

This function registers an extended #GError domain. @error_type_name will be duplicated. Otherwise does the same as g_error_domain_register_static().

func ErrorDomainRegisterStatic 

func ErrorDomainRegisterStatic(ErrorTypeNameVar string, ErrorTypePrivateSizeVar uint, ErrorTypeInitVar *ErrorInitFunc, ErrorTypeCopyVar *ErrorCopyFunc, ErrorTypeClearVar *ErrorClearFunc) Quark

This function registers an extended #GError domain.

@error_type_name should not be freed. @error_type_private_size must be greater than 0.

@error_type_init receives an initialized #GError and should then initialize the private data.

@error_type_copy is a function that receives both original and a copy #GError and should copy the fields of the private error data. The standard #GError fields are already handled.

@error_type_clear receives the pointer to the error, and it should free the fields of the private error data. It should not free the struct itself though.

Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it already takes care of passing valid information to this function.

func FileErrorQuark 

func FileErrorQuark() Quark

func IoChannelErrorQuark 

func IoChannelErrorQuark() Quark

func KeyFileErrorQuark 

func KeyFileErrorQuark() Quark

func MarkupErrorQuark 

func MarkupErrorQuark() Quark

func NumberParserErrorQuark 

func NumberParserErrorQuark() Quark

func OptionErrorQuark 

func OptionErrorQuark() Quark

func QuarkFromStaticString 

func QuarkFromStaticString(StringVar *string) Quark

Gets the #GQuark identifying the given (static) string. If the string does not currently have an associated #GQuark, a new #GQuark is created, linked to the given string.

Note that this function is identical to g_quark_from_string() except that if a new #GQuark is created the string itself is used rather than a copy. This saves memory, but can only be used if the string will continue to exist until the program terminates. It can be used with statically allocated strings in the main program, but not with statically allocated memory in dynamically loaded modules, if you expect to ever unload the module again (e.g. do not use this function in GTK theme engines).

This function must not be used before library constructors have finished running. In particular, this means it cannot be used to initialize global variables in C++.

func QuarkFromString 

func QuarkFromString(StringVar *string) Quark

Gets the #GQuark identifying the given string. If the string does not currently have an associated #GQuark, a new #GQuark is created, using a copy of the string.

This function must not be used before library constructors have finished running. In particular, this means it cannot be used to initialize global variables in C++.

func QuarkTryString 

func QuarkTryString(StringVar *string) Quark

Gets the #GQuark associated with the given string, or 0 if string is %NULL or it has no associated #GQuark.

If you want the GQuark to be created if it doesn't already exist, use g_quark_from_string() or g_quark_from_static_string().

This function must not be used before library constructors have finished running.

func RegexErrorQuark 

func RegexErrorQuark() Quark

func ShellErrorQuark 

func ShellErrorQuark() Quark

func SpawnErrorQuark 

func SpawnErrorQuark() Quark

func SpawnExitErrorQuark 

func SpawnExitErrorQuark() Quark

func ThreadErrorQuark 

func ThreadErrorQuark() Quark

func UriErrorQuark 

func UriErrorQuark() Quark

func VariantParseErrorQuark 

func VariantParseErrorQuark() Quark

func VariantParserGetErrorQuark 

func VariantParserGetErrorQuark() Quark

Same as g_variant_error_quark().

type Queue 

type Queue struct {
	Head *List

	Tail *List

	Length uint
	// contains filtered or unexported fields
}

Contains the public fields of a Queue(data-structures.html#double-ended-queues).

func (*Queue) Clear 

func (x *Queue) Clear()

Removes all the elements in @queue. If queue elements contain dynamically-allocated memory, they should be freed first.

func (*Queue) ClearFull 

func (x *Queue) ClearFull(FreeFuncVar *DestroyNotify)

Convenience method, which frees all the memory used by a #GQueue, and calls the provided @free_func on each item in the #GQueue.

func (*Queue) Copy 

func (x *Queue) Copy() *Queue

Copies a @queue. Note that is a shallow copy. If the elements in the queue consist of pointers to data, the pointers are copied, but the actual data is not. 

func (x *Queue) DeleteLink(LinkVar *List)

Removes @link_ from @queue and frees it.

@link_ must be part of @queue.

func (*Queue) Find 

func (x *Queue) Find(DataVar uintptr) *List

Finds the first link in @queue which contains @data.

func (*Queue) FindCustom 

func (x *Queue) FindCustom(DataVar uintptr, FuncVar *CompareFunc) *List

Finds an element in a #GQueue, using a supplied function to find the desired element. It iterates over the queue, calling the given function which should return 0 when the desired element is found. The function takes two gconstpointer arguments, the #GQueue element's data as the first argument and the given user data as the second argument.

func (*Queue) Foreach 

func (x *Queue) Foreach(FuncVar *Func, UserDataVar uintptr)

Calls @func for each element in the queue passing @user_data to the function.

It is safe for @func to remove the element from @queue, but it must not modify any part of the queue after that element.

func (*Queue) Free 

func (x *Queue) Free()

Frees the memory allocated for the #GQueue. Only call this function if @queue was created with g_queue_new(). If queue elements contain dynamically-allocated memory, they should be freed first.

If queue elements contain dynamically-allocated memory, you should either use g_queue_free_full() or free them manually first.

func (*Queue) FreeFull 

func (x *Queue) FreeFull(FreeFuncVar *DestroyNotify)

Convenience method, which frees all the memory used by a #GQueue, and calls the specified destroy function on every element's data.

@free_func should not modify the queue (eg, by removing the freed element from it).

func (*Queue) GetLength 

func (x *Queue) GetLength() uint

Returns the number of items in @queue.

func (*Queue) GoPointer 

func (x *Queue) GoPointer() uintptr

func (*Queue) Index 

func (x *Queue) Index(DataVar uintptr) int

Returns the position of the first element in @queue which contains @data.

func (*Queue) Init 

func (x *Queue) Init()

A statically-allocated #GQueue must be initialized with this function before it can be used. Alternatively you can initialize it with %G_QUEUE_INIT. It is not necessary to initialize queues created with g_queue_new().

func (*Queue) InsertAfter 

func (x *Queue) InsertAfter(SiblingVar *List, DataVar uintptr)

Inserts @data into @queue after @sibling.

@sibling must be part of @queue. Since GLib 2.44 a %NULL sibling pushes the data at the head of the queue. 

func (x *Queue) InsertAfterLink(SiblingVar *List, LinkVar *List)

Inserts @link_ into @queue after @sibling.

@sibling must be part of @queue.

func (*Queue) InsertBefore 

func (x *Queue) InsertBefore(SiblingVar *List, DataVar uintptr)

Inserts @data into @queue before @sibling.

@sibling must be part of @queue. Since GLib 2.44 a %NULL sibling pushes the data at the tail of the queue. 

func (x *Queue) InsertBeforeLink(SiblingVar *List, LinkVar *List)

Inserts @link_ into @queue before @sibling.

@sibling must be part of @queue.

func (*Queue) InsertSorted 

func (x *Queue) InsertSorted(DataVar uintptr, FuncVar *CompareDataFunc, UserDataVar uintptr)

Inserts @data into @queue using @func to determine the new position.

func (*Queue) IsEmpty 

func (x *Queue) IsEmpty() bool

Returns %TRUE if the queue is empty.

func (*Queue) LinkIndex 

func (x *Queue) LinkIndex(LinkVar *List) int

Returns the position of @link_ in @queue.

func (*Queue) PeekHead 

func (x *Queue) PeekHead() uintptr

Returns the first element of the queue. 

func (x *Queue) PeekHeadLink() *List

Returns the first link in @queue.

func (*Queue) PeekNth 

func (x *Queue) PeekNth(NVar uint) uintptr

Returns the @n'th element of @queue. 

func (x *Queue) PeekNthLink(NVar uint) *List

Returns the link at the given position

func (*Queue) PeekTail 

func (x *Queue) PeekTail() uintptr

Returns the last element of the queue. 

func (x *Queue) PeekTailLink() *List

Returns the last link in @queue.

func (*Queue) PopHead 

func (x *Queue) PopHead() uintptr

Removes the first element of the queue and returns its data. 

func (x *Queue) PopHeadLink() *List

Removes and returns the first element of the queue.

func (*Queue) PopNth 

func (x *Queue) PopNth(NVar uint) uintptr

Removes the @n'th element of @queue and returns its data. 

func (x *Queue) PopNthLink(NVar uint) *List

Removes and returns the link at the given position.

func (*Queue) PopTail 

func (x *Queue) PopTail() uintptr

Removes the last element of the queue and returns its data. 

func (x *Queue) PopTailLink() *List

Removes and returns the last element of the queue.

func (*Queue) PushHead 

func (x *Queue) PushHead(DataVar uintptr)

Adds a new element at the head of the queue. 

func (x *Queue) PushHeadLink(LinkVar *List)

Adds a new element at the head of the queue.

func (*Queue) PushNth 

func (x *Queue) PushNth(DataVar uintptr, NVar int)

Inserts a new element into @queue at the given position. 

func (x *Queue) PushNthLink(NVar int, LinkVar *List)

Inserts @link into @queue at the given position.

func (*Queue) PushTail 

func (x *Queue) PushTail(DataVar uintptr)

Adds a new element at the tail of the queue. 

func (x *Queue) PushTailLink(LinkVar *List)

Adds a new element at the tail of the queue.

func (*Queue) Remove 

func (x *Queue) Remove(DataVar uintptr) bool

Removes the first element in @queue that contains @data.

func (*Queue) RemoveAll 

func (x *Queue) RemoveAll(DataVar uintptr) uint

Remove all elements whose data equals @data from @queue.

func (*Queue) Reverse 

func (x *Queue) Reverse()

Reverses the order of the items in @queue.

func (*Queue) Sort 

func (x *Queue) Sort(CompareFuncVar *CompareDataFunc, UserDataVar uintptr)

Sorts @queue using @compare_func. 

func (x *Queue) Unlink(LinkVar *List)

Unlinks @link_ so that it will no longer be part of @queue. The link is not freed.

@link_ must be part of @queue.

type RWLock 

type RWLock struct {
	P uintptr

	I [2]uint
	// contains filtered or unexported fields
}

The GRWLock struct is an opaque data structure to represent a reader-writer lock. It is similar to a #GMutex in that it allows multiple threads to coordinate access to a shared resource.

The difference to a mutex is that a reader-writer lock discriminates between read-only ('reader') and full ('writer') access. While only one thread at a time is allowed write access (by holding the 'writer' lock via g_rw_lock_writer_lock()), multiple threads can gain simultaneous read-only access (by holding the 'reader' lock via g_rw_lock_reader_lock()).

It is unspecified whether readers or writers have priority in acquiring the lock when a reader already holds the lock and a writer is queued to acquire it.

Here is an example for an array with access functions: |[&lt;!-- language="C" --&gt; 

 GRWLock lock;
 GPtrArray *array;

 gpointer
 my_array_get (guint index)
 {
   gpointer retval = NULL;

   if (!array)
     return NULL;

   g_rw_lock_reader_lock (&amp;lock);
   if (index &lt; array-&gt;len)
     retval = g_ptr_array_index (array, index);
   g_rw_lock_reader_unlock (&amp;lock);

   return retval;
 }

 void
 my_array_set (guint index, gpointer data)
 {
   g_rw_lock_writer_lock (&amp;lock);

   if (!array)
     array = g_ptr_array_new ();

   if (index &gt;= array-&gt;len)
     g_ptr_array_set_size (array, index+1);
   g_ptr_array_index (array, index) = data;

   g_rw_lock_writer_unlock (&amp;lock);
 }
]|

This example shows an array which can be accessed by many readers (the my_array_get() function) simultaneously, whereas the writers (the my_array_set() function) will only be allowed one at a time and only if no readers currently access the array. This is because of the potentially dangerous resizing of the array. Using these functions is fully multi-thread safe now.

If a #GRWLock is allocated in static storage then it can be used without initialisation. Otherwise, you should call g_rw_lock_init() on it and g_rw_lock_clear() when done.

A GRWLock should only be accessed with the g_rw_lock_ functions.

func (*RWLock) Clear 

func (x *RWLock) Clear()

Frees the resources allocated to a lock with g_rw_lock_init().

This function should not be used with a #GRWLock that has been statically allocated.

Calling g_rw_lock_clear() when any thread holds the lock leads to undefined behaviour.

func (*RWLock) GoPointer 

func (x *RWLock) GoPointer() uintptr

func (*RWLock) Init 

func (x *RWLock) Init()

Initializes a #GRWLock so that it can be used.

This function is useful to initialize a lock that has been allocated on the stack, or as part of a larger structure. It is not necessary to initialise a reader-writer lock that has been statically allocated.

|[&lt;!-- language="C" --&gt; 

typedef struct {
  GRWLock l;
  ...
} Blob;

Blob *b;

b = g_new (Blob, 1); g_rw_lock_init (&amp;b-&gt;l); ]|

To undo the effect of g_rw_lock_init() when a lock is no longer needed, use g_rw_lock_clear().

Calling g_rw_lock_init() on an already initialized #GRWLock leads to undefined behaviour.

func (*RWLock) ReaderLock 

func (x *RWLock) ReaderLock()

Obtain a read lock on @rw_lock. If another thread currently holds the write lock on @rw_lock, the current thread will block until the write lock was (held and) released. If another thread does not hold the write lock, but is waiting for it, it is implementation defined whether the reader or writer will block. Read locks can be taken recursively.

Calling g_rw_lock_reader_lock() while the current thread already owns a write lock leads to undefined behaviour. Read locks however can be taken recursively, in which case you need to make sure to call g_rw_lock_reader_unlock() the same amount of times.

It is implementation-defined how many read locks are allowed to be held on the same lock simultaneously. If the limit is hit, or if a deadlock is detected, a critical warning will be emitted.

func (*RWLock) ReaderTrylock 

func (x *RWLock) ReaderTrylock() bool

Tries to obtain a read lock on @rw_lock and returns %TRUE if the read lock was successfully obtained. Otherwise it returns %FALSE.

func (*RWLock) ReaderUnlock 

func (x *RWLock) ReaderUnlock()

Release a read lock on @rw_lock.

Calling g_rw_lock_reader_unlock() on a lock that is not held by the current thread leads to undefined behaviour.

func (*RWLock) WriterLock 

func (x *RWLock) WriterLock()

Obtain a write lock on @rw_lock. If another thread currently holds a read or write lock on @rw_lock, the current thread will block until all other threads have dropped their locks on @rw_lock.

Calling g_rw_lock_writer_lock() while the current thread already owns a read or write lock on @rw_lock leads to undefined behaviour.

func (*RWLock) WriterTrylock 

func (x *RWLock) WriterTrylock() bool

Tries to obtain a write lock on @rw_lock. If another thread currently holds a read or write lock on @rw_lock, it immediately returns %FALSE. Otherwise it locks @rw_lock and returns %TRUE.

func (*RWLock) WriterUnlock 

func (x *RWLock) WriterUnlock()

Release a write lock on @rw_lock.

Calling g_rw_lock_writer_unlock() on a lock that is not held by the current thread leads to undefined behaviour.

type RWLockReaderLocker 

type RWLockReaderLocker = uintptr

Opaque type. See g_rw_lock_reader_locker_new() for details.

type RWLockWriterLocker 

type RWLockWriterLocker = uintptr

Opaque type. See g_rw_lock_writer_locker_new() for details.

type Rand 

type Rand struct {
	// contains filtered or unexported fields
}

The GRand struct is an opaque data structure. It should only be accessed through the g_rand_* functions.

func NewRand 

func NewRand() *Rand

Creates a new random number generator initialized with a seed taken either from `/dev/urandom` (if existing) or from the current time (as a fallback).

On Windows, the seed is taken from rand_s().

func NewRandWithSeed 

func NewRandWithSeed(SeedVar uint32) *Rand

Creates a new random number generator initialized with @seed.

func NewRandWithSeedArray 

func NewRandWithSeedArray(SeedVar uint32, SeedLengthVar uint) *Rand

Creates a new random number generator initialized with @seed.

func (*Rand) Copy 

func (x *Rand) Copy() *Rand

Copies a #GRand into a new one with the same exact state as before. This way you can take a snapshot of the random number generator for replaying later.

func (*Rand) Double 

func (x *Rand) Double() float64

Returns the next random #gdouble from @rand_ equally distributed over the range [0..1).

func (*Rand) DoubleRange 

func (x *Rand) DoubleRange(BeginVar float64, EndVar float64) float64

Returns the next random #gdouble from @rand_ equally distributed over the range [@begin..@end).

func (*Rand) Free 

func (x *Rand) Free()

Frees the memory allocated for the #GRand.

func (*Rand) GoPointer 

func (x *Rand) GoPointer() uintptr

func (*Rand) Int 

func (x *Rand) Int() uint32

Returns the next random #guint32 from @rand_ equally distributed over the range [0..2^32-1].

func (*Rand) IntRange 

func (x *Rand) IntRange(BeginVar int32, EndVar int32) int32

Returns the next random #gint32 from @rand_ equally distributed over the range [@begin..@end-1].

func (*Rand) SetSeed 

func (x *Rand) SetSeed(SeedVar uint32)

Sets the seed for the random number generator #GRand to @seed.

func (*Rand) SetSeedArray 

func (x *Rand) SetSeedArray(SeedVar uint32, SeedLengthVar uint)

Initializes the random number generator by an array of longs. Array can be of arbitrary size, though only the first 624 values are taken. This function is useful if you have many low entropy seeds, or if you require more then 32 bits of actual entropy for your application.

type RecMutex 

type RecMutex struct {
	P uintptr

	I [2]uint
	// contains filtered or unexported fields
}

The GRecMutex struct is an opaque data structure to represent a recursive mutex. It is similar to a #GMutex with the difference that it is possible to lock a GRecMutex multiple times in the same thread without deadlock. When doing so, care has to be taken to unlock the recursive mutex as often as it has been locked.

If a #GRecMutex is allocated in static storage then it can be used without initialisation. Otherwise, you should call g_rec_mutex_init() on it and g_rec_mutex_clear() when done.

A GRecMutex should only be accessed with the g_rec_mutex_ functions.

func (*RecMutex) Clear 

func (x *RecMutex) Clear()

Frees the resources allocated to a recursive mutex with g_rec_mutex_init().

This function should not be used with a #GRecMutex that has been statically allocated.

Calling g_rec_mutex_clear() on a locked recursive mutex leads to undefined behaviour.

func (*RecMutex) GoPointer 

func (x *RecMutex) GoPointer() uintptr

func (*RecMutex) Init 

func (x *RecMutex) Init()

Initializes a #GRecMutex so that it can be used.

This function is useful to initialize a recursive mutex that has been allocated on the stack, or as part of a larger structure.

It is not necessary to initialise a recursive mutex that has been statically allocated.

|[&lt;!-- language="C" --&gt; 

typedef struct {
  GRecMutex m;
  ...
} Blob;

Blob *b;

b = g_new (Blob, 1); g_rec_mutex_init (&amp;b-&gt;m); ]|

Calling g_rec_mutex_init() on an already initialized #GRecMutex leads to undefined behaviour.

To undo the effect of g_rec_mutex_init() when a recursive mutex is no longer needed, use g_rec_mutex_clear().

func (*RecMutex) Lock 

func (x *RecMutex) Lock()

Locks @rec_mutex. If @rec_mutex is already locked by another thread, the current thread will block until @rec_mutex is unlocked by the other thread. If @rec_mutex is already locked by the current thread, the 'lock count' of @rec_mutex is increased. The mutex will only become available again when it is unlocked as many times as it has been locked.

func (*RecMutex) Trylock 

func (x *RecMutex) Trylock() bool

Tries to lock @rec_mutex. If @rec_mutex is already locked by another thread, it immediately returns %FALSE. Otherwise it locks @rec_mutex and returns %TRUE.

func (*RecMutex) Unlock 

func (x *RecMutex) Unlock()

Unlocks @rec_mutex. If another thread is blocked in a g_rec_mutex_lock() call for @rec_mutex, it will become unblocked and can lock @rec_mutex itself.

Calling g_rec_mutex_unlock() on a recursive mutex that is not locked by the current thread leads to undefined behaviour.

type RecMutexLocker 

type RecMutexLocker = uintptr

Opaque type. See g_rec_mutex_locker_new() for details.

type RefString 

type RefString = byte

A typedef for a reference-counted string. A pointer to a #GRefString can be treated like a standard `char*` array by all code, but can additionally have `g_ref_string_*()` methods called on it. `g_ref_string_*()` methods cannot be called on `char*` arrays not allocated using g_ref_string_new().

If using #GRefString with autocleanups, g_autoptr() must be used rather than g_autofree(), so that the reference counting metadata is also freed.

type Regex 

type Regex struct {
	// contains filtered or unexported fields
}

A `GRegex` is a compiled form of a regular expression.

After instantiating a `GRegex`, you can use its methods to find matches in a string, replace matches within a string, or split the string at matches.

`GRegex` implements regular expression pattern matching using syntax and semantics (such as character classes, quantifiers, and capture groups) similar to Perl regular expression. See the [PCRE documentation](man:pcre2pattern(3)) for details.

A typical scenario for regex pattern matching is to check if a string matches a pattern. The following statements implement this scenario.

``` { .c } const char *regex_pattern = ".*GLib.*"; const char *string_to_search = "You will love the GLib implementation of regex"; g_autoptr(GMatchInfo) match_info = NULL; g_autoptr(GRegex) regex = NULL;

regex = g_regex_new (regex_pattern, G_REGEX_DEFAULT, G_REGEX_MATCH_DEFAULT, NULL); g_assert (regex != NULL);

if (g_regex_match (regex, string_to_search, G_REGEX_MATCH_DEFAULT, &amp;match_info)) 

{
  int start_pos, end_pos;
  g_match_info_fetch_pos (match_info, 0, &amp;start_pos, &amp;end_pos);
  g_print ("Match successful! Overall pattern matches bytes %d to %d\n", start_pos, end_pos);
}

else 

{
  g_print ("No match!\n");
}

```

The constructor for `GRegex` includes two sets of bitmapped flags:

* [flags@GLib.RegexCompileFlags]—These flags control how GLib compiles the regex. There are options for case sensitivity, multiline, ignoring whitespace, etc. * [flags@GLib.RegexMatchFlags]—These flags control `GRegex`’s matching behavior, such as anchoring and customizing definitions for newline characters.

Some regex patterns include backslash assertions, such as `\d` (digit) or `\D` (non-digit). The regex pattern must escape those backslashes. For example, the pattern `"\\d\\D"` matches a digit followed by a non-digit.

GLib’s implementation of pattern matching includes a `start_position` argument for some of the match, replace, and split methods. Specifying a start position provides flexibility when you want to ignore the first _n_ characters of a string, but want to incorporate backslash assertions at character _n_ - 1. For example, a database field contains inconsistent spelling for a job title: `healthcare provider` and `health-care provider`. The database manager wants to make the spelling consistent by adding a hyphen when it is missing. The following regex pattern tests for the string `care` preceded by a non-word boundary character (instead of a hyphen) and followed by a space.

``` { .c } const char *regex_pattern = "\\Bcare\\s"; ```

An efficient way to match with this pattern is to start examining at `start_position` 6 in the string `healthcare` or `health-care`.

``` { .c } const char *regex_pattern = "\\Bcare\\s"; const char *string_to_search = "healthcare provider"; g_autoptr(GMatchInfo) match_info = NULL; g_autoptr(GRegex) regex = NULL;

regex = g_regex_new ( 

regex_pattern,
G_REGEX_DEFAULT,
G_REGEX_MATCH_DEFAULT,
NULL);

g_assert (regex != NULL);

g_regex_match_full ( 

regex,
string_to_search,
-1,
6, // position of 'c' in the test string.
G_REGEX_MATCH_DEFAULT,
&amp;match_info,
NULL);

```

The method [method@GLib.Regex.match_full] (and other methods implementing `start_pos`) allow for lookback before the start position to determine if the previous character satisfies an assertion.

Unless you set the [flags@GLib.RegexCompileFlags.RAW] as one of the `GRegexCompileFlags`, all the strings passed to `GRegex` methods must be encoded in UTF-8. The lengths and the positions inside the strings are in bytes and not in characters, so, for instance, `\xc3\xa0` (i.e., `à`) is two bytes long but it is treated as a single character. If you set `G_REGEX_RAW`, the strings can be non-valid UTF-8 strings and a byte is treated as a character, so `\xc3\xa0` is two bytes and two characters long.

Regarding line endings, `\n` matches a `\n` character, and `\r` matches a `\r` character. More generally, `\R` matches all typical line endings: CR + LF (`\r\n`), LF (linefeed, U+000A, `\n`), VT (vertical tab, U+000B, `\v`), FF (formfeed, U+000C, `\f`), CR (carriage return, U+000D, `\r`), NEL (next line, U+0085), LS (line separator, U+2028), and PS (paragraph separator, U+2029).

The behaviour of the dot, circumflex, and dollar metacharacters are affected by newline characters. By default, `GRegex` matches any newline character matched by `\R`. You can limit the matched newline characters by specifying the [flags@GLib.RegexMatchFlags.NEWLINE_CR], [flags@GLib.RegexMatchFlags.NEWLINE_LF], and [flags@GLib.RegexMatchFlags.NEWLINE_CRLF] compile options, and with [flags@GLib.RegexMatchFlags.NEWLINE_ANY], [flags@GLib.RegexMatchFlags.NEWLINE_CR], [flags@GLib.RegexMatchFlags.NEWLINE_LF] and [flags@GLib.RegexMatchFlags.NEWLINE_CRLF] match options. These settings are also relevant when compiling a pattern if [flags@GLib.RegexCompileFlags.EXTENDED] is set and an unescaped `#` outside a character class is encountered. This indicates a comment that lasts until after the next newline.

Because `GRegex` does not modify its internal state between creation and destruction, you can create and modify the same `GRegex` instance from different threads. In contrast, [struct@GLib.MatchInfo] is not thread safe.

The regular expression low-level functionalities are obtained through the excellent [PCRE](http://www.pcre.org/) library written by Philip Hazel.

func NewRegex 

func NewRegex(PatternVar string, CompileOptionsVar RegexCompileFlags, MatchOptionsVar RegexMatchFlags) (*Regex, error)

Compiles the regular expression to an internal form, and does the initial setup of the #GRegex structure.

func (*Regex) GetCaptureCount 

func (x *Regex) GetCaptureCount() int

Returns the number of capturing subpatterns in the pattern.

func (*Regex) GetCompileFlags 

func (x *Regex) GetCompileFlags() RegexCompileFlags

Returns the compile options that @regex was created with.

Depending on the version of PCRE that is used, this may or may not include flags set by option expressions such as `(?i)` found at the top-level within the compiled pattern.

func (*Regex) GetHasCrOrLf 

func (x *Regex) GetHasCrOrLf() bool

Checks whether the pattern contains explicit CR or LF references.

func (*Regex) GetMatchFlags 

func (x *Regex) GetMatchFlags() RegexMatchFlags

Returns the match options that @regex was created with.

func (*Regex) GetMaxBackref 

func (x *Regex) GetMaxBackref() int

Returns the number of the highest back reference in the pattern, or 0 if the pattern does not contain back references.

func (*Regex) GetMaxLookbehind 

func (x *Regex) GetMaxLookbehind() int

Gets the number of characters in the longest lookbehind assertion in the pattern. This information is useful when doing multi-segment matching using the partial matching facilities.

func (*Regex) GetPattern 

func (x *Regex) GetPattern() string

Gets the pattern string associated with @regex, i.e. a copy of the string passed to g_regex_new().

func (*Regex) GetStringNumber 

func (x *Regex) GetStringNumber(NameVar string) int

Retrieves the number of the subexpression named @name.

func (*Regex) GoPointer 

func (x *Regex) GoPointer() uintptr

func (*Regex) Match 

func (x *Regex) Match(StringVar string, MatchOptionsVar RegexMatchFlags, MatchInfoVar **MatchInfo) bool

Scans for a match in @string for the pattern in @regex. The @match_options are combined with the match options specified when the @regex structure was created, letting you have more flexibility in reusing #GRegex structures.

Unless %G_REGEX_RAW is specified in the options, @string must be valid UTF-8.

A #GMatchInfo structure, used to get information on the match, is stored in @match_info if not %NULL. Note that if @match_info is not %NULL then it is created even if the function returns %FALSE, i.e. you must free it regardless if regular expression actually matched.

To retrieve all the non-overlapping matches of the pattern in string you can use g_match_info_next().

|[&lt;!-- language="C" --&gt; static void print_uppercase_words (const gchar *string) 

{
  // Print all uppercase-only words.
  GRegex *regex;
  GMatchInfo *match_info;

  regex = g_regex_new ("[A-Z]+", G_REGEX_DEFAULT, G_REGEX_MATCH_DEFAULT, NULL);
  g_regex_match (regex, string, 0, &amp;match_info);
  while (g_match_info_matches (match_info))
    {
      gchar *word = g_match_info_fetch (match_info, 0);
      g_print ("Found: %s\n", word);
      g_free (word);
      g_match_info_next (match_info, NULL);
    }
  g_match_info_free (match_info);
  g_regex_unref (regex);
}

]|

@string is not copied and is used in #GMatchInfo internally. If you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined.

func (*Regex) MatchAll 

func (x *Regex) MatchAll(StringVar string, MatchOptionsVar RegexMatchFlags, MatchInfoVar **MatchInfo) bool

Using the standard algorithm for regular expression matching only the longest match in the string is retrieved. This function uses a different algorithm so it can retrieve all the possible matches. For more documentation see g_regex_match_all_full().

A #GMatchInfo structure, used to get information on the match, is stored in @match_info if not %NULL. Note that if @match_info is not %NULL then it is created even if the function returns %FALSE, i.e. you must free it regardless if regular expression actually matched.

@string is not copied and is used in #GMatchInfo internally. If you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined.

func (*Regex) MatchAllFull 

func (x *Regex) MatchAllFull(StringVar []string, StringLenVar int, StartPositionVar int, MatchOptionsVar RegexMatchFlags, MatchInfoVar **MatchInfo) (bool, error)

Using the standard algorithm for regular expression matching only the longest match in the @string is retrieved, it is not possible to obtain all the available matches. For instance matching `"&lt;a&gt; &lt;b&gt; &lt;c&gt;"` against the pattern `"&lt;.*&gt;"` you get `"&lt;a&gt; &lt;b&gt; &lt;c&gt;"`.

This function uses a different algorithm (called DFA, i.e. deterministic finite automaton), so it can retrieve all the possible matches, all starting at the same point in the string. For instance matching `"&lt;a&gt; &lt;b&gt; &lt;c&gt;"` against the pattern `"&lt;.*&gt;"` you would obtain three matches: `"&lt;a&gt; &lt;b&gt; &lt;c&gt;"`, `"&lt;a&gt; &lt;b&gt;"` and `"&lt;a&gt;"`.

The number of matched strings is retrieved using g_match_info_get_match_count(). To obtain the matched strings and their position you can use, respectively, g_match_info_fetch() and g_match_info_fetch_pos(). Note that the strings are returned in reverse order of length; that is, the longest matching string is given first.

Note that the DFA algorithm is slower than the standard one and it is not able to capture substrings, so backreferences do not work.

Setting @start_position differs from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b".

Unless %G_REGEX_RAW is specified in the options, @string must be valid UTF-8.

A #GMatchInfo structure, used to get information on the match, is stored in @match_info if not %NULL. Note that if @match_info is not %NULL then it is created even if the function returns %FALSE, i.e. you must free it regardless if regular expression actually matched.

@string is not copied and is used in #GMatchInfo internally. If you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined.

func (*Regex) MatchFull 

func (x *Regex) MatchFull(StringVar []string, StringLenVar int, StartPositionVar int, MatchOptionsVar RegexMatchFlags, MatchInfoVar **MatchInfo) (bool, error)

Scans for a match in @string for the pattern in @regex. The @match_options are combined with the match options specified when the @regex structure was created, letting you have more flexibility in reusing #GRegex structures.

Setting @start_position differs from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b".

Unless %G_REGEX_RAW is specified in the options, @string must be valid UTF-8.

A #GMatchInfo structure, used to get information on the match, is stored in @match_info if not %NULL. Note that if @match_info is not %NULL then it is created even if the function returns %FALSE, i.e. you must free it regardless if regular expression actually matched.

@string is not copied and is used in #GMatchInfo internally. If you use any #GMatchInfo method (except g_match_info_free()) after freeing or modifying @string then the behaviour is undefined.

To retrieve all the non-overlapping matches of the pattern in string you can use g_match_info_next().

|[&lt;!-- language="C" --&gt; static void print_uppercase_words (const gchar *string) 

{
  // Print all uppercase-only words.
  GRegex *regex;
  GMatchInfo *match_info;
  GError *error = NULL;

  regex = g_regex_new ("[A-Z]+", G_REGEX_DEFAULT, G_REGEX_MATCH_DEFAULT, NULL);
  g_regex_match_full (regex, string, -1, 0, 0, &amp;match_info, &amp;error);
  while (g_match_info_matches (match_info))
    {
      gchar *word = g_match_info_fetch (match_info, 0);
      g_print ("Found: %s\n", word);
      g_free (word);
      g_match_info_next (match_info, &amp;error);
    }
  g_match_info_free (match_info);
  g_regex_unref (regex);
  if (error != NULL)
    {
      g_printerr ("Error while matching: %s\n", error-&gt;message);
      g_error_free (error);
    }
}

]|

func (*Regex) Ref 

func (x *Regex) Ref() *Regex

Increases reference count of @regex by 1.

func (*Regex) Replace 

func (x *Regex) Replace(StringVar []string, StringLenVar int, StartPositionVar int, ReplacementVar string, MatchOptionsVar RegexMatchFlags) (string, error)

Replaces all occurrences of the pattern in @regex with the replacement text. Backreferences of the form `\number` or `\g&lt;number&gt;` in the replacement text are interpolated by the number-th captured subexpression of the match, `\g&lt;name&gt;` refers to the captured subexpression with the given name. `\0` refers to the complete match, but `\0` followed by a number is the octal representation of a character. To include a literal `\` in the replacement, write `\\\\`.

There are also escapes that changes the case of the following text:

- \l: Convert to lower case the next character - \u: Convert to upper case the next character - \L: Convert to lower case till \E - \U: Convert to upper case till \E - \E: End case modification

If you do not need to use backreferences use g_regex_replace_literal().

The @replacement string must be UTF-8 encoded even if %G_REGEX_RAW was passed to g_regex_new(). If you want to use not UTF-8 encoded strings you can use g_regex_replace_literal().

Setting @start_position differs from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b".

func (*Regex) ReplaceEval 

func (x *Regex) ReplaceEval(StringVar []string, StringLenVar int, StartPositionVar int, MatchOptionsVar RegexMatchFlags, EvalVar *RegexEvalCallback, UserDataVar uintptr) (string, error)

Replaces occurrences of the pattern in regex with the output of @eval for that occurrence.

Setting @start_position differs from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b".

The following example uses g_regex_replace_eval() to replace multiple strings at once: |[&lt;!-- language="C" --&gt; static gboolean eval_cb (const GMatchInfo *info, 

GString          *res,
gpointer          data)

{
  gchar *match;
  gchar *r;

   match = g_match_info_fetch (info, 0);
   r = g_hash_table_lookup ((GHashTable *)data, match);
   g_string_append (res, r);
   g_free (match);

   return FALSE;
}

...

GRegex *reg; GHashTable *h; gchar *res;

h = g_hash_table_new (g_str_hash, g_str_equal);

g_hash_table_insert (h, "1", "ONE"); g_hash_table_insert (h, "2", "TWO"); g_hash_table_insert (h, "3", "THREE"); g_hash_table_insert (h, "4", "FOUR");

reg = g_regex_new ("1|2|3|4", G_REGEX_DEFAULT, G_REGEX_MATCH_DEFAULT, NULL); res = g_regex_replace_eval (reg, text, -1, 0, 0, eval_cb, h, NULL); g_hash_table_destroy (h);

... ]|

func (*Regex) ReplaceLiteral 

func (x *Regex) ReplaceLiteral(StringVar []string, StringLenVar int, StartPositionVar int, ReplacementVar string, MatchOptionsVar RegexMatchFlags) (string, error)

Replaces all occurrences of the pattern in @regex with the replacement text. @replacement is replaced literally, to include backreferences use g_regex_replace().

Setting @start_position differs from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b".

func (*Regex) Split 

func (x *Regex) Split(StringVar string, MatchOptionsVar RegexMatchFlags) []string

Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first token.

As a special case, the result of splitting the empty string "" is an empty vector, not a vector containing a single string. The reason for this special case is that being able to represent an empty vector is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling this function.

A pattern that can match empty strings splits @string into separate characters wherever it matches the empty string between characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c".

func (*Regex) SplitFull 

func (x *Regex) SplitFull(StringVar []string, StringLenVar int, StartPositionVar int, MatchOptionsVar RegexMatchFlags, MaxTokensVar int) ([]string, error)

Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first token.

As a special case, the result of splitting the empty string "" is an empty vector, not a vector containing a single string. The reason for this special case is that being able to represent an empty vector is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling this function.

A pattern that can match empty strings splits @string into separate characters wherever it matches the empty string between characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c".

Setting @start_position differs from just passing over a shortened string and setting %G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b".

func (*Regex) Unref 

func (x *Regex) Unref()

Decreases reference count of @regex by 1. When reference count drops to zero, it frees all the memory associated with the regex structure.

type RegexCompileFlags 

type RegexCompileFlags int

Flags specifying compile-time options. 

const (

	// No special options set. Since: 2.74
	GRegexDefaultValue RegexCompileFlags = 0
	// Letters in the pattern match both upper- and
	//     lowercase letters. This option can be changed within a pattern
	//     by a "(?i)" option setting.
	GRegexCaselessValue RegexCompileFlags = 1
	// By default, GRegex treats the strings as consisting
	//     of a single line of characters (even if it actually contains
	//     newlines). The "start of line" metacharacter ("^") matches only
	//     at the start of the string, while the "end of line" metacharacter
	//     ("$") matches only at the end of the string, or before a terminating
	//     newline (unless %G_REGEX_DOLLAR_ENDONLY is set). When
	//     %G_REGEX_MULTILINE is set, the "start of line" and "end of line"
	//     constructs match immediately following or immediately before any
	//     newline in the string, respectively, as well as at the very start
	//     and end. This can be changed within a pattern by a "(?m)" option
	//     setting.
	GRegexMultilineValue RegexCompileFlags = 2
	// A dot metacharacter (".") in the pattern matches all
	//     characters, including newlines. Without it, newlines are excluded.
	//     This option can be changed within a pattern by a ("?s") option setting.
	GRegexDotallValue RegexCompileFlags = 4
	// Whitespace data characters in the pattern are
	//     totally ignored except when escaped or inside a character class.
	//     Whitespace does not include the VT character (code 11). In addition,
	//     characters between an unescaped "#" outside a character class and
	//     the next newline character, inclusive, are also ignored. This can
	//     be changed within a pattern by a "(?x)" option setting.
	GRegexExtendedValue RegexCompileFlags = 8
	// The pattern is forced to be "anchored", that is,
	//     it is constrained to match only at the first matching point in the
	//     string that is being searched. This effect can also be achieved by
	//     appropriate constructs in the pattern itself such as the "^"
	//     metacharacter.
	GRegexAnchoredValue RegexCompileFlags = 16
	// A dollar metacharacter ("$") in the pattern
	//     matches only at the end of the string. Without this option, a
	//     dollar also matches immediately before the final character if
	//     it is a newline (but not before any other newlines). This option
	//     is ignored if %G_REGEX_MULTILINE is set.
	GRegexDollarEndonlyValue RegexCompileFlags = 32
	// Inverts the "greediness" of the quantifiers so that
	//     they are not greedy by default, but become greedy if followed by "?".
	//     It can also be set by a "(?U)" option setting within the pattern.
	GRegexUngreedyValue RegexCompileFlags = 512
	// Usually strings must be valid UTF-8 strings, using this
	//     flag they are considered as a raw sequence of bytes.
	GRegexRawValue RegexCompileFlags = 2048
	// Disables the use of numbered capturing
	//     parentheses in the pattern. Any opening parenthesis that is not
	//     followed by "?" behaves as if it were followed by "?:" but named
	//     parentheses can still be used for capturing (and they acquire numbers
	//     in the usual way).
	GRegexNoAutoCaptureValue RegexCompileFlags = 4096
	// Since 2.74 and the port to pcre2, requests JIT
	//     compilation, which, if the just-in-time compiler is available, further
	//     processes a compiled pattern into machine code that executes much
	//     faster. However, it comes at the cost of extra processing before the
	//     match is performed, so it is most beneficial to use this when the same
	//     compiled pattern is used for matching many times. Before 2.74 this
	//     option used the built-in non-JIT optimizations in pcre1.
	GRegexOptimizeValue RegexCompileFlags = 8192
	// Limits an unanchored pattern to match before (or at) the
	//     first newline. Since: 2.34
	GRegexFirstlineValue RegexCompileFlags = 262144
	// Names used to identify capturing subpatterns need not
	//     be unique. This can be helpful for certain types of pattern when it
	//     is known that only one instance of the named subpattern can ever be
	//     matched.
	GRegexDupnamesValue RegexCompileFlags = 524288
	// Usually any newline character or character sequence is
	//     recognized. If this option is set, the only recognized newline character
	//     is '\r'.
	GRegexNewlineCrValue RegexCompileFlags = 1048576
	// Usually any newline character or character sequence is
	//     recognized. If this option is set, the only recognized newline character
	//     is '\n'.
	GRegexNewlineLfValue RegexCompileFlags = 2097152

	GRegexNewlineReserved1Value RegexCompileFlags = 4194304
)

type RegexError 

type RegexError int

Error codes returned by regular expressions functions. 

const (

	// Compilation of the regular expression failed.
	GRegexErrorCompileValue RegexError = 0
	// Optimization of the regular expression failed.
	GRegexErrorOptimizeValue RegexError = 1
	// Replacement failed due to an ill-formed replacement
	//     string.
	GRegexErrorReplaceValue RegexError = 2
	// The match process failed.
	GRegexErrorMatchValue RegexError = 3
	// Internal error of the regular expression engine.
	//     Since 2.16
	GRegexErrorInternalValue RegexError = 4
	// "\\" at end of pattern. Since 2.16
	GRegexErrorStrayBackslashValue RegexError = 101
	// "\\c" at end of pattern. Since 2.16
	GRegexErrorMissingControlCharValue RegexError = 102
	// Unrecognized character follows "\\".
	//     Since 2.16
	GRegexErrorUnrecognizedEscapeValue RegexError = 103
	// Numbers out of order in "{}"
	//     quantifier. Since 2.16
	GRegexErrorQuantifiersOutOfOrderValue RegexError = 104
	// Number too big in "{}" quantifier.
	//     Since 2.16
	GRegexErrorQuantifierTooBigValue RegexError = 105
	// Missing terminating "]" for
	//     character class. Since 2.16
	GRegexErrorUnterminatedCharacterClassValue RegexError = 106
	// Invalid escape sequence
	//     in character class. Since 2.16
	GRegexErrorInvalidEscapeInCharacterClassValue RegexError = 107
	// Range out of order in character class.
	//     Since 2.16
	GRegexErrorRangeOutOfOrderValue RegexError = 108
	// Nothing to repeat. Since 2.16
	GRegexErrorNothingToRepeatValue RegexError = 109
	// Unrecognized character after "(?",
	//     "(?&lt;" or "(?P". Since 2.16
	GRegexErrorUnrecognizedCharacterValue RegexError = 112
	// POSIX named classes are
	//     supported only within a class. Since 2.16
	GRegexErrorPosixNamedClassOutsideClassValue RegexError = 113
	// Missing terminating ")" or ")"
	//     without opening "(". Since 2.16
	GRegexErrorUnmatchedParenthesisValue RegexError = 114
	// Reference to non-existent
	//     subpattern. Since 2.16
	GRegexErrorInexistentSubpatternReferenceValue RegexError = 115
	// Missing terminating ")" after comment.
	//     Since 2.16
	GRegexErrorUnterminatedCommentValue RegexError = 118
	// Regular expression too large.
	//     Since 2.16
	GRegexErrorExpressionTooLargeValue RegexError = 120
	// Failed to get memory. Since 2.16
	GRegexErrorMemoryErrorValue RegexError = 121
	// Lookbehind assertion is not
	//     fixed length. Since 2.16
	GRegexErrorVariableLengthLookbehindValue RegexError = 125
	// Malformed number or name after "(?(".
	//     Since 2.16
	GRegexErrorMalformedConditionValue RegexError = 126
	// Conditional group contains
	//     more than two branches. Since 2.16
	GRegexErrorTooManyConditionalBranchesValue RegexError = 127
	// Assertion expected after "(?(".
	//     Since 2.16
	GRegexErrorAssertionExpectedValue RegexError = 128
	// Unknown POSIX class name.
	//     Since 2.16
	GRegexErrorUnknownPosixClassNameValue RegexError = 130
	// POSIX collating
	//     elements are not supported. Since 2.16
	GRegexErrorPosixCollatingElementsNotSupportedValue RegexError = 131
	// Character value in "\\x{...}" sequence
	//     is too large. Since 2.16
	GRegexErrorHexCodeTooLargeValue RegexError = 134
	// Invalid condition "(?(0)". Since 2.16
	GRegexErrorInvalidConditionValue RegexError = 135
	// \\C not allowed in
	//     lookbehind assertion. Since 2.16
	GRegexErrorSingleByteMatchInLookbehindValue RegexError = 136
	// Recursive call could loop indefinitely.
	//     Since 2.16
	GRegexErrorInfiniteLoopValue RegexError = 140
	// Missing terminator
	//     in subpattern name. Since 2.16
	GRegexErrorMissingSubpatternNameTerminatorValue RegexError = 142
	// Two named subpatterns have
	//     the same name. Since 2.16
	GRegexErrorDuplicateSubpatternNameValue RegexError = 143
	// Malformed "\\P" or "\\p" sequence.
	//     Since 2.16
	GRegexErrorMalformedPropertyValue RegexError = 146
	// Unknown property name after "\\P" or
	//     "\\p". Since 2.16
	GRegexErrorUnknownPropertyValue RegexError = 147
	// Subpattern name is too long
	//     (maximum 32 characters). Since 2.16
	GRegexErrorSubpatternNameTooLongValue RegexError = 148
	// Too many named subpatterns (maximum
	//     10,000). Since 2.16
	GRegexErrorTooManySubpatternsValue RegexError = 149
	// Octal value is greater than "\\377".
	//     Since 2.16
	GRegexErrorInvalidOctalValueValue RegexError = 151
	// "DEFINE" group contains more
	//     than one branch. Since 2.16
	GRegexErrorTooManyBranchesInDefineValue RegexError = 154
	// Repeating a "DEFINE" group is not allowed.
	//     This error is never raised. Since: 2.16 Deprecated: 2.34
	GRegexErrorDefineRepetionValue RegexError = 155
	// Inconsistent newline options.
	//     Since 2.16
	GRegexErrorInconsistentNewlineOptionsValue RegexError = 156
	// "\\g" is not followed by a braced,
	//      angle-bracketed, or quoted name or number, or by a plain number. Since: 2.16
	GRegexErrorMissingBackReferenceValue RegexError = 157
	// relative reference must not be zero. Since: 2.34
	GRegexErrorInvalidRelativeReferenceValue RegexError = 158
	// the backtracing
	//     control verb used does not allow an argument. Since: 2.34
	GRegexErrorBacktrackingControlVerbArgumentForbiddenValue RegexError = 159
	// unknown backtracing
	//     control verb. Since: 2.34
	GRegexErrorUnknownBacktrackingControlVerbValue RegexError = 160
	// number is too big in escape sequence. Since: 2.34
	GRegexErrorNumberTooBigValue RegexError = 161
	// Missing subpattern name. Since: 2.34
	GRegexErrorMissingSubpatternNameValue RegexError = 162
	// Missing digit. Since 2.34
	GRegexErrorMissingDigitValue RegexError = 163
	// In JavaScript compatibility mode,
	//     "[" is an invalid data character. Since: 2.34
	GRegexErrorInvalidDataCharacterValue RegexError = 164
	// different names for subpatterns of the
	//     same number are not allowed. Since: 2.34
	GRegexErrorExtraSubpatternNameValue RegexError = 165
	// the backtracing control
	//     verb requires an argument. Since: 2.34
	GRegexErrorBacktrackingControlVerbArgumentRequiredValue RegexError = 166
	// "\\c" must be followed by an ASCII
	//     character. Since: 2.34
	GRegexErrorInvalidControlCharValue RegexError = 168
	// "\\k" is not followed by a braced, angle-bracketed, or
	//     quoted name. Since: 2.34
	GRegexErrorMissingNameValue RegexError = 169
	// "\\N" is not supported in a class. Since: 2.34
	GRegexErrorNotSupportedInClassValue RegexError = 171
	// too many forward references. Since: 2.34
	GRegexErrorTooManyForwardReferencesValue RegexError = 172
	// the name is too long in "(*MARK)", "(*PRUNE)",
	//     "(*SKIP)", or "(*THEN)". Since: 2.34
	GRegexErrorNameTooLongValue RegexError = 175
	// the character value in the \\u sequence is
	//     too large. Since: 2.34
	GRegexErrorCharacterValueTooLargeValue RegexError = 176
)

type RegexEvalCallback 

type RegexEvalCallback func(*MatchInfo, *String, uintptr) bool

Specifies the type of the function passed to g_regex_replace_eval(). It is called for each occurrence of the pattern in the string passed to g_regex_replace_eval(), and it should append the replacement to @result.

type RegexMatchFlags 

type RegexMatchFlags int

Flags specifying match-time options. 

const (

	// No special options set. Since: 2.74
	GRegexMatchDefaultValue RegexMatchFlags = 0
	// The pattern is forced to be "anchored", that is,
	//     it is constrained to match only at the first matching point in the
	//     string that is being searched. This effect can also be achieved by
	//     appropriate constructs in the pattern itself such as the "^"
	//     metacharacter.
	GRegexMatchAnchoredValue RegexMatchFlags = 16
	// Specifies that first character of the string is
	//     not the beginning of a line, so the circumflex metacharacter should
	//     not match before it. Setting this without %G_REGEX_MULTILINE (at
	//     compile time) causes circumflex never to match. This option affects
	//     only the behaviour of the circumflex metacharacter, it does not
	//     affect "\A".
	GRegexMatchNotbolValue RegexMatchFlags = 128
	// Specifies that the end of the subject string is
	//     not the end of a line, so the dollar metacharacter should not match
	//     it nor (except in multiline mode) a newline immediately before it.
	//     Setting this without %G_REGEX_MULTILINE (at compile time) causes
	//     dollar never to match. This option affects only the behaviour of
	//     the dollar metacharacter, it does not affect "\Z" or "\z".
	GRegexMatchNoteolValue RegexMatchFlags = 256
	// An empty string is not considered to be a valid
	//     match if this option is set. If there are alternatives in the pattern,
	//     they are tried. If all the alternatives match the empty string, the
	//     entire match fails. For example, if the pattern "a?b?" is applied to
	//     a string not beginning with "a" or "b", it matches the empty string
	//     at the start of the string. With this flag set, this match is not
	//     valid, so GRegex searches further into the string for occurrences
	//     of "a" or "b".
	GRegexMatchNotemptyValue RegexMatchFlags = 1024
	// Turns on the partial matching feature, for more
	//     documentation on partial matching see g_match_info_is_partial_match().
	GRegexMatchPartialValue RegexMatchFlags = 32768
	// Overrides the newline definition set when
	//     creating a new #GRegex, setting the '\r' character as line terminator.
	GRegexMatchNewlineCrValue RegexMatchFlags = 1048576
	// Overrides the newline definition set when
	//     creating a new #GRegex, setting the '\n' character as line terminator.
	GRegexMatchNewlineLfValue RegexMatchFlags = 2097152
	// Overrides the newline definition set when
	//     creating a new #GRegex, setting the '\r\n' characters sequence as line terminator.
	GRegexMatchNewlineCrlfValue RegexMatchFlags = 3145728
	// Overrides the newline definition set when
	//     creating a new #GRegex, any Unicode newline sequence
	//     is recognised as a newline. These are '\r', '\n' and '\rn', and the
	//     single characters U+000B LINE TABULATION, U+000C FORM FEED (FF),
	//     U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and
	//     U+2029 PARAGRAPH SEPARATOR.
	GRegexMatchNewlineAnyValue RegexMatchFlags = 4194304
	// Overrides the newline definition set when
	//     creating a new #GRegex; any '\r', '\n', or '\r\n' character sequence
	//     is recognized as a newline. Since: 2.34
	GRegexMatchNewlineAnycrlfValue RegexMatchFlags = 5242880
	// Overrides the newline definition for "\R" set when
	//     creating a new #GRegex; only '\r', '\n', or '\r\n' character sequences
	//     are recognized as a newline by "\R". Since: 2.34
	GRegexMatchBsrAnycrlfValue RegexMatchFlags = 8388608
	// Overrides the newline definition for "\R" set when
	//     creating a new #GRegex; any Unicode newline character or character sequence
	//     are recognized as a newline by "\R". These are '\r', '\n' and '\rn', and the
	//     single characters U+000B LINE TABULATION, U+000C FORM FEED (FF),
	//     U+0085 NEXT LINE (NEL), U+2028 LINE SEPARATOR and
	//     U+2029 PARAGRAPH SEPARATOR. Since: 2.34
	GRegexMatchBsrAnyValue RegexMatchFlags = 16777216
	// An alias for %G_REGEX_MATCH_PARTIAL. Since: 2.34
	GRegexMatchPartialSoftValue RegexMatchFlags = 32768
	// Turns on the partial matching feature. In contrast to
	//     to %G_REGEX_MATCH_PARTIAL_SOFT, this stops matching as soon as a partial match
	//     is found, without continuing to search for a possible complete match. See
	//     g_match_info_is_partial_match() for more information. Since: 2.34
	GRegexMatchPartialHardValue RegexMatchFlags = 134217728
	// Like %G_REGEX_MATCH_NOTEMPTY, but only applied to
	//     the start of the matched string. For anchored
	//     patterns this can only happen for pattern containing "\K". Since: 2.34
	GRegexMatchNotemptyAtstartValue RegexMatchFlags = 268435456
)

type Relation 

type Relation struct {
	// contains filtered or unexported fields
}

A `GRelation` is a table of data which can be indexed on any number of fields, rather like simple database tables. A `GRelation` contains a number of records, called tuples. Each record contains a number of fields. Records are not ordered, so it is not possible to find the record at a particular index.

Note that `GRelation` tables are currently limited to 2 fields.

To create a `GRelation`, use [func@GLib.Relation.new].

To specify which fields should be indexed, use [method@GLib.Relation.index]. Note that this must be called before any tuples are added to the `GRelation`.

To add records to a `GRelation` use [method@GLib.Relation.insert].

To determine if a given record appears in a `GRelation`, use [method@GLib.Relation.exists]. Note that fields are compared directly, so pointers must point to the exact same position (i.e. different copies of the same string will not match.)

To count the number of records which have a particular value in a given field, use [method@GLib.Relation.count].

To get all the records which have a particular value in a given field, use [method@GLib.Relation.select]. To access fields of the resulting records, use [method@GLib.Tuples.index]. To free the resulting records use [method@GLib.Tuples.destroy].

To delete all records which have a particular value in a given field, use [method@GLib.Relation.delete].

To destroy the `GRelation`, use [method@GLib.Relation.destroy].

To help debug `GRelation` objects, use [method@GLib.Relation.print].

`GRelation` has been marked as deprecated, since this API has never been fully implemented, is not very actively maintained and rarely used.

func (*Relation) Count 

func (x *Relation) Count(KeyVar uintptr, FieldVar int) int

Returns the number of tuples in a #GRelation that have the given value in the given field.

func (*Relation) Delete 

func (x *Relation) Delete(KeyVar uintptr, FieldVar int) int

Deletes any records from a #GRelation that have the given key value in the given field.

func (*Relation) Destroy 

func (x *Relation) Destroy()

Destroys the #GRelation, freeing all memory allocated. However, it does not free memory allocated for the tuple data, so you should free that first if appropriate.

func (*Relation) Exists 

func (x *Relation) Exists(varArgs ...interface{}) bool

Returns %TRUE if a record with the given values exists in a #GRelation. Note that the values are compared directly, so that, for example, two copies of the same string will not match.

func (*Relation) GoPointer 

func (x *Relation) GoPointer() uintptr

func (*Relation) Index 

func (x *Relation) Index(FieldVar int, HashFuncVar *HashFunc, KeyEqualFuncVar *EqualFunc)

Creates an index on the given field. Note that this must be called before any records are added to the #GRelation.

func (*Relation) Insert 

func (x *Relation) Insert(varArgs ...interface{})

Inserts a record into a #GRelation.

func (*Relation) Print 

func (x *Relation) Print()

Outputs information about all records in a #GRelation, as well as the indexes. It is for debugging.

func (*Relation) Select 

func (x *Relation) Select(KeyVar uintptr, FieldVar int) *Tuples

Returns all of the tuples which have the given key in the given field. Use g_tuples_index() to access the returned records. The returned records should be freed with g_tuples_destroy().

type SList 

type SList struct {
	Data uintptr

	Next *SList
	// contains filtered or unexported fields
}

The #GSList struct is used for each element in the singly-linked list.

func (*SList) GoPointer 

func (x *SList) GoPointer() uintptr

type Scanner 

type Scanner struct {
	UserData uintptr

	MaxParseErrors uint

	ParseErrors uint

	InputName uintptr

	Qdata *Data

	Config *ScannerConfig

	Token TokenType

	Value TokenValue

	Line uint

	Position uint

	NextToken TokenType

	NextValue TokenValue

	NextLine uint

	NextPosition uint

	SymbolTable *HashTable

	InputFd int32

	Text uintptr

	TextEnd uintptr

	Buffer uintptr

	ScopeId uint

	MsgHandler ScannerMsgFunc
	// contains filtered or unexported fields
}

`GScanner` provides a general-purpose lexical scanner.

You should set @input_name after creating the scanner, since it is used by the default message handler when displaying warnings and errors. If you are scanning a file, the filename would be a good choice.

The @user_data and @max_parse_errors fields are not used. If you need to associate extra data with the scanner you can place them here.

If you want to use your own message handler you can set the @msg_handler field. The type of the message handler function is declared by #GScannerMsgFunc.

func (*Scanner) CurLine 

func (x *Scanner) CurLine() uint

Returns the current line in the input stream (counting from 1). This is the line of the last token parsed via g_scanner_get_next_token().

func (*Scanner) CurPosition 

func (x *Scanner) CurPosition() uint

Returns the current position in the current line (counting from 0). This is the position of the last token parsed via g_scanner_get_next_token().

func (*Scanner) CurToken 

func (x *Scanner) CurToken() TokenType

Gets the current token type. This is simply the @token field in the #GScanner structure.

func (*Scanner) CurValue 

func (x *Scanner) CurValue() TokenValue

Gets the current token value. This is simply the @value field in the #GScanner structure.

func (*Scanner) Destroy 

func (x *Scanner) Destroy()

Frees all memory used by the #GScanner.

func (*Scanner) Eof 

func (x *Scanner) Eof() bool

Returns %TRUE if the scanner has reached the end of the file or text buffer.

func (*Scanner) Error 

func (x *Scanner) Error(FormatVar string, varArgs ...interface{})

Outputs an error message, via the #GScanner message handler.

func (*Scanner) GetNextToken 

func (x *Scanner) GetNextToken() TokenType

Parses the next token just like g_scanner_peek_next_token() and also removes it from the input stream. The token data is placed in the @token, @value, @line, and @position fields of the #GScanner structure.

func (*Scanner) GoPointer 

func (x *Scanner) GoPointer() uintptr

func (*Scanner) InputFile 

func (x *Scanner) InputFile(InputFdVar int)

Prepares to scan a file.

func (*Scanner) InputText 

func (x *Scanner) InputText(TextVar string, TextLenVar uint)

Prepares to scan a text buffer.

func (*Scanner) LookupSymbol 

func (x *Scanner) LookupSymbol(SymbolVar string) uintptr

Looks up a symbol in the current scope and return its value. If the symbol is not bound in the current scope, %NULL is returned.

func (*Scanner) PeekNextToken 

func (x *Scanner) PeekNextToken() TokenType

Parses the next token, without removing it from the input stream. The token data is placed in the @next_token, @next_value, @next_line, and @next_position fields of the #GScanner structure.

Note that, while the token is not removed from the input stream (i.e. the next call to g_scanner_get_next_token() will return the same token), it will not be reevaluated. This can lead to surprising results when changing scope or the scanner configuration after peeking the next token. Getting the next token after switching the scope or configuration will return whatever was peeked before, regardless of any symbols that may have been added or removed in the new scope.

func (*Scanner) ScopeAddSymbol 

func (x *Scanner) ScopeAddSymbol(ScopeIdVar uint, SymbolVar string, ValueVar uintptr)

Adds a symbol to the given scope.

func (*Scanner) ScopeForeachSymbol 

func (x *Scanner) ScopeForeachSymbol(ScopeIdVar uint, FuncVar *HFunc, UserDataVar uintptr)

Calls the given function for each of the symbol/value pairs in the given scope of the #GScanner. The function is passed the symbol and value of each pair, and the given @user_data parameter.

func (*Scanner) ScopeLookupSymbol 

func (x *Scanner) ScopeLookupSymbol(ScopeIdVar uint, SymbolVar string) uintptr

Looks up a symbol in a scope and return its value. If the symbol is not bound in the scope, %NULL is returned.

func (*Scanner) ScopeRemoveSymbol 

func (x *Scanner) ScopeRemoveSymbol(ScopeIdVar uint, SymbolVar string)

Removes a symbol from a scope.

func (*Scanner) SetScope 

func (x *Scanner) SetScope(ScopeIdVar uint) uint

Sets the current scope.

func (*Scanner) SyncFileOffset 

func (x *Scanner) SyncFileOffset()

Rewinds the filedescriptor to the current buffer position and blows the file read ahead buffer. This is useful for third party uses of the scanners filedescriptor, which hooks onto the current scanning position.

func (*Scanner) UnexpToken 

func (x *Scanner) UnexpToken(ExpectedTokenVar TokenType, IdentifierSpecVar string, SymbolSpecVar string, SymbolNameVar string, MessageVar string, IsErrorVar int)

Outputs a message through the scanner's msg_handler, resulting from an unexpected token in the input stream. Note that you should not call g_scanner_peek_next_token() followed by g_scanner_unexp_token() without an intermediate call to g_scanner_get_next_token(), as g_scanner_unexp_token() evaluates the scanner's current token (not the peeked token) to construct part of the message.

func (*Scanner) Warn 

func (x *Scanner) Warn(FormatVar string, varArgs ...interface{})

Outputs a warning message, via the #GScanner message handler.

type ScannerConfig 

type ScannerConfig struct {
	CsetSkipCharacters uintptr

	CsetIdentifierFirst uintptr

	CsetIdentifierNth uintptr

	CpairCommentSingle uintptr

	CaseSensitive uint

	SkipCommentMulti uint

	SkipCommentSingle uint

	ScanCommentMulti uint

	ScanIdentifier uint

	ScanIdentifier1char uint

	ScanIdentifierNULL uint

	ScanSymbols uint

	ScanBinary uint

	ScanOctal uint

	ScanFloat uint

	ScanHex uint

	ScanHexDollar uint

	ScanStringSq uint

	ScanStringDq uint

	Numbers2Int uint

	Int2Float uint

	Identifier2String uint

	Char2Token uint

	Symbol2Token uint

	Scope0Fallback uint

	StoreInt64 uint

	PaddingDummy uint
	// contains filtered or unexported fields
}

Specifies the #GScanner parser configuration. Most settings can be changed during the parsing phase and will affect the lexical parsing of the next unpeeked token.

func (*ScannerConfig) GoPointer 

func (x *ScannerConfig) GoPointer() uintptr

type ScannerMsgFunc 

type ScannerMsgFunc func(*Scanner, string, bool)

Specifies the type of the message handler function.

type SeekType 

type SeekType int

An enumeration specifying the base position for a g_io_channel_seek_position() operation. 

const (

	// the current position in the file.
	GSeekCurValue SeekType = 0
	// the start of the file.
	GSeekSetValue SeekType = 1
	// the end of the file.
	GSeekEndValue SeekType = 2
)

type Sequence 

type Sequence struct {
	// contains filtered or unexported fields
}

The #GSequence struct is an opaque data type representing a [sequence](data-structures.html#scalable-lists) data type.

func (*Sequence) Append 

func (x *Sequence) Append(DataVar uintptr) *SequenceIter

Adds a new item to the end of @seq.

func (*Sequence) Foreach 

func (x *Sequence) Foreach(FuncVar *Func, UserDataVar uintptr)

Calls @func for each item in the sequence passing @user_data to the function. @func must not modify the sequence itself.

func (*Sequence) Free 

func (x *Sequence) Free()

Frees the memory allocated for @seq. If @seq has a data destroy function associated with it, that function is called on all items in @seq.

func (*Sequence) GetBeginIter 

func (x *Sequence) GetBeginIter() *SequenceIter

Returns the begin iterator for @seq.

func (*Sequence) GetEndIter 

func (x *Sequence) GetEndIter() *SequenceIter

Returns the end iterator for @seg

func (*Sequence) GetIterAtPos 

func (x *Sequence) GetIterAtPos(PosVar int) *SequenceIter

Returns the iterator at position @pos. If @pos is negative or larger than the number of items in @seq, the end iterator is returned.

func (*Sequence) GetLength 

func (x *Sequence) GetLength() int

Returns the positive length (&gt;= 0) of @seq. Note that this method is O(h) where `h' is the height of the tree. It is thus more efficient to use g_sequence_is_empty() when comparing the length to zero.

func (*Sequence) GoPointer 

func (x *Sequence) GoPointer() uintptr

func (*Sequence) InsertSorted 

func (x *Sequence) InsertSorted(DataVar uintptr, CmpFuncVar *CompareDataFunc, CmpDataVar uintptr) *SequenceIter

Inserts @data into @seq using @cmp_func to determine the new position. The sequence must already be sorted according to @cmp_func; otherwise the new position of @data is undefined.

@cmp_func is called with two items of the @seq, and @cmp_data. It should return 0 if the items are equal, a negative value if the first item comes before the second, and a positive value if the second item comes before the first.

Note that when adding a large amount of data to a #GSequence, it is more efficient to do unsorted insertions and then call g_sequence_sort() or g_sequence_sort_iter().

func (*Sequence) InsertSortedIter 

func (x *Sequence) InsertSortedIter(DataVar uintptr, IterCmpVar *SequenceIterCompareFunc, CmpDataVar uintptr) *SequenceIter

Like g_sequence_insert_sorted(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

@iter_cmp is called with two iterators pointing into @seq. It should return 0 if the iterators are equal, a negative value if the first iterator comes before the second, and a positive value if the second iterator comes before the first.

Note that when adding a large amount of data to a #GSequence, it is more efficient to do unsorted insertions and then call g_sequence_sort() or g_sequence_sort_iter().

func (*Sequence) IsEmpty 

func (x *Sequence) IsEmpty() bool

Returns %TRUE if the sequence contains zero items.

This function is functionally identical to checking the result of g_sequence_get_length() being equal to zero. However this function is implemented in O(1) running time.

func (*Sequence) Lookup 

func (x *Sequence) Lookup(DataVar uintptr, CmpFuncVar *CompareDataFunc, CmpDataVar uintptr) *SequenceIter

Returns an iterator pointing to the position of the first item found equal to @data according to @cmp_func and @cmp_data. If more than one item is equal, it is not guaranteed that it is the first which is returned. In that case, you can use g_sequence_iter_next() and g_sequence_iter_prev() to get others.

@cmp_func is called with two items of the @seq, and @cmp_data. It should return 0 if the items are equal, a negative value if the first item comes before the second, and a positive value if the second item comes before the first.

This function will fail if the data contained in the sequence is unsorted.

func (*Sequence) LookupIter 

func (x *Sequence) LookupIter(DataVar uintptr, IterCmpVar *SequenceIterCompareFunc, CmpDataVar uintptr) *SequenceIter

Like g_sequence_lookup(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

@iter_cmp is called with two iterators pointing into @seq. It should return 0 if the iterators are equal, a negative value if the first iterator comes before the second, and a positive value if the second iterator comes before the first.

This function will fail if the data contained in the sequence is unsorted.

func (*Sequence) Prepend 

func (x *Sequence) Prepend(DataVar uintptr) *SequenceIter

Adds a new item to the front of @seq

func (*Sequence) Search 

func (x *Sequence) Search(DataVar uintptr, CmpFuncVar *CompareDataFunc, CmpDataVar uintptr) *SequenceIter

Returns an iterator pointing to the position where @data would be inserted according to @cmp_func and @cmp_data.

@cmp_func is called with two items of the @seq, and @cmp_data. It should return 0 if the items are equal, a negative value if the first item comes before the second, and a positive value if the second item comes before the first.

If you are simply searching for an existing element of the sequence, consider using g_sequence_lookup().

This function will fail if the data contained in the sequence is unsorted.

func (*Sequence) SearchIter 

func (x *Sequence) SearchIter(DataVar uintptr, IterCmpVar *SequenceIterCompareFunc, CmpDataVar uintptr) *SequenceIter

Like g_sequence_search(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function.

@iter_cmp is called with two iterators pointing into @seq. It should return 0 if the iterators are equal, a negative value if the first iterator comes before the second, and a positive value if the second iterator comes before the first.

If you are simply searching for an existing element of the sequence, consider using g_sequence_lookup_iter().

This function will fail if the data contained in the sequence is unsorted.

func (*Sequence) Sort 

func (x *Sequence) Sort(CmpFuncVar *CompareDataFunc, CmpDataVar uintptr)

Sorts @seq using @cmp_func.

@cmp_func is passed two items of @seq and should return 0 if they are equal, a negative value if the first comes before the second, and a positive value if the second comes before the first.

func (*Sequence) SortIter 

func (x *Sequence) SortIter(CmpFuncVar *SequenceIterCompareFunc, CmpDataVar uintptr)

Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as the compare function

@cmp_func is called with two iterators pointing into @seq. It should return 0 if the iterators are equal, a negative value if the first iterator comes before the second, and a positive value if the second iterator comes before the first.

type SequenceIter 

type SequenceIter struct {
	// contains filtered or unexported fields
}

The #GSequenceIter struct is an opaque data type representing an iterator pointing into a #GSequence.

func SequenceInsertBefore 

func SequenceInsertBefore(IterVar *SequenceIter, DataVar uintptr) *SequenceIter

Inserts a new item just before the item pointed to by @iter.

func SequenceRangeGetMidpoint 

func SequenceRangeGetMidpoint(BeginVar *SequenceIter, EndVar *SequenceIter) *SequenceIter

Finds an iterator somewhere in the range (@begin, @end). This iterator will be close to the middle of the range, but is not guaranteed to be exactly in the middle.

The @begin and @end iterators must both point to the same sequence and @begin must come before or be equal to @end in the sequence.

func (*SequenceIter) Compare 

func (x *SequenceIter) Compare(BVar *SequenceIter) int

Returns a negative number if @a comes before @b, 0 if they are equal, and a positive number if @a comes after @b.

The @a and @b iterators must point into the same sequence.

func (*SequenceIter) GetPosition 

func (x *SequenceIter) GetPosition() int

Returns the position of @iter

func (*SequenceIter) GetSequence 

func (x *SequenceIter) GetSequence() *Sequence

Returns the #GSequence that @iter points into.

func (*SequenceIter) GoPointer 

func (x *SequenceIter) GoPointer() uintptr

func (*SequenceIter) IsBegin 

func (x *SequenceIter) IsBegin() bool

Returns whether @iter is the begin iterator

func (*SequenceIter) IsEnd 

func (x *SequenceIter) IsEnd() bool

Returns whether @iter is the end iterator

func (*SequenceIter) Move 

func (x *SequenceIter) Move(DeltaVar int) *SequenceIter

Returns the #GSequenceIter which is @delta positions away from @iter. If @iter is closer than -@delta positions to the beginning of the sequence, the begin iterator is returned. If @iter is closer than @delta positions to the end of the sequence, the end iterator is returned.

func (*SequenceIter) Next 

func (x *SequenceIter) Next() *SequenceIter

Returns an iterator pointing to the next position after @iter. If @iter is the end iterator, the end iterator is returned.

func (*SequenceIter) Prev 

func (x *SequenceIter) Prev() *SequenceIter

Returns an iterator pointing to the previous position before @iter. If @iter is the begin iterator, the begin iterator is returned.

type SequenceIterCompareFunc 

type SequenceIterCompareFunc func(*SequenceIter, *SequenceIter, uintptr) int

A #GSequenceIterCompareFunc is a function used to compare iterators. It must return zero if the iterators compare equal, a negative value if @a comes before @b, and a positive value if @b comes before @a.

type ShellError 

type ShellError int

Error codes returned by shell functions. 

const (

	// Mismatched or otherwise mangled quoting.
	GShellErrorBadQuotingValue ShellError = 0
	// String to be parsed was empty.
	GShellErrorEmptyStringValue ShellError = 1
	// Some other error.
	GShellErrorFailedValue ShellError = 2
)

type SliceConfig 

type SliceConfig int
const (
	GSliceConfigAlwaysMallocValue SliceConfig = 1

	GSliceConfigBypassMagazinesValue SliceConfig = 2

	GSliceConfigWorkingSetMsecsValue SliceConfig = 3

	GSliceConfigColorIncrementValue SliceConfig = 4

	GSliceConfigChunkSizesValue SliceConfig = 5

	GSliceConfigContentionCounterValue SliceConfig = 6
)

type Source 

type Source struct {
	CallbackData uintptr

	CallbackFuncs *SourceCallbackFuncs

	SourceFuncs *SourceFuncs

	RefCount uint

	Context *MainContext

	Priority int32

	Flags uint

	SourceId uint

	PollFds *SList

	Prev *Source

	Next *Source

	Name uintptr

	Priv *SourcePrivate
	// contains filtered or unexported fields
}

The `GSource` struct is an opaque data type representing an event source.

func ChildWatchSourceNew 

func ChildWatchSourceNew(PidVar Pid) *Source

Creates a new child watch source.

The source will not initially be associated with any [struct@GLib.MainContext] and must be added to one with [method@GLib.Source.attach] before it will be executed.

Note that child watch sources can only be used in conjunction with `g_spawn...` when the [flags@GLib.SpawnFlags.DO_NOT_REAP_CHILD] flag is used.

Note that on platforms where [type@GLib.Pid] must be explicitly closed (see [func@GLib.spawn_close_pid]) @pid must not be closed while the source is still active. Typically, you will want to call [func@GLib.spawn_close_pid] in the callback function for the source.

On POSIX platforms, the following restrictions apply to this API due to limitations in POSIX process interfaces:

  • @pid must be a child of this process.
  • @pid must be positive.
  • The application must not call [`waitpid()`](man:waitpid(1)) with a non-positive first argument, for instance in another thread.
  • The application must not wait for @pid to exit by any other mechanism, including `waitpid(pid, ...)` or a second child-watch source for the same @pid.
  • The application must not ignore `SIGCHLD`.
  • Before 2.78, the application could not send a signal ([`kill()`](man:kill(2))) to the watched @pid in a race free manner. Since 2.78, you can do that while the associated [struct@GLib.MainContext] is acquired.
  • Before 2.78, even after destroying the [struct@GLib.Source], you could not be sure that @pid wasn’t already reaped. Hence, it was also not safe to `kill()` or `waitpid()` on the process ID after the child watch source was gone. Destroying the source before it fired made it impossible to reliably reap the process.

If any of those conditions are not met, this and related APIs will not work correctly. This can often be diagnosed via a GLib warning stating that `ECHILD` was received by `waitpid()`.

Calling [`waitpid()`](man:waitpid(2)) for specific processes other than @pid remains a valid thing to do.

func IdleSourceNew 

func IdleSourceNew() *Source

Creates a new idle source.

The source will not initially be associated with any [struct@GLib.MainContext] and must be added to one with [method@GLib.Source.attach] before it will be executed. Note that the default priority for idle sources is [const@GLib.PRIORITY_DEFAULT_IDLE], as compared to other sources which have a default priority of [const@GLib.PRIORITY_DEFAULT].

func IoCreateWatch 

func IoCreateWatch(ChannelVar *IOChannel, ConditionVar IOCondition) *Source

Creates a #GSource that's dispatched when @condition is met for the given @channel. For example, if condition is %G_IO_IN, the source will be dispatched when there's data available for reading.

The callback function invoked by the #GSource should be added with g_source_set_callback(), but it has type #GIOFunc (not #GSourceFunc).

g_io_add_watch() is a simpler interface to this same functionality, for the case where you want to add the source to the default main loop context at the default priority.

On Windows, polling a #GSource created to watch a channel for a socket puts the socket in non-blocking mode. This is a side-effect of the implementation and unavoidable.

func MainCurrentSource 

func MainCurrentSource() *Source

Returns the currently firing source for this thread.

func NewSource 

func NewSource(SourceFuncsVar *SourceFuncs, StructSizeVar uint) *Source

Creates a new [struct@GLib.Source] structure.

The size is specified to allow creating structures derived from [struct@GLib.Source] that contain additional data. The size passed in must be at least `sizeof (GSource)`.

The source will not initially be associated with any [struct@GLib.MainContext] and must be added to one with [method@GLib.Source.attach] before it will be executed.

func TimeoutSourceNew 

func TimeoutSourceNew(IntervalVar uint) *Source

Creates a new timeout source.

The source will not initially be associated with any [struct@GLib.MainContext] and must be added to one with [method@GLib.Source.attach] before it will be executed.

The interval given is in terms of monotonic time, not wall clock time. See [func@GLib.get_monotonic_time].

func TimeoutSourceNewSeconds 

func TimeoutSourceNewSeconds(IntervalVar uint) *Source

Creates a new timeout source.

The source will not initially be associated with any [struct@GLib.MainContext] and must be added to one with [method@GLib.Source.attach] before it will be executed.

The scheduling granularity/accuracy of this timeout source will be in seconds.

The interval given is in terms of monotonic time, not wall clock time. See [func@GLib.get_monotonic_time].

func (*Source) AddChildSource 

func (x *Source) AddChildSource(ChildSourceVar *Source)

Adds @child_source to @source as a ‘polled’ source.

When @source is added to a [struct@GLib.MainContext], @child_source will be automatically added with the same priority. When @child_source is triggered, it will cause @source to dispatch (in addition to calling its own callback), and when @source is destroyed, it will destroy @child_source as well.

The @source will also still be dispatched if its own prepare/check functions indicate that it is ready.

If you don’t need @child_source to do anything on its own when it triggers, you can call `g_source_set_dummy_callback()` on it to set a callback that does nothing (except return true if appropriate).

The @source will hold a reference on @child_source while @child_source is attached to it.

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

func (*Source) AddPoll 

func (x *Source) AddPoll(FdVar *PollFD)

Adds a file descriptor to the set of file descriptors polled for this source.

This is usually combined with [ctor@GLib.Source.new] to add an event source. The event source’s check function will typically test the @revents field in the [struct@GLib.PollFD] struct and return true if events need to be processed.

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

Using this API forces the linear scanning of event sources on each main loop iteration. Newly-written event sources should try to use `g_source_add_unix_fd()` instead of this API.

func (*Source) AddUnixFd 

func (x *Source) AddUnixFd(FdVar int, EventsVar IOCondition) uintptr

Monitors @fd for the IO events in @events.

The tag returned by this function can be used to remove or modify the monitoring of the @fd using [method@GLib.Source.remove_unix_fd] or [method@GLib.Source.modify_unix_fd].

It is not necessary to remove the file descriptor before destroying the source; it will be cleaned up automatically.

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

As the name suggests, this function is not available on Windows.

func (*Source) Attach 

func (x *Source) Attach(ContextVar *MainContext) uint

Adds a [struct@GLib.Source] to a @context so that it will be executed within that context.

Remove it by calling [method@GLib.Source.destroy].

This function is safe to call from any thread, regardless of which thread the @context is running in.

func (*Source) Destroy 

func (x *Source) Destroy()

Removes a source from its [struct@GLib.MainContext], if any, and marks it as destroyed.

The source cannot be subsequently added to another context. It is safe to call this on sources which have already been removed from their context.

This does not unref the [struct@GLib.Source]: if you still hold a reference, use [method@GLib.Source.unref] to drop it.

This function is safe to call from any thread, regardless of which thread the [struct@GLib.MainContext] is running in.

If the source is currently attached to a [struct@GLib.MainContext], destroying it will effectively unset the callback similar to calling [method@GLib.Source.set_callback]. This can mean, that the data’s [callback@GLib.DestroyNotify] gets called right away.

func (*Source) DupContext 

func (x *Source) DupContext() *MainContext

Gets a reference to the [struct@GLib.MainContext] with which the source is associated.

You can call this on a source that has been destroyed. You can always call this function on the source returned from [func@GLib.main_current_source].

func (*Source) GetCanRecurse 

func (x *Source) GetCanRecurse() bool

Checks whether a source is allowed to be called recursively.

See [method@GLib.Source.set_can_recurse].

func (*Source) GetContext 

func (x *Source) GetContext() *MainContext

Gets the [struct@GLib.MainContext] with which the source is associated.

You can call this on a source that has been destroyed, provided that the [struct@GLib.MainContext] it was attached to still exists (in which case it will return that [struct@GLib.MainContext]). In particular, you can always call this function on the source returned from [func@GLib.main_current_source]. But calling this function on a source whose [struct@GLib.MainContext] has been destroyed is an error.

If the associated [struct@GLib.MainContext] could be destroy concurrently from a different thread, then this function is not safe to call and [method@GLib.Source.dup_context] should be used instead.

func (*Source) GetCurrentTime 

func (x *Source) GetCurrentTime(TimevalVar *TimeVal)

This function ignores @source and is otherwise the same as [func@GLib.get_current_time].

func (*Source) GetId 

func (x *Source) GetId() uint

Returns the numeric ID for a particular source.

The ID of a source is a positive integer which is unique within a particular main loop context. The reverse mapping from ID to source is done by [method@GLib.MainContext.find_source_by_id].

You can only call this function while the source is associated to a [struct@GLib.MainContext] instance; calling this function before [method@GLib.Source.attach] or after [method@GLib.Source.destroy] yields undefined behavior. The ID returned is unique within the [struct@GLib.MainContext] instance passed to [method@GLib.Source.attach].

func (*Source) GetName 

func (x *Source) GetName() string

Gets a name for the source, used in debugging and profiling.

The name may be `NULL` if it has never been set with [method@GLib.Source.set_name].

func (*Source) GetPriority 

func (x *Source) GetPriority() int

Gets the priority of a source.

func (*Source) GetReadyTime 

func (x *Source) GetReadyTime() int64

Gets the ‘ready time’ of @source, as set by [method@GLib.Source.set_ready_time].

Any time before or equal to the current monotonic time (including zero) is an indication that the source will fire immediately.

func (*Source) GetTime 

func (x *Source) GetTime() int64

Gets the time to be used when checking this source.

The advantage of calling this function over calling [func@GLib.get_monotonic_time] directly is that when checking multiple sources, GLib can cache a single value instead of having to repeatedly get the system monotonic time.

The time here is the system monotonic time, if available, or some other reasonable alternative otherwise. See [func@GLib.get_monotonic_time].

func (*Source) GoPointer 

func (x *Source) GoPointer() uintptr

func (*Source) IsDestroyed 

func (x *Source) IsDestroyed() bool

Returns whether @source has been destroyed.

This is important when you operate upon your objects from within idle handlers, but may have freed the object before the dispatch of your idle handler.

```c static gboolean idle_callback (gpointer data) 

{
  SomeWidget *self = data;

  g_mutex_lock (&amp;self-&gt;idle_id_mutex);
  // do stuff with self
  self-&gt;idle_id = 0;
  g_mutex_unlock (&amp;self-&gt;idle_id_mutex);

  return G_SOURCE_REMOVE;
}

static void some_widget_do_stuff_later (SomeWidget *self) 

{
  g_mutex_lock (&amp;self-&gt;idle_id_mutex);
  self-&gt;idle_id = g_idle_add (idle_callback, self);
  g_mutex_unlock (&amp;self-&gt;idle_id_mutex);
}

static void some_widget_init (SomeWidget *self) 

{
  g_mutex_init (&amp;self-&gt;idle_id_mutex);

  // ...
}

static void some_widget_finalize (GObject *object) 

{
  SomeWidget *self = SOME_WIDGET (object);

  if (self-&gt;idle_id)
    g_source_remove (self-&gt;idle_id);

  g_mutex_clear (&amp;self-&gt;idle_id_mutex);

  G_OBJECT_CLASS (parent_class)-&gt;finalize (object);
}

```

This will fail in a multi-threaded application if the widget is destroyed before the idle handler fires due to the use after free in the callback. A solution, to this particular problem, is to check to if the source has already been destroy within the callback.

```c static gboolean idle_callback (gpointer data) 

{
  SomeWidget *self = data;

  g_mutex_lock (&amp;self-&gt;idle_id_mutex);
  if (!g_source_is_destroyed (g_main_current_source ()))
    {
      // do stuff with self
    }
  g_mutex_unlock (&amp;self-&gt;idle_id_mutex);

  return FALSE;
}

```

Calls to this function from a thread other than the one acquired by the [struct@GLib.MainContext] the [struct@GLib.Source] is attached to are typically redundant, as the source could be destroyed immediately after this function returns. However, once a source is destroyed it cannot be un-destroyed, so this function can be used for opportunistic checks from any thread.

func (*Source) ModifyUnixFd 

func (x *Source) ModifyUnixFd(TagVar uintptr, NewEventsVar IOCondition)

Updates the event mask to watch for the file descriptor identified by @tag.

The @tag is the tag returned from [method@GLib.Source.add_unix_fd].

If you want to remove a file descriptor, don’t set its event mask to zero. Instead, call [method@GLib.Source.remove_unix_fd].

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

As the name suggests, this function is not available on Windows.

func (*Source) QueryUnixFd 

func (x *Source) QueryUnixFd(TagVar uintptr) IOCondition

Queries the events reported for the file descriptor corresponding to @tag on @source during the last poll.

The return value of this function is only defined when the function is called from the check or dispatch functions for @source.

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

As the name suggests, this function is not available on Windows.

func (*Source) Ref 

func (x *Source) Ref() *Source

Increases the reference count on a source by one.

func (*Source) RemoveChildSource 

func (x *Source) RemoveChildSource(ChildSourceVar *Source)

Detaches @child_source from @source and destroys it.

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

func (*Source) RemovePoll 

func (x *Source) RemovePoll(FdVar *PollFD)

Removes a file descriptor from the set of file descriptors polled for this source.

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

func (*Source) RemoveUnixFd 

func (x *Source) RemoveUnixFd(TagVar uintptr)

Reverses the effect of a previous call to [method@GLib.Source.add_unix_fd].

You only need to call this if you want to remove a file descriptor from being watched while keeping the same source around. In the normal case you will just want to destroy the source.

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

As the name suggests, this function is not available on Windows.

func (*Source) SetCallback 

func (x *Source) SetCallback(FuncVar *SourceFunc, DataVar uintptr, NotifyVar *DestroyNotify)

Sets the callback function for a source. The callback for a source is called from the source’s dispatch function.

The exact type of @func depends on the type of source; ie. you should not count on @func being called with @data as its first parameter. Cast @func with [func@GLib.SOURCE_FUNC] to avoid warnings about incompatible function types.

See [main loop memory management](main-loop.html#memory-management-of-sources) for details on how to handle memory management of @data.

Typically, you won’t use this function. Instead use functions specific to the type of source you are using, such as [func@GLib.idle_add] or [func@GLib.timeout_add].

It is safe to call this function multiple times on a source which has already been attached to a context. The changes will take effect for the next time the source is dispatched after this call returns.

Note that [method@GLib.Source.destroy] for a currently attached source has the effect of also unsetting the callback.

func (*Source) SetCallbackIndirect 

func (x *Source) SetCallbackIndirect(CallbackDataVar uintptr, CallbackFuncsVar *SourceCallbackFuncs)

Sets the callback function storing the data as a reference counted callback ‘object’.

This is used internally. Note that calling [method@GLib.Source.set_callback_indirect] assumes an initial reference count on @callback_data, and thus `callback_funcs-&gt;unref` will eventually be called once more than `callback_funcs-&gt;ref`.

It is safe to call this function multiple times on a source which has already been attached to a context. The changes will take effect for the next time the source is dispatched after this call returns.

func (*Source) SetCanRecurse 

func (x *Source) SetCanRecurse(CanRecurseVar bool)

Sets whether a source can be called recursively.

If @can_recurse is true, then while the source is being dispatched then this source will be processed normally. Otherwise, all processing of this source is blocked until the dispatch function returns.

func (*Source) SetDisposeFunction 

func (x *Source) SetDisposeFunction(DisposeVar *SourceDisposeFunc)

Set @dispose as dispose function on @source.

The @dispose function will be called once the reference count of @source reaches zero but before any of the state of the source is freed, especially before the finalize function (set as part of the [type@GLib.SourceFuncs]) is called.

This means that at this point @source is still a valid [struct@GLib.Source] and it is allow for the reference count to increase again until @dispose returns.

The dispose function can be used to clear any ‘weak’ references to the @source in other data structures in a thread-safe way where it is possible for another thread to increase the reference count of @source again while it is being freed.

The finalize function can not be used for this purpose as at that point @source is already partially freed and not valid any more.

This should only ever be called from [struct@GLib.Source] implementations.

func (*Source) SetFuncs 

func (x *Source) SetFuncs(FuncsVar *SourceFuncs)

Sets the source functions of an unattached source.

These can be used to override the default implementations for the type of @source.

func (*Source) SetName 

func (x *Source) SetName(NameVar string)

Sets a name for the source, used in debugging and profiling.

The name defaults to `NULL`.

The source name should describe in a human-readable way what the source does. For example, ‘X11 event queue’ or ‘GTK repaint idle handler’.

It is permitted to call this function multiple times, but is not recommended due to the potential performance impact. For example, one could change the name in the `check` function of a [struct@GLib.SourceFuncs] to include details like the event type in the source name.

Use caution if changing the name while another thread may be accessing it with [method@GLib.Source.get_name]; that function does not copy the value, and changing the value will free it while the other thread may be attempting to use it.

Also see [method@GLib.Source.set_static_name].

func (*Source) SetPriority 

func (x *Source) SetPriority(PriorityVar int)

Sets the priority of a source.

While the main loop is being run, a source will be dispatched if it is ready to be dispatched and no sources at a higher (numerically smaller) priority are ready to be dispatched.

A child source always has the same priority as its parent. It is not permitted to change the priority of a source once it has been added as a child of another source.

func (*Source) SetReadyTime 

func (x *Source) SetReadyTime(ReadyTimeVar int64)

Sets a source to be dispatched when the given monotonic time is reached (or passed).

If the monotonic time is in the past (as it always will be if @ready_time is `0`) then the source will be dispatched immediately.

If @ready_time is `-1` then the source is never woken up on the basis of the passage of time.

Dispatching the source does not reset the ready time. You should do so yourself, from the source dispatch function.

Note that if you have a pair of sources where the ready time of one suggests that it will be delivered first but the priority for the other suggests that it would be delivered first, and the ready time for both sources is reached during the same main context iteration, then the order of dispatch is undefined.

It is a no-op to call this function on a [struct@GLib.Source] which has already been destroyed with [method@GLib.Source.destroy].

This API is only intended to be used by implementations of [struct@GLib.Source]. Do not call this API on a [struct@GLib.Source] that you did not create.

func (*Source) SetStaticName 

func (x *Source) SetStaticName(NameVar string)

A variant of [method@GLib.Source.set_name] that does not duplicate the @name, and can only be used with string literals.

func (*Source) Unref 

func (x *Source) Unref()

Decreases the reference count of a source by one.

If the resulting reference count is zero the source and associated memory will be destroyed.

type SourceCallbackFuncs 

type SourceCallbackFuncs struct {
	// contains filtered or unexported fields
}

The `GSourceCallbackFuncs` struct contains functions for managing callback objects.

func (*SourceCallbackFuncs) GetGet 

func (x *SourceCallbackFuncs) GetGet() func(uintptr, *Source, *SourceFunc, uintptr)

GetGet gets the "get" callback function. Called to extract the callback function and data from the 

callback object.

func (*SourceCallbackFuncs) GetRef 

func (x *SourceCallbackFuncs) GetRef() func(uintptr)

GetRef gets the "ref" callback function. Called when a reference is added to the callback object

func (*SourceCallbackFuncs) GetUnref 

func (x *SourceCallbackFuncs) GetUnref() func(uintptr)

GetUnref gets the "unref" callback function. Called when a reference to the callback object is dropped

func (*SourceCallbackFuncs) GoPointer 

func (x *SourceCallbackFuncs) GoPointer() uintptr

func (*SourceCallbackFuncs) OverrideGet 

func (x *SourceCallbackFuncs) OverrideGet(cb func(uintptr, *Source, *SourceFunc, uintptr))

OverrideGet sets the "get" callback function. Called to extract the callback function and data from the 

callback object.

func (*SourceCallbackFuncs) OverrideRef 

func (x *SourceCallbackFuncs) OverrideRef(cb func(uintptr))

OverrideRef sets the "ref" callback function. Called when a reference is added to the callback object

func (*SourceCallbackFuncs) OverrideUnref 

func (x *SourceCallbackFuncs) OverrideUnref(cb func(uintptr))

OverrideUnref sets the "unref" callback function. Called when a reference to the callback object is dropped

type SourceDisposeFunc 

type SourceDisposeFunc func(*Source)

Dispose function for @source. See [method@GLib.Source.set_dispose_function] for details.

type SourceDummyMarshal 

type SourceDummyMarshal func()

This is just a placeholder for #GClosureMarshal, which cannot be used here for dependency reasons.

type SourceFunc 

type SourceFunc func(uintptr) bool

Specifies the type of function passed to [func@GLib.timeout_add], [func@GLib.timeout_add_full], [func@GLib.idle_add], and [func@GLib.idle_add_full].

When calling [method@GLib.Source.set_callback], you may need to cast a function of a different type to this type. Use [func@GLib.SOURCE_FUNC] to avoid warnings about incompatible function types.

type SourceFuncs 

type SourceFuncs struct {
	Prepare SourceFuncsPrepareFunc

	Check SourceFuncsCheckFunc

	Dispatch SourceFuncsDispatchFunc

	Finalize SourceFuncsFinalizeFunc

	ClosureCallback SourceFunc

	ClosureMarshal SourceDummyMarshal
	// contains filtered or unexported fields
}

The `GSourceFuncs` struct contains a table of functions used to handle event sources in a generic manner.

For idle sources, the prepare and check functions always return %TRUE to indicate that the source is always ready to be processed. The prepare function also returns a timeout value of 0 to ensure that the poll() call doesn't block (since that would be time wasted which could have been spent running the idle function).

For timeout sources, the prepare and check functions both return %TRUE if the timeout interval has expired. The prepare function also returns a timeout value to ensure that the poll() call doesn't block too long and miss the next timeout.

For file descriptor sources, the prepare function typically returns %FALSE, since it must wait until poll() has been called before it knows whether any events need to be processed. It sets the returned timeout to -1 to indicate that it doesn't mind how long the poll() call blocks. In the check function, it tests the results of the poll() call to see if the required condition has been met, and returns %TRUE if so.

func (*SourceFuncs) GoPointer 

func (x *SourceFuncs) GoPointer() uintptr

type SourceFuncsCheckFunc 

type SourceFuncsCheckFunc func(*Source) bool

Checks if the source is ready to be dispatched.

Called after all the file descriptors are polled. The source should return %TRUE if it is ready to be dispatched. Note that some time may have passed since the previous prepare function was called, so the source should be checked again here.

Since 2.36 this may be `NULL`, in which case the effect is as if the function always returns `FALSE`.

type SourceFuncsDispatchFunc 

type SourceFuncsDispatchFunc func(*Source, uintptr, uintptr) bool

Dispatches the source callback.

Called to dispatch the event source, after it has returned `TRUE` in either its prepare or its check function, or if a ready time has been reached. The dispatch function receives a callback function and user data. The callback function may be `NULL` if the source was never connected to a callback using [method@GLib.Source.set_callback]. The dispatch function should call the callback function with @user_data and whatever additional parameters are needed for this type of event source. The return value of the dispatch function should be [const@GLib.SOURCE_REMOVE] if the source should be removed or [const@GLib.SOURCE_CONTINUE] to keep it.

type SourceFuncsFinalizeFunc 

type SourceFuncsFinalizeFunc func(*Source)

Finalizes the source.

Called when the source is finalized. At this point, the source will have been destroyed, had its callback cleared, and have been removed from its [type@GLib.MainContext], but it will still have its final reference count, so methods can be called on it from within this function.

type SourceFuncsPrepareFunc 

type SourceFuncsPrepareFunc func(*Source, *int) bool

Checks the source for readiness.

Called before all the file descriptors are polled. If the source can determine that it is ready here (without waiting for the results of the poll call) it should return %TRUE. It can also return a @timeout_ value which should be the maximum timeout (in milliseconds) which should be passed to the poll call. The actual timeout used will be `-1` if all sources returned `-1`, or it will be the minimum of all the @timeout_ values returned which were greater than or equal to `0`. If the prepare function returns a timeout and the source also has a ready time set, then the lower of the two will be used.

Since 2.36 this may be `NULL`, in which case the effect is as if the function always returns `FALSE` with a timeout of `-1`.

type SourceOnceFunc 

type SourceOnceFunc func(uintptr)

A source function that is only called once before being removed from the main context automatically.

See: [func@GLib.idle_add_once], [func@GLib.timeout_add_once]

type SourcePrivate 

type SourcePrivate struct {
	// contains filtered or unexported fields
}

func (*SourcePrivate) GoPointer 

func (x *SourcePrivate) GoPointer() uintptr

type SpawnChildSetupFunc 

type SpawnChildSetupFunc func(uintptr)

Specifies the type of the setup function passed to g_spawn_async(), g_spawn_sync() and g_spawn_async_with_pipes(), which can, in very limited ways, be used to affect the child's execution.

On POSIX platforms, the function is called in the child after GLib has performed all the setup it plans to perform, but before calling exec(). Actions taken in this function will only affect the child, not the parent.

On Windows, the function is called in the parent. Its usefulness on Windows is thus questionable. In many cases executing the child setup function in the parent can have ill effects, and you should be very careful when porting software to Windows that uses child setup functions.

However, even on POSIX, you are extremely limited in what you can safely do from a #GSpawnChildSetupFunc, because any mutexes that were held by other threads in the parent process at the time of the fork() will still be locked in the child process, and they will never be unlocked (since the threads that held them don't exist in the child). POSIX allows only async-signal-safe functions (see signal(7)) to be called in the child between fork() and exec(), which drastically limits the usefulness of child setup functions.

In particular, it is not safe to call any function which may call malloc(), which includes POSIX functions such as setenv(). If you need to set up the child environment differently from the parent, you should use g_get_environ(), g_environ_setenv(), and g_environ_unsetenv(), and then pass the complete environment list to the `g_spawn...` function.

type SpawnError 

type SpawnError int

Error codes returned by spawning processes. 

const (

	// Fork failed due to lack of memory.
	GSpawnErrorForkValue SpawnError = 0
	// Read or select on pipes failed.
	GSpawnErrorReadValue SpawnError = 1
	// Changing to working directory failed.
	GSpawnErrorChdirValue SpawnError = 2
	// execv() returned `EACCES`
	GSpawnErrorAccesValue SpawnError = 3
	// execv() returned `EPERM`
	GSpawnErrorPermValue SpawnError = 4
	// execv() returned `E2BIG`
	GSpawnErrorTooBigValue SpawnError = 5
	// deprecated alias for %G_SPAWN_ERROR_TOO_BIG (deprecated since GLib 2.32)
	GSpawnError2bigValue SpawnError = 5
	// execv() returned `ENOEXEC`
	GSpawnErrorNoexecValue SpawnError = 6
	// execv() returned `ENAMETOOLONG`
	GSpawnErrorNametoolongValue SpawnError = 7
	// execv() returned `ENOENT`
	GSpawnErrorNoentValue SpawnError = 8
	// execv() returned `ENOMEM`
	GSpawnErrorNomemValue SpawnError = 9
	// execv() returned `ENOTDIR`
	GSpawnErrorNotdirValue SpawnError = 10
	// execv() returned `ELOOP`
	GSpawnErrorLoopValue SpawnError = 11
	// execv() returned `ETXTBUSY`
	GSpawnErrorTxtbusyValue SpawnError = 12
	// execv() returned `EIO`
	GSpawnErrorIoValue SpawnError = 13
	// execv() returned `ENFILE`
	GSpawnErrorNfileValue SpawnError = 14
	// execv() returned `EMFILE`
	GSpawnErrorMfileValue SpawnError = 15
	// execv() returned `EINVAL`
	GSpawnErrorInvalValue SpawnError = 16
	// execv() returned `EISDIR`
	GSpawnErrorIsdirValue SpawnError = 17
	// execv() returned `ELIBBAD`
	GSpawnErrorLibbadValue SpawnError = 18
	// Some other fatal failure,
	//   `error-&gt;message` should explain.
	GSpawnErrorFailedValue SpawnError = 19
)

type SpawnFlags 

type SpawnFlags int

Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes(). 

const (

	// no flags, default behaviour
	GSpawnDefaultValue SpawnFlags = 0
	// the parent's open file descriptors will
	//     be inherited by the child; otherwise all descriptors except stdin,
	//     stdout and stderr will be closed before calling exec() in the child.
	GSpawnLeaveDescriptorsOpenValue SpawnFlags = 1
	// the child will not be automatically reaped;
	//     you must use g_child_watch_add() yourself (or call waitpid() or handle
	//     `SIGCHLD` yourself), or the child will become a zombie.
	GSpawnDoNotReapChildValue SpawnFlags = 2
	// `argv[0]` need not be an absolute path, it will be
	//     looked for in the user's `PATH`.
	GSpawnSearchPathValue SpawnFlags = 4
	// the child's standard output will be discarded,
	//     instead of going to the same location as the parent's standard output.
	GSpawnStdoutToDevNullValue SpawnFlags = 8
	// the child's standard error will be discarded.
	GSpawnStderrToDevNullValue SpawnFlags = 16
	// the child will inherit the parent's standard
	//     input (by default, the child's standard input is attached to `/dev/null`).
	GSpawnChildInheritsStdinValue SpawnFlags = 32
	// the first element of `argv` is the file to
	//     execute, while the remaining elements are the actual argument vector
	//     to pass to the file. Normally g_spawn_async_with_pipes() uses `argv[0]`
	//     as the file to execute, and passes all of `argv` to the child.
	GSpawnFileAndArgvZeroValue SpawnFlags = 64
	// if `argv[0]` is not an absolute path,
	//     it will be looked for in the `PATH` from the passed child environment.
	//     Since: 2.34
	GSpawnSearchPathFromEnvpValue SpawnFlags = 128
	// create all pipes with the `O_CLOEXEC` flag set.
	//     Since: 2.40
	GSpawnCloexecPipesValue SpawnFlags = 256
	// The child will inherit the parent's standard output.
	GSpawnChildInheritsStdoutValue SpawnFlags = 512
	// The child will inherit the parent's standard error.
	GSpawnChildInheritsStderrValue SpawnFlags = 1024
	// The child's standard input is attached to `/dev/null`.
	GSpawnStdinFromDevNullValue SpawnFlags = 2048
)

type StatBuf 

type StatBuf struct {
	// contains filtered or unexported fields
}

A type corresponding to the appropriate struct type for the stat() system call, depending on the platform and/or compiler being used.

See g_stat() for more information.

func (*StatBuf) GoPointer 

func (x *StatBuf) GoPointer() uintptr

type StaticMutex 

type StaticMutex struct {
	Mutex *Mutex
	// contains filtered or unexported fields
}

A #GStaticMutex works like a #GMutex.

Prior to GLib 2.32, GStaticMutex had the significant advantage that it doesn't need to be created at run-time, but can be defined at compile-time. Since 2.32, #GMutex can be statically allocated as well, and GStaticMutex has been deprecated.

Here is a version of our give_me_next_number() example using a GStaticMutex: |[ 

int
give_me_next_number (void)
{
  static int current_number = 0;
  int ret_val;
  static GStaticMutex mutex = G_STATIC_MUTEX_INIT;

  g_static_mutex_lock (&amp;mutex);
  ret_val = current_number = calc_next_number (current_number);
  g_static_mutex_unlock (&amp;mutex);

  return ret_val;
}

]|

Sometimes you would like to dynamically create a mutex. If you don't want to require prior calling to g_thread_init(), because your code should also be usable in non-threaded programs, you are not able to use g_mutex_new() and thus #GMutex, as that requires a prior call to g_thread_init(). In these cases you can also use a #GStaticMutex. It must be initialized with g_static_mutex_init() before using it and freed with with g_static_mutex_free() when not needed anymore to free up any allocated resources.

Even though #GStaticMutex is not opaque, it should only be used with the following functions, as it is defined differently on different platforms.

All of the g_static_mutex_* functions apart from g_static_mutex_get_mutex() can also be used even if g_thread_init() has not yet been called. Then they do nothing, apart from g_static_mutex_trylock() which does nothing but returning %TRUE.

All of the g_static_mutex_* functions are actually macros. Apart from taking their addresses, you can however use them as if they were functions.

func (*StaticMutex) Free 

func (x *StaticMutex) Free()

Releases all resources allocated to @mutex.

You don't have to call this functions for a #GStaticMutex with an unbounded lifetime, i.e. objects declared 'static', but if you have a #GStaticMutex as a member of a structure and the structure is freed, you should also free the #GStaticMutex.

Calling g_static_mutex_free() on a locked mutex may result in undefined behaviour.

func (*StaticMutex) GetMutexImpl 

func (x *StaticMutex) GetMutexImpl() *Mutex

func (*StaticMutex) GoPointer 

func (x *StaticMutex) GoPointer() uintptr

func (*StaticMutex) Init 

func (x *StaticMutex) Init()

Initializes @mutex. Alternatively you can initialize it with %G_STATIC_MUTEX_INIT.

type StaticPrivate 

type StaticPrivate struct {
	Index uint
	// contains filtered or unexported fields
}

A #GStaticPrivate works almost like a #GPrivate, but it has one significant advantage. It doesn't need to be created at run-time like a #GPrivate, but can be defined at compile-time. This is similar to the difference between #GMutex and #GStaticMutex.

Now look at our give_me_next_number() example with #GStaticPrivate: |[ 

int
give_me_next_number ()
{
  static GStaticPrivate current_number_key = G_STATIC_PRIVATE_INIT;
  int *current_number = g_static_private_get (&amp;current_number_key);

  if (!current_number)
    {
      current_number = g_new (int, 1);
      *current_number = 0;
      g_static_private_set (&amp;current_number_key, current_number, g_free);
    }

  *current_number = calc_next_number (*current_number);

  return *current_number;
}

]|

func (*StaticPrivate) Free 

func (x *StaticPrivate) Free()

Releases all resources allocated to @private_key.

You don't have to call this functions for a #GStaticPrivate with an unbounded lifetime, i.e. objects declared 'static', but if you have a #GStaticPrivate as a member of a structure and the structure is freed, you should also free the #GStaticPrivate.

func (*StaticPrivate) Get 

func (x *StaticPrivate) Get() uintptr

Works like g_private_get() only for a #GStaticPrivate.

This function works even if g_thread_init() has not yet been called.

func (*StaticPrivate) GoPointer 

func (x *StaticPrivate) GoPointer() uintptr

func (*StaticPrivate) Init 

func (x *StaticPrivate) Init()

Initializes @private_key. Alternatively you can initialize it with %G_STATIC_PRIVATE_INIT.

func (*StaticPrivate) Set 

func (x *StaticPrivate) Set(DataVar uintptr, NotifyVar *DestroyNotify)

Sets the pointer keyed to @private_key for the current thread and the function @notify to be called with that pointer (%NULL or non-%NULL), whenever the pointer is set again or whenever the current thread ends.

This function works even if g_thread_init() has not yet been called. If g_thread_init() is called later, the @data keyed to @private_key will be inherited only by the main thread, i.e. the one that called g_thread_init().

@notify is used quite differently from @destructor in g_private_new().

type StaticRWLock 

type StaticRWLock struct {
	Mutex uintptr

	ReadCond *Cond

	WriteCond *Cond

	ReadCounter uint

	HaveWriter bool

	WantToRead uint

	WantToWrite uint
	// contains filtered or unexported fields
}

The [struct@StaticRWLock] struct represents a read-write lock. A read-write lock can be used for protecting data that some portions of code only read from, while others also write. In such situations it is desirable that several readers can read at once, whereas of course only one writer may write at a time.

Take a look at the following example: |[ 

GStaticRWLock rwlock = G_STATIC_RW_LOCK_INIT;
GPtrArray *array;

gpointer
my_array_get (guint index)
{
  gpointer retval = NULL;

  if (!array)
    return NULL;

  g_static_rw_lock_reader_lock (&amp;rwlock);
  if (index &lt; array-&gt;len)
    retval = g_ptr_array_index (array, index);
  g_static_rw_lock_reader_unlock (&amp;rwlock);

  return retval;
}

void
my_array_set (guint index, gpointer data)
{
  g_static_rw_lock_writer_lock (&amp;rwlock);

  if (!array)
    array = g_ptr_array_new ();

  if (index &gt;= array-&gt;len)
    g_ptr_array_set_size (array, index + 1);
  g_ptr_array_index (array, index) = data;

  g_static_rw_lock_writer_unlock (&amp;rwlock);
}

]|

This example shows an array which can be accessed by many readers (the `my_array_get()` function) simultaneously, whereas the writers (the `my_array_set()` function) will only be allowed once at a time and only if no readers currently access the array. This is because of the potentially dangerous resizing of the array. Using these functions is fully multi-thread safe now.

Most of the time, writers should have precedence over readers. That means, for this implementation, that as soon as a writer wants to lock the data, no other reader is allowed to lock the data, whereas, of course, the readers that already have locked the data are allowed to finish their operation. As soon as the last reader unlocks the data, the writer will lock it.

Even though [struct@StaticRWLock] is not opaque, it should only be used with the following functions.

All of the `g_static_rw_lock_*` functions can be used even if [func@Thread.init] has not been called. Then they do nothing, apart from `g_static_rw_lock_*_trylock`, which does nothing but returning true.

A read-write lock has a higher overhead than a mutex. For example, both [method@StaticRWLock.reader_lock] and [method@StaticRWLock.reader_unlock] have to lock and unlock a [struct@StaticMutex], so it takes at least twice the time to lock and unlock a [struct@StaticRWLock] that it does to lock and unlock a [struct@StaticMutex]. So only data structures that are accessed by multiple readers, and which keep the lock for a considerable time justify a [struct@StaticRWLock]. The above example most probably would fare better with a [struct@StaticMutex].

func (*StaticRWLock) Free 

func (x *StaticRWLock) Free()

Releases all resources allocated to @lock.

You don't have to call this functions for a #GStaticRWLock with an unbounded lifetime, i.e. objects declared 'static', but if you have a #GStaticRWLock as a member of a structure, and the structure is freed, you should also free the #GStaticRWLock.

func (*StaticRWLock) GoPointer 

func (x *StaticRWLock) GoPointer() uintptr

func (*StaticRWLock) Init 

func (x *StaticRWLock) Init()

A #GStaticRWLock must be initialized with this function before it can be used. Alternatively you can initialize it with %G_STATIC_RW_LOCK_INIT.

func (*StaticRWLock) ReaderLock 

func (x *StaticRWLock) ReaderLock()

Locks @lock for reading. There may be unlimited concurrent locks for reading of a #GStaticRWLock at the same time. If @lock is already locked for writing by another thread or if another thread is already waiting to lock @lock for writing, this function will block until @lock is unlocked by the other writing thread and no other writing threads want to lock @lock. This lock has to be unlocked by g_static_rw_lock_reader_unlock().

#GStaticRWLock is not recursive. It might seem to be possible to recursively lock for reading, but that can result in a deadlock, due to writer preference.

func (*StaticRWLock) ReaderTrylock 

func (x *StaticRWLock) ReaderTrylock() bool

Tries to lock @lock for reading. If @lock is already locked for writing by another thread or if another thread is already waiting to lock @lock for writing, immediately returns %FALSE. Otherwise locks @lock for reading and returns %TRUE. This lock has to be unlocked by g_static_rw_lock_reader_unlock().

func (*StaticRWLock) ReaderUnlock 

func (x *StaticRWLock) ReaderUnlock()

Unlocks @lock. If a thread waits to lock @lock for writing and all locks for reading have been unlocked, the waiting thread is woken up and can lock @lock for writing.

func (*StaticRWLock) WriterLock 

func (x *StaticRWLock) WriterLock()

Locks @lock for writing. If @lock is already locked for writing or reading by other threads, this function will block until @lock is completely unlocked and then lock @lock for writing. While this functions waits to lock @lock, no other thread can lock @lock for reading. When @lock is locked for writing, no other thread can lock @lock (neither for reading nor writing). This lock has to be unlocked by g_static_rw_lock_writer_unlock().

func (*StaticRWLock) WriterTrylock 

func (x *StaticRWLock) WriterTrylock() bool

Tries to lock @lock for writing. If @lock is already locked (for either reading or writing) by another thread, it immediately returns %FALSE. Otherwise it locks @lock for writing and returns %TRUE. This lock has to be unlocked by g_static_rw_lock_writer_unlock().

func (*StaticRWLock) WriterUnlock 

func (x *StaticRWLock) WriterUnlock()

Unlocks @lock. If a thread is waiting to lock @lock for writing and all locks for reading have been unlocked, the waiting thread is woken up and can lock @lock for writing. If no thread is waiting to lock @lock for writing, and some thread or threads are waiting to lock @lock for reading, the waiting threads are woken up and can lock @lock for reading.

type StaticRecMutex 

type StaticRecMutex struct {
	Mutex uintptr

	Depth uint
	// contains filtered or unexported fields
}

A #GStaticRecMutex works like a #GStaticMutex, but it can be locked multiple times by one thread. If you enter it n times, you have to unlock it n times again to let other threads lock it. An exception is the function g_static_rec_mutex_unlock_full(): that allows you to unlock a #GStaticRecMutex completely returning the depth, (i.e. the number of times this mutex was locked). The depth can later be used to restore the state of the #GStaticRecMutex by calling g_static_rec_mutex_lock_full(). In GLib 2.32, #GStaticRecMutex has been deprecated in favor of #GRecMutex.

Even though #GStaticRecMutex is not opaque, it should only be used with the following functions.

All of the g_static_rec_mutex_* functions can be used even if g_thread_init() has not been called. Then they do nothing, apart from g_static_rec_mutex_trylock(), which does nothing but returning %TRUE.

func (*StaticRecMutex) Free 

func (x *StaticRecMutex) Free()

Releases all resources allocated to a #GStaticRecMutex.

You don't have to call this functions for a #GStaticRecMutex with an unbounded lifetime, i.e. objects declared 'static', but if you have a #GStaticRecMutex as a member of a structure and the structure is freed, you should also free the #GStaticRecMutex.

func (*StaticRecMutex) GoPointer 

func (x *StaticRecMutex) GoPointer() uintptr

func (*StaticRecMutex) Init 

func (x *StaticRecMutex) Init()

A #GStaticRecMutex must be initialized with this function before it can be used. Alternatively you can initialize it with %G_STATIC_REC_MUTEX_INIT.

func (*StaticRecMutex) Lock 

func (x *StaticRecMutex) Lock()

Locks @mutex. If @mutex is already locked by another thread, the current thread will block until @mutex is unlocked by the other thread. If @mutex is already locked by the calling thread, this functions increases the depth of @mutex and returns immediately.

func (*StaticRecMutex) LockFull 

func (x *StaticRecMutex) LockFull(DepthVar uint)

Works like calling g_static_rec_mutex_lock() for @mutex @depth times.

func (*StaticRecMutex) Trylock 

func (x *StaticRecMutex) Trylock() bool

Tries to lock @mutex. If @mutex is already locked by another thread, it immediately returns %FALSE. Otherwise it locks @mutex and returns %TRUE. If @mutex is already locked by the calling thread, this functions increases the depth of @mutex and immediately returns %TRUE.

func (*StaticRecMutex) Unlock 

func (x *StaticRecMutex) Unlock()

Unlocks @mutex. Another thread will be allowed to lock @mutex only when it has been unlocked as many times as it had been locked before. If @mutex is completely unlocked and another thread is blocked in a g_static_rec_mutex_lock() call for @mutex, it will be woken and can lock @mutex itself.

func (*StaticRecMutex) UnlockFull 

func (x *StaticRecMutex) UnlockFull() uint

Completely unlocks @mutex. If another thread is blocked in a g_static_rec_mutex_lock() call for @mutex, it will be woken and can lock @mutex itself. This function returns the number of times that @mutex has been locked by the current thread. To restore the state before the call to g_static_rec_mutex_unlock_full() you can call g_static_rec_mutex_lock_full() with the depth returned by this function.

type String 

type String struct {
	Str uintptr

	Len uint

	AllocatedLen uint
	// contains filtered or unexported fields
}

A `GString` is an object that handles the memory management of a C string.

The emphasis of `GString` is on text, typically UTF-8. Crucially, the "str" member of a `GString` is guaranteed to have a trailing nul character, and it is therefore always safe to call functions such as `strchr()` or `strdup()` on it.

However, a `GString` can also hold arbitrary binary data, because it has a "len" member, which includes any possible embedded nul characters in the data. Conceptually then, `GString` is like a `GByteArray` with the addition of many convenience methods for text, and a guaranteed nul terminator.

func NewString 

func NewString(InitVar *string) *String

Creates a new #GString, initialized with the given string.

func NewStringLen 

func NewStringLen(InitVar string, LenVar int) *String

Creates a new #GString with @len bytes of the @init buffer. Because a length is provided, @init need not be nul-terminated, and can contain embedded nul bytes.

Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that @init has at least @len addressable bytes.

func NewStringTake 

func NewStringTake(InitVar *string) *String

Creates a new #GString, initialized with the given string.

After this call, @init belongs to the #GString and may no longer be modified by the caller. The memory of @init has to be dynamically allocated and will eventually be freed with g_free().

func StringSizedNew 

func StringSizedNew(DflSizeVar uint) *String

Creates a new #GString, with enough space for @dfl_size bytes. This is useful if you are going to add a lot of text to the string and don't want it to be reallocated too often.

func (*String) Append 

func (x *String) Append(ValVar string) *String

Adds a string onto the end of a #GString, expanding it if necessary.

func (*String) AppendC 

func (x *String) AppendC(CVar byte) *String

Adds a byte onto the end of a #GString, expanding it if necessary.

func (*String) AppendLen 

func (x *String) AppendLen(ValVar string, LenVar int) *String

Appends @len bytes of @val to @string.

If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to ensure that @val has at least @len addressable bytes.

If @len is negative, @val must be nul-terminated and @len is considered to request the entire string length. This makes g_string_append_len() equivalent to g_string_append().

func (*String) AppendPrintf 

func (x *String) AppendPrintf(FormatVar string, varArgs ...interface{})

Appends a formatted string onto the end of a #GString. This function is similar to g_string_printf() except that the text is appended to the #GString.

func (*String) AppendUnichar 

func (x *String) AppendUnichar(WcVar uint32) *String

Converts a Unicode character into UTF-8, and appends it to the string.

func (*String) AppendUriEscaped 

func (x *String) AppendUriEscaped(UnescapedVar string, ReservedCharsAllowedVar string, AllowUtf8Var bool) *String

Appends @unescaped to @string, escaping any characters that are reserved in URIs using URI-style escape sequences.

func (*String) AppendVprintf 

func (x *String) AppendVprintf(FormatVar string, ArgsVar []interface{})

Appends a formatted string onto the end of a #GString. This function is similar to g_string_append_printf() except that the arguments to the format string are passed as a va_list.

func (*String) AsciiDown 

func (x *String) AsciiDown() *String

Converts all uppercase ASCII letters to lowercase ASCII letters.

func (*String) AsciiUp 

func (x *String) AsciiUp() *String

Converts all lowercase ASCII letters to uppercase ASCII letters.

func (*String) Assign 

func (x *String) Assign(RvalVar string) *String

Copies the bytes from a string into a #GString, destroying any previous contents. It is rather like the standard strcpy() function, except that you do not have to worry about having enough space to copy the string.

func (*String) Copy 

func (x *String) Copy() *String

Copies the [struct@GLib.String] instance and its contents.

This will preserve the allocation length of the [struct@GLib.String] in the copy.

func (*String) Down 

func (x *String) Down() *String

Converts a #GString to lowercase.

func (*String) Equal 

func (x *String) Equal(V2Var *String) bool

Compares two strings for equality, returning %TRUE if they are equal. For use with #GHashTable.

func (*String) Erase 

func (x *String) Erase(PosVar int, LenVar int) *String

Removes @len bytes from a #GString, starting at position @pos. The rest of the #GString is shifted down to fill the gap.

func (*String) Free 

func (x *String) Free(FreeSegmentVar bool) string

Frees the memory allocated for the #GString. If @free_segment is %TRUE it also frees the character data. If it's %FALSE, the caller gains ownership of the buffer and must free it after use with g_free().

Instead of passing %FALSE to this function, consider using g_string_free_and_steal().

func (*String) FreeAndSteal 

func (x *String) FreeAndSteal() string

Frees the memory allocated for the #GString.

The caller gains ownership of the buffer and must free it after use with g_free().

func (*String) FreeToBytes 

func (x *String) FreeToBytes() *Bytes

Transfers ownership of the contents of @string to a newly allocated #GBytes. The #GString structure itself is deallocated, and it is therefore invalid to use @string after invoking this function.

Note that while #GString ensures that its buffer always has a trailing nul character (not reflected in its "len"), the returned #GBytes does not include this extra nul; i.e. it has length exactly equal to the "len" member.

func (*String) GoPointer 

func (x *String) GoPointer() uintptr

func (*String) Hash 

func (x *String) Hash() uint

Creates a hash code for @str; for use with #GHashTable.

func (*String) Insert 

func (x *String) Insert(PosVar int, ValVar string) *String

Inserts a copy of a string into a #GString, expanding it if necessary.

func (*String) InsertC 

func (x *String) InsertC(PosVar int, CVar byte) *String

Inserts a byte into a #GString, expanding it if necessary.

func (*String) InsertLen 

func (x *String) InsertLen(PosVar int, ValVar string, LenVar int) *String

Inserts @len bytes of @val into @string at @pos.

If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to ensure that @val has at least @len addressable bytes.

If @len is negative, @val must be nul-terminated and @len is considered to request the entire string length.

If @pos is -1, bytes are inserted at the end of the string.

func (*String) InsertUnichar 

func (x *String) InsertUnichar(PosVar int, WcVar uint32) *String

Converts a Unicode character into UTF-8, and insert it into the string at the given position.

func (*String) Overwrite 

func (x *String) Overwrite(PosVar uint, ValVar string) *String

Overwrites part of a string, lengthening it if necessary.

func (*String) OverwriteLen 

func (x *String) OverwriteLen(PosVar uint, ValVar string, LenVar int) *String

Overwrites part of a string, lengthening it if necessary. This function will work with embedded nuls.

func (*String) Prepend 

func (x *String) Prepend(ValVar string) *String

Adds a string on to the start of a #GString, expanding it if necessary.

func (*String) PrependC 

func (x *String) PrependC(CVar byte) *String

Adds a byte onto the start of a #GString, expanding it if necessary.

func (*String) PrependLen 

func (x *String) PrependLen(ValVar string, LenVar int) *String

Prepends @len bytes of @val to @string.

If @len is positive, @val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to ensure that @val has at least @len addressable bytes.

If @len is negative, @val must be nul-terminated and @len is considered to request the entire string length. This makes g_string_prepend_len() equivalent to g_string_prepend().

func (*String) PrependUnichar 

func (x *String) PrependUnichar(WcVar uint32) *String

Converts a Unicode character into UTF-8, and prepends it to the string.

func (*String) Printf 

func (x *String) Printf(FormatVar string, varArgs ...interface{})

Writes a formatted string into a #GString. This is similar to the standard sprintf() function, except that the #GString buffer automatically expands to contain the results. The previous contents of the #GString are destroyed.

func (*String) Replace 

func (x *String) Replace(FindVar string, ReplaceVar string, LimitVar uint) uint

Replaces the string @find with the string @replace in a #GString up to @limit times. If the number of instances of @find in the #GString is less than @limit, all instances are replaced. If @limit is `0`, all instances of @find are replaced.

If @find is the empty string, since versions 2.69.1 and 2.68.4 the replacement will be inserted no more than once per possible position (beginning of string, end of string and between characters). This did not work correctly in earlier versions.

If @limit is zero and more than `G_MAXUINT` instances of @find are in the input string, they will all be replaced, but the return value will be capped at `G_MAXUINT`.

func (*String) SetSize 

func (x *String) SetSize(LenVar uint) *String

Sets the length of a #GString. If the length is less than the current length, the string will be truncated. If the length is greater than the current length, the contents of the newly added area are undefined. (However, as always, string-&gt;str[string-&gt;len] will be a nul byte.)

func (*String) Truncate 

func (x *String) Truncate(LenVar uint) *String

Cuts off the end of the GString, leaving the first @len bytes.

func (*String) Up 

func (x *String) Up() *String

Converts a #GString to uppercase.

func (*String) Vprintf 

func (x *String) Vprintf(FormatVar string, ArgsVar []interface{})

Writes a formatted string into a #GString. This function is similar to g_string_printf() except that the arguments to the format string are passed as a va_list.

type StringChunk 

type StringChunk struct {
	// contains filtered or unexported fields
}

`GStringChunk` provides efficient storage of groups of strings

String chunks are used to store groups of strings. Memory is allocated in blocks, and as strings are added to the `GStringChunk` they are copied into the next free position in a block. When a block is full a new block is allocated.

When storing a large number of strings, string chunks are more efficient than using [func@GLib.strdup] since fewer calls to `malloc()` are needed, and less memory is wasted in memory allocation overheads.

By adding strings with [method@GLib.StringChunk.insert_const] it is also possible to remove duplicates.

To create a new `GStringChunk` use [func@GLib.StringChunk.new].

To add strings to a `GStringChunk` use [method@GLib.StringChunk.insert].

To add strings to a `GStringChunk`, but without duplicating strings which are already in the `GStringChunk`, use [method@GLib.StringChunk.insert_const].

To free the entire `GStringChunk` use [method@GLib.StringChunk.free]. It is not possible to free individual strings.

func (*StringChunk) Clear 

func (x *StringChunk) Clear()

Frees all strings contained within the #GStringChunk. After calling g_string_chunk_clear() it is not safe to access any of the strings which were contained within it.

func (*StringChunk) Free 

func (x *StringChunk) Free()

Frees all memory allocated by the #GStringChunk. After calling g_string_chunk_free() it is not safe to access any of the strings which were contained within it.

func (*StringChunk) GoPointer 

func (x *StringChunk) GoPointer() uintptr

func (*StringChunk) Insert 

func (x *StringChunk) Insert(StringVar string) string

Adds a copy of @string to the #GStringChunk. It returns a pointer to the new copy of the string in the #GStringChunk. The characters in the string can be changed, if necessary, though you should not change anything after the end of the string.

Unlike g_string_chunk_insert_const(), this function does not check for duplicates. Also strings added with g_string_chunk_insert() will not be searched by g_string_chunk_insert_const() when looking for duplicates.

func (*StringChunk) InsertConst 

func (x *StringChunk) InsertConst(StringVar string) string

Adds a copy of @string to the #GStringChunk, unless the same string has already been added to the #GStringChunk with g_string_chunk_insert_const().

This function is useful if you need to copy a large number of strings but do not want to waste space storing duplicates. But you must remember that there may be several pointers to the same string, and so any changes made to the strings should be done very carefully.

Note that g_string_chunk_insert_const() will not return a pointer to a string added with g_string_chunk_insert(), even if they do match.

func (*StringChunk) InsertLen 

func (x *StringChunk) InsertLen(StringVar string, LenVar int) string

Adds a copy of the first @len bytes of @string to the #GStringChunk. The copy is nul-terminated.

Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that @string has at least @len addressable bytes.

The characters in the returned string can be changed, if necessary, though you should not change anything after the end of the string.

type Strv 

type Strv = string

A typedef alias for gchar**. This is mostly useful when used together with `g_auto()`.

type StrvBuilder 

type StrvBuilder struct {
	// contains filtered or unexported fields
}

`GStrvBuilder` is a helper object to build a %NULL-terminated string arrays.

The following example shows how to build a two element array:

```c 

g_autoptr(GStrvBuilder) builder = g_strv_builder_new ();
g_strv_builder_add (builder, "hello");
g_strv_builder_add (builder, "world");

g_auto(GStrv) array = g_strv_builder_end (builder);

g_assert_true (g_strv_equal (array, (const char *[]) { "hello", "world", NULL }));

```

func NewStrvBuilder 

func NewStrvBuilder() *StrvBuilder

Creates a new #GStrvBuilder with a reference count of 1. Use g_strv_builder_unref() on the returned value when no longer needed.

func (*StrvBuilder) Add 

func (x *StrvBuilder) Add(ValueVar string)

Add a string to the end of the array.

Since 2.68

func (*StrvBuilder) AddMany 

func (x *StrvBuilder) AddMany(varArgs ...interface{})

Appends all the given strings to the builder.

Since 2.70

func (*StrvBuilder) Addv 

func (x *StrvBuilder) Addv(ValueVar []string)

Appends all the strings in the given vector to the builder.

Since 2.70

func (*StrvBuilder) End 

func (x *StrvBuilder) End() []string

Ends the builder process and returns the constructed NULL-terminated string array. The returned value should be freed with g_strfreev() when no longer needed.

func (*StrvBuilder) GoPointer 

func (x *StrvBuilder) GoPointer() uintptr

func (*StrvBuilder) Ref 

func (x *StrvBuilder) Ref() *StrvBuilder

Atomically increments the reference count of @builder by one. This function is thread-safe and may be called from any thread.

func (*StrvBuilder) Take 

func (x *StrvBuilder) Take(ValueVar string)

Add a string to the end of the array. After @value belongs to the #GStrvBuilder and may no longer be modified by the caller.

Since 2.80

func (*StrvBuilder) Unref 

func (x *StrvBuilder) Unref()

Decreases the reference count on @builder.

In the event that there are no more references, releases all memory associated with the #GStrvBuilder.

func (*StrvBuilder) UnrefToStrv 

func (x *StrvBuilder) UnrefToStrv() []string

Decreases the reference count on the string vector builder, and returns its contents as a `NULL`-terminated string array.

This function is especially useful for cases where it's not possible to use `g_autoptr()`.

```c GStrvBuilder *builder = g_strv_builder_new (); g_strv_builder_add (builder, "hello"); g_strv_builder_add (builder, "world");

GStrv array = g_strv_builder_unref_to_strv (builder);

g_assert_true (g_strv_equal (array, (const char *[]) { "hello", "world", NULL }));

g_strfreev (array); ```

type TestCase 

type TestCase struct {
	// contains filtered or unexported fields
}

An opaque structure representing a test case.

func TestCreateCase 

func TestCreateCase(TestNameVar string, DataSizeVar uint, TestDataVar uintptr, DataSetupVar *TestFixtureFunc, DataTestVar *TestFixtureFunc, DataTeardownVar *TestFixtureFunc) *TestCase

Creates a new [struct@GLib.TestCase].

This API is fairly low level, and calling [func@GLib.test_add] or [func@GLib.test_add_func] is preferable.

When this test is executed, a fixture structure of size @data_size will be automatically allocated and filled with zeros. Then @data_setup is called to initialize the fixture. After fixture setup, the actual test function @data_test is called. Once the test run completes, the fixture structure is torn down by calling @data_teardown and after that the memory is automatically released by the test framework.

Splitting up a test run into fixture setup, test function and fixture teardown is most useful if the same fixture type is used for multiple tests. In this cases, [func@GLib.test_create_case] will be called with the same type of fixture (the @data_size argument), but varying @test_name and @data_test arguments.

func (*TestCase) Free 

func (x *TestCase) Free()

Free the @test_case.

func (*TestCase) GoPointer 

func (x *TestCase) GoPointer() uintptr

type TestConfig 

type TestConfig struct {
	TestInitialized bool

	TestQuick bool

	TestPerf bool

	TestVerbose bool

	TestQuiet bool

	TestUndefined bool
	// contains filtered or unexported fields
}

func (*TestConfig) GoPointer 

func (x *TestConfig) GoPointer() uintptr

type TestDataFunc 

type TestDataFunc func(uintptr)

The type used for test case functions that take an extra pointer argument.

type TestFileType 

type TestFileType int

The type of file to return the filename for, when used with [func@GLib.test_build_filename].

These two options correspond rather directly to the 'dist' and 'built' terminology that automake uses and are explicitly used to distinguish between the 'srcdir' and 'builddir' being separate. All files in your project should either be dist (in the `EXTRA_DIST` or `dist_schema_DATA` sense, in which case they will always be in the srcdir) or built (in the `BUILT_SOURCES` sense, in which case they will always be in the builddir).

Note: As a general rule of automake, files that are generated only as part of the build-from-git process (but then are distributed with the tarball) always go in srcdir (even if doing a srcdir != builddir build from git) and are considered as distributed files.

The same principles apply for other build systems, such as meson. 

const (

	// a file that was included in the distribution tarball
	GTestDistValue TestFileType = 0
	// a file that was built on the compiling machine
	GTestBuiltValue TestFileType = 1
)

type TestFixtureFunc 

type TestFixtureFunc func(uintptr, uintptr)

The type used for functions that operate on test fixtures.

This is used for the fixture setup and teardown functions as well as for the testcases themselves.

@user_data is a pointer to the data that was given when registering the test case.

@fixture will be a pointer to the area of memory allocated by the test framework, of the size requested. If the requested size was zero then @fixture will be equal to @user_data.

type TestFunc 

type TestFunc func()

The type used for test case functions.

type TestLogBuffer 

type TestLogBuffer struct {
	Data *String

	Msgs *SList
	// contains filtered or unexported fields
}

func (*TestLogBuffer) Free 

func (x *TestLogBuffer) Free()

Internal function for gtester to free test log messages, no ABI guarantees provided.

func (*TestLogBuffer) GoPointer 

func (x *TestLogBuffer) GoPointer() uintptr

func (*TestLogBuffer) Pop 

func (x *TestLogBuffer) Pop() *TestLogMsg

Internal function for gtester to retrieve test log messages, no ABI guarantees provided.

func (*TestLogBuffer) Push 

func (x *TestLogBuffer) Push(NBytesVar uint, BytesVar byte)

Internal function for gtester to decode test log messages, no ABI guarantees provided.

type TestLogFatalFunc 

type TestLogFatalFunc func(string, LogLevelFlags, string, uintptr) bool

Specifies the prototype of fatal log handler functions.

type TestLogMsg 

type TestLogMsg struct {
	LogType TestLogType

	NStrings uint

	Strings uintptr

	NNums uint

	Nums float64
	// contains filtered or unexported fields
}

func (*TestLogMsg) Free 

func (x *TestLogMsg) Free()

Internal function for gtester to free test log messages, no ABI guarantees provided.

func (*TestLogMsg) GoPointer 

func (x *TestLogMsg) GoPointer() uintptr

type TestLogType 

type TestLogType int
const (
	GTestLogNoneValue TestLogType = 0

	GTestLogErrorValue TestLogType = 1

	GTestLogStartBinaryValue TestLogType = 2

	GTestLogListCaseValue TestLogType = 3

	GTestLogSkipCaseValue TestLogType = 4

	GTestLogStartCaseValue TestLogType = 5

	GTestLogStopCaseValue TestLogType = 6

	GTestLogMinResultValue TestLogType = 7

	GTestLogMaxResultValue TestLogType = 8

	GTestLogMessageValue TestLogType = 9

	GTestLogStartSuiteValue TestLogType = 10

	GTestLogStopSuiteValue TestLogType = 11
)

type TestResult 

type TestResult int
const (
	GTestRunSuccessValue TestResult = 0

	GTestRunSkippedValue TestResult = 1

	GTestRunFailureValue TestResult = 2

	GTestRunIncompleteValue TestResult = 3
)

type TestSubprocessFlags 

type TestSubprocessFlags int

Flags to pass to [func@GLib.test_trap_subprocess] to control input and output.

Note that in contrast with [func@GLib.test_trap_fork], the default behavior of [func@GLib.test_trap_subprocess] is to not show stdout and stderr. 

const (

	// Default behaviour. Since: 2.74
	GTestSubprocessDefaultValue TestSubprocessFlags = 0
	// If this flag is given, the child
	//   process will inherit the parent's stdin. Otherwise, the child's
	//   stdin is redirected to `/dev/null`.
	GTestSubprocessInheritStdinValue TestSubprocessFlags = 1
	// If this flag is given, the child
	//   process will inherit the parent's stdout. Otherwise, the child's
	//   stdout will not be visible, but it will be captured to allow
	//   later tests with [func@GLib.test_trap_assert_stdout].
	GTestSubprocessInheritStdoutValue TestSubprocessFlags = 2
	// If this flag is given, the child
	//   process will inherit the parent's stderr. Otherwise, the child's
	//   stderr will not be visible, but it will be captured to allow
	//   later tests with [func@GLib.test_trap_assert_stderr].
	GTestSubprocessInheritStderrValue TestSubprocessFlags = 4
	// If this flag is given, the
	//   child process will inherit the parent’s open file descriptors.
	GTestSubprocessInheritDescriptorsValue TestSubprocessFlags = 8
)

type TestSuite 

type TestSuite struct {
	// contains filtered or unexported fields
}

An opaque structure representing a test suite.

func TestCreateSuite 

func TestCreateSuite(SuiteNameVar string) *TestSuite

Creates a new test suite with the name @suite_name.

func TestGetRoot 

func TestGetRoot() *TestSuite

Gets the toplevel test suite for the test path API.

func (*TestSuite) Add 

func (x *TestSuite) Add(TestCaseVar *TestCase)

Adds @test_case to @suite.

func (*TestSuite) AddSuite 

func (x *TestSuite) AddSuite(NestedsuiteVar *TestSuite)

Adds @nestedsuite to @suite.

func (*TestSuite) Free 

func (x *TestSuite) Free()

Frees the @suite and all nested suites.

func (*TestSuite) GoPointer 

func (x *TestSuite) GoPointer() uintptr

type TestTrapFlags 

type TestTrapFlags int

Flags to pass to [func@GLib.test_trap_fork] to control input and output.

Test traps are guards around forked tests. These flags determine what traps to set. 

const (

	// Default behaviour. Since: 2.74
	GTestTrapDefaultValue TestTrapFlags = 0
	// Redirect stdout of the test child to
	//     `/dev/null` so it cannot be observed on the console during test
	//     runs. The actual output is still captured though to allow later
	//     tests with g_test_trap_assert_stdout().
	GTestTrapSilenceStdoutValue TestTrapFlags = 128
	// Redirect stderr of the test child to
	//     `/dev/null` so it cannot be observed on the console during test
	//     runs. The actual output is still captured though to allow later
	//     tests with g_test_trap_assert_stderr().
	GTestTrapSilenceStderrValue TestTrapFlags = 256
	// If this flag is given, stdin of the
	//     child process is shared with stdin of its parent process.
	//     It is redirected to `/dev/null` otherwise.
	GTestTrapInheritStdinValue TestTrapFlags = 512
)

type Thread 

type Thread struct {
	Func ThreadFunc

	Data uintptr

	Joinable bool

	Priority ThreadPriority
	// contains filtered or unexported fields
}

The #GThread struct represents a running thread. This struct is returned by g_thread_new() or g_thread_try_new(). You can obtain the #GThread struct representing the current thread by calling g_thread_self().

GThread is refcounted, see g_thread_ref() and g_thread_unref(). The thread represented by it holds a reference while it is running, and g_thread_join() consumes the reference that it is given, so it is normally not necessary to manage GThread references explicitly.

The structure is opaque -- none of its fields may be directly accessed.

func NewThread 

func NewThread(NameVar *string, FuncVar *ThreadFunc, DataVar uintptr) *Thread

This function creates a new thread. The new thread starts by invoking @func with the argument data. The thread will run until @func returns or until g_thread_exit() is called from the new thread. The return value of @func becomes the return value of the thread, which can be obtained with g_thread_join().

The @name can be useful for discriminating threads in a debugger. It is not used for other purposes and does not have to be unique. Some systems restrict the length of @name to 16 bytes.

If the thread can not be created the program aborts. See g_thread_try_new() if you want to attempt to deal with failures.

If you are using threads to offload (potentially many) short-lived tasks, #GThreadPool may be more appropriate than manually spawning and tracking multiple #GThreads.

To free the struct returned by this function, use g_thread_unref(). Note that g_thread_join() implicitly unrefs the #GThread as well.

New threads by default inherit their scheduler policy (POSIX) or thread priority (Windows) of the thread creating the new thread.

This behaviour changed in GLib 2.64: before threads on Windows were not inheriting the thread priority but were spawned with the default priority. Starting with GLib 2.64 the behaviour is now consistent between Windows and POSIX and all threads inherit their parent thread's priority.

func ThreadCreate 

func ThreadCreate(FuncVar *ThreadFunc, DataVar uintptr, JoinableVar bool) (*Thread, error)

This function creates a new thread.

The new thread executes the function @func with the argument @data. If the thread was created successfully, it is returned.

@error can be %NULL to ignore errors, or non-%NULL to report errors. The error is set, if and only if the function returns %NULL.

This function returns a reference to the created thread only if @joinable is %TRUE. In that case, you must free this reference by calling g_thread_unref() or g_thread_join(). If @joinable is %FALSE then you should probably not touch the return value.

func ThreadCreateFull 

func ThreadCreateFull(FuncVar *ThreadFunc, DataVar uintptr, StackSizeVar uint, JoinableVar bool, BoundVar bool, PriorityVar ThreadPriority) (*Thread, error)

This function creates a new thread.

func ThreadSelf 

func ThreadSelf() *Thread

This function returns the #GThread corresponding to the current thread. Note that this function does not increase the reference count of the returned struct.

This function will return a #GThread even for threads that were not created by GLib (i.e. those created by other threading APIs). This may be useful for thread identification purposes (i.e. comparisons) but you must not use GLib functions (such as g_thread_join()) on these threads.

func ThreadTryNew 

func ThreadTryNew(NameVar *string, FuncVar *ThreadFunc, DataVar uintptr) (*Thread, error)

This function is the same as g_thread_new() except that it allows for the possibility of failure.

If a thread can not be created (due to resource limits), @error is set and %NULL is returned.

func (*Thread) GetName 

func (x *Thread) GetName() string

Gets the name of the thread.

This function is intended for debugging purposes.

func (*Thread) GoPointer 

func (x *Thread) GoPointer() uintptr

func (*Thread) Join 

func (x *Thread) Join() uintptr

Waits until @thread finishes, i.e. the function @func, as given to g_thread_new(), returns or g_thread_exit() is called. If @thread has already terminated, then g_thread_join() returns immediately.

Any thread can wait for any other thread by calling g_thread_join(), not just its 'creator'. Calling g_thread_join() from multiple threads for the same @thread leads to undefined behaviour.

The value returned by @func or given to g_thread_exit() is returned by this function.

g_thread_join() consumes the reference to the passed-in @thread. This will usually cause the #GThread struct and associated resources to be freed. Use g_thread_ref() to obtain an extra reference if you want to keep the GThread alive beyond the g_thread_join() call.

func (*Thread) Ref 

func (x *Thread) Ref() *Thread

Increase the reference count on @thread.

func (*Thread) SetPriority 

func (x *Thread) SetPriority(PriorityVar ThreadPriority)

This function does nothing.

func (*Thread) Unref 

func (x *Thread) Unref()

Decrease the reference count on @thread, possibly freeing all resources associated with it.

Note that each thread holds a reference to its #GThread while it is running, so it is safe to drop your own reference to it if you don't need it anymore.

type ThreadError 

type ThreadError int

Possible errors of thread related functions. 

const (

	// a thread couldn't be created due to resource
	//                        shortage. Try again later.
	GThreadErrorAgainValue ThreadError = 0
)

type ThreadFunc 

type ThreadFunc func(uintptr) uintptr

Specifies the type of the @func functions passed to g_thread_new() or g_thread_try_new().

type ThreadFunctions 

type ThreadFunctions struct {
	// contains filtered or unexported fields
}

This function table is no longer used by g_thread_init() to initialize the thread system.

func (*ThreadFunctions) GetCondBroadcast 

func (x *ThreadFunctions) GetCondBroadcast() func(*Cond)

GetCondBroadcast gets the "cond_broadcast" callback function. virtual function pointer for g_cond_broadcast()

func (*ThreadFunctions) GetCondFree 

func (x *ThreadFunctions) GetCondFree() func(*Cond)

GetCondFree gets the "cond_free" callback function. virtual function pointer for g_cond_free()

func (*ThreadFunctions) GetCondNew 

func (x *ThreadFunctions) GetCondNew() func() *Cond

GetCondNew gets the "cond_new" callback function. virtual function pointer for g_cond_new()

func (*ThreadFunctions) GetCondSignal 

func (x *ThreadFunctions) GetCondSignal() func(*Cond)

GetCondSignal gets the "cond_signal" callback function. virtual function pointer for g_cond_signal()

func (*ThreadFunctions) GetCondTimedWait 

func (x *ThreadFunctions) GetCondTimedWait() func(*Cond, *Mutex, *TimeVal) bool

GetCondTimedWait gets the "cond_timed_wait" callback function. virtual function pointer for g_cond_timed_wait()

func (*ThreadFunctions) GetCondWait 

func (x *ThreadFunctions) GetCondWait() func(*Cond, *Mutex)

GetCondWait gets the "cond_wait" callback function. virtual function pointer for g_cond_wait()

func (*ThreadFunctions) GetMutexFree 

func (x *ThreadFunctions) GetMutexFree() func(*Mutex)

GetMutexFree gets the "mutex_free" callback function. virtual function pointer for g_mutex_free()

func (*ThreadFunctions) GetMutexLock 

func (x *ThreadFunctions) GetMutexLock() func(*Mutex)

GetMutexLock gets the "mutex_lock" callback function. virtual function pointer for g_mutex_lock()

func (*ThreadFunctions) GetMutexNew 

func (x *ThreadFunctions) GetMutexNew() func() *Mutex

GetMutexNew gets the "mutex_new" callback function. virtual function pointer for g_mutex_new()

func (*ThreadFunctions) GetMutexTrylock 

func (x *ThreadFunctions) GetMutexTrylock() func(*Mutex) bool

GetMutexTrylock gets the "mutex_trylock" callback function. virtual function pointer for g_mutex_trylock()

func (*ThreadFunctions) GetMutexUnlock 

func (x *ThreadFunctions) GetMutexUnlock() func(*Mutex)

GetMutexUnlock gets the "mutex_unlock" callback function. virtual function pointer for g_mutex_unlock()

func (*ThreadFunctions) GetPrivateGet 

func (x *ThreadFunctions) GetPrivateGet() func(*Private) uintptr

GetPrivateGet gets the "private_get" callback function. virtual function pointer for g_private_get()

func (*ThreadFunctions) GetPrivateNew 

func (x *ThreadFunctions) GetPrivateNew() func(*DestroyNotify) *Private

GetPrivateNew gets the "private_new" callback function. virtual function pointer for g_private_new()

func (*ThreadFunctions) GetPrivateSet 

func (x *ThreadFunctions) GetPrivateSet() func(*Private, uintptr)

GetPrivateSet gets the "private_set" callback function. virtual function pointer for g_private_set()

func (*ThreadFunctions) GetThreadCreate 

func (x *ThreadFunctions) GetThreadCreate() func(*ThreadFunc, uintptr, uint, bool, bool, ThreadPriority, uintptr)

GetThreadCreate gets the "thread_create" callback function. virtual function pointer for g_thread_create()

func (*ThreadFunctions) GetThreadEqual 

func (x *ThreadFunctions) GetThreadEqual() func(uintptr, uintptr) bool

GetThreadEqual gets the "thread_equal" callback function. used internally by recursive mutex locks and by some 

assertion checks

func (*ThreadFunctions) GetThreadExit 

func (x *ThreadFunctions) GetThreadExit() func()

GetThreadExit gets the "thread_exit" callback function. virtual function pointer for g_thread_exit()

func (*ThreadFunctions) GetThreadJoin 

func (x *ThreadFunctions) GetThreadJoin() func(uintptr)

GetThreadJoin gets the "thread_join" callback function. virtual function pointer for g_thread_join()

func (*ThreadFunctions) GetThreadSelf 

func (x *ThreadFunctions) GetThreadSelf() func(uintptr)

GetThreadSelf gets the "thread_self" callback function. virtual function pointer for g_thread_self()

func (*ThreadFunctions) GetThreadSetPriority 

func (x *ThreadFunctions) GetThreadSetPriority() func(uintptr, ThreadPriority)

GetThreadSetPriority gets the "thread_set_priority" callback function. virtual function pointer for 

g_thread_set_priority()

func (*ThreadFunctions) GetThreadYield 

func (x *ThreadFunctions) GetThreadYield() func()

GetThreadYield gets the "thread_yield" callback function. virtual function pointer for g_thread_yield()

func (*ThreadFunctions) GoPointer 

func (x *ThreadFunctions) GoPointer() uintptr

func (*ThreadFunctions) OverrideCondBroadcast 

func (x *ThreadFunctions) OverrideCondBroadcast(cb func(*Cond))

OverrideCondBroadcast sets the "cond_broadcast" callback function. virtual function pointer for g_cond_broadcast()

func (*ThreadFunctions) OverrideCondFree 

func (x *ThreadFunctions) OverrideCondFree(cb func(*Cond))

OverrideCondFree sets the "cond_free" callback function. virtual function pointer for g_cond_free()

func (*ThreadFunctions) OverrideCondNew 

func (x *ThreadFunctions) OverrideCondNew(cb func() *Cond)

OverrideCondNew sets the "cond_new" callback function. virtual function pointer for g_cond_new()

func (*ThreadFunctions) OverrideCondSignal 

func (x *ThreadFunctions) OverrideCondSignal(cb func(*Cond))

OverrideCondSignal sets the "cond_signal" callback function. virtual function pointer for g_cond_signal()

func (*ThreadFunctions) OverrideCondTimedWait 

func (x *ThreadFunctions) OverrideCondTimedWait(cb func(*Cond, *Mutex, *TimeVal) bool)

OverrideCondTimedWait sets the "cond_timed_wait" callback function. virtual function pointer for g_cond_timed_wait()

func (*ThreadFunctions) OverrideCondWait 

func (x *ThreadFunctions) OverrideCondWait(cb func(*Cond, *Mutex))

OverrideCondWait sets the "cond_wait" callback function. virtual function pointer for g_cond_wait()

func (*ThreadFunctions) OverrideMutexFree 

func (x *ThreadFunctions) OverrideMutexFree(cb func(*Mutex))

OverrideMutexFree sets the "mutex_free" callback function. virtual function pointer for g_mutex_free()

func (*ThreadFunctions) OverrideMutexLock 

func (x *ThreadFunctions) OverrideMutexLock(cb func(*Mutex))

OverrideMutexLock sets the "mutex_lock" callback function. virtual function pointer for g_mutex_lock()

func (*ThreadFunctions) OverrideMutexNew 

func (x *ThreadFunctions) OverrideMutexNew(cb func() *Mutex)

OverrideMutexNew sets the "mutex_new" callback function. virtual function pointer for g_mutex_new()

func (*ThreadFunctions) OverrideMutexTrylock 

func (x *ThreadFunctions) OverrideMutexTrylock(cb func(*Mutex) bool)

OverrideMutexTrylock sets the "mutex_trylock" callback function. virtual function pointer for g_mutex_trylock()

func (*ThreadFunctions) OverrideMutexUnlock 

func (x *ThreadFunctions) OverrideMutexUnlock(cb func(*Mutex))

OverrideMutexUnlock sets the "mutex_unlock" callback function. virtual function pointer for g_mutex_unlock()

func (*ThreadFunctions) OverridePrivateGet 

func (x *ThreadFunctions) OverridePrivateGet(cb func(*Private) uintptr)

OverridePrivateGet sets the "private_get" callback function. virtual function pointer for g_private_get()

func (*ThreadFunctions) OverridePrivateNew 

func (x *ThreadFunctions) OverridePrivateNew(cb func(*DestroyNotify) *Private)

OverridePrivateNew sets the "private_new" callback function. virtual function pointer for g_private_new()

func (*ThreadFunctions) OverridePrivateSet 

func (x *ThreadFunctions) OverridePrivateSet(cb func(*Private, uintptr))

OverridePrivateSet sets the "private_set" callback function. virtual function pointer for g_private_set()

func (*ThreadFunctions) OverrideThreadCreate 

func (x *ThreadFunctions) OverrideThreadCreate(cb func(*ThreadFunc, uintptr, uint, bool, bool, ThreadPriority, uintptr))

OverrideThreadCreate sets the "thread_create" callback function. virtual function pointer for g_thread_create()

func (*ThreadFunctions) OverrideThreadEqual 

func (x *ThreadFunctions) OverrideThreadEqual(cb func(uintptr, uintptr) bool)

OverrideThreadEqual sets the "thread_equal" callback function. used internally by recursive mutex locks and by some 

assertion checks

func (*ThreadFunctions) OverrideThreadExit 

func (x *ThreadFunctions) OverrideThreadExit(cb func())

OverrideThreadExit sets the "thread_exit" callback function. virtual function pointer for g_thread_exit()

func (*ThreadFunctions) OverrideThreadJoin 

func (x *ThreadFunctions) OverrideThreadJoin(cb func(uintptr))

OverrideThreadJoin sets the "thread_join" callback function. virtual function pointer for g_thread_join()

func (*ThreadFunctions) OverrideThreadSelf 

func (x *ThreadFunctions) OverrideThreadSelf(cb func(uintptr))

OverrideThreadSelf sets the "thread_self" callback function. virtual function pointer for g_thread_self()

func (*ThreadFunctions) OverrideThreadSetPriority 

func (x *ThreadFunctions) OverrideThreadSetPriority(cb func(uintptr, ThreadPriority))

OverrideThreadSetPriority sets the "thread_set_priority" callback function. virtual function pointer for 

g_thread_set_priority()

func (*ThreadFunctions) OverrideThreadYield 

func (x *ThreadFunctions) OverrideThreadYield(cb func())

OverrideThreadYield sets the "thread_yield" callback function. virtual function pointer for g_thread_yield()

type ThreadPool 

type ThreadPool struct {
	Func Func

	UserData uintptr

	Exclusive bool
	// contains filtered or unexported fields
}

The `GThreadPool` struct represents a thread pool.

A thread pool is useful when you wish to asynchronously fork out the execution of work and continue working in your own thread. If that will happen often, the overhead of starting and destroying a thread each time might be too high. In such cases reusing already started threads seems like a good idea. And it indeed is, but implementing this can be tedious and error-prone.

Therefore GLib provides thread pools for your convenience. An added advantage is, that the threads can be shared between the different subsystems of your program, when they are using GLib.

To create a new thread pool, you use [func@GLib.ThreadPool.new]. It is destroyed by [method@GLib.ThreadPool.free].

If you want to execute a certain task within a thread pool, use [method@GLib.ThreadPool.push].

To get the current number of running threads you call [method@GLib.ThreadPool.get_num_threads]. To get the number of still unprocessed tasks you call [method@GLib.ThreadPool.unprocessed]. To control the maximum number of threads for a thread pool, you use [method@GLib.ThreadPool.get_max_threads]. and [method@GLib.ThreadPool.set_max_threads].

Finally you can control the number of unused threads, that are kept alive by GLib for future use. The current number can be fetched with [func@GLib.ThreadPool.get_num_unused_threads]. The maximum number can be controlled by [func@GLib.ThreadPool.get_max_unused_threads] and [func@GLib.ThreadPool.set_max_unused_threads]. All currently unused threads can be stopped by calling [func@GLib.ThreadPool.stop_unused_threads].

func (*ThreadPool) Free 

func (x *ThreadPool) Free(ImmediateVar bool, WaitVar bool)

Frees all resources allocated for @pool.

If @immediate is %TRUE, no new task is processed for @pool. Otherwise @pool is not freed before the last task is processed. Note however, that no thread of this pool is interrupted while processing a task. Instead at least all still running threads can finish their tasks before the @pool is freed.

If @wait_ is %TRUE, this function does not return before all tasks to be processed (dependent on @immediate, whether all or only the currently running) are ready. Otherwise this function returns immediately.

After calling this function @pool must not be used anymore.

func (*ThreadPool) GetMaxThreads 

func (x *ThreadPool) GetMaxThreads() int

Returns the maximal number of threads for @pool.

func (*ThreadPool) GetNumThreads 

func (x *ThreadPool) GetNumThreads() uint

Returns the number of threads currently running in @pool.

func (*ThreadPool) GoPointer 

func (x *ThreadPool) GoPointer() uintptr

func (*ThreadPool) MoveToFront 

func (x *ThreadPool) MoveToFront(DataVar uintptr) bool

Moves the item to the front of the queue of unprocessed items, so that it will be processed next.

func (*ThreadPool) Push 

func (x *ThreadPool) Push(DataVar uintptr) (bool, error)

Inserts @data into the list of tasks to be executed by @pool.

When the number of currently running threads is lower than the maximal allowed number of threads, a new thread is started (or reused) with the properties given to g_thread_pool_new(). Otherwise, @data stays in the queue until a thread in this pool finishes its previous task and processes @data.

@error can be %NULL to ignore errors, or non-%NULL to report errors. An error can only occur when a new thread couldn't be created. In that case @data is simply appended to the queue of work to do.

Before version 2.32, this function did not return a success status.

func (*ThreadPool) SetMaxThreads 

func (x *ThreadPool) SetMaxThreads(MaxThreadsVar int) (bool, error)

Sets the maximal allowed number of threads for @pool. A value of -1 means that the maximal number of threads is unlimited. If @pool is an exclusive thread pool, setting the maximal number of threads to -1 is not allowed.

Setting @max_threads to 0 means stopping all work for @pool. It is effectively frozen until @max_threads is set to a non-zero value again.

A thread is never terminated while calling @func, as supplied by g_thread_pool_new(). Instead the maximal number of threads only has effect for the allocation of new threads in g_thread_pool_push(). A new thread is allocated, whenever the number of currently running threads in @pool is smaller than the maximal number.

@error can be %NULL to ignore errors, or non-%NULL to report errors. An error can only occur when a new thread couldn't be created.

Before version 2.32, this function did not return a success status.

func (*ThreadPool) SetSortFunction 

func (x *ThreadPool) SetSortFunction(FuncVar *CompareDataFunc, UserDataVar uintptr)

Sets the function used to sort the list of tasks. This allows the tasks to be processed by a priority determined by @func, and not just in the order in which they were added to the pool.

Note, if the maximum number of threads is more than 1, the order that threads are executed cannot be guaranteed 100%. Threads are scheduled by the operating system and are executed at random. It cannot be assumed that threads are executed in the order they are created.

func (*ThreadPool) Unprocessed 

func (x *ThreadPool) Unprocessed() uint

Returns the number of tasks still unprocessed in @pool.

type ThreadPriority 

type ThreadPriority int

Thread priorities. 

const (

	// a priority lower than normal
	GThreadPriorityLowValue ThreadPriority = 0
	// the default priority
	GThreadPriorityNormalValue ThreadPriority = 1
	// a priority higher than normal
	GThreadPriorityHighValue ThreadPriority = 2
	// the highest priority
	GThreadPriorityUrgentValue ThreadPriority = 3
)

type Time 

type Time = int32

Simply a replacement for `time_t`. It has been deprecated since it is not equivalent to `time_t` on 64-bit platforms with a 64-bit `time_t`.

Unrelated to #GTimer.

Note that #GTime is defined to always be a 32-bit integer, unlike `time_t` which may be 64-bit on some systems. Therefore, #GTime will overflow in the year 2038, and you cannot use the address of a #GTime variable as argument to the UNIX time() function.

Instead, do the following:

|[&lt;!-- language="C" --&gt; time_t ttime; GTime gtime;

time (&amp;ttime); gtime = (GTime)ttime; ]|

type TimeSpan 

type TimeSpan = int64

A value representing an interval of time, in microseconds.

type TimeType 

type TimeType int

Disambiguates a given time in two ways.

First, specifies if the given time is in universal or local time.

Second, if the time is in local time, specifies if it is local standard time or local daylight time. This is important for the case where the same local time occurs twice (during daylight savings time transitions, for example). 

const (

	// the time is in local standard time
	GTimeTypeStandardValue TimeType = 0
	// the time is in local daylight time
	GTimeTypeDaylightValue TimeType = 1
	// the time is in UTC
	GTimeTypeUniversalValue TimeType = 2
)

type TimeVal 

type TimeVal struct {
	TvSec int

	TvUsec int
	// contains filtered or unexported fields
}

Represents a precise time, with seconds and microseconds.

Similar to the struct timeval returned by the `gettimeofday()` UNIX system call.

GLib is attempting to unify around the use of 64-bit integers to represent microsecond-precision time. As such, this type will be removed from a future version of GLib. A consequence of using `glong` for `tv_sec` is that on 32-bit systems `GTimeVal` is subject to the year 2038 problem.

func (*TimeVal) Add 

func (x *TimeVal) Add(MicrosecondsVar int)

Adds the given number of microseconds to @time_. @microseconds can also be negative to decrease the value of @time_.

func (*TimeVal) GoPointer 

func (x *TimeVal) GoPointer() uintptr

func (*TimeVal) ToIso8601 

func (x *TimeVal) ToIso8601() string

Converts @time_ into an RFC 3339 encoded string, relative to the Coordinated Universal Time (UTC). This is one of the many formats allowed by ISO 8601.

ISO 8601 allows a large number of date/time formats, with or without punctuation and optional elements. The format returned by this function is a complete date and time, with optional punctuation included, the UTC time zone represented as "Z", and the @tv_usec part included if and only if it is nonzero, i.e. either "YYYY-MM-DDTHH:MM:SSZ" or "YYYY-MM-DDTHH:MM:SS.fffffZ".

This corresponds to the Internet date/time format defined by [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt), and to either of the two most-precise formats defined by the W3C Note [Date and Time Formats](http://www.w3.org/TR/NOTE-datetime-19980827). Both of these documents are profiles of ISO 8601.

Use g_date_time_format() or g_strdup_printf() if a different variation of ISO 8601 format is required.

If @time_ represents a date which is too large to fit into a `struct tm`, %NULL will be returned. This is platform dependent. Note also that since `GTimeVal` stores the number of seconds as a `glong`, on 32-bit systems it is subject to the year 2038 problem. Accordingly, since GLib 2.62, this function has been deprecated. Equivalent functionality is available using: |[ GDateTime *dt = g_date_time_new_from_unix_utc (time_val); iso8601_string = g_date_time_format_iso8601 (dt); g_date_time_unref (dt); ]|

The return value of g_time_val_to_iso8601() has been nullable since GLib 2.54; before then, GLib would crash under the same conditions.

type TimeZone 

type TimeZone struct {
	// contains filtered or unexported fields
}

A `GTimeZone` represents a time zone, at no particular point in time.

The `GTimeZone` struct is refcounted and immutable.

Each time zone has an identifier (for example, ‘Europe/London’) which is platform dependent. See [ctor@GLib.TimeZone.new] for information on the identifier formats. The identifier of a time zone can be retrieved using [method@GLib.TimeZone.get_identifier].

A time zone contains a number of intervals. Each interval has an abbreviation to describe it (for example, ‘PDT’), an offset to UTC and a flag indicating if the daylight savings time is in effect during that interval. A time zone always has at least one interval — interval 0. Note that interval abbreviations are not the same as time zone identifiers (apart from ‘UTC’), and cannot be passed to [ctor@GLib.TimeZone.new].

Every UTC time is contained within exactly one interval, but a given local time may be contained within zero, one or two intervals (due to incontinuities associated with daylight savings time).

An interval may refer to a specific period of time (eg: the duration of daylight savings time during 2010) or it may refer to many periods of time that share the same properties (eg: all periods of daylight savings time). It is also possible (usually for political reasons) that some properties (like the abbreviation) change between intervals without other properties changing.

func NewTimeZone 

func NewTimeZone(IdentifierVar *string) *TimeZone

A version of g_time_zone_new_identifier() which returns the UTC time zone if @identifier could not be parsed or loaded.

If you need to check whether @identifier was loaded successfully, use g_time_zone_new_identifier().

func NewTimeZoneIdentifier 

func NewTimeZoneIdentifier(IdentifierVar *string) *TimeZone

Creates a #GTimeZone corresponding to @identifier. If @identifier cannot be parsed or loaded, %NULL is returned.

@identifier can either be an RFC3339/ISO 8601 time offset or something that would pass as a valid value for the `TZ` environment variable (including %NULL).

In Windows, @identifier can also be the unlocalized name of a time zone for standard time, for example "Pacific Standard Time".

Valid RFC3339 time offsets are `"Z"` (for UTC) or `"±hh:mm"`. ISO 8601 additionally specifies `"±hhmm"` and `"±hh"`. Offsets are time values to be added to Coordinated Universal Time (UTC) to get the local time.

In UNIX, the `TZ` environment variable typically corresponds to the name of a file in the zoneinfo database, an absolute path to a file somewhere else, or a string in "std offset [dst [offset],start[/time],end[/time]]" (POSIX) format. There are no spaces in the specification. The name of standard and daylight savings time zone must be three or more alphabetic characters. Offsets are time values to be added to local time to get Coordinated Universal Time (UTC) and should be `"[±]hh[[:]mm[:ss]]"`. Dates are either `"Jn"` (Julian day with n between 1 and 365, leap years not counted), `"n"` (zero-based Julian day with n between 0 and 365) or `"Mm.w.d"` (day d (0 &lt;= d &lt;= 6) of week w (1 &lt;= w &lt;= 5) of month m (1 &lt;= m &lt;= 12), day 0 is a Sunday). Times are in local wall clock time, the default is 02:00:00.

In Windows, the "tzn[+|–]hh[:mm[:ss]][dzn]" format is used, but also accepts POSIX format. The Windows format uses US rules for all time zones; daylight savings time is 60 minutes behind the standard time with date and time of change taken from Pacific Standard Time. Offsets are time values to be added to the local time to get Coordinated Universal Time (UTC).

g_time_zone_new_local() calls this function with the value of the `TZ` environment variable. This function itself is independent of the value of `TZ`, but if @identifier is %NULL then `/etc/localtime` will be consulted to discover the correct time zone on UNIX and the registry will be consulted or GetTimeZoneInformation() will be used to get the local time zone on Windows.

If intervals are not available, only time zone rules from `TZ` environment variable or other means, then they will be computed from year 1900 to 2037. If the maximum year for the rules is available and it is greater than 2037, then it will followed instead.

See [RFC3339 §5.6](http://tools.ietf.org/html/rfc3339#section-5.6) for a precise definition of valid RFC3339 time offsets (the `time-offset` expansion) and ISO 8601 for the full list of valid time offsets. See [The GNU C Library manual](http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html) for an explanation of the possible values of the `TZ` environment variable. See [Microsoft Time Zone Index Values](http://msdn.microsoft.com/en-us/library/ms912391%28v=winembedded.11%29.aspx) for the list of time zones on Windows.

You should release the return value by calling g_time_zone_unref() when you are done with it.

func NewTimeZoneLocal 

func NewTimeZoneLocal() *TimeZone

Creates a #GTimeZone corresponding to local time. The local time zone may change between invocations to this function; for example, if the system administrator changes it.

This is equivalent to calling g_time_zone_new() with the value of the `TZ` environment variable (including the possibility of %NULL).

You should release the return value by calling g_time_zone_unref() when you are done with it.

func NewTimeZoneOffset 

func NewTimeZoneOffset(SecondsVar int32) *TimeZone

Creates a #GTimeZone corresponding to the given constant offset from UTC, in seconds.

This is equivalent to calling g_time_zone_new() with a string in the form `[+|-]hh[:mm[:ss]]`.

It is possible for this function to fail if @seconds is too big (greater than 24 hours), in which case this function will return the UTC timezone for backwards compatibility. To detect failures like this, use g_time_zone_new_identifier() directly.

func NewTimeZoneUtc 

func NewTimeZoneUtc() *TimeZone

Creates a #GTimeZone corresponding to UTC.

This is equivalent to calling g_time_zone_new() with a value like "Z", "UTC", "+00", etc.

You should release the return value by calling g_time_zone_unref() when you are done with it.

func (*TimeZone) AdjustTime 

func (x *TimeZone) AdjustTime(TypeVar TimeType, TimeVar *int64) int

Finds an interval within @tz that corresponds to the given @time_, possibly adjusting @time_ if required to fit into an interval. The meaning of @time_ depends on @type.

This function is similar to g_time_zone_find_interval(), with the difference that it always succeeds (by making the adjustments described below).

In any of the cases where g_time_zone_find_interval() succeeds then this function returns the same value, without modifying @time_.

This function may, however, modify @time_ in order to deal with non-existent times. If the non-existent local @time_ of 02:30 were requested on March 14th 2010 in Toronto then this function would adjust @time_ to be 03:00 and return the interval containing the adjusted time.

func (*TimeZone) FindInterval 

func (x *TimeZone) FindInterval(TypeVar TimeType, TimeVar int64) int

Finds an interval within @tz that corresponds to the given @time_. The meaning of @time_ depends on @type.

If @type is %G_TIME_TYPE_UNIVERSAL then this function will always succeed (since universal time is monotonic and continuous).

Otherwise @time_ is treated as local time. The distinction between %G_TIME_TYPE_STANDARD and %G_TIME_TYPE_DAYLIGHT is ignored except in the case that the given @time_ is ambiguous. In Toronto, for example, 01:30 on November 7th 2010 occurred twice (once inside of daylight savings time and the next, an hour later, outside of daylight savings time). In this case, the different value of @type would result in a different interval being returned.

It is still possible for this function to fail. In Toronto, for example, 02:00 on March 14th 2010 does not exist (due to the leap forward to begin daylight savings time). -1 is returned in that case.

func (*TimeZone) GetAbbreviation 

func (x *TimeZone) GetAbbreviation(IntervalVar int) string

Determines the time zone abbreviation to be used during a particular @interval of time in the time zone @tz.

For example, in Toronto this is currently "EST" during the winter months and "EDT" during the summer months when daylight savings time is in effect.

func (*TimeZone) GetIdentifier 

func (x *TimeZone) GetIdentifier() string

Get the identifier of this #GTimeZone, as passed to g_time_zone_new(). If the identifier passed at construction time was not recognised, `UTC` will be returned. If it was %NULL, the identifier of the local timezone at construction time will be returned.

The identifier will be returned in the same format as provided at construction time: if provided as a time offset, that will be returned by this function.

func (*TimeZone) GetOffset 

func (x *TimeZone) GetOffset(IntervalVar int) int32

Determines the offset to UTC in effect during a particular @interval of time in the time zone @tz.

The offset is the number of seconds that you add to UTC time to arrive at local time for @tz (ie: negative numbers for time zones west of GMT, positive numbers for east).

func (*TimeZone) GoPointer 

func (x *TimeZone) GoPointer() uintptr

func (*TimeZone) IsDst 

func (x *TimeZone) IsDst(IntervalVar int) bool

Determines if daylight savings time is in effect during a particular @interval of time in the time zone @tz.

func (*TimeZone) Ref 

func (x *TimeZone) Ref() *TimeZone

Increases the reference count on @tz.

func (*TimeZone) Unref 

func (x *TimeZone) Unref()

Decreases the reference count on @tz.

type Timer 

type Timer struct {
	// contains filtered or unexported fields
}

`GTimer` records a start time, and counts microseconds elapsed since that time.

This is done somewhat differently on different platforms, and can be tricky to get exactly right, so `GTimer` provides a portable/convenient interface.

func (*Timer) Continue 

func (x *Timer) Continue()

Resumes a timer that has previously been stopped with g_timer_stop(). g_timer_stop() must be called before using this function.

func (*Timer) Destroy 

func (x *Timer) Destroy()

Destroys a timer, freeing associated resources.

func (*Timer) Elapsed 

func (x *Timer) Elapsed(MicrosecondsVar uint) float64

If @timer has been started but not stopped, obtains the time since the timer was started. If @timer has been stopped, obtains the elapsed time between the time it was started and the time it was stopped. The return value is the number of seconds elapsed, including any fractional part. The @microseconds out parameter is essentially useless.

func (*Timer) GoPointer 

func (x *Timer) GoPointer() uintptr

func (*Timer) IsActive 

func (x *Timer) IsActive() bool

Exposes whether the timer is currently active.

func (*Timer) Reset 

func (x *Timer) Reset()

This function is useless; it's fine to call g_timer_start() on an already-started timer to reset the start time, so g_timer_reset() serves no purpose.

func (*Timer) Start 

func (x *Timer) Start()

Marks a start time, so that future calls to g_timer_elapsed() will report the time since g_timer_start() was called. g_timer_new() automatically marks the start time, so no need to call g_timer_start() immediately after creating the timer.

func (*Timer) Stop 

func (x *Timer) Stop()

Marks an end time, so calls to g_timer_elapsed() will return the difference between this end time and the start time.

type TokenType 

type TokenType int

The possible types of token returned from each g_scanner_get_next_token() call. 

const (

	// the end of the file
	GTokenEofValue TokenType = 0
	// a '(' character
	GTokenLeftParenValue TokenType = 40
	// a ')' character
	GTokenRightParenValue TokenType = 41
	// a '{' character
	GTokenLeftCurlyValue TokenType = 123
	// a '}' character
	GTokenRightCurlyValue TokenType = 125
	// a '[' character
	GTokenLeftBraceValue TokenType = 91
	// a ']' character
	GTokenRightBraceValue TokenType = 93
	// a '=' character
	GTokenEqualSignValue TokenType = 61
	// a ',' character
	GTokenCommaValue TokenType = 44
	// not a token
	GTokenNoneValue TokenType = 256
	// an error occurred
	GTokenErrorValue TokenType = 257
	// a character
	GTokenCharValue TokenType = 258
	// a binary integer
	GTokenBinaryValue TokenType = 259
	// an octal integer
	GTokenOctalValue TokenType = 260
	// an integer
	GTokenIntValue TokenType = 261
	// a hex integer
	GTokenHexValue TokenType = 262
	// a floating point number
	GTokenFloatValue TokenType = 263
	// a string
	GTokenStringValue TokenType = 264
	// a symbol
	GTokenSymbolValue TokenType = 265
	// an identifier
	GTokenIdentifierValue TokenType = 266
	// a null identifier
	GTokenIdentifierNullValue TokenType = 267
	// one line comment
	GTokenCommentSingleValue TokenType = 268
	// multi line comment
	GTokenCommentMultiValue TokenType = 269
)

type TokenValue 

type TokenValue = uintptr

A union holding the value of the token.

type TranslateFunc 

type TranslateFunc func(string, uintptr) string

The type of functions which are used to translate user-visible strings, for &lt;option&gt;--help&lt;/option&gt; output.

type TrashStack 

type TrashStack struct {
	Next *TrashStack
	// contains filtered or unexported fields
}

A `GTrashStack` is an efficient way to keep a stack of unused allocated memory chunks. Each memory chunk is required to be large enough to hold a `gpointer`. This allows the stack to be maintained without any space overhead, since the stack pointers can be stored inside the memory chunks.

There is no function to create a `GTrashStack`. A `NULL` `GTrashStack*` is a perfectly valid empty stack.

Each piece of memory that is pushed onto the stack is cast to a `GTrashStack*`.

There is no longer any good reason to use `GTrashStack`. If you have extra pieces of memory, `free()` them and allocate them again later.

func (*TrashStack) GoPointer 

func (x *TrashStack) GoPointer() uintptr

type TraverseFlags 

type TraverseFlags int

Specifies which nodes are visited during several of the tree functions, including g_node_traverse() and g_node_find(). 

const (

	// only leaf nodes should be visited. This name has
	//                     been introduced in 2.6, for older version use
	//                     %G_TRAVERSE_LEAFS.
	GTraverseLeavesValue TraverseFlags = 1
	// only non-leaf nodes should be visited. This
	//                         name has been introduced in 2.6, for older
	//                         version use %G_TRAVERSE_NON_LEAFS.
	GTraverseNonLeavesValue TraverseFlags = 2
	// all nodes should be visited.
	GTraverseAllValue TraverseFlags = 3
	// a mask of all traverse flags.
	GTraverseMaskValue TraverseFlags = 3
	// identical to %G_TRAVERSE_LEAVES.
	GTraverseLeafsValue TraverseFlags = 1
	// identical to %G_TRAVERSE_NON_LEAVES.
	GTraverseNonLeafsValue TraverseFlags = 2
)

type TraverseFunc 

type TraverseFunc func(uintptr, uintptr, uintptr) bool

Specifies the type of function passed to g_tree_traverse(). It is passed the key and value of each node, together with the @user_data parameter passed to g_tree_traverse(). If the function returns %TRUE, the traversal is stopped.

type TraverseNodeFunc 

type TraverseNodeFunc func(*TreeNode, uintptr) bool

Specifies the type of function passed to g_tree_foreach_node(). It is passed each node, together with the @user_data parameter passed to g_tree_foreach_node(). If the function returns %TRUE, the traversal is stopped.

type TraverseType 

type TraverseType int

Specifies the type of traversal performed by g_tree_traverse(), g_node_traverse() and g_node_find().

The different orders are illustrated here:

  • In order: A, B, C, D, E, F, G, H, I &lt;picture&gt; &lt;source srcset="Sorted_binary_tree_inorder-dark.svg" media="(prefers-color-scheme: dark)"&gt; &lt;img src="Sorted_binary_tree_inorder.svg" alt="Sorted binary tree, in-order traversal"&gt; &lt;/picture&gt;
  • Pre order: F, B, A, D, C, E, G, I, H &lt;picture&gt; &lt;source srcset="Sorted_binary_tree_preorder-dark.svg" media="(prefers-color-scheme: dark)"&gt; &lt;img src="Sorted_binary_tree_preorder.svg" alt="Sorted binary tree, pre-order traversal"&gt; &lt;/picture&gt;
  • Post order: A, C, E, D, B, H, I, G, F &lt;picture&gt; &lt;source srcset="Sorted_binary_tree_postorder-dark.svg" media="(prefers-color-scheme: dark)"&gt; &lt;img src="Sorted_binary_tree_postorder.svg" alt="Sorted binary tree, post-order traversal"&gt; &lt;/picture&gt;
  • Level order: F, B, G, A, D, I, C, E, H &lt;picture&gt; &lt;source srcset="Sorted_binary_tree_breadth-first_traversal-dark.svg" media="(prefers-color-scheme: dark)"&gt; &lt;img src="Sorted_binary_tree_breadth-first_traversal.svg" alt="Sorted binary tree, breadth-first level order traversal"&gt; &lt;/picture&gt;
const (

	// visits a node's left child first, then the node itself,
	//              then its right child. This is the one to use if you
	//              want the output sorted according to the compare
	//              function.
	GInOrderValue TraverseType = 0
	// visits a node, then its children.
	GPreOrderValue TraverseType = 1
	// visits the node's children, then the node itself.
	GPostOrderValue TraverseType = 2
	// is not implemented for
	//              [balanced binary trees](data-structures.html#binary-trees).
	//              For [n-ary trees](data-structures.html#n-ary-trees), it
	//              visits the root node first, then its children, then
	//              its grandchildren, and so on. Note that this is less
	//              efficient than the other orders.
	GLevelOrderValue TraverseType = 3
)

type Tree 

type Tree struct {
	// contains filtered or unexported fields
}

The GTree struct is an opaque data structure representing a [balanced binary tree](data-structures.html#binary-trees). It should be accessed only by using the following functions.

func NewTree 

func NewTree(KeyCompareFuncVar *CompareFunc) *Tree

Creates a new #GTree.

func NewTreeFull 

func NewTreeFull(KeyCompareFuncVar *CompareDataFunc, KeyCompareDataVar uintptr, KeyDestroyFuncVar *DestroyNotify, ValueDestroyFuncVar *DestroyNotify) *Tree

Creates a new #GTree like g_tree_new() and allows to specify functions to free the memory allocated for the key and value that get called when removing the entry from the #GTree.

func NewTreeWithData 

func NewTreeWithData(KeyCompareFuncVar *CompareDataFunc, KeyCompareDataVar uintptr) *Tree

Creates a new #GTree with a comparison function that accepts user data. See g_tree_new() for more details.

func (*Tree) Destroy 

func (x *Tree) Destroy()

Removes all keys and values from the #GTree and decreases its reference count by one. If keys and/or values are dynamically allocated, you should either free them first or create the #GTree using g_tree_new_full(). In the latter case the destroy functions you supplied will be called on all keys and values before destroying the #GTree.

func (*Tree) Foreach 

func (x *Tree) Foreach(FuncVar *TraverseFunc, UserDataVar uintptr)

Calls the given function for each of the key/value pairs in the #GTree. The function is passed the key and value of each pair, and the given @data parameter. The tree is traversed in sorted order.

The tree may not be modified while iterating over it (you can't add/remove items). To remove all items matching a predicate, you need to add each item to a list in your #GTraverseFunc as you walk over the tree, then walk the list and remove each item.

func (*Tree) ForeachNode 

func (x *Tree) ForeachNode(FuncVar *TraverseNodeFunc, UserDataVar uintptr)

Calls the given function for each of the nodes in the #GTree. The function is passed the pointer to the particular node, and the given @data parameter. The tree traversal happens in-order.

The tree may not be modified while iterating over it (you can't add/remove items). To remove all items matching a predicate, you need to add each item to a list in your #GTraverseFunc as you walk over the tree, then walk the list and remove each item.

func (*Tree) GoPointer 

func (x *Tree) GoPointer() uintptr

func (*Tree) Height 

func (x *Tree) Height() int

Gets the height of a #GTree.

If the #GTree contains no nodes, the height is 0. If the #GTree contains only one root node the height is 1. If the root node has children the height is 2, etc.

func (*Tree) Insert 

func (x *Tree) Insert(KeyVar uintptr, ValueVar uintptr)

Inserts a key/value pair into a #GTree.

Inserts a new key and value into a #GTree as g_tree_insert_node() does, only this function does not return the inserted or set node.

func (*Tree) InsertNode 

func (x *Tree) InsertNode(KeyVar uintptr, ValueVar uintptr) *TreeNode

Inserts a key/value pair into a #GTree.

If the given key already exists in the #GTree its corresponding value is set to the new value. If you supplied a @value_destroy_func when creating the #GTree, the old value is freed using that function. If you supplied a @key_destroy_func when creating the #GTree, the passed key is freed using that function.

The tree is automatically 'balanced' as new key/value pairs are added, so that the distance from the root to every leaf is as small as possible. The cost of maintaining a balanced tree while inserting new key/value result in a O(n log(n)) operation where most of the other operations are O(log(n)).

func (*Tree) Lookup 

func (x *Tree) Lookup(KeyVar uintptr) uintptr

Gets the value corresponding to the given key. Since a #GTree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree).

func (*Tree) LookupExtended 

func (x *Tree) LookupExtended(LookupKeyVar uintptr, OrigKeyVar *uintptr, ValueVar *uintptr) bool

Looks up a key in the #GTree, returning the original key and the associated value. This is useful if you need to free the memory allocated for the original key, for example before calling g_tree_remove().

func (*Tree) LookupNode 

func (x *Tree) LookupNode(KeyVar uintptr) *TreeNode

Gets the tree node corresponding to the given key. Since a #GTree is automatically balanced as key/value pairs are added, key lookup is O(log n) (where n is the number of key/value pairs in the tree).

func (*Tree) LowerBound 

func (x *Tree) LowerBound(KeyVar uintptr) *TreeNode

Gets the lower bound node corresponding to the given key, or %NULL if the tree is empty or all the nodes in the tree have keys that are strictly lower than the searched key.

The lower bound is the first node that has its key greater than or equal to the searched key.

func (*Tree) Nnodes 

func (x *Tree) Nnodes() int

Gets the number of nodes in a #GTree.

func (*Tree) NodeFirst 

func (x *Tree) NodeFirst() *TreeNode

Returns the first in-order node of the tree, or %NULL for an empty tree.

func (*Tree) NodeLast 

func (x *Tree) NodeLast() *TreeNode

Returns the last in-order node of the tree, or %NULL for an empty tree.

func (*Tree) Ref 

func (x *Tree) Ref() *Tree

Increments the reference count of @tree by one.

It is safe to call this function from any thread.

func (*Tree) Remove 

func (x *Tree) Remove(KeyVar uintptr) bool

Removes a key/value pair from a #GTree.

If the #GTree was created using g_tree_new_full(), the key and value are freed using the supplied destroy functions, otherwise you have to make sure that any dynamically allocated values are freed yourself. If the key does not exist in the #GTree, the function does nothing.

The cost of maintaining a balanced tree while removing a key/value result in a O(n log(n)) operation where most of the other operations are O(log(n)).

func (*Tree) RemoveAll 

func (x *Tree) RemoveAll()

Removes all nodes from a #GTree and destroys their keys and values, then resets the #GTree’s root to %NULL.

func (*Tree) Replace 

func (x *Tree) Replace(KeyVar uintptr, ValueVar uintptr)

Inserts a new key and value into a #GTree as g_tree_replace_node() does, only this function does not return the inserted or set node.

func (*Tree) ReplaceNode 

func (x *Tree) ReplaceNode(KeyVar uintptr, ValueVar uintptr) *TreeNode

Inserts a new key and value into a #GTree similar to g_tree_insert_node(). The difference is that if the key already exists in the #GTree, it gets replaced by the new key. If you supplied a @value_destroy_func when creating the #GTree, the old value is freed using that function. If you supplied a @key_destroy_func when creating the #GTree, the old key is freed using that function.

The tree is automatically 'balanced' as new key/value pairs are added, so that the distance from the root to every leaf is as small as possible.

func (*Tree) Search 

func (x *Tree) Search(SearchFuncVar *CompareFunc, UserDataVar uintptr) uintptr

Searches a #GTree using @search_func.

The @search_func is called with a pointer to the key of a key/value pair in the tree, and the passed in @user_data. If @search_func returns 0 for a key/value pair, then the corresponding value is returned as the result of g_tree_search(). If @search_func returns -1, searching will proceed among the key/value pairs that have a smaller key; if @search_func returns 1, searching will proceed among the key/value pairs that have a larger key.

func (*Tree) SearchNode 

func (x *Tree) SearchNode(SearchFuncVar *CompareFunc, UserDataVar uintptr) *TreeNode

Searches a #GTree using @search_func.

The @search_func is called with a pointer to the key of a key/value pair in the tree, and the passed in @user_data. If @search_func returns 0 for a key/value pair, then the corresponding node is returned as the result of g_tree_search(). If @search_func returns -1, searching will proceed among the key/value pairs that have a smaller key; if @search_func returns 1, searching will proceed among the key/value pairs that have a larger key.

func (*Tree) Steal 

func (x *Tree) Steal(KeyVar uintptr) bool

Removes a key and its associated value from a #GTree without calling the key and value destroy functions.

If the key does not exist in the #GTree, the function does nothing.

func (*Tree) Traverse 

func (x *Tree) Traverse(TraverseFuncVar *TraverseFunc, TraverseTypeVar TraverseType, UserDataVar uintptr)

Calls the given function for each node in the #GTree.

func (*Tree) Unref 

func (x *Tree) Unref()

Decrements the reference count of @tree by one. If the reference count drops to 0, all keys and values will be destroyed (if destroy functions were specified) and all memory allocated by @tree will be released.

It is safe to call this function from any thread.

func (*Tree) UpperBound 

func (x *Tree) UpperBound(KeyVar uintptr) *TreeNode

Gets the upper bound node corresponding to the given key, or %NULL if the tree is empty or all the nodes in the tree have keys that are lower than or equal to the searched key.

The upper bound is the first node that has its key strictly greater than the searched key.

type TreeNode 

type TreeNode struct {
	// contains filtered or unexported fields
}

An opaque type which identifies a specific node in a #GTree.

func (*TreeNode) GoPointer 

func (x *TreeNode) GoPointer() uintptr

func (*TreeNode) Key 

func (x *TreeNode) Key() uintptr

Gets the key stored at a particular tree node.

func (*TreeNode) Next 

func (x *TreeNode) Next() *TreeNode

Returns the next in-order node of the tree, or %NULL if the passed node was already the last one.

func (*TreeNode) Previous 

func (x *TreeNode) Previous() *TreeNode

Returns the previous in-order node of the tree, or %NULL if the passed node was already the first one.

func (*TreeNode) Value 

func (x *TreeNode) Value() uintptr

Gets the value stored at a particular tree node.

type Tuples 

type Tuples struct {
	Len uint
	// contains filtered or unexported fields
}

The #GTuples struct is used to return records (or tuples) from the #GRelation by g_relation_select(). It only contains one public member - the number of records that matched. To access the matched records, you must use g_tuples_index().

func (*Tuples) Destroy 

func (x *Tuples) Destroy()

Frees the records which were returned by g_relation_select(). This should always be called after g_relation_select() when you are finished with the records. The records are not removed from the #GRelation.

func (*Tuples) GoPointer 

func (x *Tuples) GoPointer() uintptr

func (*Tuples) Index 

func (x *Tuples) Index(IndexVar int, FieldVar int) uintptr

Gets a field from the records returned by g_relation_select(). It returns the given field of the record at the given index. The returned value should not be changed.

type UnicodeBreakType 

type UnicodeBreakType int

These are the possible line break classifications.

Since new Unicode versions may add new types here, applications should be ready to handle unknown values. They may be regarded as %G_UNICODE_BREAK_UNKNOWN.

See [Unicode Line Breaking Algorithm](https://www.unicode.org/reports/tr14/). 

const (

	// Mandatory Break (BK)
	GUnicodeBreakMandatoryValue UnicodeBreakType = 0
	// Carriage Return (CR)
	GUnicodeBreakCarriageReturnValue UnicodeBreakType = 1
	// Line Feed (LF)
	GUnicodeBreakLineFeedValue UnicodeBreakType = 2
	// Attached Characters and Combining Marks (CM)
	GUnicodeBreakCombiningMarkValue UnicodeBreakType = 3
	// Surrogates (SG)
	GUnicodeBreakSurrogateValue UnicodeBreakType = 4
	// Zero Width Space (ZW)
	GUnicodeBreakZeroWidthSpaceValue UnicodeBreakType = 5
	// Inseparable (IN)
	GUnicodeBreakInseparableValue UnicodeBreakType = 6
	// Non-breaking ("Glue") (GL)
	GUnicodeBreakNonBreakingGlueValue UnicodeBreakType = 7
	// Contingent Break Opportunity (CB)
	GUnicodeBreakContingentValue UnicodeBreakType = 8
	// Space (SP)
	GUnicodeBreakSpaceValue UnicodeBreakType = 9
	// Break Opportunity After (BA)
	GUnicodeBreakAfterValue UnicodeBreakType = 10
	// Break Opportunity Before (BB)
	GUnicodeBreakBeforeValue UnicodeBreakType = 11
	// Break Opportunity Before and After (B2)
	GUnicodeBreakBeforeAndAfterValue UnicodeBreakType = 12
	// Hyphen (HY)
	GUnicodeBreakHyphenValue UnicodeBreakType = 13
	// Nonstarter (NS)
	GUnicodeBreakNonStarterValue UnicodeBreakType = 14
	// Opening Punctuation (OP)
	GUnicodeBreakOpenPunctuationValue UnicodeBreakType = 15
	// Closing Punctuation (CL)
	GUnicodeBreakClosePunctuationValue UnicodeBreakType = 16
	// Ambiguous Quotation (QU)
	GUnicodeBreakQuotationValue UnicodeBreakType = 17
	// Exclamation/Interrogation (EX)
	GUnicodeBreakExclamationValue UnicodeBreakType = 18
	// Ideographic (ID)
	GUnicodeBreakIdeographicValue UnicodeBreakType = 19
	// Numeric (NU)
	GUnicodeBreakNumericValue UnicodeBreakType = 20
	// Infix Separator (Numeric) (IS)
	GUnicodeBreakInfixSeparatorValue UnicodeBreakType = 21
	// Symbols Allowing Break After (SY)
	GUnicodeBreakSymbolValue UnicodeBreakType = 22
	// Ordinary Alphabetic and Symbol Characters (AL)
	GUnicodeBreakAlphabeticValue UnicodeBreakType = 23
	// Prefix (Numeric) (PR)
	GUnicodeBreakPrefixValue UnicodeBreakType = 24
	// Postfix (Numeric) (PO)
	GUnicodeBreakPostfixValue UnicodeBreakType = 25
	// Complex Content Dependent (South East Asian) (SA)
	GUnicodeBreakComplexContextValue UnicodeBreakType = 26
	// Ambiguous (Alphabetic or Ideographic) (AI)
	GUnicodeBreakAmbiguousValue UnicodeBreakType = 27
	// Unknown (XX)
	GUnicodeBreakUnknownValue UnicodeBreakType = 28
	// Next Line (NL)
	GUnicodeBreakNextLineValue UnicodeBreakType = 29
	// Word Joiner (WJ)
	GUnicodeBreakWordJoinerValue UnicodeBreakType = 30
	// Hangul L Jamo (JL)
	GUnicodeBreakHangulLJamoValue UnicodeBreakType = 31
	// Hangul V Jamo (JV)
	GUnicodeBreakHangulVJamoValue UnicodeBreakType = 32
	// Hangul T Jamo (JT)
	GUnicodeBreakHangulTJamoValue UnicodeBreakType = 33
	// Hangul LV Syllable (H2)
	GUnicodeBreakHangulLvSyllableValue UnicodeBreakType = 34
	// Hangul LVT Syllable (H3)
	GUnicodeBreakHangulLvtSyllableValue UnicodeBreakType = 35
	// Closing Parenthesis (CP). Since 2.28. Deprecated: 2.70: Use %G_UNICODE_BREAK_CLOSE_PARENTHESIS instead.
	GUnicodeBreakCloseParanthesisValue UnicodeBreakType = 36
	// Closing Parenthesis (CP). Since 2.70
	GUnicodeBreakCloseParenthesisValue UnicodeBreakType = 36
	// Conditional Japanese Starter (CJ). Since: 2.32
	GUnicodeBreakConditionalJapaneseStarterValue UnicodeBreakType = 37
	// Hebrew Letter (HL). Since: 2.32
	GUnicodeBreakHebrewLetterValue UnicodeBreakType = 38
	// Regional Indicator (RI). Since: 2.36
	GUnicodeBreakRegionalIndicatorValue UnicodeBreakType = 39
	// Emoji Base (EB). Since: 2.50
	GUnicodeBreakEmojiBaseValue UnicodeBreakType = 40
	// Emoji Modifier (EM). Since: 2.50
	GUnicodeBreakEmojiModifierValue UnicodeBreakType = 41
	// Zero Width Joiner (ZWJ). Since: 2.50
	GUnicodeBreakZeroWidthJoinerValue UnicodeBreakType = 42
	// Aksara (AK). Since: 2.80
	GUnicodeBreakAksaraValue UnicodeBreakType = 43
	// Aksara Pre-Base (AP). Since: 2.80
	GUnicodeBreakAksaraPreBaseValue UnicodeBreakType = 44
	// Aksara Start (AS). Since: 2.80
	GUnicodeBreakAksaraStartValue UnicodeBreakType = 45
	// Virama Final (VF). Since: 2.80
	GUnicodeBreakViramaFinalValue UnicodeBreakType = 46
	// Virama (VI). Since: 2.80
	GUnicodeBreakViramaValue UnicodeBreakType = 47
	// Unambiguous Hyphen (HH). Since: 2.88
	GUnicodeBreakUnambiguousHyphenValue UnicodeBreakType = 48
)

func UnicharBreakType 

func UnicharBreakType(CVar uint32) UnicodeBreakType

Determines the break type of @c. @c should be a Unicode character (to derive a character from UTF-8 encoded text, use g_utf8_get_char()). The break type is used to find word and line breaks ("text boundaries"), Pango implements the Unicode boundary resolution algorithms and normally you would use a function such as pango_break() instead of caring about break types yourself.

type UnicodeScript 

type UnicodeScript int

The #GUnicodeScript enumeration identifies different writing systems. The values correspond to the names as defined in the Unicode standard. The enumeration has been added in GLib 2.14, and is interchangeable with #PangoScript.

Note that new types may be added in the future. Applications should be ready to handle unknown values. See [Unicode Standard Annex #24: Script names](http://www.unicode.org/reports/tr24/). 

const (

	// a value never returned from g_unichar_get_script()
	GUnicodeScriptInvalidCodeValue UnicodeScript = -1
	// a character used by multiple different scripts
	GUnicodeScriptCommonValue UnicodeScript = 0
	// a mark glyph that takes its script from the
	//                               base glyph to which it is attached
	GUnicodeScriptInheritedValue UnicodeScript = 1
	// Arabic
	GUnicodeScriptArabicValue UnicodeScript = 2
	// Armenian
	GUnicodeScriptArmenianValue UnicodeScript = 3
	// Bengali
	GUnicodeScriptBengaliValue UnicodeScript = 4
	// Bopomofo
	GUnicodeScriptBopomofoValue UnicodeScript = 5
	// Cherokee
	GUnicodeScriptCherokeeValue UnicodeScript = 6
	// Coptic
	GUnicodeScriptCopticValue UnicodeScript = 7
	// Cyrillic
	GUnicodeScriptCyrillicValue UnicodeScript = 8
	// Deseret
	GUnicodeScriptDeseretValue UnicodeScript = 9
	// Devanagari
	GUnicodeScriptDevanagariValue UnicodeScript = 10
	// Ethiopic
	GUnicodeScriptEthiopicValue UnicodeScript = 11
	// Georgian
	GUnicodeScriptGeorgianValue UnicodeScript = 12
	// Gothic
	GUnicodeScriptGothicValue UnicodeScript = 13
	// Greek
	GUnicodeScriptGreekValue UnicodeScript = 14
	// Gujarati
	GUnicodeScriptGujaratiValue UnicodeScript = 15
	// Gurmukhi
	GUnicodeScriptGurmukhiValue UnicodeScript = 16
	// Han
	GUnicodeScriptHanValue UnicodeScript = 17
	// Hangul
	GUnicodeScriptHangulValue UnicodeScript = 18
	// Hebrew
	GUnicodeScriptHebrewValue UnicodeScript = 19
	// Hiragana
	GUnicodeScriptHiraganaValue UnicodeScript = 20
	// Kannada
	GUnicodeScriptKannadaValue UnicodeScript = 21
	// Katakana
	GUnicodeScriptKatakanaValue UnicodeScript = 22
	// Khmer
	GUnicodeScriptKhmerValue UnicodeScript = 23
	// Lao
	GUnicodeScriptLaoValue UnicodeScript = 24
	// Latin
	GUnicodeScriptLatinValue UnicodeScript = 25
	// Malayalam
	GUnicodeScriptMalayalamValue UnicodeScript = 26
	// Mongolian
	GUnicodeScriptMongolianValue UnicodeScript = 27
	// Myanmar
	GUnicodeScriptMyanmarValue UnicodeScript = 28
	// Ogham
	GUnicodeScriptOghamValue UnicodeScript = 29
	// Old Italic
	GUnicodeScriptOldItalicValue UnicodeScript = 30
	// Oriya
	GUnicodeScriptOriyaValue UnicodeScript = 31
	// Runic
	GUnicodeScriptRunicValue UnicodeScript = 32
	// Sinhala
	GUnicodeScriptSinhalaValue UnicodeScript = 33
	// Syriac
	GUnicodeScriptSyriacValue UnicodeScript = 34
	// Tamil
	GUnicodeScriptTamilValue UnicodeScript = 35
	// Telugu
	GUnicodeScriptTeluguValue UnicodeScript = 36
	// Thaana
	GUnicodeScriptThaanaValue UnicodeScript = 37
	// Thai
	GUnicodeScriptThaiValue UnicodeScript = 38
	// Tibetan
	GUnicodeScriptTibetanValue UnicodeScript = 39
	// Canadian Aboriginal
	GUnicodeScriptCanadianAboriginalValue UnicodeScript = 40
	// Yi
	GUnicodeScriptYiValue UnicodeScript = 41
	// Tagalog
	GUnicodeScriptTagalogValue UnicodeScript = 42
	// Hanunoo
	GUnicodeScriptHanunooValue UnicodeScript = 43
	// Buhid
	GUnicodeScriptBuhidValue UnicodeScript = 44
	// Tagbanwa
	GUnicodeScriptTagbanwaValue UnicodeScript = 45
	// Braille
	GUnicodeScriptBrailleValue UnicodeScript = 46
	// Cypriot
	GUnicodeScriptCypriotValue UnicodeScript = 47
	// Limbu
	GUnicodeScriptLimbuValue UnicodeScript = 48
	// Osmanya
	GUnicodeScriptOsmanyaValue UnicodeScript = 49
	// Shavian
	GUnicodeScriptShavianValue UnicodeScript = 50
	// Linear B
	GUnicodeScriptLinearBValue UnicodeScript = 51
	// Tai Le
	GUnicodeScriptTaiLeValue UnicodeScript = 52
	// Ugaritic
	GUnicodeScriptUgariticValue UnicodeScript = 53
	// New Tai Lue
	GUnicodeScriptNewTaiLueValue UnicodeScript = 54
	// Buginese
	GUnicodeScriptBugineseValue UnicodeScript = 55
	// Glagolitic
	GUnicodeScriptGlagoliticValue UnicodeScript = 56
	// Tifinagh
	GUnicodeScriptTifinaghValue UnicodeScript = 57
	// Syloti Nagri
	GUnicodeScriptSylotiNagriValue UnicodeScript = 58
	// Old Persian
	GUnicodeScriptOldPersianValue UnicodeScript = 59
	// Kharoshthi
	GUnicodeScriptKharoshthiValue UnicodeScript = 60
	// an unassigned code point
	GUnicodeScriptUnknownValue UnicodeScript = 61
	// Balinese
	GUnicodeScriptBalineseValue UnicodeScript = 62
	// Cuneiform
	GUnicodeScriptCuneiformValue UnicodeScript = 63
	// Phoenician
	GUnicodeScriptPhoenicianValue UnicodeScript = 64
	// Phags-pa
	GUnicodeScriptPhagsPaValue UnicodeScript = 65
	// N'Ko
	GUnicodeScriptNkoValue UnicodeScript = 66
	// Kayah Li. Since 2.16.3
	GUnicodeScriptKayahLiValue UnicodeScript = 67
	// Lepcha. Since 2.16.3
	GUnicodeScriptLepchaValue UnicodeScript = 68
	// Rejang. Since 2.16.3
	GUnicodeScriptRejangValue UnicodeScript = 69
	// Sundanese. Since 2.16.3
	GUnicodeScriptSundaneseValue UnicodeScript = 70
	// Saurashtra. Since 2.16.3
	GUnicodeScriptSaurashtraValue UnicodeScript = 71
	// Cham. Since 2.16.3
	GUnicodeScriptChamValue UnicodeScript = 72
	// Ol Chiki. Since 2.16.3
	GUnicodeScriptOlChikiValue UnicodeScript = 73
	// Vai. Since 2.16.3
	GUnicodeScriptVaiValue UnicodeScript = 74
	// Carian. Since 2.16.3
	GUnicodeScriptCarianValue UnicodeScript = 75
	// Lycian. Since 2.16.3
	GUnicodeScriptLycianValue UnicodeScript = 76
	// Lydian. Since 2.16.3
	GUnicodeScriptLydianValue UnicodeScript = 77
	// Avestan. Since 2.26
	GUnicodeScriptAvestanValue UnicodeScript = 78
	// Bamum. Since 2.26
	GUnicodeScriptBamumValue UnicodeScript = 79
	// Egyptian Hieroglpyhs. Since 2.26
	GUnicodeScriptEgyptianHieroglyphsValue UnicodeScript = 80
	// Imperial Aramaic. Since 2.26
	GUnicodeScriptImperialAramaicValue UnicodeScript = 81
	// Inscriptional Pahlavi. Since 2.26
	GUnicodeScriptInscriptionalPahlaviValue UnicodeScript = 82
	// Inscriptional Parthian. Since 2.26
	GUnicodeScriptInscriptionalParthianValue UnicodeScript = 83
	// Javanese. Since 2.26
	GUnicodeScriptJavaneseValue UnicodeScript = 84
	// Kaithi. Since 2.26
	GUnicodeScriptKaithiValue UnicodeScript = 85
	// Lisu. Since 2.26
	GUnicodeScriptLisuValue UnicodeScript = 86
	// Meetei Mayek. Since 2.26
	GUnicodeScriptMeeteiMayekValue UnicodeScript = 87
	// Old South Arabian. Since 2.26
	GUnicodeScriptOldSouthArabianValue UnicodeScript = 88
	// Old Turkic. Since 2.28
	GUnicodeScriptOldTurkicValue UnicodeScript = 89
	// Samaritan. Since 2.26
	GUnicodeScriptSamaritanValue UnicodeScript = 90
	// Tai Tham. Since 2.26
	GUnicodeScriptTaiThamValue UnicodeScript = 91
	// Tai Viet. Since 2.26
	GUnicodeScriptTaiVietValue UnicodeScript = 92
	// Batak. Since 2.28
	GUnicodeScriptBatakValue UnicodeScript = 93
	// Brahmi. Since 2.28
	GUnicodeScriptBrahmiValue UnicodeScript = 94
	// Mandaic. Since 2.28
	GUnicodeScriptMandaicValue UnicodeScript = 95
	// Chakma. Since: 2.32
	GUnicodeScriptChakmaValue UnicodeScript = 96
	// Meroitic Cursive. Since: 2.32
	GUnicodeScriptMeroiticCursiveValue UnicodeScript = 97
	// Meroitic Hieroglyphs. Since: 2.32
	GUnicodeScriptMeroiticHieroglyphsValue UnicodeScript = 98
	// Miao. Since: 2.32
	GUnicodeScriptMiaoValue UnicodeScript = 99
	// Sharada. Since: 2.32
	GUnicodeScriptSharadaValue UnicodeScript = 100
	// Sora Sompeng. Since: 2.32
	GUnicodeScriptSoraSompengValue UnicodeScript = 101
	// Takri. Since: 2.32
	GUnicodeScriptTakriValue UnicodeScript = 102
	// Bassa. Since: 2.42
	GUnicodeScriptBassaVahValue UnicodeScript = 103
	// Caucasian Albanian. Since: 2.42
	GUnicodeScriptCaucasianAlbanianValue UnicodeScript = 104
	// Duployan. Since: 2.42
	GUnicodeScriptDuployanValue UnicodeScript = 105
	// Elbasan. Since: 2.42
	GUnicodeScriptElbasanValue UnicodeScript = 106
	// Grantha. Since: 2.42
	GUnicodeScriptGranthaValue UnicodeScript = 107
	// Kjohki. Since: 2.42
	GUnicodeScriptKhojkiValue UnicodeScript = 108
	// Khudawadi, Sindhi. Since: 2.42
	GUnicodeScriptKhudawadiValue UnicodeScript = 109
	// Linear A. Since: 2.42
	GUnicodeScriptLinearAValue UnicodeScript = 110
	// Mahajani. Since: 2.42
	GUnicodeScriptMahajaniValue UnicodeScript = 111
	// Manichaean. Since: 2.42
	GUnicodeScriptManichaeanValue UnicodeScript = 112
	// Mende Kikakui. Since: 2.42
	GUnicodeScriptMendeKikakuiValue UnicodeScript = 113
	// Modi. Since: 2.42
	GUnicodeScriptModiValue UnicodeScript = 114
	// Mro. Since: 2.42
	GUnicodeScriptMroValue UnicodeScript = 115
	// Nabataean. Since: 2.42
	GUnicodeScriptNabataeanValue UnicodeScript = 116
	// Old North Arabian. Since: 2.42
	GUnicodeScriptOldNorthArabianValue UnicodeScript = 117
	// Old Permic. Since: 2.42
	GUnicodeScriptOldPermicValue UnicodeScript = 118
	// Pahawh Hmong. Since: 2.42
	GUnicodeScriptPahawhHmongValue UnicodeScript = 119
	// Palmyrene. Since: 2.42
	GUnicodeScriptPalmyreneValue UnicodeScript = 120
	// Pau Cin Hau. Since: 2.42
	GUnicodeScriptPauCinHauValue UnicodeScript = 121
	// Psalter Pahlavi. Since: 2.42
	GUnicodeScriptPsalterPahlaviValue UnicodeScript = 122
	// Siddham. Since: 2.42
	GUnicodeScriptSiddhamValue UnicodeScript = 123
	// Tirhuta. Since: 2.42
	GUnicodeScriptTirhutaValue UnicodeScript = 124
	// Warang Citi. Since: 2.42
	GUnicodeScriptWarangCitiValue UnicodeScript = 125
	// Ahom. Since: 2.48
	GUnicodeScriptAhomValue UnicodeScript = 126
	// Anatolian Hieroglyphs. Since: 2.48
	GUnicodeScriptAnatolianHieroglyphsValue UnicodeScript = 127
	// Hatran. Since: 2.48
	GUnicodeScriptHatranValue UnicodeScript = 128
	// Multani. Since: 2.48
	GUnicodeScriptMultaniValue UnicodeScript = 129
	// Old Hungarian. Since: 2.48
	GUnicodeScriptOldHungarianValue UnicodeScript = 130
	// Signwriting. Since: 2.48
	GUnicodeScriptSignwritingValue UnicodeScript = 131
	// Adlam. Since: 2.50
	GUnicodeScriptAdlamValue UnicodeScript = 132
	// Bhaiksuki. Since: 2.50
	GUnicodeScriptBhaiksukiValue UnicodeScript = 133
	// Marchen. Since: 2.50
	GUnicodeScriptMarchenValue UnicodeScript = 134
	// Newa. Since: 2.50
	GUnicodeScriptNewaValue UnicodeScript = 135
	// Osage. Since: 2.50
	GUnicodeScriptOsageValue UnicodeScript = 136
	// Tangut. Since: 2.50
	GUnicodeScriptTangutValue UnicodeScript = 137
	// Masaram Gondi. Since: 2.54
	GUnicodeScriptMasaramGondiValue UnicodeScript = 138
	// Nushu. Since: 2.54
	GUnicodeScriptNushuValue UnicodeScript = 139
	// Soyombo. Since: 2.54
	GUnicodeScriptSoyomboValue UnicodeScript = 140
	// Zanabazar Square. Since: 2.54
	GUnicodeScriptZanabazarSquareValue UnicodeScript = 141
	// Dogra. Since: 2.58
	GUnicodeScriptDograValue UnicodeScript = 142
	// Gunjala Gondi. Since: 2.58
	GUnicodeScriptGunjalaGondiValue UnicodeScript = 143
	// Hanifi Rohingya. Since: 2.58
	GUnicodeScriptHanifiRohingyaValue UnicodeScript = 144
	// Makasar. Since: 2.58
	GUnicodeScriptMakasarValue UnicodeScript = 145
	// Medefaidrin. Since: 2.58
	GUnicodeScriptMedefaidrinValue UnicodeScript = 146
	// Old Sogdian. Since: 2.58
	GUnicodeScriptOldSogdianValue UnicodeScript = 147
	// Sogdian. Since: 2.58
	GUnicodeScriptSogdianValue UnicodeScript = 148
	// Elym. Since: 2.62
	GUnicodeScriptElymaicValue UnicodeScript = 149
	// Nand. Since: 2.62
	GUnicodeScriptNandinagariValue UnicodeScript = 150
	// Rohg. Since: 2.62
	GUnicodeScriptNyiakengPuachueHmongValue UnicodeScript = 151
	// Wcho. Since: 2.62
	GUnicodeScriptWanchoValue UnicodeScript = 152
	// Chorasmian. Since: 2.66
	GUnicodeScriptChorasmianValue UnicodeScript = 153
	// Dives Akuru. Since: 2.66
	GUnicodeScriptDivesAkuruValue UnicodeScript = 154
	// Khitan small script. Since: 2.66
	GUnicodeScriptKhitanSmallScriptValue UnicodeScript = 155
	// Yezidi. Since: 2.66
	GUnicodeScriptYezidiValue UnicodeScript = 156
	// Cypro-Minoan. Since: 2.72
	GUnicodeScriptCyproMinoanValue UnicodeScript = 157
	// Old Uyghur. Since: 2.72
	GUnicodeScriptOldUyghurValue UnicodeScript = 158
	// Tangsa. Since: 2.72
	GUnicodeScriptTangsaValue UnicodeScript = 159
	// Toto. Since: 2.72
	GUnicodeScriptTotoValue UnicodeScript = 160
	// Vithkuqi. Since: 2.72
	GUnicodeScriptVithkuqiValue UnicodeScript = 161
	// Mathematical notation. Since: 2.72
	GUnicodeScriptMathValue UnicodeScript = 162
	// Kawi. Since 2.74
	GUnicodeScriptKawiValue UnicodeScript = 163
	// Nag Mundari. Since 2.74
	GUnicodeScriptNagMundariValue UnicodeScript = 164
	// Todhri. Since: 2.84
	GUnicodeScriptTodhriValue UnicodeScript = 165
	// Garay. Since: 2.84
	GUnicodeScriptGarayValue UnicodeScript = 166
	// Tulu-Tigalari. Since: 2.84
	GUnicodeScriptTuluTigalariValue UnicodeScript = 167
	// Sunuwar. Since: 2.84
	GUnicodeScriptSunuwarValue UnicodeScript = 168
	// Gurung Khema. Since: 2.84
	GUnicodeScriptGurungKhemaValue UnicodeScript = 169
	// Kirat Rai. Since: 2.84
	GUnicodeScriptKiratRaiValue UnicodeScript = 170
	// Ol Onal. Since: 2.84
	GUnicodeScriptOlOnalValue UnicodeScript = 171
	// Sidetic. Since: 2.88
	GUnicodeScriptSideticValue UnicodeScript = 172
	// Tolong Siki. Since: 2.88
	GUnicodeScriptTolongSikiValue UnicodeScript = 173
	// Tai Yo. Since: 2.88
	GUnicodeScriptTaiYoValue UnicodeScript = 174
	// Beria Erfe. Since: 2.88
	GUnicodeScriptBeriaErfeValue UnicodeScript = 175
)

func UnicharGetScript 

func UnicharGetScript(ChVar uint32) UnicodeScript

Looks up the #GUnicodeScript for a particular character (as defined by Unicode Standard Annex \#24). No check is made for @ch being a valid Unicode character; if you pass in invalid character, the result is undefined.

This function is equivalent to pango_script_for_unichar() and the two are interchangeable.

func UnicodeScriptFromIso15924 

func UnicodeScriptFromIso15924(Iso15924Var uint32) UnicodeScript

Looks up the Unicode script for @iso15924. ISO 15924 assigns four-letter codes to scripts. For example, the code for Arabic is 'Arab'. This function accepts four letter codes encoded as a @guint32 in a big-endian fashion. That is, the code expected for Arabic is 0x41726162 (0x41 is ASCII code for 'A', 0x72 is ASCII code for 'r', etc).

See [Codes for the representation of names of scripts](http://unicode.org/iso15924/codelists.html) for details.

type UnicodeType 

type UnicodeType int

These are the possible character classifications from the Unicode specification. See [Unicode Character Database](http://www.unicode.org/reports/tr44/#General_Category_Values). 

const (

	// General category "Other, Control" (Cc)
	GUnicodeControlValue UnicodeType = 0
	// General category "Other, Format" (Cf)
	GUnicodeFormatValue UnicodeType = 1
	// General category "Other, Not Assigned" (Cn)
	GUnicodeUnassignedValue UnicodeType = 2
	// General category "Other, Private Use" (Co)
	GUnicodePrivateUseValue UnicodeType = 3
	// General category "Other, Surrogate" (Cs)
	GUnicodeSurrogateValue UnicodeType = 4
	// General category "Letter, Lowercase" (Ll)
	GUnicodeLowercaseLetterValue UnicodeType = 5
	// General category "Letter, Modifier" (Lm)
	GUnicodeModifierLetterValue UnicodeType = 6
	// General category "Letter, Other" (Lo)
	GUnicodeOtherLetterValue UnicodeType = 7
	// General category "Letter, Titlecase" (Lt)
	GUnicodeTitlecaseLetterValue UnicodeType = 8
	// General category "Letter, Uppercase" (Lu)
	GUnicodeUppercaseLetterValue UnicodeType = 9
	// General category "Mark, Spacing" (Mc)
	GUnicodeSpacingMarkValue UnicodeType = 10
	// General category "Mark, Enclosing" (Me)
	GUnicodeEnclosingMarkValue UnicodeType = 11
	// General category "Mark, Nonspacing" (Mn)
	GUnicodeNonSpacingMarkValue UnicodeType = 12
	// General category "Number, Decimal Digit" (Nd)
	GUnicodeDecimalNumberValue UnicodeType = 13
	// General category "Number, Letter" (Nl)
	GUnicodeLetterNumberValue UnicodeType = 14
	// General category "Number, Other" (No)
	GUnicodeOtherNumberValue UnicodeType = 15
	// General category "Punctuation, Connector" (Pc)
	GUnicodeConnectPunctuationValue UnicodeType = 16
	// General category "Punctuation, Dash" (Pd)
	GUnicodeDashPunctuationValue UnicodeType = 17
	// General category "Punctuation, Close" (Pe)
	GUnicodeClosePunctuationValue UnicodeType = 18
	// General category "Punctuation, Final quote" (Pf)
	GUnicodeFinalPunctuationValue UnicodeType = 19
	// General category "Punctuation, Initial quote" (Pi)
	GUnicodeInitialPunctuationValue UnicodeType = 20
	// General category "Punctuation, Other" (Po)
	GUnicodeOtherPunctuationValue UnicodeType = 21
	// General category "Punctuation, Open" (Ps)
	GUnicodeOpenPunctuationValue UnicodeType = 22
	// General category "Symbol, Currency" (Sc)
	GUnicodeCurrencySymbolValue UnicodeType = 23
	// General category "Symbol, Modifier" (Sk)
	GUnicodeModifierSymbolValue UnicodeType = 24
	// General category "Symbol, Math" (Sm)
	GUnicodeMathSymbolValue UnicodeType = 25
	// General category "Symbol, Other" (So)
	GUnicodeOtherSymbolValue UnicodeType = 26
	// General category "Separator, Line" (Zl)
	GUnicodeLineSeparatorValue UnicodeType = 27
	// General category "Separator, Paragraph" (Zp)
	GUnicodeParagraphSeparatorValue UnicodeType = 28
	// General category "Separator, Space" (Zs)
	GUnicodeSpaceSeparatorValue UnicodeType = 29
)

func UnicharType 

func UnicharType(CVar uint32) UnicodeType

Classifies a Unicode character by type.

type Uri 

type Uri struct {
	// contains filtered or unexported fields
}

The `GUri` type and related functions can be used to parse URIs into their components, and build valid URIs from individual components.

Since `GUri` only represents absolute URIs, all `GUri`s will have a URI scheme, so [method@GLib.Uri.get_scheme] will always return a non-`NULL` answer. Likewise, by definition, all URIs have a path component, so [method@GLib.Uri.get_path] will always return a non-`NULL` string (which may be empty).

If the URI string has an [‘authority’ component](https://tools.ietf.org/html/rfc3986#section-3) (that is, if the scheme is followed by `://` rather than just `:`), then the `GUri` will contain a hostname, and possibly a port and ‘userinfo’. Additionally, depending on how the `GUri` was constructed/parsed (for example, using the `G_URI_FLAGS_HAS_PASSWORD` and `G_URI_FLAGS_HAS_AUTH_PARAMS` flags), the userinfo may be split out into a username, password, and additional authorization-related parameters.

Normally, the components of a `GUri` will have all `%`-encoded characters decoded. However, if you construct/parse a `GUri` with `G_URI_FLAGS_ENCODED`, then the `%`-encoding will be preserved instead in the userinfo, path, and query fields (and in the host field if also created with `G_URI_FLAGS_NON_DNS`). In particular, this is necessary if the URI may contain binary data or non-UTF-8 text, or if decoding the components might change the interpretation of the URI.

For example, with the encoded flag:

```c g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_ENCODED, &amp;err); g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue"); ```

While the default `%`-decoding behaviour would give:

```c g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fparam%3Dvalue", G_URI_FLAGS_NONE, &amp;err); g_assert_cmpstr (g_uri_get_query (uri), ==, "query=http://host/path?param=value"); ```

During decoding, if an invalid UTF-8 string is encountered, parsing will fail with an error indicating the bad string location:

```c g_autoptr(GUri) uri = g_uri_parse ("http://host/path?query=http%3A%2F%2Fhost%2Fpath%3Fbad%3D%00alue", G_URI_FLAGS_NONE, &amp;err); g_assert_error (err, G_URI_ERROR, G_URI_ERROR_BAD_QUERY); ```

You should pass `G_URI_FLAGS_ENCODED` or `G_URI_FLAGS_ENCODED_QUERY` if you need to handle that case manually. In particular, if the query string contains `=` characters that are `%`-encoded, you should let [func@GLib.Uri.parse_params] do the decoding once of the query.

`GUri` is immutable once constructed, and can safely be accessed from multiple threads. Its reference counting is atomic.

Note that the scope of `GUri` is to help manipulate URIs in various applications, following [RFC 3986](https://tools.ietf.org/html/rfc3986). In particular, it doesn't intend to cover web browser needs, and doesn’t implement the [WHATWG URL](https://url.spec.whatwg.org/) standard. No APIs are provided to help prevent [homograph attacks](https://en.wikipedia.org/wiki/IDN_homograph_attack), so `GUri` is not suitable for formatting URIs for display to the user for making security-sensitive decisions.

## Relative and absolute URIs

As defined in [RFC 3986](https://tools.ietf.org/html/rfc3986#section-4), the hierarchical nature of URIs means that they can either be ‘relative references’ (sometimes referred to as ‘relative URIs’) or ‘URIs’ (for clarity, ‘URIs’ are referred to in this documentation as ‘absolute URIs’ — although [in contrast to RFC 3986](https://tools.ietf.org/html/rfc3986#section-4.3), fragment identifiers are always allowed).

Relative references have one or more components of the URI missing. In particular, they have no scheme. Any other component, such as hostname, query, etc. may be missing, apart from a path, which has to be specified (but may be empty). The path may be relative, starting with `./` rather than `/`.

For example, a valid relative reference is `./path?query`, `/?query#fragment` or `//example.com`.

Absolute URIs have a scheme specified. Any other components of the URI which are missing are specified as explicitly unset in the URI, rather than being resolved relative to a base URI using [method@GLib.Uri.parse_relative].

For example, a valid absolute URI is `file:///home/bob` or `https://search.com?query=string`.

A `GUri` instance is always an absolute URI. A string may be an absolute URI or a relative reference; see the documentation for individual functions as to what forms they accept.

## Parsing URIs

The most minimalist APIs for parsing URIs are [func@GLib.Uri.split] and [func@GLib.Uri.split_with_user]. These split a URI into its component parts, and return the parts; the difference between the two is that [func@GLib.Uri.split] treats the ‘userinfo’ component of the URI as a single element, while [func@GLib.Uri.split_with_user] can (depending on the [flags@GLib.UriFlags] you pass) treat it as containing a username, password, and authentication parameters. Alternatively, [func@GLib.Uri.split_network] can be used when you are only interested in the components that are needed to initiate a network connection to the service (scheme, host, and port).

[func@GLib.Uri.parse] is similar to [func@GLib.Uri.split], but instead of returning individual strings, it returns a `GUri` structure (and it requires that the URI be an absolute URI).

[func@GLib.Uri.resolve_relative] and [method@GLib.Uri.parse_relative] allow you to resolve a relative URI relative to a base URI. [func@GLib.Uri.resolve_relative] takes two strings and returns a string, and [method@GLib.Uri.parse_relative] takes a `GUri` and a string and returns a `GUri`.

All of the parsing functions take a [flags@GLib.UriFlags] argument describing exactly how to parse the URI; see the documentation for that type for more details on the specific flags that you can pass. If you need to choose different flags based on the type of URI, you can use [func@GLib.Uri.peek_scheme] on the URI string to check the scheme first, and use that to decide what flags to parse it with.

For example, you might want to use `G_URI_PARAMS_WWW_FORM` when parsing the params for a web URI, so compare the result of [func@GLib.Uri.peek_scheme] against `http` and `https`.

## Building URIs

[func@GLib.Uri.join] and [func@GLib.Uri.join_with_user] can be used to construct valid URI strings from a set of component strings. They are the inverse of [func@GLib.Uri.split] and [func@GLib.Uri.split_with_user].

Similarly, [func@GLib.Uri.build] and [func@GLib.Uri.build_with_user] can be used to construct a `GUri` from a set of component strings.

As with the parsing functions, the building functions take a [flags@GLib.UriFlags] argument. In particular, it is important to keep in mind whether the URI components you are using are already `%`-encoded. If so, you must pass the `G_URI_FLAGS_ENCODED` flag.

## `file://` URIs

Note that Windows and Unix both define special rules for parsing `file://` URIs (involving non-UTF-8 character sets on Unix, and the interpretation of path separators on Windows). `GUri` does not implement these rules. Use [func@GLib.filename_from_uri] and [func@GLib.filename_to_uri] if you want to properly convert between `file://` URIs and local filenames.

## URI Equality

Note that there is no `g_uri_equal ()` function, because comparing URIs usefully requires scheme-specific knowledge that `GUri` does not have. `GUri` can help with normalization if you use the various encoded [flags@GLib.UriFlags] as well as `G_URI_FLAGS_SCHEME_NORMALIZE` however it is not comprehensive. For example, `data:,foo` and `data:;base64,Zm9v` resolve to the same thing according to the `data:` URI specification which GLib does not handle.

func UriBuild 

func UriBuild(FlagsVar UriFlags, SchemeVar string, UserinfoVar *string, HostVar *string, PortVar int, PathVar string, QueryVar *string, FragmentVar *string) *Uri

Creates a new #GUri from the given components according to @flags.

See also g_uri_build_with_user(), which allows specifying the components of the "userinfo" separately.

func UriBuildWithUser 

func UriBuildWithUser(FlagsVar UriFlags, SchemeVar string, UserVar *string, PasswordVar *string, AuthParamsVar *string, HostVar *string, PortVar int, PathVar string, QueryVar *string, FragmentVar *string) *Uri

Creates a new #GUri from the given components according to @flags (%G_URI_FLAGS_HAS_PASSWORD is added unconditionally). The @flags must be coherent with the passed values, in particular use `%`-encoded values with %G_URI_FLAGS_ENCODED.

In contrast to g_uri_build(), this allows specifying the components of the ‘userinfo’ field separately. Note that @user must be non-%NULL if either @password or @auth_params is non-%NULL.

func UriParse 

func UriParse(UriStringVar string, FlagsVar UriFlags) (*Uri, error)

Parses @uri_string according to @flags. If the result is not a valid [absolute URI](#relative-and-absolute-uris), it will be discarded, and an error returned.

func (*Uri) GetAuthParams 

func (x *Uri) GetAuthParams() string

Gets @uri's authentication parameters, which may contain `%`-encoding, depending on the flags with which @uri was created. (If @uri was not created with %G_URI_FLAGS_HAS_AUTH_PARAMS then this will be %NULL.)

Depending on the URI scheme, g_uri_parse_params() may be useful for further parsing this information.

func (*Uri) GetFlags 

func (x *Uri) GetFlags() UriFlags

Gets @uri's flags set upon construction.

func (*Uri) GetFragment 

func (x *Uri) GetFragment() string

Gets @uri's fragment, which may contain `%`-encoding, depending on the flags with which @uri was created.

func (*Uri) GetHost 

func (x *Uri) GetHost() string

Gets @uri's host. This will never have `%`-encoded characters, unless it is non-UTF-8 (which can only be the case if @uri was created with %G_URI_FLAGS_NON_DNS).

If @uri contained an IPv6 address literal, this value will be just that address, without the brackets around it that are necessary in the string form of the URI. Note that in this case there may also be a scope ID attached to the address. Eg, `fe80::1234%“em1` (or `fe80::1234%“25em1` if the string is still encoded).

func (*Uri) GetPassword 

func (x *Uri) GetPassword() string

Gets @uri's password, which may contain `%`-encoding, depending on the flags with which @uri was created. (If @uri was not created with %G_URI_FLAGS_HAS_PASSWORD then this will be %NULL.)

func (*Uri) GetPath 

func (x *Uri) GetPath() string

Gets @uri's path, which may contain `%`-encoding, depending on the flags with which @uri was created.

func (*Uri) GetPort 

func (x *Uri) GetPort() int

Gets @uri's port.

func (*Uri) GetQuery 

func (x *Uri) GetQuery() string

Gets @uri's query, which may contain `%`-encoding, depending on the flags with which @uri was created.

For queries consisting of a series of `name=value` parameters, #GUriParamsIter or g_uri_parse_params() may be useful.

func (*Uri) GetScheme 

func (x *Uri) GetScheme() string

Gets @uri's scheme. Note that this will always be all-lowercase, regardless of the string or strings that @uri was created from.

func (*Uri) GetUser 

func (x *Uri) GetUser() string

Gets the ‘username’ component of @uri's userinfo, which may contain `%`-encoding, depending on the flags with which @uri was created. If @uri was not created with %G_URI_FLAGS_HAS_PASSWORD or %G_URI_FLAGS_HAS_AUTH_PARAMS, this is the same as g_uri_get_userinfo().

func (*Uri) GetUserinfo 

func (x *Uri) GetUserinfo() string

Gets @uri's userinfo, which may contain `%`-encoding, depending on the flags with which @uri was created.

func (*Uri) GoPointer 

func (x *Uri) GoPointer() uintptr

func (*Uri) ParseRelative 

func (x *Uri) ParseRelative(UriRefVar string, FlagsVar UriFlags) (*Uri, error)

Parses @uri_ref according to @flags and, if it is a [relative URI](#relative-and-absolute-uris), resolves it relative to @base_uri. If the result is not a valid absolute URI, it will be discarded, and an error returned.

func (*Uri) Ref 

func (x *Uri) Ref() *Uri

Increments the reference count of @uri by one.

func (*Uri) ToString 

func (x *Uri) ToString() string

Returns a string representing @uri.

This is not guaranteed to return a string which is identical to the string that @uri was parsed from. However, if the source URI was syntactically correct (according to RFC 3986), and it was parsed with %G_URI_FLAGS_ENCODED, then g_uri_to_string() is guaranteed to return a string which is at least semantically equivalent to the source URI (according to RFC 3986).

If @uri might contain sensitive details, such as authentication parameters, or private data in its query string, and the returned string is going to be logged, then consider using g_uri_to_string_partial() to redact parts.

func (*Uri) ToStringPartial 

func (x *Uri) ToStringPartial(FlagsVar UriHideFlags) string

Returns a string representing @uri, subject to the options in @flags. See g_uri_to_string() and #GUriHideFlags for more details.

func (*Uri) Unref 

func (x *Uri) Unref()

Atomically decrements the reference count of @uri by one.

When the reference count reaches zero, the resources allocated by @uri are freed

type UriError 

type UriError int

Error codes returned by #GUri methods. 

const (

	// Generic error if no more specific error is available.
	//     See the error message for details.
	GUriErrorFailedValue UriError = 0
	// The scheme of a URI could not be parsed.
	GUriErrorBadSchemeValue UriError = 1
	// The user/userinfo of a URI could not be parsed.
	GUriErrorBadUserValue UriError = 2
	// The password of a URI could not be parsed.
	GUriErrorBadPasswordValue UriError = 3
	// The authentication parameters of a URI could not be parsed.
	GUriErrorBadAuthParamsValue UriError = 4
	// The host of a URI could not be parsed.
	GUriErrorBadHostValue UriError = 5
	// The port of a URI could not be parsed.
	GUriErrorBadPortValue UriError = 6
	// The path of a URI could not be parsed.
	GUriErrorBadPathValue UriError = 7
	// The query of a URI could not be parsed.
	GUriErrorBadQueryValue UriError = 8
	// The fragment of a URI could not be parsed.
	GUriErrorBadFragmentValue UriError = 9
)

type UriFlags 

type UriFlags int

Flags that describe a URI.

When parsing a URI, if you need to choose different flags based on the type of URI, you can use g_uri_peek_scheme() on the URI string to check the scheme first, and use that to decide what flags to parse it with. 

const (

	// No flags set.
	GUriFlagsNoneValue UriFlags = 0
	// Parse the URI more relaxedly than the
	//     [RFC 3986](https://tools.ietf.org/html/rfc3986) grammar specifies,
	//     fixing up or ignoring common mistakes in URIs coming from external
	//     sources. This is also needed for some obscure URI schemes where `;`
	//     separates the host from the path. Don’t use this flag unless you need to.
	GUriFlagsParseRelaxedValue UriFlags = 1
	// The userinfo field may contain a password,
	//     which will be separated from the username by `:`.
	GUriFlagsHasPasswordValue UriFlags = 2
	// The userinfo may contain additional
	//     authentication-related parameters, which will be separated from
	//     the username and/or password by `;`.
	GUriFlagsHasAuthParamsValue UriFlags = 4
	// When parsing a URI, this indicates that `%`-encoded
	//     characters in the userinfo, path, query, and fragment fields
	//     should not be decoded. (And likewise the host field if
	//     %G_URI_FLAGS_NON_DNS is also set.) When building a URI, it indicates
	//     that you have already `%`-encoded the components, and so #GUri
	//     should not do any encoding itself.
	GUriFlagsEncodedValue UriFlags = 8
	// The host component should not be assumed to be a
	//     DNS hostname or IP address (for example, for `smb` URIs with NetBIOS
	//     hostnames).
	GUriFlagsNonDnsValue UriFlags = 16
	// Same as %G_URI_FLAGS_ENCODED, for the query
	//     field only.
	GUriFlagsEncodedQueryValue UriFlags = 32
	// Same as %G_URI_FLAGS_ENCODED, for the path only.
	GUriFlagsEncodedPathValue UriFlags = 64
	// Same as %G_URI_FLAGS_ENCODED, for the
	//     fragment only.
	GUriFlagsEncodedFragmentValue UriFlags = 128
	// A scheme-based normalization will be applied.
	//     For example, when parsing an HTTP URI changing omitted path to `/` and
	//     omitted port to `80`; and when building a URI, changing empty path to `/`
	//     and default port `80`). This only supports a subset of known schemes. (Since: 2.68)
	GUriFlagsSchemeNormalizeValue UriFlags = 256
)

type UriHideFlags 

type UriHideFlags int

Flags describing what parts of the URI to hide in g_uri_to_string_partial(). Note that %G_URI_HIDE_PASSWORD and %G_URI_HIDE_AUTH_PARAMS will only work if the #GUri was parsed with the corresponding flags. 

const (

	// No flags set.
	GUriHideNoneValue UriHideFlags = 0
	// Hide the userinfo.
	GUriHideUserinfoValue UriHideFlags = 1
	// Hide the password.
	GUriHidePasswordValue UriHideFlags = 2
	// Hide the auth_params.
	GUriHideAuthParamsValue UriHideFlags = 4
	// Hide the query.
	GUriHideQueryValue UriHideFlags = 8
	// Hide the fragment.
	GUriHideFragmentValue UriHideFlags = 16
)

type UriParamsFlags 

type UriParamsFlags int

Flags modifying the way parameters are handled by g_uri_parse_params() and #GUriParamsIter. 

const (

	// No flags set.
	GUriParamsNoneValue UriParamsFlags = 0
	// Parameter names are case insensitive.
	GUriParamsCaseInsensitiveValue UriParamsFlags = 1
	// Replace `+` with space character. Only useful for
	//     URLs on the web, using the `https` or `http` schemas.
	GUriParamsWwwFormValue UriParamsFlags = 2
	// See %G_URI_FLAGS_PARSE_RELAXED.
	GUriParamsParseRelaxedValue UriParamsFlags = 4
)

type UriParamsIter 

type UriParamsIter struct {
	Dummy0 int32

	Dummy1 uintptr

	Dummy2 uintptr

	Dummy3 [256]byte
	// contains filtered or unexported fields
}

Many URI schemes include one or more attribute/value pairs as part of the URI value. For example `scheme://server/path?query=string&amp;is=there` has two attributes – `query=string` and `is=there` – in its query part.

A #GUriParamsIter structure represents an iterator that can be used to iterate over the attribute/value pairs of a URI query string. #GUriParamsIter structures are typically allocated on the stack and then initialized with g_uri_params_iter_init(). See the documentation for g_uri_params_iter_init() for a usage example.

func (*UriParamsIter) GoPointer 

func (x *UriParamsIter) GoPointer() uintptr

func (*UriParamsIter) Init 

func (x *UriParamsIter) Init(ParamsVar string, LengthVar int, SeparatorsVar string, FlagsVar UriParamsFlags)

Initializes an attribute/value pair iterator.

The iterator keeps pointers to the @params and @separators arguments, those variables must thus outlive the iterator and not be modified during the iteration.

If %G_URI_PARAMS_WWW_FORM is passed in @flags, `+` characters in the param string will be replaced with spaces in the output. For example, `foo=bar+baz` will give attribute `foo` with value `bar baz`. This is commonly used on the web (the `https` and `http` schemes only), but is deprecated in favour of the equivalent of encoding spaces as `%20`.

Unlike with g_uri_parse_params(), %G_URI_PARAMS_CASE_INSENSITIVE has no effect if passed to @flags for g_uri_params_iter_init(). The caller is responsible for doing their own case-insensitive comparisons.

|[&lt;!-- language="C" --&gt; GUriParamsIter iter; GError *error = NULL; gchar *unowned_attr, *unowned_value;

g_uri_params_iter_init (&amp;iter, "foo=bar&amp;baz=bar&amp;Foo=frob&amp;baz=bar2", -1, "&amp;", G_URI_PARAMS_NONE); while (g_uri_params_iter_next (&amp;iter, &amp;unowned_attr, &amp;unowned_value, &amp;error)) 

{
  g_autofree gchar *attr = g_steal_pointer (&amp;unowned_attr);
  g_autofree gchar *value = g_steal_pointer (&amp;unowned_value);
  // do something with attr and value; this code will be called 4 times
  // for the params string in this example: once with attr=foo and value=bar,
  // then with baz/bar, then Foo/frob, then baz/bar2.
}

if (error) 

// handle parsing error

]|

func (*UriParamsIter) Next 

func (x *UriParamsIter) Next(AttributeVar *string, ValueVar *string) (bool, error)

Advances @iter and retrieves the next attribute/value. %FALSE is returned if an error has occurred (in which case @error is set), or if the end of the iteration is reached (in which case @attribute and @value are set to %NULL and the iterator becomes invalid). If %TRUE is returned, g_uri_params_iter_next() may be called again to receive another attribute/value pair.

Note that the same @attribute may be returned multiple times, since URIs allow repeated attributes.

type UserDirectory 

type UserDirectory int

These are logical ids for special directories which are defined depending on the platform used. You should use g_get_user_special_dir() to retrieve the full path associated to the logical id.

The #GUserDirectory enumeration can be extended at later date. Not every platform has a directory for every logical id in this enumeration. 

const (

	// the user's Desktop directory
	GUserDirectoryDesktopValue UserDirectory = 0
	// the user's Documents directory
	GUserDirectoryDocumentsValue UserDirectory = 1
	// the user's Downloads directory
	GUserDirectoryDownloadValue UserDirectory = 2
	// the user's Music directory
	GUserDirectoryMusicValue UserDirectory = 3
	// the user's Pictures directory
	GUserDirectoryPicturesValue UserDirectory = 4
	// the user's shared directory
	GUserDirectoryPublicShareValue UserDirectory = 5
	// the user's Templates directory
	GUserDirectoryTemplatesValue UserDirectory = 6
	// the user's Movies directory
	GUserDirectoryVideosValue UserDirectory = 7
	// the number of enum values
	GUserNDirectoriesValue UserDirectory = 8
)

type Variant 

type Variant struct {
	// contains filtered or unexported fields
}

`GVariant` is a variant datatype; it can contain one or more values along with information about the type of the values.

A `GVariant` may contain simple types, like an integer, or a boolean value; or complex types, like an array of two strings, or a dictionary of key value pairs. A `GVariant` is also immutable: once it’s been created neither its type nor its content can be modified further.

`GVariant` is useful whenever data needs to be serialized, for example when sending method parameters in D-Bus, or when saving settings using [`GSettings`](../gio/class.Settings.html).

When creating a new `GVariant`, you pass the data you want to store in it along with a string representing the type of data you wish to pass to it.

For instance, if you want to create a `GVariant` holding an integer value you can use:

```c GVariant *v = g_variant_new ("u", 40); ```

The string `u` in the first argument tells `GVariant` that the data passed to the constructor (`40`) is going to be an unsigned integer.

More advanced examples of `GVariant` in use can be found in documentation for [`GVariant` format strings](gvariant-format-strings.html#pointers).

The range of possible values is determined by the type.

The type system used by `GVariant` is [type@GLib.VariantType].

`GVariant` instances always have a type and a value (which are given at construction time). The type and value of a `GVariant` instance can never change other than by the `GVariant` itself being destroyed. A `GVariant` cannot contain a pointer.

`GVariant` is reference counted using [method@GLib.Variant.ref] and [method@GLib.Variant.unref]. `GVariant` also has floating reference counts — see [method@GLib.Variant.ref_sink].

`GVariant` is completely threadsafe. A `GVariant` instance can be concurrently accessed in any way from any number of threads without problems.

`GVariant` is heavily optimised for dealing with data in serialized form. It works particularly well with data located in memory-mapped files. It can perform nearly all deserialization operations in a small constant time, usually touching only a single memory page. Serialized `GVariant` data can also be sent over the network.

`GVariant` is largely compatible with D-Bus. Almost all types of `GVariant` instances can be sent over D-Bus. See [type@GLib.VariantType] for exceptions. (However, `GVariant`’s serialization format is not the same as the serialization format of a D-Bus message body: use [GDBusMessage](../gio/class.DBusMessage.html), in the GIO library, for those.)

For space-efficiency, the `GVariant` serialization format does not automatically include the variant’s length, type or endianness, which must either be implied from context (such as knowledge that a particular file format always contains a little-endian `G_VARIANT_TYPE_VARIANT` which occupies the whole length of the file) or supplied out-of-band (for instance, a length, type and/or endianness indicator could be placed at the beginning of a file, network message or network stream).

A `GVariant`’s size is limited mainly by any lower level operating system constraints, such as the number of bits in `gsize`. For example, it is reasonable to have a 2GB file mapped into memory with [struct@GLib.MappedFile], and call [ctor@GLib.Variant.new_from_data] on it.

For convenience to C programmers, `GVariant` features powerful varargs-based value construction and destruction. This feature is designed to be embedded in other libraries.

There is a Python-inspired text language for describing `GVariant` values. `GVariant` includes a printer for this language and a parser with type inferencing.

## Memory Use

`GVariant` tries to be quite efficient with respect to memory use. This section gives a rough idea of how much memory is used by the current implementation. The information here is subject to change in the future.

The memory allocated by `GVariant` can be grouped into 4 broad purposes: memory for serialized data, memory for the type information cache, buffer management memory and memory for the `GVariant` structure itself.

## Serialized Data Memory

This is the memory that is used for storing `GVariant` data in serialized form. This is what would be sent over the network or what would end up on disk, not counting any indicator of the endianness, or of the length or type of the top-level variant.

The amount of memory required to store a boolean is 1 byte. 16, 32 and 64 bit integers and double precision floating point numbers use their ‘natural’ size. Strings (including object path and signature strings) are stored with a nul terminator, and as such use the length of the string plus 1 byte.

‘Maybe’ types use no space at all to represent the null value and use the same amount of space (sometimes plus one byte) as the equivalent non-maybe-typed value to represent the non-null case.

Arrays use the amount of space required to store each of their members, concatenated. Additionally, if the items stored in an array are not of a fixed-size (ie: strings, other arrays, etc) then an additional framing offset is stored for each item. The size of this offset is either 1, 2 or 4 bytes depending on the overall size of the container. Additionally, extra padding bytes are added as required for alignment of child values.

Tuples (including dictionary entries) use the amount of space required to store each of their members, concatenated, plus one framing offset (as per arrays) for each non-fixed-sized item in the tuple, except for the last one. Additionally, extra padding bytes are added as required for alignment of child values.

Variants use the same amount of space as the item inside of the variant, plus 1 byte, plus the length of the type string for the item inside the variant.

As an example, consider a dictionary mapping strings to variants. In the case that the dictionary is empty, 0 bytes are required for the serialization.

If we add an item ‘width’ that maps to the int32 value of 500 then we will use 4 bytes to store the int32 (so 6 for the variant containing it) and 6 bytes for the string. The variant must be aligned to 8 after the 6 bytes of the string, so that’s 2 extra bytes. 6 (string) + 2 (padding) + 6 (variant) is 14 bytes used for the dictionary entry. An additional 1 byte is added to the array as a framing offset making a total of 15 bytes.

If we add another entry, ‘title’ that maps to a nullable string that happens to have a value of null, then we use 0 bytes for the null value (and 3 bytes for the variant to contain it along with its type string) plus 6 bytes for the string. Again, we need 2 padding bytes. That makes a total of 6 + 2 + 3 = 11 bytes.

We now require extra padding between the two items in the array. After the 14 bytes of the first item, that’s 2 bytes required. We now require 2 framing offsets for an extra two bytes. 14 + 2 + 11 + 2 = 29 bytes to encode the entire two-item dictionary.

## Type Information Cache

For each `GVariant` type that currently exists in the program a type information structure is kept in the type information cache. The type information structure is required for rapid deserialization.

Continuing with the above example, if a `GVariant` exists with the type `a{sv}` then a type information struct will exist for `a{sv}`, `{sv}`, `s`, and `v`. Multiple uses of the same type will share the same type information. Additionally, all single-digit types are stored in read-only static memory and do not contribute to the writable memory footprint of a program using `GVariant`.

Aside from the type information structures stored in read-only memory, there are two forms of type information. One is used for container types where there is a single element type: arrays and maybe types. The other is used for container types where there are multiple element types: tuples and dictionary entries.

Array type info structures are `6 * sizeof (void *)`, plus the memory required to store the type string itself. This means that on 32-bit systems, the cache entry for `a{sv}` would require 30 bytes of memory (plus allocation overhead).

Tuple type info structures are `6 * sizeof (void *)`, plus `4 * sizeof (void *)` for each item in the tuple, plus the memory required to store the type string itself. A 2-item tuple, for example, would have a type information structure that consumed writable memory in the size of `14 * sizeof (void *)` (plus type string) This means that on 32-bit systems, the cache entry for `{sv}` would require 61 bytes of memory (plus allocation overhead).

This means that in total, for our `a{sv}` example, 91 bytes of type information would be allocated.

The type information cache, additionally, uses a [struct@GLib.HashTable] to store and look up the cached items and stores a pointer to this hash table in static storage. The hash table is freed when there are zero items in the type cache.

Although these sizes may seem large it is important to remember that a program will probably only have a very small number of different types of values in it and that only one type information structure is required for many different values of the same type.

## Buffer Management Memory

`GVariant` uses an internal buffer management structure to deal with the various different possible sources of serialized data that it uses. The buffer is responsible for ensuring that the correct call is made when the data is no longer in use by `GVariant`. This may involve a [func@GLib.free] or even [method@GLib.MappedFile.unref].

One buffer management structure is used for each chunk of serialized data. The size of the buffer management structure is `4 * (void *)`. On 32-bit systems, that’s 16 bytes.

## GVariant structure

The size of a `GVariant` structure is `6 * (void *)`. On 32-bit systems, that’s 24 bytes.

`GVariant` structures only exist if they are explicitly created with API calls. For example, if a `GVariant` is constructed out of serialized data for the example given above (with the dictionary) then although there are 9 individual values that comprise the entire dictionary (two keys, two values, two variants containing the values, two dictionary entries, plus the dictionary itself), only 1 `GVariant` instance exists — the one referring to the dictionary.

If calls are made to start accessing the other values then `GVariant` instances will exist for those values only for as long as they are in use (ie: until you call [method@GLib.Variant.unref]). The type information is shared. The serialized data and the buffer management structure for that serialized data is shared by the child.

## Summary

To put the entire example together, for our dictionary mapping strings to variants (with two entries, as given above), we are using 91 bytes of memory for type information, 29 bytes of memory for the serialized data, 16 bytes for buffer management and 24 bytes for the `GVariant` instance, or a total of 160 bytes, plus allocation overhead. If we were to use [method@GLib.Variant.get_child_value] to access the two dictionary entries, we would use an additional 48 bytes. If we were to have other dictionaries of the same type, we would use more memory for the serialized data and buffer management for those dictionaries, but the type information would be shared.

func NewVariant 

func NewVariant(FormatStringVar string, varArgs ...interface{}) *Variant

Creates a new #GVariant instance.

Think of this function as an analogue to g_strdup_printf().

The type of the created instance and the arguments that are expected by this function are determined by @format_string. See the section on [GVariant format strings](gvariant-format-strings.html). Please note that the syntax of the format string is very likely to be extended in the future.

The first character of the format string must not be '*' '?' '@' or 'r'; in essence, a new #GVariant must always be constructed by this function (and not merely passed through it unmodified).

Note that the arguments must be of the correct width for their types specified in @format_string. This can be achieved by casting them. See the [GVariant varargs documentation](gvariant-format-strings.html#varargs).

|[&lt;!-- language="C" --&gt; MyFlags some_flags = FLAG_ONE | FLAG_TWO; const gchar *some_strings[] = { "a", "b", "c", NULL }; GVariant *new_variant;

new_variant = g_variant_new ("(t^as)", 

// This cast is required.
(guint64) some_flags,
some_strings);

]|

func NewVariantArray 

func NewVariantArray(ChildTypeVar *VariantType, ChildrenVar uintptr, NChildrenVar uint) *Variant

Creates a new #GVariant array from @children.

@child_type must be non-%NULL if @n_children is zero. Otherwise, the child type is determined by inspecting the first element of the @children array. If @child_type is non-%NULL then it must be a definite type.

The items of the array are taken from the @children array. No entry in the @children array may be %NULL.

All items in the array must have the same type, which must be the same as @child_type, if given.

If the @children are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink().

func NewVariantBoolean 

func NewVariantBoolean(ValueVar bool) *Variant

Creates a new boolean #GVariant instance -- either %TRUE or %FALSE.

func NewVariantByte 

func NewVariantByte(ValueVar byte) *Variant

Creates a new byte #GVariant instance.

func NewVariantBytestring 

func NewVariantBytestring(StringVar []byte) *Variant

Creates an array-of-bytes #GVariant with the contents of @string. This function is just like g_variant_new_string() except that the string need not be valid UTF-8.

The nul terminator character at the end of the string is stored in the array.

func NewVariantBytestringArray 

func NewVariantBytestringArray(StrvVar []string, LengthVar int) *Variant

Constructs an array of bytestring #GVariant from the given array of strings.

If @length is -1 then @strv is %NULL-terminated.

func NewVariantDictEntry 

func NewVariantDictEntry(KeyVar *Variant, ValueVar *Variant) *Variant

Creates a new dictionary entry #GVariant. @key and @value must be non-%NULL. @key must be a value of a basic type (ie: not a container).

If the @key or @value are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink().

func NewVariantDouble 

func NewVariantDouble(ValueVar float64) *Variant

Creates a new double #GVariant instance.

func NewVariantFixedArray 

func NewVariantFixedArray(ElementTypeVar *VariantType, ElementsVar uintptr, NElementsVar uint, ElementSizeVar uint) *Variant

Constructs a new array #GVariant instance, where the elements are of @element_type type.

@elements must be an array with fixed-sized elements. Numeric types are fixed-size as are tuples containing only other fixed-sized types.

@element_size must be the size of a single element in the array. For example, if calling this function for an array of 32-bit integers, you might say sizeof(gint32). This value isn't used except for the purpose of a double-check that the form of the serialized data matches the caller's expectation.

@n_elements must be the length of the @elements array.

func NewVariantFromBytes 

func NewVariantFromBytes(TypeVar *VariantType, BytesVar *Bytes, TrustedVar bool) *Variant

Constructs a new serialized-mode #GVariant instance. This is the inner interface for creation of new serialized values that gets called from various functions in gvariant.c.

A reference is taken on @bytes.

The data in @bytes must be aligned appropriately for the @type being loaded. Otherwise this function will internally create a copy of the memory (since GLib 2.60) or (in older versions) fail and exit the process.

func NewVariantFromData 

func NewVariantFromData(TypeVar *VariantType, DataVar []byte, SizeVar uint, TrustedVar bool, NotifyVar *DestroyNotify, UserDataVar uintptr) *Variant

Creates a new #GVariant instance from serialized data.

@type is the type of #GVariant instance that will be constructed. The interpretation of @data depends on knowing the type.

@data is not modified by this function and must remain valid with an unchanging value until such a time as @notify is called with @user_data. If the contents of @data change before that time then the result is undefined.

If @data is trusted to be serialized data in normal form then @trusted should be %TRUE. This applies to serialized data created within this process or read from a trusted location on the disk (such as a file installed in /usr/lib alongside your application). You should set trusted to %FALSE if @data is read from the network, a file in the user's home directory, etc.

If @data was not stored in this machine's native endianness, any multi-byte numeric values in the returned variant will also be in non-native endianness. g_variant_byteswap() can be used to recover the original values.

@notify will be called with @user_data when @data is no longer needed. The exact time of this call is unspecified and might even be before this function returns.

Note: @data must be backed by memory that is aligned appropriately for the @type being loaded. Otherwise this function will internally create a copy of the memory (since GLib 2.60) or (in older versions) fail and exit the process.

func NewVariantHandle 

func NewVariantHandle(ValueVar int32) *Variant

Creates a new handle #GVariant instance.

By convention, handles are indexes into an array of file descriptors that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them.

func NewVariantInt16 

func NewVariantInt16(ValueVar int16) *Variant

Creates a new int16 #GVariant instance.

func NewVariantInt32 

func NewVariantInt32(ValueVar int32) *Variant

Creates a new int32 #GVariant instance.

func NewVariantInt64 

func NewVariantInt64(ValueVar int64) *Variant

Creates a new int64 #GVariant instance.

func NewVariantMaybe 

func NewVariantMaybe(ChildTypeVar *VariantType, ChildVar *Variant) *Variant

Depending on if @child is %NULL, either wraps @child inside of a maybe container or creates a Nothing instance for the given @type.

At least one of @child_type and @child must be non-%NULL. If @child_type is non-%NULL then it must be a definite type. If they are both non-%NULL then @child_type must be the type of @child.

If @child is a floating reference (see g_variant_ref_sink()), the new instance takes ownership of @child.

func NewVariantObjectPath 

func NewVariantObjectPath(ObjectPathVar string) *Variant

Creates a D-Bus object path #GVariant with the contents of @object_path. @object_path must be a valid D-Bus object path. Use g_variant_is_object_path() if you're not sure.

func NewVariantObjv 

func NewVariantObjv(StrvVar []string, LengthVar int) *Variant

Constructs an array of object paths #GVariant from the given array of strings.

Each string must be a valid #GVariant object path; see g_variant_is_object_path().

If @length is -1 then @strv is %NULL-terminated.

func NewVariantParsed 

func NewVariantParsed(FormatVar string, varArgs ...interface{}) *Variant

Parses @format and returns the result.

@format must be a text format #GVariant with one extension: at any point that a value may appear in the text, a '%' character followed by a GVariant format string (as per g_variant_new()) may appear. In that case, the same arguments are collected from the argument list as g_variant_new() would have collected.

Note that the arguments must be of the correct width for their types specified in @format. This can be achieved by casting them. See the [GVariant varargs documentation](gvariant-format-strings.html#varargs).

Consider this simple example: |[&lt;!-- language="C" --&gt; 

g_variant_new_parsed ("[('one', 1), ('two', %i), (%s, 3)]", 2, "three");

]|

In the example, the variable argument parameters are collected and filled in as if they were part of the original string to produce the result of |[&lt;!-- language="C" --&gt; [('one', 1), ('two', 2), ('three', 3)] ]|

This function is intended only to be used with @format as a string literal. Any parse error is fatal to the calling process. If you want to parse data from untrusted sources, use g_variant_parse().

You may not use this function to return, unmodified, a single #GVariant pointer from the argument list. ie: @format may not solely be anything along the lines of "%*", "%?", "\%r", or anything starting with "%@".

func NewVariantParsedVa 

func NewVariantParsedVa(FormatVar string, AppVar []interface{}) *Variant

Parses @format and returns the result.

This is the version of g_variant_new_parsed() intended to be used from libraries.

The return value will be floating if it was a newly created GVariant instance. In the case that @format simply specified the collection of a #GVariant pointer (eg: @format was "%*") then the collected #GVariant pointer will be returned unmodified, without adding any additional references.

Note that the arguments in @app must be of the correct width for their types specified in @format when collected into the #va_list. See the [GVariant varargs documentation](gvariant-format-strings.html#varargs).

In order to behave correctly in all cases it is necessary for the calling function to g_variant_ref_sink() the return result before returning control to the user that originally provided the pointer. At this point, the caller will have their own full reference to the result. This can also be done by adding the result to a container, or by passing it to another g_variant_new() call.

func NewVariantPrintf 

func NewVariantPrintf(FormatStringVar string, varArgs ...interface{}) *Variant

Creates a string-type GVariant using printf formatting.

This is similar to calling g_strdup_printf() and then g_variant_new_string() but it saves a temporary variable and an unnecessary copy.

func NewVariantSignature 

func NewVariantSignature(SignatureVar string) *Variant

Creates a D-Bus type signature #GVariant with the contents of @string. @string must be a valid D-Bus type signature. Use g_variant_is_signature() if you're not sure.

func NewVariantString 

func NewVariantString(StringVar string) *Variant

Creates a string #GVariant with the contents of @string.

@string must be valid UTF-8, and must not be %NULL. To encode potentially-%NULL strings, use g_variant_new() with `ms` as the [format string](gvariant-format-strings.html#maybe-types).

func NewVariantStrv 

func NewVariantStrv(StrvVar []string, LengthVar int) *Variant

Constructs an array of strings #GVariant from the given array of strings.

If @length is -1 then @strv is %NULL-terminated.

func NewVariantTakeString 

func NewVariantTakeString(StringVar string) *Variant

Creates a string #GVariant with the contents of @string.

@string must be valid UTF-8, and must not be %NULL. To encode potentially-%NULL strings, use this with g_variant_new_maybe().

After this call, @string belongs to the #GVariant and may no longer be modified by the caller. The memory of @data has to be dynamically allocated and will eventually be freed with g_free().

You must not modify or access @string in any other way after passing it to this function. It is even possible that @string is immediately freed.

func NewVariantTuple 

func NewVariantTuple(ChildrenVar uintptr, NChildrenVar uint) *Variant

Creates a new tuple #GVariant out of the items in @children. The type is determined from the types of @children. No entry in the @children array may be %NULL.

If @n_children is 0 then the unit tuple is constructed.

If the @children are floating references (see g_variant_ref_sink()), the new instance takes ownership of them as if via g_variant_ref_sink().

func NewVariantUint16 

func NewVariantUint16(ValueVar uint16) *Variant

Creates a new uint16 #GVariant instance.

func NewVariantUint32 

func NewVariantUint32(ValueVar uint32) *Variant

Creates a new uint32 #GVariant instance.

func NewVariantUint64 

func NewVariantUint64(ValueVar uint64) *Variant

Creates a new uint64 #GVariant instance.

func NewVariantVa 

func NewVariantVa(FormatStringVar string, EndptrVar *string, AppVar []interface{}) *Variant

This function is intended to be used by libraries based on #GVariant that want to provide g_variant_new()-like functionality to their users.

The API is more general than g_variant_new() to allow a wider range of possible uses.

@format_string must still point to a valid format string, but it only needs to be nul-terminated if @endptr is %NULL. If @endptr is non-%NULL then it is updated to point to the first character past the end of the format string.

@app is a pointer to a #va_list. The arguments, according to @format_string, are collected from this #va_list and the list is left pointing to the argument following the last.

Note that the arguments in @app must be of the correct width for their types specified in @format_string when collected into the #va_list. See the [GVariant varargs documentation](gvariant-format-strings.html#varargs).

These two generalisations allow mixing of multiple calls to g_variant_new_va() and g_variant_get_va() within a single actual varargs call by the user.

The return value will be floating if it was a newly created GVariant instance (for example, if the format string was "(ii)"). In the case that the format_string was '*', '?', 'r', or a format starting with '@' then the collected #GVariant pointer will be returned unmodified, without adding any additional references.

In order to behave correctly in all cases it is necessary for the calling function to g_variant_ref_sink() the return result before returning control to the user that originally provided the pointer. At this point, the caller will have their own full reference to the result. This can also be done by adding the result to a container, or by passing it to another g_variant_new() call.

func NewVariantVariant 

func NewVariantVariant(ValueVar *Variant) *Variant

Boxes @value. The result is a #GVariant instance representing a variant containing the original value.

If @child is a floating reference (see g_variant_ref_sink()), the new instance takes ownership of @child.

func VariantParse 

func VariantParse(TypeVar *VariantType, TextVar string, LimitVar *string, EndptrVar *string) (*Variant, error)

Parses a #GVariant from a text representation.

A single #GVariant is parsed from the content of @text.

The format is described [here](gvariant-text-format.html).

The memory at @limit will never be accessed and the parser behaves as if the character at @limit is the nul terminator. This has the effect of bounding @text.

If @endptr is non-%NULL then @text is permitted to contain data following the value that this function parses and @endptr will be updated to point to the first character past the end of the text parsed by this function. If @endptr is %NULL and there is extra data then an error is returned.

If @type is non-%NULL then the value will be parsed to have that type. This may result in additional parse errors (in the case that the parsed value doesn't fit the type) but may also result in fewer errors (in the case that the type would have been ambiguous, such as with empty arrays).

In the event that the parsing is successful, the resulting #GVariant is returned. It is never floating, and must be freed with [method@GLib.Variant.unref].

In case of any error, %NULL will be returned. If @error is non-%NULL then it will be set to reflect the error that occurred.

Officially, the language understood by the parser is “any string produced by [method@GLib.Variant.print]”. This explicitly includes `g_variant_print()`’s annotated types like `int64 -1000`.

There may be implementation specific restrictions on deeply nested values, which would result in a %G_VARIANT_PARSE_ERROR_RECURSION error. #GVariant is guaranteed to handle nesting up to at least 64 levels.

func (*Variant) Byteswap 

func (x *Variant) Byteswap() *Variant

Performs a byteswapping operation on the contents of @value. The result is that all multi-byte numeric data contained in @value is byteswapped. That includes 16, 32, and 64bit signed and unsigned integers as well as file handles and double precision floating point values.

This function is an identity mapping on any value that does not contain multi-byte numeric data. That include strings, booleans, bytes and containers containing only these things (recursively).

While this function can safely handle untrusted, non-normal data, it is recommended to check whether the input is in normal form beforehand, using g_variant_is_normal_form(), and to reject non-normal inputs if your application can be strict about what inputs it rejects.

The returned value is always in normal form and is marked as trusted. A full, not floating, reference is returned.

func (*Variant) CheckFormatString 

func (x *Variant) CheckFormatString(FormatStringVar string, CopyOnlyVar bool) bool

Checks if calling g_variant_get() with @format_string on @value would be valid from a type-compatibility standpoint. @format_string is assumed to be a valid format string (from a syntactic standpoint).

If @copy_only is %TRUE then this function additionally checks that it would be safe to call g_variant_unref() on @value immediately after the call to g_variant_get() without invalidating the result. This is only possible if deep copies are made (ie: there are no pointers to the data inside of the soon-to-be-freed #GVariant instance). If this check fails then a g_critical() is printed and %FALSE is returned.

This function is meant to be used by functions that wish to provide varargs accessors to #GVariant values of uncertain values (eg: g_variant_lookup() or g_menu_model_get_item_attribute()).

func (*Variant) Classify 

func (x *Variant) Classify() VariantClass

Classifies @value according to its top-level type.

func (*Variant) Compare 

func (x *Variant) Compare(TwoVar uintptr) int

Compares @one and @two.

The types of @one and @two are #gconstpointer only to allow use of this function with #GTree, #GPtrArray, etc. They must each be a #GVariant.

Comparison is only defined for basic types (ie: booleans, numbers, strings). For booleans, %FALSE is less than %TRUE. Numbers are ordered in the usual way. Strings are in ASCII lexographical order.

It is a programmer error to attempt to compare container values or two values that have types that are not exactly equal. For example, you cannot compare a 32-bit signed integer with a 32-bit unsigned integer. Also note that this function is not particularly well-behaved when it comes to comparison of doubles; in particular, the handling of incomparable values (ie: NaN) is undefined.

If you only require an equality comparison, g_variant_equal() is more general.

func (*Variant) DupBytestring 

func (x *Variant) DupBytestring(LengthVar *uint) uintptr

Similar to g_variant_get_bytestring() except that instead of returning a constant string, the string is duplicated.

The return value must be freed using g_free().

func (*Variant) DupBytestringArray 

func (x *Variant) DupBytestringArray(LengthVar *uint) []string

Gets the contents of an array of array of bytes #GVariant. This call makes a deep copy; the return result should be released with g_strfreev().

If @length is non-%NULL then the number of elements in the result is stored there. In any case, the resulting array will be %NULL-terminated.

For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned.

func (*Variant) DupObjv 

func (x *Variant) DupObjv(LengthVar *uint) []string

Gets the contents of an array of object paths #GVariant. This call makes a deep copy; the return result should be released with g_strfreev().

If @length is non-%NULL then the number of elements in the result is stored there. In any case, the resulting array will be %NULL-terminated.

For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned.

func (*Variant) DupString 

func (x *Variant) DupString(LengthVar *uint) string

Similar to g_variant_get_string() except that instead of returning a constant string, the string is duplicated.

The string will always be UTF-8 encoded.

The return value must be freed using g_free().

func (*Variant) DupStrv 

func (x *Variant) DupStrv(LengthVar *uint) []string

Gets the contents of an array of strings #GVariant. This call makes a deep copy; the return result should be released with g_strfreev().

If @length is non-%NULL then the number of elements in the result is stored there. In any case, the resulting array will be %NULL-terminated.

For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned.

func (*Variant) Equal 

func (x *Variant) Equal(TwoVar uintptr) bool

Checks if @one and @two have the same type and value.

The types of @one and @two are #gconstpointer only to allow use of this function with #GHashTable. They must each be a #GVariant.

func (*Variant) Get 

func (x *Variant) Get(FormatStringVar string, varArgs ...interface{})

Deconstructs a #GVariant instance.

Think of this function as an analogue to scanf().

The arguments that are expected by this function are entirely determined by @format_string. @format_string also restricts the permissible types of @value. It is an error to give a value with an incompatible type. See the section on [GVariant format strings](gvariant-format-strings.html). Please note that the syntax of the format string is very likely to be extended in the future.

@format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed, see the section on [`GVariant` format strings](gvariant-format-strings.html#pointers).

func (*Variant) GetBoolean 

func (x *Variant) GetBoolean() bool

Returns the boolean value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_BOOLEAN.

func (*Variant) GetByte 

func (x *Variant) GetByte() byte

Returns the byte value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_BYTE.

func (*Variant) GetBytestring 

func (x *Variant) GetBytestring() uintptr

Returns the string value of a #GVariant instance with an array-of-bytes type. The string has no particular encoding.

If the array does not end with a nul terminator character, the empty string is returned. For this reason, you can always trust that a non-%NULL nul-terminated string will be returned by this function.

If the array contains a nul terminator character somewhere other than the last byte then the returned string is the string, up to the first such nul character.

g_variant_get_fixed_array() should be used instead if the array contains arbitrary data that could not be nul-terminated or could contain nul bytes.

It is an error to call this function with a @value that is not an array of bytes.

The return value remains valid as long as @value exists.

func (*Variant) GetBytestringArray 

func (x *Variant) GetBytestringArray(LengthVar *uint) []string

Gets the contents of an array of array of bytes #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified.

If @length is non-%NULL then the number of elements in the result is stored there. In any case, the resulting array will be %NULL-terminated.

For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned.

func (*Variant) GetChild 

func (x *Variant) GetChild(IndexVar uint, FormatStringVar string, varArgs ...interface{})

Reads a child item out of a container #GVariant instance and deconstructs it according to @format_string. This call is essentially a combination of g_variant_get_child_value() and g_variant_get().

@format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed, see the section on [`GVariant` format strings](gvariant-format-strings.html#pointers).

func (*Variant) GetChildValue 

func (x *Variant) GetChildValue(IndexVar uint) *Variant

Reads a child item out of a container #GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of #GVariant.

It is an error if @index_ is greater than the number of child items in the container. See g_variant_n_children().

The returned value is never floating. You should free it with g_variant_unref() when you're done with it.

Note that values borrowed from the returned child are not guaranteed to still be valid after the child is freed even if you still hold a reference to @value, if @value has not been serialized at the time this function is called. To avoid this, you can serialize @value by calling g_variant_get_data() and optionally ignoring the return value.

There may be implementation specific restrictions on deeply nested values, which would result in the unit tuple being returned as the child value, instead of further nested children. #GVariant is guaranteed to handle nesting up to at least 64 levels.

This function is O(1).

func (*Variant) GetData 

func (x *Variant) GetData() uintptr

Returns a pointer to the serialized form of a #GVariant instance. The returned data may not be in fully-normalised form if read from an untrusted source. The returned data must not be freed; it remains valid for as long as @value exists.

If @value is a fixed-sized value that was deserialized from a corrupted serialized container then %NULL may be returned. In this case, the proper thing to do is typically to use the appropriate number of nul bytes in place of @value. If @value is not fixed-sized then %NULL is never returned.

In the case that @value is already in serialized form, this function is O(1). If the value is not already in serialized form, serialization occurs implicitly and is approximately O(n) in the size of the result.

To deserialize the data returned by this function, in addition to the serialized data, you must know the type of the #GVariant, and (if the machine might be different) the endianness of the machine that stored it. As a result, file formats or network messages that incorporate serialized #GVariants must include this information either implicitly (for instance "the file always contains a %G_VARIANT_TYPE_VARIANT and it is always in little-endian order") or explicitly (by storing the type and/or endianness in addition to the serialized data).

func (*Variant) GetDataAsBytes 

func (x *Variant) GetDataAsBytes() *Bytes

Returns a pointer to the serialized form of a #GVariant instance. The semantics of this function are exactly the same as g_variant_get_data(), except that the returned #GBytes holds a reference to the variant data.

func (*Variant) GetDouble 

func (x *Variant) GetDouble() float64

Returns the double precision floating point value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_DOUBLE.

func (*Variant) GetFixedArray 

func (x *Variant) GetFixedArray(NElementsVar *uint, ElementSizeVar uint) uintptr

Provides access to the serialized data for an array of fixed-sized items.

@value must be an array with fixed-sized elements. Numeric types are fixed-size, as are tuples containing only other fixed-sized types.

@element_size must be the size of a single element in the array, as given by the section on [serialized data memory](struct.Variant.html#serialized-data-memory).

In particular, arrays of these fixed-sized types can be interpreted as an array of the given C type, with @element_size set to the size the appropriate type: - %G_VARIANT_TYPE_INT16 (etc.): #gint16 (etc.) - %G_VARIANT_TYPE_BOOLEAN: #guchar (not #gboolean!) - %G_VARIANT_TYPE_BYTE: #guint8 - %G_VARIANT_TYPE_HANDLE: #guint32 - %G_VARIANT_TYPE_DOUBLE: #gdouble

For example, if calling this function for an array of 32-bit integers, you might say `sizeof(gint32)`. This value isn't used except for the purpose of a double-check that the form of the serialized data matches the caller's expectation.

@n_elements, which must be non-%NULL, is set equal to the number of items in the array.

func (*Variant) GetHandle 

func (x *Variant) GetHandle() int32

Returns the 32-bit signed integer value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_HANDLE.

By convention, handles are indexes into an array of file descriptors that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them.

func (*Variant) GetInt16 

func (x *Variant) GetInt16() int16

Returns the 16-bit signed integer value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT16.

func (*Variant) GetInt32 

func (x *Variant) GetInt32() int32

Returns the 32-bit signed integer value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT32.

func (*Variant) GetInt64 

func (x *Variant) GetInt64() int64

Returns the 64-bit signed integer value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_INT64.

func (*Variant) GetMaybe 

func (x *Variant) GetMaybe() *Variant

Given a maybe-typed #GVariant instance, extract its value. If the value is Nothing, then this function returns %NULL.

func (*Variant) GetNormalForm 

func (x *Variant) GetNormalForm() *Variant

Gets a #GVariant instance that has the same value as @value and is trusted to be in normal form.

If @value is already trusted to be in normal form then a new reference to @value is returned.

If @value is not already trusted, then it is scanned to check if it is in normal form. If it is found to be in normal form then it is marked as trusted and a new reference to it is returned.

If @value is found not to be in normal form then a new trusted #GVariant is created with the same value as @value. The non-normal parts of @value will be replaced with default values which are guaranteed to be in normal form.

It makes sense to call this function if you've received #GVariant data from untrusted sources and you want to ensure your serialized output is definitely in normal form.

If @value is already in normal form, a new reference will be returned (which will be floating if @value is floating). If it is not in normal form, the newly created #GVariant will be returned with a single non-floating reference. Typically, g_variant_take_ref() should be called on the return value from this function to guarantee ownership of a single non-floating reference to it.

func (*Variant) GetObjv 

func (x *Variant) GetObjv(LengthVar *uint) []string

Gets the contents of an array of object paths #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified.

If @length is non-%NULL then the number of elements in the result is stored there. In any case, the resulting array will be %NULL-terminated.

For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned.

func (*Variant) GetSize 

func (x *Variant) GetSize() uint

Determines the number of bytes that would be required to store @value with g_variant_store().

If @value has a fixed-sized type then this function always returned that fixed size.

In the case that @value is already in serialized form or the size has already been calculated (ie: this function has been called before) then this function is O(1). Otherwise, the size is calculated, an operation which is approximately O(n) in the number of values involved.

func (*Variant) GetString 

func (x *Variant) GetString(LengthVar *uint) string

Returns the string value of a #GVariant instance with a string type. This includes the types %G_VARIANT_TYPE_STRING, %G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE.

The string will always be UTF-8 encoded, will never be %NULL, and will never contain nul bytes.

If @length is non-%NULL then the length of the string (in bytes) is returned there. For trusted values, this information is already known. Untrusted values will be validated and, if valid, a strlen() will be performed. If invalid, a default value will be returned — for %G_VARIANT_TYPE_OBJECT_PATH, this is `"/"`, and for other types it is the empty string.

It is an error to call this function with a @value of any type other than those three.

The return value remains valid as long as @value exists.

func (*Variant) GetStrv 

func (x *Variant) GetStrv(LengthVar *uint) []string

Gets the contents of an array of strings #GVariant. This call makes a shallow copy; the return result should be released with g_free(), but the individual strings must not be modified.

If @length is non-%NULL then the number of elements in the result is stored there. In any case, the resulting array will be %NULL-terminated.

For an empty array, @length will be set to 0 and a pointer to a %NULL pointer will be returned.

func (*Variant) GetType 

func (x *Variant) GetType() *VariantType

Determines the type of @value.

The return value is valid for the lifetime of @value and must not be freed.

func (*Variant) GetTypeString 

func (x *Variant) GetTypeString() string

Returns the type string of @value. Unlike the result of calling g_variant_type_peek_string(), this string is nul-terminated. This string belongs to #GVariant and must not be freed.

func (*Variant) GetUint16 

func (x *Variant) GetUint16() uint16

Returns the 16-bit unsigned integer value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT16.

func (*Variant) GetUint32 

func (x *Variant) GetUint32() uint32

Returns the 32-bit unsigned integer value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT32.

func (*Variant) GetUint64 

func (x *Variant) GetUint64() uint64

Returns the 64-bit unsigned integer value of @value.

It is an error to call this function with a @value of any type other than %G_VARIANT_TYPE_UINT64.

func (*Variant) GetVa 

func (x *Variant) GetVa(FormatStringVar string, EndptrVar *string, AppVar []interface{})

This function is intended to be used by libraries based on #GVariant that want to provide g_variant_get()-like functionality to their users.

The API is more general than g_variant_get() to allow a wider range of possible uses.

@format_string must still point to a valid format string, but it only need to be nul-terminated if @endptr is %NULL. If @endptr is non-%NULL then it is updated to point to the first character past the end of the format string.

@app is a pointer to a #va_list. The arguments, according to @format_string, are collected from this #va_list and the list is left pointing to the argument following the last.

These two generalisations allow mixing of multiple calls to g_variant_new_va() and g_variant_get_va() within a single actual varargs call by the user.

@format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed, see the section on [`GVariant` format strings](gvariant-format-strings.html#pointers).

func (*Variant) GetVariant 

func (x *Variant) GetVariant() *Variant

Unboxes @value. The result is the #GVariant instance that was contained in @value.

func (*Variant) GoPointer 

func (x *Variant) GoPointer() uintptr

func (*Variant) Hash 

func (x *Variant) Hash() uint

Generates a hash value for a #GVariant instance.

The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor architectures or even different versions of GLib. Do not use this function as a basis for building protocols or file formats.

The type of @value is #gconstpointer only to allow use of this function with #GHashTable. @value must be a #GVariant.

func (*Variant) IsContainer 

func (x *Variant) IsContainer() bool

Checks if @value is a container.

func (*Variant) IsFloating 

func (x *Variant) IsFloating() bool

Checks whether @value has a floating reference count.

This function should only ever be used to assert that a given variant is or is not floating, or for debug purposes. To acquire a reference to a variant that might be floating, always use g_variant_ref_sink() or g_variant_take_ref().

See g_variant_ref_sink() for more information about floating reference counts.

func (*Variant) IsNormalForm 

func (x *Variant) IsNormalForm() bool

Checks if @value is in normal form.

The main reason to do this is to detect if a given chunk of serialized data is in normal form: load the data into a #GVariant using g_variant_new_from_data() and then use this function to check.

If @value is found to be in normal form then it will be marked as being trusted. If the value was already marked as being trusted then this function will immediately return %TRUE.

There may be implementation specific restrictions on deeply nested values. GVariant is guaranteed to handle nesting up to at least 64 levels.

func (*Variant) IsOfType 

func (x *Variant) IsOfType(TypeVar *VariantType) bool

Checks if a value has a type matching the provided type.

func (*Variant) IterNew 

func (x *Variant) IterNew() *VariantIter

Creates a heap-allocated #GVariantIter for iterating over the items in @value.

Use g_variant_iter_free() to free the return value when you no longer need it.

A reference is taken to @value and will be released only when g_variant_iter_free() is called.

func (*Variant) Lookup 

func (x *Variant) Lookup(KeyVar string, FormatStringVar string, varArgs ...interface{}) bool

Looks up a value in a dictionary #GVariant.

This function is a wrapper around g_variant_lookup_value() and g_variant_get(). In the case that %NULL would have been returned, this function returns %FALSE. Otherwise, it unpacks the returned value and returns %TRUE.

@format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed, see the section on [`GVariant` format strings](gvariant-format-strings.html#pointers).

This function is currently implemented with a linear scan. If you plan to do many lookups then #GVariantDict may be more efficient.

func (*Variant) LookupValue 

func (x *Variant) LookupValue(KeyVar string, ExpectedTypeVar *VariantType) *Variant

Looks up a value in a dictionary #GVariant.

This function works with dictionaries of the type `a{s*}` (and equally well with type `a{o*}`), but we only further discuss the string case for sake of clarity).

In the event that @dictionary has the type `a{sv}`, the @expected_type string specifies what type of value is expected to be inside of the variant. If the value inside the variant has a different type then %NULL is returned. In the event that @dictionary has a value type other than v then @expected_type must directly match the value type and it is used to unpack the value directly or an error occurs.

In either case, if @key is not found in @dictionary, %NULL is returned.

If the key is found and the value has the correct type, it is returned. If @expected_type was specified then any non-%NULL return value will have this type.

This function is currently implemented with a linear scan. If you plan to do many lookups then [struct@VariantDict] may be more efficient.

func (*Variant) NChildren 

func (x *Variant) NChildren() uint

Determines the number of children in a container #GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of #GVariant.

For variants, the return value is always 1. For values with maybe types, it is always zero or one. For arrays, it is the length of the array. For tuples it is the number of tuple items (which depends only on the type). For dictionary entries, it is always 2

This function is O(1).

func (*Variant) Print 

func (x *Variant) Print(TypeAnnotateVar bool) string

Pretty-prints @value in the format understood by g_variant_parse().

The format is described [here](gvariant-text-format.html).

If @type_annotate is %TRUE, then type information is included in the output.

func (*Variant) PrintString 

func (x *Variant) PrintString(StringVar *String, TypeAnnotateVar bool) *String

Behaves as g_variant_print(), but operates on a #GString.

If @string is non-%NULL then it is appended to and returned. Else, a new empty #GString is allocated and it is returned.

func (*Variant) Ref 

func (x *Variant) Ref() *Variant

Increases the reference count of @value.

func (*Variant) RefSink 

func (x *Variant) RefSink() *Variant

#GVariant uses a floating reference count system. All functions with names starting with `g_variant_new_` return floating references.

Calling g_variant_ref_sink() on a #GVariant with a floating reference will convert the floating reference into a full reference. Calling g_variant_ref_sink() on a non-floating #GVariant results in an additional normal reference being added.

In other words, if the @value is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference. If the @value is not floating, then this call adds a new normal reference increasing the reference count by one.

All calls that result in a #GVariant instance being inserted into a container will call g_variant_ref_sink() on the instance. This means that if the value was just created (and has only its floating reference) then the container will assume sole ownership of the value at that point and the caller will not need to unreference it. This makes certain common styles of programming much easier while still maintaining normal refcounting semantics in situations where values are not floating.

func (*Variant) Store 

func (x *Variant) Store(DataVar uintptr)

Stores the serialized form of @value at @data. @data should be large enough. See g_variant_get_size().

The stored data is in machine native byte order but may not be in fully-normalised form if read from an untrusted source. See g_variant_get_normal_form() for a solution.

As with g_variant_get_data(), to be able to deserialize the serialized variant successfully, its type and (if the destination machine might be different) its endianness must also be available.

This function is approximately O(n) in the size of @data.

func (*Variant) TakeRef 

func (x *Variant) TakeRef() *Variant

If @value is floating, sink it. Otherwise, do nothing.

Typically you want to use g_variant_ref_sink() in order to automatically do the correct thing with respect to floating or non-floating references, but there is one specific scenario where this function is helpful.

The situation where this function is helpful is when creating an API that allows the user to provide a callback function that returns a #GVariant. We certainly want to allow the user the flexibility to return a non-floating reference from this callback (for the case where the value that is being returned already exists).

At the same time, the style of the #GVariant API makes it likely that for newly-created #GVariant instances, the user can be saved some typing if they are allowed to return a #GVariant with a floating reference.

Using this function on the return value of the user's callback allows the user to do whichever is more convenient for them. The caller will always receives exactly one full reference to the value: either the one that was returned in the first place, or a floating reference that has been converted to a full reference.

This function has an odd interaction when combined with g_variant_ref_sink() running at the same time in another thread on the same #GVariant instance. If g_variant_ref_sink() runs first then the result will be that the floating reference is converted to a hard reference. If g_variant_take_ref() runs first then the result will be that the floating reference is converted to a hard reference and an additional reference on top of that one is added. It is best to avoid this situation.

func (*Variant) Unref 

func (x *Variant) Unref()

Decreases the reference count of @value. When its reference count drops to 0, the memory used by the variant is freed.

type VariantBuilder 

type VariantBuilder struct {
	// contains filtered or unexported fields
}

A utility type for constructing container-type #GVariant instances.

This is an opaque structure and may only be accessed using the following functions.

#GVariantBuilder is not threadsafe in any way. Do not attempt to access it from more than one thread.

func NewVariantBuilder 

func NewVariantBuilder(TypeVar *VariantType) *VariantBuilder

Allocates and initialises a new #GVariantBuilder.

You should call g_variant_builder_unref() on the return value when it is no longer needed. The memory will not be automatically freed by any other call.

In most cases it is easier to place a #GVariantBuilder directly on the stack of the calling function and initialise it with g_variant_builder_init_static().

func (*VariantBuilder) Add 

func (x *VariantBuilder) Add(FormatStringVar string, varArgs ...interface{})

Adds to a #GVariantBuilder.

This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_builder_add_value().

Note that the arguments must be of the correct width for their types specified in @format_string. This can be achieved by casting them. See the [GVariant varargs documentation](gvariant-format-strings.html#varargs).

This function might be used as follows:

|[&lt;!-- language="C" --&gt; GVariant * make_pointless_dictionary (void) 

{
  GVariantBuilder builder;
  int i;

  g_variant_builder_init_static (&amp;builder, G_VARIANT_TYPE_ARRAY);
  for (i = 0; i &lt; 16; i++)
    {
      gchar buf[3];

      sprintf (buf, "%d", i);
      g_variant_builder_add (&amp;builder, "{is}", i, buf);
    }

  return g_variant_builder_end (&amp;builder);
}

]|

func (*VariantBuilder) AddParsed 

func (x *VariantBuilder) AddParsed(FormatVar string, varArgs ...interface{})

Adds to a #GVariantBuilder.

This call is a convenience wrapper that is exactly equivalent to calling g_variant_new_parsed() followed by g_variant_builder_add_value().

Note that the arguments must be of the correct width for their types specified in @format_string. This can be achieved by casting them. See the [GVariant varargs documentation](gvariant-format-strings.html#varargs).

This function might be used as follows:

|[&lt;!-- language="C" --&gt; GVariant * make_pointless_dictionary (void) 

{
  GVariantBuilder builder;
  int i;

  g_variant_builder_init_static (&amp;builder, G_VARIANT_TYPE_ARRAY);
  g_variant_builder_add_parsed (&amp;builder, "{'width', &lt;%i&gt;}", 600);
  g_variant_builder_add_parsed (&amp;builder, "{'title', &lt;%s&gt;}", "foo");
  g_variant_builder_add_parsed (&amp;builder, "{'transparency', &lt;0.5&gt;}");
  return g_variant_builder_end (&amp;builder);
}

]|

func (*VariantBuilder) AddValue 

func (x *VariantBuilder) AddValue(ValueVar *Variant)

Adds @value to @builder.

It is an error to call this function in any way that would create an inconsistent value to be constructed. Some examples of this are putting different types of items into an array, putting the wrong types or number of items in a tuple, putting more than one value into a variant, etc.

If @value is a floating reference (see g_variant_ref_sink()), the @builder instance takes ownership of @value.

func (*VariantBuilder) Clear 

func (x *VariantBuilder) Clear()

Releases all memory associated with a #GVariantBuilder without freeing the #GVariantBuilder structure itself.

It typically only makes sense to do this on a stack-allocated #GVariantBuilder if you want to abort building the value part-way through. This function need not be called if you call g_variant_builder_end() and it also doesn't need to be called on builders allocated with g_variant_builder_new() (see g_variant_builder_unref() for that).

This function leaves the #GVariantBuilder structure set to all-zeros. It is valid to call this function on either an initialised #GVariantBuilder or one that is set to all-zeros but it is not valid to call this function on uninitialised memory.

func (*VariantBuilder) Close 

func (x *VariantBuilder) Close()

Closes the subcontainer inside the given @builder that was opened by the most recent call to g_variant_builder_open().

It is an error to call this function in any way that would create an inconsistent value to be constructed (ie: too few values added to the subcontainer).

func (*VariantBuilder) End 

func (x *VariantBuilder) End() *Variant

Ends the builder process and returns the constructed value.

It is not permissible to use @builder in any way after this call except for reference counting operations (in the case of a heap-allocated #GVariantBuilder) or by reinitialising it with g_variant_builder_init() (in the case of stack-allocated). This means that for the stack-allocated builders there is no need to call g_variant_builder_clear() after the call to g_variant_builder_end().

It is an error to call this function in any way that would create an inconsistent value to be constructed (ie: insufficient number of items added to a container with a specific number of children required). It is also an error to call this function if the builder was created with an indefinite array or maybe type and no children have been added; in this case it is impossible to infer the type of the empty array.

func (*VariantBuilder) GoPointer 

func (x *VariantBuilder) GoPointer() uintptr

func (*VariantBuilder) Init 

func (x *VariantBuilder) Init(TypeVar *VariantType)

Initialises a #GVariantBuilder structure.

@type must be non-%NULL. It specifies the type of container to construct. It can be an indefinite type such as %G_VARIANT_TYPE_ARRAY or a definite type such as "as" or "(ii)". Maybe, array, tuple, dictionary entry and variant-typed values may be constructed.

If using a static type such as one of the `G_VARIANT_TYPE_*` constants or a `G_VARIANT_TYPE ("(ii)")` macro, it is more performant to use g_variant_builder_init_static() rather than g_variant_builder_init().

After the builder is initialised, values are added using g_variant_builder_add_value() or g_variant_builder_add().

After all the child values are added, g_variant_builder_end() frees the memory associated with the builder and returns the #GVariant that was created.

This function completely ignores the previous contents of @builder. On one hand this means that it is valid to pass in completely uninitialised memory. On the other hand, this means that if you are initialising over top of an existing #GVariantBuilder you need to first call g_variant_builder_clear() in order to avoid leaking memory.

You must not call g_variant_builder_ref() or g_variant_builder_unref() on a #GVariantBuilder that was initialised with this function. If you ever pass a reference to a #GVariantBuilder outside of the control of your own code then you should assume that the person receiving that reference may try to use reference counting; you should use g_variant_builder_new() instead of this function.

func (*VariantBuilder) InitStatic 

func (x *VariantBuilder) InitStatic(TypeVar *VariantType)

Initialises a #GVariantBuilder structure.

This function works exactly like g_variant_builder_init() but does not make a copy of @type. Therefore, @type must remain valid for the lifetime of @builder. This is always true of type constants like `G_VARIANT_TYPE_*` or `G_VARIANT_TYPE ("(ii)")`.

func (*VariantBuilder) Open 

func (x *VariantBuilder) Open(TypeVar *VariantType)

Opens a subcontainer inside the given @builder. When done adding items to the subcontainer, g_variant_builder_close() must be called. @type is the type of the container: so to build a tuple of several values, @type must include the tuple itself.

It is an error to call this function in any way that would cause an inconsistent value to be constructed (ie: adding too many values or a value of an incorrect type).

Example of building a nested variant: |[&lt;!-- language="C" --&gt; GVariantBuilder builder; guint32 some_number = get_number (); g_autoptr (GHashTable) some_dict = get_dict (); GHashTableIter iter; const gchar *key; const GVariant *value; g_autoptr (GVariant) output = NULL;

g_variant_builder_init (&amp;builder, G_VARIANT_TYPE ("(ua{sv})")); g_variant_builder_add (&amp;builder, "u", some_number); g_variant_builder_open (&amp;builder, G_VARIANT_TYPE ("a{sv}"));

g_hash_table_iter_init (&amp;iter, some_dict); while (g_hash_table_iter_next (&amp;iter, (gpointer *) &amp;key, (gpointer *) &amp;value)) 

{
  g_variant_builder_open (&amp;builder, G_VARIANT_TYPE ("{sv}"));
  g_variant_builder_add (&amp;builder, "s", key);
  g_variant_builder_add (&amp;builder, "v", value);
  g_variant_builder_close (&amp;builder);
}

g_variant_builder_close (&amp;builder);

output = g_variant_builder_end (&amp;builder); ]|

func (*VariantBuilder) Ref 

func (x *VariantBuilder) Ref() *VariantBuilder

Increases the reference count on @builder.

Don't call this on stack-allocated #GVariantBuilder instances or bad things will happen.

func (*VariantBuilder) Unref 

func (x *VariantBuilder) Unref()

Decreases the reference count on @builder.

In the event that there are no more references, releases all memory associated with the #GVariantBuilder.

Don't call this on stack-allocated #GVariantBuilder instances or bad things will happen.

type VariantClass 

type VariantClass int

The range of possible top-level types of #GVariant instances. 

const (

	// The #GVariant is a boolean.
	GVariantClassBooleanValue VariantClass = 98
	// The #GVariant is a byte.
	GVariantClassByteValue VariantClass = 121
	// The #GVariant is a signed 16 bit integer.
	GVariantClassInt16Value VariantClass = 110
	// The #GVariant is an unsigned 16 bit integer.
	GVariantClassUint16Value VariantClass = 113
	// The #GVariant is a signed 32 bit integer.
	GVariantClassInt32Value VariantClass = 105
	// The #GVariant is an unsigned 32 bit integer.
	GVariantClassUint32Value VariantClass = 117
	// The #GVariant is a signed 64 bit integer.
	GVariantClassInt64Value VariantClass = 120
	// The #GVariant is an unsigned 64 bit integer.
	GVariantClassUint64Value VariantClass = 116
	// The #GVariant is a file handle index.
	GVariantClassHandleValue VariantClass = 104
	// The #GVariant is a double precision floating
	//                          point value.
	GVariantClassDoubleValue VariantClass = 100
	// The #GVariant is a normal string.
	GVariantClassStringValue VariantClass = 115
	// The #GVariant is a D-Bus object path
	//                               string.
	GVariantClassObjectPathValue VariantClass = 111
	// The #GVariant is a D-Bus signature string.
	GVariantClassSignatureValue VariantClass = 103
	// The #GVariant is a variant.
	GVariantClassVariantValue VariantClass = 118
	// The #GVariant is a maybe-typed value.
	GVariantClassMaybeValue VariantClass = 109
	// The #GVariant is an array.
	GVariantClassArrayValue VariantClass = 97
	// The #GVariant is a tuple.
	GVariantClassTupleValue VariantClass = 40
	// The #GVariant is a dictionary entry.
	GVariantClassDictEntryValue VariantClass = 123
)

type VariantDict 

type VariantDict struct {
	// contains filtered or unexported fields
}

#GVariantDict is a mutable interface to #GVariant dictionaries.

It can be used for doing a sequence of dictionary lookups in an efficient way on an existing #GVariant dictionary or it can be used to construct new dictionaries with a hashtable-like interface. It can also be used for taking existing dictionaries and modifying them in order to create new ones.

#GVariantDict can only be used with %G_VARIANT_TYPE_VARDICT dictionaries.

It is possible to use #GVariantDict allocated on the stack or on the heap. When using a stack-allocated #GVariantDict, you begin with a call to g_variant_dict_init() and free the resources with a call to g_variant_dict_clear().

Heap-allocated #GVariantDict follows normal refcounting rules: you allocate it with g_variant_dict_new() and use g_variant_dict_ref() and g_variant_dict_unref().

g_variant_dict_end() is used to convert the #GVariantDict back into a dictionary-type #GVariant. When used with stack-allocated instances, this also implicitly frees all associated memory, but for heap-allocated instances, you must still call g_variant_dict_unref() afterwards.

You will typically want to use a heap-allocated #GVariantDict when you expose it as part of an API. For most other uses, the stack-allocated form will be more convenient.

Consider the following two examples that do the same thing in each style: take an existing dictionary and look up the "count" uint32 key, adding 1 to it if it is found, or returning an error if the key is not found. Each returns the new dictionary as a floating #GVariant.

## Using a stack-allocated GVariantDict

|[&lt;!-- language="C" --&gt; 

GVariant *
add_to_count (GVariant  *orig,
              GError   **error)
{
  GVariantDict dict;
  guint32 count;

  g_variant_dict_init (&amp;dict, orig);
  if (!g_variant_dict_lookup (&amp;dict, "count", "u", &amp;count))
    {
      g_set_error (...);
      g_variant_dict_clear (&amp;dict);
      return NULL;
    }

  g_variant_dict_insert (&amp;dict, "count", "u", count + 1);

  return g_variant_dict_end (&amp;dict);
}

]|

## Using heap-allocated GVariantDict

|[&lt;!-- language="C" --&gt; 

GVariant *
add_to_count (GVariant  *orig,
              GError   **error)
{
  GVariantDict *dict;
  GVariant *result;
  guint32 count;

  dict = g_variant_dict_new (orig);

  if (g_variant_dict_lookup (dict, "count", "u", &amp;count))
    {
      g_variant_dict_insert (dict, "count", "u", count + 1);
      result = g_variant_dict_end (dict);
    }
  else
    {
      g_set_error (...);
      result = NULL;
    }

  g_variant_dict_unref (dict);

  return result;
}

]|

func NewVariantDict 

func NewVariantDict(FromAsvVar *Variant) *VariantDict

Allocates and initialises a new #GVariantDict.

You should call g_variant_dict_unref() on the return value when it is no longer needed. The memory will not be automatically freed by any other call.

In some cases it may be easier to place a #GVariantDict directly on the stack of the calling function and initialise it with g_variant_dict_init(). This is particularly useful when you are using #GVariantDict to construct a #GVariant.

func (*VariantDict) Clear 

func (x *VariantDict) Clear()

Releases all memory associated with a #GVariantDict without freeing the #GVariantDict structure itself.

It typically only makes sense to do this on a stack-allocated #GVariantDict if you want to abort building the value part-way through. This function need not be called if you call g_variant_dict_end() and it also doesn't need to be called on dicts allocated with g_variant_dict_new (see g_variant_dict_unref() for that).

It is valid to call this function on either an initialised #GVariantDict or one that was previously cleared by an earlier call to g_variant_dict_clear() but it is not valid to call this function on uninitialised memory.

func (*VariantDict) Contains 

func (x *VariantDict) Contains(KeyVar string) bool

Checks if @key exists in @dict.

func (*VariantDict) End 

func (x *VariantDict) End() *Variant

Returns the current value of @dict as a #GVariant of type %G_VARIANT_TYPE_VARDICT, clearing it in the process.

It is not permissible to use @dict in any way after this call except for reference counting operations (in the case of a heap-allocated #GVariantDict) or by reinitialising it with g_variant_dict_init() (in the case of stack-allocated).

func (*VariantDict) GoPointer 

func (x *VariantDict) GoPointer() uintptr

func (*VariantDict) Init 

func (x *VariantDict) Init(FromAsvVar *Variant)

Initialises a #GVariantDict structure.

If @from_asv is given, it is used to initialise the dictionary.

This function completely ignores the previous contents of @dict. On one hand this means that it is valid to pass in completely uninitialised memory. On the other hand, this means that if you are initialising over top of an existing #GVariantDict you need to first call g_variant_dict_clear() in order to avoid leaking memory.

You must not call g_variant_dict_ref() or g_variant_dict_unref() on a #GVariantDict that was initialised with this function. If you ever pass a reference to a #GVariantDict outside of the control of your own code then you should assume that the person receiving that reference may try to use reference counting; you should use g_variant_dict_new() instead of this function.

func (*VariantDict) Insert 

func (x *VariantDict) Insert(KeyVar string, FormatStringVar string, varArgs ...interface{})

Inserts a value into a #GVariantDict.

This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_dict_insert_value().

func (*VariantDict) InsertValue 

func (x *VariantDict) InsertValue(KeyVar string, ValueVar *Variant)

Inserts (or replaces) a key in a #GVariantDict.

@value is consumed if it is floating.

func (*VariantDict) Lookup 

func (x *VariantDict) Lookup(KeyVar string, FormatStringVar string, varArgs ...interface{}) bool

Looks up a value in a #GVariantDict.

This function is a wrapper around g_variant_dict_lookup_value() and g_variant_get(). In the case that %NULL would have been returned, this function returns %FALSE and does not modify the values of the arguments passed in to @.... Otherwise, it unpacks the returned value and returns %TRUE.

@format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed, see the section on [`GVariant` format strings](gvariant-format-strings.html#pointers).

func (*VariantDict) LookupValue 

func (x *VariantDict) LookupValue(KeyVar string, ExpectedTypeVar *VariantType) *Variant

Looks up a value in a #GVariantDict.

If @key is not found in @dictionary, %NULL is returned.

The @expected_type string specifies what type of value is expected. If the value associated with @key has a different type then %NULL is returned.

If the key is found and the value has the correct type, it is returned. If @expected_type was specified then any non-%NULL return value will have this type.

func (*VariantDict) Ref 

func (x *VariantDict) Ref() *VariantDict

Increases the reference count on @dict.

Don't call this on stack-allocated #GVariantDict instances or bad things will happen.

func (*VariantDict) Remove 

func (x *VariantDict) Remove(KeyVar string) bool

Removes a key and its associated value from a #GVariantDict.

func (*VariantDict) Unref 

func (x *VariantDict) Unref()

Decreases the reference count on @dict.

In the event that there are no more references, releases all memory associated with the #GVariantDict.

Don't call this on stack-allocated #GVariantDict instances or bad things will happen.

type VariantIter 

type VariantIter struct {
	X [16]uintptr
	// contains filtered or unexported fields
}

#GVariantIter is an opaque data structure and can only be accessed using the following functions.

func (*VariantIter) Copy 

func (x *VariantIter) Copy() *VariantIter

Creates a new heap-allocated #GVariantIter to iterate over the container that was being iterated over by @iter. Iteration begins on the new iterator from the current position of the old iterator but the two copies are independent past that point.

Use g_variant_iter_free() to free the return value when you no longer need it.

A reference is taken to the container that @iter is iterating over and will be related only when g_variant_iter_free() is called.

func (*VariantIter) Free 

func (x *VariantIter) Free()

Frees a heap-allocated #GVariantIter. Only call this function on iterators that were returned by g_variant_iter_new() or g_variant_iter_copy().

func (*VariantIter) GoPointer 

func (x *VariantIter) GoPointer() uintptr

func (*VariantIter) Init 

func (x *VariantIter) Init(ValueVar *Variant) uint

Initialises (without allocating) a #GVariantIter. @iter may be completely uninitialised prior to this call; its old value is ignored.

The iterator remains valid for as long as @value exists, and need not be freed in any way.

func (*VariantIter) Loop 

func (x *VariantIter) Loop(FormatStringVar string, varArgs ...interface{}) bool

Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE.

If no more items remain then %FALSE is returned.

On the first call to this function, the pointers appearing on the variable argument list are assumed to point at uninitialised memory. On the second and later calls, it is assumed that the same pointers will be given and that they will point to the memory as set by the previous call to this function. This allows the previous values to be freed, as appropriate.

This function is intended to be used with a while loop as demonstrated in the following example. This function can only be used when iterating over an array. It is only valid to call this function with a string constant for the format string and the same string constant must be used each time. Mixing calls to this function and g_variant_iter_next() or g_variant_iter_next_value() on the same iterator causes undefined behavior.

If you break out of a such a while loop using g_variant_iter_loop() then you must free or unreference all the unpacked values as you would with g_variant_get(). Failure to do so will cause a memory leak.

Here is an example for memory management with g_variant_iter_loop(): |[&lt;!-- language="C" --&gt; 

// Iterates a dictionary of type 'a{sv}'
void
iterate_dictionary (GVariant *dictionary)
{
  GVariantIter iter;
  GVariant *value;
  gchar *key;

  g_variant_iter_init (&amp;iter, dictionary);
  while (g_variant_iter_loop (&amp;iter, "{sv}", &amp;key, &amp;value))
    {
      g_print ("Item '%s' has type '%s'\n", key,
               g_variant_get_type_string (value));

      // no need to free 'key' and 'value' here
      // unless breaking out of this loop
    }
}

]|

For most cases you should use g_variant_iter_next().

This function is really only useful when unpacking into #GVariant or #GVariantIter in order to allow you to skip the call to g_variant_unref() or g_variant_iter_free().

For example, if you are only looping over simple integer and string types, g_variant_iter_next() is definitely preferred. For string types, use the '&amp;' prefix to avoid allocating any memory at all (and thereby avoiding the need to free anything as well).

@format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed.

See the section on [`GVariant` format strings](gvariant-format-strings.html#pointers).

func (*VariantIter) NChildren 

func (x *VariantIter) NChildren() uint

Queries the number of child items in the container that we are iterating over. This is the total number of items -- not the number of items remaining.

This function might be useful for preallocation of arrays.

func (*VariantIter) Next 

func (x *VariantIter) Next(FormatStringVar string, varArgs ...interface{}) bool

Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE.

If no more items remain then %FALSE is returned.

All of the pointers given on the variable arguments list of this function are assumed to point at uninitialised memory. It is the responsibility of the caller to free all of the values returned by the unpacking process.

Here is an example for memory management with g_variant_iter_next(): |[&lt;!-- language="C" --&gt; 

// Iterates a dictionary of type 'a{sv}'
void
iterate_dictionary (GVariant *dictionary)
{
  GVariantIter iter;
  GVariant *value;
  gchar *key;

  g_variant_iter_init (&amp;iter, dictionary);
  while (g_variant_iter_next (&amp;iter, "{sv}", &amp;key, &amp;value))
    {
      g_print ("Item '%s' has type '%s'\n", key,
               g_variant_get_type_string (value));

      // must free data for ourselves
      g_variant_unref (value);
      g_free (key);
    }
}

]|

For a solution that is likely to be more convenient to C programmers when dealing with loops, see g_variant_iter_loop().

@format_string determines the C types that are used for unpacking the values and also determines if the values are copied or borrowed.

See the section on [`GVariant` format strings](gvariant-format-strings.html#pointers).

func (*VariantIter) NextValue 

func (x *VariantIter) NextValue() *Variant

Gets the next item in the container. If no more items remain then %NULL is returned.

Use g_variant_unref() to drop your reference on the return value when you no longer need it.

Here is an example for iterating with g_variant_iter_next_value(): |[&lt;!-- language="C" --&gt; 

// recursively iterate a container
void
iterate_container_recursive (GVariant *container)
{
  GVariantIter iter;
  GVariant *child;

  g_variant_iter_init (&amp;iter, container);
  while ((child = g_variant_iter_next_value (&amp;iter)))
    {
      g_print ("type '%s'\n", g_variant_get_type_string (child));

      if (g_variant_is_container (child))
        iterate_container_recursive (child);

      g_variant_unref (child);
    }
}

]|

type VariantParseError 

type VariantParseError int

Error codes returned by parsing text-format GVariants. 

const (

	// generic error (unused)
	GVariantParseErrorFailedValue VariantParseError = 0
	// a non-basic #GVariantType was given where a basic type was expected
	GVariantParseErrorBasicTypeExpectedValue VariantParseError = 1
	// cannot infer the #GVariantType
	GVariantParseErrorCannotInferTypeValue VariantParseError = 2
	// an indefinite #GVariantType was given where a definite type was expected
	GVariantParseErrorDefiniteTypeExpectedValue VariantParseError = 3
	// extra data after parsing finished
	GVariantParseErrorInputNotAtEndValue VariantParseError = 4
	// invalid character in number or unicode escape
	GVariantParseErrorInvalidCharacterValue VariantParseError = 5
	// not a valid #GVariant format string
	GVariantParseErrorInvalidFormatStringValue VariantParseError = 6
	// not a valid object path
	GVariantParseErrorInvalidObjectPathValue VariantParseError = 7
	// not a valid type signature
	GVariantParseErrorInvalidSignatureValue VariantParseError = 8
	// not a valid #GVariant type string
	GVariantParseErrorInvalidTypeStringValue VariantParseError = 9
	// could not find a common type for array entries
	GVariantParseErrorNoCommonTypeValue VariantParseError = 10
	// the numerical value is out of range of the given type
	GVariantParseErrorNumberOutOfRangeValue VariantParseError = 11
	// the numerical value is out of range for any type
	GVariantParseErrorNumberTooBigValue VariantParseError = 12
	// cannot parse as variant of the specified type
	GVariantParseErrorTypeErrorValue VariantParseError = 13
	// an unexpected token was encountered
	GVariantParseErrorUnexpectedTokenValue VariantParseError = 14
	// an unknown keyword was encountered
	GVariantParseErrorUnknownKeywordValue VariantParseError = 15
	// unterminated string constant
	GVariantParseErrorUnterminatedStringConstantValue VariantParseError = 16
	// no value given
	GVariantParseErrorValueExpectedValue VariantParseError = 17
	// variant was too deeply nested; #GVariant is only guaranteed to handle nesting up to 64 levels (Since: 2.64)
	GVariantParseErrorRecursionValue VariantParseError = 18
)

type VariantType 

type VariantType struct {
	// contains filtered or unexported fields
}

A type in the [type@GLib.Variant] type system.

[type@GLib.Variant] types are represented as strings, but have a strict syntax described below. All [type@GLib.VariantType]s passed to GLib must be valid, and they are typically expected to be static (i.e. not provided by user input) as they determine how binary [type@GLib.Variant] data is interpreted.

To convert a static string to a [type@GLib.VariantType] in C, use the [func@GLib.VARIANT_TYPE] casting macro. When GLib is compiled with checks enabled, it will validate the type. To check if an arbitrary string is a valid [type@GLib.VariantType], use [func@GLib.VariantType.string_is_valid].

## GVariant Type System

This section introduces the [type@GLib.Variant] type system. It is based, in large part, on the D-Bus type system, with two major changes and some minor lifting of restrictions. The [D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html), therefore, provides a significant amount of information that is useful when working with [type@GLib.Variant].

The first major change with respect to the D-Bus type system is the introduction of maybe (or ‘nullable’) types. Any type in [type@GLib.Variant] can be converted to a maybe type, in which case, `nothing` (or `null`) becomes a valid value. Maybe types have been added by introducing the character `m` to type strings.

The second major change is that the [type@GLib.Variant] type system supports the concept of ‘indefinite types’ — types that are less specific than the normal types found in D-Bus. For example, it is possible to speak of ‘an array of any type’ in [type@GLib.Variant], where the D-Bus type system would require you to speak of ‘an array of integers’ or ‘an array of strings’. Indefinite types have been added by introducing the characters `*`, `?` and `r` to type strings.

Finally, all arbitrary restrictions relating to the complexity of types are lifted along with the restriction that dictionary entries may only appear nested inside of arrays.

Just as in D-Bus, [type@GLib.Variant] types are described with strings (‘type strings’). Subject to the differences mentioned above, these strings are of the same form as those found in D-Bus. Note, however: D-Bus always works in terms of messages and therefore individual type strings appear nowhere in its interface. Instead, ‘signatures’ are a concatenation of the strings of the type of each argument in a message. [type@GLib.Variant] deals with single values directly so [type@GLib.Variant] type strings always describe the type of exactly one value. This means that a D-Bus signature string is generally not a valid [type@GLib.Variant] type string — except in the case that it is the signature of a message containing exactly one argument.

An indefinite type is similar in spirit to what may be called an abstract type in other type systems. No value can exist that has an indefinite type as its type, but values can exist that have types that are subtypes of indefinite types. That is to say, [method@GLib.Variant.get_type] will never return an indefinite type, but calling [method@GLib.Variant.is_of_type] with an indefinite type may return true. For example, you cannot have a value that represents ‘an array of no particular type’, but you can have an ‘array of integers’ which certainly matches the type of ‘an array of no particular type’, since ‘array of integers’ is a subtype of ‘array of no particular type’.

This is similar to how instances of abstract classes may not directly exist in other type systems, but instances of their non-abstract subtypes may. For example, in GTK, no object that has the type of [`GtkWidget`](https://docs.gtk.org/gtk4/class.Widget.html) can exist (since `GtkWidget` is an abstract class), but a [`GtkWindow`](https://docs.gtk.org/gtk4/class.Window.html) can certainly be instantiated, and you would say that a `GtkWindow` is a `GtkWidget` (since `GtkWindow` is a subclass of `GtkWidget`).

Two types may not be compared by value; use [method@GLib.VariantType.equal] or [method@GLib.VariantType.is_subtype_of] May be copied using [method@GLib.VariantType.copy] and freed using [method@GLib.VariantType.free].

## GVariant Type Strings

A [type@GLib.Variant] type string can be any of the following:

  • any basic type string (listed below)
  • `v`, `r` or `*`
  • one of the characters `a` or `m`, followed by another type string
  • the character `(`, followed by a concatenation of zero or more other type strings, followed by the character `)`
  • the character `{`, followed by a basic type string (see below), followed by another type string, followed by the character `}`

A basic type string describes a basic type (as per [method@GLib.VariantType.is_basic]) and is always a single character in length. The valid basic type strings are `b`, `y`, `n`, `q`, `i`, `u`, `x`, `t`, `h`, `d`, `s`, `o`, `g` and `?`.

The above definition is recursive to arbitrary depth. `aaaaai` and `(ui(nq((y)))s)` are both valid type strings, as is `a(aa(ui)(qna{ya(yd)}))`. In order to not hit memory limits, [type@GLib.Variant] imposes a limit on recursion depth of 65 nested containers. This is the limit in the D-Bus specification (64) plus one to allow a [`GDBusMessage`](../gio/class.DBusMessage.html) to be nested in a top-level tuple.

The meaning of each of the characters is as follows:

  • `b`: the type string of `G_VARIANT_TYPE_BOOLEAN`; a boolean value.

  • `y`: the type string of `G_VARIANT_TYPE_BYTE`; a byte.

  • `n`: the type string of `G_VARIANT_TYPE_INT16`; a signed 16 bit integer.

  • `q`: the type string of `G_VARIANT_TYPE_UINT16`; an unsigned 16 bit integer.

  • `i`: the type string of `G_VARIANT_TYPE_INT32`; a signed 32 bit integer.

  • `u`: the type string of `G_VARIANT_TYPE_UINT32`; an unsigned 32 bit integer.

  • `x`: the type string of `G_VARIANT_TYPE_INT64`; a signed 64 bit integer.

  • `t`: the type string of `G_VARIANT_TYPE_UINT64`; an unsigned 64 bit integer.

  • `h`: the type string of `G_VARIANT_TYPE_HANDLE`; a signed 32 bit value that, by convention, is used as an index into an array of file descriptors that are sent alongside a D-Bus message.

  • `d`: the type string of `G_VARIANT_TYPE_DOUBLE`; a double precision floating point value.

  • `s`: the type string of `G_VARIANT_TYPE_STRING`; a string.

  • `o`: the type string of `G_VARIANT_TYPE_OBJECT_PATH`; a string in the form of a D-Bus object path.

  • `g`: the type string of `G_VARIANT_TYPE_SIGNATURE`; a string in the form of a D-Bus type signature.

  • `?`: the type string of `G_VARIANT_TYPE_BASIC`; an indefinite type that is a supertype of any of the basic types.

  • `v`: the type string of `G_VARIANT_TYPE_VARIANT`; a container type that contain any other type of value.

  • `a`: used as a prefix on another type string to mean an array of that type; the type string `ai`, for example, is the type of an array of signed 32-bit integers.

  • `m`: used as a prefix on another type string to mean a ‘maybe’, or ‘nullable’, version of that type; the type string `ms`, for example, is the type of a value that maybe contains a string, or maybe contains nothing.

  • `()`: used to enclose zero or more other concatenated type strings to create a tuple type; the type string `(is)`, for example, is the type of a pair of an integer and a string.

  • `r`: the type string of `G_VARIANT_TYPE_TUPLE`; an indefinite type that is a supertype of any tuple type, regardless of the number of items.

  • `{}`: used to enclose a basic type string concatenated with another type string to create a dictionary entry type, which usually appears inside of an array to form a dictionary; the type string `a{sd}`, for example, is the type of a dictionary that maps strings to double precision floating point values.

    The first type (the basic type) is the key type and the second type is the value type. The reason that the first type is restricted to being a basic type is so that it can easily be hashed.

  • `*`: the type string of `G_VARIANT_TYPE_ANY`; the indefinite type that is a supertype of all types. Note that, as with all type strings, this character represents exactly one type. It cannot be used inside of tuples to mean ‘any number of items’.

Any type string of a container that contains an indefinite type is, itself, an indefinite type. For example, the type string `a*` (corresponding to `G_VARIANT_TYPE_ARRAY`) is an indefinite type that is a supertype of every array type. `(*s)` is a supertype of all tuples that contain exactly two items where the second item is a string.

`a{?*}` is an indefinite type that is a supertype of all arrays containing dictionary entries where the key is any basic type and the value is any type at all. This is, by definition, a dictionary, so this type string corresponds to `G_VARIANT_TYPE_DICTIONARY`. Note that, due to the restriction that the key of a dictionary entry must be a basic type, `{**}` is not a valid type string.

func NewVariantType 

func NewVariantType(TypeStringVar string) *VariantType

Creates a new [type@GLib.VariantType] corresponding to the type string given by @type_string.

It is appropriate to call [method@GLib.VariantType.free] on the return value.

It is a programmer error to call this function with an invalid type string. Use [func@GLib.VariantType.string_is_valid] if you are unsure.

func NewVariantTypeArray 

func NewVariantTypeArray(ElementVar *VariantType) *VariantType

Constructs the type corresponding to an array of elements of the type @type.

It is appropriate to call [method@GLib.VariantType.first] on the return value.

func NewVariantTypeDictEntry 

func NewVariantTypeDictEntry(KeyVar *VariantType, ValueVar *VariantType) *VariantType

Constructs the type corresponding to a dictionary entry with a key of type @key and a value of type @value.

It is appropriate to call [method@GLib.VariantType.free] on the return value.

func NewVariantTypeMaybe 

func NewVariantTypeMaybe(ElementVar *VariantType) *VariantType

Constructs the type corresponding to a ‘maybe’ instance containing type @type or `Nothing`.

It is appropriate to call [method@GLib.VariantType.free] on the return value.

func NewVariantTypeTuple 

func NewVariantTypeTuple(ItemsVar uintptr, LengthVar int) *VariantType

Constructs a new tuple type, from @items.

@length is the number of items in @items, or `-1` to indicate that @items is `NULL`-terminated.

It is appropriate to call [method@GLib.VariantType.free] on the return value.

func VariantTypeChecked 

func VariantTypeChecked(TypeStringVar string) *VariantType

func (*VariantType) Copy 

func (x *VariantType) Copy() *VariantType

Makes a copy of a [type@GLib.VariantType].

It is appropriate to call [method@GLib.VariantType.free] on the return value. @type may not be `NULL`.

func (*VariantType) DupString 

func (x *VariantType) DupString() string

Returns a newly-allocated copy of the type string corresponding to @type.

The returned string is nul-terminated. It is appropriate to call [func@GLib.free] on the return value.

func (*VariantType) Element 

func (x *VariantType) Element() *VariantType

Determines the element type of an array or ‘maybe’ type.

This function may only be used with array or ‘maybe’ types.

func (*VariantType) Equal 

func (x *VariantType) Equal(Type2Var uintptr) bool

Compares @type1 and @type2 for equality.

Only returns true if the types are exactly equal. Even if one type is an indefinite type and the other is a subtype of it, false will be returned if they are not exactly equal. If you want to check for subtypes, use [method@GLib.VariantType.is_subtype_of].

The argument types of @type1 and @type2 are only `gconstpointer` to allow use with [type@GLib.HashTable] without function pointer casting. For both arguments, a valid [type@GLib.VariantType] must be provided.

func (*VariantType) First 

func (x *VariantType) First() *VariantType

Determines the first item type of a tuple or dictionary entry type.

This function may only be used with tuple or dictionary entry types, but must not be used with the generic tuple type `G_VARIANT_TYPE_TUPLE`.

In the case of a dictionary entry type, this returns the type of the key.

`NULL` is returned in case of @type being `G_VARIANT_TYPE_UNIT`.

This call, together with [method@GLib.VariantType.next] provides an iterator interface over tuple and dictionary entry types.

func (*VariantType) Free 

func (x *VariantType) Free()

Frees a [type@GLib.VariantType] that was allocated with [method@GLib.VariantType.copy], [ctor@GLib.VariantType.new] or one of the container type constructor functions.

In the case that @type is `NULL`, this function does nothing.

Since 2.24

func (*VariantType) GetStringLength 

func (x *VariantType) GetStringLength() uint

Returns the length of the type string corresponding to the given @type.

This function must be used to determine the valid extent of the memory region returned by [method@GLib.VariantType.peek_string].

func (*VariantType) GoPointer 

func (x *VariantType) GoPointer() uintptr

func (*VariantType) Hash 

func (x *VariantType) Hash() uint

Hashes @type.

The argument type of @type is only `gconstpointer` to allow use with [type@GLib.HashTable] without function pointer casting. A valid [type@GLib.VariantType] must be provided.

func (*VariantType) IsArray 

func (x *VariantType) IsArray() bool

Determines if the given @type is an array type.

This is true if the type string for @type starts with an `a`.

This function returns true for any indefinite type for which every definite subtype is an array type — `G_VARIANT_TYPE_ARRAY`, for example.

func (*VariantType) IsBasic 

func (x *VariantType) IsBasic() bool

Determines if the given @type is a basic type.

Basic types are booleans, bytes, integers, doubles, strings, object paths and signatures.

Only a basic type may be used as the key of a dictionary entry.

This function returns `FALSE` for all indefinite types except `G_VARIANT_TYPE_BASIC`.

func (*VariantType) IsContainer 

func (x *VariantType) IsContainer() bool

Determines if the given @type is a container type.

Container types are any array, maybe, tuple, or dictionary entry types plus the variant type.

This function returns true for any indefinite type for which every definite subtype is a container — `G_VARIANT_TYPE_ARRAY`, for example.

func (*VariantType) IsDefinite 

func (x *VariantType) IsDefinite() bool

Determines if the given @type is definite (ie: not indefinite).

A type is definite if its type string does not contain any indefinite type characters (`*`, `?`, or `r`).

A [type@GLib.Variant] instance may not have an indefinite type, so calling this function on the result of [method@GLib.Variant.get_type] will always result in true being returned. Calling this function on an indefinite type like `G_VARIANT_TYPE_ARRAY`, however, will result in `FALSE` being returned.

func (*VariantType) IsDictEntry 

func (x *VariantType) IsDictEntry() bool

Determines if the given @type is a dictionary entry type.

This is true if the type string for @type starts with a `{`.

This function returns true for any indefinite type for which every definite subtype is a dictionary entry type — `G_VARIANT_TYPE_DICT_ENTRY`, for example.

func (*VariantType) IsMaybe 

func (x *VariantType) IsMaybe() bool

Determines if the given @type is a ‘maybe’ type.

This is true if the type string for @type starts with an `m`.

This function returns true for any indefinite type for which every definite subtype is a ‘maybe’ type — `G_VARIANT_TYPE_MAYBE`, for example.

func (*VariantType) IsSubtypeOf 

func (x *VariantType) IsSubtypeOf(SupertypeVar *VariantType) bool

Checks if @type is a subtype of @supertype.

This function returns true if @type is a subtype of @supertype. All types are considered to be subtypes of themselves. Aside from that, only indefinite types can have subtypes.

func (*VariantType) IsTuple 

func (x *VariantType) IsTuple() bool

Determines if the given @type is a tuple type.

This is true if the type string for @type starts with a `(` or if @type is `G_VARIANT_TYPE_TUPLE`.

This function returns true for any indefinite type for which every definite subtype is a tuple type — `G_VARIANT_TYPE_TUPLE`, for example.

func (*VariantType) IsVariant 

func (x *VariantType) IsVariant() bool

Determines if the given @type is the variant type.

func (*VariantType) Key 

func (x *VariantType) Key() *VariantType

Determines the key type of a dictionary entry type.

This function may only be used with a dictionary entry type. Other than the additional restriction, this call is equivalent to [method@GLib.VariantType.first].

func (*VariantType) NItems 

func (x *VariantType) NItems() uint

Determines the number of items contained in a tuple or dictionary entry type.

This function may only be used with tuple or dictionary entry types, but must not be used with the generic tuple type `G_VARIANT_TYPE_TUPLE`.

In the case of a dictionary entry type, this function will always return `2`.

func (*VariantType) Next 

func (x *VariantType) Next() *VariantType

Determines the next item type of a tuple or dictionary entry type.

@type must be the result of a previous call to [method@GLib.VariantType.first] or [method@GLib.VariantType.next].

If called on the key type of a dictionary entry then this call returns the value type. If called on the value type of a dictionary entry then this call returns `NULL`.

For tuples, `NULL` is returned when @type is the last item in the tuple.

func (*VariantType) PeekString 

func (x *VariantType) PeekString() string

Returns the type string corresponding to the given @type.

The result is not nul-terminated; in order to determine its length you must call [method@GLib.VariantType.get_string_length].

To get a nul-terminated string, see [method@GLib.VariantType.dup_string].

func (*VariantType) Value 

func (x *VariantType) Value() *VariantType

Determines the value type of a dictionary entry type.

This function may only be used with a dictionary entry type.

type VoidFunc 

type VoidFunc func()

Declares a type of function which takes no arguments and has no return value. It is used to specify the type function passed to g_atexit().

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.