jTrolog.lib

Class BuiltIn

java.lang.Object

jTrolog.lib.Library

jTrolog.lib.BuiltIn

All Implemented Interfaces:

Serializable

public class BuiltIn
extends Library

Library of built-in predicates

Author:

Alex Benini, janerist@stud.ntnu.no, ivar.orstavik@hist.no

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BuiltIn(Prolog mediator)

Method Summary

Modifier and Type	Method and Description
boolean	$debug_1(BindingsTable bt, Term arg0)
boolean	$debug_3(BindingsTable bt, Term arg0, Term arg2, Term arg3)
boolean	$domain_error_zero_1(BindingsTable bt, Term term)
boolean	$find_2(BindingsTable bt, Struct arg0, Term arg1)
boolean	$instantiation_error_0(BindingsTable bt)
boolean	$representation_error_1(BindingsTable bt, Term maxArity)
boolean	$retract_1(BindingsTable bt, Struct arg0)
boolean	$type_error_2(BindingsTable bt, Term typeName, Term term)
boolean	abolish_1(BindingsTable bt, Struct predicateIndicator) see 8.9.4 p.81 in ISO standard
boolean	asserta_1(BindingsTable bt, Term arg0)
boolean	assertz_1(BindingsTable bt, Term arg0)
static boolean	call_1(BindingsTable bt, Term arg1)
boolean	comma_2(BindingsTable bt, Term arg0, Term arg1) Primitives
void	consult_1(BindingsTable bt, Term theory)
static Clause	convertTermToClause(Term arg0) see ISO 7.6.1 and 7.6.2
static Struct	convertTermToClauseBody(Term body)
static Struct[]	convertTermToClauseBody2(Term body)
boolean	copy_2(BindingsTable bt, Term arg0, Term arg1)
static boolean	cut_0(BindingsTable bt)
boolean	deunify_2(BindingsTable bt, Term arg0, Term arg1)
boolean	dynamic_1(BindingsTable bt, Struct predicateIndicator) Registers the existence predicate indicator in the dynamic data base.
static boolean	fail_0(BindingsTable bt)
void	flag_4(BindingsTable bt, Term flagName, Struct flagSet, Term flagDefault, Term flagModifiable)
boolean	flag_list_1(BindingsTable bt, Term arg0)
boolean	get_prolog_flag_2(BindingsTable bt, Term arg0, Term arg1)
String[]	getSynonym(String primitive) Defines a map for synonyms for primitives.
static boolean	halt_0(BindingsTable bt)
boolean	halt_1(BindingsTable bt, Number arg0)
static String	isPredicateIndicator(Struct predicateIndicator, BindingsTable bt)
boolean	load_library_1(BindingsTable bt, Struct arg0)
void	load_library_1(BindingsTable bt, Term lib)
boolean	newlist_2(BindingsTable bt, Int length, Var out)
void	op_3(BindingsTable bt, Number arg0, StructAtom arg1, StructAtom arg2) op(+Precedence, +Type, +Name) defines a new operator if precedence not in 0..1200 = delete currently present op
boolean	set_prolog_flag_2(BindingsTable bt, Term arg0, Term arg1)
void	solve_1(BindingsTable bt, Struct goal)
static boolean	true_0(BindingsTable bt)
boolean	unify_2(BindingsTable bt, Term arg0, Term arg1)
boolean	unload_library_1(BindingsTable bt, Struct arg0) unloads a engine library, given its java class name

Methods inherited from class jTrolog.lib.Library

dismiss, getName, getTheory, onSolveBegin, onSolveEnd, setEngine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuiltIn

public BuiltIn(Prolog mediator)

Method Detail

getSynonym

public String[] getSynonym(String primitive)

Defines a map for synonyms for primitives. String primitive name = String[]{synonym name, another synonym name, ..}.

Overrides:

getSynonym in class Library

comma_2

public boolean comma_2(BindingsTable bt,
                       Term arg0,
                       Term arg1)

Primitives

cut_0

public static boolean cut_0(BindingsTable bt)

fail_0

public static boolean fail_0(BindingsTable bt)

true_0

public static boolean true_0(BindingsTable bt)

call_1

public static boolean call_1(BindingsTable bt,
                             Term arg1)

halt_0

public static boolean halt_0(BindingsTable bt)
                      throws PrologException

Throws:

PrologException

halt_1

public boolean halt_1(BindingsTable bt,
                      Number arg0)
               throws PrologException

Throws:

PrologException

$debug_1

public boolean $debug_1(BindingsTable bt,
                        Term arg0)

$debug_3

public boolean $debug_3(BindingsTable bt,
                        Term arg0,
                        Term arg2,
                        Term arg3)

