asdlGen Reference Manual : Views : Other Properties
Previous: Adding User Code
Next: Choosing a Different Representation

5.3. Other Properties

doc_string

All entities have this property. Its value is interpreted as a string. Currently only the --doc command recognizes the property. It includes the property value in the HTML documentation produced for the module.

source_name

All entities have this property. The value is interpreted as a string. Choose a different name for the type constructor or module in the output code. The name has no case restrictions. This is particularly useful when producing Java code on Windows NT/95 since the file system is case insensitive and types and constructors that differ only in case will cause problems.

user_attribute

Property of types only. The value is interpreted as a qualified identifier. Add a field called client_data as an attribute to the type. The value is the qualified identifier that represents an arbitrary user type of the field. The client_data field is ignored by the pickling code and does not appear in constructors. This property is currently only recognized when outputting C.

user_init

Property of types only. The value is interpreted as a qualified identifier. Call the function specified by the value before returning a the data structure created by a constructor function. This property is currently only recognized when outputting C.

base_class

Property of types only. The value is interpreted as a qualified identifier. The name of the class from which all classes generated for that type should inherit from. This property is recognized only when outputting C++ and Java.

reader

Property of types only. The value is interpreted as a qualified identifier. Replace the body of the read pickle function for this type with a call to a function with the proper arguments.

writer

Property of types only. The value is interpreted as a qualified identifier. Replace the body of the writer pickle function for this type with a call to a function with the proper arguments.

enum_value

Property of constructors only. The value is interpreted as an integer. Use this integer value as the internal tag value for the constructor. The external pickle tag remains unchanged. This property is recognized only when outputting C, C++, and Java.


asdlGen Reference Manual : Views : Other Properties
Previous: Adding User Code
Next: Choosing a Different Representation