jpl.fli

Class Prolog

java.lang.Object

jpl.fli.Prolog

public final class Prolog
extends Object

This class consists only of constants (static finals) and static native methods. The constants and methods defined herein are in (almost) strict 1-1 correpsondence with the functions in the Prolog FLI by the same name (except without the PL_, SQ_, etc. prefixes).

See the file jpl_fli_Prolog.c for the native implementations of these methods. Refer to your local Prolog FLI documentations for the meanings of these methods, and observe the following:

The types and signatures of the following methods are almost in 1-1 correspondence with the Prolog FLI. The Prolog types term_t, atom_t, functor_t, etc. are mirrored in this package with classes by the same name, making the C and java uses of these interfaces similar.

As term_t, functor_t, etc. types are Java classes, they are passed to these methods by vlaue; however, calling these methods on such class instances does have side effects. In general, the value fields of these instances will be modified, in much the same way the term_t, functor_t, etc. Prolog instances would be modified.

The exceptions to this rule occur when maintaining the same signature would be impossible, e.g., when the Prolog FLI functions require pointers; in this case, the signatures have been modified to take *Holder classes (Int, Double, String, etc.), to indicate a call by reference parameter.

Functions which take variable-length argument lists in C take arrays in Java; however, due to the fact that Java does not support variable length argument lists, these methods currently have an upper bound of 5 arguments. Sorry about that.

Copyright (C) 1998 Fred Dushin

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library Public License for more details.

Version:

$Revision: 1.1.1.1 $

Author:

Fred Dushin

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATOM
static int	BUF_DISCARDABLE
static int	BUF_MALLOC
static int	BUF_RING
static int	CHARS
static int	CVT_ALL
static int	CVT_ATOM
static int	CVT_ATOMIC
static int	CVT_FLOAT
static int	CVT_INTEGER
static int	CVT_NUMBER
static int	CVT_STRING
static int	CVT_VARIABLE
static int	fail
static int	FLOAT
static int	FUNCTOR
static int	INTEGER
static int	LIST
static int	POINTER
static int	Q_CATCH_EXCEPTION
static int	Q_NODEBUG
static int	Q_NORMAL
static int	Q_PASS_EXCEPTION
static int	STRING
static int	succeed
static int	TERM
static int	VARIABLE
static int	VT_LIST

Constructor Summary

Constructors

Constructor and Description
Prolog()

Method Summary

Modifier and Type	Method and Description
static String	atom_chars(atom_t a)
static int	call_predicate(module_t m, int debug, predicate_t pred, term_t t0)
static int	call(term_t t, module_t m)
static void	close_foreign_frame(fid_t cid)
static void	close_query(qid_t qid)
static void	cons_functor_v(term_t h, functor_t fd, term_t a0)
protected static void	cons_functor(term_t h, functor_t f, term_t[] terms)
static void	cons_list(term_t l, term_t h, term_t t)
static module_t	context()
static term_t	copy_term_ref(term_t from)
static void	cut_query(qid_t qid)
static void	discard_foreign_frame(fid_t cid)
static term_t	exception(qid_t qid)
static int	functor_arity(functor_t f)
static atom_t	functor_name(functor_t f)
static int	get_arg(int index, term_t t, term_t a)
static int	get_atom_chars(term_t t, StringHolder a)
static int	get_atom(term_t t, atom_t a)
static int	get_chars(term_t t, StringHolder s, int flags)
static int	get_float(term_t t, DoubleHolder d)
static int	get_functor(term_t t, functor_t f)
static int	get_head(term_t l, term_t h)
static int	get_integer(term_t t, IntHolder i)
static int	get_list_chars(term_t l, StringHolder s, int flags)
static int	get_list(term_t l, term_t h, term_t t)
static int	get_long(term_t t, LongHolder l)
static int	get_module(term_t t, module_t module)
static int	get_name_arity(term_t t, atom_t name, IntHolder arity)
static int	get_nil(term_t l)
static int	get_pointer(term_t t, PointerHolder ptr)
static int	get_string(term_t t, StringHolder s)
static int	get_tail(term_t l, term_t t)
static void	halt(int status)
static int	initialise(int argc, String[] argv)
static int	is_atom(term_t t)
static int	is_atomic(term_t t)
static int	is_compound(term_t t)
static int	is_float(term_t t)
static int	is_functor(term_t t, functor_t f)
static int	is_integer(term_t t)
static int	is_list(term_t t)
static int	is_number(term_t t)
static int	is_string(term_t t)
static int	is_variable(term_t t)
static void	main(String[] argv)
static atom_t	module_name(module_t module)
static atom_t	new_atom(String s)
static functor_t	new_functor(atom_t f, int a)
static module_t	new_module(atom_t name)
static term_t	new_term_ref()
static term_t	new_term_refs(int n)
static int	next_solution(qid_t qid)
static fid_t	open_foreign_frame()
static qid_t	open_query(module_t m, int flags, predicate_t pred, term_t t0)
static predicate_t	pred(functor_t f, module_t m)
static int	predicate_info(predicate_t pred, atom_t name, IntHolder arity, module_t module)
static predicate_t	predicate(String name, int arity, String module)
static void	put_atom_chars(term_t t, String chars)
static void	put_atom(term_t t, atom_t a)
static void	put_float(term_t t, double f)
static void	put_functor(term_t t, functor_t functor)
static void	put_integer(term_t t, long i)
static void	put_list_chars(term_t t, String chars)
static void	put_list(term_t l)
static void	put_nil(term_t l)
static void	put_pointer(term_t t, PointerHolder ptr)
static void	put_string_chars(term_t t, String chars)
static void	put_term(term_t t1, term_t t2)
static void	put_variable(term_t t)
static void	reset_term_refs(term_t r)
static int	strip_module(term_t in, module_t m, term_t out)
static int	term_type(term_t t)
static int	unify(term_t t1, term_t t2)

