[llvm-remarkutil] Fix issues after #66214 and its fixups

MaskRay · MaskRay · commit 0603737ac0f7 · 2023-10-14T12:06:59.000-07:00
Don't use reserved identifier (_GroupBy)
Fix GCC 7.4/7.5 builds (return Filter =&gt; return std::move(Filter))
Remove trailing spaces
diff --git a/llvm/docs/CommandGuide/llvm-remarkutil.rst b/llvm/docs/CommandGuide/llvm-remarkutil.rst
@@ -75,7 +75,7 @@ CSV format is as follows:
   Function,InstructionCount
   foo,123
 
-if `--use-debug-loc` is passed then the CSV will include the source path, line number and column. 
+if `--use-debug-loc` is passed then the CSV will include the source path, line number and column.
 
 ::
   Source,Function,InstructionCount
@@ -104,7 +104,7 @@ CSV format is as follows:
   Function,Count
   foo,123
 
-if `--use-debug-loc` is passed then the CSV will include the source path, line number and column. 
+if `--use-debug-loc` is passed then the CSV will include the source path, line number and column.
 
 ::
   Source,Function,Count
@@ -122,7 +122,7 @@ USAGE: :program:`llvm-remarkutil` count [*options*] <input file>
 Summary
 ^^^^^^^
 
-:program:`llvm-remarkutil count` counts `remarks <https://llvm.org/docs/Remarks.html>` based on specified properties. 
+:program:`llvm-remarkutil count` counts `remarks <https://llvm.org/docs/Remarks.html>` based on specified properties.
 By default the tool counts remarks based on how many occour in a source file or function or total for the generated remark file.
 The tool also supports collecting count based on specific remark arguments. The specified arguments should have an integer value to be able to report a count.
 
@@ -143,15 +143,15 @@ OPTIONS
 
 .. option:: --group-by=<value>
   group count of remarks by property.
-  * ``source``: Count will be collected per source path. Remarks with no debug location will not be counted. 
+  * ``source``: Count will be collected per source path. Remarks with no debug location will not be counted.
   * ``function``: Count is collected per function.
-  * ``function-with-loc``: Count is collected per function per source. Remarks with no debug location will not be counted. 
+  * ``function-with-loc``: Count is collected per function per source. Remarks with no debug location will not be counted.
   * ``Total``: Report a count for the provided remark file.
 
 .. option:: --args[=arguments]
   If `count-by` is set to `arg` this flag can be used to collect from specified remark arguments represented as a comma seperated string.
   The arguments must have a numeral value to be able to count remarks by
-  
+
 .. option:: --rargs[=arguments]
   If `count-by` is set to `arg` this flag can be used to collect from specified remark arguments using regular expression.
   The arguments must have a numeral value to be able to count remarks by
@@ -177,12 +177,12 @@ OPTIONS
 .. option:: --remark-type=<value>
   Filter remarks by type with the following options.
   * ``unknown``
-  * ``passed``               
-  * ``missed``               
-  * ``analysis``             
+  * ``passed``
+  * ``missed``
+  * ``analysis``
   * ``analysis-fp-commute``
-  * ``analysis-aliasing``    
-  * ``failure``              
+  * ``analysis-aliasing``
+  * ``failure``
 
 .. _size-diff_subcommand:
 
diff --git a/llvm/test/tools/llvm-remarkutil/Inputs/annotation-count-with-dbg-loc.yaml b/llvm/test/tools/llvm-remarkutil/Inputs/annotation-count-with-dbg-loc.yaml
@@ -12,7 +12,7 @@ Args:
 Pass:            annotation-remarks
 Name:            AnnotationSummary
 DebugLoc:        { File: path/to/anno2.c, Line: 1, Column: 2 }
-Function:        func2 
+Function:        func2
 Args:
   - String:          'Annotated '
   - count:           '2'
diff --git a/llvm/test/tools/llvm-remarkutil/Inputs/annotation-count.yaml b/llvm/test/tools/llvm-remarkutil/Inputs/annotation-count.yaml
@@ -1,7 +1,7 @@
 --- !Analysis
 Pass:            annotation-remarks
 Name:            AnnotationSummary
-Function:        func1 
+Function:        func1
 Args:
   - String:          'Annotated '
   - count:           '1'
@@ -10,7 +10,7 @@ Args:
 --- !Analysis
 Pass:            annotation-remarks
 Name:            AnnotationSummary
-Function:        func2 
+Function:        func2
 Args:
   - String:          'Annotated '
   - count:           '2'
