GLib

Description:

Content:

Namespaces:

Classes:

MainLoop - The `GMainLoop` struct is an opaque data type representing the main event loop of a GLib or GTK+ application.
MainContext - The `GMainContext` struct is an opaque data type representing a set of sources to be handled in a main loop.
TimeoutSource -
IdleSource -
ChildWatchSource -
Source -
SourceCallbackFuncs - The `GSourceCallbackFuncs` struct contains functions for managing callback objects.
Thread - The Thread struct represents a running thread.
Mutex - The Mutex struct is an opaque data structure to represent a mutex (mutual exclusion).
Private -
Cond - The Cond struct is an opaque data structure that represents a condition.
ThreadPool - The ThreadPool struct represents a thread pool.
AsyncQueue - The GAsyncQueue struct is an opaque data structure which represents an asynchronous queue.
MemVTable - A set of functions used to perform memory allocation.
IOChannel - A data structure representing an IO Channel.
IOSource -
Error - The `GError` structure contains information about an error that has occurred.
Checksum - An opaque structure representing a checksumming operation.
Hmac - An opaque structure representing a HMAC operation.
DateTime - `GDateTime` is an opaque structure whose members cannot be accessed directly.
TimeZone - TimeZone is an opaque structure whose members cannot be accessed directly.
Rand - The GRand struct is an opaque data structure.
Scanner - The data structure representing a lexical scanner.
Completion -
Timer - Opaque datatype that records a start time.
FileStream -
Dir - An opaque structure representing an opened directory.
MappedFile - The MappedFile represents a file mapping created with MappedFile.
OptionContext - A `GOptionContext` struct defines which options are accepted by the commandline option parser.
OptionGroup - A `GOptionGroup` struct defines the options in a single group.
Regex - The g_regex_*() functions implement regular expression pattern matching using syntax and semantics similar to Perl regular expression.
MatchInfo - A GMatchInfo is an opaque struct used to return information about matches.
MarkupParseContext - A parse context is used to parse a stream of bytes that you expect to contain marked-up text.
KeyFile - The GKeyFile struct contains only private data and should not be accessed directly.
BookmarkFile - The `GBookmarkFile` structure contains only private data and should not be directly accessed.
TestCase - An opaque structure representing a test case.
TestSuite - An opaque structure representing a test suite.
List - The List struct is used for each element in a doubly-linked list.
SList - The SList struct is used for each element in the singly-linked list.
Queue - Contains the public fields of a Queue.
Sequence - The Sequence struct is an opaque data type representing a sequence data type.
SequenceIter - The SequenceIter struct is an opaque data type representing an iterator pointing into a Sequence.
HashTable -
GenericSet - The GenericSet struct is an opaque data structure to represent a Hash Table.
StringBuilder - The GString struct contains the public fields of a GString.
StringChunk - An opaque data structure representing String Chunks.
PtrArray -
GenericArray - Contains the public fields of a pointer array.
Bytes - A simple refcounted data type representing an immutable sequence of zero or more bytes from an unspecified origin.
ByteArray - Contains the public fields of a GByteArray.
Node - The Node struct represents one node in a n-ary tree.
Array - Contains the public fields of a GArray.
Tree - The GTree struct is an opaque data structure representing a balanced binary tree.
PatternSpec - A GPatternSpec struct is the 'compiled' form of a pattern.
VariantType - This section introduces the GVariant type system.
Variant - Variant is a variant datatype; it stores a value along with information about the type of that value.
VariantIter - VariantIter is an opaque data structure and can only be accessed using the following functions.
VariantBuilder - A utility type for constructing container-type Variant instances.
VariantDict - VariantDict is a mutable interface to Variant dictionaries.
ObjectPath -
BusName -

Structs:

Pid - A type which is used to hold a process identification.
PollFD - Represents a file descriptor, which events to poll for, and which events occurred.
SourceFuncs - The `GSourceFuncs` struct contains a table of functions used to handle event sources in a generic manner.
RecMutex - The GRecMutex struct is an opaque data structure to represent a recursive mutex.
RWLock - The GRWLock struct is an opaque data structure to represent a reader-writer lock.
StaticMutex -
StaticRecMutex -
StaticRWLock -
StaticPrivate -
Once - A Once struct controls a one-time initialization function.
DebugKey - Associates a string with a bit flag.
IConv - The GIConv struct wraps an iconv conversion descriptor.
TimeVal - Represents a precise time, with seconds and microseconds.
DateDay - Integer representing a day of the month; between 1 and 31.
DateYear - Integer representing a year; BAD_YEAR is the invalid value.
Date - Represents a day between January 1, Year 1 and a few thousand years in the future.
Time -
TimeSpan - A value representing an interval of time, in microseconds.
ScannerConfig - Specifies the Scanner parser configuration.
TokenValue - A union holding the value of the token.
UTimBuf -
Stat -
OptionEntry - A GOptionEntry struct defines a single option.
MarkupParser - Any of the fields in MarkupParser can be null, in which case they will be ignored.
HashTableIter -
GenericSetIter - A GHashTableIter structure represents an iterator that can be used to iterate over the elements of a GenericSet.
Quark - A GQuark is a non-zero integer which uniquely identifies a particular string.
Datalist -

