LLVM 23.0.0git
llvm::instrumentor::BaseConfigurationOption Struct Reference

An option for the base configuration. More...

#include "llvm/Transforms/IPO/Instrumentor.h"

Classes

union  ValueTy
 Helper union that holds any possible option type. More...

Public Types

enum  KindTy { STRING , BOOLEAN }
 The possible types of options. More...

Public Member Functions

void setBool (bool B)
 Set and get of the boolean value.
bool getBool () const
void setString (StringRef S)
 }
StringRef getString () const
 BaseConfigurationOption (StringRef Name, StringRef Desc, KindTy Kind)
 }

Static Public Member Functions

static BaseConfigurationOptioncreateBoolOption (InstrumentationConfig &IC, StringRef Name, StringRef Description, bool DefaultValue)
 Create a boolean option with Name name, Description description and DefaultValue as boolean default value.
static BaseConfigurationOptioncreateStringOption (InstrumentationConfig &IC, StringRef Name, StringRef Description, StringRef DefaultValue)
 Create a string option with Name name, Description description and DefaultValue as string default value.

Public Attributes

StringRef Name
 }
StringRef Description
KindTy Kind
ValueTy Value = {0}

Detailed Description

An option for the base configuration.

Definition at line 267 of file Instrumentor.h.

Member Enumeration Documentation

◆ KindTy

The possible types of options.

Enumerator
STRING 
BOOLEAN 

Definition at line 269 of file Instrumentor.h.

Constructor & Destructor Documentation

◆ BaseConfigurationOption()

llvm::instrumentor::BaseConfigurationOption::BaseConfigurationOption ( StringRef Name,
StringRef Desc,
KindTy Kind )
inline

}

Construct a base configuration option.

Definition at line 327 of file Instrumentor.h.

References Description, Kind, and Name.

Referenced by createBoolOption(), and createStringOption().

Member Function Documentation

◆ createBoolOption()

BaseConfigurationOption * BaseConfigurationOption::createBoolOption ( InstrumentationConfig & IC,
StringRef Name,
StringRef Description,
bool DefaultValue )
static

Create a boolean option with Name name, Description description and DefaultValue as boolean default value.

Definition at line 291 of file Instrumentor.cpp.

References llvm::instrumentor::InstrumentationConfig::addBaseChoice(), BaseConfigurationOption(), BOOLEAN, Description, and Name.

Referenced by llvm::instrumentor::InstrumentationConfig::InstrumentationConfig().

◆ createStringOption()

BaseConfigurationOption * BaseConfigurationOption::createStringOption ( InstrumentationConfig & IC,
StringRef Name,
StringRef Description,
StringRef DefaultValue )
static

Create a string option with Name name, Description description and DefaultValue as string default value.

Definition at line 300 of file Instrumentor.cpp.

References llvm::instrumentor::InstrumentationConfig::addBaseChoice(), BaseConfigurationOption(), Description, Name, and STRING.

Referenced by llvm::instrumentor::InstrumentationConfig::InstrumentationConfig().

◆ getBool()

bool llvm::instrumentor::BaseConfigurationOption::getBool ( ) const
inline

Definition at line 300 of file Instrumentor.h.

References assert(), BOOLEAN, Kind, and Value.

◆ getString()

StringRef llvm::instrumentor::BaseConfigurationOption::getString ( ) const
inline

Definition at line 312 of file Instrumentor.h.

References assert(), Kind, STRING, and Value.

◆ setBool()

void llvm::instrumentor::BaseConfigurationOption::setBool ( bool B)
inline

Set and get of the boolean value.

Only valid if it is a boolean option. {

Definition at line 296 of file Instrumentor.h.

References assert(), B(), BOOLEAN, Kind, and Value.

◆ setString()

void llvm::instrumentor::BaseConfigurationOption::setString ( StringRef S)
inline

}

Set and get the string value. Only valid if it is a boolean option. {

Definition at line 308 of file Instrumentor.h.

References assert(), Kind, STRING, and Value.

Member Data Documentation

◆ Description

StringRef llvm::instrumentor::BaseConfigurationOption::Description

Definition at line 321 of file Instrumentor.h.

Referenced by BaseConfigurationOption(), createBoolOption(), and createStringOption().

◆ Kind

KindTy llvm::instrumentor::BaseConfigurationOption::Kind

Definition at line 322 of file Instrumentor.h.

Referenced by BaseConfigurationOption(), getBool(), getString(), setBool(), and setString().

◆ Name

StringRef llvm::instrumentor::BaseConfigurationOption::Name

}

The information of the option. {

Definition at line 320 of file Instrumentor.h.

Referenced by BaseConfigurationOption(), createBoolOption(), and createStringOption().

◆ Value

ValueTy llvm::instrumentor::BaseConfigurationOption::Value = {0}

Definition at line 323 of file Instrumentor.h.

Referenced by getBool(), getString(), setBool(), and setString().


The documentation for this struct was generated from the following files: