From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-f45.google.com (mail-wr1-f45.google.com [209.85.221.45]) by sourceware.org (Postfix) with ESMTPS id 661053858C50 for ; Fri, 28 Oct 2022 10:26:48 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 661053858C50 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=palves.net Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=gmail.com Received: by mail-wr1-f45.google.com with SMTP id a14so6023054wru.5 for ; Fri, 28 Oct 2022 03:26:48 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:content-language:in-reply-to:mime-version :user-agent:date:message-id:references:to:from:subject :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=9t7ST6TzTrfbj79QeLVkFEk9kaxYQL8hM9IFSLTEP4Y=; b=PSKiwoopXOWHTp5c++7qH0j8Q2IEy9oFjHxVPvAKeUUAKBeVFHX0gy1PCFXoTcmpCt zcB0kBD1+xmLwRYzDixJAiEjIeCqgithVi3OB5MXDDBJDcNjjZCvfFf8lr3dP86igHgT IloR1d92aMSSz1q4Ndcte1jKbNS7qSswOpPdbzN6Zmnk22nVk+kADjxUY0R85Vl5WK/q Cv2q2Oezrk6DEQQjndWF67KTLJqoKrdFU14BPafooCWpWHJzoPj9cMVPPL943XP74OVW G1V3rFphqQF+ogEDlfJCvg89TXq3nv6yYCgQ6BkGnBmhFu2ne1G4OUMIP17ywBZ2rw3R VsVA== X-Gm-Message-State: ACrzQf3sMB0WZcE2h4Kwgf8Kw6VOC8+hmTkXsRvY8Sel2hZyspmG9Hzj Phy3Iiu0JzEufrccfj1F9k42M7hBoQ+gDw== X-Google-Smtp-Source: AMsMyM4UUQUF5SE0tG7OiZD1AAJhX8d9gG0O2o1Ix7imr+OGzrRPkiDYPS6dKI1GPrm/Nk4afaRzVg== X-Received: by 2002:a5d:59a4:0:b0:230:eaa4:88d7 with SMTP id p4-20020a5d59a4000000b00230eaa488d7mr35626359wrr.35.1666952806827; Fri, 28 Oct 2022 03:26:46 -0700 (PDT) Received: from ?IPv6:2001:8a0:f93a:3b00:e038:5cdc:b8bf:4653? ([2001:8a0:f93a:3b00:e038:5cdc:b8bf:4653]) by smtp.gmail.com with ESMTPSA id h9-20020a05600c350900b003b4935f04a4sm4925864wmq.5.2022.10.28.03.26.46 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 28 Oct 2022 03:26:46 -0700 (PDT) Subject: [PATCH v2] enum_flags to_string (was: Re: [PATCH v2 07/29] Thread options & clone events (core + remote)) From: Pedro Alves To: Simon Marchi , gdb-patches@sourceware.org References: <20220713222433.374898-1-pedro@palves.net> <20220713222433.374898-8-pedro@palves.net> <5d68cd36-e8d6-e8ad-5428-863e79742062@simark.ca> Message-ID: Date: Fri, 28 Oct 2022 11:26:45 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.10.1 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-10.0 required=5.0 tests=BAYES_00,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,GIT_PATCH_0,HEADER_FROM_DIFFERENT_DOMAINS,KAM_DMARC_STATUS,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,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 List-Id: Some self review. :-) On 2022-10-27 8:55 p.m., Pedro Alves wrote: > > static std::string > to_string (some_flags flags) > { > #define CASE(X) { X, #X } > static constexpr test_flags::string_map_element mapping[] = { > CASE (SOME_FLAG1), > CASE (SOME_FLAG2), > CASE (SOME_FLAG3), > }; > #undef CASE > > return flags.to_string (mapping); > } I was looking at this again, and noticed I named the macro "CASE". That's just because that style of macro is typically used in a switch/case, my first approach used one. That isn't what's being done in the end, so better rename it. And while doing that, I realized that you don't even need to name the array or its type. Like so: static std::string to_string (some_flags flags) { #define MAP_ENUM_FLAG(X) { X, #X } return flags.to_string ({ MAP_ENUM_FLAG (SOME_FLAG1), MAP_ENUM_FLAG (SOME_FLAG3), }); #undef MAP_ENUM_FLAG } But then, every enum_flags to_string implementation will end up defining/undefining that same macro, so might as well put it in gdbsupport/enum-flags.h, resulting in: static std::string to_string (test_flags flags) { return flags.to_string ({ MAP_ENUM_FLAG (FLAG1), MAP_ENUM_FLAG (FLAG3), }); } > + /* Convert this object to a std::string, using MAPPING as > + enumerator-to-string mapping array. This is not meant to be > + called directly. Instead, enum_flags specializations that have > + their own to_string function wrapping this one, thus hidding the > + mapping array from callers. */ Something's off in that last sentence. Fixed. > + /* If there were flags not included in the mapping, print them as > + an hex number. */ Typo: "an hex" -> "a hex". Fixed. Here's the updated patch. -- >8 -- >From 957f039d7fab9bf515bb2c12d485cf2747fa78cc Mon Sep 17 00:00:00 2001 From: Pedro Alves Date: Tue, 25 Oct 2022 15:39:37 +0100 Subject: [PATCH v2] enum_flags to_string This commit introduces shared infrastructure that can be used to implement enum_flags -> to_string functions. With this, if we want to support converting a given enum_flags specialization to string, we just need to implement a function that provides the enumerator->string mapping, like so: enum some_flag { SOME_FLAG1 = 1 << 0, SOME_FLAG2 = 1 << 1, SOME_FLAG3 = 1 << 2, }; DEF_ENUM_FLAGS_TYPE (some_flag, some_flags); static std::string to_string (some_flags flags) { return flags.to_string ({ MAP_ENUM_FLAG (SOME_FLAG1), MAP_ENUM_FLAG (SOME_FLAG2), MAP_ENUM_FLAG (SOME_FLAG3), }; } .. and then to_string(SOME_FLAG2 | SOME_FLAG3) produces a string like "0x6 [SOME_FLAG2 SOME_FLAG3]". If we happen to forget to update the mapping array when we introduce a new enumerator, then the string representation will pretty-print the flags it knows about, and then the leftover flags in hex (one single number). For example, if we had missed mapping SOME_FLAG2 above, we'd end up with: to_string(SOME_FLAG2 | SOME_FLAG3) => "0x6 [SOME_FLAG2 0x4]"); Other than in the unit tests included, no actual usage of the functionality is added in this commit. Change-Id: I835de43c33d13bc0c95132f42c3f97318b875779 --- gdb/unittests/enum-flags-selftests.c | 23 +++++++++++ gdbsupport/enum-flags.h | 57 ++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+) diff --git a/gdb/unittests/enum-flags-selftests.c b/gdb/unittests/enum-flags-selftests.c index f52fc7220a1..474b7ba43c8 100644 --- a/gdb/unittests/enum-flags-selftests.c +++ b/gdb/unittests/enum-flags-selftests.c @@ -374,6 +374,19 @@ enum test_uflag : unsigned DEF_ENUM_FLAGS_TYPE (test_flag, test_flags); DEF_ENUM_FLAGS_TYPE (test_uflag, test_uflags); +/* to_string enumerator->string mapping function used to test + enum_flags::to_string. This intentionally misses mapping one + enumerator (FLAG2). */ + +static std::string +to_string (test_flags flags) +{ + return flags.to_string ({ + MAP_ENUM_FLAG (FLAG1), + MAP_ENUM_FLAG (FLAG3), + }); +} + static void self_test () { @@ -581,6 +594,16 @@ self_test () SELF_CHECK (ok); } + + /* Check string conversion. */ + { + SELF_CHECK (to_string (0) == "0x0 []"); + SELF_CHECK (to_string (FLAG1) == "0x2 [FLAG1]"); + SELF_CHECK (to_string (FLAG1 | FLAG3) == "0xa [FLAG1 FLAG3]"); + SELF_CHECK (to_string (FLAG1 | FLAG2 | FLAG3) == "0xe [FLAG1 FLAG3 0x4]"); + SELF_CHECK (to_string (FLAG2) == "0x4 [0x4]"); + SELF_CHECK (to_string (test_flag (0xff)) == "0xff [FLAG1 FLAG3 0xf5]"); + } } } /* namespace enum_flags_tests */ diff --git a/gdbsupport/enum-flags.h b/gdbsupport/enum-flags.h index cd500f55ff3..2bf2f9a4638 100644 --- a/gdbsupport/enum-flags.h +++ b/gdbsupport/enum-flags.h @@ -130,6 +130,17 @@ class enum_flags typedef E enum_type; typedef typename enum_underlying_type::type underlying_type; + /* For to_string. Maps one enumerator of E to a string. */ + struct string_map_element + { + E flag; + const char *str; + }; + + /* Convenience for to_string implementations, to build a + string_map_element array. */ +#define MAP_ENUM_FLAG(ENUM_FLAG) { ENUM_FLAG, #ENUM_FLAG } + public: /* Allow default construction. */ constexpr enum_flags () @@ -183,6 +194,52 @@ class enum_flags /* Binary operations involving some unrelated type (which would be a bug) are implemented as non-members, and deleted. */ + /* Convert this object to a std::string, using MAPPING as + enumerator-to-string mapping array. This is not meant to be + called directly. Instead, enum_flags specializations should have + their own to_string function wrapping this one, thus hidding the + mapping array from callers. */ + + template + std::string + to_string (const string_map_element (&mapping)[N]) const + { + enum_type flags = raw (); + std::string res = hex_string (flags); + res += " ["; + + bool need_space = false; + for (const auto &entry : mapping) + { + if ((flags & entry.flag) != 0) + { + /* Do op~ in the underlying type, because if enum_type's + underlying type is signed, op~ won't be defined for + it. */ + flags &= (enum_type) ~(underlying_type) entry.flag; + + if (need_space) + res += " "; + res += entry.str; + + need_space = true; + } + } + + /* If there were flags not included in the mapping, print them as + a hex number. */ + if (flags != 0) + { + if (need_space) + res += " "; + res += hex_string (flags); + } + + res += "]"; + + return res; + } + private: /* Stored as enum_type because GDB knows to print the bit flags neatly if the enum values look like bit flags. */ base-commit: 508ccf9b3e1db355037a4a1c9004efe0d6d3ffbf -- 2.36.0