1 //===- CoverageViewOptions.h - Code coverage display options -------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_COV_COVERAGEVIEWOPTIONS_H
10 #define LLVM_COV_COVERAGEVIEWOPTIONS_H
11 
12 #include "llvm/Config/llvm-config.h"
13 #include "RenderingSupport.h"
14 #include <vector>
15 
16 namespace llvm {
17 
18 /// The options for displaying the code coverage information.
19 struct CoverageViewOptions {
20   enum class OutputFormat {
21     Text,
22     HTML,
23     Lcov
24   };
25 
26   enum class BranchOutputType { Count, Percent, Off };
27 
28   bool Debug;
29   bool Colors;
30   bool ShowLineNumbers;
31   bool ShowLineStats;
32   bool ShowRegionMarkers;
33   bool ShowBranchCounts;
34   bool ShowBranchPercents;
35   bool ShowExpandedRegions;
36   bool ShowFunctionInstantiations;
37   bool ShowFullFilenames;
38   bool ShowBranchSummary;
39   bool ShowRegionSummary;
40   bool ShowInstantiationSummary;
41   bool ExportSummaryOnly;
42   bool SkipExpansions;
43   bool SkipFunctions;
44   OutputFormat Format;
45   BranchOutputType ShowBranches;
46   std::string ShowOutputDirectory;
47   std::vector<std::string> DemanglerOpts;
48   uint32_t TabSize;
49   std::string ProjectTitle;
50   std::string CreatedTimeStr;
51   unsigned NumThreads;
52   std::string CompilationDirectory;
53   float HighCovWatermark;
54   float LowCovWatermark;
55 
56   /// Change the output's stream color if the colors are enabled.
57   ColoredRawOstream colored_ostream(raw_ostream &OS,
58                                     raw_ostream::Colors Color) const {
59     return llvm::colored_ostream(OS, Color, Colors);
60   }
61 
62   /// Check if an output directory has been specified.
63   bool hasOutputDirectory() const { return !ShowOutputDirectory.empty(); }
64 
65   /// Check if a demangler has been specified.
66   bool hasDemangler() const { return !DemanglerOpts.empty(); }
67 
68   /// Check if a project title has been specified.
69   bool hasProjectTitle() const { return !ProjectTitle.empty(); }
70 
71   /// Check if the created time of the profile data file is available.
72   bool hasCreatedTime() const { return !CreatedTimeStr.empty(); }
73 
74   /// Get the LLVM version string.
75   std::string getLLVMVersionString() const {
76     std::string VersionString = "Generated by llvm-cov -- llvm version ";
77     VersionString += LLVM_VERSION_STRING;
78     return VersionString;
79   }
80 };
81 }
82 
83 #endif // LLVM_COV_COVERAGEVIEWOPTIONS_H
84