scanner: methods cannot have an out-arg as their first arg

This ensures that if the first argument of a function like

  gboolean gdk_rgba_parse (GdkRGBA *rgba, const gchar *spec);

is annotated as being an out-arg, the result is a class function with two
arguments, not a method with one argument.  Previously, the (out) annotation
was simply ignored.

https://bugzilla.gnome.org/show_bug.cgi?id=682124

Post-release version bump

gimarshallingtests: Add GParamSpec return and (out) argument

https://bugzilla.gnome.org/show_bug.cgi?id=681565

Co-Authored-By: Martin Pitt <martinpitt@gnome.org>

girffi: Fix g_callable_info_prepare_closure for certain callables

Namely, those that are methods and those that throw GErrors.
We have very similar code in two places that calculate arg lengths and
argument types to stick into libffi. Merge, clean up, and correct both.

https://bugzilla.gnome.org/show_bug.cgi?id=673805

gicallableinfo: Add two new convenience methods: is_method and can_throw_gerror

https://bugzilla.gnome.org/show_bug.cgi?id=673805

Release 1.33.9

Update annotations from glib git

Makefile.introspection: Add gir dependency to example

build: Ensure cairo-gobject always ends up in cairo.gir

We were conditionalizing on the presence of cairo in the buildroot,
but that's super lame since it makes a huge mess of the build
dependency graph.

Let's just always stick cairo-gobject in there.  I doubt anyone cares
anymore about building g-i on really old systems without it.

If they do...well, we can revisit this again.

Revert "Implement "rename to" annotation for records"

This reverts commit 764366f7e4ef5a765a24ffac8c60b811f38b9ad9.

It can't work right now because to really use the structures, you need
to register them as a boxed, and that means we also need to rename the
boxed type.

A future version of this patch will need to handle both the structure
name and the GType name.

https://bugzilla.gnome.org/show_bug.cgi?id=675985

tests: Fix coding style and compiler warning in regress

Previous commit used old-style declarations which was broken.

Test typedef in #define

requires "handle unsigned properly for type of defined size" patch.

scanner: handle unsigned properly for type of defined size

giscanner: special case G_GINT64_CONSTANT and G_GUINT64_CONSTANT + misc

This let the macro expands to its value as gint64/guint64.

Also
- fix lexer identifier/typdef detection for macro and misc

- do not discard cast

gimarshallingtests: More useful assertions

Convert the simple g_assert() statements into g_assert_cmp*, to show what the
actual value is in case of a failure. This makes it easier to port
g-i/pygobject/etc. to new architectures which exhibit bugs, like powerpc64.

Regress: Update expected gir for previous changes

gimarshallingtests: Squash compiler warning

tests: Fix comment about expected result

Implement "rename to" annotation for records

https://bugzilla.gnome.org/show_bug.cgi?id=675985
Moving the early annotation pass is needed to avoid
the first type resolve pass to resolve to the not-renamed type.

Add test for "rename to" annotation for records

https://bugzilla.gnome.org/show_bug.cgi?id=675985

regress: Use G_DEFINE_INTERFACE

https://bugzilla.gnome.org/show_bug.cgi?id=679981

regress: Fix regress_test_versioning

https://bugzilla.gnome.org/show_bug.cgi?id=679981

Release 1.33.4

Update annotations from glib git

Update glib annotations from git

GIMarshallingTests: Add method taking array of variants

Add a new interface GIMarshallingTestsInterface3 with a method that takes an
array of variants as argument. This can be used for testing the passing of
array of variants from C to introspection clients, which is not otherwise
covered in the tests for arrays of variants.

https://bugzilla.gnome.org/show_bug.cgi?id=667244

Signed-off-by: Martin Pitt <martinpitt@gnome.org>

Fix GI_MARSHALLING_TESTS_INTERFACE2_GET_IFACE() definition

This used the non-existing G_TYPE_INSTANCE_GET_INTERFACE2 macro, likely a
copy&paste error.

Update glib annotations from git

scanner: support stability tag

https://bugzilla.gnome.org/show_bug.cgi?id=679160

scanner: Ensure "complete_ctype" patch doesn't throw an exception for anonymous unions

The previous patch introduced a regression where we would crash on
encountering an anonymous union.  Work around this by just writing out
'gpointer' in this case, and add a regression test.

giscanner: Write detailed information in "type" tag's "c:type" attribute.

That is - write also type qualifiers (const and volatile here). Update
existing tests and add a new struct to regress.h having members with
type qualifiers.

