Safe Haskell	Safe-Inferred
Language	Haskell2010

PlutusCore.Annotation

Synopsis

data Ann = Ann {
- annInline :: Inline
- annSrcSpans :: SrcSpans
}
data SrcSpan = SrcSpan {
- srcSpanFile :: FilePath
- srcSpanSLine :: Int
- srcSpanSCol :: Int
- srcSpanELine :: Int
- srcSpanECol :: Int
}
newtype SrcSpans = SrcSpans {
- unSrcSpans :: Set SrcSpan
}
newtype InlineHints name a = InlineHints {
- shouldInline :: a -> name -> Bool
}
data Inline
- = AlwaysInline
- | MayInline
annAlwaysInline :: Ann
annMayInline :: Ann
data SourcePos = SourcePos {
- sourceName :: FilePath
- sourceLine :: !Pos
- sourceColumn :: !Pos
}
data Pos
addSrcSpan :: SrcSpan -> Ann -> Ann
lineInSrcSpan :: Pos -> SrcSpan -> Bool

Documentation

data Ann Source #

An annotation type used during the compilation.

Constructors

Ann
Fields annInline :: Inline annSrcSpans :: SrcSpans

Instances

Instances details

Generic Ann Source #
Instance details Defined in PlutusCore.Annotation Associated Types type Rep Ann :: Type -> Type Source # Methods from :: Ann -> Rep Ann x Source # to :: Rep Ann x -> Ann Source #
Show Ann Source #
Instance details Defined in PlutusCore.Annotation Methods showsPrec :: Int -> Ann -> ShowS Source # show :: Ann -> String Source # showList :: [Ann] -> ShowS Source #
Eq Ann Source #
Instance details Defined in PlutusCore.Annotation Methods (==) :: Ann -> Ann -> Bool Source # (/=) :: Ann -> Ann -> Bool Source #
Ord Ann Source #
Instance details Defined in PlutusCore.Annotation Methods compare :: Ann -> Ann -> Ordering Source # (<) :: Ann -> Ann -> Bool Source # (<=) :: Ann -> Ann -> Bool Source # (>) :: Ann -> Ann -> Bool Source # (>=) :: Ann -> Ann -> Bool Source # max :: Ann -> Ann -> Ann Source # min :: Ann -> Ann -> Ann Source #
Hashable Ann Source #
Instance details Defined in PlutusCore.Annotation Methods hashWithSalt :: Int -> Ann -> Int hash :: Ann -> Int
Pretty Ann Source #
Instance details Defined in PlutusCore.Annotation Methods pretty :: Ann -> Doc ann # prettyList :: [Ann] -> Doc ann #
type Rep Ann Source #
Instance details Defined in PlutusCore.Annotation type Rep Ann = D1 ('MetaData "Ann" "PlutusCore.Annotation" "plutus-core-1.36.0.0-7ehJj5tIPqoJIiiivXkX9N" 'False) (C1 ('MetaCons "Ann" 'PrefixI 'True) (S1 ('MetaSel ('Just "annInline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inline) :*: S1 ('MetaSel ('Just "annSrcSpans") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SrcSpans)))

data SrcSpan Source #

The span between two source locations.

This corresponds roughly to the SrcSpan used by GHC, but we define our own version so we don't have to depend on ghc to use it.

The line and column numbers are 1-based, and the unit is Unicode code point (or Char).

Constructors

SrcSpan
Fields srcSpanFile :: FilePath srcSpanSLine :: Int srcSpanSCol :: Int srcSpanELine :: Int srcSpanECol :: Int Same as GHC's `SrcSpan`, `srcSpanECol` is usually one more than the column of the last character of the thing this `SrcSpan` is for (unless the last character is the line break).

Instances

Instances details

Generic SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Associated Types type Rep SrcSpan :: Type -> Type Source # Methods from :: SrcSpan -> Rep SrcSpan x Source # to :: Rep SrcSpan x -> SrcSpan Source #
Show SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Methods showsPrec :: Int -> SrcSpan -> ShowS Source # show :: SrcSpan -> String Source # showList :: [SrcSpan] -> ShowS Source #
NFData SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Methods rnf :: SrcSpan -> () Source #
Flat SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Methods encode :: SrcSpan -> Encoding decode :: Get SrcSpan size :: SrcSpan -> NumBits -> NumBits
Eq SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Methods (==) :: SrcSpan -> SrcSpan -> Bool Source # (/=) :: SrcSpan -> SrcSpan -> Bool Source #
Ord SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Methods compare :: SrcSpan -> SrcSpan -> Ordering Source # (<) :: SrcSpan -> SrcSpan -> Bool Source # (<=) :: SrcSpan -> SrcSpan -> Bool Source # (>) :: SrcSpan -> SrcSpan -> Bool Source # (>=) :: SrcSpan -> SrcSpan -> Bool Source # max :: SrcSpan -> SrcSpan -> SrcSpan Source # min :: SrcSpan -> SrcSpan -> SrcSpan Source #
Hashable SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Methods hashWithSalt :: Int -> SrcSpan -> Int hash :: SrcSpan -> Int
Pretty SrcSpan Source #
Instance details Defined in PlutusCore.Annotation Methods pretty :: SrcSpan -> Doc ann # prettyList :: [SrcSpan] -> Doc ann #
Exception (UniqueError SrcSpan) Source #
Instance details Defined in PlutusCore.Error Methods toException :: UniqueError SrcSpan -> SomeException Source # fromException :: SomeException -> Maybe (UniqueError SrcSpan) Source # displayException :: UniqueError SrcSpan -> String Source #
type Rep SrcSpan Source #
Instance details Defined in PlutusCore.Annotation type Rep SrcSpan = D1 ('MetaData "SrcSpan" "PlutusCore.Annotation" "plutus-core-1.36.0.0-7ehJj5tIPqoJIiiivXkX9N" 'False) (C1 ('MetaCons "SrcSpan" 'PrefixI 'True) ((S1 ('MetaSel ('Just "srcSpanFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :: S1 ('MetaSel ('Just "srcSpanSLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :: (S1 ('MetaSel ('Just "srcSpanSCol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: (S1 ('MetaSel ('Just "srcSpanELine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "srcSpanECol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))))

newtype SrcSpans Source #

Constructors

SrcSpans
Fields unSrcSpans :: Set SrcSpan

Instances

Instances details

Monoid SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods mempty :: SrcSpans Source # mappend :: SrcSpans -> SrcSpans -> SrcSpans Source # mconcat :: [SrcSpans] -> SrcSpans Source #
Semigroup SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods (<>) :: SrcSpans -> SrcSpans -> SrcSpans Source # sconcat :: NonEmpty SrcSpans -> SrcSpans Source # stimes :: Integral b => b -> SrcSpans -> SrcSpans Source #
Generic SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Associated Types type Rep SrcSpans :: Type -> Type Source # Methods from :: SrcSpans -> Rep SrcSpans x Source # to :: Rep SrcSpans x -> SrcSpans Source #
Show SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods showsPrec :: Int -> SrcSpans -> ShowS Source # show :: SrcSpans -> String Source # showList :: [SrcSpans] -> ShowS Source #
NFData SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods rnf :: SrcSpans -> () Source #
Flat SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods encode :: SrcSpans -> Encoding decode :: Get SrcSpans size :: SrcSpans -> NumBits -> NumBits
Eq SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods (==) :: SrcSpans -> SrcSpans -> Bool Source # (/=) :: SrcSpans -> SrcSpans -> Bool Source #
Ord SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods compare :: SrcSpans -> SrcSpans -> Ordering Source # (<) :: SrcSpans -> SrcSpans -> Bool Source # (<=) :: SrcSpans -> SrcSpans -> Bool Source # (>) :: SrcSpans -> SrcSpans -> Bool Source # (>=) :: SrcSpans -> SrcSpans -> Bool Source # max :: SrcSpans -> SrcSpans -> SrcSpans Source # min :: SrcSpans -> SrcSpans -> SrcSpans Source #
Hashable SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods hashWithSalt :: Int -> SrcSpans -> Int hash :: SrcSpans -> Int
MonoFoldable SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods ofoldMap :: Monoid m => (Element SrcSpans -> m) -> SrcSpans -> m ofoldr :: (Element SrcSpans -> b -> b) -> b -> SrcSpans -> b ofoldl' :: (a -> Element SrcSpans -> a) -> a -> SrcSpans -> a otoList :: SrcSpans -> [Element SrcSpans] oall :: (Element SrcSpans -> Bool) -> SrcSpans -> Bool oany :: (Element SrcSpans -> Bool) -> SrcSpans -> Bool onull :: SrcSpans -> Bool olength :: SrcSpans -> Int olength64 :: SrcSpans -> Int64 ocompareLength :: Integral i => SrcSpans -> i -> Ordering otraverse_ :: Applicative f => (Element SrcSpans -> f b) -> SrcSpans -> f () ofor_ :: Applicative f => SrcSpans -> (Element SrcSpans -> f b) -> f () omapM_ :: Applicative m => (Element SrcSpans -> m ()) -> SrcSpans -> m () oforM_ :: Applicative m => SrcSpans -> (Element SrcSpans -> m ()) -> m () ofoldlM :: Monad m => (a -> Element SrcSpans -> m a) -> a -> SrcSpans -> m a ofoldMap1Ex :: Semigroup m => (Element SrcSpans -> m) -> SrcSpans -> m ofoldr1Ex :: (Element SrcSpans -> Element SrcSpans -> Element SrcSpans) -> SrcSpans -> Element SrcSpans ofoldl1Ex' :: (Element SrcSpans -> Element SrcSpans -> Element SrcSpans) -> SrcSpans -> Element SrcSpans headEx :: SrcSpans -> Element SrcSpans lastEx :: SrcSpans -> Element SrcSpans unsafeHead :: SrcSpans -> Element SrcSpans unsafeLast :: SrcSpans -> Element SrcSpans maximumByEx :: (Element SrcSpans -> Element SrcSpans -> Ordering) -> SrcSpans -> Element SrcSpans minimumByEx :: (Element SrcSpans -> Element SrcSpans -> Ordering) -> SrcSpans -> Element SrcSpans oelem :: Element SrcSpans -> SrcSpans -> Bool onotElem :: Element SrcSpans -> SrcSpans -> Bool
Pretty SrcSpans Source #
Instance details Defined in PlutusCore.Annotation Methods pretty :: SrcSpans -> Doc ann # prettyList :: [SrcSpans] -> Doc ann #
type Rep SrcSpans Source #
Instance details Defined in PlutusCore.Annotation type Rep SrcSpans = D1 ('MetaData "SrcSpans" "PlutusCore.Annotation" "plutus-core-1.36.0.0-7ehJj5tIPqoJIiiivXkX9N" 'True) (C1 ('MetaCons "SrcSpans" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSrcSpans") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set SrcSpan))))
type Element SrcSpans Source #
Instance details Defined in PlutusCore.Annotation type Element SrcSpans = SrcSpan

newtype InlineHints name a Source #

Constructors

InlineHints
Fields shouldInline :: a -> name -> Bool

Instances

Instances details

Monoid (InlineHints name a) Source #
Instance details Defined in PlutusCore.Annotation Methods mempty :: InlineHints name a Source # mappend :: InlineHints name a -> InlineHints name a -> InlineHints name a Source # mconcat :: [InlineHints name a] -> InlineHints name a Source #
Semigroup (InlineHints name a) Source #
Instance details Defined in PlutusCore.Annotation Methods (<>) :: InlineHints name a -> InlineHints name a -> InlineHints name a Source # sconcat :: NonEmpty (InlineHints name a) -> InlineHints name a Source # stimes :: Integral b => b -> InlineHints name a -> InlineHints name a Source #
Show (InlineHints name a) Source #
Instance details Defined in PlutusCore.Annotation Methods showsPrec :: Int -> InlineHints name a -> ShowS Source # show :: InlineHints name a -> String Source # showList :: [InlineHints name a] -> ShowS Source #

data Inline Source #

Constructors

AlwaysInline

When calling PlutusIR.Compiler.Definitions.defineTerm to add a new term definition, if we annotation the var on the LHS of the definition with AlwaysInline, the inliner will always inline that var.

This is currently used to ensure builtin functions such as trace (when the remove-trace flag is on and trace is rewritten to const) are inlined, because the inliner would otherwise not inline them. To achieve that, we annotate the definition with AlwaysInline when defining trace, i.e., trace AlwaysInline = _ a -> a.

MayInline

Instances

Instances details

Generic Inline Source #
Instance details Defined in PlutusCore.Annotation Associated Types type Rep Inline :: Type -> Type Source # Methods from :: Inline -> Rep Inline x Source # to :: Rep Inline x -> Inline Source #
Show Inline Source #
Instance details Defined in PlutusCore.Annotation Methods showsPrec :: Int -> Inline -> ShowS Source # show :: Inline -> String Source # showList :: [Inline] -> ShowS Source #
Eq Inline Source #
Instance details Defined in PlutusCore.Annotation Methods (==) :: Inline -> Inline -> Bool Source # (/=) :: Inline -> Inline -> Bool Source #
Ord Inline Source #
Instance details Defined in PlutusCore.Annotation Methods compare :: Inline -> Inline -> Ordering Source # (<) :: Inline -> Inline -> Bool Source # (<=) :: Inline -> Inline -> Bool Source # (>) :: Inline -> Inline -> Bool Source # (>=) :: Inline -> Inline -> Bool Source # max :: Inline -> Inline -> Inline Source # min :: Inline -> Inline -> Inline Source #
Hashable Inline Source #
Instance details Defined in PlutusCore.Annotation Methods hashWithSalt :: Int -> Inline -> Int hash :: Inline -> Int
type Rep Inline Source #
Instance details Defined in PlutusCore.Annotation type Rep Inline = D1 ('MetaData "Inline" "PlutusCore.Annotation" "plutus-core-1.36.0.0-7ehJj5tIPqoJIiiivXkX9N" 'False) (C1 ('MetaCons "AlwaysInline" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MayInline" 'PrefixI 'False) (U1 :: Type -> Type))

annAlwaysInline :: Ann Source #

Create an Ann with AlwaysInline.

annMayInline :: Ann Source #

Create an Ann with MayInline.

data SourcePos #

Constructors

SourcePos
Fields sourceName :: FilePath sourceLine :: !Pos sourceColumn :: !Pos

Instances

Instances details

Data SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SourcePos -> c SourcePos Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SourcePos Source # toConstr :: SourcePos -> Constr Source # dataTypeOf :: SourcePos -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SourcePos) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SourcePos) Source # gmapT :: (forall b. Data b => b -> b) -> SourcePos -> SourcePos Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SourcePos -> r Source # gmapQ :: (forall d. Data d => d -> u) -> SourcePos -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> SourcePos -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SourcePos -> m SourcePos Source #
Generic SourcePos
Instance details Defined in Text.Megaparsec.Pos Associated Types type Rep SourcePos :: Type -> Type Source # Methods from :: SourcePos -> Rep SourcePos x Source # to :: Rep SourcePos x -> SourcePos Source #
Read SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods readsPrec :: Int -> ReadS SourcePos Source # readList :: ReadS [SourcePos] Source # readPrec :: ReadPrec SourcePos Source # readListPrec :: ReadPrec [SourcePos] Source #
Show SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods showsPrec :: Int -> SourcePos -> ShowS Source # show :: SourcePos -> String Source # showList :: [SourcePos] -> ShowS Source #
NFData SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods rnf :: SourcePos -> () Source #
Eq SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods (==) :: SourcePos -> SourcePos -> Bool Source # (/=) :: SourcePos -> SourcePos -> Bool Source #
Ord SourcePos
Instance details Defined in Text.Megaparsec.Pos Methods compare :: SourcePos -> SourcePos -> Ordering Source # (<) :: SourcePos -> SourcePos -> Bool Source # (<=) :: SourcePos -> SourcePos -> Bool Source # (>) :: SourcePos -> SourcePos -> Bool Source # (>=) :: SourcePos -> SourcePos -> Bool Source # max :: SourcePos -> SourcePos -> SourcePos Source # min :: SourcePos -> SourcePos -> SourcePos Source #
Pretty SourcePos Source #
Instance details Defined in PlutusCore.Error Methods pretty :: SourcePos -> Doc ann # prettyList :: [SourcePos] -> Doc ann #
type Rep SourcePos
Instance details Defined in Text.Megaparsec.Pos type Rep SourcePos = D1 ('MetaData "SourcePos" "Text.Megaparsec.Pos" "megaparsec-9.6.1-2y4TSvMYdIdIGL4Xdwvkcx" 'False) (C1 ('MetaCons "SourcePos" 'PrefixI 'True) (S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :: (S1 ('MetaSel ('Just "sourceLine") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Pos) :: S1 ('MetaSel ('Just "sourceColumn") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Pos))))

data Pos #

Instances

Instances details

Data Pos
Instance details Defined in Text.Megaparsec.Pos Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Pos -> c Pos Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Pos Source # toConstr :: Pos -> Constr Source # dataTypeOf :: Pos -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Pos) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Pos) Source # gmapT :: (forall b. Data b => b -> b) -> Pos -> Pos Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Pos -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Pos -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Pos -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Pos -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Pos -> m Pos Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Pos -> m Pos Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Pos -> m Pos Source #
Semigroup Pos
Instance details Defined in Text.Megaparsec.Pos Methods (<>) :: Pos -> Pos -> Pos Source # sconcat :: NonEmpty Pos -> Pos Source # stimes :: Integral b => b -> Pos -> Pos Source #
Generic Pos
Instance details Defined in Text.Megaparsec.Pos Associated Types type Rep Pos :: Type -> Type Source # Methods from :: Pos -> Rep Pos x Source # to :: Rep Pos x -> Pos Source #
Read Pos
Instance details Defined in Text.Megaparsec.Pos Methods readsPrec :: Int -> ReadS Pos Source # readList :: ReadS [Pos] Source # readPrec :: ReadPrec Pos Source # readListPrec :: ReadPrec [Pos] Source #
Show Pos
Instance details Defined in Text.Megaparsec.Pos Methods showsPrec :: Int -> Pos -> ShowS Source # show :: Pos -> String Source # showList :: [Pos] -> ShowS Source #
NFData Pos
Instance details Defined in Text.Megaparsec.Pos Methods rnf :: Pos -> () Source #
Eq Pos
Instance details Defined in Text.Megaparsec.Pos Methods (==) :: Pos -> Pos -> Bool Source # (/=) :: Pos -> Pos -> Bool Source #
Ord Pos
Instance details Defined in Text.Megaparsec.Pos Methods compare :: Pos -> Pos -> Ordering Source # (<) :: Pos -> Pos -> Bool Source # (<=) :: Pos -> Pos -> Bool Source # (>) :: Pos -> Pos -> Bool Source # (>=) :: Pos -> Pos -> Bool Source # max :: Pos -> Pos -> Pos Source # min :: Pos -> Pos -> Pos Source #
type Rep Pos
Instance details Defined in Text.Megaparsec.Pos type Rep Pos = D1 ('MetaData "Pos" "Text.Megaparsec.Pos" "megaparsec-9.6.1-2y4TSvMYdIdIGL4Xdwvkcx" 'True) (C1 ('MetaCons "Pos" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

addSrcSpan :: SrcSpan -> Ann -> Ann Source #

Add an extra SrcSpan to existing SrcSpans of Ann

lineInSrcSpan :: Pos -> SrcSpan -> Bool Source #

Tells if a line (positive integer) falls inside a SrcSpan.