Safe Haskell	None
Language	Haskell2010

Internal.Data.Basic.TH.Types

Description

module Internal. : Data.Basic.TH.Types Description : Data types and utility function used during TH generation phase Copyright : (c) Nikola Henezi, 2016-2017 Luka Horvat, 2016-2017 License : MIT

This module Internal.defines data types that are used during parsing and TH generation stages. They describe structure of the parser and define minimal representation that is needed from parser in order to generate Template Haskell.

Synopsis

Documentation

data ParseError Source #

When something goes wrong, this explains what went wrong - hopefully...

Constructors

ParseError Text

Instances

Show ParseError Source #
Methods showsPrec :: Int -> ParseError -> ShowS # show :: ParseError -> String # showList :: [ParseError] -> ShowS #
Semigroup ParseError Source #
Methods (<>) :: ParseError -> ParseError -> ParseError # sconcat :: NonEmpty ParseError -> ParseError # stimes :: Integral b => b -> ParseError -> ParseError #
Monoid ParseError Source #
Methods mempty :: ParseError # mappend :: ParseError -> ParseError -> ParseError # mconcat :: [ParseError] -> ParseError #

data ColumnConstraint Source #

List of constraints that can be applied to a Column and affect generated datatype Currently, only Null constraint affects it by wrapping data type with Maybe

Constructors

NullConstraint
NotNullConstraint
DefaultConstraint

Instances

Eq ColumnConstraint Source #
Methods (==) :: ColumnConstraint -> ColumnConstraint -> Bool # (/=) :: ColumnConstraint -> ColumnConstraint -> Bool #
Show ColumnConstraint Source #
Methods showsPrec :: Int -> ColumnConstraint -> ShowS # show :: ColumnConstraint -> String # showList :: [ColumnConstraint] -> ShowS #

data ColumnInfo Source #

Column information gathered from a parser

Constructors

ColumnInfo
Fields _columnInfoText :: !Text name retrieved from the parser _columnInfoNormalName :: !Text normalized name of the field _columnInfoName :: !Name generate TH name _columnInfoType :: !Type generated TH type _columnInfoSqlType :: !TypeName original sql type _columnInfoConstraints :: ![ColumnConstraint] list of constraints that have to be applied

Instances

Eq ColumnInfo Source #
Methods (==) :: ColumnInfo -> ColumnInfo -> Bool # (/=) :: ColumnInfo -> ColumnInfo -> Bool #
Show ColumnInfo Source #
Methods showsPrec :: Int -> ColumnInfo -> ShowS # show :: ColumnInfo -> String # showList :: [ColumnInfo] -> ShowS #

columnInfoType :: Lens' ColumnInfo Type Source #

columnInfoText :: Lens' ColumnInfo Text Source #

columnInfoSqlType :: Lens' ColumnInfo TypeName Source #

columnInfoNormalName :: Lens' ColumnInfo Text Source #

columnInfoName :: Lens' ColumnInfo Name Source #

columnInfoConstraints :: Lens' ColumnInfo [ColumnConstraint] Source #

data EntityInfo Source #

Entity information gathered from a parser

Constructors

EntityInfo
Fields _entityInfoText :: !Text name retrieved from the parser, basically a computed value of `Name` _entityInfoName :: !Name generated TH name _entityInfoSQLName :: !Name original sql name retrieved by hssqlpp _entityInfoType :: !Type generated datatype _entityInfoConstraintList :: ![Constraint] list of constraints that have to be applied _entityInfoColumnMap :: [ColumnInfo] list of all columns

Instances

Eq EntityInfo Source #
Methods (==) :: EntityInfo -> EntityInfo -> Bool # (/=) :: EntityInfo -> EntityInfo -> Bool #
Show EntityInfo Source #
Methods showsPrec :: Int -> EntityInfo -> ShowS # show :: EntityInfo -> String # showList :: [EntityInfo] -> ShowS #

entityInfoType :: Lens' EntityInfo Type Source #

entityInfoText :: Lens' EntityInfo Text Source #

entityInfoSQLName :: Lens' EntityInfo Name Source #

entityInfoName :: Lens' EntityInfo Name Source #

entityInfoConstraintList :: Lens' EntityInfo [Constraint] Source #

entityInfoColumnMap :: Lens' EntityInfo [ColumnInfo] Source #

data ForeignKeyConstraint Source #

Minimal context we need to generate a foreign key constraint

Constructors

ForeignKeyConstraint
Fields _fkName :: !Text name of the foreign key _fkFromT :: !EntityInfo _fkFromCols :: ![ColumnInfo] _fkToT :: !EntityInfo referenced entity _fkToCols :: ![ColumnInfo] referenced columns

Instances