diff --git a/llvm/test/tools/llvm-remarkutil/count/Inputs/remark-count-by.yaml b/llvm/test/tools/llvm-remarkutil/count/Inputs/remark-count-by.yaml
@@ -1,6 +1,6 @@
 --- !Analysis
 Pass:            generic-remarks-pass
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
@@ -23,7 +23,7 @@ Args:
   - type:            remark
 --- !Analysis
 Pass:            generic-remarks-pass
-Name:            Remark3 
+Name:            Remark3
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
@@ -32,7 +32,7 @@ Args:
   - type:            remark
 --- !Analysis
 Pass:            generic-remarks-pass
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func2
 Args:
diff --git a/llvm/test/tools/llvm-remarkutil/count/Inputs/remark-filter-by.yaml b/llvm/test/tools/llvm-remarkutil/count/Inputs/remark-filter-by.yaml
@@ -1,6 +1,6 @@
 --- !Analysis
 Pass:            generic-remarks-pass
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno2.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
@@ -20,7 +20,7 @@ Args:
   - type:            remark
 --- !Missed
 Pass:            generic-remarks-pass
-Name:            Remark3 
+Name:            Remark3
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
@@ -29,7 +29,7 @@ Args:
   - type:            remark
 --- !Passed
 Pass:            generic-remarks-pass
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
diff --git a/llvm/test/tools/llvm-remarkutil/count/Inputs/remark-group-by.yaml b/llvm/test/tools/llvm-remarkutil/count/Inputs/remark-group-by.yaml
@@ -1,6 +1,6 @@
 --- !Analysis
 Pass:            generic-remarks-pass
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
@@ -9,7 +9,7 @@ Args:
   - type:            remark
 --- !Missed
 Pass:            generic-remarks-pass
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
@@ -18,7 +18,7 @@ Args:
   - type:            remark
 --- !Passed
 Pass:            generic-remarks-pass
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func2
 Args:
@@ -27,7 +27,7 @@ Args:
   - type:            remark
 --- !Analysis
 Pass:            generic-remarks-pass2
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno3.c, Line: 1, Column: 2 }
 Function:        func1
 Args:
@@ -36,7 +36,7 @@ Args:
   - type:            remark
 --- !Analysis
 Pass:            generic-remarks-pass3
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno.c, Line: 1, Column: 2 }
 Function:        func2
 Args:
@@ -45,7 +45,7 @@ Args:
   - type:            remark
 --- !Analysis
 Pass:            generic-remarks-pass4
-Name:            Remark 
+Name:            Remark
 DebugLoc:        { File: path/to/anno2.c, Line: 1, Column: 2 }
 Function:        func3
 Args:
diff --git a/llvm/test/tools/llvm-remarkutil/count/count-by-keys.test b/llvm/test/tools/llvm-remarkutil/count/count-by-keys.test
@@ -1,7 +1,7 @@
 RUN: llvm-remarkutil count --parser=yaml --count-by=arg --group-by=source %p/Inputs/remark-count-by.yaml | FileCheck %s
 RUN: llvm-remarkutil count --parser=yaml --count-by=arg --group-by=function %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKFUNC
 RUN: llvm-remarkutil count --parser=yaml --count-by=arg --group-by=function-with-loc %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKFUNCLOC
-RUN: llvm-remarkutil count --parser=yaml --count-by=arg --group-by=total %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKTOTAL 
+RUN: llvm-remarkutil count --parser=yaml --count-by=arg --group-by=total %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKTOTAL
 
 ; CHECK-LABEL: Source,count1,count2,count3,count4
 ; CHECK: path/to/anno.c,3,4,6,4
diff --git a/llvm/test/tools/llvm-remarkutil/count/count-by-remark.test b/llvm/test/tools/llvm-remarkutil/count/count-by-remark.test
@@ -1,7 +1,7 @@
 RUN: llvm-remarkutil count --parser=yaml --count-by=remark-name --group-by=source %p/Inputs/remark-count-by.yaml | FileCheck %s
 RUN: llvm-remarkutil count --parser=yaml --count-by=remark-name --group-by=function %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKFUNC
 RUN: llvm-remarkutil count --parser=yaml --count-by=remark-name --group-by=function-with-loc %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKFUNCLOC
-RUN: llvm-remarkutil count --parser=yaml --count-by=remark-name --group-by=total %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKTOTAL 
+RUN: llvm-remarkutil count --parser=yaml --count-by=remark-name --group-by=total %p/Inputs/remark-count-by.yaml | FileCheck %s --check-prefix=CHECKTOTAL
 
 ; CHECK-LABEL: Source,Count
 ; CHECK: path/to/anno.c,3
