Observe.Event.DSL

DSL for generating Event fields and selectors.

Typical entrypoint is SelectorSpec.

See Example.hs for an idiomatic example.

See Observe.Event.DSL.Compile to compile this into the relevant types.

The core AST

data SelectorSpec

A specification for an Event selector type

Constructors

SelectorSpec

Fields

• !ExplodedName

  The base name of the generated type. Selector will be appended.

• ![SelectorConstructorSpec]

  Constructors for the selector type.

data SelectorConstructorSpec

A specification for a single constructor for a selector

End users probably want to use RecordField to create SelectorConstructorSpecs.

Constructors

SelectorConstructorSpec

Fields

• !ExplodedName

  The name of the constructor

• !SelectorField

  The type of fields associated with this selector

Instances

a ~ ExplodedName => RecordField a FieldSpec SelectorConstructorSpec

e.g. "foo" ≔ FieldSpec ...

Defined in Observe.Event.DSL

Methods

(≔) :: a -> FieldSpec -> SelectorConstructorSpec

a ~ ExplodedName => RecordField a SelectorField SelectorConstructorSpec

e.g. "foo" ≔ NoFields

Defined in Observe.Event.DSL

Methods

(≔) :: a -> SelectorField -> SelectorConstructorSpec

a ~ ExplodedName => RecordField a Name SelectorConstructorSpec

e.g. "foo" ≔ ''Int

Defined in Observe.Event.DSL

Methods

(≔) :: a -> Name -> SelectorConstructorSpec

(a ~ ExplodedName, m ~ AnyQuote) => RecordField a (m Type) SelectorConstructorSpec

e.g. "foo" ≔ [t|Maybe Int|]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> m Type -> SelectorConstructorSpec

data SelectorField

Ways to specify the field for a selector.

Constructors

Specified !FieldSpec

The field is itself specified with the DSL.

The field type will be generated alongside the selector type.

End users probably want to use the RecordField ExplodedName FieldSpec SelectorConstructorSpec instance for Specified SelectorFields.

SimpleType !AnyType

The field type is simply a preexisting type, typically not eventuo11y-aware.

End users probably want to use the RecordField ExplodedName Name SelectorConstructorSpec or RecordField ExplodedName AnyType SelectorConstructorSpec instances for SimpleType SelectorFields

Inject !Name

This selector is a natural injection from a different selector type.

This is typically used to call library code with its own selector types.

NoFields

Events selected by this selector have no fields.

This may be useful purely to add timing to some event, or to create an event that is parent and/or proximate to other events.

Instances

a ~ ExplodedName => RecordField a SelectorField SelectorConstructorSpec

e.g. "foo" ≔ NoFields

Defined in Observe.Event.DSL

Methods

(≔) :: a -> SelectorField -> SelectorConstructorSpec

data FieldSpec

A specification for an Event field type.

Constructors

FieldSpec

Fields

• !ExplodedName

  The base name of the field. Field will be appended.

• ![FieldConstructorSpec]

  Constructors of this field type.

Instances

a ~ ExplodedName => RecordField a FieldSpec SelectorConstructorSpec

e.g. "foo" ≔ FieldSpec ...

Defined in Observe.Event.DSL

Methods

(≔) :: a -> FieldSpec -> SelectorConstructorSpec

data FieldConstructorSpec

A specification for a single constructor for a field

End users probably want to use RecordField to create FieldConstructorSpecs.

Constructors

FieldConstructorSpec

Fields

• !ExplodedName

  The name of the constructor

• !(NonEmpty AnyType)

  The types of the arguments to the constructor.

Instances

a ~ ExplodedName => RecordField a Name FieldConstructorSpec

e.g. "foo" ≔ ''Int

Defined in Observe.Event.DSL

Methods

(≔) :: a -> Name -> FieldConstructorSpec

(a ~ ExplodedName, m ~ AnyQuote) => RecordField a (NonEmpty (m Type)) FieldConstructorSpec

e.g. "foo" ≔ [t|Int] :| [ [t|Bool], [t|Char] ]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> NonEmpty (m Type) -> FieldConstructorSpec

a ~ ExplodedName => RecordField a [Name] FieldConstructorSpec

e.g. "foo" ≔ [''Int, ''Char]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> [Name] -> FieldConstructorSpec

(a ~ ExplodedName, m ~ AnyQuote) => RecordField a (m Type) FieldConstructorSpec

e.g. "foo" ≔ [t|Maybe Int]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> m Type -> FieldConstructorSpec

Syntax

class RecordField k v a where

A type class for common syntax for types that are key-value-like.

For example, the appropriate RecordField instances allow for [ "bytes", "asked" ] ≔ ''ByteCount and [ "bytes", "actual" ] ≔ [t|Maybe ByteCount|] to both construct FieldConstructorSpecs, the former creating a constructor BytesAsked taking a ByteCount and the latter a constructor BytesActual taking a Maybe ByteCount.

Methods

(≔) :: k -> v -> a infixr 4

Instances

a ~ ExplodedName => RecordField a FieldSpec SelectorConstructorSpec

e.g. "foo" ≔ FieldSpec ...

Defined in Observe.Event.DSL

Methods

(≔) :: a -> FieldSpec -> SelectorConstructorSpec

a ~ ExplodedName => RecordField a SelectorField SelectorConstructorSpec

