From patchwork Wed Mar 19 07:23:34 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022184 Received: from mail-lj1-f181.google.com (mail-lj1-f181.google.com [209.85.208.181]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A4BF21991CD for ; Wed, 19 Mar 2025 07:25:08 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.181 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369110; cv=none; b=d1qWUtTnhSBmux5aPmnuu3BHoZXavS8bcKzgX22qS+erevl3OjIg9suJPmHSODhBWvy76B7qlLJvnBhFts2SK7S8SRxj3oT8Zk3KpLizgN8cEpwDKoWJ44wLMJwqbF8QUMiL2hN6Mxs8O+WbBEoQWQp+FgOQkZeXh1PWhfzWcmI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369110; c=relaxed/simple; bh=ZN4Fc891vezb4fHhCtGKxW+ds1kQv9SdD+KI7ux0BRk=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=JiGw5xCwFCj/6xCcm7ltrpC0vdtGZrqZ29ZcPJ8k3C5X/VkGI9DBkaSt3f4M0nDTTVCrqH6TQMmEd8Xfg1jKJQHE2XeuxxRYE2JKxmhfL+dfLL3ljnCot2KEWhaDT4HOXudb93kT0aCxGWs3r38IdXT4zAtsETHf+ezftZMvAEU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=TMK09jq3; arc=none smtp.client-ip=209.85.208.181 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="TMK09jq3" Received: by mail-lj1-f181.google.com with SMTP id 38308e7fff4ca-30bf1d48843so61769841fa.2 for ; Wed, 19 Mar 2025 00:25:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369106; x=1742973906; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=W9GI9SBf3YemZmUeOSNpHs+f1KiT1YsnXerp+OInJ0E=; b=TMK09jq3eoIvF3jcMAEdWAZwkVbeoG50Tv5x7SlndKCuMtgQP+6C8fbNwviZpij0Ri bH8dRijaPN9XcRYJIOKMD7zSnLXthmt54DZsrXyOBAxKANRFj9mhpNNK0lV/v09U3tqf PsEI5N2fozfBUkOV4xJxde6q9k+RpCTPRLoxqNR/RqoDSwYqkj9SLz6iOuzXFMM+ruus kUQAPfjSyfYuhKUP05LSJOhE07aFUosIMUWw4QGRay4UqeAtteacHEMd7YXNxe3a32mc 3qNFiyHQnKsE+W5mJsH1KYUUJPCTMAHMqL+ZBx/1AcBf2AE1bNJqqcnOCG511Pg9avRW h/Iw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369106; x=1742973906; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=W9GI9SBf3YemZmUeOSNpHs+f1KiT1YsnXerp+OInJ0E=; b=DVJFUJJV9n8WRwg31aVLuV6+RpwEfN8SDkCg058p44ivrnPKp5uX6Mh5ASuCh/OgLv ZJ2wFAQ/xJVrSMtBMPtYTyeRISaMRXzuajvC35a4h6DIJF115gFjiauVkbJHgS5goYgL 7nE8eSh5wLGyLY2Hek8KD2HDVrtrlotBhW20m0XG98hZnUymmti3kbvIx9qe2uBq3UPA hxrVYOZZAE9//CIcuzLEO7RUpdOiNFyspQeRX7YxSEG9rRrXwQFXd70RX6gqn0qcNt8P 8dwaAEA0RbUq+ajwEVNwDK0HVRpZ3HKd0+aEGnUtBFaUl9KPgIgppxBu/rT54/c/te2F 1M2Q== X-Gm-Message-State: AOJu0YwB0D6IDriKYsWSMjcO/7tWxfJ35lx4KvcY7t1GI45M7EUdWtR7 7Y1UkBUgi4IdGcW+thxBOMRVBADqZLbJxM/jdD+igQkzZDWuQfy2dHe2vA== X-Gm-Gg: ASbGncsbwEdP/eF4GuomK7jurRZzTfIdY8Puy1xJ7j/UVzIM/sC4QKgQHzpelghLqOX XGD1em8sG/HdxzrAHg+XlvIHRfTN5Vn2zZ6eeckOwZTAAytSDQT0z7umEha+6GVKyXX6PF6dnYx rUUOkYBZ00wh+WudDZFPcudFNowaqYfM9R5voUBYKh479njo/UqLctcpCuVh1y8Trq7zEPsy1yY BGuqRVCyZ4M1srxjN1sm0/ezd1SDRznZ9Nq/eh/D/sJ6R0QCgjiwep87lDo8rRL86dnx8huZCTI RjCzTpUUXeZCNcjKo3RlemvQAEVI6f///or79robR4dg8u19d3w0CIddPV0F9Q== X-Google-Smtp-Source: AGHT+IFyRtvUr3fGUNcDUM+jPIVCOo0SGY6BzhzlcT1ogwPwlB40n/qC1bd4IXLRe6XTd6Rd/cKlcQ== X-Received: by 2002:a05:651c:2313:b0:30b:cd41:89c7 with SMTP id 38308e7fff4ca-30d6a3fa027mr6233861fa.22.1742369105900; Wed, 19 Mar 2025 00:25:05 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.04 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:04 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Subject: [PATCH 1/8] pretty: tighten function signature to not take `void *` Date: Wed, 19 Mar 2025 08:23:34 +0100 Message-ID: <192fc78dd869f28cb6ae91f3a26a05eb6b6a4bbf.1742367347.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 We take a `void *` and immediately cast it. Both callers already have this pointer as the right type, so tighten the interface and stop casting. Signed-off-by: Martin Ågren --- pretty.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pretty.c b/pretty.c index 0bc8ad8a9a..a4e5fc5c50 100644 --- a/pretty.c +++ b/pretty.c @@ -1437,9 +1437,8 @@ static void free_decoration_options(const struct decoration_options *opts) static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ const char *placeholder, - void *context) + struct format_commit_context *c) { - struct format_commit_context *c = context; const struct commit *commit = c->commit; const char *msg = c->message; struct commit_list *p; From patchwork Wed Mar 19 07:23:35 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022185 Received: from mail-lj1-f179.google.com (mail-lj1-f179.google.com [209.85.208.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4EA021991CD for ; Wed, 19 Mar 2025 07:25:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369116; cv=none; b=PRNLMeF2cdjbX4wTJ1edS+DaCwkKuOiB1ibN55B0zLfRfkjSnAZZ1aX99HYRAEiwZ2VsFL8hVBK2CeosEglkJ7FcLCnfadIPkR3pDEQcOzLvOz1PuFBjgK4ThoiamuoLtk00Qd4j4FBQmezFKLBgA14Of1/RFKkeIOPBcNKKqs8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369116; c=relaxed/simple; bh=q36Nn5XXkvbG0TLNsLQw6og1YVIOTItPwlGSTs20ltQ=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=Hw3+brfFVVNbc2fW3ZmWjWzt3UiB4duHth3LjBAyK9OcX/yUA7UxnJheFVTBHD8KdoaR3RkITfgA8DZFMGznkzHITs9awi3BRfhNRTFbGyyhPJc1hGioUU5ItrF9p9hre8VpRuFKRAFok3oBSve/7yyEaG93wAMVMJ6u5AOOUHQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=H0aFORCe; arc=none smtp.client-ip=209.85.208.179 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="H0aFORCe" Received: by mail-lj1-f179.google.com with SMTP id 38308e7fff4ca-30bf3f3539dso4278621fa.1 for ; Wed, 19 Mar 2025 00:25:14 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369112; x=1742973912; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=8Jqef0PRuNiD0Qcz0fE3OpQ99Td1DgpGZlcLaT7BCMw=; b=H0aFORCeMt2Rg+TLp6ae9GJeiRlB0yRbteNVGu2ro70JGAWTH9J3rlBKXjyzoaBk4M lZRzhL7cP92nDrgRDabaE/a19D22yykFPU+h7dtWNIA8CiysIcDR9kLrhJ5/T/AdS+HP gw+N1iHGMWqpb9gAfBfdIADCDKBGe2cgciJKZ4lE2AnFoJ6g9y/RIolfR/+7gFs8hvq6 frVdaxfIi8t3BFHXlB6fSa4K8MtwuSHhei2+xbP4KLdCu46xYzk1JVdKaUbV3hqA9tCz YEpAWEjI6TzwJUL1Za06csIYIahTlMqLDXlEiAaAZoX8m4Hu9XBSEKtJp57D4LR/XNpk GSjA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369112; x=1742973912; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=8Jqef0PRuNiD0Qcz0fE3OpQ99Td1DgpGZlcLaT7BCMw=; b=rL0cNQYH+VAHqPRvRRCbKn+do5M4m9C/Li8hrUzTeaRPTDkcAiOYM/LH/oO5IT6IEs WFC75XFq6OW2zIAJoXqOa0SYxqTU2xX0Sq/QGGbW4vV+FbG8Ar30BYZm7BvcltMIZWGH nYjIKmaM3BvHRrhqTS1TojTyOKoIH3KPq7BWrnHEK7219yn/5uBymgFjGsq3GJWepst5 5dKegFCnqbSrkwdhW8xUm6mUhK0LijhscHXefiZIgHflAjZ1dQNXItjfygeeu9SNaCw5 iopFtFg181kF465mbm8ra40oNRsgCi/5mY1mw0+gfGeL6vXtt7vhcGkTJ9z/JaXjJ2oL us1Q== X-Gm-Message-State: AOJu0YxKUoVNabKlvdy5ghX+SUYNGvC3hIgLUfof2TBgsZCHxwGTlia2 CYZIGGhqrrsqR8I6L++4KFmbGi4jI1cD3b20ccV7WzX1vGsdqa0afpSPqA== X-Gm-Gg: ASbGnctd+20+9BtWkeHwheXU1LGzzEfJJaqiiXZErNgazEbjH4jETKGSCO2IBW9/CtV Fz7BJm9ELkJ8SieOWvg9Tvzhhe/Mr27U4vTkSFtSUykPZQvRekgz4suDqAaYA1b2ZKN/NVCl4kI PCez5JhCJUSmvnC8MTgeufDoAGp9va9veCbezkzCUxCGA3fvOzzyW3oD7d0EWrkkKY8Zoc7KXAF esVlF83DXrNUvTZoEwcXE4K1XE2XgFDpfby+sd3uBnC3Fh1AWWjNR7GY5hpw7qD3JXQl8s4tNIj BpBvrn+FsLmgTV4pZb1OD+3as9tAJdC5yLPWoVwyYIcm+bCVXxDohiax+4OouA== X-Google-Smtp-Source: AGHT+IHDfVv9zJAknPDy3USml4foE9wveQuc5SuKVwDyK1aCb/bdp2Gl7BFRO8fqkxKIPHrY+IMzmg== X-Received: by 2002:a2e:9cd2:0:b0:30b:f599:d78f with SMTP id 38308e7fff4ca-30cd95bc544mr33747631fa.7.1742369111791; Wed, 19 Mar 2025 00:25:11 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:10 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Jeff King Subject: [PATCH 2/8] pretty: simplify if-else to reduce code duplication Date: Wed, 19 Mar 2025 08:23:35 +0100 Message-ID: <5f787ddac2d80391feadb8cf6be379fc8e58652f.1742367347.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 First we look for "auto,", then we try "always,", then we fall back to the default, which is to do exactly the same thing as we do for "auto,". The amount of code duplication isn't huge, but still: reading this code carefully requires spending at least *some* time on making sure the two blocks of code are indeed identical. Rearrange the checks so that we end with the default case, opportunistically consuming the "auto," which may or may not be there. In the "always," case, we don't actually *do* anything, so if we were into golfing, we'd just write the whole thing as a single if (!skip_prefix(begin, "always,", &begin)) { ... } If we ever learn something new besides "always," and "auto," we'd need to pull things apart again. Plus we still need somewhere to place the comment. Let's focus on code de-duplication rather than golfing for now. Signed-off-by: Martin Ågren --- pretty.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/pretty.c b/pretty.c index a4e5fc5c50..6a4264dd01 100644 --- a/pretty.c +++ b/pretty.c @@ -1076,13 +1076,11 @@ static size_t parse_color(struct strbuf *sb, /* in UTF-8 */ if (!end) return 0; - if (skip_prefix(begin, "auto,", &begin)) { - if (!want_color(c->pretty_ctx->color)) - return end - placeholder + 1; - } else if (skip_prefix(begin, "always,", &begin)) { + if (skip_prefix(begin, "always,", &begin)) { /* nothing to do; we do not respect want_color at all */ } else { /* the default is the same as "auto" */ + skip_prefix(begin, "auto,", &begin); if (!want_color(c->pretty_ctx->color)) return end - placeholder + 1; } From patchwork Wed Mar 19 07:23:36 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022186 Received: from mail-lj1-f175.google.com (mail-lj1-f175.google.com [209.85.208.175]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 18BD524EF7F for ; Wed, 19 Mar 2025 07:25:16 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.175 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369119; cv=none; b=PW8rFA0UFrcaqggRob9ZVU++LmNBWGtnX+76HdaHGYyN2fdvWqjvDNVJspt8+Lrh0IB/HZg3SdQSmOV1sgyIFjgiGpRLLyf+JQd5x9Tx/HOwv6UA23SWULA/yZJV5485vXuoboS2XJBZ9kt14o2NUatdN9Q4anQNh22PiW1pI2o= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369119; c=relaxed/simple; bh=KLlDS11N3toOVeq97bE4WJrpZY69S6KAyE0yuUU6HuE=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=kS/dZcIWaRfh4CEQCUX6k8z3DJuQp2tUovN3I2S4GmD5Q9pny+uAJxZgDi0ybBgCEeJoebg+mjEKWDemdHYLf6TBjf44ID8KRKsygglJVdd6xOFOockH0Tf1ZUeDiCFb34Hr03ox5r/scxid0SO6XdPBXwdyHnJ030X/j2fDonU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=OZ9WR8nV; arc=none smtp.client-ip=209.85.208.175 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="OZ9WR8nV" Received: by mail-lj1-f175.google.com with SMTP id 38308e7fff4ca-30bf3f3539dso4279051fa.1 for ; Wed, 19 Mar 2025 00:25:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369115; x=1742973915; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=ZN4tYwhgPHK4P01ThUx2abeHiZpY3QAT4sT12lJH4nM=; b=OZ9WR8nVptJSH0WMTIi9yEFRFEevTpaJjbwObBReoTnPYmIx5LK0NflH2AogjpNDjl sMsjF6jWOF4y6bP0f76I9mId1XUfqIyCBvTjACdcXICjR5XE/aD15H7eGqFdveLe6fp3 VwsBT9oFm/R8ZD5MIdPVVnBLof2i17gMEu+NrNJ7qrpINWJzrUoSz6swWhOSZ+WHZgYT KWBN3qDPOQlLRjqSLbLiz1kFxC61ZClkSrLexPLnNbhCiW+931gW9eoyTfQ1s9bLwZJG mQOkOy3OBXw0easha8wlw/CCkV4ji2ZvDuUTf38P7DmZ201meoyH1TLm2bZ7mrYSVCVr zTlA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369115; x=1742973915; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=ZN4tYwhgPHK4P01ThUx2abeHiZpY3QAT4sT12lJH4nM=; b=npbBRmPzuKAEcEBjfWKiqvKsX3ZcLdsqSAZ1mjC0Q0T85Zh45Z3zo/FO1mTjji0H+7 Kbb++mdmZRFhwL/UIqzmisqtxl2VC1AHZBVeNxd0XatRfi4dWoEGteeBGGRlwatqwjq8 eXR59rOjAPLJyi6PHKcNmiu2OhN36aiswWI1th6bjLf3H5m3B2Etfsi3tUiYJmkUmfeq Yl8XPfReYNSy+yZp3NsYyc05cOybK9JKk4jvvF5tRybvYc3MU40CzvOmhbaWrohs9odz 8sORDz/KaVQL9GNxdI6XiasXYXolSyHlar1qXQqfq+MR/zyW4cTuaCo6kdisveOCGjUJ PnJw== X-Gm-Message-State: AOJu0YyJ3le93VE/6fjjGKNf1zQrK8P8azagM8J4n6W7SsZyKV9RTU4p Z6+ub8E18vnbaPgRxRUkDTmPLPM/HtjR1yUXlacu30hN8n4ZgJv92Go50A== X-Gm-Gg: ASbGncsmpltwsegDEpNz+szjTMXohE3bY1upFJMnGXp/1oOgIr1USMWACbsKMqp9Djb Ijk8ACqUMKg4CCuFJ7ZTsELLRXVsZD+NDhZAfsR7QwR0l00CJU3lzhX7FNxG32lHopSCFzF00Vn N4xcx2Z8tPzc5P5tPFrTL1TtzLUxN7hxU6F5nOrN4AIYFsrG3HckGXq2KnhkR3AG5mOvm4mwyyP mVy9UA1tB87TGIn4ReWIpOm2CSQ3Cd++ZBrvsrFgnkKD5iXlSZV+gMmUxy0Vm/ZxFTDbpSptENw 41irfre213dg2NTESo5iceqTQ+t42K29KNp/ZJseG6sQYjawraOxqdMPjIl1LA== X-Google-Smtp-Source: AGHT+IE3MmY3WxGvFV5yqLAAU+lcClDsbj+rIRc34h6l28oOGJnWHbuccls2fRns2hUmvwAu1oS6KQ== X-Received: by 2002:a2e:9cd2:0:b0:30b:f599:d78f with SMTP id 38308e7fff4ca-30cd95bc544mr33748271fa.7.1742369114461; Wed, 19 Mar 2025 00:25:14 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.13 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:13 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Subject: [PATCH 3/8] pretty: collect padding-related fields in separate struct Date: Wed, 19 Mar 2025 08:23:36 +0100 Message-ID: <1adaa171fb2de74aef811bb5e410a08da72718cf.1742367347.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Padding ("%<" and "%>") involves three fields of `struct format_commit_context`. This goes all the way back to commits a57523428b (pretty: support padding placeholders, %< %> and %><, 2013-04-19) and 1640632b4f (pretty: support %>> that steal trailing spaces, 2013-04-19). These fields are not used for anything else. Make that clearer by collecting them into their own little struct. Let our parser populate just that struct to make it obvious that the rest of the big struct does not influence the parsing. Signed-off-by: Martin Ågren --- pretty.c | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/pretty.c b/pretty.c index 6a4264dd01..e5e8ef24fa 100644 --- a/pretty.c +++ b/pretty.c @@ -887,6 +887,12 @@ enum trunc_type { trunc_right }; +struct padding_args { + enum flush_type flush_type; + enum trunc_type truncate; + int padding; +}; + struct format_commit_context { struct repository *repository; const struct commit *commit; @@ -894,13 +900,11 @@ struct format_commit_context { unsigned commit_header_parsed:1; unsigned commit_message_parsed:1; struct signature_check signature_check; - enum flush_type flush_type; - enum trunc_type truncate; const char *message; char *commit_encoding; size_t width, indent1, indent2; int auto_color; - int padding; + struct padding_args pad; /* These offsets are relative to the start of the commit message. */ struct chunk author; @@ -1112,7 +1116,7 @@ static size_t parse_color(struct strbuf *sb, /* in UTF-8 */ } static size_t parse_padding_placeholder(const char *placeholder, - struct format_commit_context *c) + struct padding_args *p) { const char *ch = placeholder; enum flush_type flush_type; @@ -1167,8 +1171,8 @@ static size_t parse_padding_placeholder(const char *placeholder, if (width < 0) return 0; } - c->padding = to_column ? -width : width; - c->flush_type = flush_type; + p->padding = to_column ? -width : width; + p->flush_type = flush_type; if (*end == ',') { start = end + 1; @@ -1176,15 +1180,15 @@ static size_t parse_padding_placeholder(const char *placeholder, if (!end || end == start) return 0; if (starts_with(start, "trunc)")) - c->truncate = trunc_right; + p->truncate = trunc_right; else if (starts_with(start, "ltrunc)")) - c->truncate = trunc_left; + p->truncate = trunc_left; else if (starts_with(start, "mtrunc)")) - c->truncate = trunc_middle; + p->truncate = trunc_middle; else return 0; } else - c->truncate = trunc_none; + p->truncate = trunc_none; return end - placeholder + 1; } @@ -1504,7 +1508,7 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ case '<': case '>': - return parse_padding_placeholder(placeholder, c); + return parse_padding_placeholder(placeholder, &c->pad); } if (skip_prefix(placeholder, "(describe", &arg)) { @@ -1788,7 +1792,7 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */ { struct strbuf local_sb = STRBUF_INIT; size_t total_consumed = 0; - int len, padding = c->padding; + int len, padding = c->pad.padding; if (padding < 0) { const char *start = strrchr(sb->buf, '\n'); @@ -1815,7 +1819,7 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */ } len = utf8_strnwidth(local_sb.buf, local_sb.len, 1); - if (c->flush_type == flush_left_and_steal) { + if (c->pad.flush_type == flush_left_and_steal) { const char *ch = sb->buf + sb->len - 1; while (len > padding && ch > sb->buf) { const char *p; @@ -1841,11 +1845,11 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */ ch = p - 1; } strbuf_setlen(sb, ch + 1 - sb->buf); - c->flush_type = flush_left; + c->pad.flush_type = flush_left; } if (len > padding) { - switch (c->truncate) { + switch (c->pad.truncate) { case trunc_left: strbuf_utf8_replace(&local_sb, 0, len - (padding - 2), @@ -1868,9 +1872,9 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */ strbuf_addbuf(sb, &local_sb); } else { size_t sb_len = sb->len, offset = 0; - if (c->flush_type == flush_left) + if (c->pad.flush_type == flush_left) offset = padding - len; - else if (c->flush_type == flush_both) + else if (c->pad.flush_type == flush_both) offset = (padding - len) / 2; /* * we calculate padding in columns, now @@ -1882,7 +1886,7 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */ local_sb.len); } strbuf_release(&local_sb); - c->flush_type = no_flush; + c->pad.flush_type = no_flush; return total_consumed; } @@ -1927,7 +1931,7 @@ static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */ } orig_len = sb->len; - if (context->flush_type == no_flush) + if (context->pad.flush_type == no_flush) consumed = format_commit_one(sb, placeholder, context); else consumed = format_and_pad_commit(sb, placeholder, context); From patchwork Wed Mar 19 07:23:37 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022187 Received: from mail-lj1-f179.google.com (mail-lj1-f179.google.com [209.85.208.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2745724EF61 for ; Wed, 19 Mar 2025 07:25:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369121; cv=none; b=bozHf8OhYP+YRIC8tQdN5m+Hu/s+087Dj0qBkA7kpE0+fdI+3r2L4N0AiGVauLbAOZcS6Cp3atLYwjdeOz41RkGFS/0f2aLWkgS61ARpTkLkaEfMqbhyBgTtYvXyqbeGUZ4hrBA7UgE/b38YgfopwP11LuP9dZ3uI/OKs8Znqe0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369121; c=relaxed/simple; bh=Bh1EYjOdZwmorXY5gKtPfXBrXraHG7/arSeds7FWM2Q=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=rSFgeheOLV/Amil4HHxAuX433uZpWVF6IVXQUCPB94koFJwdZdKXPRNRSR/KT+K7Uca6Ls1eKx8iB7aqNJHLk4wiw9080qr0/FSh2iA7lLQRgBiveFgtHNfuN77NF0SGVUB9cOn3+5/IfWOvEDPEiIqlo+HULIpMf9gb+Sgi6o4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=NYLe34RN; arc=none smtp.client-ip=209.85.208.179 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="NYLe34RN" Received: by mail-lj1-f179.google.com with SMTP id 38308e7fff4ca-30c0517142bso57450051fa.1 for ; Wed, 19 Mar 2025 00:25:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369117; x=1742973917; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=cg3FKRnHjvhREnd6ibZefrlSHHX4d7SlDKdhUkdxTNU=; b=NYLe34RNlCj6t1MIMFmXRWX5qCl4eyq2I70yeK/56Pklxw6q5j5oUytxZ5LKH4awn5 RSzIrf2oZWVZAlONxihouwN0vhKDy6xtChQQZm1mDHK/HrtAQZzU/bAzIrMAjxXuVQr/ TpR6Y9jFqkwkhSxS+iCqVSK0oL5OCPnpJXkAd7CwoXu2NJf97x8/8Rr6FvZh7iWXVn1Z 50GuyeK4l7rY3GKoDM9cTG/c2e2uhibIglx+xlRlJrYE+snIv0Q5nIByEH9ToxSolDoW pnWpCRoMjUD95qKnBZ+t8cir3gxg7FWHyrCXiGvGaqw+zY7XtaNQkw5bE2tkGQVFypXZ mMHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369117; x=1742973917; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=cg3FKRnHjvhREnd6ibZefrlSHHX4d7SlDKdhUkdxTNU=; b=vCzM071g/xfqU6h5RjwpHzftC6NKv6NPZ93x5d82bRzhiv/3Hmky5zv2G/k5gL++Pi 7BD+nJjOn5GF1oeOb+Df/0sBo2v+KhLv+90kB6NGWQSMqFCvzlYh+eEvQ5dmK42AQ2EQ GzE/8lKSeoJxJFXVLbJlWWJWITvyogWRLQ9s/YVLsCfoIutPGxcVRuI6Dh60CLn1l3q1 pZWxEH5dqBuOGBJ8EVHxb5PK2jUeb0w6tXRro1U4HwLFagNdNFC8NYZqQxDjZ5AMzji0 apFspZf1SU+GvxL3GP9W/wZ9y0JELeFQfWwsXgl2acIS/1SnWH1PXenxnqghqKGu8RlK jU7A== X-Gm-Message-State: AOJu0YyHFCAxHOPK/OW2MTRku5Fo7R4LfmijlVpErKausgQDcbcXg1+o J152H6RUGFdVFSB3pM2EroV2EiGM9iWc7erINd0SLxGxKn88WlyWAe/kUQ== X-Gm-Gg: ASbGncsUSKscVuJpPUiH2u1FJ4Ot5IQsFJ4ig9H00WyBKd/DzBR7EEPJMaJU6J8HS8B tXWAFr0XZYrsh9Bu+aimVOOuS6yMOU8K4Bdlo7fM7QsR9OerNtQTITMpY1tH7xY2rV48nHIMGjc dV8qZgIz/3Qu1Xfm0cME84IP/Jwkp2KtLt4fpQQKTzGVyitLswtl2lVD3hTHRDUx/y8SlLWfLCj 6z/XJaWOaxW5HBOIxlLLW8g4UywyLXbIR1ERp3rwiTjrmGfq7CHVVUD0dq6rxrAlV8ydGzuVr7s hcGVhPPCwQDksOItuqNHYpicsbp0C7miTiRTzkiBFZhndNKrDTvauoVv8uXPwA== X-Google-Smtp-Source: AGHT+IFdSdPcLfW51N/qhsnA3G6oVMB1UKJCx4B8hx2oXgnLpQhQSrRuM01QLoyZbMwHKYr2MbcUHA== X-Received: by 2002:a2e:3c0e:0:b0:30d:629c:4333 with SMTP id 38308e7fff4ca-30d6a44b527mr5922561fa.34.1742369116484; Wed, 19 Mar 2025 00:25:16 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.15 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:15 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Subject: [PATCH 4/8] pretty: fix parsing of half-valid "%<" and "%>" placeholders Date: Wed, 19 Mar 2025 08:23:37 +0100 Message-ID: <7d6b62006ecaf7db159e8db0c85455ed58027ce6.1742367347.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 When we parse a padding directive ("%<" or "%>"), we might populate a few of the struct's fields before bailing. This can result in such half-parsed information being used to actually introduce some padding/truncation. When parsing a "%<" or "%>", only store the parsed data after parsing successfully. The added test would have failed before this commit. It also shows how the existing behavior is hardly something someone can rely on since the non-consumed modifier ("%<(10,bad)") shows up verbatim in the pretty output. We could let the caller use a temporary struct and only copy the data on success. Let's instead make our parsing function easy to use correctly by letting it only touch the output struct in the success case. While setting up a temporary struct for parsing into, we might as well initialize it to a well-defined state. It's unnecessary for the current implementation since it always writes to all three fields in a successful case, but some future-proofing shouldn't hurt. Note that the test relies on first using a correct placeholder "%<(4,trunc)" where "trunc" (`trunc_right`) lingers in our struct until it's then used instead of the invalid "bad". The next commit will teach us to clean up any remnants of "%<(4,trunc)" after handling it. Signed-off-by: Martin Ågren --- pretty.c | 18 ++++++++++++------ t/t4205-log-pretty-formats.sh | 6 ++++++ 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/pretty.c b/pretty.c index e5e8ef24fa..a4fa052f8b 100644 --- a/pretty.c +++ b/pretty.c @@ -1121,6 +1121,11 @@ static size_t parse_padding_placeholder(const char *placeholder, const char *ch = placeholder; enum flush_type flush_type; int to_column = 0; + struct padding_args ans = { + .flush_type = no_flush, + .truncate = trunc_none, + .padding = 0, + }; switch (*ch++) { case '<': @@ -1171,8 +1176,8 @@ static size_t parse_padding_placeholder(const char *placeholder, if (width < 0) return 0; } - p->padding = to_column ? -width : width; - p->flush_type = flush_type; + ans.padding = to_column ? -width : width; + ans.flush_type = flush_type; if (*end == ',') { start = end + 1; @@ -1180,16 +1185,17 @@ static size_t parse_padding_placeholder(const char *placeholder, if (!end || end == start) return 0; if (starts_with(start, "trunc)")) - p->truncate = trunc_right; + ans.truncate = trunc_right; else if (starts_with(start, "ltrunc)")) - p->truncate = trunc_left; + ans.truncate = trunc_left; else if (starts_with(start, "mtrunc)")) - p->truncate = trunc_middle; + ans.truncate = trunc_middle; else return 0; } else - p->truncate = trunc_none; + ans.truncate = trunc_none; + *p = ans; return end - placeholder + 1; } return 0; diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh index f81e42a84d..26987ecd77 100755 --- a/t/t4205-log-pretty-formats.sh +++ b/t/t4205-log-pretty-formats.sh @@ -1130,6 +1130,12 @@ test_expect_success 'log --pretty with invalid padding format' ' test_cmp expect actual ' +test_expect_success 'semi-parseable padding format does not get semi-applied' ' + git log -1 --pretty="format:%<(4,trunc)%H%%<(10,bad)%H" >expect && + git log -1 --pretty="format:%<(4,trunc)%H%<(10,bad)%H" >actual && + test_cmp expect actual +' + test_expect_success 'log --pretty with magical wrapping directives' ' commit_id=$(git commit-tree HEAD^{tree} -m "describe me") && git tag describe-me $commit_id && From patchwork Wed Mar 19 07:23:38 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022188 Received: from mail-lf1-f54.google.com (mail-lf1-f54.google.com [209.85.167.54]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3C170224896 for ; Wed, 19 Mar 2025 07:25:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.54 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369123; cv=none; b=r+6qD3NBIsnbXuD2Fkxkw1TX4RFLBQ4YteOvrHkbeDq1K6VJaAHSl/K3KK3B7antM5fUixPy2aFyNcm7Mrq4XJvIDq19MKC+n9peVJ4vs7fz6C6wOye86RgiCwZ/tPf9YOqkl/mTLDU4lbzBdfzRRMsHkjjz5uWbZqBlRpOkVCo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369123; c=relaxed/simple; bh=lPomomhH2Jp5NS+SthBXAIhVGg5p2aKU1Q9Sam35MHA=; h=From:To:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=e7l4Qlnrrs0hzl7+GKgkLdvgB9+GJkXyQcwAmgoUVtiT/S0uoaiQcLCLThdZ6AUqEoHBgINOMB+M4PwbYErEoBA0bH0kqhqX7eQ19R6st6n7JoC9WuJtPFXU8Uw5kX3W92Gk/aVBITmT2WRjkmYxVuUXBsu9jKkKAUKJJr/Jd2w= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=NixRX6Bi; arc=none smtp.client-ip=209.85.167.54 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="NixRX6Bi" Received: by mail-lf1-f54.google.com with SMTP id 2adb3069b0e04-5499614d3d2so6898363e87.3 for ; Wed, 19 Mar 2025 00:25:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369119; x=1742973919; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=Qv61sTArLdp+ygVLAED5QvzRkh3KapfyJ8EUqp7yke0=; b=NixRX6Bina/mky0hCyDTXQI5+iFC3Zo9yZr4Y26OFQZxcIjvC5Cu6cQ+5sMZJX6oCG n9u/dL62pN494iK61302OgaQkz7FjrEI3bk9FFyv+3cOZtXOZvjpPdnkOj0WB6kISoAf YJyhvlXuddNrZ+gnUCwxyP74OP+fKSTeAOgHjzKyD0zhdYpPGDE4ZX5Ea0xAe3JyVNQs 2LUI87tdxUaoeSv9I3y1rWO1lQd9kVpsYF+t9LUV/UdLORNR+S0MPjXFXfxfLI28U1A3 oXZhjyJanlny72CsxYiyCbprrTvlq2LmsXWBtpSfrVxwb+5CfcZjn1yQXz9dfQHfJArj 0hrQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369119; x=1742973919; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Qv61sTArLdp+ygVLAED5QvzRkh3KapfyJ8EUqp7yke0=; b=DzcgcmaVzgAkPla26jxmjF+4XgwovO4OaPg8l8fhWt9JQnmY9gqiNFwHo6FgUfeZVQ fzxIRWd9ka2nWyBOBuvkaHxO1iTDBg5CjtbOuhPRYLefApyVlO0bwYMKq1KOk6FSA/P3 6/vZiJZNBDN1rEtb1VTb8Mr++Lr2tm6BwMmJE6B0JwVMdzOM+zjDtcgAepy5aJ8NCvqS ZqIyI8c/hi4t95LbecNfiqIvJuuM6sttCMt0/A//uvGe9TVPDEJ/LgNYHPU6Q5lO4WRo TGdjew5fv+V1hCvxlG4xJT7WvebBiPiTBC/1L2NsAs3JTC+1ZqUSYQqRZ/VUDXTkxNSq PRJA== X-Gm-Message-State: AOJu0Yx84VF/SN83K1z0LFiQtIaKJnyZr8sg+nNMQR5eiaGZo2bm9ypz UurFEqgX17Wp4VIjPEF02sVc7f7x4Q7GEtBbu7lePCEf2bBb1VtwnnziTQ== X-Gm-Gg: ASbGnctHP3qPXhArTtRp5GZT7BezW68wkCM7hxv/3P6lUUvXnamv52o/b/5T8WECWDF 4m6JzMqNBPMAZb8SmZB9VPwUDfSp3qJf3vnKbgqN2zPMSfoipJ3bFugcnKG35cL3XRUvvJhbXFJ lcmBhaTNL3h5MuOV6rxDzuSEHoD8ht9FKIgNpDVYmXjAcfqrVjOV2+bSAzR1HgJ/jDCJ520uLlq ATtREXekr3auJ4tHQS8YXzWtxpmDMC7OYnOIocRLwFht8eMksJvewtFdjTGpAU1NAAc9QgtdtJq lhrYhmgzeSJFtVuZVyDK/3aZwdv94UvBXzG5oZ627ZJ/37BRO01dsbTqOupUlA== X-Google-Smtp-Source: AGHT+IF6YXGMWRXVV/QtsPVgr++HkbhmUTRCC/g6WmltZZUYSDR34O9vJuA/g1VcggQTB/c60W8I4w== X-Received: by 2002:a05:6512:1591:b0:540:2fd2:6c87 with SMTP id 2adb3069b0e04-54acb1b81ecmr481380e87.16.1742369118694; Wed, 19 Mar 2025 00:25:18 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.17 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:17 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Subject: [PATCH 5/8] pretty: after padding, reset padding info Date: Wed, 19 Mar 2025 08:23:38 +0100 Message-ID: X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 After handling a padding directive ("%<" or "%>"), we leave the `struct padding_args` in a halfway state. We modify it a bit as we apply the padding/truncation so that by the time we're done, it can't be in quite as many states as when we started. Still, we don't fully restore it to its default, no-action state. "%<" and "%>" should only affect the next placeholder, but leaving a bit of state around doesn't make it obvious that we don't spill any of it into our handling of later placeholders. The previous commit closed off a way of populating only half the `struct padding_args`, thereby fixing a bug that *also* relied on then having the other half contain this kind of lingering data. After that fix, I haven't figured out a way to provoke a bug using just this here half of the issue. Still, after handling padding, let's drop all remnants of the previous "%<" or "%>". Unlike the bug fixed in the previous commit, this could have some realistic chance of regressing something for someone if they've actually been using such state leftovers (knowingly or not). Still, it seems worthwhile to try to tighten this. This change to pretty.c would have been sufficient to make the test added in the previous commit pass. Belt and suspenders. Signed-off-by: Martin Ågren --- pretty.c | 2 ++ t/t4205-log-pretty-formats.sh | 9 +++++++++ 2 files changed, 11 insertions(+) diff --git a/pretty.c b/pretty.c index a4fa052f8b..f53e77ed86 100644 --- a/pretty.c +++ b/pretty.c @@ -1893,6 +1893,8 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */ } strbuf_release(&local_sb); c->pad.flush_type = no_flush; + c->pad.truncate = trunc_none; + c->pad.padding = 0; return total_consumed; } diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh index 26987ecd77..d34a7cec09 100755 --- a/t/t4205-log-pretty-formats.sh +++ b/t/t4205-log-pretty-formats.sh @@ -1124,6 +1124,15 @@ test_expect_success 'log --pretty with space stealing' ' test_cmp expect actual ' +test_expect_success 'only the next placeholder gets truncated' ' + { + git log -1 --pretty="format:%<(4,trunc)%H" && + printf "$(git rev-parse HEAD)" + } >expect && + git log -1 --pretty="format:%<(4,trunc)%H%H" >actual && + test_cmp expect actual +' + test_expect_success 'log --pretty with invalid padding format' ' printf "%s%%<(20" "$(git rev-parse HEAD)" >expect && git log -1 --pretty="format:%H%<(20" >actual && From patchwork Wed Mar 19 07:23:39 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022189 Received: from mail-lj1-f177.google.com (mail-lj1-f177.google.com [209.85.208.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C76BC24EAB7 for ; Wed, 19 Mar 2025 07:25:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.177 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369125; cv=none; b=u6SIVdx+PSmmL3S2yy5OtmlbmSNhX7KqnO6KcZkpsGyoxJPGZqnvThVY66CYofS/BmIYUD/8TA+LjdV33AFUnsy17n6n0iQotbacBW4h+mWr3p61XJqKz49sXBiApcQ2Rm6R76AX/YmjruGJ0SET3oy0STmLQcgVv3WMjgaGSlc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369125; c=relaxed/simple; bh=ZhWYH9jjBv7Uyk+RY0wtudJBWUtR6xNsvFVTJy814KE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=oz6kJaf4w+QByebMsg3pSEhlMHDjTjzCKvNDREPTZ7JL7dm3WncE8V/ISlhC9ME0yMNU2heIWQYYEzciCk7B1uAl/QzHCJIoY17ZTM2xVM6IMb6ywP5GAQ5qZLyGfhFrCuQ1jMBU798y0nmy4XcSKEZtxKMja3hDkZxTfglA9ZU= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=MUIAZ2qV; arc=none smtp.client-ip=209.85.208.177 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="MUIAZ2qV" Received: by mail-lj1-f177.google.com with SMTP id 38308e7fff4ca-30bd21f887aso59480231fa.1 for ; Wed, 19 Mar 2025 00:25:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369121; x=1742973921; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=bc8zgkSIWBKAVbCPavklAohqEmAoFhBmo0Jaap5WPCI=; b=MUIAZ2qV/iBosOszCqDtPjzUGlVih9z9niR3SiMZJOfB0iLFnRmKXyGJreRa/cJAN3 OMBJcWPC1whSSDGbalNDDq1Y4nea8WCdWHJM1sW8plSOft4TQhTWSoKfPybDAscIcs76 GikiDuPYXzv8wGzrLuYRc9v5/+S2amQJV22hZLyfJhC8VZdd6CI/b4CdX7aAxRJTwgbw LekYYdf5EZdzEsDO1zHxu853FhfwtLFnXyVOrV6e1RyMEgd/2Opyye7tjRZtzrQxGeyR J+mIt6ox5YPC5UL9kkZCatc3siU6c3K6vZO+EH8fiFwRARnaSyfe8U1SRzstSYhPli+v B0lg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369121; x=1742973921; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=bc8zgkSIWBKAVbCPavklAohqEmAoFhBmo0Jaap5WPCI=; b=cO4amyJ1DYFAHLYkTw0DQRciItBMOpZuKxIvZXLkpU+DCmkC9Bn0SuMPN3pcsq1Bdt 4pwkYkGcFPzWDesZgnjighQyyVmjBKyhiT+2iJWwgMwSXeNHhHAo8P7Y0b4G29Hh2Gai +rkIf5Y/BxHxcthxkDIrGQF4ck0J+PUrEzv4sCMvB0Nm65J4xUqJizw7BZHrsaFiEdV1 z9GjSbEjYh2eKIk6kyvr07mFUPuUCq3RgOVyC8IbXnV8P0hXJSzqV+A/s8+3juT1WdAF 0c7XD/P50jvCOboK/nCf3CDpGX2xY9JngbDwX/4xDrQf3+euUShzYEiNe8Z48ffGNAri v1/A== X-Gm-Message-State: AOJu0YyfmfOGSSJwt/94V3qDYumz8grqsG3G+YT69WJHBRvH62lQOxMX M0TYo093vUtKLdBUu7a/Am3fSQ1+2gQmo+Yos1xJkaMzb8U9nr17YKYzMw== X-Gm-Gg: ASbGncsy8bAkkHHpUquogGAGROv79A4OKZau8LtXe7w+6K2Kg0U/9T8Kn+GKu7YIJkU LzuW87V9ZuepTc8sVWKsuYVGeG/Wz5RiI0rPAYWpbcSeHAbkmGxi+EBaJF2ROUSILDp+G4zcSej AfQ5RyPScycmmucwFtmSZisob9M0KDmLc1+EpwVoZi9AjpO7IvSXD0ressls1TcXJjihIJLgSob qvljDxXLWnCB3ByAgdprnpZOusjbhLQaSF1Ny6GwFVtTo2Bvxj7tCSIR8wce752MKLbcIC0IOuO xw5HHr5eI7f/O/fkxr1v9gY+uojNhjJjuJp6sQG3z+qTZpMX2FQZF0qZvoJCtg== X-Google-Smtp-Source: AGHT+IH2297ywTuUmmKbfbSmDvCP8iOVK5h0I0IB29oN5vJDkSQQcYBbGHwa5t+xHhyd4/WPE4nBgQ== X-Received: by 2002:a05:651c:2120:b0:30b:fd28:a771 with SMTP id 38308e7fff4ca-30d6a1cc588mr6734551fa.0.1742369121259; Wed, 19 Mar 2025 00:25:21 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:19 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Patrick Steinhardt , =?utf-8?q?Ren=C3=A9_Scharfe?= Subject: [PATCH 6/8] pretty: refactor parsing of line-wrapping "%w" placeholder Date: Wed, 19 Mar 2025 08:23:39 +0100 Message-ID: <465c91155eb30197b5eac00d294dc6e7ea2dd310.1742367347.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Our parsing of a "%w" placeholder is quite a big chunk of code in the middle of our switch for handling a few different placeholders. We parse into three different variables, then use them to compare to and update existing values in the big `struct format_commit_context`. Pull out a helper function for parsing such a "%w" placeholder. Define a struct for collecting the three variables. Unlike recent commits, parsing and subsequent use are already a bit more separated in the sense that we don't parse directly into the big context struct. Thus, unlike the preceding commits, this does not fix any bugs that I'm aware of. There's still value in separating parsing and usage more clearly and simplifying `format_commit_one()`. Note that we use two different types for these values, `unsigned long` when parsing, `size_t` when eventually applying. Let's go for `size_t` in our struct. I don't know if there are platforms where assigning an `unsigned long` to a `size_t` could truncate the value, but since we already verify the values to be at most 16 KiB, we should be able to fit them into any sane `size_t`s. Signed-off-by: Martin Ågren --- pretty.c | 120 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 76 insertions(+), 44 deletions(-) diff --git a/pretty.c b/pretty.c index f53e77ed86..c44ff87481 100644 --- a/pretty.c +++ b/pretty.c @@ -893,6 +893,10 @@ struct padding_args { int padding; }; +struct rewrap_args { + size_t width, indent1, indent2; +}; + struct format_commit_context { struct repository *repository; const struct commit *commit; @@ -902,7 +906,7 @@ struct format_commit_context { struct signature_check signature_check; const char *message; char *commit_encoding; - size_t width, indent1, indent2; + struct rewrap_args rewrap; int auto_color; struct padding_args pad; @@ -1034,18 +1038,21 @@ static void strbuf_wrap(struct strbuf *sb, size_t pos, static void rewrap_message_tail(struct strbuf *sb, struct format_commit_context *c, - size_t new_width, size_t new_indent1, - size_t new_indent2) + const struct rewrap_args *new_rewrap) { - if (c->width == new_width && c->indent1 == new_indent1 && - c->indent2 == new_indent2) + const struct rewrap_args *old_rewrap = &c->rewrap; + + if (old_rewrap->width == new_rewrap->width && + old_rewrap->indent1 == new_rewrap->indent1 && + old_rewrap->indent2 == new_rewrap->indent2) return; + if (c->wrap_start < sb->len) - strbuf_wrap(sb, c->wrap_start, c->width, c->indent1, c->indent2); + strbuf_wrap(sb, c->wrap_start, old_rewrap->width, + old_rewrap->indent1, old_rewrap->indent2); + c->wrap_start = sb->len; - c->width = new_width; - c->indent1 = new_indent1; - c->indent2 = new_indent2; + c->rewrap = *new_rewrap; } static int format_reflog_person(struct strbuf *sb, @@ -1443,6 +1450,57 @@ static void free_decoration_options(const struct decoration_options *opts) free(opts->tag); } +static size_t parse_rewrap(const char *placeholder, struct rewrap_args *rewrap) +{ + unsigned long width = 0, indent1 = 0, indent2 = 0; + char *next; + const char *start; + const char *end; + + memset(rewrap, 0, sizeof(*rewrap)); + + if (placeholder[1] != '(') + return 0; + + start = placeholder + 2; + end = strchr(start, ')'); + + if (!end) + return 0; + if (end > start) { + width = strtoul(start, &next, 10); + if (*next == ',') { + indent1 = strtoul(next + 1, &next, 10); + if (*next == ',') { + indent2 = strtoul(next + 1, + &next, 10); + } + } + if (*next != ')') + return 0; + } + + /* + * We need to limit the format here as it allows the + * user to prepend arbitrarily many bytes to the buffer + * when rewrapping. + */ + if (width > FORMATTING_LIMIT || + indent1 > FORMATTING_LIMIT || + indent2 > FORMATTING_LIMIT) + return 0; + + /* + * These values are small enough to fit in any + * real-world size_t. + */ + rewrap->width = width; + rewrap->indent1 = indent1; + rewrap->indent2 = indent2; + + return end - placeholder + 1; +} + static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ const char *placeholder, struct format_commit_context *c) @@ -1478,40 +1536,13 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ return ret; } case 'w': - if (placeholder[1] == '(') { - unsigned long width = 0, indent1 = 0, indent2 = 0; - char *next; - const char *start = placeholder + 2; - const char *end = strchr(start, ')'); - if (!end) - return 0; - if (end > start) { - width = strtoul(start, &next, 10); - if (*next == ',') { - indent1 = strtoul(next + 1, &next, 10); - if (*next == ',') { - indent2 = strtoul(next + 1, - &next, 10); - } - } - if (*next != ')') - return 0; - } - - /* - * We need to limit the format here as it allows the - * user to prepend arbitrarily many bytes to the buffer - * when rewrapping. - */ - if (width > FORMATTING_LIMIT || - indent1 > FORMATTING_LIMIT || - indent2 > FORMATTING_LIMIT) - return 0; - rewrap_message_tail(sb, c, width, indent1, indent2); - return end - placeholder + 1; - } else - return 0; - + { + struct rewrap_args rewrap; + res = parse_rewrap(placeholder, &rewrap); + if (res) + rewrap_message_tail(sb, c, &rewrap); + return res; + } case '<': case '>': return parse_padding_placeholder(placeholder, &c->pad); @@ -2005,6 +2036,7 @@ void repo_format_commit_message(struct repository *r, }; const char *output_enc = pretty_ctx->output_encoding; const char *utf8 = "UTF-8"; + const struct rewrap_args rewrap_reset = { 0 }; while (strbuf_expand_step(sb, &format)) { size_t len; @@ -2016,7 +2048,7 @@ void repo_format_commit_message(struct repository *r, else strbuf_addch(sb, '%'); } - rewrap_message_tail(sb, &context, 0, 0, 0); + rewrap_message_tail(sb, &context, &rewrap_reset); /* * Convert output to an actual output encoding; note that From patchwork Wed Mar 19 07:23:40 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022190 Received: from mail-lj1-f173.google.com (mail-lj1-f173.google.com [209.85.208.173]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 70A7E24EF9B for ; Wed, 19 Mar 2025 07:25:26 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.173 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369128; cv=none; b=mDO+rKhASGwkTDCRy03D/2k6JUCeY8h5rCi0keXcWNeEi897jWpM2q2Z1ORybc53XP8e6dZcyVGVHQOl1vEWHLlX4FseuuUDgZ76sUEkv36xc6v3mKqUILvU6VpBI0Hzs4sllFjCE9Wk2+OI8YpJI7Mpl1zsWuhfnH/AEwaq4Xs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369128; c=relaxed/simple; bh=gz1prJjDZEcrqdQ36GW6UD6vsUPNdi/R2etgQN8/klo=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=exBlTA/sTwfT09BseUDphxmnBM8Mt6wx+5Z86O1WpxIS7ZSnOqd0eTlvpm3vauP9tYPyFeEXJSYjyGCMc00HloC4R4BbCXiIxVkYM/hU4WY7tkXkViJm+dQ7JCMGdWXGDgj7sJB78bi0ElS610AOaL5a+5cYiJeMtxHJE5B6FIs= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=bBA+/3zl; arc=none smtp.client-ip=209.85.208.173 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="bBA+/3zl" Received: by mail-lj1-f173.google.com with SMTP id 38308e7fff4ca-30613802a6bso71381271fa.1 for ; Wed, 19 Mar 2025 00:25:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369124; x=1742973924; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=qNfmTcWnY80hZ5/wwAmLAry92b+eyfMdh8mS6MNaui4=; b=bBA+/3zlMw4Pxd89vbPpiVVIgWfrZucLyikwrJOvAgHYhCBPKONmOnPbNqINWUI8qG jx4VsCqfmF7Te4drlZ87Bo7R596VpF2dCguZFrBzWPMhnXmZavJhvEQpEUzvb311eLGd dN/9z9v4U0uzo2ZwW4ds4+rig+idSrnXYKZJKj8JO++8y62NuaqnK/KXzQcUH4qV+kFY dG1EDIOK3/iQJX2wsMUzg8tr+24Ca5fBHcAGrPWbsgsj1CqT4DuOnaHSEqD36A0DjQ1E cMV8dyfEaRrKo0/5MxDucULiCGI9wLKy0HIodagFz6UVI482HON7aRvm7s9Nt6B00FSQ lnLw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369124; x=1742973924; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=qNfmTcWnY80hZ5/wwAmLAry92b+eyfMdh8mS6MNaui4=; b=xDxE5MGQHtI4QbnxA///uMfR44Nee6Os7Z1eizfvmWz0EoGb8ufOOy6Uddm4fFH03I Sbyc69tluIWh7+PFmCpTuv1yDO3YWgoWrxWAdQlsMEr/m2Wgg5Lv2wY4ZZVVXEkjb5+r HqHPvkaDcp9wqSBDSEZkkXRn1yIqj491fi5AsvhPtMAtE4YUkmPHafkXspaHJAdzOVv5 8Cubya45jIIuUZdlY4AnM3v5SDGNeUDh+cionG5QBJUsicOSD1X7XEKG3a6+ks80+tbD ES//GXm5R/+ycK0vLMvXpwLWu6e8YLqm48dBNKKHF1eLTzNMsMqy2o3N6ZyG2KiQzZV8 JKpQ== X-Gm-Message-State: AOJu0Ywi/ABfOdMh9C4cx+fVuBtNCfHGSfv1nPNSurOl+M76fg0DWiKU bxUqtYWKz8+fv3IR4kg1Fi8jQtdqvb0B67tjbWo0AeG9LJ25+q1LICmomA== X-Gm-Gg: ASbGncu/yhhCEgz+NIryXNeqeJEFtPx7bFGOgdS91XCp6rQQbrSkbmR+FQjk2Fgweh+ ojegOpIz9ivTrD0hBx4nR2B5Upvf7S2+mqSjoGYH7Q1b6zBZxJ5Zj3BdZSPdkQ5h1qwrS0hUH/x QfZ4hAd80qbURmgXUME7GQHCRfi9/IU53RfDd9XEy7FtLQlsPSWWOzoa/8Heo3Wv329YkYqR/i6 nkqXGSL2tVeDGv5c6FpqABLP97B+uA+lhpw2JoPOePpiSRjQmU95qvRgADBQ++26YBuE62n20D/ e1WdMTMUkLTtSEw1KgvhZPrh1siAkCWiR41ybNIZHC/crn2HjwONl91KXBHKLg== X-Google-Smtp-Source: AGHT+IF07wVyw1cWzRmuSx5fEId0Gmclgp+f8d7avXzCzOnCKGrROP32dgB8bVegVtdK+jQxhHSufQ== X-Received: by 2002:a05:651c:b10:b0:30c:189d:a169 with SMTP id 38308e7fff4ca-30d6a44c2ebmr7112401fa.25.1742369123496; Wed, 19 Mar 2025 00:25:23 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:22 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Junio C Hamano Subject: [PATCH 7/8] pretty: refactor parsing of magic Date: Wed, 19 Mar 2025 08:23:40 +0100 Message-ID: <7c96899bb520ab945a650205982f54d65461d5bd.1742367347.git.martin.agren@gmail.com> X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Similar to the previous commit, pull out our parsing of initial placeholder magic into a separate function. This helps make it a bit easier to get an overview of `format_commit_item()`. It also represents another small step towards separating the parsing of placeholders from subsequent usage of the parsed information. This diff might be a bit easier to read with `-w`. Signed-off-by: Martin Ågren --- pretty.c | 69 ++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 27 deletions(-) diff --git a/pretty.c b/pretty.c index c44ff87481..ddc7fd6aab 100644 --- a/pretty.c +++ b/pretty.c @@ -1929,17 +1929,17 @@ static size_t format_and_pad_commit(struct strbuf *sb, /* in UTF-8 */ return total_consumed; } -static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */ - const char *placeholder, - struct format_commit_context *context) +enum magic { + NO_MAGIC, + ADD_LF_BEFORE_NON_EMPTY, + DEL_LF_BEFORE_EMPTY, + ADD_SP_BEFORE_NON_EMPTY +}; + +/* 2 for 'bad magic', otherwise whether we consumed 0 or 1 chars. */ +static size_t parse_magic(const char *placeholder, enum magic *ret) { - size_t consumed, orig_len; - enum { - NO_MAGIC, - ADD_LF_BEFORE_NON_EMPTY, - DEL_LF_BEFORE_EMPTY, - ADD_SP_BEFORE_NON_EMPTY - } magic = NO_MAGIC; + enum magic magic; switch (placeholder[0]) { case '-': @@ -1952,28 +1952,43 @@ static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */ magic = ADD_SP_BEFORE_NON_EMPTY; break; default: - break; + *ret = NO_MAGIC; + return 0; } - if (magic != NO_MAGIC) { - placeholder++; - switch (placeholder[0]) { - case 'w': - /* - * `%+w()` cannot ever expand to a non-empty string, - * and it potentially changes the layout of preceding - * contents. We're thus not able to handle the magic in - * this combination and refuse the pattern. - */ - return 0; - }; - } + switch (placeholder[1]) { + case 'w': + /* + * `%+w()` cannot ever expand to a non-empty string, + * and it potentially changes the layout of preceding + * contents. We're thus not able to handle the magic in + * this combination and refuse the pattern. + */ + *ret = NO_MAGIC; + return 2; + }; + + *ret = magic; + return 1; +} + +static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */ + const char *placeholder, + struct format_commit_context *context) +{ + size_t consumed, orig_len; + enum magic magic; + + consumed = parse_magic(placeholder, &magic); + if (consumed > 1) + return 0; + placeholder += consumed; orig_len = sb->len; if (context->pad.flush_type == no_flush) - consumed = format_commit_one(sb, placeholder, context); + consumed += format_commit_one(sb, placeholder, context); else - consumed = format_and_pad_commit(sb, placeholder, context); + consumed += format_and_pad_commit(sb, placeholder, context); if (magic == NO_MAGIC) return consumed; @@ -1986,7 +2001,7 @@ static size_t format_commit_item(struct strbuf *sb, /* in UTF-8 */ else if (magic == ADD_SP_BEFORE_NON_EMPTY) strbuf_insertstr(sb, orig_len, " "); } - return consumed + 1; + return consumed; } void userformat_find_requirements(const char *fmt, struct userformat_want *w) From patchwork Wed Mar 19 07:23:41 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Martin_=C3=85gren?= X-Patchwork-Id: 14022191 Received: from mail-lj1-f178.google.com (mail-lj1-f178.google.com [209.85.208.178]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 46951211707 for ; Wed, 19 Mar 2025 07:25:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.178 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369130; cv=none; b=eer7ntjbNzEZlXzbUD+lLqUrsmYVIdiGgJbYi4RQVNtr/IczVDlBIxJ2+ywdUSX9s4Vl7ldY7ptYtR5PdkfRYbQ4Zq1K+ZtyGj4K0Fw524b+GvrD9bXlR8AfCJtHYmuF8jRIXse8OoN13yVYlma9gXvrOjSM02zhJIMEA7n8quY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1742369130; c=relaxed/simple; bh=SNgM7ev5oZspnkXilnvWJHzdTH0jQUnMKeqq/Ju1mJI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=MNpSb4dbeP0INP87yqqY1vaBeJ47VSFmmHkMeS9z3rTCmHPOeNOZ1avgxnXY8+S5ckBc3QYzE2mRbTCVW3Ox6E2KhciNJQn9FHD24Tmc+jwhQvPkjyGf2mYXZQEPA1icN9KrfP/noQVhfhA0hAYmCnLsOLEb+2TPaL/E2imAIvE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=JGFCtujF; arc=none smtp.client-ip=209.85.208.178 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="JGFCtujF" Received: by mail-lj1-f178.google.com with SMTP id 38308e7fff4ca-30bd21f887aso59480461fa.1 for ; Wed, 19 Mar 2025 00:25:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1742369126; x=1742973926; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=IDLZMLZ/XVx0yVCqbwA8+osvBsxeqEQ9KVgNVlqfG04=; b=JGFCtujFlEemQ4zq240PEsqEBVjrYMeRd+q+934hYfO8s/gFm1JKh0ma4XCKO+l3O3 9K/h7w4ot3vUuXpPoWm4uD1n9FXRnrD7LH1eKgrfKNv7jOjbyjZK5R6zfpalpusOz8r8 9DfGtqbYDdd2m3fKpvleBBf0ZPjH3pS6i80VJnW15bx74PYUGmsyEAFc2Y8+gKVlW27i ciQlTZc2rP3KnZgjTjV98k0TlPbBzeNvK209/NtjPBp6fWhjgd6njH1NWUXo/+X+M1TU M9BxbnVzmfYkJ6kJ/0McG5RMTfDjnz6O3ENQsjbWrxQKBNFVFkhrf5HWhxR++9oZkD1r i5rA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1742369126; x=1742973926; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=IDLZMLZ/XVx0yVCqbwA8+osvBsxeqEQ9KVgNVlqfG04=; b=I7wi1rsm3I4SirrQyaJhf1EzxEe2pFsVzl3GkPuN/VbSTALZ9biJKcmjtV748gdVi1 sHLyqEa+sU9TqvtYsR6WK3e2kZnVbxpZgMGulkR3je04rSmMG2l+c0SdNMyIlodXn+s1 R3BMuhcZkBQkBAYydJtkK2nZQfchjnCzZeGFrbpfX5f5Yjm8Y3G0XJb6T5GyEN35vTFW 7V/uVKh725FDKU5QVTA24WF0dpEhytUuZyznLKyllg3uUjdyGXgqVkmx+o2zclKT8SeM FeaT0BSOa2FH21zlUMnSzeoyRIXGUCGCAwUDE9j8KBaW7arKMYZVl7MBQSj97LV6ZyV/ k+aw== X-Gm-Message-State: AOJu0YypGZQ4s6WLIfUOMKRr/sS6llPnB/Q2PY6tNcpPb9QQJ8DDi9Xk qvp6AtLPcUqR1dwgkZML1QIeXQghoiEhIDm/Lfh++TWLAKy1olquUoO+Qw== X-Gm-Gg: ASbGncv0zyPx7qYxbu+pq2MGBo73jKYY3uMQ9D/N6itynDothz8DKGAdUqc1oFatTjj RiaxOPxfT/Wpy/zD8kiMDPhXrorJlrj2GzUdmgHhT3kyjTx49TI1WsKDy1oKeuSXpTeh4HIM1k6 EMw1WQl4mpYBqlW5SO7pzSo4skvRwgrF0hX9YYDr7CryOA1RWy1/eQ0FkBD+90RQGbMfNEIn563 xVU8BhruRr0lHl14FZautkBPlhq7puH8RQjieGOz0uOaf/AsvPmGxbpiXrztDbIEbKj5pZhGRFx dWh0pz1Ss3uoqP1fvg/UJMGneZo2hQa+sJg/4qhGXcMfVI0vFfQLk5a9ls5GuDCfMKlS+Biu X-Google-Smtp-Source: AGHT+IEukpp04nOZD5cg2LCxdZDGdDa4BcPg/2c5C6esupfWq/ubQAXfW6TRF5CfnoEEmAwKigbozw== X-Received: by 2002:a2e:a582:0:b0:30b:d05a:c103 with SMTP id 38308e7fff4ca-30d6a43c383mr4774181fa.29.1742369125749; Wed, 19 Mar 2025 00:25:25 -0700 (PDT) Received: from localhost.localdomain ([217.116.228.14]) by smtp.gmail.com with ESMTPSA id 38308e7fff4ca-30c3f209d6esm22089541fa.112.2025.03.19.00.25.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Mar 2025 00:25:24 -0700 (PDT) From: =?utf-8?q?Martin_=C3=85gren?= To: git@vger.kernel.org Cc: Andy Koppe Subject: [PATCH 8/8] pretty: refactor parsing of decoration options Date: Wed, 19 Mar 2025 08:23:41 +0100 Message-ID: X-Mailer: git-send-email 2.49.0.472.ge94155a9ec In-Reply-To: References: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 After having spotted "%(decorate", we see if there's a ':' and, if so, reach out to `parse_decoration_options()`. We then verify there's a closing ')' before actually considering the placeholder valid. Pull the handling of ':' and ')' into `parse_decoration_options()` so that it's more of a one-stop shop for handling everything after "%(decorate". Let this include freeing up resources in the error path to make it really easy to use this function. Signed-off-by: Martin Ågren --- pretty.c | 52 ++++++++++++++++++++++++++++++---------------------- 1 file changed, 30 insertions(+), 22 deletions(-) diff --git a/pretty.c b/pretty.c index ddc7fd6aab..d5a8ceb7ef 100644 --- a/pretty.c +++ b/pretty.c @@ -1430,17 +1430,6 @@ static int parse_decoration_option(const char **arg, return 0; } -static void parse_decoration_options(const char **arg, - struct decoration_options *opts) -{ - while (parse_decoration_option(arg, "prefix", &opts->prefix) || - parse_decoration_option(arg, "suffix", &opts->suffix) || - parse_decoration_option(arg, "separator", &opts->separator) || - parse_decoration_option(arg, "pointer", &opts->pointer) || - parse_decoration_option(arg, "tag", &opts->tag)) - ; -} - static void free_decoration_options(const struct decoration_options *opts) { free(opts->prefix); @@ -1450,6 +1439,30 @@ static void free_decoration_options(const struct decoration_options *opts) free(opts->tag); } +static int parse_decoration_options(const char **arg, + struct decoration_options *opts) +{ + memset(opts, 0, sizeof(*opts)); + + if (**arg == ':') { + (*arg)++; + while (parse_decoration_option(arg, "prefix", &opts->prefix) || + parse_decoration_option(arg, "suffix", &opts->suffix) || + parse_decoration_option(arg, "separator", &opts->separator) || + parse_decoration_option(arg, "pointer", &opts->pointer) || + parse_decoration_option(arg, "tag", &opts->tag)) + ; + } + + if (**arg != ')') { + free_decoration_options(opts); + return -1; + } + (*arg)++; + + return 0; +} + static size_t parse_rewrap(const char *placeholder, struct rewrap_args *rewrap) { unsigned long width = 0, indent1 = 0, indent2 = 0; @@ -1735,20 +1748,15 @@ static size_t format_commit_one(struct strbuf *sb, /* in UTF-8 */ } if (skip_prefix(placeholder, "(decorate", &arg)) { - struct decoration_options opts = { NULL }; - size_t ret = 0; + struct decoration_options opts; - if (*arg == ':') { - arg++; - parse_decoration_options(&arg, &opts); - } - if (*arg == ')') { - format_decorations(sb, commit, c->auto_color, &opts); - ret = arg - placeholder + 1; - } + if (parse_decoration_options(&arg, &opts) < 0) + return 0; + + format_decorations(sb, commit, c->auto_color, &opts); free_decoration_options(&opts); - return ret; + return arg - placeholder; } /* For the rest we have to parse the commit header. */