HsParrot-0.0.2.20150805: Haskell integration with Parrot virtual machine

Safe HaskellNone
LanguageHaskell98

Language.PIR

Contents

Description

Parrot PIR syntax tree.

  All that is gold does not glitter,
  Not all those who wander are lost;
  The old that is strong does not wither,
  Deep roots are not reached by the frost.

Synopsis

Documentation

type PIR = [Decl] Source

PIR code consists of declarations.

data Decl Source

Constructors

DeclSub

Subroutine declaration

Fields

dsName :: !SubName
 
dsFlags :: ![SubFlag]
 
dsBody :: ![Stmt]
 
DeclNS

Namespace declaration

Fields

dnPackage :: !PkgName
 
dnBody :: ![Decl]
 
DeclInc

.include directive

Fields

diFile :: !FilePath
 
DeclHLL

HLL directive

Fields

dhLang :: !String
 
dhGroup :: !String
 

Instances

Eq Decl Source 
Show Decl Source 
YAML Decl Source 
Emit Decl Source

Emits PIR code for declarations (namespace, include, or sub declarations).

data Stmt Source

Constructors

StmtComment !String

Comment

StmtLine !FilePath !Int

#line directive

StmtPad ![(VarName, Expression)] ![Stmt]

Lexical Pad

StmtRaw !Doc

Backdoor into raw Doc

StmtIns !Ins

Generic instructions

StmtSub !SubName ![Stmt]

Inner subroutine

Instances

data Ins Source

Constructors

InsLocal !RegType !VarName

.local directive

InsNew !LValue !ObjType

new opcode

InsBind !LValue !Expression

set opcode

InsAssign !LValue !Expression

assign opcode

InsPrim !(Maybe LValue) !PrimName ![Expression]

Other opcodes

InsFun ![Sig] !Expression ![Expression]

Function call

InsTailFun !Expression ![Expression]

Tail call

InsLabel !LabelName

Label

InsComment !String !(Maybe Ins)

Comment

InsExp !Expression

Generic expressions

InsConst !LValue !ObjType !Expression

Constant

Instances

data Expression Source

Constructors

ExpLV !LValue

Variables

ExpLit !Literal

Literals

Instances

data LValue Source

Constructors

VAR !VarName

A variable declared by .local

PMC !Int

PMC register n

STR !Int

String register n

INT !Int

Integer register n

NUM !Int

Number register n

KEYED !LValue !Expression 

Instances

data Literal Source

Constructors

LitStr !String

A literal string

LitInt !Integer

A literal integer

LitNum !Double

A literal number

Instances

Eq Literal Source 
Show Literal Source 
YAML Literal Source 
Emit Literal Source

Emits a literal (a LitStr, LitInt, or LitNum), and escapes if necessary.

data SubFlag Source

Tags a PIR subroutine definition with @MAIN, @LOAD, @ANON, @METHOD, or @MULTI.

Constructors

SubMAIN 
SubLOAD 
SubANON 
SubMETHOD 
SubMULTI ![ObjType] 
SubOUTER !SubName 

Instances

Eq SubFlag Source 
Show SubFlag Source 
YAML SubFlag Source 
Emit SubFlag Source

Emits PIR code for a SubFlag (e.g. :main, :anon, etc.).

data RegType Source

Constructors

RegInt

I (Integer) register

RegNum

N (Number) register

RegStr

S (String) register

RegPMC

P (PMC) register

Instances

data ObjType Source

A PMC type, which, for example, can be given as an argument to the new opcode (e.g. new .PerlScalar).

Constructors

PerlScalar 
PerlArray 
PerlHash 
PerlInt 
PerlPair 
PerlRef 
PerlEnv 
Sub 
Closure 
Continuation 
BareType String 

Instances

type LabelName = String Source

type SubName = String Source

type VarName = String Source

type PrimName = String Source

type PkgName = String Source

type CallConv = String Source

emitStmts :: [Stmt] -> Doc Source

curPad :: Int Source

