Package net.hydromatic.morel.ast

Enum CoreBuilder

java.lang.Object

java.lang.Enum<CoreBuilder>

net.hydromatic.morel.ast.CoreBuilder

All Implemented Interfaces:

Serializable, Comparable<CoreBuilder>

public enum CoreBuilder
extends Enum<CoreBuilder>

Builds parse tree nodes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
core	The singleton instance of the CORE builder.

Field Summary

Fields

Modifier and Type	Field	Description
private Core.WildcardPat	boolWildcardPat
private Core.Literal	falseLiteral
private Core.Literal	trueLiteral
private Core.LiteralPat	truePat

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CoreBuilder()

Method Summary

Modifier and Type	Method	Description
Core.Aggregate	aggregate(Type type, Core.Exp aggregate, @Nullable Core.Exp argument)
Core.Exp	andAlso(TypeSystem typeSystem, Core.Exp a0, Core.Exp a1)
Core.Apply	apply(Pos pos, Type type, Core.Exp fn, Core.Exp arg)
private Core.Exp	args(Type paramType, Core.Exp[] args)
Core.AsPat	asPat(Type type, String name, int i, Core.Pat pat)
Core.AsPat	asPat(Type type, String name, NameGenerator nameGenerator, Core.Pat pat)	Creates an AsPat with a given name, generating an ordinal to distinguish it from other declarations with the same name elsewhere in the program.
Core.Literal	boolLiteral(boolean b)	Creates a boolean literal.
private static Core.Literal	boolLiteral_(boolean b)	Used only during initialization.
private Core.Apply	call(TypeSystem typeSystem, BuiltIn builtIn, Core.Exp... args)	Calls a built-in function.
private Core.Apply	call(TypeSystem typeSystem, BuiltIn builtIn, Type type, Pos pos, Core.Exp... args)	Calls a built-in function with one type parameter.
Core.Case	caseOf(Type type, Core.Exp exp, Iterable<? extends Core.Match> matchList, Pos pos)
Core.Literal	charLiteral(char c)	Creates a char literal.
Core.Con0Pat	con0Pat(DataType type, String tyCon)
Core.ConPat	conPat(Type type, String tyCon, Core.Pat pat)
Core.ConPat	consPat(Type type, String tyCon, Core.Pat pat)
Core.DatatypeDecl	datatypeDecl(Iterable<DataType> dataTypes)
Core.Exp	elem(TypeSystem typeSystem, Core.Exp a0, Core.Exp a1)
Core.Exp	equal(TypeSystem typeSystem, Core.Exp a0, Core.Exp a1)
Core.Exp	field(TypeSystem typeSystem, Core.Exp exp, int slot)	Creates a reference to the slotth field of an expression, "#slot exp".
Core.Fn	fn(FnType type, Core.IdPat idPat, Core.Exp exp)
Core.From	from(ListType type, List<Core.FromStep> steps)
Core.From	from(TypeSystem typeSystem, List<Core.FromStep> steps)	Derives the result type, then calls from(ListType, List).
FromBuilder	fromBuilder(TypeSystem typeSystem)	Creates a builder that will create a Core.From but does not validate.
FromBuilder	fromBuilder(TypeSystem typeSystem, @Nullable Environment env)	Creates a builder that will create a Core.From.
(package private) static Type	fromElementType(TypeSystem typeSystem, List<Core.FromStep> steps)	Returns the element type of a Core.From with the given steps.
Core.Literal	functionLiteral(TypeSystem typeSystem, BuiltIn builtIn)	Creates a function literal.
Core.Exp	greaterThan(TypeSystem typeSystem, Core.Exp a0, Core.Exp a1)
Core.Group	group(SortedMap<Core.IdPat,Core.Exp> groupExps, SortedMap<Core.IdPat,Core.Aggregate> aggregates)
Core.Id	id(Core.NamedPat idPat)	Creates a reference to a value.
Core.IdPat	idPat(Type type, String name, int i)	Creates an IdPat with a given name and ordinal.
Core.IdPat	idPat(Type type, String name, NameGenerator nameGenerator)	Creates an IdPat with a given name, generating an ordinal to distinguish it from other declarations with the same name elsewhere in the program.
Core.IdPat	idPat(Type type, NameGenerator nameGenerator)	Creates an IdPat with a system-generated unique name.
Core.Case	ifThenElse(Core.Exp condition, Core.Exp ifTrue, Core.Exp ifFalse)
Core.Exp	implicitYieldExp(TypeSystem typeSystem, List<Core.FromStep> steps)	Returns what would be the yield expression if we created a Core.From from the given steps.
Core.Literal	intLiteral(BigDecimal value)	Creates an int literal.
List<Binding>	lastBindings(List<? extends Core.FromStep> steps)
Core.Exp	lessThan(TypeSystem typeSystem, Core.Exp a0, Core.Exp a1)
Core.Let	let(Core.ValDecl decl, Core.Exp exp)
Core.Exp	list(TypeSystem typeSystem, Type elementType, List<Core.Exp> args)	Creates a list.
Core.ListPat	listPat(Type type, Iterable<? extends Core.Pat> args)
Core.ListPat	listPat(Type type, Core.Pat... args)
Core.ListPat	listPat(TypeSystem typeSystem, List<Core.Pat> args)
Core.Literal	literal(PrimitiveType type, Object value)	Creates a literal.
Core.LiteralPat	literalPat(Op op, Type type, Comparable value)
Core.Local	local(DataType dataType, Core.Exp exp)
Core.Match	match(Core.Pat pat, Core.Exp exp, Pos pos)
Core.NonRecValDecl	nonRecValDecl(Core.NamedPat pat, Core.Exp exp, Pos pos)
Core.Exp	only(TypeSystem typeSystem, Pos pos, Core.Exp a0)
Core.Order	order(List<Binding> bindings, Iterable<Core.OrderItem> orderItems)
Core.OrderItem	orderItem(Core.Exp exp, Ast.Direction direction)
Core.Exp	orElse(TypeSystem typeSystem, Core.Exp a0, Core.Exp a1)
Core.Literal	realLiteral(Float value)	Creates a float literal with a non-normal value.
Core.Literal	realLiteral(BigDecimal value)	Creates a float literal.
Core.Exp	record(TypeSystem typeSystem, Map<String,? extends Core.Exp> nameExps)	Creates a record.
Core.RecordPat	recordPat(RecordType type, List<? extends Core.Pat> args)
Core.Pat	recordPat(TypeSystem typeSystem, Set<String> argNames, List<Core.Pat> args)
Core.RecordSelector	recordSelector(FnType fnType, int slot)
Core.RecordSelector	recordSelector(TypeSystem typeSystem, RecordLikeType recordType, int slot)
Core.RecordSelector	recordSelector(TypeSystem typeSystem, RecordLikeType recordType, String fieldName)
Core.RecValDecl	recValDecl(Iterable<? extends Core.NonRecValDecl> list)
Core.Scan	scan(Op op, List<Binding> bindings, Core.Pat pat, Core.Exp exp, Core.Exp condition)
Core.Literal	stringLiteral(String value)	Creates a string literal.
Core.Tuple	tuple(RecordLikeType type, Iterable<? extends Core.Exp> args)
Core.Tuple	tuple(RecordLikeType type, Core.Exp... args)
Core.Tuple	tuple(TypeSystem typeSystem, @Nullable RecordLikeType type, Iterable<? extends Core.Exp> args)	As tuple(RecordLikeType, Iterable), but derives type.
Core.TuplePat	tuplePat(Type type, Iterable<? extends Core.Pat> args)
Core.TuplePat	tuplePat(Type type, Core.Pat... args)
Core.TuplePat	tuplePat(TypeSystem typeSystem, List<Core.Pat> args)
Core.Literal	unitLiteral()	Creates a unit literal.
Core.Literal	valueLiteral(Core.Exp exp, Object value)	Creates a value literal.
static CoreBuilder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CoreBuilder[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
Core.Where	where(List<Binding> bindings, Core.Exp exp)
Core.WildcardPat	wildcardPat(Type type)
Core.Yield	yield_(List<Binding> bindings, Core.Exp exp)
Core.Yield	yield_(TypeSystem typeSystem, Core.Exp exp)	Derives bindings, then calls yield_(List, Core.Exp).

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

core

public static final CoreBuilder core

The singleton instance of the CORE builder. The short name is convenient for use via 'import static', but checkstyle does not approve.

Field Detail

truePat

private final Core.LiteralPat truePat

boolWildcardPat

private final Core.WildcardPat boolWildcardPat

trueLiteral

private final Core.Literal trueLiteral

falseLiteral

private final Core.Literal falseLiteral

Constructor Detail

CoreBuilder

private CoreBuilder()

Method Detail

values

public static CoreBuilder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CoreBuilder c : CoreBuilder.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CoreBuilder valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

literal

public Core.Literal literal(PrimitiveType type,
                            Object value)

Creates a literal.

boolLiteral_

private static Core.Literal boolLiteral_(boolean b)

Used only during initialization.

boolLiteral

public Core.Literal boolLiteral(boolean b)

Creates a boolean literal.

charLiteral

public Core.Literal charLiteral(char c)

Creates a char literal.

intLiteral

public Core.Literal intLiteral(BigDecimal value)

Creates an int literal.

realLiteral

public Core.Literal realLiteral(BigDecimal value)

Creates a float literal.

realLiteral

public Core.Literal realLiteral(Float value)

Creates a float literal with a non-normal value.

stringLiteral

public Core.Literal stringLiteral(String value)

Creates a string literal.

unitLiteral

public Core.Literal unitLiteral()

Creates a unit literal.

functionLiteral

public Core.Literal functionLiteral(TypeSystem typeSystem,
                                    BuiltIn builtIn)

Creates a function literal.

valueLiteral

public Core.Literal valueLiteral(Core.Exp exp,
                                 Object value)

Creates a value literal.

id

public Core.Id id(Core.NamedPat idPat)

Creates a reference to a value.

recordSelector

public Core.RecordSelector recordSelector(TypeSystem typeSystem,
                                          RecordLikeType recordType,
                                          String fieldName)

recordSelector

public Core.RecordSelector recordSelector(TypeSystem typeSystem,
                                          RecordLikeType recordType,
                                          int slot)

recordSelector

public Core.RecordSelector recordSelector(FnType fnType,
                                          int slot)

idPat

public Core.IdPat idPat(Type type,
                        String name,
                        int i)

Creates an IdPat with a given name and ordinal. You must ensure that the ordinal is unique for this name in this program.

idPat

public Core.IdPat idPat(Type type,
                        NameGenerator nameGenerator)

Creates an IdPat with a system-generated unique name.

idPat

public Core.IdPat idPat(Type type,
                        String name,
                        NameGenerator nameGenerator)

Creates an IdPat with a given name, generating an ordinal to distinguish it from other declarations with the same name elsewhere in the program.

literalPat

public Core.LiteralPat literalPat(Op op,
                                  Type type,
                                  Comparable value)

wildcardPat

public Core.WildcardPat wildcardPat(Type type)

asPat

public Core.AsPat asPat(Type type,
                        String name,
                        int i,
                        Core.Pat pat)

asPat

public Core.AsPat asPat(Type type,
                        String name,
                        NameGenerator nameGenerator,
                        Core.Pat pat)

Creates an AsPat with a given name, generating an ordinal to distinguish it from other declarations with the same name elsewhere in the program.

consPat

public Core.ConPat consPat(Type type,
                           String tyCon,
                           Core.Pat pat)

conPat

public Core.ConPat conPat(Type type,
                          String tyCon,
                          Core.Pat pat)

con0Pat

public Core.Con0Pat con0Pat(DataType type,
                            String tyCon)

tuplePat

public Core.TuplePat tuplePat(Type type,
                              Iterable<? extends Core.Pat> args)

tuplePat

public Core.TuplePat tuplePat(Type type,
                              Core.Pat... args)

tuplePat

public Core.TuplePat tuplePat(TypeSystem typeSystem,
                              List<Core.Pat> args)

listPat

public Core.ListPat listPat(Type type,
                            Iterable<? extends Core.Pat> args)

listPat

public Core.ListPat listPat(Type type,
                            Core.Pat... args)

listPat

public Core.ListPat listPat(TypeSystem typeSystem,
                            List<Core.Pat> args)

recordPat

public Core.RecordPat recordPat(RecordType type,
                                List<? extends Core.Pat> args)

recordPat

public Core.Pat recordPat(TypeSystem typeSystem,
                          Set<String> argNames,
                          List<Core.Pat> args)

tuple

public Core.Tuple tuple(RecordLikeType type,
                        Iterable<? extends Core.Exp> args)

tuple

public Core.Tuple tuple(RecordLikeType type,
                        Core.Exp... args)

tuple

public Core.Tuple tuple(TypeSystem typeSystem,
                        @Nullable RecordLikeType type,
                        Iterable<? extends Core.Exp> args)

As tuple(RecordLikeType, Iterable), but derives type.

If present, type serves as a template, dictating whether to produce a record or a tuple type, and if a record type, the field names. If not present, the result is a tuple type.

let

public Core.Let let(Core.ValDecl decl,
                    Core.Exp exp)

local

public Core.Local local(DataType dataType,
                        Core.Exp exp)

nonRecValDecl

public Core.NonRecValDecl nonRecValDecl(Core.NamedPat pat,
                                        Core.Exp exp,
                                        Pos pos)

recValDecl

public Core.RecValDecl recValDecl(Iterable<? extends Core.NonRecValDecl> list)

match

public Core.Match match(Core.Pat pat,
                        Core.Exp exp,
                        Pos pos)

caseOf

public Core.Case caseOf(Type type,
                        Core.Exp exp,
                        Iterable<? extends Core.Match> matchList,
                        Pos pos)

from

public Core.From from(ListType type,
                      List<Core.FromStep> steps)

from

public Core.From from(TypeSystem typeSystem,
                      List<Core.FromStep> steps)

Derives the result type, then calls from(ListType, List).

fromElementType

static Type fromElementType(TypeSystem typeSystem,
                            List<Core.FromStep> steps)

Returns the element type of a Core.From with the given steps.

implicitYieldExp

public Core.Exp implicitYieldExp(TypeSystem typeSystem,
                                 List<Core.FromStep> steps)

Returns what would be the yield expression if we created a Core.From from the given steps.

Examples:

• implicitYieldExp(steps=[scan(a=E:t)]) is a (a Core.Id);
• implicitYieldExp(steps=[scan(a=E:t), scan(b=E2:t2)]) is {a = a, b = b} (a record).

lastBindings

public List<Binding> lastBindings(List<? extends Core.FromStep> steps)

fromBuilder

public FromBuilder fromBuilder(TypeSystem typeSystem,
                               @Nullable Environment env)

Creates a builder that will create a Core.From.

fromBuilder

public FromBuilder fromBuilder(TypeSystem typeSystem)

Creates a builder that will create a Core.From but does not validate.

fn

public Core.Fn fn(FnType type,
                  Core.IdPat idPat,
                  Core.Exp exp)

apply

public Core.Apply apply(Pos pos,
                        Type type,
                        Core.Exp fn,
                        Core.Exp arg)

ifThenElse

public Core.Case ifThenElse(Core.Exp condition,
                            Core.Exp ifTrue,
                            Core.Exp ifFalse)

datatypeDecl

public Core.DatatypeDecl datatypeDecl(Iterable<DataType> dataTypes)

scan

public Core.Scan scan(Op op,
                      List<Binding> bindings,
                      Core.Pat pat,
                      Core.Exp exp,
                      Core.Exp condition)

aggregate

public Core.Aggregate aggregate(Type type,
                                Core.Exp aggregate,
                                @Nullable Core.Exp argument)

order

public Core.Order order(List<Binding> bindings,
                        Iterable<Core.OrderItem> orderItems)

orderItem

public Core.OrderItem orderItem(Core.Exp exp,
                                Ast.Direction direction)

group

public Core.Group group(SortedMap<Core.IdPat,Core.Exp> groupExps,
                        SortedMap<Core.IdPat,Core.Aggregate> aggregates)

where

public Core.Where where(List<Binding> bindings,
                        Core.Exp exp)

yield_

public Core.Yield yield_(List<Binding> bindings,
                         Core.Exp exp)

yield_

public Core.Yield yield_(TypeSystem typeSystem,
                         Core.Exp exp)

Derives bindings, then calls yield_(List, Core.Exp).

field

public Core.Exp field(TypeSystem typeSystem,
                      Core.Exp exp,
                      int slot)

Creates a reference to the slotth field of an expression, "#slot exp". The expression's type must be record or tuple.

list

public Core.Exp list(TypeSystem typeSystem,
                     Type elementType,
                     List<Core.Exp> args)

Creates a list.

record

public Core.Exp record(TypeSystem typeSystem,
                       Map<String,? extends Core.Exp> nameExps)

Creates a record.

call

private Core.Apply call(TypeSystem typeSystem,
                        BuiltIn builtIn,
                        Core.Exp... args)

Calls a built-in function.

call

private Core.Apply call(TypeSystem typeSystem,
                        BuiltIn builtIn,
                        Type type,
                        Pos pos,
                        Core.Exp... args)

Calls a built-in function with one type parameter.

args

private Core.Exp args(Type paramType,
                      Core.Exp[] args)

equal

public Core.Exp equal(TypeSystem typeSystem,
                      Core.Exp a0,
                      Core.Exp a1)

lessThan

public Core.Exp lessThan(TypeSystem typeSystem,
                         Core.Exp a0,
                         Core.Exp a1)

greaterThan

public Core.Exp greaterThan(TypeSystem typeSystem,
                            Core.Exp a0,
                            Core.Exp a1)

elem

public Core.Exp elem(TypeSystem typeSystem,
                     Core.Exp a0,
                     Core.Exp a1)

andAlso

public Core.Exp andAlso(TypeSystem typeSystem,
                        Core.Exp a0,
                        Core.Exp a1)

orElse

public Core.Exp orElse(TypeSystem typeSystem,
                       Core.Exp a0,
                       Core.Exp a1)

only

public Core.Exp only(TypeSystem typeSystem,
                     Pos pos,
                     Core.Exp a0)