LLVM 24.0.0git
llvm::cl::LibraryOptions Class Referenceabstract

The options of a library that declares them in TableGen rather than as cl::opt (see llvm/Option/LibraryOptions.h). More...

#include "llvm/Support/CommandLine.h"

Inheritance diagram for llvm::cl::LibraryOptions:
[legend]

Public Member Functions

virtual void forEachOption (function_ref< void(StringRef Spelling, StringRef MetaVar, StringRef Help)> Fn) const =0
 Calls Fn with the spelling of each option without its prefix (e.g.
virtual Error parse (void *Opts, ArrayRef< const char * > Args, unsigned &Consumed, BumpPtrAllocator &Alloc) const =0
 Parses the option spelled by Args[0], which may take Args[1] as its value, into Opts and sets Consumed to the number of arguments it spans.
virtual const void * getDefault () const =0
 Returns the default values.
virtual void * copyDefault (BumpPtrAllocator &Alloc) const =0
 Returns a copy of getDefault() allocated from Alloc.

Protected Member Functions

constexpr LibraryOptions ()=default
 ~LibraryOptions ()=default

Detailed Description

The options of a library that declares them in TableGen rather than as cl::opt (see llvm/Option/LibraryOptions.h).

parseCommandLineOptions hands every argument naming one of them to parse(). This lets libraries move off cl::opt while tools still parse argv with cl::, and goes away once tools parse argv without cl::.

Definition at line 2196 of file CommandLine.h.

Constructor & Destructor Documentation

◆ LibraryOptions()

llvm::cl::LibraryOptions::LibraryOptions ( )
constexprprotecteddefault

◆ ~LibraryOptions()

llvm::cl::LibraryOptions::~LibraryOptions ( )
protecteddefault

Member Function Documentation

◆ copyDefault()

virtual void * llvm::cl::LibraryOptions::copyDefault ( BumpPtrAllocator & Alloc) const
pure virtual

Returns a copy of getDefault() allocated from Alloc.

Implemented in llvm::opt::LibraryOptionsParser.

References llvm::Alloc.

◆ forEachOption()

virtual void llvm::cl::LibraryOptions::forEachOption ( function_ref< void(StringRef Spelling, StringRef MetaVar, StringRef Help)> Fn) const
pure virtual

Calls Fn with the spelling of each option without its prefix (e.g.

"x" or "x="), its metavariable, and its help text. Only -help-hidden lists the options.

References Help().

◆ getDefault()

virtual const void * llvm::cl::LibraryOptions::getDefault ( ) const
pure virtual

Returns the default values.

Implemented in llvm::opt::LibraryOptionsParser.

◆ parse()

virtual Error llvm::cl::LibraryOptions::parse ( void * Opts,
ArrayRef< const char * > Args,
unsigned & Consumed,
BumpPtrAllocator & Alloc ) const
pure virtual

Parses the option spelled by Args[0], which may take Args[1] as its value, into Opts and sets Consumed to the number of arguments it spans.

The strings in Args and the memory from Alloc remain valid as long as Opts is used.

Implemented in llvm::opt::LibraryOptionsParser.

References llvm::Alloc.


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