https://bugzilla.gnome.org/show_bug.cgi?id=656445

scanner: Turn dead code into assertion

https://bugzilla.gnome.org/show_bug.cgi?id=656445

giscanner: Fix pointer parsing.

They were parsed in wrong order resulting in having wrong pointer
being const. For example - g_settings_list_schemas return type is
normally 'const gchar *const *', but parsing result was
'const gchar ** const'.

This was unnoticed, because pointer constness information is rather
not used by gobject-introspection now.

https://bugzilla.gnome.org/show_bug.cgi?id=656445

tests: Ignore SLetter generated gir.

https://bugzilla.gnome.org/show_bug.cgi?id=656445

Maintransfomer: fix again paring error domains with unregistered enums

Previous fix was wrong, as it called to_underscores_noprefix on a
prefixed type name. The actual fix is to call the transformer to
do the prefix / type_name split, and turn the latter to underscores.
Test case included.

https://bugzilla.gnome.org/show_bug.cgi?id=634202

Add missing SLetter expected gir

tests: Add GSpawnError-alike to SLetter

See https://bugzilla.gnome.org/show_bug.cgi?id=637025 for motivation.

tests: Add SLetter

This test case has a single-letter symbol prefix, which triggers
edge cases in the difference between prefix handling.

See https://bugzilla.gnome.org/show_bug.cgi?id=637025

Fix build

scanner: Remove properties

We don't need a basic getter for a private field - this isn't Java.

scanner: Don't use an O(N) lookup when we already have a hashmap

This is a general code cleanup.

fix GIArgument being exported as _Argument in .gir

https://bugzilla.gnome.org/show_bug.cgi?id=635128

Revert scanner fix in 64f3832

This is incorrect -- the type name that's passed to the function
should contain a prefix. This fixes error domains for GLib errors.
Don't revert doc changes or test additions.

Release 1.33.3

Update glib annotations from git

scanner: complete the enum-to-error-quark fix

Turns out that the problem was not only in the wrong matching
to GType enums, but also that the non-GType heuristics used
to_underscores instead of to_underscores_noprefix, turning DBusError
into D_Bus_Error instead of DBus_Error.
Complete with various tests.

https://bugzilla.gnome.org/show_bug.cgi?id=669350

scanner: fix pairing of error quarks with registered enums

_uscore_type_names maps from the c_symbol_prefix, which has the
global ns prefix removed, so we need to split the function symbol
before the lookup. Previously it worked because it used the heuristics
for unregistered enums (and failed for GDBusError, which has two
uppercase letters in succession)

https://bugzilla.gnome.org/show_bug.cgi?id=669350

Release 1.33.2

Update annotations to glib 2.33.2

tests: Add marshalling test for a boxed struct property

Also make the _copy()/_free() methods for GIMarshallingTestsBoxedStruct get
along with NULL values.

https://bugzilla.gnome.org/show_bug.cgi?id=676603

tests: Add a refcounting boxed

https://bugzilla.gnome.org/show_bug.cgi?id=677249

tests: Add vfunc taking a caller-allocated out parameter

This reproduces
https://bugzilla.gnome.org/show_bug.cgi?id=653151

tests: Add marshalling test for a caller-allocated out GValue parameter

This came up as a side issue in
https://bugzilla.gnome.org/show_bug.cgi?id=653151

scanner: allow for functions that look like constructors but aren't

If the scanner found a function with _new in its name, but not
prefixed by the name of a known type, it would assume that the
function was a constructor, and then complain that it couldn't figure
out what it was a constructor for, and mark it introspectable=0.

Instead, just assume that the function is not actually a constructor
in that case (unless it's explicitly tagged as such).

https://bugzilla.gnome.org/show_bug.cgi?id=676815

givfuncinfo: Fix memory leak

The field info wasn't being freed after it was used

tests: Fix a memory leak

We need to unref the cairo surface here, as we are making the context
be the sole owner of it.

https://bugzilla.gnome.org/show_bug.cgi?id=671687

tests: Add a foreign struct signal test

https://bugzilla.gnome.org/show_bug.cgi?id=671687

tests: Fix warnings

https://bugzilla.gnome.org/show_bug.cgi?id=671687

Update annotations

Update glib annotations from git

girepository: avoid crash when querying nonexistent info

It appears that cmph library can return (n+1) when querying item not
present in its original n-item-sized set.  Adjust code so that it
detects this condition and do not chase stray pointers resulting from
this bogus(?) hash result.

https://bugzilla.gnome.org/show_bug.cgi?id=675939

GIMarshallingTests: Add GStrv property

Fix regress_test_closure_variant return value

We need to g_variant_ref() the return type: the closure delivers it wrapped
in a GValue, and the subsequent g_value_unset() unrefs it to zero otherwise.

This was uncovered by the now working TestClosures.test_variant() test case in
PyGObject.

Also allow passing NULL as argument, to be able to test these code paths as
well.

Update glib annotations to 2.33.1

Add the fixed width C99 types from stdint.h

C99 has standard types for fixed width signed and unsigned integers.
This adds types to giscanner to map them to the glib equivalent types.

stdint.h also has other types to specify specify sizes with at least a
certain number of bits, the fastest type with at least some number of
bits, a type big enough to store a pointer and a type containing the
most number of bits. These don't map well to glib types so I have
ignored them.

https://bugzilla.gnome.org/show_bug.cgi?id=674796

Fix GVariant handling in regress_test_closure_variant

Commit 7c4fbbd6 introduced some low-level g_memdup()ing of the passed GVariant
in regress_test_closure_variant(). This causes a race condition with GI clients
like pygobject's test suite, which sometimes fail with

  (runtests.py:15653): GLib-CRITICAL **: g_variant_ref_sink: assertion `value->ref_count > 0' failed

Drop the memduping again, and instead make the argument non-const (which is
true, as the method temporarily increases the refcount).

g-ir-doc-tool: Update expected file

Should have signal arguments in the right order

Update glib annotations from git

configure: Update to 1.33.0

tests: Add flags and enum to GValue GHash in/out

Add a flag and enum check to
the GHashes returned/expected by regress_test_ghash_gvalue_{return,in}().

https://bugzilla.gnome.org/show_bug.cgi?id=637466

tests: Add array marshalling test for array without length argument

A test case with an array in-argument that is neither zero terminated,
nor fixed length, nor blessed with a length argument.

This is, for example, the case in clutter_texture_set_from_rgb_data()

https://bugzilla.gnome.org/show_bug.cgi?id=674271

Signed-off-by: Martin Pitt <martinpitt@gnome.org>

tests: Add GType property TestObj:gtype

Needed for https://bugzilla.gnome.org/show_bug.cgi?id=674351

https://bugzilla.gnome.org/show_bug.cgi?id=674366

Signed-off-by: Martin Pitt <martinpitt@gnome.org>

Update Gio/GLib/GObject annotations

Ran misc/update-glib-annotations.py against current glib master.

annotationparser: add test for comment lines not starting with ' * '

https://bugzilla.gnome.org/show_bug.cgi?id=673806

annotationparser: cleanup and add tests for the new warnings we now emit

Including:
- handle things in the logical order encountered (first colon,
  then annotations)
- correctly report column when missing a colon on the identifier part
- small type fixes
- remove no longer useful "parameter/tag expected" warnings

warningtester: make it possible to EXPECT multiple lines of output

Revert "annotationparser: indent _parse_comment_block gtkdoc code"

This reverts commit f41525d54f53edd9b0d665397f7c6c755ee3616b and
adds a more complete solution as the original commit only handled
empty lines between the GTK-Doc comment block start token "/**" and
the identifier.

https://bugzilla.gnome.org/show_bug.cgi?id=673806

update-glib-annotations: Set required environment variables

Assume srcdir=builddir, so users don't have to set this.

annotationparser: indent _parse_comment_block gtkdoc code

The current logic in _parse_comment_block of the annotationparser
check the identifier and use variables that only makes sense if a
result was returned (column_offset, original_line). This patch
indent the logic so it is only triggered if a result is found.
Otherwise it returns None as expected by call chain
"parse >  parse_comment_block > _parse_comment_block":
ie in "parse":
   comment_block = self.parse_comment_block(comment)
   if comment_block is not None:

This still raises a lot of warnings but does not abort while generating
gir for libgnomekbd, mutter or telepathy-glib (those thus have to be
tweaked not to call g-ir-scanner with --warn-error at least until the
parser mask those false positives or the doc from those projects is
fixed to comply with the behaviour expected by giscanner).

https://bugzilla.gnome.org/show_bug.cgi?id=673806

Move libffi and gmodule to Requires.private in .pc files

The intention of the change is to clean up unnecessary linking with
libffi and gmodule in g-i consumers as they typically don't use any
libffi/gmodule symbols.

Listing libffi and gmodule in pkg-config Requires meant that every
consumer that wanted to link with -lgirepository also got -lffi and
-lgmodule-2.0, which caused ld to emit unnecessary DT_NEEDED entries.

Moving the deps to Requires.private removes the internal dependencies
from 'pkg-config --libs', but keeps them in --libs --static output. The
change won't affect --cflags and the include directories necessary for
<ffi.h> will still be listed.

https://bugzilla.gnome.org/show_bug.cgi?id=674065

Don't link with gthread-2.0

Commit 2fff986 removed the use of g_thread_init() and we don't use any
other symbols from gthread-2.0.

https://bugzilla.gnome.org/show_bug.cgi?id=674065

Make introspection compile with -Wall -Werror

Address all gcc warnings, -Werror is not enabled yet but at least
-Wall -Werror passes on my machine.

Compare filenames using g_file_equal()

Makes it work on case-sensitive file systems such as HFS+.

https://bugzilla.gnome.org/show_bug.cgi?id=667405

Pass in LDFLAGS to the dumper

We should honor LDFLAGS environment variable set by the user,
so options such as -Wl,--enable-new-dtags properly get passed to
the linker when creating the dumper binary

https://bugzilla.gnome.org/show_bug.cgi?id=670152

annotationparser: split validate() into sub-methods

Most cases in validate() were already simply calls to _validate_option()
with particular arguments; this extracts the code from the remaining
options to their own methods, making the dispatch table more legible.

https://bugzilla.gnome.org/show_bug.cgi?id=670985

annotationparser: correct "maximium" in error messages

"Maximium" is not an English word. Even if corrected to "maximum" (which
is), "at maximum" is not conventional usage: "at most" is more
idiomatic.

https://bugzilla.gnome.org/show_bug.cgi?id=670985

annotationparser: remove duplication of annotation names

Previously, the validation code compared each option name to a constant
(such as OPT_ALLOW_NONE) which expands to the string used in a source
file, and if they matched it would typically pass that same string to
_validate_option(). But the annotation name was written out longhand
each time, which seemed strange to me.

https://bugzilla.gnome.org/show_bug.cgi?id=670985

giscanner: Don't run pkg-config when there's no packages specified

This prevents a simple error from pkg-config, "Must specify package names
on command line"

https://bugzilla.gnome.org/show_bug.cgi?id=673668

Avoid _get_func() consuming reference from input info

Fix of leak in 4c9424e18d71237f438a99bc5f2d45ae7de60b78 was a bit
overaggressive, stealing also one reference from input 'info'
argument.

Also fixes another bug in that commit - local 'func' shadowing the
return value, causing that function always returned NULL even when
some result was actually found.

https://bugzilla.gnome.org/show_bug.cgi?id=673282

Split parameter and tag storage in annotationparser parse tree

This avoids tags overwriting parameters if they happen to
share the same name. For example, this was triggered by
valid code in libgnome-keyring.

tests/scanner/regress.c and tests/scanner/regress.h test
written by Colin Walters <walters@verbum.org>.

https://bugzilla.gnome.org/show_bug.cgi?id=672254

Don't extract annotations from headers

The headers are already parsed as they are passed
in to g-ir-scanner. This avoids quite a few warnings triggered
with the new annotation parser.

Update annotations from git.

This removes also all the headers as it's the first run
with the updated extraction tool.

Do the filename filtering in scannerlexer

This avoids a bit of python work and reduces the
amount of allocations.

Don't parse doc comments in dependencies

Only parse doc comments for the files we pass in
on the command line to g-ir-scanner, not the included dependencies.

Replace ''' with """, to avoid confusing syntax highlightning in emacs

Fix malformed GTK-Doc comment blocks:

- add missing colons
- invalid annotations
- invalid parameters and tags
- correct parameter name
- preserve description indentation
- no description parts
- comment end marker
- invalid empty lines
- line numbers

AnnotationParser now emits warnings which are considered as
errors by "make check" so fix those warnings...

https://bugzilla.gnome.org/show_bug.cgi?id=672254

Now make AnnotationParser do what gobject-introspection needs it to do.

https://bugzilla.gnome.org/show_bug.cgi?id=672254

Update GLib annotations, using the improved annotation parser.

https://bugzilla.gnome.org/show_bug.cgi?id=672254

update-glib-annotations.py: reduce code duplication

https://bugzilla.gnome.org/show_bug.cgi?id=672254

Make AnnotationParser._parse_comment() do what gtk-doc does.

https://bugzilla.gnome.org/show_bug.cgi?id=672254