diff --git a/llvm/test/tools/llvm-remarkutil/count/filter-by-pass-name.test b/llvm/test/tools/llvm-remarkutil/count/filter-by-pass-name.test
@@ -1,5 +1,5 @@
-RUN: llvm-remarkutil count --parser=yaml --pass-name=generic-remarks-pass %p/Inputs/remark-filter-by.yaml | FileCheck %s 
-RUN: llvm-remarkutil count --parser=yaml --rpass-name=.* %p/Inputs/remark-filter-by.yaml | FileCheck %s --check-prefix=CHECKALL 
+RUN: llvm-remarkutil count --parser=yaml --pass-name=generic-remarks-pass %p/Inputs/remark-filter-by.yaml | FileCheck %s
+RUN: llvm-remarkutil count --parser=yaml --rpass-name=.* %p/Inputs/remark-filter-by.yaml | FileCheck %s --check-prefix=CHECKALL
 
 ; CHECK-LABEL: Source,Count
 ; CHECK: path/to/anno.c,2
diff --git a/llvm/test/tools/llvm-remarkutil/count/filter-by-remark-name.test b/llvm/test/tools/llvm-remarkutil/count/filter-by-remark-name.test
@@ -1,5 +1,5 @@
-RUN: llvm-remarkutil count --parser=yaml --remark-name=Remark %p/Inputs/remark-filter-by.yaml | FileCheck %s 
-RUN: llvm-remarkutil count --parser=yaml --rremark-name=R.* %p/Inputs/remark-filter-by.yaml | FileCheck %s --check-prefix=CHECKALL 
+RUN: llvm-remarkutil count --parser=yaml --remark-name=Remark %p/Inputs/remark-filter-by.yaml | FileCheck %s
+RUN: llvm-remarkutil count --parser=yaml --rremark-name=R.* %p/Inputs/remark-filter-by.yaml | FileCheck %s --check-prefix=CHECKALL
 
 ; CHECK-LABEL: Source,Count
 ; CHECK: path/to/anno.c,1
diff --git a/llvm/test/tools/llvm-remarkutil/count/filter-by-type.test b/llvm/test/tools/llvm-remarkutil/count/filter-by-type.test
@@ -13,4 +13,4 @@ RUN: llvm-remarkutil count --parser=yaml --remark-type=unknown %p/Inputs/remark-
 ; ANALYSIS: path/to/anno2.c,2
 
 ; UNKNOWN: Source,Count
-; UNKNOWN-EMPTY: 
+; UNKNOWN-EMPTY:
diff --git a/llvm/test/tools/llvm-remarkutil/count/group-by-function.test b/llvm/test/tools/llvm-remarkutil/count/group-by-function.test
@@ -4,4 +4,4 @@ RUN: llvm-remarkutil count --parser=yaml --group-by=function %p/Inputs/remark-gr
 ; CHECK-LABEL: Function,Count
 ; CHECK: func1,3
 ; CHECK: func2,2
