plutus-tx-plugin-1.38.0.0: The Plutus Tx compiler and GHC plugin

Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusTx.Options

Synopsis

data PluginOptions = PluginOptions {
- _posPlcTargetVersion ∷ Version
- _posDoTypecheck ∷ Bool
- _posDeferErrors ∷ Bool
- _posConservativeOpts ∷ Bool
- _posContextLevel ∷ Int
- _posDumpPir ∷ Bool
- _posDumpPlc ∷ Bool
- _posDumpUPlc ∷ Bool
- _posOptimize ∷ Bool
- _posPedantic ∷ Bool
- _posVerbosity ∷ Verbosity
- _posMaxSimplifierIterationsPir ∷ Int
- _posMaxSimplifierIterationsUPlc ∷ Int
- _posMaxCseIterations ∷ Int
- _posDoSimplifierUnwrapCancel ∷ Bool
- _posDoSimplifierBeta ∷ Bool
- _posDoSimplifierInline ∷ Bool
- _posDoSimplifierEvaluateBuiltins ∷ Bool
- _posDoSimplifierStrictifyBindings ∷ Bool
- _posDoSimplifierRemoveDeadBindings ∷ Bool
- _posProfile ∷ ProfileOpts
- _posCoverageAll ∷ Bool
- _posCoverageLocation ∷ Bool
- _posCoverageBoolean ∷ Bool
- _posRelaxedFloatin ∷ Bool
- _posCaseOfCaseConservative ∷ Bool
- _posInlineConstants ∷ Bool
- _posPreserveLogging ∷ Bool
- _posRemoveTrace ∷ Bool
- _posDumpCompilationTrace ∷ Bool
}
posVerbosity ∷ Lens' PluginOptions Verbosity
posRemoveTrace ∷ Lens' PluginOptions Bool
posRelaxedFloatin ∷ Lens' PluginOptions Bool
posProfile ∷ Lens' PluginOptions ProfileOpts
posPreserveLogging ∷ Lens' PluginOptions Bool
posPlcTargetVersion ∷ Lens' PluginOptions Version
posPedantic ∷ Lens' PluginOptions Bool
posOptimize ∷ Lens' PluginOptions Bool
posMaxSimplifierIterationsUPlc ∷ Lens' PluginOptions Int
posMaxSimplifierIterationsPir ∷ Lens' PluginOptions Int
posMaxCseIterations ∷ Lens' PluginOptions Int
posInlineConstants ∷ Lens' PluginOptions Bool
posDumpUPlc ∷ Lens' PluginOptions Bool
posDumpPlc ∷ Lens' PluginOptions Bool
posDumpPir ∷ Lens' PluginOptions Bool
posDumpCompilationTrace ∷ Lens' PluginOptions Bool
posDoTypecheck ∷ Lens' PluginOptions Bool
posDoSimplifierUnwrapCancel ∷ Lens' PluginOptions Bool
posDoSimplifierStrictifyBindings ∷ Lens' PluginOptions Bool
posDoSimplifierRemoveDeadBindings ∷ Lens' PluginOptions Bool
posDoSimplifierInline ∷ Lens' PluginOptions Bool
posDoSimplifierEvaluateBuiltins ∷ Lens' PluginOptions Bool
posDoSimplifierBeta ∷ Lens' PluginOptions Bool
posDeferErrors ∷ Lens' PluginOptions Bool
posCoverageLocation ∷ Lens' PluginOptions Bool
posCoverageBoolean ∷ Lens' PluginOptions Bool
posCoverageAll ∷ Lens' PluginOptions Bool
posContextLevel ∷ Lens' PluginOptions Int
posConservativeOpts ∷ Lens' PluginOptions Bool
posCaseOfCaseConservative ∷ Lens' PluginOptions Bool
type OptionKey = Text
type OptionValue = Text
data Implication a = ∀ b. Implication (a → Bool) (Lens' PluginOptions b) b
data PluginOption = ∀ a.Pretty a ⇒ PluginOption {
- poTypeRep ∷ TypeRep a
- poFun ∷ Maybe OptionValue → Validation ParseError (a → a)
- poLens ∷ Lens' PluginOptions a
- poDescription ∷ Text
- poImplications ∷ [Implication a]
}
data ParseError
- = CannotParseValue !OptionKey !OptionValue !SomeTypeRep
- | UnexpectedValue !OptionKey !OptionValue
- | MissingValue !OptionKey
- | UnrecognisedOption !OptionKey ![OptionKey]
newtype ParseErrors = ParseErrors (NonEmpty ParseError)
renderParseError ∷ ParseError → Text
pluginOptions ∷ Map OptionKey PluginOption
flag ∷ (a → a) → OptionKey → Maybe OptionValue → Validation ParseError (a → a)
setTrue ∷ OptionKey → Maybe OptionValue → Validation ParseError (Bool → Bool)
plcParserOption ∷ Parser a → OptionKey → Maybe OptionValue → Validation ParseError (a → a)
readOption ∷ Read a ⇒ OptionKey → Maybe OptionValue → Validation ParseError (a → a)
fromReadOption ∷ Read a ⇒ OptionKey → (a → Validation ParseError b) → Maybe OptionValue → Validation ParseError (b → b)
defaultPluginOptions ∷ PluginOptions
processOne ∷ OptionKey → Maybe OptionValue → Validation ParseError (PluginOptions → PluginOptions)
applyImplications ∷ Lens' PluginOptions a → [Implication a] → PluginOptions → PluginOptions
processAll ∷ [(OptionKey, Maybe OptionValue)] → Validation ParseErrors [PluginOptions → PluginOptions]
toKeyValue ∷ CommandLineOption → (OptionKey, Maybe OptionValue)
parsePluginOptions ∷ [CommandLineOption] → Validation ParseErrors PluginOptions

Documentation

data PluginOptions Source #

Constructors

Fields

_posPlcTargetVersion ∷ Version
_posDoTypecheck ∷ Bool
_posDeferErrors ∷ Bool
_posConservativeOpts ∷ Bool
_posContextLevel ∷ Int
_posDumpPir ∷ Bool
_posDumpPlc ∷ Bool
_posDumpUPlc ∷ Bool
_posOptimize ∷ Bool
_posPedantic ∷ Bool
_posVerbosity ∷ Verbosity
_posMaxSimplifierIterationsPir ∷ Int
_posMaxSimplifierIterationsUPlc ∷ Int
_posMaxCseIterations ∷ Int
_posDoSimplifierUnwrapCancel ∷ Bool
_posDoSimplifierBeta ∷ Bool
_posDoSimplifierInline ∷ Bool
_posDoSimplifierEvaluateBuiltins ∷ Bool
_posDoSimplifierStrictifyBindings ∷ Bool
_posDoSimplifierRemoveDeadBindings ∷ Bool
_posProfile ∷ ProfileOpts
_posCoverageAll ∷ Bool
_posCoverageLocation ∷ Bool
_posCoverageBoolean ∷ Bool
_posRelaxedFloatin ∷ Bool
_posCaseOfCaseConservative ∷ Bool
_posInlineConstants ∷ Bool
_posPreserveLogging ∷ Bool
Whether to try and retain the logging behaviour of the program.
_posRemoveTrace ∷ Bool
_posDumpCompilationTrace ∷ Bool

posVerbosity ∷ Lens' PluginOptions Verbosity Source #

posRemoveTrace ∷ Lens' PluginOptions Bool Source #

posRelaxedFloatin ∷ Lens' PluginOptions Bool Source #

posProfile ∷ Lens' PluginOptions ProfileOpts Source #

posPreserveLogging ∷ Lens' PluginOptions Bool Source #

posPlcTargetVersion ∷ Lens' PluginOptions Version Source #

posPedantic ∷ Lens' PluginOptions Bool Source #

posOptimize ∷ Lens' PluginOptions Bool Source #

posMaxSimplifierIterationsUPlc ∷ Lens' PluginOptions Int Source #

posMaxSimplifierIterationsPir ∷ Lens' PluginOptions Int Source #

posMaxCseIterations ∷ Lens' PluginOptions Int Source #

posInlineConstants ∷ Lens' PluginOptions Bool Source #

posDumpUPlc ∷ Lens' PluginOptions Bool Source #

posDumpPlc ∷ Lens' PluginOptions Bool Source #

posDumpPir ∷ Lens' PluginOptions Bool Source #

posDumpCompilationTrace ∷ Lens' PluginOptions Bool Source #

posDoTypecheck ∷ Lens' PluginOptions Bool Source #

posDoSimplifierUnwrapCancel ∷ Lens' PluginOptions Bool Source #

posDoSimplifierStrictifyBindings ∷ Lens' PluginOptions Bool Source #

posDoSimplifierRemoveDeadBindings ∷ Lens' PluginOptions Bool Source #

posDoSimplifierInline ∷ Lens' PluginOptions Bool Source #

posDoSimplifierEvaluateBuiltins ∷ Lens' PluginOptions Bool Source #

posDoSimplifierBeta ∷ Lens' PluginOptions Bool Source #

posDeferErrors ∷ Lens' PluginOptions Bool Source #

posCoverageLocation ∷ Lens' PluginOptions Bool Source #

posCoverageBoolean ∷ Lens' PluginOptions Bool Source #

posCoverageAll ∷ Lens' PluginOptions Bool Source #

posContextLevel ∷ Lens' PluginOptions Int Source #

posConservativeOpts ∷ Lens' PluginOptions Bool Source #

posCaseOfCaseConservative ∷ Lens' PluginOptions Bool Source #

type OptionKey = Text Source #

type OptionValue = Text Source #

data Implication a Source #

A data type representing option a implying option b.

Constructors

∀ b. Implication (a → Bool) (Lens' PluginOptions b) b

data PluginOption Source #

A plugin option definition for a PluginOptions field of type a.

Constructors

∀ a.Pretty a ⇒ PluginOption

Fields

poTypeRep ∷ TypeRep a
TypeRep used for pretty printing the option.
poFun ∷ Maybe OptionValue → Validation ParseError (a → a)
Consumes an optional value, and either updates the field or reports an error.
poLens ∷ Lens' PluginOptions a
Lens focusing on the field. This is for modifying the field, as well as getting the field value from defaultPluginOptions for pretty printing.
poDescription ∷ Text
A description of the option.
poImplications ∷ [Implication a]
Implications of this option being set to a particular value. An option should not imply itself.

data ParseError Source #

Constructors

CannotParseValue !OptionKey !OptionValue !SomeTypeRep
UnexpectedValue !OptionKey !OptionValue
MissingValue !OptionKey
UnrecognisedOption !OptionKey ![OptionKey]

Instances

Instances details

Show ParseError Source #
Instance details Defined in PlutusTx.Options Methods showsPrec ∷ Int → ParseError → ShowS Source # show ∷ ParseError → String Source # showList ∷ [ParseError] → ShowS Source #

newtype ParseErrors Source #

Constructors

ParseErrors (NonEmpty ParseError)

Instances

Instances details

Semigroup ParseErrors Source #
Instance details Defined in PlutusTx.Options Methods (<>) ∷ ParseErrors → ParseErrors → ParseErrors Source # sconcat ∷ NonEmpty ParseErrors → ParseErrors Source # stimes ∷ Integral b ⇒ b → ParseErrors → ParseErrors Source #
Exception ParseErrors Source #
Instance details Defined in PlutusTx.Options Methods toException ∷ ParseErrors → SomeException Source # fromException ∷ SomeException → Maybe ParseErrors Source # displayException ∷ ParseErrors → String Source #
Show ParseErrors Source #
Instance details Defined in PlutusTx.Options Methods showsPrec ∷ Int → ParseErrors → ShowS Source # show ∷ ParseErrors → String Source # showList ∷ [ParseErrors] → ShowS Source #

renderParseError ∷ ParseError → Text Source #

pluginOptions ∷ Map OptionKey PluginOption Source #

Definition of plugin options.

flag ∷ (a → a) → OptionKey → Maybe OptionValue → Validation ParseError (a → a) Source #

setTrue ∷ OptionKey → Maybe OptionValue → Validation ParseError (Bool → Bool) Source #

plcParserOption ∷ Parser a → OptionKey → Maybe OptionValue → Validation ParseError (a → a) Source #

readOption ∷ Read a ⇒ OptionKey → Maybe OptionValue → Validation ParseError (a → a) Source #

fromReadOption ∷ Read a ⇒ OptionKey → (a → Validation ParseError b) → Maybe OptionValue → Validation ParseError (b → b) Source #

Obtain an option value of type a from an Int.

defaultPluginOptions ∷ PluginOptions Source #

processOne ∷ OptionKey → Maybe OptionValue → Validation ParseError (PluginOptions → PluginOptions) Source #

applyImplications ∷ Lens' PluginOptions a → [Implication a] → PluginOptions → PluginOptions Source #

processAll ∷ [(OptionKey, Maybe OptionValue)] → Validation ParseErrors [PluginOptions → PluginOptions] Source #

toKeyValue ∷ CommandLineOption → (OptionKey, Maybe OptionValue) Source #

parsePluginOptions ∷ [CommandLineOption] → Validation ParseErrors PluginOptions Source #

Parses the arguments that were given to ghc at commandline as "-fplugin-opt PlutusTx.Plugin:opt" or "-fplugin-opt PlutusTx.Plugin:opt=val"