MLIR  20.0.0git
Static Public Member Functions | List of all members
mlir::PassPipelineOptions< T > Class Template Reference

Subclasses of PassPipelineOptions provide a set of options that can be used to initialize a pass pipeline. More...

#include "mlir/Pass/PassOptions.h"

+ Inheritance diagram for mlir::PassPipelineOptions< T >:

Static Public Member Functions

static std::unique_ptr< T > createFromString (StringRef options)
 Factory that parses the provided options and returns a unique_ptr to the struct. More...
 

Additional Inherited Members

- Public Types inherited from mlir::detail::PassOptions
template<typename DataType >
using OptionParser = std::conditional_t< std::is_base_of_v< PassOptions, DataType >, PassOptionsParser< DataType >, std::conditional_t< std::is_base_of< llvm::cl::generic_parser_base, llvm::cl::parser< DataType > >::value, GenericOptionParser< DataType >, llvm::cl::parser< DataType > >>
 The specific parser to use. More...
 
- Public Member Functions inherited from mlir::detail::PassOptions
 PassOptions ()=default
 
 PassOptions (const PassOptions &)=delete
 Delete the copy constructor to avoid copying the internal options map. More...
 
 PassOptions (PassOptions &&)=delete
 
void copyOptionValuesFrom (const PassOptions &other)
 Copy the option values from 'other' into 'this', where 'other' has the same options as 'this'. More...
 
LogicalResult parseFromString (StringRef options, raw_ostream &errorStream=llvm::errs())
 Parse options out as key=value pairs that can then be handed off to the llvm::cl command line passing infrastructure. More...
 
void print (raw_ostream &os) const
 Print the options held by this struct in a form that can be parsed via 'parseFromString'. More...
 
void printHelp (size_t indent, size_t descIndent) const
 Print the help string for the options held by this struct. More...
 
size_t getOptionWidth () const
 Return the maximum width required when printing the help string. More...
 

Detailed Description

template<typename T>
class mlir::PassPipelineOptions< T >

Subclasses of PassPipelineOptions provide a set of options that can be used to initialize a pass pipeline.

See PassPipelineRegistration for usage details.

Usage:

struct MyPipelineOptions : PassPipelineOptions<MyPassOptions> { ListOption<int> someListFlag{*this, "flag-name", llvm::cl::desc("...")}; };

Definition at line 383 of file PassOptions.h.

Member Function Documentation

◆ createFromString()

template<typename T >
static std::unique_ptr<T> mlir::PassPipelineOptions< T >::createFromString ( StringRef  options)
inlinestatic

Factory that parses the provided options and returns a unique_ptr to the struct.

Definition at line 387 of file PassOptions.h.


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