YAP Development release
This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Vítor Santos Costa 28de20262f initialise *all* threads.
support SWI buffers.
2010-08-04 11:35:30 +01:00
BEAM support for passing priority as argument to write. (Ulrich's #45). 2009-05-22 13:24:27 -05:00
C initialise *all* threads. 2010-08-04 11:35:30 +01:00
console allow -F to be ignored. 2010-06-17 00:34:57 +01:00
CVSROOT * configured to use syncmail to send mail notification of commits to 2001-06-08 18:10:32 +00:00
docs fix documentation 2010-08-03 12:58:19 +01:00
GPL allow people to use ctypes.pl 2010-07-19 14:53:00 +01:00
H implement access_file/2 in C 2010-08-03 21:04:16 +01:00
include expand C-interface to allow access to common term operations (request from Ingo Molnar). 2010-08-02 19:48:17 +01:00
LGPL support for date.pl 2010-07-29 00:22:08 +01:00
library improvements in SWI emulation, especially for text. 2010-08-04 02:46:26 +01:00
misc implement access_file/2 in C 2010-08-03 21:04:16 +01:00
MYDDAS fix 64 bit warnings 2010-06-17 00:32:25 +01:00
OPTYap fix interface with Thor 2010-07-28 17:14:29 +01:00
packages improvements in SWI emulation, especially for text. 2010-08-04 02:46:26 +01:00
pl implement access_file/2 in C 2010-08-03 21:04:16 +01:00
VC renaming some OPTYap files in order to have a more consistent name organization 2010-04-19 02:34:08 +01:00
.gitignore make git ignore these files (Ulrich Neumerkel). 2009-05-02 11:00:21 -05:00
.gitmodules declae all modules. 2009-04-22 17:34:31 -05:00
Artistic Updated the YAP license to the final version of the "The Artistic License 2.0" (see http://www.perlfoundation.org/legal/ for details). 2006-09-27 18:09:14 +00:00
build-distr avoid adding junk to tar files 2001-07-17 18:51:50 +00:00
changes4.3.html move to 4.5.3 2004-03-08 19:31:01 +00:00
changes-5.0.html more files ;-). 2005-10-28 17:57:25 +00:00
changes-5.1.html more locking fixes 2008-08-13 01:16:26 +00:00
changes-6.0.html fix indexing of bignums (obs from Jos de Roo). 2010-05-14 12:42:30 +01:00
changes.css library(system) plus several new support builtins 2001-05-21 20:00:05 +00:00
config.guess upgrade to more recent version. 2009-11-23 10:14:56 +00:00
config.h.in fixes for clib 2010-07-20 22:55:09 +01:00
config.sub upgrade to more recent version. 2009-11-23 10:14:56 +00:00
configure install time.so and time.pl 2010-08-04 02:42:05 +01:00
configure.in install time.so and time.pl 2010-08-04 02:42:05 +01:00
COPYING WINDOWS release setup 2010-02-22 19:06:08 -06:00
distribute upgrade to 5.1.4 2008-06-18 10:02:27 +00:00
GIT get rid of wrong docs. 2010-06-14 08:46:58 +01:00
INSTALL fix missing characters in INSTALL 2002-04-08 22:14:22 +00:00
install-sh This commit was generated by cvs2svn to compensate for changes in r4, 2001-04-09 19:54:03 +00:00
Makefile.in better support for win32 2010-08-03 12:27:23 +01:00
README update instructions. 2010-04-27 22:10:08 +01:00
README.EAM.html eamconsult can now be used to pre-compile simple prolog code. 2006-04-08 15:12:08 +00:00
README.nt saved state should be startup.yss, not startup.yss, in case YAP looks up 2009-05-02 14:06:24 -05:00
TO_DO upgrade to 5.1.4 2008-06-18 10:02:27 +00:00


			README for Yap6


This directory contains a release of the Yap 6.0.* Prolog system,
originally developed at the Universidade do Porto by Luis Damas and
Vitor Santos Costa, with contributions from the Edinburgh Prolog
library, the C-Prolog manual authors, Ricardo Lopes, Ricardo Rocha,
M. Hermenegildo, D. Cabeza, Eric Alphonse, Paulo Moura, Nuno Fonseca,
Jan Wielemaker, Paul Singleton, Fred Dushin, Jan Wielemaker, Markus
Triska, and many others. You should read the rest of this file for
information on what Yap is and for instructions on how to build it.

YAP 6 has been built with several versions on GCC on a variety of
Linux, MacOSX. It has been built on Windows XP and VISTA using the
mingw toolkit and cygwin from Cygnus Solutions.

The main core of the YAP distribution is distributed under a dual
license: the Perl Artistic license 2 and the FSF's LGPL. The YAP
distribution also contains files distributed under the LGPL
exclusively, and under the GPL.

The YAP distribution includes several packages ported to Yap, such as
Pillow, JPL, CLP(R) and CHR. We would like to take the opportunity to
thank the developers of these packages for their generosity in
allowing YAP to distribute these packages. Any bugs in these packages
are probably our fault.

If you have a question about this software, desire to add code, found
a bug, want to request a feature, or wonder how to get further
assistance, please send e-mail to yap-users@lists.sourceforge.net. To
subscribe to the mailing list or access the list archives, please see
http://lists.sourceforge.net/lists/listinfo/yap-users

Online documentation is available for Yap at:

	http://www.dcc.fc.up.pt/~vsc/Yap/

Recent versions of Yap, including both source and selected binaries,
can be found from this same URL.

1. What is YAP

The Yap Prolog System is a high-performance Prolog compiler developed
at LIACC, Universidade do Porto. Yap provides several important
features:

 o speed: Yap is widely considered one of the fastest available Prolog
systems.

 o functionality: it supports stream I/O, sockets, modules,
exceptions, Prolog debugger, C-interface, dynamic code, internal
database, DCGs, saved states, co-routining, arrays.

 o we explicitly allow both commercial and non-commercial use of Yap.

Yap is based on the David H. D. Warren's WAM (Warren Abstract
Machine), with several optimizations for better performance. Yap
follows the Edinburgh tradition, and was originally designed to be
largely compatible with DEC-10 Prolog, Quintus Prolog, and especially
with C-Prolog.

