Message Bundle Tree Descriptor
A message bundle tree is used by the Avail parser. Since the Avail syntax is so flexible, we make up for that simplicity with a complementary complexity in the parsing mechanism. A message bundle tree is used to keep track of how far along the parser has gotten in the parsing of a method invocation. More powerfully, it does this for multiple methods simultaneously, at least up to the point that the method names diverge.
For example, assume the methods "_foo_bar" and "_foo_baz" are both visible in the current module. After parsing an argument, the "foo" keyword, and another argument, the next thing to look for is either the "bar" keyword or the "baz" keyword. Depending which keyword comes next, we will have parsed an invocation of either the first or the second method. Both possibilities have been parsed together (i.e., only once) up to this point, and the next keyword encountered decides which (if either) method call is being invoked.
MessageSplitter is used to generate a sequence of parsing instructions for a method name. These parsing instructions determine how long multiple potential method invocations can be parsed together and when they must diverge.
Author
Mark van Gulik
Todd L Smith
Parameters
The Mutability of the new descriptor.
Types
The layout of integer slots for my instances.
Functions
Ensure that the specified field is writable.
Create a new object whose descriptor is the receiver, and which has the specified number of indexed (variable) slots.
Create a new object whose descriptor is the receiver, and which has the specified number of indexed (variable) slots.
Create a new object whose descriptor is the receiver, and which has the specified number of indexed (variable) slots.
Can an object using this descriptor have more than the minimum number of integer slots?
Can an object using this descriptor have more than the minimum number of object slots?
Answer how many levels of printing to allow before elision.
Answer whether the argument types supported by the specified FunctionTypeDescriptor are acceptable argument types for invoking a FunctionDescriptor whose type is self.
Answer whether these are acceptable TypeDescriptor for invoking a FunctionDescriptor whose type is self.
Answer whether these are acceptable arguments for invoking a FunctionDescriptor whose type is self.
Answer whether these are acceptable TypeDescriptor for invoking a FunctionDescriptor that is an instance of self. There may be more entries in the TupleDescriptor than are required by the FunctionTypeDescriptor.
Answer whether these are acceptable arguments for invoking a FunctionDescriptor that is an instance of self. There may be more entries in the TupleDescriptor than are required by the FunctionTypeDescriptor.
Record the fact that the given L2Chunk depends on the object not changing in some way peculiar to the kind of object. Most typically, this is applied to A_Methods, triggering invalidation if A_Definitions are added to or removed from the method, but at some point we may also support slowly-changing variables.
Add the plan to this bundle tree. Use self as a monitor for mutual exclusion to ensure changes from multiple fibers won't interfere, not to ensure the mutual safety of A_BundleTree.expand.
Add the operands and answer the result.
Add the operands and answer the result.
Construct a Java string from the given Avail StringDescriptor.
Construct a Java set from the given TupleDescriptor.
Construct a TupleDescriptor from the given SetDescriptor. Element ordering in the tuple will be arbitrary and unstable.
Visit my child phrases with the action.
Map my children through the (destructive) transformation specified by aBlock.
Compare a subrange of the receiver with a subrange of the given TupleDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given ByteStringDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given ByteTupleDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given IntegerIntervalTupleDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given NybbleTupleDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given ObjectTupleDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given RepeatedElementTupleDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given SmallIntegerIntervalTupleDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of another object. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compare a subrange of the receiver with a subrange of the given TwoByteStringDescriptor. The size of the subrange of both objects is determined by the index range supplied for the receiver.
Compute this object's TypeTag, having failed to extract it from the descriptor directly in AvailObjectRepresentation.typeTag.
Answer a fiber's internal debug log.
Describe the object for the IntelliJ debugger.
Divide the operands and answer the result.
Divide the operands and answer the result.
Answer whether the arguments, both objects, are equal in value.
Answer whether the arguments, an object and a TupleDescriptor, are equal in value.
Answer whether the arguments, an object and a ByteStringDescriptor, are equal in value.
Answer whether the arguments, an object, and a ByteTupleDescriptor, are equal in value.
Answer whether the receiver, an object, is a character with a code point equal to the integer argument.
Answer whether the arguments, an object and a CompiledCodeDescriptor, are equal.
Answer whether the arguments, an object and a FiberTypeDescriptor, are equal in value.
Answer whether the arguments, an object and a FunctionDescriptor, are equal in value.
Answer whether the arguments, an object and a FunctionTypeDescriptor, are equal.
Expand the bundle tree if there's anything unclassified in it.
Extract a 64-bit signed Java long from the specified Avail integer.
Answer whether the receiver contains the specified element.
Is the specified AvailObject an Avail atom?
Given two objects that are known to be equal, is the first one in a better form (more compact, more efficient, older generation) than the second one?
Sets only use explicit bins for collisions, otherwise they store the element itself. This works because a bin can't be an element of a set.
Is the specified AvailObject an Avail boolean?
Is the specified AvailObject an Avail byte tuple?
Is the specified AvailObject an Avail character?
Is the specified AvailObject an Avail extended integer?
Is the specified AvailObject an Avail function?
Is the specified AvailObject an Avail map?
Is the specified AvailObject an Avail nybble?
Is the specified AvailObject an Avail set?
Is the specified AvailObject an Avail string?
Is the specified AvailObject an Avail tuple?
Is the specified AvailObject an Avail unsigned byte?
Answer a pojo's java object. The type is not statically checkable in Java, but at least making it generic avoids an explicit cast expression at each call site.
Answer the nearest ancestor that was known at some time to have a backward jump in at least one of its parsing-plans-in-progress.
Given that the receiver is marked immutable, but its slots have not yet been made immutable, scan them now. For each slot found to be mutable, mark it immutable and add it to the supplied list.
Given that the receiver is marked shared, but its slots have not yet been shared, scan them now. For each slot found to be unshared, mark it and add it to the supplied list.
{@inheritDoc}
{@inheritDoc}
Add a DefinitionDescriptor to the receiver. Causes dependent chunks to be invalidated.
Difference the operands and answer the result.
Add a GrammaticalRestrictionDescriptor to the receiver.
Multiply the operands and answer the result.
Multiply the operands and answer the result.
Answer how many arguments my instances expect. This is applicable to both MethodDescriptor and CompiledCodeDescriptor.
Add the operands and answer the result.
Remove the plan from this bundle tree. We don't need to remove the bundle itself if this is the last plan for that bundle, since this can only be called when satisfying a forward declaration – by adding another definition.
Given two objects that are known to be equal, the second of which is in the form of a tuple type, is the first one in a better form than the second one?
Return the MethodDescriptor's TupleDescriptor of FunctionDescriptor that statically restrict call sites by argument type.
Difference the operands and answer the result.
Difference the operands and answer the result.
Multiply the operands and answer the result.
An A_GrammaticalRestriction has been added. Update this bundle tree and any relevant successors related to the given A_ParsingPlanInProgress to agree with the new restriction.
Print the object to the StringBuilder. By default show it as the descriptor's name and a line-by-line list of fields. If the indent is beyond the maximumIndent, indicate it's too deep without recursing. If the object is in the specified recursion list, indicate a recursive print and return.
Answer the shared version of this descriptor.
Throw an AvailUnsupportedOperationException suitable to be thrown by the sender.
Properties
A Statistic that records the number and size of each allocation.
Used for quickly checking integer fields when AvailObjectRepresentation.shouldCheckSlots is enabled.
Used for quickly checking object fields when AvailObjectRepresentation.shouldCheckSlots is enabled.
This is the most recently encountered backward jump in the ancestry of this bundle tree, or nil if none were encountered in the ancestry. There could be multiple competing parsing plans in that target bundle tree, some of which had a backward jump and some of which didn't, but we only require that at least one had a backward jump.
The minimum number of integer slots an AvailObject can have if it uses this descriptor. Does not include indexed slots possibly at the end. Populated automatically by the constructor.
The minimum number of object slots an AvailObject can have if it uses this descriptor. Does not include indexed slots possibly at the end. Populated automatically by the constructor.
This read-only property can be used in place of unsupportedOperation. Using the getter produces almost the same diagnostic stack trace when executed, but is a much shorter expression.