LLVM 22.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
llvm::BitCodeAbbrevOp Class Reference

BitCodeAbbrevOp - This describes one or more operands in an abbreviation. More...

#include "llvm/Bitstream/BitCodes.h"

Public Types

enum  Encoding {
  Fixed = 1 , VBR = 2 , Array = 3 , Char6 = 4 ,
  Blob = 5
}

Public Member Functions

 BitCodeAbbrevOp (uint64_t V)
 BitCodeAbbrevOp (Encoding E, uint64_t Data=0)
bool isLiteral () const
bool isEncoding () const
uint64_t getLiteralValue () const
Encoding getEncoding () const
uint64_t getEncodingData () const
bool hasEncodingData () const

Static Public Member Functions

static bool isValidEncoding (uint64_t E)
static bool hasEncodingData (Encoding E)
static bool isChar6 (char C)
 isChar6 - Return true if this character is legal in the Char6 encoding.
static unsigned EncodeChar6 (char C)
static char DecodeChar6 (unsigned V)

Protected Attributes

uint64_t Val
uint64_t IsLiteral: 1
uint64_t Enc: 3

Detailed Description

BitCodeAbbrevOp - This describes one or more operands in an abbreviation.

This is actually a union of two different things:

  1. It could be a literal integer value ("the operand is always 17").
  2. It could be an encoding specification ("this operand encoded like so").

Definition at line 34 of file BitCodes.h.

Member Enumeration Documentation

◆ Encoding

enum llvm::BitCodeAbbrevOp::Encoding
Enumerator
Fixed 
VBR 
Array 
Char6 
Blob 

Definition at line 36 of file BitCodes.h.

Constructor & Destructor Documentation

◆ BitCodeAbbrevOp() [1/2]

llvm::BitCodeAbbrevOp::BitCodeAbbrevOp ( uint64_t V)
inlineexplicit

Definition at line 56 of file BitCodes.h.

References IsLiteral, and Val.

◆ BitCodeAbbrevOp() [2/2]

llvm::BitCodeAbbrevOp::BitCodeAbbrevOp ( Encoding E,
uint64_t Data = 0 )
inlineexplicit

Definition at line 57 of file BitCodes.h.

References llvm::Data, E(), Enc, IsLiteral, and Val.

Member Function Documentation

◆ DecodeChar6()

char llvm::BitCodeAbbrevOp::DecodeChar6 ( unsigned V)
inlinestatic

Definition at line 98 of file BitCodes.h.

References assert().

Referenced by readAbbreviatedField(), and llvm::BitstreamCursor::readRecord().

◆ EncodeChar6()

unsigned llvm::BitCodeAbbrevOp::EncodeChar6 ( char C)
inlinestatic

Definition at line 89 of file BitCodes.h.

References llvm::CallingConv::C, and llvm_unreachable.

◆ getEncoding()

Encoding llvm::BitCodeAbbrevOp::getEncoding ( ) const
inline

Definition at line 67 of file BitCodes.h.

References assert(), Enc, and isEncoding().

Referenced by hasEncodingData(), llvm::BitstreamCursor::readRecord(), and llvm::BitstreamCursor::skipRecord().

◆ getEncodingData()

uint64_t llvm::BitCodeAbbrevOp::getEncodingData ( ) const
inline

Definition at line 68 of file BitCodes.h.

References assert(), hasEncodingData(), isEncoding(), and Val.

Referenced by llvm::BitstreamCursor::readRecord(), and llvm::BitstreamCursor::skipRecord().

◆ getLiteralValue()

uint64_t llvm::BitCodeAbbrevOp::getLiteralValue ( ) const
inline

Definition at line 64 of file BitCodes.h.

References assert(), isLiteral(), and Val.

Referenced by llvm::BitstreamCursor::readRecord(), and llvm::BitstreamCursor::skipRecord().

◆ hasEncodingData() [1/2]

bool llvm::BitCodeAbbrevOp::hasEncodingData ( ) const
inline

Definition at line 73 of file BitCodes.h.

References getEncoding(), and hasEncodingData().

Referenced by getEncodingData(), hasEncodingData(), and llvm::BitstreamCursor::ReadAbbrevRecord().

◆ hasEncodingData() [2/2]

bool llvm::BitCodeAbbrevOp::hasEncodingData ( Encoding E)
inlinestatic

Definition at line 74 of file BitCodes.h.

References Array, Blob, Char6, E(), Fixed, llvm::report_fatal_error(), and VBR.

◆ isChar6()

bool llvm::BitCodeAbbrevOp::isChar6 ( char C)
inlinestatic

isChar6 - Return true if this character is legal in the Char6 encoding.

Definition at line 88 of file BitCodes.h.

References llvm::CallingConv::C, and llvm::isAlnum().

Referenced by llvm::BCChar6::assertValid(), getStringEncoding(), llvm::dxil::DXILBitcodeWriter::writeStringRecord(), and writeStringRecord().

◆ isEncoding()

bool llvm::BitCodeAbbrevOp::isEncoding ( ) const
inline

Definition at line 61 of file BitCodes.h.

References IsLiteral.

Referenced by getEncoding(), getEncodingData(), and llvm::BitstreamCursor::readRecord().

◆ isLiteral()

bool llvm::BitCodeAbbrevOp::isLiteral ( ) const
inline

Definition at line 60 of file BitCodes.h.

References IsLiteral.

Referenced by getLiteralValue(), llvm::BitstreamCursor::readRecord(), and llvm::BitstreamCursor::skipRecord().

◆ isValidEncoding()

bool llvm::BitCodeAbbrevOp::isValidEncoding ( uint64_t E)
inlinestatic

Definition at line 52 of file BitCodes.h.

References E(), and isValidEncoding().

Referenced by isValidEncoding(), and llvm::BitstreamCursor::ReadAbbrevRecord().

Member Data Documentation

◆ Enc

uint64_t llvm::BitCodeAbbrevOp::Enc
protected

Definition at line 49 of file BitCodes.h.

Referenced by BitCodeAbbrevOp(), and getEncoding().

◆ IsLiteral

uint64_t llvm::BitCodeAbbrevOp::IsLiteral
protected

Definition at line 47 of file BitCodes.h.

Referenced by BitCodeAbbrevOp(), BitCodeAbbrevOp(), isEncoding(), and isLiteral().

◆ Val

uint64_t llvm::BitCodeAbbrevOp::Val
protected

Definition at line 45 of file BitCodes.h.

Referenced by BitCodeAbbrevOp(), BitCodeAbbrevOp(), getEncodingData(), and getLiteralValue().

The documentation for this class was generated from the following file:
Generated on for LLVM by doxygen 1.14.0