Low-level core library that forms the basis for projects such as GTK+ and GNOME.
Go to file
Thomas Haller ee247c0a2d array: add support for %NULL termination in GPtrArray
GArray supports a "zero_terminated" flag, but GPtrArray doesn't.
This is odd, because especially for a pointer array it makes sense
to have a %NULL sentinel. This would be for example useful to track
or construct a strv array with a GPtrArray.

As workaround for this missing feature you could use a GArray instead
(ugly) or to explicitly add the %NULL element. However the latter increases
the "len" of the array, which can be problematic if you want to still use
the GPtrArray for other purposes.

Add API for marking a GPtrArray as %NULL terminated. In that case, the
API will ensure that there is always a valid %NULL sentinel after the
array. Note that the API does not enforce that a %NULL terminated API
actually has any data allocated. That means, even with a %NULL terminated
array, pdata can still be %NULL (only if len is zero).

Add g_ptr_array_new_null_terminated() constructor. The null-terminated flag
cannot be cleared. Once the GPtrArray is flagged to be %NULL terminated, it
sticks. The purpose is that once a user checks whether a GPtrArray instance
is safe to be treated as a %NULL terminated array, the decision does
not need to be re-evaluated.

Also add a g_ptr_array_is_null_terminated(). That is useful because it
allows you to check whether a GPtrArray created by somebody else is safe
to use as a %NULL terminated array. Since there is no API to make an
array not %NULL terminated anymore, this is not error prone.

The new flag is tracked as a guint8 in GRealPtrArray. On common 64 bit
architectures this does not increase the size of the struct as it fits
in an existing hole. Note that this is not a bitfield because it's
probably more efficient to access the entire guint8. However, there is
still a 3 bytes hole (on common 32 and 64 architectures), so if we need
to add more flags in the future, we still have space for 24 bits,
despite the new flag not being a bitfield.

The biggest downside of the patch is the runtime overhead that most
operations now need to check whether %NULL termination is requested.

Includes some tweaks and additional tests by Philip Withnall.

https://gitlab.gnome.org/GNOME/glib/-/issues/353
2022-05-27 15:27:19 +01:00
.gitlab-ci gitlab-ci: left-over from junit cleanup 2022-05-25 15:27:37 +02:00
.reuse fuzzing: Mark .corpus and .dict files as not copyrightable 2022-05-18 09:50:05 +01:00
docs array: add support for %NULL termination in GPtrArray 2022-05-27 15:27:19 +01:00
fuzzing fuzzing: Add copyright/licensing headers to fuzzing files 2022-05-18 09:49:26 +01:00
gio Merge branch 'nacho/uwp-warnings' into 'main' 2022-05-26 14:29:11 +00:00
glib array: add support for %NULL termination in GPtrArray 2022-05-27 15:27:19 +01:00
gmodule Move tests/module-test.c to gmodules/tests/ 2022-05-26 17:26:58 +01:00
gobject Merge branch 'move_gobject_tests' into 'main' 2022-05-26 18:37:19 +00:00
gthread build: Drop checks and workarounds for older Meson versions 2022-05-06 13:01:44 +01:00
LICENSES docs: Add all used licenses in a REUSE-compatible directory 2022-05-17 17:23:34 +01:00
m4macros m4macros: Increment serial number of glib-2.0.m4 2021-01-27 11:55:37 +00:00
po Update Turkish translation 2022-05-24 07:01:45 +00:00
subprojects build: update sysprof configuration options 2022-05-25 23:02:14 -07:00
tests Merge branch 'move_gobject_tests' into 'main' 2022-05-26 18:37:19 +00:00
tools tools: Move glib.supp to tools directory 2022-05-11 13:11:01 +01:00
.clang-format CI: Code check formating in CI 2019-11-21 14:03:01 -06:00
.dir-locals.el Add .dir-locals.el to tell Emacs users not to use tabs for C 2012-07-30 04:09:08 -04:00
.editorconfig docs: Add .editorconfig file 2021-10-28 14:47:53 +01:00
.gitignore docs: Move INSTALL.in to INSTALL.md 2022-05-11 13:02:49 +01:00
.gitlab-ci.yml gitlab-ci: left-over from junit cleanup 2022-05-25 15:27:37 +02:00
.lcovrc build: Move lcovrc file to root so it’s picked up by Meson 2022-04-28 11:57:45 +01:00
CODE_OF_CONDUCT.md docs: Add a code of conduct document 2022-05-11 12:30:58 +01:00
CONTRIBUTING.md Rename the master branch to main 2021-06-07 14:03:48 +01:00
COPYING docs: Add all used licenses in a REUSE-compatible directory 2022-05-17 17:23:34 +01:00
glib.doap docs: Update various external links to use HEAD instead of master 2021-06-07 14:03:48 +01:00
HACKING docs: Move README.rationale to docs subdirectory 2022-05-11 13:02:49 +01:00
INSTALL.md docs: Reformat INSTALL.md as Markdown 2022-05-11 13:02:55 +01:00
meson_options.txt gio: Remove fam file monitor support 2022-03-23 15:41:54 +00:00
meson.build meson: use builtin zlib dependency lookup 2022-05-24 15:22:34 -04:00
msvc_recommended_pragmas.h msvc_recommended_pragmas.h: Refine for clang-cl 2021-03-30 16:45:07 +08:00
NEWS docs: Merge NEWS.pre-1-3 into NEWS 2022-05-11 13:02:55 +01:00
README.md docs: Move INSTALL.in to INSTALL.md 2022-05-11 13:02:49 +01:00
README.win32.md README.win32.md: Mention about Window 8+ SDK requirement 2021-02-28 11:04:29 +02:00
SECURITY.md docs: Add a note about git-evtag to SECURITY.md 2021-09-07 11:21:12 +00:00