Methods inherited from class java.lang.Object

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

Field Detail

VARIABLE

public static final int VARIABLE

See Also:

Constant Field Values

ATOM

public static final int ATOM

See Also:

Constant Field Values

INTEGER

public static final int INTEGER

See Also:

Constant Field Values

FLOAT

public static final int FLOAT

See Also:

Constant Field Values

STRING

public static final int STRING

See Also:

Constant Field Values

TERM

public static final int TERM

See Also:

Constant Field Values

FUNCTOR

public static final int FUNCTOR

See Also:

Constant Field Values

LIST

public static final int LIST

See Also:

Constant Field Values

CHARS

public static final int CHARS

See Also:

Constant Field Values

POINTER

public static final int POINTER

See Also:

Constant Field Values

succeed

public static final int succeed

See Also:

Constant Field Values

fail

public static final int fail

See Also:

Constant Field Values

Q_NORMAL

public static final int Q_NORMAL

See Also:

Constant Field Values

Q_NODEBUG

public static final int Q_NODEBUG

See Also:

Constant Field Values

Q_CATCH_EXCEPTION

public static final int Q_CATCH_EXCEPTION

See Also:

Constant Field Values

Q_PASS_EXCEPTION

public static final int Q_PASS_EXCEPTION

See Also:

Constant Field Values

CVT_ATOM

public static final int CVT_ATOM

See Also:

Constant Field Values

CVT_STRING

public static final int CVT_STRING

See Also:

Constant Field Values

VT_LIST

public static final int VT_LIST

See Also:

Constant Field Values

CVT_INTEGER

public static final int CVT_INTEGER

See Also:

Constant Field Values

CVT_FLOAT

public static final int CVT_FLOAT

See Also:

Constant Field Values

CVT_VARIABLE

public static final int CVT_VARIABLE

See Also:

Constant Field Values

CVT_NUMBER

public static final int CVT_NUMBER

See Also:

Constant Field Values

CVT_ATOMIC

public static final int CVT_ATOMIC

See Also:

Constant Field Values

CVT_ALL

public static final int CVT_ALL

See Also:

Constant Field Values

BUF_DISCARDABLE

public static final int BUF_DISCARDABLE

See Also:

Constant Field Values

BUF_RING

public static final int BUF_RING

See Also:

Constant Field Values

BUF_MALLOC

public static final int BUF_MALLOC

See Also:

Constant Field Values

Constructor Detail

Prolog

public Prolog()

Method Detail

new_term_refs

public static term_t new_term_refs(int n)

new_term_ref

public static term_t new_term_ref()

copy_term_ref

public static term_t copy_term_ref(term_t from)

reset_term_refs

public static void reset_term_refs(term_t r)

new_atom

public static atom_t new_atom(String s)

atom_chars

public static String atom_chars(atom_t a)

new_functor

public static functor_t new_functor(atom_t f,
                                    int a)

functor_name

public static atom_t functor_name(functor_t f)

