Skip to main content

This version of the product is no longer supported, and this documentation is no longer updated regularly. See the latest version of this content.Opens in a new tab

%Compiler.Util.ParseTree

Property Inventory

Method Inventory

Properties

property source as %Stream.Object;
Property methods: sourceDelete(), sourceGet(), sourceGetObject(), sourceGetObjectId(), sourceGetSwizzled(), sourceIsValid(), sourceNewObject(), sourceOid(), sourceOpen(), sourceSet(), sourceSetObject(), sourceSetObjectId(), sourceUnSwizzle()
property stack as %Integer;
Property methods: stackDisplayToLogical(), stackGet(), stackIsValid(), stackLogicalToDisplay(), stackNormalize(), stackSet()
property treePtr as %Integer;
Property methods: treePtrDisplayToLogical(), treePtrGet(), treePtrIsValid(), treePtrLogicalToDisplay(), treePtrNormalize(), treePtrSet()

Methods

abstract method %AddToSaveSet(depth As %Integer = 3, refresh As %Integer = 0, norecurseon As %String = "") as %Status
Inherited description:

This method adds the current object to the SaveSet containing objects that are part of the current %Save() for persistent classes or %GetSwizzleObject for serial classes. A queue of objects to be saved or serialized is also constructed. Only modified objects are included in the save queue. The value (OID or serial value in OID form) of each object is also placed in the SaveSet.

This method will invoke the %OnAddToSaveSet method if it is implemented. See that method for more information.

%AddToSaveSet should not ever be invoked directly except from %OnAddToSaveSet().

This method takes these parameters: depth, with these values:

1: Include this object in the SaveSet and, if it has not been serialized put it in the save queue and invoke %AddToSaveSet on any objects referenced by this object to the SaveSet with a depth of 1.
2: Include this object in the SaveSet and save queue. Also invoke %AddToSaveSet on any referenced objects in the SaveSet with a depth of 1.
3: Include this object in the SaveSet and, if modified, the save queue. Also invoke %AddToSaveSet on any referenced objects in the SaveSet with a depth of 3.
refresh, with these values:
0: Add this object to the save set only if it isn't already included.
1: Add this object to the SaveSet even if it already exists. This causes object dependencies to be rebuilt. Typically, this value is only passed by %OnAddToSaveSet when it modifies objects other than the current one.

Note: Swizzled serial objects always have an empty serial value and will always be placed in the save queue and the SaveSet. the value of depth simply gets passed on to its referenced objects.

abstract method %BindExport(dev As %String, ByRef Seen As %String, RegisterOref As %Boolean, AllowedDepth As %Integer, AllowedCapacity As %Integer) as %Status
Inherited description: This method is used by Language Binding Engine to send the whole object and all objects it referes to to the client.
abstract method %ConstructClone(deep As %Boolean = 0, ByRef cloned As %String, location As %String) as %RegisteredObject
Inherited description: Clone the current object to a new object. If deep is 1 then this does a deep copy which will also copy any subobjects and if deep is 0 then it will create another reference to any subobjects and increment the reference count appropriately. It returns the new cloned object.

Note that even if deep=0 when you clone a parent object in a parent child relationship or a one object of a one to many relationship then it will construct clones of all the child/many objects. This is because a child/many object can only point at a single parent and so if we did not create a clone of these then you would have a relationship with zero items in it. If you really just want to clone the object without these child/many objects then pass deep=-1 to this method.

After the clone is constructed it will call %OnConstructClone(object,deep,.cloned) on the clone if it is defined so that you can perform any additional steps e.g. taking out a lock. This works just the same way as %OnNew() does.

The object is the oref of the original object that was cloned. The cloned array is just used internally when doing a deep clone to prevent recursive loops, do not pass anything in at all for this parameter on the initial call. If you write a %OnConstructClone and from here you wish to call %ConstructClone on another object pass in the cloned array, e.g. 'Do oref.%ConstructClone(1,.cloned)' so that it can prevent recursive loops.

The location is used internally to pass the new location for stream objects.

abstract method %NormalizeObject() as %Status
Inherited description: Normalizes all of an object's property values by invoking the data type Normalize methods. Many data types may allow many different representations of the same value. Normalization converts a value to its cannonical, or normalized, form.
abstract method %RemoveFromSaveSet() as %Status
Inherited description:

This method removes the current object from the SaveSet. If this object is also in the save queue it is removed from there as well.

abstract method %SerializeObject(ByRef serial As %Binary, partial As %Integer = 0) as %Status
Inherited description: This method retrieves all of the serial values for referenced objects and places them into the instance variables, Validates, Normalizes, and serializes the object (with a save of the persistent image if persistent).
This method is not meant to be called directly. It is called by %Save and by %GetSwizzleObject.
abstract method %ValidateObject(force As %Library.Integer = 0, checkserial As %Library.Boolean = 1) as %Status
Inherited description: This method validates an object. The %Save method of a persistent class calls it before filing any objects in the database. The %ValidateObject method of a referencing object can call it. You can also call it explicitly at any time.

%ValidateObject() does the following:

  1. It tests if any required property values are missing.
  2. If the PROPERTYVALIDATION class parameter is set to ValidateOnSave, it validates each non-null property value by calling the property method IsValid on each literal property and the object's %ValidateObject method for object-valued properties.
  3. If present, it will call a user-supplied %OnValidateObject() method.

If any of these tests fail, %ValidateObject() immediately returns an error value. It is up to the caller of %ValidateObject to process the error value.

Returns a %Status value indicating success or failure.

classmethod Parse(source As %CacheString, settings As %CacheString = "", ByRef returnStatus As %Status, trigger As %Boolean = 0) as %Compiler.Util.ParseTree
method accept(visitor As %Compiler.Util.Visitor) as %Status
accept() This method 'accepts' a visitor to the parse tree. The visitor can perform any actions such as displaying the parse tree traversal, code generation, constructing intermediate forms, etc. Accepting a visitor is more like giving a guest a tour of the tree(house). This implementation traverses the parse tree and invokes the appropriate visit method from the visitor on each node. The visit method invoked depends on the node type and is of the form v. If the visitor wishes to report on the visit experience then a message stack is provided. If the visitor wishes to abort the tour prematurely then just throw an exception in the visit method - we'll catch it gracefully.
abstract classmethod parseStream(source As %Stream.Object, settings As %CacheString = "", ByRef returnStatus As %Status, trigger As %Boolean = 0) as %Compiler.Util.ParseTree
parseStream() This method is responsible for invoking the parser. The parser constructs the parseTree and returns any errors encountered. Since the parser can vary by compiler, this method is abstract and expected to be implemented by the specific compiler.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab