From patchwork Wed Nov 16 13:38:15 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Wakely X-Patchwork-Id: 60697 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 4BCD0395B414 for ; Wed, 16 Nov 2022 13:38:48 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 4BCD0395B414 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1668605928; bh=ZbqHRcBkDzxPPoV+lKfAgkEV/XodyMgjP2Q5s8OGzUI=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=JOL+xV3fj+MdLa9xYJJuRurYVRp/bvCVroXZQBb04q6h6pb2aU6AkeigBMRK+dpUj qX6s/Kvam5SkUG9tEiyNF1n6woo1DXyN2byBc8q3njPuzlVtHozM9h1I/qms4Qa1+P e6hOC/PHkH+b1eqRcPo78/oLixHtnyEJMpPj4miA= X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id DA3C0395A073 for ; Wed, 16 Nov 2022 13:38:19 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org DA3C0395A073 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-654-KwbPyylgN9WX5acw1kj7VA-1; Wed, 16 Nov 2022 08:38:18 -0500 X-MC-Unique: KwbPyylgN9WX5acw1kj7VA-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E755D855438; Wed, 16 Nov 2022 13:38:17 +0000 (UTC) Received: from localhost (unknown [10.33.36.199]) by smtp.corp.redhat.com (Postfix) with ESMTP id AE154C2C8C7; Wed, 16 Nov 2022 13:38:17 +0000 (UTC) To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org Subject: [committed] libstdc++: Improve comments on pretty printer code Date: Wed, 16 Nov 2022 13:38:15 +0000 Message-Id: <20221116133815.1351836-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.8 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Jonathan Wakely via Gcc-patches From: Jonathan Wakely Reply-To: Jonathan Wakely Errors-To: gcc-patches-bounces+patchwork=sourceware.org@gcc.gnu.org Sender: "Gcc-patches" Tested x86_64-linux with GDB 12.1. Pushed to trunk. -- >8 -- libstdc++-v3/ChangeLog: * python/libstdcxx/v6/printers.py (is_specialization_of): Fix incorrect terminology in docstring and describe arguments. (FilteringTypePrinter): Add default argument for new parameter, enhance docstring. --- libstdc++-v3/python/libstdcxx/v6/printers.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/libstdc++-v3/python/libstdcxx/v6/printers.py b/libstdc++-v3/python/libstdcxx/v6/printers.py index eaaf5e817c0..19c70d12035 100644 --- a/libstdc++-v3/python/libstdcxx/v6/printers.py +++ b/libstdc++-v3/python/libstdcxx/v6/printers.py @@ -166,7 +166,12 @@ def is_member_of_namespace(typ, *namespaces): return False def is_specialization_of(x, template_name): - "Test if a type is a given template instantiation." + """ + Test whether a type is a specialization of the named class template. + The type can be specified as a string or a gdb.Type object. + The template should be the name of a class template as a string, + without any 'std' qualification. + """ global _versioned_namespace if type(x) is gdb.Type: x = x.tag @@ -2071,19 +2076,22 @@ class FilteringTypePrinter(object): Args: template (str): The class template to recognize. name (str): The typedef-name that will be used instead. - targ1 (str): The first template argument. - If arg1 is provided (not None), match only template specializations - with this type as the first template argument, - e.g. if template='basic_string is the same type as std::istream then print it as std::istream. + + If targ1 is provided (not None), match only template specializations with + this type as the first template argument, e.g. if template='basic_string' + and targ1='char' then only match 'basic_string' and not + 'basic_string'. This rejects non-matching specializations + more quickly, without needing to do GDB type lookups. """ - def __init__(self, template, name, targ1): + def __init__(self, template, name, targ1 = None): self.template = template self.name = name self.targ1 = targ1