LLVM 24.0.0git
llvm::opt::OptTable::Info Struct Reference

Entry for a single option instance in the option data table. More...

#include "llvm/Option/OptTable.h"

Public Member Functions

bool hasNoPrefix () const
unsigned getNumPrefixes (ArrayRef< StringTable::Offset > PrefixesTable) const
ArrayRef< StringTable::OffsetgetPrefixOffsets (ArrayRef< StringTable::Offset > PrefixesTable) const
bool hasHelpText () const
void appendPrefixes (const StringTable &StrTable, ArrayRef< StringTable::Offset > PrefixesTable, SmallVectorImpl< StringRef > &Prefixes) const
StringRef getPrefix (const StringTable &StrTable, ArrayRef< StringTable::Offset > PrefixesTable, unsigned PrefixIndex) const
StringRef getPrefixedName (const StringTable &StrTable) const
StringRef getName (const StringTable &StrTable, ArrayRef< StringTable::Offset > PrefixesTable) const

Public Attributes

StringTable::Offset PrefixedNameOffset
StringTable::Offset HelpTextOffset
 Offset 0 means the .td supplied no HelpText.
unsigned Flags
unsigned short Visibility
unsigned short PrefixesOffset
unsigned short GroupID
unsigned short AliasID
unsigned short ExtraOffset
unsigned char Kind
unsigned char Param

Detailed Description

Entry for a single option instance in the option data table.

An option's ID is its 1-based position in the table.

Definition at line 92 of file OptTable.h.

Member Function Documentation

◆ appendPrefixes()

void llvm::opt::OptTable::Info::appendPrefixes ( const StringTable & StrTable,
ArrayRef< StringTable::Offset > PrefixesTable,
SmallVectorImpl< StringRef > & Prefixes ) const
inline

◆ getName()

StringRef llvm::opt::OptTable::Info::getName ( const StringTable & StrTable,
ArrayRef< StringTable::Offset > PrefixesTable ) const
inline

Definition at line 141 of file OptTable.h.

References getPrefix(), getPrefixedName(), and hasNoPrefix().

◆ getNumPrefixes()

unsigned llvm::opt::OptTable::Info::getNumPrefixes ( ArrayRef< StringTable::Offset > PrefixesTable) const
inline

Definition at line 110 of file OptTable.h.

References PrefixesOffset.

Referenced by getPrefixOffsets().

◆ getPrefix()

StringRef llvm::opt::OptTable::Info::getPrefix ( const StringTable & StrTable,
ArrayRef< StringTable::Offset > PrefixesTable,
unsigned PrefixIndex ) const
inline

Definition at line 131 of file OptTable.h.

References getPrefixOffsets().

Referenced by getName().

◆ getPrefixedName()

StringRef llvm::opt::OptTable::Info::getPrefixedName ( const StringTable & StrTable) const
inline

Definition at line 137 of file OptTable.h.

References PrefixedNameOffset.

Referenced by getName().

◆ getPrefixOffsets()

ArrayRef< StringTable::Offset > llvm::opt::OptTable::Info::getPrefixOffsets ( ArrayRef< StringTable::Offset > PrefixesTable) const
inline

Definition at line 116 of file OptTable.h.

References getNumPrefixes(), hasNoPrefix(), and PrefixesOffset.

Referenced by appendPrefixes(), and getPrefix().

◆ hasHelpText()

bool llvm::opt::OptTable::Info::hasHelpText ( ) const
inline

Definition at line 122 of file OptTable.h.

References HelpTextOffset.

◆ hasNoPrefix()

bool llvm::opt::OptTable::Info::hasNoPrefix ( ) const
inline

Definition at line 108 of file OptTable.h.

References PrefixesOffset.

Referenced by getName(), and getPrefixOffsets().

Member Data Documentation

◆ AliasID

unsigned short llvm::opt::OptTable::Info::AliasID

Definition at line 102 of file OptTable.h.

◆ ExtraOffset

unsigned short llvm::opt::OptTable::Info::ExtraOffset

Definition at line 104 of file OptTable.h.

◆ Flags

unsigned llvm::opt::OptTable::Info::Flags

Definition at line 97 of file OptTable.h.

Referenced by llvm::opt::OptTable::findNearest().

◆ GroupID

unsigned short llvm::opt::OptTable::Info::GroupID

Definition at line 101 of file OptTable.h.

◆ HelpTextOffset

StringTable::Offset llvm::opt::OptTable::Info::HelpTextOffset

Offset 0 means the .td supplied no HelpText.

A HelpText<""> maps to a distinct empty string, marking the option deliberately undocumented.

Definition at line 96 of file OptTable.h.

Referenced by hasHelpText().

◆ Kind

unsigned char llvm::opt::OptTable::Info::Kind

Definition at line 105 of file OptTable.h.

◆ Param

unsigned char llvm::opt::OptTable::Info::Param

Definition at line 106 of file OptTable.h.

◆ PrefixedNameOffset

StringTable::Offset llvm::opt::OptTable::Info::PrefixedNameOffset

Definition at line 93 of file OptTable.h.

Referenced by getPrefixedName().

◆ PrefixesOffset

unsigned short llvm::opt::OptTable::Info::PrefixesOffset

Definition at line 100 of file OptTable.h.

Referenced by getNumPrefixes(), getPrefixOffsets(), and hasNoPrefix().

◆ Visibility

unsigned short llvm::opt::OptTable::Info::Visibility

Definition at line 98 of file OptTable.h.

Referenced by llvm::opt::OptTable::findNearest(), and llvm::opt::OptTable::printHelp().


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