GLib

GLib is the low-level core library that forms the basis for projects such as GTK and GNOME. It provides data structure handling for C, portability wrappers, and interfaces for such runtime functionality as an event loop, threads, dynamic loading, and an object system.

The official download locations are: https://download.gnome.org/sources/glib

The official web site is: https://www.gtk.org/

Installation

See the file 'INSTALL.md'

Supported versions

Only the most recent unstable and stable release series are supported. All older versions are not supported upstream and may contain bugs, some of which may be exploitable security vulnerabilities.

See SECURITY.md for more details.

Documentation

API documentation is available online for GLib for the:

Discussion

If you have a question about how to use GLib, seek help on GNOMEs Discourse instance. Alternatively, ask a question on StackOverflow and tag it glib.

Reporting bugs

Bugs should be reported to the GNOME issue tracking system. You will need to create an account for yourself. You may also submit bugs by e-mail (without an account) by e-mailing incoming+gnome-glib-658-issue-@gitlab.gnome.org, but this will give you a degraded experience.

Bugs are for reporting problems in GLib itself, not for asking questions about how to use it. To ask questions, use one of our discussion forums.

In bug reports please include:

  • Information about your system. For instance:
    • What operating system and version
    • For Linux, what version of the C library
    • And anything else you think is relevant.
  • How to reproduce the bug.
    • If you can reproduce it with one of the test programs that are built in the tests/ subdirectory, that will be most convenient. Otherwise, please include a short test program that exhibits the behavior. As a last resort, you can also provide a pointer to a larger piece of software that can be downloaded.
  • If the bug was a crash, the exact text that was printed out when the crash occurred.
  • Further information such as stack traces may be useful, but is not necessary.

Contributing to GLib

Please follow the contribution guide to know how to start contributing to GLib.

Patches should be submitted as merge requests to gitlab.gnome.org. If the patch fixes an existing issue, please refer to the issue in your commit message with the following notation (for issue 123):

Closes: #123

Otherwise, create a new merge request that introduces the change. Filing a separate issue is not required.

Default branch renamed to main

The default development branch of GLib has been renamed to main. To update your local checkout, use:

git checkout master
git branch -m master main
git fetch
git branch --unset-upstream
git branch -u origin/main
git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/main