avail/avail.compiler.splitter/MessageSplitter

MessageSplitter

class MessageSplitter constructor(messageName: A_String)

MessageSplitter is used to split Avail message names into a sequence of instructions that can be used directly for parsing.

Message splitting occurs in two phases. In the first setPhase, the message is tokenized and parsed into an abstract Expression tree. In the second setPhase, a tuple type of phrase types is supplied, and produces a tuple of integer-encoded ParsingOperations.

Author

Mark van Gulik

Todd L Smith

Parameters

messageName

An Avail string specifying the keywords and arguments of some message being defined.

Throws

avail.exceptions.MalformedMessageException

    If the message name is malformed.

Constructors

MessageSplitter

fun MessageSplitter(messageName: A_String)

Construct a new MessageSplitter, parsing the provided message into token strings and generating parsing for parsing occurrences of this message.

Types

Companion

object Companion

Metacharacter

enum Metacharacter : Enum<MessageSplitter.Metacharacter>

The metacharacters used in message names.

Functions

checkImplementationSignature

@JvmOverloads

fun checkImplementationSignature(functionType: A_Type, sectionNumber: Int = Integer.MAX_VALUE)

Check that an implementation with the given signature is appropriate for a message like this.

checkListStructure

fun checkListStructure(list: A_Phrase): Boolean

Answer whether the given list is correctly internally structured for a send of this message. It must recursively match the expected number of arguments, as well as have the expected permutations in the corresponding recursive Expressions.

highlightedNameFor

fun highlightedNameFor(phraseType: A_Type, pc: Int): String

Answer a String containing the message name with an indicator inserted to show which area of the message is being parsed by the given program counter.

instructionsTupleFor

fun instructionsTupleFor(phraseType: A_Type): A_Tuple

Answer a tuple of Avail integers describing how to parse this message. See MessageSplitter and ParsingOperation for an understanding of the parse instructions.

printSendNodeOnIndent

fun printSendNodeOnIndent( sendPhrase: A_Phrase, builder: StringBuilder, indent: Int)

Pretty-print a send of this message with given argument phrases.

toString

open override fun toString(): String

Properties

containsGroups

val containsGroups: Boolean

Does the message contain any groups?

leafArgumentCount

val leafArgumentCount: Int = 0

The number of underscores/ellipses present in the method name. This is not the same as the number of arguments that a method implementing this name would accept, as a top-level guillemet group with N recursively embedded underscores/ellipses is counted as N, not one.

messageName

val messageName: A_String

The Avail string to be parsed.

messageParts

val messageParts: Array<A_String>

The individual tokens (strings) constituting the message.

numberOfArguments

val numberOfArguments: Int

Return the number of arguments a MethodDefinitionDescriptor implementing this name would accept. Note that this is not necessarily the number of underscores and ellipses, as a guillemet group may contain zero or more underscores/ellipses (and other guillemet groups) but count as one top-level argument.

numberOfSectionCheckpoints

var numberOfSectionCheckpoints: Int = 0

The number of SectionCheckpoints encountered so far.

recursivelyContainsReorders

val recursivelyContainsReorders: Boolean

Answer whether there are any reordered expressions anywhere inside this method name. Reordering is specified by placing circled numbers (e.g., ①, ②) after all argument-yielding Expressions occurring in some Sequence. Either none or all must be numbered within any sequence, and the numbers must be a non-identity permutation (not simply ①, ②, ③, etc.).