~ chicken-core (master) /README
Trap1234 _/_/_/ _/ _/ _/_/_/ _/_/_/ _/ _/ _/_/_/_/ _/ _/5 _/ _/ _/ _/ _/ _/ _/ _/ _/_/ _/6 _/ _/_/_/_/ _/ _/ _/_/ _/_/_/ _/ _/ _/7_/ _/ _/ _/ _/ _/ _/ _/ _/ _/_/8 _/_/_/ _/ _/ _/_/_/ _/_/_/ _/ _/ _/_/_/_/ _/ _/9101112 README file for the CHICKEN Scheme system13 =========================================141516 (c) 2008-2022, The CHICKEN Team17 (c) 2000-2007, Felix L. Winkelmann1819 version 6.0.0202122 1. Introduction2324 CHICKEN is a Scheme-to-C compiler supporting the language25 features as defined in the 'Revised^5 Report on26 Scheme'. Separate compilation is supported and full27 tail-recursion and efficient first-class continuations are28 available.2930 Some things that CHICKEN has to offer:3132 1. CHICKEN generates quite portable C code and compiled files33 generated by it (including itself) should work without any34 changes on Windows, most UNIX-like platforms, and with35 minor changes on other systems.3637 2. The whole package is distributed under a BSD style license38 and as such is free to use and modify as long as you agree39 to its terms.4041 3. Linkage to C modules and C library functions is42 straightforward. Compiled programs can easily be embedded43 into existing C code.4445 4. Loads of extra libraries.4647 Note: Should you have any trouble in setting up and using48 CHICKEN, please ask questions on the CHICKEN users mailing49 list. Check http://wiki.call-cc.org/discussion-groups for50 information on how to subscribe to CHICKEN mailing lists.515253 2. Installation5455 Building CHICKEN requires GNU Make. Other "make" derivates are56 not supported.5758 Configuration and customization of the build process is done by59 either using the "configure" script, setting makefile variables60 on the "make" command line or by editing the platform-specific61 makefile.6263 2.1. Building from a release tarball6465 To build CHICKEN, first extract the archive ("tar xzf66 chicken-<version>.tar.gz" on UNIX or use your favorite67 extraction program on Windows), then change to the68 chicken-<version> directory and invoke "configure" like this:6970 ./configure [OPTION ...]7172 This will overwrite a configuration file for the subsequent73 "make" invocation that builds the CHICKEN tools and libraries.74 Enter "./configure --help" to see the available options.75 Usually you want to set the installation prefix where the76 results of the build should be installed:7778 ./configure --prefix $HOME/.local7980 If not given, the installation prefix defaults to "/usr/local".81 You can also define the build platform and whether you want to82 build with debug-information, in addition to other specialized83 settings. The platform is determined automatically if not84 specified.8586 Once you have configured the system you can start building it87 by entering8889 make9091 Note that GNU make is currently required, so use9293 gmake9495 On systems that use BSD make.9697 The old style invocation of "make" is still supported, where98 you pass platform and prefix information on the make command99 line, like this:100101 make PLATFORM=<platform> PREFIX=<destination>102103 Out-of-directory builds are currently not supported, so you must104 be in the toplevel source directory to invoke "configure" and105 "make".106107 If CHICKEN somehow detects the wrong platform, type108109 ./configure --platform=list110111 to get a list of available platforms, and re-run "configure" using112 the correct platform.113114 If you invoke "make" later with different configuration parameters,115 it is advisable to run:116117 make confclean118119 to remove old configuration files.120121 2.2. Building from Git122123 If you build CHICKEN directly from the development sources out124 of the git repository, you will need a "chicken" executable to125 generate the compiled C files from the Scheme library sources.126 See section 2.1 for platform detection issues.127128 Configuration is the same as when building from the distribution129 tarball. You may have to use the "--chicken" option to define130 which "chicken" compiler binary should be used to translate the131 Scheme source code in the repository:132133 ./configure --prefix ... --chicken <install-dir>/bin/chicken134135 If you do not want to use the "configure" script, create an empty136 "config.make", like this:137138 touch config.make139140 "Config.make" is required by the build process, even if it141 contains no settings.142143 If you are building in a checkout where you have built other144 versions of chicken, you need to make sure that all traces of145 the previous build are removed. "make clean" is insufficient,146 and you should do the following:147148 make spotless149150 You will need to have a "chicken" binary installed, ideally151 from the development snapshot tarball that is closest to the152 git version you are trying to build (significantly older or153 newer ones are unlikely to work), and then use that chicken154 to build from your git sources. Installing this CHICKEN is155 recommended, if necessary you can install it to a temporary156 location in your homedir for example.157158 In some cases, the sources may have diverged enough to159 become unbuildable even with the snapshot. Then you'll need160 to first build a bootstrapping compiler with the installed161 CHICKEN and then use that to build the version from git.162 See the "Bootstrapping" section below.163164 2.3. Finishing the installation165166 If CHICKEN is built successfully, you can install it on your167 system by entering168169 make install170171 To install CHICKEN for a particular prefix on a different172 location, set the "DESTDIR" variable: It designates the173 directory where the files are installed into.174175 2.4. Verifying your installation is correct176177 You can check whether CHICKEN is functioning correctly by178 running179180 make check181182 This will run the test scripts, which show a lot of output.183 The only thing that matters is the exit status at the end.184 If it exits with status 0, everything is fine, if it exits185 with a nonzero status, the failing test's output should be186 the final lines before Make's "error; exit" output. If the187 check fails on unmodified sources, please file a bugreport.188189 2.5. Optional features190191 You can further enable various optional features by adding192 one or more of the following variables to the "configure"193 invocation:194195 --debugbuild196 Disable optimizations in compiled C code and enable197 debug information.198199 --staticbuild200 Build only static versions of the runtime library, compiler201 and interpreter.202203 --program-prefix PREFIX204 A prefix to prepend to the names of all generated executables.205 This allows having multiple CHICKEN versions in your PATH206 (but note that they have to be installed at different locations).207208 --program-suffix SUFFIX209 A suffix to be appended to the names of all generated executables.210211 --host SYSTEM212 A "<machine>-<platform>" name prefix to use for the C compiler to213 use to compile the runtime system and executables. Set this variable214 if you want to compile CHICKEN for a different architecture than215 the one on which you are building it.216217 --target SYSTEM218 Similar to "HOSTSYSTEM", but specifies the name219 prefix to use for compiling code with the "csc" compiler220 driver. This is required for creating a "cross chicken", a221 specially built CHICKEN that invokes a cross C compiler to222 build the final binaries. You will need a cross compiled223 runtime system by building a version of CHICKEN with the224 "HOST" option mentioned above. More information about this225 process and the variables that you should set are provided226 in the manual (see the "Cross development" chapter).227228 --srcdir DIRECTORY229 Specifies that CHICKEN should be built outside of its source230 tree. The SRCDIR variable indicates the location of the231 CHICKEN source tree. The executables and object files will232 be generated in the current directory.233234 --vardir DIRECTORY235 If set, this directory overrides the location where236 extensions along with their metadata are stored. Normally237 this will be equivalent to "<PREFIX>/lib/chicken/<BINARYVERSION>".238 When VARDIR is specified, extensions will be stored in239 "<VARDIR>/chicken/<BINARYVERSION>", conforming to the FHS.240241 --c-compiler PROGRAM242 If set, determines the C compiler used to compiler C sources.243244 --linker PROGRAM245 Determines the executable used for linking compiled object files,246 usually the same as the C compiler executable.247248 --profile-object "FILENAME ..."249 This option allows you to profile (parts of) CHICKEN itself.250 Just pass in a whitespace-separated list of objects, without251 the .scm-extension. (An "object" here is an individual252 .scm-file which gets compiled to a .c-file)253 To build with profiling support, run "make spotless" first.254 Be warned that this is a highly experimental option and255 profiling doesn't work for every component of CHICKEN.256257 The "configure" script respects the "CC" and "CFLAGS" environment258 variables which allow overriding the C compiler to use and any259 additional C compiler flags that should be used when compiling260 the runtime system and C files generated by "chicken".261262 The default compiler is "gcc" ("cc" on *BSD systems). CHICKEN263 can be built with the LLVM version of gcc and with "clang",264 the LLVM-based C compiler, just set C_COMPILER to "llvm-gcc"265 or "clang". CHICKEN has also been successfully built with "zig cc",266 the C frontend of the "Zig" language toolchain.267268 Less frequently used settings are available by variables that can269 be passed on the "make" command line:270271 2.6. Uninstalling CHICKEN272273 To remove CHICKEN from your file-system, enter (probably as274 root):275276 make uninstall277278 (If you gave DESTDIR during installation, you have to pass279 the same setting to "make" when uninstalling)280281 2.7. What gets installed282283 These files will be installed under the prefix given during284 build and installation:285286 <PREFIX>287 |-- bin288 | |-- chicken289 | |-- chicken-install290 | |-- chicken-profile291 | |-- chicken-status292 | |-- chicken-uninstall293 | |-- libchicken.dll (Windows)294 | |-- csc295 | `-- csi296 |-- include297 | `-- chicken298 | |-- chicken-config.h299 | `-- chicken.h300 |-- lib301 | |-- chicken302 | | `-- 12303 | | |-- chicken.base.import.so304 | | |-- chicken.bitwise.import.so305 | | |-- chicken.bytevector.import.so306 | | |-- chicken.compiler.user-pass.import.so307 | | |-- chicken.condition.import.so308 | | |-- chicken.continuation.import.so309 | | |-- chicken.csi.import.so310 | | |-- chicken.errno.import.so311 | | |-- chicken.eval.import.so312 | | |-- chicken.file.import.so313 | | |-- chicken.file.posix.import.so314 | | |-- chicken.fixnum.import.so315 | | |-- chicken.flonum.import.so316 | | |-- chicken.foreign.import.so317 | | |-- chicken.format.import.so318 | | |-- chicken.gc.import.so319 | | |-- chicken.internal.import.so320 | | |-- chicken.io.import.so321 | | |-- chicken.irregex.import.so322 | | |-- chicken.keyword.import.so323 | | |-- chicken.load.import.so324 | | |-- chicken.locative.import.so325 | | |-- chicken.memory.import.so326 | | |-- chicken.memory.representation.import.so327 | | |-- chicken.pathname.import.so328 | | |-- chicken.platform.import.so329 | | |-- chicken.plist.import.so330 | | |-- chicken.port.import.so331 | | |-- chicken.pretty-print.import.so332 | | |-- chicken.process.import.so333 | | |-- chicken.process.signal.import.so334 | | |-- chicken.process-context.import.so335 | | |-- chicken.process-context.posix.import.so336 | | |-- chicken.random.import.so337 | | |-- chicken.repl.import.so338 | | |-- chicken.sort.import.so339 | | |-- chicken.string.import.so340 | | |-- chicken.read-syntax.import.so341 | | |-- chicken.syntax.import.so342 | | |-- chicken.tcp.import.so343 | | |-- chicken.time.import.so344 | | |-- chicken.time.posix.import.so345 | | |-- scheme.file.import.so346 | | |-- scheme.process-context.import.so347 | | |-- scheme.time.import.so348 | | |-- scheme.write.import.so349 | | |-- modules.db350 | | |-- srfi-4.import.so351 | | `-- types.db352 | |-- libchicken-static.a353 | |-- libchicken.dll.a (Windows)354 | |-- libchicken.dylib (Macintosh)355 | |-- libchicken.so -> libchicken.so.12 (Unix)356 | `-- libchicken.so.12 (Unix)357 `-- share358 |-- chicken359 | |-- doc360 | | |-- LICENSE361 | | |-- README362 | | |-- DEPRECATED363 | | |-- chicken.png364 | | |-- manual-html365 | | `-- *.html366 | |-- chicken.rc.o (Windows)367 | `-- setup.defaults368 `-- man369 `-- man1370 |-- chicken-install.1371 |-- chicken-profile.1372 |-- chicken-status.1373 |-- chicken-uninstall.1374 |-- chicken.1375 |-- csc.1376 `-- csi.1377378379 3. Usage380381 Documentation can be found in the directory382 PREFIX/share/chicken/doc in HTML format. The manual is383 maintained in a wiki at http://wiki.call-cc.org. Go there to384 read the most up to date documentation.385386387 4. Extensions388389 A large number of extension libraries for CHICKEN are390 available at http://wiki.call-cc.org/eggs. You can391 automatically download, compile and install extensions with392 the "chicken-install" program. See the CHICKEN User's Manual393 for more information.394395 A selection of 3rd party libraries, together with source and396 binary packages for tools helpful for development with CHICKEN397 are also available at:398 <http://www.call-with-current-continuation.org/tarballs/>.399400401 5. Platform issues402403 Android:404405 - The Android SDK and NDK are required. Make sure you have406 set up a project and have a suitable NDK toolchain407 available. You will have to override the make(1) variable408 C_COMPILER to contain the correct compiler; see409 docs/STANDALONE-TOOLCHAIN.html in your NDK root for notes410 on how to call the correct compiler. You will also need to411 override the ARCH variable to match the device you're412 targeting. The build will produce a libchicken.so that413 can then be integrated into your project as a prebuilt414 shared library. See the android section on415 http://wiki.call-cc.org/embedding for a complete example.416417 - It is possible to use eggs, by copying them into the right418 place and probably renaming the files. This is somewhat419 awkward and requires various hacks to make the420 loading/linking of eggs work. It may be easier to build421 the eggs you need manually and linking them statically to422 your executable.423424 - By default debug-logging is enabled and written to the425 Android log.426427 FreeBSD/NetBSD/OpenBSD:428429 - *BSD system users *must* use GNU make ("gmake") - the makefiles430 can not be processed by BSD make.431432 - On NetBSD it might be possible that compilation fails with a433 "virtual memory exhausted error". Try the following:434435 % unlimit datasize436437 - When using -deploy on NetBSD, currently the kernel only438 supports running the program through its absolute path,439 otherwise you will get an error message stating:440441 execname not specified in AUX vector: No such file or directory442443 Deployed binaries can also be run without an explicit path,444 through $PATH; only relative pathnames do not work.445446 - Using external libraries on NetBSD may also be easier, if447 you add the following definitions to `Makefile.bsd':448449 C_COMPILER_OPTIONS += -I/usr/pkg/lib450 LINKER_OPTIONS += -L/usr/pkg/lib -Wl,-rpath=/usr/pkg/lib451452 Note that this may cause build-problems, if you already have453 an existing CHICKEN installation in the /usr/pkg prefix.454455 Linux:456457 - If you want to build Linux binaries which use the "X32 ABI",458 you can pass ARCH=x32 on the Make command line.459460 - There have been reports where the library directory461 "/usr/lib64" could not be found at build-time on a Fedora462 12 system. If you build a 64-bit version of CHICKEN and463 the library directory is set incorrectly, you can override464 it by passing "LIBDIR=/usr/lib64" as an additional465 argument when you invoke "make".466467 Solaris:468469 - By default, CHICKEN is build with the GNU C compiler (`gcc').470 To use the SunPro C compiler (`cc') instead, override the471 used compiler like this:472473 CC=cc ./configure ...474475 - Older versions of Solaris have a bug in ld.so that causes476 trouble with dynamic loading. Patching Solaris fixes the477 problem. Solaris 7 needs patch 106950-18. Solaris 8 has an478 equivalent patch, 109147-16.479480 You can find out if you have these patches installed by481 running:482483 % showrev -p | grep 106950 # solaris 7484 % showrev -p | grep 109147 # solaris 8485486 Mac OS X:487488 - The build currently assumes the C toolchain is in the path,489 use the "xcode-select(1)" tool to make them available on the490 command line if you haven't already done so.491492 - CHICKEN will normally select a 32-bit or 64-bit build493 automatically when you use the normal build step:494495 make496497 Specifically, the defaults are:498499 10.4: 32-bit500 10.5: 32-bit501 10.6: 64-bit (32-bit on original Core Duo, circa early 2006)502 10.7: 64-bit503504 On 10.5, you can optionally build in 64-bit mode on machines505 released in late 2006 or later (i.e. with a Core 2 Duo or Xeon506 CPU), by specifying ARCH=x86-64:507508 make ARCH=x86-64509510 - Universal binaries: On 10.4 and 10.5 only, CHICKEN and its eggs511 can be built as universal binaries which will work on either512 Intel or PowerPC. Most users will not want to do this.513514 For 10.4 universal build:515 make ARCH=universal516517 For 10.5 universal build:518 export MACOSX_DEPLOYMENT_TARGET=10.4519 make C_COMPILER=gcc-4.0 ARCH=universal520521 For 10.6 and later, universal builds are not supported.522523 - On 10.3 and earlier, you must first install `dlcompat'524 which can be found at http://distfiles.macports.org/dlcompat/.525526 iOS:527528 - Make sure the "XCODE_PATH" setting is correct (see529 Makefile.ios), it defaults to "/Applications/Xcode.app".530531 - The paths for the the various build tools changed between532 Xcode 4 and 5. The makefile used for iOS builds of CHICKEN533 assume Xcode 5 is used. If you are using Xcode 4, override534 the XCODE_TOOLPATH and C_COMPILER make-variables providing535 the correct paths, see Makefile.ios for suggestions.536537 - The iOS build is static (iOS doesn't support dynamic538 loading of executable code). Only the runtime library539 (libchicken.a) is of interest. To use it, integrate540 libchicken.a in your Xcode project and use a normal MacOS541 build to compile your Scheme sources into C files, adding542 them to you project.543544 - Core library units must by accessed via "(declare (uses545 ...))" and "(import ...)", "require", "require-library",546 "require-extension" and "use" will not work, due to the547 reasons mentioned above.548549 - As dynamic loading is not supported, eggs can not be used550 as usual, you will have to compile them manually and551 integrate what you need into your project.552553 - If you want to build for the iPhone Simulator, override554 the ARCH and XCODE_SDK variables accordingly, see also in555 Makefile.ios for suggestions.556557 Windows:558559 - On Windows, native builds using the "MingW" toolchain and560 Cygwin are supported (Microsoft Visual Studio is *NOT*).561 Makefiles for MingW are provided (`Makefile.MingW').562 GNU make and a POSIX sh(1) are required to build the system.563 Please also read the notes below.564565 - Since there are various distributions of the MingW toolchain566 we recommend to use "w64devkit" by Chrstopher Wellons:567568 https://github.com/skeeto/w64devkit569570 This toolset is very complete, includes GNU make and a571 POSIX shell and is the development environment we use to572 test CHICKEN. Other distributions of MingW may work but573 are not tested by us.574575 - When installing under the MingW platform, PREFIX must be an576 absolute path name (i.e. it must include the drive letter) and577 must use forward slashes (no backward slashes), for example578579 ./configure --prefix C:/chicken/580581 - Under MingW, the "csc" compiler driver and "chicken-install"582 expect the compiler executable and the usual UNIX tools are583 in the PATH, so make sure to run them inside a shell that584 provides the necessary stuff.585586 - Cygwin will not be able to find the chicken shared libraries587 until Windows is rebooted.588589 - During "make check" you may see these intermittent errors:590591 ld.exe: cannot open output file a.out: Permission denied592593 When this happens, the virusscanner is holding open594 the file of the previous test while the compiler is595 preparing the next test.596 To work around this in Windows Defender (the default),597 disable "realtime protection" under tools->options.598599 AIX:600601 - CHICKEN is built with the GNU C compiler (`gcc'). IBM's XL602 C compiler is not supported at this time.603604 - AIX users *must* use GNU make ("gmake") - the makefiles can not be605 processed with IBM's version of make.606607 - Deployment doesn't work. See manual/Deployment for more details.608609 - The AIX linker may occasionally show warnings of the form:610611 ld: 0711-783 WARNING: TOC overflow. TOC size: 66656612 Maximum size: 65536613 Extra instructions are being generated for each reference to a TOC614 symbol if the symbol is in the TOC overflow area.615616 Such messages indicate that lookups for some symbols in the617 effected library/executable may be somewhat slower at runtime as an618 auxiliary symbol table is needed to accommodate all of the symbols.619620 - The AIX assembler may show warnings of the form:621622 /tmp//ccycPGzK.s: line 527244: 1252-171 The displacement must be623 greater than or equal to -32768 and less than or equal to 32767.624625 This is a known issue between the GNU toolchain and IBM's assembler:626627 http://gcc.gnu.org/bugzilla/show_bug.cgi?id=4587628629 The problem arises because the PPC architecture cannot perform jumps630 to addresses that differ more than what a 16-bit integer can631 represent. Adding support for IBM's XL C compiler may resolve this632 issue.633634 Instructing gcc to optimize the size of generated code (-Os)635 mitigates this to some degree, but very large C files may still be636 uncompilable. This is known to affect the html-tags egg.637638 Haiku:639640 - The default GCC compiler is too old to support the -fwrapv641 option. You can either remove the flag from Makefile.haiku,642 use a newer GCC, or supply your own C_COMPILER_OPTIONS on643 the Make command line.644645 - The default Haiku BFS file system only supports timestamps646 with a granularity of one second. This may cause trouble647 with pregenerated release or development snapshot tarballs648 due to the way files are pre-translated to C. You'll either649 need to have CHICKEN installed, or touch the650 build-version.c file before building.651652653 6. Bootstrapping654655 To build a bootstrapping compiler yourself, get the most656 recent development snapshot tarball from657 http://code.call-cc.org, unpack it, build and install everything.658 Then change to the directory containing the git code and run:659660 ./configure --chicken <path-to-existing-chicken>661 make boot-chicken662663 This will produce a statically linked binary with the name664 "chicken-boot[.exe]" that can be given as the value of the665 "--chicken" configuration option. Note that the path to an666 existing `chicken' binary must be given to use it for667 compiling the Scheme code of the runtime-system and compiler.668669 "scripts/bootstrap.sh" automates this process; use this script670 if you are unsure how to build from the repository sources. It671 downloads the necessary development snapshot with wget(1) and672 builds the boot-chicken that you can use to compile the673 development sources. The invocation is:674675 ./scripts/bootstrap.sh ...676677 You can add additional parameters if you like to customize the678 build, but this should not be necessary. Note that your current679 working directory must be the root directory of the CHICKEN680 git(1) repository. Once the boot-chicken is built, proceed by681 invoking make(1) as described above (in 2.2, Building from Git),682 with the additional parameter:683684 make CHICKEN=./chicken-boot ...685686 or run "configure" again:687688 ./configure --chicken ./chicken-boot ...689 make690691692 7. Emacs support693694 See http://wiki.call-cc.org/emacs for tips and links to emacs695 extensions for Scheme and CHICKEN programming.696697698 8. What's next?699700 If you find any bugs, or want to report a problem, please send701 a detailed bug report.702703 If you have any more questions or problems (even the slightest704 problems, or the most stupid questions), then please subscribe705 to the "chicken-users"706 (http://lists.nongnu.org/mailman/listinfo/chicken-users)707 mailing list and ask for help. It will be answered.