emitRets :: [Sig] -> Doc Source

emitFun :: (Emit b, Emit c) => CallConv -> b -> [c] -> [Sig] -> Doc Source

emitArgs :: Emit a => [a] -> Doc Source

emitFunName :: Emit b => CallConv -> String -> [b] -> [Sig] -> Doc Source

noArgs :: [Expression] Source

expKeyed :: LValue -> Expression -> Expression Source

quoted :: String -> String Source

include :: PkgName -> Decl Source

.include directive.

hll :: String -> String -> Decl Source

.HLL directive.

(<:=) :: LValue -> Expression -> Ins Source

Short for InsBind (binding).

(<==) :: LValue -> Expression -> Ins Source

Short for InsAssign.

(<--) :: LValue -> PrimName -> [Expression] -> Ins infixl 4 Source

Calls an opcode which returns a value.

(.-) :: PrimName -> [Expression] -> Ins infixl 4 Source

Calls an opcode, ignoring any return values.

(<-&) :: [Sig] -> Expression -> [Expression] -> Ins infixl 4 Source

Calls an user-defined sub which returns a list of values.

(.&) :: Expression -> [Expression] -> Ins infixl 4 Source

Calls an user-defined sub, ignoring any return values.

lit0 :: Expression Source

Literal zero

nullPMC :: RegClass a => a Source

$P0 register

funPMC :: RegClass a => a Source

$P1 register

rv :: RegClass a => a Source

$P2 register

arg0 :: RegClass a => a Source

$P10 register

arg1 :: RegClass a => a Source

$P11 register

arg2 :: RegClass a => a Source

$P12 register

arg3 :: RegClass a => a Source

$P13 register

tempPMC :: RegClass a => a Source

$P8 register

tempPMC2 :: RegClass a => a Source

$P9 register

tempSTR :: RegClass a => a Source

$S8 register

tempSTR2 :: RegClass a => a Source

$S9 register

tempSTR3 :: RegClass a => a Source

$S10 register

tempINT :: RegClass a => a Source

$I8 register

tempINT2 :: RegClass a => a Source

$I9 register

tempINT3 :: RegClass a => a Source

$I10 register

tempINT4 :: RegClass a => a Source

$I11 register

tempNUM :: RegClass a => a Source

$N8 register

tempNUM2 :: RegClass a => a Source

$N9 register

class RegClass y where Source

Methods

reg :: LValue -> y Source

Instances

class LiteralClass x where Source

Methods

lit :: x -> Expression Source

Instances

sub Source

Arguments

:: SubName

Name of the subroutine

-> [Sig]

Signature

-> [Ins]

Subroutine body

-> Decl

The final subroutine declaration

Subroutine declaration.

sigList :: [Sig] -> [Expression] Source

data Sig Source

Constructors

MkSig 

Fields

sigFlags :: [ArgFlag]
 
sigIdent :: Expression
 

Instances

data ArgFlag Source

Constructors

MkArgFlatten 
MkArgSlurpyArray 
MkArgMaybeFlatten 
MkArgOptional 

Instances

argVal :: ArgFlag -> Int Source

maybeFlatten :: Doc Source

slurpy :: Expression -> Sig Source

Marks a parameter as slurpy.

(-->) :: Decl -> [Expression] -> Decl infixl 9 Source

Returns from a sub.

retSigList :: [Expression] -> [Expression] Source

vop1 Source

Arguments

:: SubName

Perl 6 name of the opcode to wrap

-> PrimName

PIR opcode

-> Decl

Final subroutine declaration

In the case a Perl 6 builtin corresponds exactly to a PIR opcode, you can use vop1 to create an appropriate wrapper for an opcode expecting one argument.

vop2 Source

Arguments

:: SubName

Perl 6 name of the opcode to wrap

-> PrimName

PIR opcode

-> Decl

Final subroutine declaration

In the case a Perl 6 builtin corresponds exactly to a PIR opcode, you can use vop2 to create an appropriate wrapper for an opcode expecting two arguments.

