//tabstop=4 //*****************************************************************************/ // Project: jpl // // File: $Id: Prolog.java,v 1.1 2004-08-27 20:27:56 vsc Exp $ // Date: $Date: 2004-08-27 20:27:56 $ // Author: Fred Dushin // // // Description: // // // ------------------------------------------------------------------------- // Copyright (c) 1998 Fred Dushin // All rights reserved. // // 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. //*****************************************************************************/ package jpl.fli; //----------------------------------------------------------------------/ // Prolog /** * This class consists only of constants (static finals) and static * native methods. The constants and methods defined herein are in * (almost) strict 1-1 correspondence 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 value; 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; from Java 1.1 onwards, anonymous arrays * can be used e.g. Term[] { new Atom("a"), new Atom ("b") } *
    • * *
    * 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.

    *

    * @author Fred Dushin * @version $Revision: 1.1 $ */ public final class Prolog { static { System.loadLibrary("jpl"); } /* term types */ public static final int VARIABLE = 1; public static final int ATOM = 2; public static final int INTEGER = 3; public static final int FLOAT = 4; public static final int STRING = 5; public static final int COMPOUND = 6; public static final int JBOOLEAN = 101; public static final int JREF = 102; public static final int JVOID = 103; /** * @deprecated use Prolog.COMPOUND */ public static final int TERM = 6; public static final int succeed = 1; public static final int fail = 0; /* query flags */ public static final int Q_NORMAL = 0x02; public static final int Q_NODEBUG = 0x04; public static final int Q_CATCH_EXCEPTION = 0x08; public static final int Q_PASS_EXCEPTION = 0x10; /* conversion flags */ public static final int CVT_ATOM = 0x0001; public static final int CVT_STRING = 0x0002; public static final int CVT_LIST = 0x0004; public static final int CVT_INTEGER = 0x0008; public static final int CVT_FLOAT = 0x0010; public static final int CVT_VARIABLE = 0x0020; public static final int CVT_NUMBER = (CVT_INTEGER | CVT_FLOAT); public static final int CVT_ATOMIC = (CVT_NUMBER | CVT_ATOM | CVT_STRING); public static final int CVT_ALL = 0x00ff; public static final int BUF_DISCARDABLE = 0x0000; public static final int BUF_RING = 0x0100; public static final int BUF_MALLOC = 0x0200; /* new, for revised term_t-to-Variable stuff */ public static native int compare(term_t t1, term_t t2); // returns -1, 0 or 1 /* Creating and destroying term-refs */ public static native term_t new_term_ref(); public static native term_t new_term_refs(int n); public static native term_t copy_term_ref(term_t from); public static native void reset_term_refs(term_t r); /* Constants */ public static native atom_t new_atom(String s); public static native String atom_chars(atom_t a); public static native functor_t new_functor(atom_t f, int a); public static native atom_t functor_name(functor_t f); public static native int functor_arity(functor_t f); public static native void unregister_atom(atom_t a); // called from atom_t's finalize() /* Get Java-values from Prolog terms */ public static native boolean get_atom(term_t t, atom_t a); public static native boolean get_atom_chars(term_t t, StringHolder a); public static native boolean get_string_chars(term_t t, StringHolder s); public static native boolean get_integer(term_t t, IntHolder i); public static native boolean get_pointer(term_t t, PointerHolder ptr); public static native boolean get_float(term_t t, DoubleHolder d); public static native boolean get_functor(term_t t, functor_t f); public static native boolean get_name_arity(term_t t, StringHolder name, IntHolder arity); public static native boolean get_module(term_t t, module_t module); public static native boolean get_arg(int index, term_t t, term_t a); public static native boolean get_jref(term_t t, ObjectHolder obj); public static native boolean get_jboolean(term_t t, BooleanHolder b); /* Verify types */ public static native int term_type(term_t t); public static native boolean is_variable(term_t t); public static native boolean is_atom(term_t t); public static native boolean is_integer(term_t t); public static native boolean is_float(term_t t); public static native boolean is_compound(term_t t); public static native boolean is_functor(term_t t, functor_t f); public static native boolean is_atomic(term_t t); public static native boolean is_number(term_t t); /* Assign to term-references */ public static native void put_variable(term_t t); public static native void put_atom(term_t t, atom_t a); public static native void put_integer(term_t t, long i); public static native void put_pointer(term_t t, PointerHolder ptr); public static native void put_float(term_t t, double f); public static native void put_functor(term_t t, functor_t functor); public static native void put_term(term_t t1, term_t t2); public static native void put_jref(term_t t, Object ref); public static native void put_jboolean(term_t t, boolean b); public static native void put_jvoid(term_t t); /* ... */ public static native void cons_functor_v(term_t h, functor_t fd, term_t a0); public static native void cons_list(term_t l, term_t h, term_t t); // unification: // public static native int unify(term_t t1, term_t t2); // predicates: public static native predicate_t pred(functor_t f, module_t m); public static native predicate_t predicate(String name, int arity, String module); public static native int predicate_info(predicate_t pred, atom_t name, IntHolder arity, module_t module); // querying (general): public static native qid_t open_query(module_t m, int flags, predicate_t pred, term_t t0); public static native boolean next_solution(qid_t qid); public static native void close_query(qid_t qid); public static native void cut_query(qid_t qid); // querying (simplified): public static native boolean call(term_t t, module_t m); public static native boolean call_predicate(module_t m, int debug, predicate_t pred, term_t t0); // foreign frames: public static native fid_t open_foreign_frame(); public static native void close_foreign_frame(fid_t cid); public static native void discard_foreign_frame(fid_t cid); // modules: public static native module_t context(); public static native atom_t module_name(module_t module); public static native module_t new_module(atom_t name); public static native int strip_module(term_t in, module_t m, term_t out); // not yet mapped: raise_exception() // not yet mapped: throw() // exceptions: public static native term_t exception(qid_t qid); // initialisation: public static native String[] get_default_init_args(); public static native boolean set_default_init_args(String argv[]); public static native boolean initialise(); public static native String[] get_actual_init_args(); public static native void halt(int status); // thread & engine management: public static native int thread_self(); public static native engine_t attach_pool_engine(); public static native int release_pool_engine(); public static native engine_t current_engine(); public static native boolean current_engine_is_pool(); public static native String get_c_lib_version(); public static native int action_abort(); public static native int attach_engine(engine_t e); public static native int pool_engine_id(engine_t e); } //345678901234567890123456789012346578901234567890123456789012345678901234567890