From patchwork Fri Apr 19 14:55:04 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 88734 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 19773384641E for ; Fri, 19 Apr 2024 14:56:17 +0000 (GMT) X-Original-To: gdb-patches@sourceware.org Delivered-To: gdb-patches@sourceware.org Received: from mail-il1-x136.google.com (mail-il1-x136.google.com [IPv6:2607:f8b0:4864:20::136]) by sourceware.org (Postfix) with ESMTPS id C873C3849AE5 for ; Fri, 19 Apr 2024 14:55:06 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org C873C3849AE5 Authentication-Results: sourceware.org; dmarc=pass (p=quarantine dis=none) header.from=adacore.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=adacore.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org C873C3849AE5 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=2607:f8b0:4864:20::136 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1713538511; cv=none; b=Q3zE9UWcAUFHZC82AHtBN7k/yZVN7z48wxGfwkCkCz7ZAavMuc8NtxtWDzmxjd2nmtLHaERhzPE3n27WWklK+kXv21NNRKBmeIqb+7AyszbIfsuWThTG3aFB9XV70eAwzllR9bYPKqkO3aqk3MhmXyyFUFlnu78QhPrYqQnQ+zg= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1713538511; c=relaxed/simple; bh=4EWP7/d0SKTucWk/xrlOv+xk8ykrVBMNFruofhnlyno=; h=DKIM-Signature:From:Date:Subject:MIME-Version:Message-Id:To; b=GStlO4iOYL5o3rgNsaNwlLy6Rsv/5h1nHmPOMDGElpNZmmamXl7WiAIZfDwnNf5hB0VhwDbtKEse7PDaKwFR6r7Z7Qgaa4neWb1f5BJBwX+bkRNKqRIxBeV+f3FeXsn+rS6UUIt4KoJ2csUmX2LbNPY01NTSlc5Yga6duI7YO50= ARC-Authentication-Results: i=1; server2.sourceware.org Received: by mail-il1-x136.google.com with SMTP id e9e14a558f8ab-36a0d09e6ffso8891285ab.0 for ; Fri, 19 Apr 2024 07:55:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=adacore.com; s=google; t=1713538506; x=1714143306; darn=sourceware.org; h=to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=Kw/9te+j55rN4BCZQTe4qFAHpxO4BRlMEgivad9ddc0=; b=IeXatvnxExwM58KJPa12f8i0zSUX+Vu3ckVtb6Qk7V99DLpwb6CBtfxS4hTwNLNlVD ZwtQjpcLfC535hu0gJp0TfGltSQ3K4Kj1qThUy4iQfUleyGKgYedQaFMDeXg37Ct9We0 vcdQGIjVTAsu14aoFyr+3I/G2dnke4hroXyDNMS3uKUXra991vhajMlXh0SANcvlUU9D lrc4oHfCPUPvaZ5ZCNELw6wuT2y3fonfKTwfjeJLT2wrOhCkzfdiaeWVvOOZIr2dm2aq +nj2zs7BBD9FmGvgkAAEZWD52mPrGkFwwyep/n28aY7yK398JyTQjzHhEZqVAXgvqylH b4wQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713538506; x=1714143306; h=to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Kw/9te+j55rN4BCZQTe4qFAHpxO4BRlMEgivad9ddc0=; b=dlCsfSONC52oCJX4MGN2EiyseNadO6adz2ImvQBp9SMNqwwuXDFqS8j2jlpZqZjERs adl2/EPKpQijIT9JKLfYXelXePt5h9hy5p6tPcr/rD26wXVLhwDQPc6YjAaRQkKwmkBu h9kDHICUyx2MQZUuoiS9vqR+UWKTNiIuub1oH/hnUlxwcv6FpMQhIve1h+Em2NQNgWFs lUx95G5uHNtxqoXzKPvJIC0wps8Qlfd2JmWGt2oFhSYotlxQhNE3GErmrvfDh8LUQBIz 1HUezVebiWTaDa4QCnIItbgVCglENksNSGBo9t8dbmMZyQVtJY1CRqAME3l9I6vPAZS+ 8dqw== X-Gm-Message-State: AOJu0Yx07GpqBZNBKROn4Hd3bZw9IcjZzJn96F7Jbf44BF0/CLcB86N8 DukD0nDeGHc9MPm/VIeJyw/ONsEiKq8YNPS1vD4DIQPoS2puq8W17Tu8stgEdMxXYUWrhK+DMP0 = X-Google-Smtp-Source: AGHT+IERr1Y626fR4LANKMlYyXPHtoUYXXtjw9RPjZS3PnqIR81+j1EeOUPdPzErMYrid0r+FAzt/w== X-Received: by 2002:a05:6e02:1aa2:b0:368:80ff:9bc4 with SMTP id l2-20020a056e021aa200b0036880ff9bc4mr2982584ilv.1.1713538505888; Fri, 19 Apr 2024 07:55:05 -0700 (PDT) Received: from localhost.localdomain (97-122-86-252.hlrn.qwest.net. [97.122.86.252]) by smtp.gmail.com with ESMTPSA id u14-20020a056e02110e00b0036b1aa58c5dsm828448ilk.15.2024.04.19.07.55.05 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 19 Apr 2024 07:55:05 -0700 (PDT) From: Tom Tromey Date: Fri, 19 Apr 2024 08:55:04 -0600 Subject: [PATCH v3 3/4] Add check-include-guards.py to pre-commit MIME-Version: 1.0 Message-Id: <20240419-header-check-v3-3-2f2a837c2976@adacore.com> References: <20240419-header-check-v3-0-2f2a837c2976@adacore.com> In-Reply-To: <20240419-header-check-v3-0-2f2a837c2976@adacore.com> To: gdb-patches@sourceware.org X-Mailer: b4 0.13.0 X-Spam-Status: No, score=-11.8 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, 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: gdb-patches@sourceware.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gdb-patches-bounces+patchwork=sourceware.org@sourceware.org This changes pre-commit to run check-include-guards.py. --- .pre-commit-config.yaml | 10 ++++++++++ gdb/check-include-guards.py | 35 ++++++++++------------------------- 2 files changed, 20 insertions(+), 25 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8721dac678b..74c2a684cf5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -22,3 +22,13 @@ repos: - id: isort types_or: [file] files: 'gdb/.*\.py(\.in)?$' + - repo: local + hooks: + - id: check-include-guards + name: check-include-guards + language: python + entry: gdb/check-include-guards.py + # This matches headers in gdbsupport, gdbserver, gdb, and the + # immediate subdirectories of gdb (e.g., gdb/nat) -- but, + # importantly, not gdb/testsuite/*/*.h. + files: '^(gdb(support|server)?)/[^/]*(/[^/]*)?\.h$' diff --git a/gdb/check-include-guards.py b/gdb/check-include-guards.py index 5c61fc90bb0..428b5a71fa2 100755 --- a/gdb/check-include-guards.py +++ b/gdb/check-include-guards.py @@ -22,27 +22,19 @@ # ./gdb/check-include-guards.py gdb/*.h -import glob import re import sys -status = 0 - DEF = re.compile("^#ifndef ([A-Za-z0-9_]+)\n") OLDDEF = re.compile("^#if !defined *\\(([A-Za-z0-9_]+)\\)\n") -def failure(filename, ndx, text): - print(filename + ":" + str(ndx + 1) + ": " + text) - global status - status = 1 - - -def headers(dirname): - return glob.iglob(dirname + "/*.h") +def failure(filename: str, ndx: int, text: str): + print(filename + ":" + str(ndx + 1) + ": " + text, file=sys.stderr) + sys.exit(1) -def skip_comments_and_blanks(ndx, contents): +def skip_comments_and_blanks(ndx: int, contents: list[str]): while ndx < len(contents) and contents[ndx].startswith("/*"): while ndx < len(contents): ndx += 1 @@ -56,12 +48,12 @@ def skip_comments_and_blanks(ndx, contents): return ndx -def write_header(filename, contents): +def write_header(filename: str, contents: list[str]): with open(filename, "w") as f: f.writelines(contents) -def check_header(filename): +def check_header(filename: str): # Turn x/y-z.h into X_Y_Z_H. assert filename.endswith(".h") expected = filename.replace("-", "_") @@ -70,28 +62,28 @@ def check_header(filename): expected = expected.upper() with open(filename) as f: contents = list(f) + if len(contents) == 0: + # Empty file -- pathological but we can just ignore rather + # than crashing. + return if "THIS FILE IS GENERATED" in contents[0]: # Ignore. return if not contents[0].startswith("/*"): failure(filename, 0, "header should start with comment") - return i = skip_comments_and_blanks(0, contents) if i == len(contents): failure(filename, i, "unterminated intro comment or missing body") - return m = DEF.match(contents[i]) force_rewrite = False if not m: m = OLDDEF.match(contents[i]) if not m: failure(filename, i, "no header guard") - return force_rewrite = True symbol = m.group(1) updated = False if symbol != expected: - failure(filename, i, "symbol should be: " + expected) force_rewrite = True if force_rewrite: contents[i] = "#ifndef " + expected + "\n" @@ -99,20 +91,15 @@ def check_header(filename): i += 1 if i == len(contents): failure(filename, i, "premature EOF") - return if not contents[i].startswith("#define "): failure(filename, i, "no define of header guard") - return if contents[i] != "#define " + expected + "\n": - failure(filename, i, "wrong symbol name in define") contents[i] = "#define " + expected + "\n" updated = True i = len(contents) - 1 if not contents[i].startswith("#endif"): failure(filename, i, "no trailing endif") - return if contents[i] != "#endif /* " + expected + " */\n": - failure(filename, i, "incorrect endif") contents[i] = "#endif /* " + expected + " */\n" updated = True if updated: @@ -121,5 +108,3 @@ def check_header(filename): for filename in sys.argv[1:]: check_header(filename) - -sys.exit(status)