1
0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2026-10-24 00:49:00 +03:00
Files
glib/gobject/gatomicarray.h
Philip Chimento 0213ee7354 Avoid reserved identifiers in public macros
Clang-tidy has a check to prohibit identifiers that are reserved for the
compiler. Those are identifiers that start with:
  - an underscore plus an uppercase letter
  - two underscores
  - an underscore, and are in the global scope
https://clang.llvm.org/extra/clang-tidy/checks/bugprone/reserved-identifier.html

Many public GLib macros define variables starting with two underscores,
which is technically not allowed. This is probably usually harmless, but
it causes false positives in the abovementioned clang-tidy check when
consumers of GLib use macros like G_VALUE_HOLDS_POINTER or
g_str_has_suffix.

This commit replaces all such names with one-underscore names, which are
not reserved because they're not in the global scope.

Here's the incantation I used to discover which macros needed editing:

git grep -P '\b__(?!builtin|atomic|sync|asm|volatile|pragma)[a-z].*\\$' \
  -- '*.h' | grep -v valgrind.h

This generates a manageable number of false positives. It also fails to
find identifiers on the last line of a macro, but those are generally
already mentioned elsewhere in the macro.

I left valgrind.h untouched.
2026-07-26 14:12:11 -07:00

70 lines
2.4 KiB
C

/* GObject - GLib Type, Object, Parameter and Signal Library
* Copyright (C) 2009 Benjamin Otte <otte@gnome.org>
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __G_ATOMIC_ARRAY_H__
#define __G_ATOMIC_ARRAY_H__
#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
#error "Only <glib-object.h> can be included directly."
#endif
#include <glib/glib.h>
G_BEGIN_DECLS
typedef union _GAtomicArrayMetadata
{
gsize size;
/* We have to ensure that the memory location is sufficiently aligned to
* store any object. With C11 this would be max_align_t, but in practise
* gpointer is sufficient for all known architectures. We could change
* this to `_Alignas(max_align_t) char pad` once we depend on C11. */
gpointer _alignment_padding;
} GAtomicArrayMetadata;
#define G_ATOMIC_ARRAY_DATA_SIZE(mem) (((GAtomicArrayMetadata *) (mem) - 1)->size)
typedef struct _GAtomicArray GAtomicArray;
struct _GAtomicArray {
gpointer data; /* elements - atomic */
};
void _g_atomic_array_init (GAtomicArray *array);
gpointer _g_atomic_array_copy (GAtomicArray *array,
gsize header_size,
gsize additional_element_size);
void _g_atomic_array_update (GAtomicArray *array,
gpointer new_data);
#define G_ATOMIC_ARRAY_GET_LOCKED(_array, _type) ((_type *)((_array)->data))
#define G_ATOMIC_ARRAY_DO_TRANSACTION(_array, _type, _C_) G_STMT_START { \
gpointer *_datap = &(_array)->data; \
_type *transaction_data, *_check; \
\
_check = g_atomic_pointer_get (_datap); \
do { \
transaction_data = _check; \
{_C_;} \
_check = g_atomic_pointer_get (_datap); \
} while (transaction_data != _check); \
} G_STMT_END
G_END_DECLS
#endif /* __G_ATOMIC_ARRAY_H__ */