Enums:

ByteOrder -
ThreadPriority -
OnceStatus - The possible statuses of a one-time initialization function controlled by a Once struct.
SliceConfig -
SeekType - An enumeration specifying the base position for a seek_position operation.
IOStatus - Stati returned by most of the IOFuncs functions.
IOCondition - A bitwise combination representing a condition to watch for on an event source.
IOFlags - Specifies properties of a IOChannel.
LogLevelFlags - Flags specifying the level of log messages.
ChecksumType - The hashing algorithm to be used by Checksum when performing the digest of some data.
DateMonth - Enumeration representing a month; values are JANUARY, FEBRUARY , etc.
DateWeekday - Enumeration representing a day of the week; MONDAY, TUESDAY, etc.
DateDMY - 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.
TimeType - Disambiguates a given time in two ways.
UserDirectory - These are logical ids for special directories which are defined depending on the platform used.
FormatSizeFlags - Flags to modify the format of the string returned by format_size.
TokenType - The possible types of token returned from each get_next_token call.
ErrorType - The possible errors, used in the v_error field of TokenValue, when the token is a g_token_error.
SpawnFlags - Flags passed to spawn_sync, spawn_async and spawn_async_with_pipes.
ProcessSignal -
FileTest - A test to perform on a file using test.
FileSeek -
OptionArg - The OptionArg enum values determine which type of extra argument the options expect to find.
OptionFlags - Flags which modify individual options.
RegexCompileFlags - Flags specifying compile-time options.
RegexMatchFlags - Flags specifying match-time options.
MarkupParseFlags - Flags that affect the behaviour of the parser.
KeyFileFlags - Flags which influence the parsing.
TestSubprocessFlags - Flags to pass to trap_subprocess to control input and output.
TestTrapFlags - Test traps are guards around forked tests.
TraverseFlags - Specifies which nodes are visited during several of the tree functions, including traverse and find.
TraverseType - Specifies the type of traveral performed by g_tree_traverse, traverse and find.
LocaleCategory -
UnicodeScript - The UnicodeScript enumeration identifies different writing systems.
UnicodeType - These are the possible character classifications from the Unicode specification.
UnicodeBreakType - These are the possible line break classifications.
NormalizeMode - 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.

Error domains:

ThreadError - Possible errors of thread related functions.
IOChannelError - Error codes returned by IOChannel operations.
ConvertError - Error codes returned by character set conversion routines.
SpawnError - Error codes returned by spawning processes.
FileError - Values corresponding to errno codes returned from file operations on UNIX.
ShellError - Error codes returned by shell functions.
OptionError - Error codes returned by option parsing.
RegexError - Error codes returned by regular expressions functions.
MarkupError - Error codes returned by markup parsing.
KeyFileError - Error codes returned by key file parsing.
BookmarkFileError - Error codes returned by bookmark file parsing.
VariantParseError - Error codes returned by parsing text-format GVariants.

Constants:

public const ByteOrder BYTE_ORDER

Delegates:

public delegate int PollFunc (PollFD[] ufds, int timeout_)
Specifies the type of function passed to set_poll_func.
public delegate void ChildWatchFunc (Pid pid, int status)
Prototype of a GChildWatchSource callback, called when a child process has exited.
public delegate void SourceDummyMarshal ()
This is just a placeholder for ClosureMarshal, which cannot be used here for dependency reasons.
public delegate bool SourcePrepareFunc (Source source, out int timeout_)
public delegate bool SourceCheckFunc (Source source)
public delegate bool SourceDispatchFunc (Source source, SourceFunc _callback)
public delegate void SourceFinalizeFunc (Source source)
public delegate void SourceCallbackRefFunc (void* cb_data)
public delegate void SourceCallbackUnrefFunc (void* cb_data)
public delegate void SourceCallbackGetFunc (void* cb_data, Source source, SourceFunc func)
public delegate bool SourceFunc ()
Specifies the type of function passed to g_timeout_add, add_full, g_idle_add, and add_full.
public delegate G ThreadFunc ()
public delegate void Func (G data)
public delegate G OnceFunc ()
Specifies the type of the func functions passed to g_thread_new or g_thread_try_new.
public delegate void ThreadPoolFunc (owned G data)
Specifies the type of functions passed to @foreach and @foreach.
public delegate bool IOFunc (IOChannel source, IOCondition condition)
Specifies the type of function passed to add_watch or add_watch_full, which is called when the requested condition on a IOChannel is satisfied.
public delegate void PrintFunc (string text)
Specifies the type of the print handler functions.
public delegate void LogFunc (string? log_domain, LogLevelFlags log_levels, string message)
Specifies the prototype of log handler functions.
public delegate void FreeFunc (void* data)
Declares a type of function which takes an arbitrary data pointer argument and has no return value.
public delegate void VoidFunc ()
Declares a type of function which takes no arguments and has no return value.
public delegate void ScannerMsgFunc (Scanner scanner, string message, bool error)
Specifies the type of the message handler function.
public delegate string CompletionFunc (void* item)
public delegate int CompletionStrncmpFunc (string s1, string s2, size_t n)
public delegate void SpawnChildSetupFunc ()
Specifies the type of the setup function passed to spawn_async, spawn_sync and spawn_async_with_pipes, which can, in very limited ways, be used to affect the child's execution.
public delegate void SignalHandlerFunc (int signum)
public delegate unowned string TranslateFunc (string str)
The type of functions which are used to translate user-visible strings, for <option>--help</option> output.
public delegate bool OptionParseFunc (OptionContext context, OptionGroup group, void* data) throws OptionError
The type of function that can be called before and after parsing.
public delegate void OptionErrorFunc (OptionContext context, OptionGroup group, void* data, ref Error error)
The type of function to be used as callback when a parse error occurs.
public delegate bool RegexEvalCallback (MatchInfo match_info, StringBuilder result)
Specifies the type of the function passed to replace_eval.
public delegate void MarkupParserStartElementFunc (MarkupParseContext context, string element_name, string[] attribute_names, string[] attribute_values) throws MarkupError
public delegate void MarkupParserEndElementFunc (MarkupParseContext context, string element_name) throws MarkupError
public delegate void MarkupParserTextFunc (MarkupParseContext context, string text, size_t text_len) throws MarkupError
public delegate void MarkupParserPassthroughFunc (MarkupParseContext context, string passthrough_text, size_t text_len) throws MarkupError
public delegate void MarkupParserErrorFunc (MarkupParseContext context, Error error)
public delegate bool LogFatalFunc (string? log_domain, LogLevelFlags log_levels, string message)
public delegate void TestFunc (void* fixture)
The type used for test case functions.
public delegate void TestDataFunc ()
The type used for test case functions that take an extra pointer argument.
public delegate int CompareFunc (G a, G b)
public delegate int CompareDataFunc (G a, G b)
Specifies the type of a comparison function used to compare two values.
public delegate int SearchFunc (G a, T b)
Specifies the type of a comparison function used to compare two values.
public delegate int SequenceIterCompareFunc (SequenceIter<G> a, SequenceIter<G> b)
A SequenceIterCompareFunc is a function used to compare iterators.
public delegate uint HashFunc (K key)
Specifies the type of the hash function which is passed to g_hash_table_new when a GenericSet is created.
public delegate bool EqualFunc (G a, G b)
Specifies the type of a function used to test two values for equality.
public delegate void HFunc (K key, V value)
Specifies the type of the function passed to for_each.
public delegate bool HRFunc (K key, V value)
Specifies the type of the function passed to foreach_remove.
public delegate void DestroyNotify (void* data)
Specifies the type of function which is called when a data element is destroyed.
public delegate bool NodeTraverseFunc (Node node)
Specifies the type of function passed to traverse.
public delegate void NodeForeachFunc (Node node)
Specifies the type of function passed to children_foreach.
public delegate void DataForeachFunc (Quark key_id, G data)
Specifies the type of function passed to g_dataset_foreach.
public delegate bool TraverseFunc (K key, V value)
Specifies the type of function passed to g_tree_traverse.
public delegate int TreeSearchFunc (K key)

Functions:

public uint get_num_processors ()
Determine the approximate number of threads that the system will schedule simultaneously for this process.
public void* malloc (size_t n_bytes)
Allocates n_bytes bytes of memory.
public void* malloc0 (size_t n_bytes)
Allocates n_bytes bytes of memory, initialized to 0's.
public void* realloc (void* mem, size_t n_bytes)
Reallocates the memory pointed to by mem, so that it now has space for n_bytes bytes of memory.
public void* try_malloc (size_t n_bytes)
Attempts to allocate n_bytes, and returns null on failure.
public void* try_malloc0 (size_t n_bytes)
Attempts to allocate n_bytes, initialized to 0's, and returns null on failure.
public void* try_realloc (void* mem, size_t n_bytes)
Attempts to realloc mem to a new size, n_bytes, and returns null on failure.
public void free (void* mem)
public void mem_set_vtable (MemVTable vtable)
Sets the MemVTable to use for memory allocation.
public void mem_profile ()
Outputs a summary of memory usage.
public void print (string format, ...)
Outputs a formatted message via the print handler.
public void set_print_handler (PrintFunc func)
Sets the print handler.
public void printerr (string format, ...)
Outputs a formatted message via the error message handler.
public void set_printerr_handler (PrintFunc func)
Sets the handler for printing error messages.
public void return_if_fail (bool expr)
public void return_val_if_fail (bool expr, ...)
public void return_if_reached ()
public void return_val_if_reached (...)
public void warn_if_fail (bool expr)
public void warn_if_reached ()
public void assert (bool expr)
public void assert_false (bool expr)
public void assert_true (bool expr)
public void assert_null (void* expr)
public void assert_nonnull (void* expr)
public void assert_not_reached ()
public void on_error_query (string? prg_name = null)
Prompts the user with `[E]xit, [H]alt, show [S]tack trace or [P] roceed`.
public void on_error_stack_trace (string? prg_name = null)
Invokes gdb, which attaches to the current process and shows a stack trace.
public void breakpoint ()
public void logv (string? log_domain, LogLevelFlags log_level, string format, va_list args)
Logs an error or debugging message.
public void log (string? log_domain, LogLevelFlags log_level, string format, ...)
Logs an error or debugging message.
public void message (string format, ...)
public void warning (string format, ...)
public void critical (string format, ...)
public void error (string format, ...)
public void debug (string format, ...)
public void info (string format, ...)
public uint parse_debug_string (string? debug_string, DebugKey[] keys)
Parses a string containing debugging options into a guint containing bit flags.
public void strfreev (unowned string** str_array)
Frees a null-terminated array of strings, and the array itself.
public uint strv_length (string[] str_array)
Returns the length of the given null-terminated string array str_array.
public bool strv_contains (string[] str_array, string str)
public unowned string strerror (int errnum)
Returns a string corresponding to the given error code, e.
public string convert (string str, ssize_t len, string to_codeset, string from_codeset, out size_t bytes_read = null, out size_t bytes_written = null) throws ConvertError
Converts a string from one character set to another.
public bool get_charset (out string charset)
Obtains the character set for the current locale; you might use this character set as an argument to convert, to convert from the current locale's encoding to some other encoding.
public bool get_filename_charsets (out string[] charsets)
Determines the preferred character sets used for filenames.
public int64 get_monotonic_time ()
Queries the system monotonic time.
public int64 get_real_time ()
Queries the system wall-clock time.
public string format_size_for_display (int64 size)
Formats a size (for example the size of a file) into a human readable string.
public string format_size (uint64 size, FormatSizeFlags flags = DEFAULT)
Formats a size.
public unowned string strsignal (int signum)
Returns a string describing the given signal, e.
public unowned string _ (string str)
public unowned string Q_ (string str)
public unowned string N_ (string str)
public unowned string C_ (string context, string str)
public unowned string NC_ (string context, string str)
public unowned string ngettext (string msgid, string msgid_plural, ulong n)
public unowned string dgettext (string? domain, string msgid)
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.
public unowned string dcgettext (string? domain, string msgid, int category)
This is a variant of dgettext that allows specifying a locale category instead of always using `LC_MESSAGES`.
public unowned string dngettext (string? domain, string msgid, string msgid_plural, ulong n)
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.
public unowned string dpgettext (string? domain, string msgctxid, size_t msgidoffset)
This function is a variant of dgettext which supports a disambiguating message context.
public unowned string dpgettext2 (string? domain, string context, string msgid)
This function is a variant of dgettext which supports a disambiguating message context.
public bool likely (bool expression)
public bool unlikely (bool expression)
public void static_assert (bool expression)
public void qsort_with_data<T> (T[] elems, size_t size, CompareDataFunc<T> compare_func)

Fields:

public MemVTable mem_profiler_table
public int errno
public FileStream stdin
public FileStream stdout
public FileStream stderr
public CompareFunc<string> strcmp
Compares str1 and str2 like strcmp.
public HashFunc<void*> direct_hash
Converts a gpointer to a hash value.
public EqualFunc<void*> direct_equal
Compares two gpointer arguments and returns true if they are equal.
public HashFunc<int64?> int64_hash
Converts a pointer to a int64 to a hash value.
public EqualFunc<int64?> int64_equal
Compares the two int64 values being pointed to and returns true if they are equal.
public HashFunc<int?> int_hash
Converts a pointer to a int to a hash value.
public EqualFunc<int?> int_equal
Compares the two int values being pointed to and returns true if they are equal.
public HashFunc<string> str_hash
Converts a string to a hash value.
public EqualFunc<string> str_equal
Compares two strings for byte-by-byte equality and returns true if they are equal.
public DestroyNotify g_free
Frees the memory pointed to by mem.
public DestroyNotify g_object_unref
public DestroyNotify g_list_free
public DestroyNotify g_variant_unref