asserta_1

public boolean asserta_1(BindingsTable bt,
                         Term arg0)
                  throws PrologException

Throws:

PrologException

assertz_1

public boolean assertz_1(BindingsTable bt,
                         Term arg0)
                  throws PrologException

Throws:

PrologException

$retract_1

public boolean $retract_1(BindingsTable bt,
                          Struct arg0)
                   throws PrologException

Throws:

PrologException

abolish_1

public boolean abolish_1(BindingsTable bt,
                         Struct predicateIndicator)
                  throws PrologException

see 8.9.4 p.81 in ISO standard

Parameters:

predicateIndicator -

Returns:

true

Throws:

PrologException - in case of errors

dynamic_1

public boolean dynamic_1(BindingsTable bt,
                         Struct predicateIndicator)
                  throws PrologException

Registers the existence predicate indicator in the dynamic data base. If such a predicate is later requested, but none exists, the search will not throw an error, but return false. see ISO spec on abolish for details on errors.

Parameters:

predicateIndicator -

Returns:

true

Throws:

PrologException - in case of bad input

load_library_1

public boolean load_library_1(BindingsTable bt,
                              Struct arg0)
                       throws InvalidLibraryException

Throws:

InvalidLibraryException

unload_library_1

public boolean unload_library_1(BindingsTable bt,
                                Struct arg0)
                         throws InvalidLibraryException

unloads a engine library, given its java class name

Throws:

InvalidLibraryException

flag_list_1

public boolean flag_list_1(BindingsTable bt,
                           Term arg0)

unify_2

public boolean unify_2(BindingsTable bt,
                       Term arg0,
                       Term arg1)

deunify_2

public boolean deunify_2(BindingsTable bt,
                         Term arg0,
                         Term arg1)

newlist_2

public boolean newlist_2(BindingsTable bt,
                         Int length,
                         Var out)
                  throws PrologException

Throws:

PrologException

copy_2

public boolean copy_2(BindingsTable bt,
                      Term arg0,
                      Term arg1)

$find_2

public boolean $find_2(BindingsTable bt,
                       Struct arg0,
                       Term arg1)
                throws PrologException,
                       CloneNotSupportedException

Throws:

PrologException

CloneNotSupportedException

set_prolog_flag_2

public boolean set_prolog_flag_2(BindingsTable bt,
                                 Term arg0,
                                 Term arg1)

get_prolog_flag_2

public boolean get_prolog_flag_2(BindingsTable bt,
                                 Term arg0,
                                 Term arg1)

op_3

public void op_3(BindingsTable bt,
                 Number arg0,
                 StructAtom arg1,
                 StructAtom arg2)

op(+Precedence, +Type, +Name) defines a new operator if precedence not in 0..1200 = delete currently present op

flag_4

public void flag_4(BindingsTable bt,
                   Term flagName,
                   Struct flagSet,
                   Term flagDefault,
                   Term flagModifiable)

solve_1

public void solve_1(BindingsTable bt,
                    Struct goal)
             throws Throwable

Throws:

Throwable

load_library_1

public void load_library_1(BindingsTable bt,
                           Term lib)
                    throws InvalidLibraryException

Throws:

InvalidLibraryException

consult_1

public void consult_1(BindingsTable bt,
                      Term theory)
               throws FileNotFoundException,
                      PrologException,
                      IOException

Throws:

FileNotFoundException

PrologException

IOException

$instantiation_error_0

public boolean $instantiation_error_0(BindingsTable bt)
                               throws PrologException

Throws:

PrologException

$type_error_2

public boolean $type_error_2(BindingsTable bt,
                             Term typeName,
                             Term term)
                      throws PrologException

Throws:

PrologException

$representation_error_1

public boolean $representation_error_1(BindingsTable bt,
                                       Term maxArity)
                                throws PrologException

Throws:

PrologException

$domain_error_zero_1

public boolean $domain_error_zero_1(BindingsTable bt,
                                    Term term)
                             throws Exception

Throws:

Exception

convertTermToClause

public static Clause convertTermToClause(Term arg0)
                                  throws PrologException

see ISO 7.6.1 and 7.6.2

Parameters:

arg0 -

Returns:

Throws:

PrologException

convertTermToClauseBody2

public static Struct[] convertTermToClauseBody2(Term body)
                                         throws PrologException

Throws:

PrologException

convertTermToClauseBody

public static Struct convertTermToClauseBody(Term body)
                                      throws PrologException

Throws:

PrologException

isPredicateIndicator

public static String isPredicateIndicator(Struct predicateIndicator,
                                          BindingsTable bt)
                                   throws PrologException

Throws:

PrologException