All Known Implementing Classes:: AProgram

public interface Program

A prolog program.

Conceptually, a set of clauses keyed by name (cf. clauses()).

Supports various interrogation methods useful for static source or style checks.

Also provides various static utility methods for processing streams of Relations.

Method Summary

Modifier and Type	Method	Description
`default List<Integer>`	`arity(String name)`	The arities of all clauses with a given name
`Map<String,List<Relation>>`	`clauses()`	The program's clauses.
`default boolean`	`containsRecursive(String name)`	True iff any of the clauses named `name` contains an invocation to a recurisive clause.
`default int`	`depth(String name)`	The "depth" of a named clause.
`static Stream<RuleInvocation>`	`invocations(Stream<Relation> relations)`	All the `RuleInvocation`s on the right-hand-side of the `Rule`s in the stream of `Relation`s
`default boolean`	`isRecursive(String name)`	True iff any of the clauses named `name` directly contains an invocation of itself.
`default List<String>`	`names()`	The names of all clauses
`default boolean`	`noMagicNumbers()`	True iff the program contains no magic numbers
`default Stream<Relation>`	`relations()`	All the `Relation`s in the program
`default List<Relation>`	`relationsWithComments()`	All `Relation`s that have comments.
`static Stream<Rule>`	`rules(Stream<Relation> relations)`	Only the `Rule`s in the stream of `Relation`s
`default List<RuleInvocation>`	`undefined()`	A collection of `RuleInvocation`s of rules not defined anywhere in the program.

Method Details
- clauses
  
  Map<String,List<Relation>> clauses()
  
  The program's clauses.
  A clause is identified by name; since prolog clauses support overloading by arity, each clause gives a list of possible Relations.
- arity
  
  default List<Integer> arity(String name)
  
  The arities of all clauses with a given name
- names
  
  default List<String> names()
  
  The names of all clauses
- relationsWithComments
  
  default List<Relation> relationsWithComments()
  
  All Relations that have comments.
  
  See Also:
  
  Relation.comment()
- isRecursive
  
  default boolean isRecursive(String name)
  
  True iff any of the clauses named name directly contains an invocation of itself.
  
  See Also:
  
  RuleInvocation.isInvocationOf(edu.unc.cs.comp524.parsers.prolog.Relation), containsRecursive(java.lang.String)
- containsRecursive
  
  default boolean containsRecursive(String name)
  
  True iff any of the clauses named name contains an invocation to a recurisive clause.
  
  See Also:
  
  isRecursive(java.lang.String)
- undefined
  
  default List<RuleInvocation> undefined()
  
  A collection of RuleInvocations of rules not defined anywhere in the program.
  This can be useful when looking at what "standard" library functions were called, or disallowing them altogether.
- depth
  
  default int depth(String name)
  
  The "depth" of a named clause.
  Implementations are free to define depth in any way.
  The default implementation defines it thusly: the depth is an integer counting how many subrules are invoked until the tree "bottoms out" by invoking a fact with no subrules. Once a subrule is counted as invoked, other invocations of that subrule are ignored (to circumvent infinite loops in the case of recursion, mutual or otherwise) in that particular "path."
  The actual depth is the maximum of all possible depths.
  This is a stand-in measure for things like cyclomatic complexity and maximum runtime-depth, the latter of which cannot be computed statically (cf. Turing's Halting problem).
- noMagicNumbers
  
  default boolean noMagicNumbers()
  
  True iff the program contains no magic numbers
  The default implementation defines that as "no rules have numeric literals that are not 0, 1, or 2; facts are permitted and encouraged to capture needed numeric constants."
- rules
  
  static Stream<Rule> rules(Stream<Relation> relations)
  
  Only the Rules in the stream of Relations
- invocations
  
  static Stream<RuleInvocation> invocations(Stream<Relation> relations)
  
  All the RuleInvocations on the right-hand-side of the Rules in the stream of Relations
  
  See Also:
  
  Rule.rhs()
- relations
  
  default Stream<Relation> relations()
  
  All the Relations in the program

Interface Program

Method Summary

Method Details