vop2keyed Source

Arguments

:: SubName

Perl 6 name of the sub to create

-> LValue

Intermediate register to convert the index to (e.g. tempINT or tempSTR)

-> Decl

Final subroutine declaration

Creates a sub which accepts a thing which allows keyed access (for example aggregates) and an index.

vop1x Source

Arguments

:: SubName

Perl 6 name of the sub to create

-> PrimName

Opcode to wrap

-> (forall a. RegClass a => a)

Register to use for the return value of the op

-> (forall b. RegClass b => b)

Register type to convert the parameter to

-> Decl

Final subroutine declaration

Generic wrapper for unary opcodes.

vop1coerce Source

Arguments

:: SubName

Perl 6 name of the sub to create

-> (forall a. RegClass a => a)

Register type to convert the parameter to

-> Decl

Final subroutine declaration

Generic wrapper for coercion/context forcing (used by &prefix:<+>, &prefix:<~>, etc.)

vop2x Source

Arguments

:: SubName

Perl 6 name of the sub to create

-> PrimName

Opcode to wrap

-> (forall a. RegClass a => a)

Register to use for the return value of the op

-> (forall b. RegClass b => b)

Register type to convert the first parameter to

-> (forall c. RegClass c => c)

Register type to convert the second parameter to

-> Decl

Final subroutine declaration

Generic wrapper for two-ary opcodes.

vop1ii :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which accepts and returns an I register.

vop1nn :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which accepts and returns a N register.

vop1ss :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which accepts and returns a S register.

vop1si :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which returns a S register and accepts a I register.

vop1is :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which returns a I register and accepts a S register.

vop1ip :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which returns a I register and accepts a P register.

vop2iii :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which accepts and returns I registers.

vop2nnn :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which accepts and returns N registers.

vop2iss :: SubName -> PrimName -> Decl Source

Wrapper for an opcode which accepts two S registers and returns a native integer (I register).

bare :: VarName -> Expression Source

collectCC :: [Ins] Source

callThunkCC :: Expression -> [Ins] Source

stmtControlLoop Source

Arguments

:: VarName

Perl 6 name of the new sub

-> PrimName

PIR opcode to use for branching

-> Decl

Final declaration of the sub

Creates appropriate &statement_control:foo subroutines.

stmtControlCond Source

Arguments

:: VarName

Perl 6 name of the new sub

-> PrimName

PIR opcode to use for branching

-> Decl

Final declaration of the sub

Creates appropriate &statement_control:foo subroutines.

op2Logical Source

Arguments

:: VarName

Perl 6 name of the sub to create

-> PrimName

PIR opcode to use (if, unless)

-> Decl

Final declaration of the sub

Creates appropriate &infix:foo subs for logical operators (||, &&, etc.).

escaped :: String -> String Source

Escapes characters which have a special meaning in PIR.

preludePIR :: Doc Source

The Prelude, defining primitives like &say, &infix:+, etc.

Generated by DrIFT : Look, but Don't Touch. *

class Show x => Emit x where Source

Methods

emit :: x -> Doc Source

Instances

Emit Int Source 
Emit String Source 
Emit Doc Source 
Emit ObjType Source

Emits PIR code for an ObjType (e.g. .PerlScalar).

Emit RegType Source 
Emit SubFlag Source

Emits PIR code for a SubFlag (e.g. :main, :anon, etc.).

Emit Literal Source

Emits a literal (a LitStr, LitInt, or LitNum), and escapes if necessary.

Emit LValue Source 
Emit Expression Source 
Emit Ins Source 
Emit Stmt Source 
Emit Decl Source

Emits PIR code for declarations (namespace, include, or sub declarations).

Emit a => Emit [a] Source 
Emit [ArgFlag] Source 
Emit a => Emit (Maybe a) Source 

nested :: Emit x => x -> Doc Source

eqSep :: (Emit a, Emit b, Emit c) => a -> b -> [c] -> Doc Source

commaSep :: Emit x => [x] -> Doc Source