Show ForeignKeyConstraint Source #
Methods showsPrec :: Int -> ForeignKeyConstraint -> ShowS # show :: ForeignKeyConstraint -> String # showList :: [ForeignKeyConstraint] -> ShowS #

fkToT :: Lens' ForeignKeyConstraint EntityInfo Source #

fkToCols :: Lens' ForeignKeyConstraint [ColumnInfo] Source #

fkName :: Lens' ForeignKeyConstraint Text Source #

fkFromT :: Lens' ForeignKeyConstraint EntityInfo Source #

fkFromCols :: Lens' ForeignKeyConstraint [ColumnInfo] Source #

data UniqueKeyConstraint Source #

Minimal context we need to generate a unique key constraint

Constructors

UniqueKeyConstraint
Fields _uqName :: !Text name of the constraint _uqEntity :: !EntityInfo referenced entity _uqCols :: ![ColumnInfo] referenced columns

Instances

Show UniqueKeyConstraint Source #
Methods showsPrec :: Int -> UniqueKeyConstraint -> ShowS # show :: UniqueKeyConstraint -> String # showList :: [UniqueKeyConstraint] -> ShowS #

uqName :: Lens' UniqueKeyConstraint Text Source #

uqEntity :: Lens' UniqueKeyConstraint EntityInfo Source #

uqCols :: Lens' UniqueKeyConstraint [ColumnInfo] Source #

data PrimaryKeyConstraint Source #

Minimal context we need to generate a primary key constraint

Constructors

PrimaryKeyConstraint
Fields _pkName :: !Text name of the constraint _pkEntity :: !EntityInfo referenced entity _pkCols :: ![ColumnInfo] referenced columns

Instances

Show PrimaryKeyConstraint Source #
Methods showsPrec :: Int -> PrimaryKeyConstraint -> ShowS # show :: PrimaryKeyConstraint -> String # showList :: [PrimaryKeyConstraint] -> ShowS #

pkName :: Lens' PrimaryKeyConstraint Text Source #

pkEntity :: Lens' PrimaryKeyConstraint EntityInfo Source #

pkCols :: Lens' PrimaryKeyConstraint [ColumnInfo] Source #

data ParseContext Source #

Full parse context. This datatype is filled with information as parser goes trough the sql file. After ParseContext is filled, TH takes over and code generation starts.

Constructors

ParseContext
Fields _entities :: ![EntityInfo] list of entities found _fks :: ![ForeignKeyConstraint] all foreign keys _pks :: ![PrimaryKeyConstraint] all primary keys _uqs :: ![UniqueKeyConstraint] all unique constraints

Instances

Show ParseContext Source #
Methods showsPrec :: Int -> ParseContext -> ShowS # show :: ParseContext -> String # showList :: [ParseContext] -> ShowS #
Semigroup ParseContext Source #
Methods (<>) :: ParseContext -> ParseContext -> ParseContext # sconcat :: NonEmpty ParseContext -> ParseContext # stimes :: Integral b => b -> ParseContext -> ParseContext #
Monoid ParseContext Source #
Methods mempty :: ParseContext # mappend :: ParseContext -> ParseContext -> ParseContext # mconcat :: [ParseContext] -> ParseContext #

uqs :: Lens' ParseContext [UniqueKeyConstraint] Source #

pks :: Lens' ParseContext [PrimaryKeyConstraint] Source #

fks :: Lens' ParseContext [ForeignKeyConstraint] Source #

entities :: Lens' ParseContext [EntityInfo] Source #

class NullValue a where Source #

Defines null values for all datatypes that we support in Basic. This is basically a hack to avoid usage of unsafeCoerce, because with unsafeCoerce you can hit segmentation faults due to wrong memory allocation (e.g. Int and Bool).

Minimal complete definition

nullValue

Methods

nullValue :: a Source #

Instances

NullValue Bool Source #
Methods nullValue :: Bool Source #
NullValue Double Source #
Methods nullValue :: Double Source #
NullValue Int Source #
Methods nullValue :: Int Source #
NullValue ByteString Source #
Methods nullValue :: ByteString Source #
NullValue Scientific Source #
Methods nullValue :: Scientific Source #
NullValue Text Source #
Methods nullValue :: Text Source #
NullValue LocalTime Source #
Methods nullValue :: LocalTime Source #
NullValue TimeOfDay Source #
Methods nullValue :: TimeOfDay Source #
NullValue Day Source #
Methods nullValue :: Day Source #
NullValue (Maybe a) Source #
Methods nullValue :: Maybe a Source #
(NullValue a, NullValue b) => NullValue (a, b) Source #
Methods nullValue :: (a, b) Source #

newtype Schema Source #

Constructors

Schema Text