category
code_metrics_utilities
¶
Internal predicates for analyzing source code.
static
(no dependencies on other entities)
Public interface¶
(none)
Protected interface¶
(none)
Private predicates¶
ancestor/4
¶
True if Entity descends from Ancestor, and EntityKind and AncestorKind unify with their respective entity types.
static
ancestor(EntityKind,Entity,AncestorKind,Ancestor)
ancestor(?entity,?entity_identifier,?entity,?entity_identifier)
- zero_or_more
current_entity/1
¶
True if Entity is a currently loaded entity.
static
current_entity(Entity)
current_entity(?entity_identifier)
- zero_or_more
declares_predicate/2
¶
True if Entity declares Predicate internally.
static
declares_predicate(Entity,Predicate)
declares_predicate(?entity_identifier,?predicate_indicator)
- zero_or_more
defines_predicate/2
¶
True if Entity defines an implementation of Predicate internally. ‘Auxiliary’ predicates are excluded from results.
static
defines_predicate(Entity,Predicate)
defines_predicate(?entity_identifier,?predicate_indicator)
- zero_or_more
defines_predicate/3
¶
Same as defines_predicate/2, except Property is unified with a corresponding property defined in the grammar.
static
defines_predicate(Entity,Predicate,Property)
defines_predicate(?entity_identifier,?predicate_indicator,?term)
- zero_or_more
entity_calls/3
¶
True if a predicate Caller within Entity makes a Call.
static
entity_calls(Entity,Caller,Call)
entity_calls(?entity_identifier,?predicate_indicator,?predicate_indicator)
- zero_or_one
entity_kind/2
¶
True if Kind defines Entity and is one of category, protocol, or object.
static
entity_kind(Entity,Kind)
entity_kind(+entity_identifier,-entity)
- zero_or_one
entity_property/2
¶
True if Property is a valid property of Entity. Entity can be either a category, a protocol, or an object.
static
entity_property(Entity,Property)
entity_property(+entity_identifier,-term)
- zero_or_more
entity_updates/3
¶
True if a predicate Updater within Entity makes a dynamic update to Update (by e.g. asserta/1, retract/1, etc.)
static
entity_updates(Entity,Updater,Update)
entity_updates(+entity_identifier,?predicate_indicator,?predicate_indicator)
- zero_or_one
Operators¶
(none)
Remarks¶
- Usage: This is meant to be imported by any metric added to the system.
- Predicate Scope: This is meant for internal use by metrics only. As such, all provided predicates are private.