-; CHECK: func3,1 
+; CHECK: func3,1
diff --git a/llvm/tools/llvm-remarkutil/RemarkCounter.cpp b/llvm/tools/llvm-remarkutil/RemarkCounter.cpp
@@ -166,8 +166,7 @@ Error ArgumentCounter::getAllMatchingArgumentsInRemark(
 }
 
 std::optional<std::string> Counter::getGroupByKey(const Remark &Remark) {
-
-  switch (_GroupBy) {
+  switch (Group) {
   case GroupBy::PER_FUNCTION:
     return Remark.FunctionName.str();
   case GroupBy::TOTAL:
@@ -177,7 +176,7 @@ std::optional<std::string> Counter::getGroupByKey(const Remark &Remark) {
     if (!Remark.Loc.has_value())
       return std::nullopt;
 
-    if (_GroupBy == GroupBy::PER_FUNCTION_WITH_DEBUG_LOC)
+    if (Group == GroupBy::PER_FUNCTION_WITH_DEBUG_LOC)
       return Remark.Loc->SourceFilePath.str() + ":" + Remark.FunctionName.str();
     return Remark.Loc->SourceFilePath.str();
   }
@@ -214,7 +213,7 @@ Error ArgumentCounter::print(StringRef OutputFileName) {
     return MaybeOF.takeError();
 
   auto OF = std::move(*MaybeOF);
-  OF->os() << groupByToStr(_GroupBy) << ",";
+  OF->os() << groupByToStr(Group) << ",";
   unsigned Idx = 0;
   for (auto [Key, _] : ArgumentSetIdxMap) {
     OF->os() << Key;
@@ -244,7 +243,7 @@ Error RemarkCounter::print(StringRef OutputFileName) {
     return MaybeOF.takeError();
 
   auto OF = std::move(*MaybeOF);
-  OF->os() << groupByToStr(_GroupBy) << ","
+  OF->os() << groupByToStr(Group) << ","
            << "Count\n";
   for (auto [Key, Count] : CountedByRemarksMap)
     OF->os() << Key << "," << Count << "\n";
diff --git a/llvm/tools/llvm-remarkutil/RemarkCounter.h b/llvm/tools/llvm-remarkutil/RemarkCounter.h
@@ -88,7 +88,7 @@ struct Filters {
     Filter.RemarkTypeFilter = std::move(RemarkTypeFilter);
     if (auto E = Filter.regexArgumentsValid())
       return std::move(E);
-    return Filter;
+    return std::move(Filter);
   }
   /// Returns true if \p Remark satisfies all the provided filters.
   bool filterRemark(const Remark &Remark);
@@ -110,15 +110,15 @@ inline Error checkRegex(const Regex &Regex) {
 /// Abstract counter class used to define the general required methods for
 /// counting a remark.
 struct Counter {
-  GroupBy _GroupBy;
-  Counter(){};
-  Counter(enum GroupBy GroupBy) : _GroupBy(GroupBy) {}
+  GroupBy Group = GroupBy::TOTAL;
+  Counter() = default;
+  Counter(enum GroupBy GroupBy) : Group(GroupBy) {}
   /// Obtain the field for collecting remark info based on how we are
   /// collecting. Remarks are grouped by FunctionName, Source, Source and
   /// Function or collect by file.
   std::optional<std::string> getGroupByKey(const Remark &Remark);
 
-  /// Collect count information from \p Remark organized based on \p GroupBy
+  /// Collect count information from \p Remark organized based on \p Group
   /// property.
   virtual void collect(const Remark &) = 0;
   /// Output the final count to the file \p OutputFileName
@@ -158,10 +158,10 @@ struct ArgumentCounter : Counter {
   /// vector then we need to check that the provided regular expressions are
   /// valid if not we return an Error.
   static Expected<ArgumentCounter>
-  createArgumentCounter(enum GroupBy GroupBy, ArrayRef<FilterMatcher> Arguments,
+  createArgumentCounter(GroupBy Group, ArrayRef<FilterMatcher> Arguments,
                         StringRef Buffer, Filters &Filter) {
     ArgumentCounter AC;
-    AC._GroupBy = GroupBy;
+    AC.Group = Group;
     for (auto &Arg : Arguments) {
       if (Arg.IsRegex) {
         if (auto E = checkRegex(Arg.FilterRE))
@@ -178,7 +178,7 @@ struct ArgumentCounter : Counter {
   void collect(const Remark &) override;
 
   /// Print a CSV table consisting of an index which is specified by \p
-  /// `GroupBy` and can be a function name, source file name or function name
+  /// `Group` and can be a function name, source file name or function name
   /// with the full source path and columns of user specified remark arguments
   /// to collect the count for.
   Error print(StringRef OutputFileName) override;
@@ -194,19 +194,19 @@ struct ArgumentCounter : Counter {
 };
 
 /// Collect remarks based by counting the existance of individual remarks. The
-/// reported table will be structured based on the provided \p GroupBy argument
+/// reported table will be structured based on the provided \p Group argument
 /// by reporting count for functions, source or total count for the provided
 /// remark file.
 struct RemarkCounter : Counter {
   std::map<std::string, unsigned> CountedByRemarksMap;
-  RemarkCounter(enum GroupBy GroupBy) : Counter(GroupBy) {}
+  RemarkCounter(GroupBy Group) : Counter(Group) {}
 
-  /// Advance the internal map count broken by \p GroupBy when
+  /// Advance the internal map count broken by \p Group when
   /// seeing \p Remark.
   void collect(const Remark &) override;
 
   /// Print a CSV table consisting of an index which is specified by \p
-  /// `GroupBy` and can be a function name, source file name or function name
+  /// `Group` and can be a function name, source file name or function name
   /// with the full source path and a counts column corresponding to the count
   /// of each individual remark at th index.
   Error print(StringRef OutputFileName) override;