e.g. "foo" ≔ NoFields

Defined in Observe.Event.DSL

Methods

(≔) :: a -> SelectorField -> SelectorConstructorSpec

a ~ ExplodedName => RecordField a Name FieldConstructorSpec

e.g. "foo" ≔ ''Int

Defined in Observe.Event.DSL

Methods

(≔) :: a -> Name -> FieldConstructorSpec

a ~ ExplodedName => RecordField a Name SelectorConstructorSpec

e.g. "foo" ≔ ''Int

Defined in Observe.Event.DSL

Methods

(≔) :: a -> Name -> SelectorConstructorSpec

(a ~ ExplodedName, m ~ AnyQuote) => RecordField a (NonEmpty (m Type)) FieldConstructorSpec

e.g. "foo" ≔ [t|Int] :| [ [t|Bool], [t|Char] ]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> NonEmpty (m Type) -> FieldConstructorSpec

a ~ ExplodedName => RecordField a [Name] FieldConstructorSpec

e.g. "foo" ≔ [''Int, ''Char]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> [Name] -> FieldConstructorSpec

(a ~ ExplodedName, m ~ AnyQuote) => RecordField a (m Type) FieldConstructorSpec

e.g. "foo" ≔ [t|Maybe Int]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> m Type -> FieldConstructorSpec

(a ~ ExplodedName, m ~ AnyQuote) => RecordField a (m Type) SelectorConstructorSpec

e.g. "foo" ≔ [t|Maybe Int|]

Defined in Observe.Event.DSL

Methods

(≔) :: a -> m Type -> SelectorConstructorSpec

Miscellaneous helpers

Quote polymorphism

newtype AnyQuote a

A concrete type for TH quotes that retains full Quote polymorphism

Prior to template-haskell 2.18, this is just an alias for Q

Constructors

AnyQuote

Fields

• toQuote :: forall m. Quote m => m a

  Extract this value in a particular Quote monad

  Prior to template-haskell 2.18, this projects into Q.

Instances

Applicative AnyQuote

Defined in Observe.Event.DSL

Methods

pure :: a -> AnyQuote a

(<*>) :: AnyQuote (a -> b) -> AnyQuote a -> AnyQuote b

liftA2 :: (a -> b -> c) -> AnyQuote a -> AnyQuote b -> AnyQuote c

(*>) :: AnyQuote a -> AnyQuote b -> AnyQuote b

(<*) :: AnyQuote a -> AnyQuote b -> AnyQuote a

Functor AnyQuote

Defined in Observe.Event.DSL

Methods

fmap :: (a -> b) -> AnyQuote a -> AnyQuote b

(<$) :: a -> AnyQuote b -> AnyQuote a

Monad AnyQuote

Defined in Observe.Event.DSL

Methods

(>>=) :: AnyQuote a -> (a -> AnyQuote b) -> AnyQuote b

(>>) :: AnyQuote a -> AnyQuote b -> AnyQuote b

return :: a -> AnyQuote a

Quote AnyQuote

Defined in Observe.Event.DSL

Methods

newName :: String -> AnyQuote Name

toQuote :: AnyQuote a -> forall m. Quote m => m a

Extract this value in a particular Quote monad

Prior to template-haskell 2.18, this projects into Q.

type AnyType = AnyQuote Type

A Type in any Quote

Names

data ExplodedName

A name for some element, broken up into words.

Different elements will use this differently. For example, using [ "foo", "bar" ] in a SelectorSpec would result in a type named FooBarSelector, while using it in a FieldSpec might cause a renderer generator to give the field the key foo-bar.

Instances

IsString ExplodedName

A singleton ExplodedName.

Defined in Observe.Event.DSL

Methods

fromString :: String -> ExplodedName

IsList ExplodedName

Must be non-empty.

Defined in Observe.Event.DSL

Associated Types

type Item ExplodedName

Methods

fromList :: [Item ExplodedName] -> ExplodedName

fromListN :: Int -> [Item ExplodedName] -> ExplodedName

toList :: ExplodedName -> [Item ExplodedName]

type Item ExplodedName

Defined in Observe.Event.DSL

type Item ExplodedName = NonEmptyString

upperCamel :: (IsList a, Item a ~ NonEmptyString) => a -> String

Convert an ExplodedName to UpperCamelCase.

lowerCamel :: ExplodedName -> String

Convert an ExplodedName to lowerCamelCase

kebab :: ExplodedName -> String

Convert an ExplodedName to kebab-case

data NonEmptyString where

Self-explanatory

Bundled Patterns

pattern (:|:) :: Char -> String -> NonEmptyString

Instances

IsString NonEmptyString

Must be non-empty

Defined in Observe.Event.DSL

Methods

fromString :: String -> NonEmptyString

IsList NonEmptyString

Must be non-empty

Defined in Observe.Event.DSL

Associated Types

type Item NonEmptyString

Methods

fromList :: [Item NonEmptyString] -> NonEmptyString

fromListN :: Int -> [Item NonEmptyString] -> NonEmptyString

toList :: NonEmptyString -> [Item NonEmptyString]

type Item NonEmptyString

Defined in Observe.Event.DSL

type Item NonEmptyString = Char

nonEmptyToString :: NonEmptyString -> String

Self-explanatory