Yap implements most of the ISO-Prolog standard. We are striving at
full compatibility, and the manual describes what is still
missing. The manual also includes a (largely incomplete) comparison
with SICStus Prolog.
 
2. Obtaining YAP's development sources.

YAP is now being maintained using the git source management system. A
public repository is available at 

http://gitorious.org/projects/yap-git

Please use

git clone git://gitorious.org/yap-git/mainline.git

to obtain a copy of the current YAP tree.

3. How to compile YAP

To compile YAP from the source directory just do:

 (1) ./configure

 (2) check the Makefile for any extensions or changes you want to make.

 (3) make

 (4) If the compilation succeeds, try ./yap

 (5) Happy? make install

 (6) "make install_info" will create the info files in the standard
     info directory.

 (7) "make html" will create documentation in html format in the
     current directory.

In most systems you will need to be superuser in order to do "make
install" and "make info" on the standard directories.

3.1 Where to install Yap

 YAP uses autoconf. Recent versions of Yap try to follow GNU
conventions on where to place software. By default, this location is
/usr/local on Unix, Linux, and OS/X machines. 

You can use the --prefix configure option to set the ROOTDIR macro and
the --exec-prefix option to set the EROOTDIR macro (for
architecture-dependent files). EROOTDIR defaults to ROOTDIR.

  o The main executable is placed at BINDIR, which defaults at
$(EROOTDIR)/bin. This executable is actually a script that calls the
Prolog engine, stored at YAPLIBDIR.

  o SHAREDIR is the directory where the Prolog libraries are stored.
Its default value is $(ROOTDIR)/share. The Prolog libraries are
machine-independent text files that only need to be installed once,
even on systems where multiple copies of Yap of the same version are
installed. (e.g. with different configurations or for different
architectures sharing a file server.)

  o LIBDIR is the directory where binary libraries are stored. It is
set to $(EROOTDIR)/lib by default. YAPLIBDIR is a subdirectory (by
default $(EROOTDIR)/lib/Yap) that contains the Prolog engine and the
binary Prolog libraries.

  o INCLUDEDIR is used if you want to use Yap as a library.

  o INFODIR is where the info help files will be stored. It defaults
to $(SHAREDIR)/info.

3.2 Which YAP to compile

Compiling YAP with the standard options give you a plain vanilla
Prolog. You can tune Yap to use extra functionality by using the
following options to configure:

 o --enable-depth-limit=yes allows depth limited evaluation, say for
implementing iterative deepening. It is required by the ILP system
Aleph.

 o --enable-use-malloc=yes makes YAP use the system's library for all
 memory allocation. 

 o --enable-threads=yes enables POSIX thread support.

 o --enable-low-level-tracer=yes allows support for tracing all calls,
retries, and backtracks in the system. This can help in debugging your
application, but results in performance loss.

 o --enable-wam-profile=yes allows profiling of abstract machine
instructions. This is useful when developing YAP, should not be very
useful for normal users.

 o --enable-parallelism={env-copy,sba,a-cow} allows or-parallelism
supported by one of these three forms. This is still highly experimental.

 o --enable-tabling=yes allows tabling support. This is still experimental.

 o --with-jpl=JAVA_PATH activates the Java Interface Library JPL. In
 Linux and WIN32 you have to provide a path to the Java library, in
 OSX it is sufficient to say yes.

3.3 Porting Yap

The system has been mainly tested with GCC, but we have been able to
compile older versions of Yap under lcc in Linux, Sun's cc compiler,
IBM's xlc, SGI's cc, HP's cc, and Microsoft's Visual C++ 6.0. Recent
versions of YAP have also been compiled using Intel's lcc.