From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 F40573858409 for ; Mon, 13 Dec 2021 14:12:50 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org F40573858409 Received: from mail-wm1-f71.google.com (mail-wm1-f71.google.com [209.85.128.71]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-516-C3BHEvycMpOkDMxMw4Nx_Q-1; Mon, 13 Dec 2021 09:12:49 -0500 X-MC-Unique: C3BHEvycMpOkDMxMw4Nx_Q-1 Received: by mail-wm1-f71.google.com with SMTP id 145-20020a1c0197000000b0032efc3eb9bcso11680275wmb.0 for ; Mon, 13 Dec 2021 06:12:49 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=X52TIiEpck9GiSTE+7j7D5uhaCqBFMlG+5vzg4rttck=; b=OOrfhiNS1wi1WoqMmPxyjkBF0HXSyBmmjew4CJY4hodhp4riJ+JU5i+3XD7bQNoHov ZaF0PSCLsaL7brDbzaaSRRin0/4llFIFd0StR2vE0CvJ1/9NW7K0iNT4W5uuBxnnGEfU tUp95z1BuMv7QJYmi3txfXGLBDGFqMV5SXWF+Kxkg/fuXXhHFpbcosArBJ8oaXkAampC /4bldA3PmOIgCJ2a9iTd0+mnPQAjlBNXO9uqli3LfmYw4F7BOOHF+3mWBeexHBS1JjN9 GYv9mwxg1bTcLu3A2QAUhm+XMmWoOj3yYla3uG3io9xnzmsmncZ62J27LnXaxLarVIhg WIvA== X-Gm-Message-State: AOAM532CmcLesAjf37hJaUsrldOXetJ3+6uac2/TLRsAqZZv2SOfimRg yURdOJNH5cPJF9nF2bL6QK52tCLu+faUhqRWO3+2zAbBN8w3Q+xBNVolIX/+mmcTeBO5awD3GQ1 aaQuibslSY8GGDYvtKERlcf56P5sIaU2s8CyrvBg+K2tjDGKESHVmmuvt21xW7cmOE8mHAbKlyQ == X-Received: by 2002:a1c:4d3:: with SMTP id 202mr37543421wme.174.1639404768183; Mon, 13 Dec 2021 06:12:48 -0800 (PST) X-Google-Smtp-Source: ABdhPJwE4R25StNuWPCFx55DqjFYDWuFAUs/cXyIExT7kvHNIuEo21mXvUnUbgXH8qwQ/s/zsO6j4A== X-Received: by 2002:a1c:4d3:: with SMTP id 202mr37543380wme.174.1639404767783; Mon, 13 Dec 2021 06:12:47 -0800 (PST) Received: from localhost (host86-134-238-138.range86-134.btcentralplus.com. [86.134.238.138]) by smtp.gmail.com with ESMTPSA id bg34sm7811323wmb.47.2021.12.13.06.12.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Dec 2021 06:12:47 -0800 (PST) From: Andrew Burgess To: gdb-patches@sourceware.org Cc: Andrew Burgess Subject: [PATCHv3 2/2] gdb/python: move styling support to gdb.styling Date: Mon, 13 Dec 2021 14:12:39 +0000 Message-Id: <9c679a50c4681789036deaa6702ad3e5311ef581.1639404422.git.aburgess@redhat.com> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII" X-Spam-Status: No, score=-10.2 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, KAM_SHORT, RCVD_IN_BARRACUDACENTRAL, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 13 Dec 2021 14:12:53 -0000 From: Andrew Burgess This commit moves the two Python functions that are used for styling into a new module, gdb.styling, there's then a small update in python.c so GDB can find the functions in their new location. The motivation for this change is purely to try and reduce the clutter in the top-level gdb module, and encapsulate related functions into modules. I did ponder documenting these functions as part of the Python API, however, doing so would effectively "fix" the API, and I'm still wondering if there's improvements that could be made, also, the colorize function is only called in some cases now that GDB prefers libsource-highlight, so it's not entirely sure how this would work as part of a user facing API. Still, despite these functions never having been part of a documented API, it is possible that a user out there has overridden these to, in some way, customize how GDB performs styling. Moving the function as I propose in this patch could break things for that user, however, fixing this breakage is trivial, and, as these functions were never documented, I don't think we should be obliged to not break user code that relies on them. --- gdb/data-directory/Makefile.in | 1 + gdb/python/lib/gdb/__init__.py | 29 -------------------- gdb/python/lib/gdb/styling.py | 48 ++++++++++++++++++++++++++++++++++ gdb/python/python.c | 24 ++++++++++++----- 4 files changed, 67 insertions(+), 35 deletions(-) create mode 100644 gdb/python/lib/gdb/styling.py diff --git a/gdb/data-directory/Makefile.in b/gdb/data-directory/Makefile.in index 888325f974e..ab0733e29dc 100644 --- a/gdb/data-directory/Makefile.in +++ b/gdb/data-directory/Makefile.in @@ -74,6 +74,7 @@ PYTHON_FILE_LIST = \ gdb/frames.py \ gdb/printing.py \ gdb/prompt.py \ + gdb/styling.py \ gdb/types.py \ gdb/unwinder.py \ gdb/xmethod.py \ diff --git a/gdb/python/lib/gdb/__init__.py b/gdb/python/lib/gdb/__init__.py index 6ab797c8c5e..8d63ae67fe8 100644 --- a/gdb/python/lib/gdb/__init__.py +++ b/gdb/python/lib/gdb/__init__.py @@ -230,32 +230,3 @@ def find_pc_line(pc): Return the gdb.Symtab_and_line object corresponding to the pc value.""" return current_progspace().find_pc_line(pc) - -try: - from pygments import formatters, lexers, highlight - - def colorize(filename, contents): - # Don't want any errors. - try: - lexer = lexers.get_lexer_for_filename(filename, stripnl=False) - formatter = formatters.TerminalFormatter() - return highlight(contents, lexer, formatter) - except: - return None - - def colorize_disasm(content, gdbarch): - # Don't want any errors. - try: - lexer = lexers.get_lexer_by_name("asm") - formatter = formatters.TerminalFormatter() - return highlight(content, lexer, formatter).rstrip() - except: - return None - -except: - - def colorize(filename, contents): - return None - - def colorize_disasm(content, gdbarch): - return None diff --git a/gdb/python/lib/gdb/styling.py b/gdb/python/lib/gdb/styling.py new file mode 100644 index 00000000000..d03c0c7252a --- /dev/null +++ b/gdb/python/lib/gdb/styling.py @@ -0,0 +1,48 @@ +# Styling related hooks. +# Copyright (C) 2010-2021 Free Software Foundation, Inc. + +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +"""Utilities for styling.""" + +import gdb + +try: + from pygments import formatters, lexers, highlight + + def colorize(filename, contents): + # Don't want any errors. + try: + lexer = lexers.get_lexer_for_filename(filename, stripnl=False) + formatter = formatters.TerminalFormatter() + return highlight(contents, lexer, formatter) + except: + return None + + def colorize_disasm(content, gdbarch): + # Don't want any errors. + try: + lexer = lexers.get_lexer_by_name("asm") + formatter = formatters.TerminalFormatter() + return highlight(content, lexer, formatter).rstrip() + except: + return None + +except: + + def colorize(filename, contents): + return None + + def colorize_disasm(content, gdbarch): + return None diff --git a/gdb/python/python.c b/gdb/python/python.c index 7524489371d..0a9b14917bf 100644 --- a/gdb/python/python.c +++ b/gdb/python/python.c @@ -1131,11 +1131,17 @@ gdbpy_colorize (const std::string &filename, const std::string &contents) gdbpy_enter enter_py (get_current_arch (), current_language); - if (gdb_python_module == nullptr - || !PyObject_HasAttrString (gdb_python_module, "colorize")) + gdbpy_ref<> module (PyImport_ImportModule ("gdb.styling")); + if (module == nullptr) + { + gdbpy_print_stack (); + return {}; + } + + if (!PyObject_HasAttrString (module.get (), "colorize")) return {}; - gdbpy_ref<> hook (PyObject_GetAttrString (gdb_python_module, "colorize")); + gdbpy_ref<> hook (PyObject_GetAttrString (module.get (), "colorize")); if (hook == nullptr) { gdbpy_print_stack (); @@ -1199,11 +1205,17 @@ gdbpy_colorize_disasm (const std::string &content, gdbarch *gdbarch) gdbpy_enter enter_py (get_current_arch (), current_language); - if (gdb_python_module == nullptr - || !PyObject_HasAttrString (gdb_python_module, "colorize_disasm")) + gdbpy_ref<> module (PyImport_ImportModule ("gdb.styling")); + if (module == nullptr) + { + gdbpy_print_stack (); + return {}; + } + + if (!PyObject_HasAttrString (module.get (), "colorize_disasm")) return {}; - gdbpy_ref<> hook (PyObject_GetAttrString (gdb_python_module, + gdbpy_ref<> hook (PyObject_GetAttrString (module.get (), "colorize_disasm")); if (hook == nullptr) { -- 2.25.4