Safe Haskell	None
Language	Haskell2010

Language.Clafer.Intermediate.Intclafer

Description

Intermediate representation (IR) of a Clafer model

Synopsis

Documentation

type UID = String Source

unique identifier of a clafer

type CName = String Source

clafer name as declared in the source model

type URL = String Source

file:/ ftp: or http:/ prefixed URL

data Ir Source

A "supertype" of all IR types

Instances

Eq Ir Source
Show Ir Source

data IType Source

Constructors

TBoolean
TString
TInteger
TDouble
TReal
TClafer
Fields _hi :: [UID] UID represents an inheritance hierarchy obtained using @Common.findHierarchy
TMap
Fields _so :: IType must only be a TClass _ta :: IType must only be a TClass
TUnion
Fields _un :: [IType] IType is a list of basic types (not union types)

Instances

Eq IType Source
Data IType Source
Ord IType Source
Show IType Source
ToJSON IType Source

data IModule Source

each file contains exactly one mode. A module is a list of declarations

Constructors

IModule
Fields _mName :: String always empty (no syntax for declaring modules) _mDecls :: [IElement] List of top-level elements

Instances

Eq IModule Source
Data IModule Source
Ord IModule Source
Show IModule Source
ToJSON IModule Source
Plated IModule Source

data IClafer Source

Clafer has a list of fields that specify its properties. Some fields, marked as (o) are for generating optimized code

Constructors

IClafer

Fields

_cinPos :: Span: the position of the syntax in source code
_isAbstract :: Bool: whether abstract or not (i.e., concrete)
_gcard :: Maybe IGCard: group cardinality
_ident :: CName: name declared in the model
_uid :: UID: a unique identifier
_parentUID :: UID: "root" if top-level, "" if unresolved or for root clafer, otherwise UID of the parent clafer
_super :: Maybe PExp: superclafer - only allowed PExp is IClaferId. Nothing = default super "clafer"
_reference :: Maybe IReference: reference type, bag or set
_card :: Maybe Interval: clafer cardinality
_glCard :: Interval: (o) global cardinality
_elements :: [IElement]: nested elements

Instances

Eq IClafer Source
Data IClafer Source
Ord IClafer Source
Show IClafer Source
ToJSON IClafer Source
Plated IClafer Source

data IElement Source

Clafer's subelement is either a clafer, a constraint, or a goal (objective) This is a wrapper type needed to have polymorphic lists of elements

Constructors

IEClafer
Fields _iClafer :: IClafer the actual clafer
IEConstraint
Fields _isHard :: Bool whether hard constraint or assertion _cpexp :: PExp the container of the actual expression
IEGoal	Goal (optimization objective)
Fields _isMaximize :: Bool whether maximize or minimize _cpexp :: PExp the container of the actual expression

Instances

Eq IElement Source
Data IElement Source
Ord IElement Source
Show IElement Source
ToJSON IElement Source

data IReference Source

A type of reference. -> values unique (set) ->> values non-unique (bag)

Constructors

IReference
Fields _isSet :: Bool whether set or bag _ref :: PExp the only allowed reference expressions are IClafer and set expr. (++, **, --s)

Instances

Eq IReference Source
Data IReference Source
Ord IReference Source
Show IReference Source
ToJSON IReference Source

data IGCard Source

Group cardinality is specified as an interval. It may also be given by a keyword. xor 1..1 isKeyword = True 1..1 1..1 isKeyword = False

Constructors

IGCard
Fields _isKeyword :: Bool whether given by keyword: or, xor, mux _interval :: Interval

Instances

Eq IGCard Source
Data IGCard Source
Ord IGCard Source
Show IGCard Source
ToJSON IGCard Source

type Interval = (Integer, Integer) Source

(Min, Max) integer interval. -1 denotes *

data PExp Source

This is expression container (parent). It has meta information about an actual expression exp

Constructors

PExp
Fields _iType :: Maybe IType the inferred type _pid :: String non-empty unique id for expressions with span, "" for noSpan _inPos :: Span position in the input Clafer file _exp :: IExp the actual expression

Instances

Eq PExp Source
Data PExp Source
Ord PExp Source
Show PExp Source
ToJSON PExp Source
Plated PExp Source

type ClaferBinding = Maybe UID Source

Embedes reference to a resolved Clafer

data IExp Source

Constructors

IDeclPExp	quantified expression with declarations e.g., [ all x1; x2 : X \| x1.ref != x2.ref ]
Fields _quant :: IQuant _oDecls :: [IDecl] _bpexp :: PExp
IFunExp	expression with a unary function, e.g., -1 binary function, e.g., 2 + 3 ternary function, e.g., if x then 4 else 5
Fields _op :: String _exps :: [PExp]
IInt	integer number
Fields _iint :: Integer
IReal	real number
Fields _ireal :: Double
IDouble	double-precision floating point number
Fields _idouble :: Double
IStr	string
Fields _istr :: String
IClaferId	a reference to a clafer name
Fields _modName :: String module name - currently not used and empty since we have no module system _sident :: CName name of the clafer being referred to _isTop :: Bool identifier refers to a top-level definition _binding :: ClaferBinding the UID of the bound IClafer, if resolved

Instances

