From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id CF4BDC432BE for ; Thu, 29 Jul 2021 18:02:47 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 547BC6054E for ; Thu, 29 Jul 2021 18:02:47 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 547BC6054E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:38446 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m9AMo-0005IZ-He for qemu-devel@archiver.kernel.org; Thu, 29 Jul 2021 14:02:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52520) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m9AGV-0006s7-CH for qemu-devel@nongnu.org; Thu, 29 Jul 2021 13:56:15 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:39666) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m9AGT-00081V-Kn for qemu-devel@nongnu.org; Thu, 29 Jul 2021 13:56:15 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1627581372; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=W9T+GXXBUzKf6Acq+ENzctJe/hvCuPWDINxzhQcrxDE=; b=FOVeBK/p4nWZiWQJH6yVkcazhjpmmcCiGmV1ch1ZSaQ+KwDxu9F3TiRJT1SrNT0V3v+vtq 8CJroRv5UV7SnIfxPrdTUfSjG77U1xDeOw05M3DAFy7yu32poZIYzwBkvHTJ4XVjxpdrML VrcWVB4+ayeLuyxRA2JMol5xMJecMRM= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-371-OTiRZR-aOTOt36v367JFwg-1; Thu, 29 Jul 2021 13:56:09 -0400 X-MC-Unique: OTiRZR-aOTOt36v367JFwg-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 8541A1006C81 for ; Thu, 29 Jul 2021 17:56:08 +0000 (UTC) Received: from localhost (unknown [10.22.18.227]) by smtp.corp.redhat.com (Postfix) with ESMTP id 535845C1D1; Thu, 29 Jul 2021 17:56:08 +0000 (UTC) From: Eduardo Habkost To: qemu-devel@nongnu.org Subject: [PATCH for-6.2 08/10] docs: qom: Show actual typecast functions in examples Date: Thu, 29 Jul 2021 13:55:52 -0400 Message-Id: <20210729175554.686474-9-ehabkost@redhat.com> In-Reply-To: <20210729175554.686474-1-ehabkost@redhat.com> References: <20210729175554.686474-1-ehabkost@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=ehabkost@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" Received-SPF: pass client-ip=216.205.24.124; envelope-from=ehabkost@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.717, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eduardo Habkost Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" For clarity and to avoid encouraging people to copy the examples, show the actual typecast functions being defined by OBJECT_DECLARE* macros in the examples. Signed-off-by: Eduardo Habkost --- docs/devel/qom.rst | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst index aa1f672efbe..3ae6f75a1a2 100644 --- a/docs/devel/qom.rst +++ b/docs/devel/qom.rst @@ -303,8 +303,10 @@ This is equivalent to the following: typedef struct MyDevice MyDevice; G_DEFINE_AUTOPTR_CLEANUP_FUNC(MyDevice, object_unref) - #define MY_DEVICE(void *obj) - OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE) + static inline MyDevice *MY_DEVICE(void *obj) + { + return OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE); + } The 'struct MyDevice' needs to be declared separately. @@ -327,12 +329,18 @@ This is equivalent to the following: G_DEFINE_AUTOPTR_CLEANUP_FUNC(MyDevice, object_unref) - #define MY_DEVICE_GET_CLASS(void *obj) \ - OBJECT_GET_CLASS(MyDeviceClass, obj, TYPE_MY_DEVICE) - #define MY_DEVICE_CLASS(void *klass) \ - OBJECT_CLASS_CHECK(MyDeviceClass, klass, TYPE_MY_DEVICE) - #define MY_DEVICE(void *obj) - OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE) + static inline MyDeviceClass *MY_DEVICE_GET_CLASS(void *obj) + { + return OBJECT_GET_CLASS(MyDeviceClass, obj, TYPE_MY_DEVICE); + } + static inline MyDeviceClass *MY_DEVICE_CLASS(void *klass) + { + return OBJECT_CLASS_CHECK(MyDeviceClass, klass, TYPE_MY_DEVICE); + } + static inline MyDevice *MY_DEVICE(void *obj) + { + return OBJECT_CHECK(MyDevice, obj, TYPE_MY_DEVICE); + } Type definition macros ---------------------- -- 2.31.1