From 32b9d4390e6b5c4da23d76a8b824816dcb4695f2 Mon Sep 17 00:00:00 2001 From: Michal Privoznik Date: Mon, 25 Jul 2022 15:04:54 +0200 Subject: [PATCH] coding-style: Allow some use of ternary operators MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit While we all understand that excessive use of ternary operator may worsen code readability (e.g. nested, multi-line expression), there are few cases where using it actually improves code readability. For instance, when a function takes a long list of arguments out of which one depends on a boolean expression, or when formatting "yes"/"no" or "on"/"off" values based on a boolean variable (although one can argue that the latter is a subset of the former). Just consider alternatives to: virBufferAsprintf(buf, "%s\n", boolVar ? "yes" : "no"); In fact, this pattern occurs plenty in our code. Exempt it from our "no ternary operators" rule. Signed-off-by: Michal Privoznik Reviewed-by: Claudio Fontana Reviewed-by: Daniel P. Berrangé --- docs/coding-style.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/coding-style.rst b/docs/coding-style.rst index bf0a80fbc5..81bd4474f1 100644 --- a/docs/coding-style.rst +++ b/docs/coding-style.rst @@ -470,7 +470,9 @@ Pointer comparisons may be shortened. All long forms are okay. if (!foo) # or: if (foo == NULL) New code should avoid the ternary operator as much as possible. -Specifically it must never span more than one line or nest: +Its usage in basic cases is warranted (e.g. when deciding between +two constant strings), however, it must never span more than one +line or nest. :: @@ -481,6 +483,9 @@ Specifically it must never span more than one line or nest: char *foo = bar ? bar->baz ? bar->baz->foo : "nobaz" : "nobar"; + GOOD: + virBufferAsprintf(buf, "%s\n", boolVar ? "yes" : "no"); + Preprocessor ------------