Various definitions and declarations can be annotated with attributes. This section describes the general syntax of attributes and where they can be placed. It also describes the meaning of the specific attributes.
- 1 Syntax
- 2 Insertion Points
- 3 Specific Attributes
- 3.1 attribute
- 3.2 byVal
- 3.3 classInitializer
- 3.4 constant
- 3.5 compiletimeSetting
- 3.6 default
- 3.7 deprecated
- 3.8 formatString
- 3.9 immediate
- 3.10 in
- 3.11 in_iterate
- 3.12 in_test
- 3.13 inline
- 3.14 intrinsic
- 3.15 mandatoryOut
- 3.16 noDefaultConstructor
- 3.17 out
- 3.18 pack
- 3.19 programPoint
- 3.20 presenter
- 3.21 retired
- 3.22 retiredFunctor
- 3.23 sealed
- 3.24 this
- 3.25 union
- 3.26 used
Attributes : [ Attribute-comma-sep-list ]
Attribute : one of LowerCaseIdentifier LowerCaseIdentifier ( Literal-comma-sep-list )
where the literals must either be numbers or string literals.
The attributes of interfaces, classes and implementations are right after the scope qualifications.
InterfaceDeclaration : interface IinterfaceName ScopeQualifications Attributes-opt Sections end interface IinterfaceName-opt
ClassDeclaration : class ClassName ConstructionType-opt ScopeQualifications Attributes-opt Sections end class ClassName-opt
ClassImplementation : implement ClassName ScopeQualifications Attributes-opt Sections end implement ClassName-opt
The attributes of constants, domains, predicates, properties and facts are at the end (i.e. right before the terminating dot).
ConstantDefinition: one of ConstantName = ConstantValue Attributes-opt ConstantName : TypeName = ConstantValue Attributes-opt
DomainDefinition: DomainName FormalTypeParameterList-opt = TypeExpression Attributes-opt
PredicateDeclaration : PredicateName : PredicateDomain LinkName-opt Attributes-opt PredicateName : PredicateDomainName LinkName-opt Attributes-opt
PropertyDeclaration : PropertyName : PropertyType FlowPattern-list-opt Attributes-opt
FactDeclaration : FactVariableDeclaration Attributes-opt FactFunctorDeclaration Attributes-opt
The attributes of formal arguments are at the end.
FormalArgument : TypeExpression ArgumentName-opt Attributes-opt
This attribute is used on a functor domain to indicate that the functors in the domain can be used as attributes elsewhere in the program.
domains meta = meta; metaDisplayAs(string DisplayAs) [attribute].
An argument is transferred directly on the stack rather than using a pointer. Valid for formal predicate arguments provided the language is stdcall, apicall or c.
domains point = point(integer X, integer Y). predicates externalP : (point Point [byVal]) language apicall.
The attribute can also be used in combination with the out attribute:
predicates externalP2 : (point Point [byVal, out]) language apicall.
In that case a point structure will be allocated before the call then a pointer to that structure is transferred handed to the external predicate which can then fill the structure with relevant data.
This attribute indicates that a predicate should be invoked as a class initializer. It can be applied to a class predicate that does not take any arguments. The predicate will be invoked when the initialization code invokes the runtime_api::runProgramInitialization. A class can have any number of class initializer which will be invoked in an undetermined order. Notice that other classes may not have been initialized.
The predicate xxx::initialize is registered as a class initializer:
implement xxx class predicates initialize : () [classInitializer]. clauses initialize() :- … end class xxx
The constant attribute is used to declare fact variables that cannot be changed once they have been initialized.
The compiletimeSetting attribute indicates that a constant should be considered a compiletime setting. As a result the compiler will suppress warnings about always failing/succeding code and about unreachable code that may be caused by this constant. The warning suppession is an approximation, because it a may be impossible/difficult to determine the cause of a warning.
implement xxx constants debugOutput : boolean = false [compiletimeSetting]. clauses pppp(...) :- ... if true = debugOutput then % do not give a warning about unreachable code log::write(...) end if, ... end implement xxx
It is problematic to update functor domains, if terms have been persisted in serialized form. Because new programs cannot deal with old serializations.
The two attributes default/1 and retiredFunctor/1 can help dealing with this problem.
The last arguments of a functor can have default values:
domains ppp = fct( integer A, real B, ddd C, integer* New [default()], real New2 [default(0)] ).
The default attribute does not change anything within the program; it only affects the deserialization. If during deserialization we meet the closing parenthesis too soon we supply default values for the remaining arguments.
Notice that this will only work for text deserialization.
See also Functor Domain Versioning.
The declared entity is deprecated. The string literal describes how to migrate from it. The entity still exists, but usage will cause a warning. The entity will not exist in future versions of Visual Prolog. Valid for member declarations and scopes.
predicates oldFashioned : (string Arg) [deprecated("Use newFashion instead")].
The argument is a format string for a subsequent ellipsis argument (i.e. ...). Valid for one string argument of a predicate with an ellipsis argument. The use of formatString will make the compiler check the validity of actual arguments with respect to actual format strings (where possible).
predicates writef : (string Format [formatString], ...).
The attribute immediate enforces immediate (i.e. non-late) initialization of a fact variable:
facts current : integer := initializeCurrent() [immediate].
See also Fact Variable Declarations.
The argument is an input argument. Valid for a formal predicate argument.
predicates pred : (string InputArg [in]).
Defines an in-iterator predicate for a domain or interface. See the description of the in operator.
Defines an in-test for a domain or interface. See the description of the in operator.
inline alters the memory layout of a struct (i.e. a single alternative functor domain with an align qualification). The purpose of the attribute is to ease interfacing to foreign languages and should normally not be used for pure Visual Prolog.
inline can be used in three cases:
- inlining a struct rather than having a pointer to the struct
- inlining a fixed size string
- inlining a fixed number of bytes
When using inline on struct field in another struct its data will be inlined instead of having a pointer to the struct
domains point =p(integer X, integer Y). domains rectangle = r( point UpperLeft [inline], point LowerRight [inline] ).
Since UpperLeft and LowerRight are inlined the struct have the same memory layout as this one:
domains rectangle2 = r2( integer UpperLeft_X, integer UpperLeft_Y, integer LowerRight_X, integer LowerRight_Y ).
When using inline(<size>) on a string or a string8 field in a struct, the struct will contain a fixed size string with <size> characters (i.e. char or char8, respectively). The strings will be zero terminated if they are shorter than <size>, but not if they have <size> characters.
domains device = device( integer Id, string DeviceName [inline(12)] ).
DeviceName is an inlined Unicode string of length 12. The struct have the same layout as:
domains device = device( integer Id, char DeviceName_01, char DeviceName_02, char DeviceName_03, char DeviceName_04, char DeviceName_05, char DeviceName_06, char DeviceName_07, char DeviceName_08, char DeviceName_09, char DeviceName_10, char DeviceName_11, char DeviceName_12 ).
When using inline(<size>) on the pointer type the struct will contain <size> bytes, and the pointer will become a pointer to that field:
domains mark = mark( integer Position, pointer Data [inline(8)] ).
Data is pointer to 8 inlined bytes The struct have the same layout as:
domains mark2 = mark2( integer Position, byte Data_1, byte Data_2, byte Data_3, byte Data_4, byte Data_5, byte Data_6, byte Data_7, byte Data_8 ).
And Data will point to Data_1.
A declaration which has special meaning and handling in the compiler (semi-built-in).
Used to prevent a predicate from having optional output parameters (see Optional parameters).
predicates ppp : (integer X [out]) [mandatoryOut]. % The output parameter is mandatory
Used for a class to indicate that it should not have an implicit default constructor, and can thus be used to a class that does not have any public constructors at all. Valid for an object creating class declaration.
class classWithoutPublicConstructors : myInterface open core [noDefaultConstructor] ... end class classWithoutPublicConstructors
The argument is an output argument. Valid for a formal predicate argument.
predicates pred : (string OutputArg [out]).
The [pack(n)] attribute (where n is a number) instructs the compiler to use n as packing size for a functor domains. By default the packing size is 4 in 32 bit programs and 8 in 64 bit programs. This attribute is mainly intended for compatibility with C/C++ api's.
domains packed = packed(integer8, pointer) [pack(2)].
The attribute can used on a class declaration to cover all domains in that class.
class richEdit_native open core, gui_native [pack(4)] % pack all domains with packing size 4 end class richEdit_native
Used for a predicate or constructor declaration to indicate that it recieves an extra input argument which describes the place in a program (program point) where this predicate was called. This additional argument has programPoint type which is declared in the PFC core class like:
domains programPoint = programPoint(hScopeDescriptor ClassDescriptor, string PredicateName, sourceCursor Cursor).
The clause name of such predicate or constructor should have suffix "_explicit". Valid for a predicate or constructor declaration.
predicates pred : (string String) [programPoint]. clauses pred_explicit(ProgramPoint, String) :- ...
Used to specify the presenter of a domain.
domains someDomain = ... [presenter(presenter_someDomain)].
Also used without argument to specify that an interface has a presenter.
interface something [presenter] ... end interface something
The declared entity is retired. The string literal describes how to migrate from it. The entity does not exist anymore.
predicates veryOldFashioned : (string Arg) [retired("Use newFashion instead")].
Functor alternatives can be retired.
domains ppp = fct(integer A, real B, ddd C) [retiredFunctor(aaa::fct_ppp)]; fct2(integer A, ddd C, integer* New).
aaa::fct_ppp must be a predicate with this type (it can be an anonymous predicate):
predicates fct_ppp : (integer A, real B, ddd C) -> ppp NewValue.
I.e. it takes the arguments of the old functor and returns a value in the functor domain.
In the program fct is does not exist at all, it is retired. But in the deserialization fct terms can still be handled: The arguments are parsed according to the types, and then the value is created by invoking aaa::fct_ppp.
This method will also work for binary serializations, provided:
- The old domain had more than one alternative (so there are functor numbers in the serialization)
- New alternatives are added last (to retain functor numbers)
It is however not recommend using binary serialization for inter-session persistence.
See also Functor Domain Versioning.
Used for an interface to indicate that it cannot be supported by any other interface. This allows to create more efficient codes, because the compiler provides some optimization when using the objects of such type. Valid for an object creating class declaration as a construction interface.
interface myInterface [sealed] ... end interface myInterface class myClass : myInterface ... end class myClass
Used for declaring extension predicates.
class predicates extension : (unsigned V [this]).
Used for creating functor domains with several alternatives but no real functors. This should only be used to mimic C/C++ union structs in low-level interfacing. Valid for functor domain with several alternatives and alignment.
domains u64var = align 4 u64(unsigned64 Value64); u64_struct(unsigned Low32, unsigned High32) [union].
An unused local member can be marked used to prevent the compiler to issue a warning and remove the corresponding code. Valid for members.
predicates seeminglyUnused : () [used].