Eq IExp Source
Data IExp Source
Ord IExp Source
Show IExp Source
ToJSON IExp Source
Plated IExp Source

data IDecl Source

For IFunExp standard set of operators includes: 1. Unary operators: ! - not (logical) # - set counting operator - - negation (arithmetic) max - maximum (created for goals and maximum of a set) min - minimum (created for goals and minimum of a set) 2. Binary operators: <=> - equivalence => - implication || - disjunction xor - exclusive or && - conjunction < - less than > - greater than = - equality <= - less than or equal >= - greater than or equal != - inequality in - belonging to a set/being a subset nin - not belonging to a set/not being a subset + - addition/string concatenation - - substraction * - multiplication / - division ++ - set union -- - set difference ** - set intersection <: - domain restriction :> - range restriction . - relational join 3. Ternary operators ifthenelse -- if then else

Local declaration disj x1; x2 : X ++ Y y1 : Y

Constructors

IDecl
Fields _isDisj :: Bool is disjunct _decls :: [CName] a list of local names _body :: PExp set to which local names refer to

Instances

Eq IDecl Source
Data IDecl Source
Ord IDecl Source
Show IDecl Source
ToJSON IDecl Source

data IQuant Source

quantifier

Constructors

INo	does not exist
ILone	less than one
IOne	exactly one
ISome	at least one (i.e., exists)
IAll	for all

Instances

Eq IQuant Source
Data IQuant Source
Ord IQuant Source
Show IQuant Source
ToJSON IQuant Source

type LineNo = Integer Source

type ColNo = Integer Source

mapIR :: (Ir -> Ir) -> IModule -> IModule Source

map over IR

foldMapIR :: Monoid m => (Ir -> m) -> IModule -> m Source

foldMap over IR

foldIR :: (Ir -> a -> a) -> a -> IModule -> a Source

fold the IR

iMap :: (Ir -> Ir) -> Ir -> Ir Source

iFoldMap :: Monoid m => (Ir -> m) -> Ir -> m Source

iFold :: (Ir -> a -> a) -> a -> Ir -> a Source

unWrapIModule :: Ir -> IModule Source

unWrapIElement :: Ir -> IElement Source

unWrapIType :: Ir -> IType Source

unWrapIClafer :: Ir -> IClafer Source

unWrapIExp :: Ir -> IExp Source

unWrapPExp :: Ir -> PExp Source

unWrapIReference :: Ir -> Maybe IReference Source

unWrapIQuant :: Ir -> IQuant Source

unWrapIDecl :: Ir -> IDecl Source

unWrapIGCard :: Ir -> Maybe IGCard Source

un :: Traversal' IType [IType] Source

ta :: Traversal' IType IType Source

so :: Traversal' IType IType Source

hi :: Traversal' IType [UID] Source

mName :: Lens' IModule String Source

mDecls :: Lens' IModule [IElement] Source

uid :: Lens' IClafer UID Source

super :: Lens' IClafer (Maybe PExp) Source

reference :: Lens' IClafer (Maybe IReference) Source

parentUID :: Lens' IClafer UID Source

isAbstract :: Lens' IClafer Bool Source

ident :: Lens' IClafer CName Source

glCard :: Lens' IClafer Interval Source

gcard :: Lens' IClafer (Maybe IGCard) Source

elements :: Lens' IClafer [IElement] Source

cinPos :: Lens' IClafer Span Source

card :: Lens' IClafer (Maybe Interval) Source

isMaximize :: Traversal' IElement Bool Source

isHard :: Traversal' IElement Bool Source

iClafer :: Traversal' IElement IClafer Source

cpexp :: Traversal' IElement PExp Source

ref :: Lens' IReference PExp Source

isSet :: Lens' IReference Bool Source

isKeyword :: Lens' IGCard Bool Source

interval :: Lens' IGCard Interval Source

pid :: Lens' PExp String Source

inPos :: Lens' PExp Span Source

iType :: Lens' PExp (Maybe IType) Source

exp :: Lens' PExp IExp Source

sident :: Traversal' IExp CName Source

quant :: Traversal' IExp IQuant Source

op :: Traversal' IExp String Source

oDecls :: Traversal' IExp [IDecl] Source

modName :: Traversal' IExp String Source

istr :: Traversal' IExp String Source

isTop :: Traversal' IExp Bool Source

ireal :: Traversal' IExp Double Source

iint :: Traversal' IExp Integer Source

idouble :: Traversal' IExp Double Source

exps :: Traversal' IExp [PExp] Source

bpexp :: Traversal' IExp PExp Source

binding :: Traversal' IExp ClaferBinding Source

isDisj :: Lens' IDecl Bool Source

decls :: Lens' IDecl [CName] Source

body :: Lens' IDecl PExp Source

data ObjectivesAndAttributes Source

Datatype used for JSON output. See Language.Clafer.gatherObjectivesAndAttributes

Constructors

ObjectivesAndAttributes
Fields _qualities :: [String] _attributes :: [String]

Instances

ToJSON ObjectivesAndAttributes Source

IRIModule IModule
IRIElement IElement
IRIType IType
IRClafer IClafer
IRIExp IExp
IRPExp PExp
IRIReference (Maybe IReference)
IRIQuant IQuant
IRIDecl IDecl
IRIGCard (Maybe IGCard)