glib/girepository/gisignalinfo.h
Philip Withnall 57d64b111f girepository: Add type-checking cast macros
These follow GObject conventions, using `G_TYPE_CHECK_INSTANCE_CAST` to
cast to the given type, and potentially performing some runtime checks
of the type instance’s `GType` too.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Fixes: #3216
2024-01-18 13:15:22 +00:00

73 lines
2.2 KiB
C

/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
* GObject introspection: Signal
*
* Copyright (C) 2005 Matthias Clasen
* Copyright (C) 2008,2009 Red Hat, Inc.
*
* 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 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#pragma once
#if !defined (__GIREPOSITORY_H_INSIDE__) && !defined (GI_COMPILATION)
#error "Only <girepository.h> can be included directly."
#endif
#include <glib-object.h>
#include <girepository/gitypes.h>
G_BEGIN_DECLS
#define GI_TYPE_SIGNAL_INFO (gi_signal_info_get_type ())
/**
* GI_SIGNAL_INFO:
* @info: Info object which is subject to casting.
*
* Casts a [type@GIRepository.SignalInfo] or derived pointer into a
* `(GISignalInfo*)` pointer.
*
* Depending on the current debugging level, this function may invoke
* certain runtime checks to identify invalid casts.
*
* Since: 2.80
*/
#define GI_SIGNAL_INFO(info) (G_TYPE_CHECK_INSTANCE_CAST ((info), GI_TYPE_SIGNAL_INFO, GISignalInfo))
/**
* GI_IS_SIGNAL_INFO:
* @info: an info structure
*
* Checks if @info is a [class@GIRepository.SignalInfo] (or a derived type).
*
* Since: 2.80
*/
#define GI_IS_SIGNAL_INFO(info) (G_TYPE_CHECK_INSTANCE_TYPE ((info), GI_TYPE_SIGNAL_INFO))
GI_AVAILABLE_IN_ALL
GSignalFlags gi_signal_info_get_flags (GISignalInfo *info);
GI_AVAILABLE_IN_ALL
GIVFuncInfo * gi_signal_info_get_class_closure (GISignalInfo *info);
GI_AVAILABLE_IN_ALL
gboolean gi_signal_info_true_stops_emit (GISignalInfo *info);
G_END_DECLS