functor_arity

public static int functor_arity(functor_t f)

get_atom

public static int get_atom(term_t t,
                           atom_t a)

get_atom_chars

public static int get_atom_chars(term_t t,
                                 StringHolder a)

get_string

public static int get_string(term_t t,
                             StringHolder s)

get_list_chars

public static int get_list_chars(term_t l,
                                 StringHolder s,
                                 int flags)

get_chars

public static int get_chars(term_t t,
                            StringHolder s,
                            int flags)

get_integer

public static int get_integer(term_t t,
                              IntHolder i)

get_long

public static int get_long(term_t t,
                           LongHolder l)

get_pointer

public static int get_pointer(term_t t,
                              PointerHolder ptr)

get_float

public static int get_float(term_t t,
                            DoubleHolder d)

get_functor

public static int get_functor(term_t t,
                              functor_t f)

get_name_arity

public static int get_name_arity(term_t t,
                                 atom_t name,
                                 IntHolder arity)

get_module

public static int get_module(term_t t,
                             module_t module)

get_arg

public static int get_arg(int index,
                          term_t t,
                          term_t a)

get_list

public static int get_list(term_t l,
                           term_t h,
                           term_t t)

get_head

public static int get_head(term_t l,
                           term_t h)

get_tail

public static int get_tail(term_t l,
                           term_t t)

get_nil

public static int get_nil(term_t l)

term_type

public static int term_type(term_t t)

is_variable

public static int is_variable(term_t t)

is_atom

public static int is_atom(term_t t)

is_integer

public static int is_integer(term_t t)

is_string

public static int is_string(term_t t)

is_float

public static int is_float(term_t t)

is_compound

public static int is_compound(term_t t)

is_functor

public static int is_functor(term_t t,
                             functor_t f)

is_list

public static int is_list(term_t t)

is_atomic

public static int is_atomic(term_t t)

is_number

public static int is_number(term_t t)

put_variable

public static void put_variable(term_t t)

put_atom

public static void put_atom(term_t t,
                            atom_t a)

put_atom_chars

public static void put_atom_chars(term_t t,
                                  String chars)

put_string_chars

public static void put_string_chars(term_t t,
                                    String chars)

put_list_chars

public static void put_list_chars(term_t t,
                                  String chars)

put_integer

public static void put_integer(term_t t,
                               long i)

put_pointer

public static void put_pointer(term_t t,
                               PointerHolder ptr)

put_float

public static void put_float(term_t t,
                             double f)

put_functor

public static void put_functor(term_t t,
                               functor_t functor)

put_list

public static void put_list(term_t l)

put_nil

public static void put_nil(term_t l)

put_term

public static void put_term(term_t t1,
                            term_t t2)

cons_functor

protected static void cons_functor(term_t h,
                                   functor_t f,
                                   term_t[] terms)

cons_functor_v

public static void cons_functor_v(term_t h,
                                  functor_t fd,
                                  term_t a0)

cons_list

public static void cons_list(term_t l,
                             term_t h,
                             term_t t)

unify

public static int unify(term_t t1,
                        term_t t2)

context

public static module_t context()

module_name

public static atom_t module_name(module_t module)

new_module

public static module_t new_module(atom_t name)

strip_module

public static int strip_module(term_t in,
                               module_t m,
                               term_t out)

open_foreign_frame

public static fid_t open_foreign_frame()

close_foreign_frame

public static void close_foreign_frame(fid_t cid)

discard_foreign_frame

public static void discard_foreign_frame(fid_t cid)

pred

public static predicate_t pred(functor_t f,
                               module_t m)

predicate

public static predicate_t predicate(String name,
                                    int arity,
                                    String module)

predicate_info

public static int predicate_info(predicate_t pred,
                                 atom_t name,
                                 IntHolder arity,
                                 module_t module)

open_query

public static qid_t open_query(module_t m,
                               int flags,
                               predicate_t pred,
                               term_t t0)

next_solution

public static int next_solution(qid_t qid)

close_query

public static void close_query(qid_t qid)

cut_query

public static void cut_query(qid_t qid)

call

public static int call(term_t t,
                       module_t m)

call_predicate

public static int call_predicate(module_t m,
                                 int debug,
                                 predicate_t pred,
                                 term_t t0)

exception

public static term_t exception(qid_t qid)

initialise

public static int initialise(int argc,
                             String[] argv)

halt

public static void halt(int status)

main

public static void main(String[] argv)