GimpScanner

GimpScanner — A wrapper around GScanner with some convenience API.

Functions

Object Hierarchy

    GBoxed
    ╰── GimpScanner

Description

A wrapper around GScanner with some convenience API.

Functions

gimp_scanner_new_file ()

GimpScanner *
gimp_scanner_new_file (GFile *file,
                       GError **error);

Parameters

file

a GFile

 

error

return location for GError, or NULL

 

Returns

The new GimpScanner.

[transfer full]

Since: 2.10


gimp_scanner_new_stream ()

GimpScanner *
gimp_scanner_new_stream (GInputStream *input,
                         GError **error);

Parameters

input

a GInputStream

 

error

return location for GError, or NULL

 

Returns

The new GimpScanner.

[transfer full]

Since: 2.10


gimp_scanner_new_string ()

GimpScanner *
gimp_scanner_new_string (const gchar *text,
                         gint text_len,
                         GError **error);

Parameters

text

.

[array length=text_len]

text_len

The length of text , or -1 if NULL-terminated

 

error

return location for GError, or NULL

 

Returns

The new GimpScanner.

[transfer full]

Since: 2.4


gimp_scanner_ref ()

GimpScanner *
gimp_scanner_ref (GimpScanner *scanner);

Adds a reference to a GimpScanner.

Parameters

scanner

GimpScanner to ref

 

Returns

the same scanner .

Since: 3.0


gimp_scanner_unref ()

void
gimp_scanner_unref (GimpScanner *scanner);

Unref a GimpScanner. If the reference count drops to zero, the scanner is freed.

Parameters

Since: 3.0


gimp_scanner_parse_token ()

gboolean
gimp_scanner_parse_token (GimpScanner *scanner,
                          GTokenType token);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

token

the GTokenType expected as next token.

 

Returns

TRUE if the next token is token , FALSE otherwise.

Since: 2.4


gimp_scanner_parse_identifier ()

gboolean
gimp_scanner_parse_identifier (GimpScanner *scanner,
                               const gchar *identifier);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

identifier

the expected identifier.

[out]

Returns

TRUE if the next token is an identifier and if its value matches identifier .

Since: 2.4


gimp_scanner_parse_string ()

gboolean
gimp_scanner_parse_string (GimpScanner *scanner,
                           gchar **dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Return location for the parsed string.

[out]

Returns

TRUE on success

Since: 2.4


gimp_scanner_parse_string_no_validate ()

gboolean
gimp_scanner_parse_string_no_validate (GimpScanner *scanner,
                                       gchar **dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Return location for the parsed string.

[out]

Returns

TRUE on success

Since: 2.4


gimp_scanner_parse_data ()

gboolean
gimp_scanner_parse_data (GimpScanner *scanner,
                         gint length,
                         guint8 **dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

length

Length of the data to parse

 

dest

Return location for the parsed data.

[out][array]

Returns

TRUE on success

Since: 2.4


gimp_scanner_parse_int ()

gboolean
gimp_scanner_parse_int (GimpScanner *scanner,
                        gint *dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Return location for the parsed integer.

[out]

Returns

TRUE on success

Since: 2.4


gimp_scanner_parse_int64 ()

gboolean
gimp_scanner_parse_int64 (GimpScanner *scanner,
                          gint64 *dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Return location for the parsed integer.

[out]

Returns

TRUE on success

Since: 2.8


gimp_scanner_parse_float ()

gboolean
gimp_scanner_parse_float (GimpScanner *scanner,
                          gdouble *dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Return location for the parsed float.

[out]

Returns

TRUE on success

Since: 2.4


gimp_scanner_parse_boolean ()

gboolean
gimp_scanner_parse_boolean (GimpScanner *scanner,
                            gboolean *dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Return location for the parsed boolean.

[out]

Returns

TRUE on success

Since: 2.4


gimp_scanner_parse_color ()

gboolean
gimp_scanner_parse_color (GimpScanner *scanner,
                          GimpRGB *dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Pointer to a color to store the result.

[out caller-allocates]

Returns

TRUE on success

Since: 2.4


gimp_scanner_parse_matrix2 ()

gboolean
gimp_scanner_parse_matrix2 (GimpScanner *scanner,
                            GimpMatrix2 *dest);

Parameters

scanner

A GimpScanner created by gimp_scanner_new_file() or gimp_scanner_new_string()

 

dest

Pointer to a matrix to store the result

 

Returns

TRUE on success

Since: 2.4