From bdfabb5ba38d1b540f7aaa5fafd168923dc537ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Glondu?= Date: Thu, 12 Sep 2019 15:54:38 +0200 Subject: Import ocplib-endian_1.0-1.debian.tar.xz [dgit import tarball ocplib-endian 1.0-1 ocplib-endian_1.0-1.debian.tar.xz] --- changelog | 5 +++ control | 62 +++++++++++++++++++++++++++++++++++ copyright | 37 +++++++++++++++++++++ gbp.conf | 2 ++ libocplib-endian-ocaml-dev.install.in | 7 ++++ libocplib-endian-ocaml.install.in | 3 ++ rules | 23 +++++++++++++ source/format | 1 + watch | 2 ++ 9 files changed, 142 insertions(+) create mode 100644 changelog create mode 100644 control create mode 100644 copyright create mode 100644 gbp.conf create mode 100644 libocplib-endian-ocaml-dev.install.in create mode 100644 libocplib-endian-ocaml.install.in create mode 100755 rules create mode 100644 source/format create mode 100644 watch diff --git a/changelog b/changelog new file mode 100644 index 0000000..d505ab9 --- /dev/null +++ b/changelog @@ -0,0 +1,5 @@ +ocplib-endian (1.0-1) unstable; urgency=medium + + * Initial release (Closes: #940039) + + -- Stéphane Glondu Thu, 12 Sep 2019 15:54:38 +0200 diff --git a/control b/control new file mode 100644 index 0000000..48ec7ff --- /dev/null +++ b/control @@ -0,0 +1,62 @@ +Source: ocplib-endian +Priority: optional +Maintainer: Debian OCaml Maintainers +Uploaders: + Stéphane Glondu +Build-Depends: + debhelper-compat (= 12), + ocaml-nox, + ocaml-findlib, + ocamlbuild, + cppo, + dh-ocaml +Standards-Version: 4.4.0 +Section: ocaml +Homepage: https://github.com/OCamlPro/ocplib-endian +Vcs-Git: https://salsa.debian.org/ocaml-team/ocplib-endian.git +Vcs-Browser: https://salsa.debian.org/ocaml-team/ocplib-endian + +Package: libocplib-endian-ocaml-dev +Architecture: any +Depends: + ${ocaml:Depends}, + ${shlibs:Depends}, + ${misc:Depends} +Provides: ${ocaml:Provides} +Recommends: ocaml-findlib +Description: optimised functions to read and write int16/32/64 (development) + Optimised functions to read and write int16/32/64 from strings, bytes + and bigarrays, based on primitives added in version 4.01. + . + The library implements three modules: + * EndianString works directly on strings, and provides submodules + BigEndian and LittleEndian, with their unsafe counter-parts; + * EndianBytes works directly on bytes, and provides submodules + BigEndian and LittleEndian, with their unsafe counter-parts; + * EndianBigstring works on bigstrings (Bigarrays of chars), and + provides submodules BigEndian and LittleEndian, with their unsafe + counter-parts. + . + This package contains the development files. + +Package: libocplib-endian-ocaml +Architecture: any +Depends: + ${ocaml:Depends}, + ${shlibs:Depends}, + ${misc:Depends} +Provides: ${ocaml:Provides} +Description: optimised functions to read and write int16/32/64 (runtime) + Optimised functions to read and write int16/32/64 from strings, bytes + and bigarrays, based on primitives added in version 4.01. + . + The library implements three modules: + * EndianString works directly on strings, and provides submodules + BigEndian and LittleEndian, with their unsafe counter-parts; + * EndianBytes works directly on bytes, and provides submodules + BigEndian and LittleEndian, with their unsafe counter-parts; + * EndianBigstring works on bigstrings (Bigarrays of chars), and + provides submodules BigEndian and LittleEndian, with their unsafe + counter-parts. + . + This package contains the runtime files. diff --git a/copyright b/copyright new file mode 100644 index 0000000..1610f26 --- /dev/null +++ b/copyright @@ -0,0 +1,37 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ + +Files: * +Copyright: © 2012-2014 OCamlPro +License: LGPL-2.2+-with-linking-exception + +Files: debian/* +Copyright: © 2019 Stéphane Glondu +License: LGPL-2.2+-with-linking-exception + +License: LGPL-2.2+-with-linking-exception + These files are distributed under the terms of the GNU Lesser General + Public License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version, + with the OCaml static compilation exception. + . + ocplib-endian 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 General Public License for more details. + . + On Debian systems, the full text of the LGPL 2.1 can be found in + `/usr/share/common-licenses/LGPL-2.1'. + . + As a special exception to the GNU Library General Public License, you + may link, statically or dynamically, a "work that uses the Library" + with a publicly distributed version of the Library to produce an + executable file containing portions of the Library, and distribute + that executable file under terms of your choice, without any of the + additional requirements listed in clause 6 of the GNU Library General + Public License. By "a publicly distributed version of the Library", + we mean either the unmodified Library as distributed by upstream + author, or a modified version of the Library that is distributed + under the conditions defined in clause 3 of the GNU Library General + Public License. This exception does not however invalidate any other + reasons why the executable file might be covered by the GNU Library + General Public License. diff --git a/gbp.conf b/gbp.conf new file mode 100644 index 0000000..cec628c --- /dev/null +++ b/gbp.conf @@ -0,0 +1,2 @@ +[DEFAULT] +pristine-tar = True diff --git a/libocplib-endian-ocaml-dev.install.in b/libocplib-endian-ocaml-dev.install.in new file mode 100644 index 0000000..f6defbb --- /dev/null +++ b/libocplib-endian-ocaml-dev.install.in @@ -0,0 +1,7 @@ +@OCamlStdlibDir@/ocplib-endian/*.ml* +@OCamlStdlibDir@/ocplib-endian/*.cmi +@OCamlStdlibDir@/ocplib-endian/*.annot +@OCamlStdlibDir@/ocplib-endian/*.cmt* +OPT: @OCamlStdlibDir@/ocplib-endian/*.cmx +OPT: @OCamlStdlibDir@/ocplib-endian/*.cmxa +OPT: @OCamlStdlibDir@/ocplib-endian/*.a diff --git a/libocplib-endian-ocaml.install.in b/libocplib-endian-ocaml.install.in new file mode 100644 index 0000000..104e141 --- /dev/null +++ b/libocplib-endian-ocaml.install.in @@ -0,0 +1,3 @@ +@OCamlStdlibDir@/ocplib-endian/META +@OCamlStdlibDir@/ocplib-endian/*.cma +DYN: @OCamlStdlibDir@/ocplib-endian/*.cmxs diff --git a/rules b/rules new file mode 100755 index 0000000..020f307 --- /dev/null +++ b/rules @@ -0,0 +1,23 @@ +#!/usr/bin/make -f +# -*- makefile -*- + +include /usr/share/ocaml/ocamlvars.mk + +DESTDIR=$(CURDIR)/debian/tmp +export OCAMLFIND_DESTDIR=$(DESTDIR)$(OCAML_STDLIB_DIR) + +%: + dh $@ --with ocaml --no-parallel + +override_dh_auto_configure: + ocaml setup.ml -configure + +override_dh_auto_build: + ocaml setup.ml -build + +override_dh_auto_install: + mkdir -p $(OCAMLFIND_DESTDIR) + ocaml setup.ml -install + +override_dh_missing: + dh_missing --fail-missing diff --git a/source/format b/source/format new file mode 100644 index 0000000..163aaf8 --- /dev/null +++ b/source/format @@ -0,0 +1 @@ +3.0 (quilt) diff --git a/watch b/watch new file mode 100644 index 0000000..1181ee5 --- /dev/null +++ b/watch @@ -0,0 +1,2 @@ +version=3 +https://github.com/OCamlPro/ocplib-endian/releases .*/archive/(.*)\.tar\.gz -- cgit v1.2.3 From da0246eb18707a7ce70d1c8c4826ebb1bb45c150 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Glondu?= Date: Thu, 12 Sep 2019 15:54:38 +0200 Subject: Import ocplib-endian_1.0.orig.tar.gz [dgit import orig ocplib-endian_1.0.orig.tar.gz] --- .gitignore | 5 + .travis-ci.sh | 28 + .travis.yml | 7 + CHANGES.md | 39 + COPYING.txt | 521 +++ Makefile | 41 + README.md | 11 + _oasis | 69 + _tags | 45 + api.odocl | 6 + configure | 27 + myocamlbuild.ml | 849 +++++ setup.ml | 7172 ++++++++++++++++++++++++++++++++++++++++++ src/META | 24 + src/be_ocaml_400.ml | 28 + src/be_ocaml_401.ml | 32 + src/bigstring.mldylib | 4 + src/bigstring.mllib | 4 + src/common.ml | 22 + src/common_400.cppo.ml | 79 + src/common_401.cppo.ml | 100 + src/common_float.ml | 5 + src/endianBigstring.cppo.ml | 120 + src/endianBigstring.cppo.mli | 130 + src/endianBytes.cppo.ml | 116 + src/endianBytes.cppo.mli | 127 + src/endianString.cppo.ml | 112 + src/endianString.cppo.mli | 123 + src/le_ocaml_400.ml | 28 + src/le_ocaml_401.ml | 32 + src/ne_ocaml_400.ml | 66 + src/ne_ocaml_401.ml | 20 + src/ocplib_endian.mldylib | 5 + src/ocplib_endian.mllib | 5 + tests/bench.ml | 436 +++ tests/test.ml | 45 + tests/test_bigstring.cppo.ml | 211 ++ tests/test_bytes.cppo.ml | 206 ++ tests/test_string.cppo.ml | 206 ++ 39 files changed, 11106 insertions(+) create mode 100644 .gitignore create mode 100644 .travis-ci.sh create mode 100644 .travis.yml create mode 100644 CHANGES.md create mode 100644 COPYING.txt create mode 100644 Makefile create mode 100644 README.md create mode 100644 _oasis create mode 100644 _tags create mode 100644 api.odocl create mode 100755 configure create mode 100644 myocamlbuild.ml create mode 100644 setup.ml create mode 100644 src/META create mode 100644 src/be_ocaml_400.ml create mode 100644 src/be_ocaml_401.ml create mode 100644 src/bigstring.mldylib create mode 100644 src/bigstring.mllib create mode 100644 src/common.ml create mode 100644 src/common_400.cppo.ml create mode 100644 src/common_401.cppo.ml create mode 100644 src/common_float.ml create mode 100644 src/endianBigstring.cppo.ml create mode 100644 src/endianBigstring.cppo.mli create mode 100644 src/endianBytes.cppo.ml create mode 100644 src/endianBytes.cppo.mli create mode 100644 src/endianString.cppo.ml create mode 100644 src/endianString.cppo.mli create mode 100644 src/le_ocaml_400.ml create mode 100644 src/le_ocaml_401.ml create mode 100644 src/ne_ocaml_400.ml create mode 100644 src/ne_ocaml_401.ml create mode 100644 src/ocplib_endian.mldylib create mode 100644 src/ocplib_endian.mllib create mode 100644 tests/bench.ml create mode 100644 tests/test.ml create mode 100644 tests/test_bigstring.cppo.ml create mode 100644 tests/test_bytes.cppo.ml create mode 100644 tests/test_string.cppo.ml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..69434de --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +_build/ +*.native +*.byte +setup.data +setup.log diff --git a/.travis-ci.sh b/.travis-ci.sh new file mode 100644 index 0000000..2b25b27 --- /dev/null +++ b/.travis-ci.sh @@ -0,0 +1,28 @@ +# Edit this for your own project dependencies +OPAM_DEPENDS="ocamlfind cppo" + +case "$OCAML_VERSION,$OPAM_VERSION" in +3.12.1,1.2.0) ppa=avsm/ocaml312+opam12 ;; +4.00.1,1.2.0) ppa=avsm/ocaml40+opam12 ;; +4.01.0,1.2.0) ppa=avsm/ocaml41+opam12 ;; +4.02.1,1.2.0) ppa=avsm/ocaml42+opam12 ;; +*) echo Unknown $OCAML_VERSION,$OPAM_VERSION; exit 1 ;; +esac + +echo "yes" | sudo add-apt-repository ppa:$ppa +sudo apt-get update -qq +sudo apt-get install -qq ocaml ocaml-native-compilers opam +export OPAMYES=1 +export OPAMVERBOSE=1 +echo OCaml version +ocaml -version +echo OPAM versions +opam --version +opam --git-version + +opam init +opam install ${OPAM_DEPENDS} +eval `opam config env` +./configure --enable-tests +make +make test diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..a14f23e --- /dev/null +++ b/.travis.yml @@ -0,0 +1,7 @@ +language: c +script: bash -ex .travis-ci.sh +env: + - OCAML_VERSION=4.02.1 OPAM_VERSION=1.2.0 + - OCAML_VERSION=4.01.0 OPAM_VERSION=1.2.0 + - OCAML_VERSION=4.00.1 OPAM_VERSION=1.2.0 + - OCAML_VERSION=3.12.1 OPAM_VERSION=1.2.0 diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..4c454fd --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,39 @@ +1.0 +--------------- + +* Install generated .mli files +* Build documentation +* Fix README links + +0.8 +--------------- + +* Replace optcomp with cppo, removing hard dependency on camlp4. + +0.7 +--------------- + +* Fix dependencies. + +0.6 +--------------- + +* Port to OCaml 4.02 -safe-string: Add an EndianBytes module. +* Add unoptimized get_float, get_double, set_float and set_double to every modules. +* Add a native endian version of interfaces. + +0.5 +--------------- + +* Fix to avoid problems with integers outside of the range [0; 255] with set_int8. +* Add travis CI files. + +0.4 +--------------- + +* Fix ocamlfind dependency on optcomp + +0.3 +--------------- + +First release. diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 index 0000000..55831aa --- /dev/null +++ b/COPYING.txt @@ -0,0 +1,521 @@ + +As a special exception to the GNU Library General Public License, you may link, +statically or dynamically, a "work that uses the Library" with a publicly +distributed version of the Library to produce an executable file containing +portions of the Library, and distribute that executable file under terms of +your choice, without any of the additional requirements listed in clause 6 of +the GNU Library General Public License. By "a publicly distributed version of +the Library", we mean either the unmodified Library as distributed by upstream +author, or a modified version of the Library that is distributed under the +conditions defined in clause 3 of the GNU Library General Public License. This +exception does not however invalidate any other reasons why the executable file +might be covered by the GNU Library General Public License. + +----------------------------------------------------------------------- + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. +^L + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. +^L + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control +compilation and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. +^L + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. +^L + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. +^L + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. +^L + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply, and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License +may add an explicit geographical distribution limitation excluding those +countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. +^L + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS +^L + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +It is safest to attach them to the start of each source file to most +effectively convey the exclusion of warranty; and each file should +have at least the "copyright" line and a pointer to where the full +notice is found. + + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..3639f14 --- /dev/null +++ b/Makefile @@ -0,0 +1,41 @@ +# OASIS_START +# DO NOT EDIT (digest: a3c674b4239234cbbe53afe090018954) + +SETUP = ocaml setup.ml + +build: setup.data + $(SETUP) -build $(BUILDFLAGS) + +doc: setup.data build + $(SETUP) -doc $(DOCFLAGS) + +test: setup.data build + $(SETUP) -test $(TESTFLAGS) + +all: + $(SETUP) -all $(ALLFLAGS) + +install: setup.data + $(SETUP) -install $(INSTALLFLAGS) + +uninstall: setup.data + $(SETUP) -uninstall $(UNINSTALLFLAGS) + +reinstall: setup.data + $(SETUP) -reinstall $(REINSTALLFLAGS) + +clean: + $(SETUP) -clean $(CLEANFLAGS) + +distclean: + $(SETUP) -distclean $(DISTCLEANFLAGS) + +setup.data: + $(SETUP) -configure $(CONFIGUREFLAGS) + +configure: + $(SETUP) -configure $(CONFIGUREFLAGS) + +.PHONY: build doc test all install uninstall reinstall clean distclean configure + +# OASIS_STOP diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a17633 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +ocplib-endian +============= + +Optimised functions to read and write int16/32/64 from strings, bytes +and bigarrays, based on primitives added in version 4.01. + +The library implements three modules: +- [EndianString](src/endianString.cppo.mli) works directly on strings, and provides submodules BigEndian and LittleEndian, with their unsafe counter-parts; +- [EndianBytes](src/endianBytes.cppo.mli) works directly on bytes, and provides submodules BigEndian and LittleEndian, with their unsafe counter-parts; +- [EndianBigstring](src/endianBigstring.cppo.mli) works on bigstrings (Bigarrays of chars), and provides submodules BigEndian and LittleEndian, with their unsafe counter-parts; + diff --git a/_oasis b/_oasis new file mode 100644 index 0000000..bd84b56 --- /dev/null +++ b/_oasis @@ -0,0 +1,69 @@ +OASISFormat: 0.3 +Name: ocplib-endian +Version: 1.0 +Synopsis: Optimised functions to read and write int16/32/64 from strings and + bigarrays +Authors: Pierre Chambart +License: LGPL-2.1 with OCaml linking exception +Plugins: DevFiles (0.3), META (0.3) +BuildTools: ocamlbuild + +Library ocplib_endian + Path: src + Modules: + EndianString, + EndianBytes + FindlibName: ocplib-endian + BuildDepends: bytes + +Library bigstring + Path: src + Modules: + EndianBigstring + FindlibName: bigstring + FindlibParent: ocplib_endian + BuildDepends: bigarray, bytes + +Executable test + Path: tests + Build$: flag(tests) + Install: false + CompiledObject: best + MainIs: test.ml + BuildDepends: ocplib-endian, ocplib-endian.bigstring + +Executable benchmark + Path: tests + Build$: flag(tests) + Install: false + CompiledObject: best + MainIs: bench.ml + BuildDepends: ocplib-endian, ocplib-endian.bigstring + +Test test + Command: $test + TestTools: test + Run$: flag(tests) + +# +-------------------------------------------------------------------+ +# | Doc | +# +-------------------------------------------------------------------+ + +Document "api" + Title: API reference for ocplib-endian + Type: ocamlbuild (0.3) + Install: true + BuildTools: ocamldoc + XOCamlbuildPath: ./ + XOCamlbuildLibraries: + ocplib-endian, + ocplib-endian.bigstring + +# +-------------------------------------------------------------------+ +# | Misc | +# +-------------------------------------------------------------------+ + +SourceRepository head + Type: git + Location: https://github.com/OCamlPro/ocplib-endian.git + Browser: https://github.com/OCamlPro/ocplib-endian diff --git a/_tags b/_tags new file mode 100644 index 0000000..a0cc6f9 --- /dev/null +++ b/_tags @@ -0,0 +1,45 @@ +true: safe_string, cppo_V_OCAML, cppo_I(src/) + +# We ask ocamlopt to inline brutally to avoir heap allocations when possible +: inline(1000) + +: include_common +: include_400, include_401 + +# OASIS_START +# DO NOT EDIT (digest: 7916603433723a4a8c213dd4495693fc) +# Ignore VCS directories, you can use the same kind of rule outside +# OASIS_START/STOP if you want to exclude directories that contains +# useless stuff for the build process +true: annot, bin_annot +<**/.svn>: -traverse +<**/.svn>: not_hygienic +".bzr": -traverse +".bzr": not_hygienic +".hg": -traverse +".hg": not_hygienic +".git": -traverse +".git": not_hygienic +"_darcs": -traverse +"_darcs": not_hygienic +# Library ocplib_endian +"src/ocplib_endian.cmxs": use_ocplib_endian +# Library bigstring +"src/bigstring.cmxs": use_bigstring +: pkg_bigarray +: pkg_bytes +# Executable test +: pkg_bigarray +: pkg_bytes +: use_bigstring +: use_ocplib_endian +# Executable benchmark +: pkg_bigarray +: pkg_bytes +: use_bigstring +: use_ocplib_endian +: pkg_bigarray +: pkg_bytes +: use_bigstring +: use_ocplib_endian +# OASIS_STOP diff --git a/api.odocl b/api.odocl new file mode 100644 index 0000000..67febba --- /dev/null +++ b/api.odocl @@ -0,0 +1,6 @@ +# OASIS_START +# DO NOT EDIT (digest: 177087cd5f67d9a7865ec0d7a1da04b5) +src/EndianString +src/EndianBytes +src/EndianBigstring +# OASIS_STOP diff --git a/configure b/configure new file mode 100755 index 0000000..6acfaeb --- /dev/null +++ b/configure @@ -0,0 +1,27 @@ +#!/bin/sh + +# OASIS_START +# DO NOT EDIT (digest: dc86c2ad450f91ca10c931b6045d0499) +set -e + +FST=true +for i in "$@"; do + if $FST; then + set -- + FST=false + fi + + case $i in + --*=*) + ARG=${i%%=*} + VAL=${i##*=} + set -- "$@" "$ARG" "$VAL" + ;; + *) + set -- "$@" "$i" + ;; + esac +done + +ocaml setup.ml -configure "$@" +# OASIS_STOP diff --git a/myocamlbuild.ml b/myocamlbuild.ml new file mode 100644 index 0000000..b4de006 --- /dev/null +++ b/myocamlbuild.ml @@ -0,0 +1,849 @@ +(* OASIS_START *) +(* DO NOT EDIT (digest: 6da48c8bf018033639e51d8da5442612) *) +module OASISGettext = struct +(* # 22 "src/oasis/OASISGettext.ml" *) + + + let ns_ str = + str + + + let s_ str = + str + + + let f_ (str: ('a, 'b, 'c, 'd) format4) = + str + + + let fn_ fmt1 fmt2 n = + if n = 1 then + fmt1^^"" + else + fmt2^^"" + + + let init = + [] + + +end + +module OASISString = struct +(* # 22 "src/oasis/OASISString.ml" *) + + + (** Various string utilities. + + Mostly inspired by extlib and batteries ExtString and BatString libraries. + + @author Sylvain Le Gall + *) + + + let nsplitf str f = + if str = "" then + [] + else + let buf = Buffer.create 13 in + let lst = ref [] in + let push () = + lst := Buffer.contents buf :: !lst; + Buffer.clear buf + in + let str_len = String.length str in + for i = 0 to str_len - 1 do + if f str.[i] then + push () + else + Buffer.add_char buf str.[i] + done; + push (); + List.rev !lst + + + (** [nsplit c s] Split the string [s] at char [c]. It doesn't include the + separator. + *) + let nsplit str c = + nsplitf str ((=) c) + + + let find ~what ?(offset=0) str = + let what_idx = ref 0 in + let str_idx = ref offset in + while !str_idx < String.length str && + !what_idx < String.length what do + if str.[!str_idx] = what.[!what_idx] then + incr what_idx + else + what_idx := 0; + incr str_idx + done; + if !what_idx <> String.length what then + raise Not_found + else + !str_idx - !what_idx + + + let sub_start str len = + let str_len = String.length str in + if len >= str_len then + "" + else + String.sub str len (str_len - len) + + + let sub_end ?(offset=0) str len = + let str_len = String.length str in + if len >= str_len then + "" + else + String.sub str 0 (str_len - len) + + + let starts_with ~what ?(offset=0) str = + let what_idx = ref 0 in + let str_idx = ref offset in + let ok = ref true in + while !ok && + !str_idx < String.length str && + !what_idx < String.length what do + if str.[!str_idx] = what.[!what_idx] then + incr what_idx + else + ok := false; + incr str_idx + done; + if !what_idx = String.length what then + true + else + false + + + let strip_starts_with ~what str = + if starts_with ~what str then + sub_start str (String.length what) + else + raise Not_found + + + let ends_with ~what ?(offset=0) str = + let what_idx = ref ((String.length what) - 1) in + let str_idx = ref ((String.length str) - 1) in + let ok = ref true in + while !ok && + offset <= !str_idx && + 0 <= !what_idx do + if str.[!str_idx] = what.[!what_idx] then + decr what_idx + else + ok := false; + decr str_idx + done; + if !what_idx = -1 then + true + else + false + + + let strip_ends_with ~what str = + if ends_with ~what str then + sub_end str (String.length what) + else + raise Not_found + + + let replace_chars f s = + let buf = Buffer.create (String.length s) in + String.iter (fun c -> Buffer.add_char buf (f c)) s; + Buffer.contents buf + + let lowercase_ascii = + replace_chars + (fun c -> + if (c >= 'A' && c <= 'Z') then + Char.chr (Char.code c + 32) + else + c) + + let uncapitalize_ascii s = + if s <> "" then + (lowercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) + else + s + + let uppercase_ascii = + replace_chars + (fun c -> + if (c >= 'a' && c <= 'z') then + Char.chr (Char.code c - 32) + else + c) + + let capitalize_ascii s = + if s <> "" then + (uppercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) + else + s + +end + +module OASISExpr = struct +(* # 22 "src/oasis/OASISExpr.ml" *) + + + + + + open OASISGettext + + + type test = string + + + type flag = string + + + type t = + | EBool of bool + | ENot of t + | EAnd of t * t + | EOr of t * t + | EFlag of flag + | ETest of test * string + + + + type 'a choices = (t * 'a) list + + + let eval var_get t = + let rec eval' = + function + | EBool b -> + b + + | ENot e -> + not (eval' e) + + | EAnd (e1, e2) -> + (eval' e1) && (eval' e2) + + | EOr (e1, e2) -> + (eval' e1) || (eval' e2) + + | EFlag nm -> + let v = + var_get nm + in + assert(v = "true" || v = "false"); + (v = "true") + + | ETest (nm, vl) -> + let v = + var_get nm + in + (v = vl) + in + eval' t + + + let choose ?printer ?name var_get lst = + let rec choose_aux = + function + | (cond, vl) :: tl -> + if eval var_get cond then + vl + else + choose_aux tl + | [] -> + let str_lst = + if lst = [] then + s_ "" + else + String.concat + (s_ ", ") + (List.map + (fun (cond, vl) -> + match printer with + | Some p -> p vl + | None -> s_ "") + lst) + in + match name with + | Some nm -> + failwith + (Printf.sprintf + (f_ "No result for the choice list '%s': %s") + nm str_lst) + | None -> + failwith + (Printf.sprintf + (f_ "No result for a choice list: %s") + str_lst) + in + choose_aux (List.rev lst) + + +end + + +# 292 "myocamlbuild.ml" +module BaseEnvLight = struct +(* # 22 "src/base/BaseEnvLight.ml" *) + + + module MapString = Map.Make(String) + + + type t = string MapString.t + + + let default_filename = + Filename.concat + (Sys.getcwd ()) + "setup.data" + + + let load ?(allow_empty=false) ?(filename=default_filename) () = + if Sys.file_exists filename then + begin + let chn = + open_in_bin filename + in + let st = + Stream.of_channel chn + in + let line = + ref 1 + in + let st_line = + Stream.from + (fun _ -> + try + match Stream.next st with + | '\n' -> incr line; Some '\n' + | c -> Some c + with Stream.Failure -> None) + in + let lexer = + Genlex.make_lexer ["="] st_line + in + let rec read_file mp = + match Stream.npeek 3 lexer with + | [Genlex.Ident nm; Genlex.Kwd "="; Genlex.String value] -> + Stream.junk lexer; + Stream.junk lexer; + Stream.junk lexer; + read_file (MapString.add nm value mp) + | [] -> + mp + | _ -> + failwith + (Printf.sprintf + "Malformed data file '%s' line %d" + filename !line) + in + let mp = + read_file MapString.empty + in + close_in chn; + mp + end + else if allow_empty then + begin + MapString.empty + end + else + begin + failwith + (Printf.sprintf + "Unable to load environment, the file '%s' doesn't exist." + filename) + end + + + let rec var_expand str env = + let buff = + Buffer.create ((String.length str) * 2) + in + Buffer.add_substitute + buff + (fun var -> + try + var_expand (MapString.find var env) env + with Not_found -> + failwith + (Printf.sprintf + "No variable %s defined when trying to expand %S." + var + str)) + str; + Buffer.contents buff + + + let var_get name env = + var_expand (MapString.find name env) env + + + let var_choose lst env = + OASISExpr.choose + (fun nm -> var_get nm env) + lst +end + + +# 397 "myocamlbuild.ml" +module MyOCamlbuildFindlib = struct +(* # 22 "src/plugins/ocamlbuild/MyOCamlbuildFindlib.ml" *) + + + (** OCamlbuild extension, copied from + * http://brion.inria.fr/gallium/index.php/Using_ocamlfind_with_ocamlbuild + * by N. Pouillard and others + * + * Updated on 2009/02/28 + * + * Modified by Sylvain Le Gall + *) + open Ocamlbuild_plugin + + type conf = + { no_automatic_syntax: bool; + } + + (* these functions are not really officially exported *) + let run_and_read = + Ocamlbuild_pack.My_unix.run_and_read + + + let blank_sep_strings = + Ocamlbuild_pack.Lexers.blank_sep_strings + + + let exec_from_conf exec = + let exec = + let env_filename = Pathname.basename BaseEnvLight.default_filename in + let env = BaseEnvLight.load ~filename:env_filename ~allow_empty:true () in + try + BaseEnvLight.var_get exec env + with Not_found -> + Printf.eprintf "W: Cannot get variable %s\n" exec; + exec + in + let fix_win32 str = + if Sys.os_type = "Win32" then begin + let buff = Buffer.create (String.length str) in + (* Adapt for windowsi, ocamlbuild + win32 has a hard time to handle '\\'. + *) + String.iter + (fun c -> Buffer.add_char buff (if c = '\\' then '/' else c)) + str; + Buffer.contents buff + end else begin + str + end + in + fix_win32 exec + + let split s ch = + let buf = Buffer.create 13 in + let x = ref [] in + let flush () = + x := (Buffer.contents buf) :: !x; + Buffer.clear buf + in + String.iter + (fun c -> + if c = ch then + flush () + else + Buffer.add_char buf c) + s; + flush (); + List.rev !x + + + let split_nl s = split s '\n' + + + let before_space s = + try + String.before s (String.index s ' ') + with Not_found -> s + + (* ocamlfind command *) + let ocamlfind x = S[Sh (exec_from_conf "ocamlfind"); x] + + (* This lists all supported packages. *) + let find_packages () = + List.map before_space (split_nl & run_and_read (exec_from_conf "ocamlfind" ^ " list")) + + + (* Mock to list available syntaxes. *) + let find_syntaxes () = ["camlp4o"; "camlp4r"] + + + let well_known_syntax = [ + "camlp4.quotations.o"; + "camlp4.quotations.r"; + "camlp4.exceptiontracer"; + "camlp4.extend"; + "camlp4.foldgenerator"; + "camlp4.listcomprehension"; + "camlp4.locationstripper"; + "camlp4.macro"; + "camlp4.mapgenerator"; + "camlp4.metagenerator"; + "camlp4.profiler"; + "camlp4.tracer" + ] + + + let dispatch conf = + function + | After_options -> + (* By using Before_options one let command line options have an higher + * priority on the contrary using After_options will guarantee to have + * the higher priority override default commands by ocamlfind ones *) + Options.ocamlc := ocamlfind & A"ocamlc"; + Options.ocamlopt := ocamlfind & A"ocamlopt"; + Options.ocamldep := ocamlfind & A"ocamldep"; + Options.ocamldoc := ocamlfind & A"ocamldoc"; + Options.ocamlmktop := ocamlfind & A"ocamlmktop"; + Options.ocamlmklib := ocamlfind & A"ocamlmklib" + + | After_rules -> + + (* When one link an OCaml library/binary/package, one should use + * -linkpkg *) + flag ["ocaml"; "link"; "program"] & A"-linkpkg"; + + if not (conf.no_automatic_syntax) then begin + (* For each ocamlfind package one inject the -package option when + * compiling, computing dependencies, generating documentation and + * linking. *) + List.iter + begin fun pkg -> + let base_args = [A"-package"; A pkg] in + (* TODO: consider how to really choose camlp4o or camlp4r. *) + let syn_args = [A"-syntax"; A "camlp4o"] in + let (args, pargs) = + (* Heuristic to identify syntax extensions: whether they end in + ".syntax"; some might not. + *) + if Filename.check_suffix pkg "syntax" || + List.mem pkg well_known_syntax then + (syn_args @ base_args, syn_args) + else + (base_args, []) + in + flag ["ocaml"; "compile"; "pkg_"^pkg] & S args; + flag ["ocaml"; "ocamldep"; "pkg_"^pkg] & S args; + flag ["ocaml"; "doc"; "pkg_"^pkg] & S args; + flag ["ocaml"; "link"; "pkg_"^pkg] & S base_args; + flag ["ocaml"; "infer_interface"; "pkg_"^pkg] & S args; + + (* TODO: Check if this is allowed for OCaml < 3.12.1 *) + flag ["ocaml"; "compile"; "package("^pkg^")"] & S pargs; + flag ["ocaml"; "ocamldep"; "package("^pkg^")"] & S pargs; + flag ["ocaml"; "doc"; "package("^pkg^")"] & S pargs; + flag ["ocaml"; "infer_interface"; "package("^pkg^")"] & S pargs; + end + (find_packages ()); + end; + + (* Like -package but for extensions syntax. Morover -syntax is useless + * when linking. *) + List.iter begin fun syntax -> + flag ["ocaml"; "compile"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; + flag ["ocaml"; "ocamldep"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; + flag ["ocaml"; "doc"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; + flag ["ocaml"; "infer_interface"; "syntax_"^syntax] & + S[A"-syntax"; A syntax]; + end (find_syntaxes ()); + + (* The default "thread" tag is not compatible with ocamlfind. + * Indeed, the default rules add the "threads.cma" or "threads.cmxa" + * options when using this tag. When using the "-linkpkg" option with + * ocamlfind, this module will then be added twice on the command line. + * + * To solve this, one approach is to add the "-thread" option when using + * the "threads" package using the previous plugin. + *) + flag ["ocaml"; "pkg_threads"; "compile"] (S[A "-thread"]); + flag ["ocaml"; "pkg_threads"; "doc"] (S[A "-I"; A "+threads"]); + flag ["ocaml"; "pkg_threads"; "link"] (S[A "-thread"]); + flag ["ocaml"; "pkg_threads"; "infer_interface"] (S[A "-thread"]); + flag ["ocaml"; "package(threads)"; "compile"] (S[A "-thread"]); + flag ["ocaml"; "package(threads)"; "doc"] (S[A "-I"; A "+threads"]); + flag ["ocaml"; "package(threads)"; "link"] (S[A "-thread"]); + flag ["ocaml"; "package(threads)"; "infer_interface"] (S[A "-thread"]); + + | _ -> + () +end + +module MyOCamlbuildBase = struct +(* # 22 "src/plugins/ocamlbuild/MyOCamlbuildBase.ml" *) + + + (** Base functions for writing myocamlbuild.ml + @author Sylvain Le Gall + *) + + + + + + open Ocamlbuild_plugin + module OC = Ocamlbuild_pack.Ocaml_compiler + + + type dir = string + type file = string + type name = string + type tag = string + + +(* # 62 "src/plugins/ocamlbuild/MyOCamlbuildBase.ml" *) + + + type t = + { + lib_ocaml: (name * dir list * string list) list; + lib_c: (name * dir * file list) list; + flags: (tag list * (spec OASISExpr.choices)) list; + (* Replace the 'dir: include' from _tags by a precise interdepends in + * directory. + *) + includes: (dir * dir list) list; + } + + + let env_filename = + Pathname.basename + BaseEnvLight.default_filename + + + let dispatch_combine lst = + fun e -> + List.iter + (fun dispatch -> dispatch e) + lst + + + let tag_libstubs nm = + "use_lib"^nm^"_stubs" + + + let nm_libstubs nm = + nm^"_stubs" + + + let dispatch t e = + let env = + BaseEnvLight.load + ~filename:env_filename + ~allow_empty:true + () + in + match e with + | Before_options -> + let no_trailing_dot s = + if String.length s >= 1 && s.[0] = '.' then + String.sub s 1 ((String.length s) - 1) + else + s + in + List.iter + (fun (opt, var) -> + try + opt := no_trailing_dot (BaseEnvLight.var_get var env) + with Not_found -> + Printf.eprintf "W: Cannot get variable %s\n" var) + [ + Options.ext_obj, "ext_obj"; + Options.ext_lib, "ext_lib"; + Options.ext_dll, "ext_dll"; + ] + + | After_rules -> + (* Declare OCaml libraries *) + List.iter + (function + | nm, [], intf_modules -> + ocaml_lib nm; + let cmis = + List.map (fun m -> (OASISString.uncapitalize_ascii m) ^ ".cmi") + intf_modules in + dep ["ocaml"; "link"; "library"; "file:"^nm^".cma"] cmis + | nm, dir :: tl, intf_modules -> + ocaml_lib ~dir:dir (dir^"/"^nm); + List.iter + (fun dir -> + List.iter + (fun str -> + flag ["ocaml"; "use_"^nm; str] (S[A"-I"; P dir])) + ["compile"; "infer_interface"; "doc"]) + tl; + let cmis = + List.map (fun m -> dir^"/"^(OASISString.uncapitalize_ascii m)^".cmi") + intf_modules in + dep ["ocaml"; "link"; "library"; "file:"^dir^"/"^nm^".cma"] + cmis) + t.lib_ocaml; + + (* Declare directories dependencies, replace "include" in _tags. *) + List.iter + (fun (dir, include_dirs) -> + Pathname.define_context dir include_dirs) + t.includes; + + (* Declare C libraries *) + List.iter + (fun (lib, dir, headers) -> + (* Handle C part of library *) + flag ["link"; "library"; "ocaml"; "byte"; tag_libstubs lib] + (S[A"-dllib"; A("-l"^(nm_libstubs lib)); A"-cclib"; + A("-l"^(nm_libstubs lib))]); + + flag ["link"; "library"; "ocaml"; "native"; tag_libstubs lib] + (S[A"-cclib"; A("-l"^(nm_libstubs lib))]); + + flag ["link"; "program"; "ocaml"; "byte"; tag_libstubs lib] + (S[A"-dllib"; A("dll"^(nm_libstubs lib))]); + + (* When ocaml link something that use the C library, then one + need that file to be up to date. + This holds both for programs and for libraries. + *) + dep ["link"; "ocaml"; tag_libstubs lib] + [dir/"lib"^(nm_libstubs lib)^"."^(!Options.ext_lib)]; + + dep ["compile"; "ocaml"; tag_libstubs lib] + [dir/"lib"^(nm_libstubs lib)^"."^(!Options.ext_lib)]; + + (* TODO: be more specific about what depends on headers *) + (* Depends on .h files *) + dep ["compile"; "c"] + headers; + + (* Setup search path for lib *) + flag ["link"; "ocaml"; "use_"^lib] + (S[A"-I"; P(dir)]); + ) + t.lib_c; + + (* Add flags *) + List.iter + (fun (tags, cond_specs) -> + let spec = BaseEnvLight.var_choose cond_specs env in + let rec eval_specs = + function + | S lst -> S (List.map eval_specs lst) + | A str -> A (BaseEnvLight.var_expand str env) + | spec -> spec + in + flag tags & (eval_specs spec)) + t.flags + | _ -> + () + + + let dispatch_default conf t = + dispatch_combine + [ + dispatch t; + MyOCamlbuildFindlib.dispatch conf; + ] + + +end + + +# 766 "myocamlbuild.ml" +open Ocamlbuild_plugin;; +let package_default = + { + MyOCamlbuildBase.lib_ocaml = + [("ocplib_endian", ["src"], []); ("bigstring", ["src"], [])]; + lib_c = []; + flags = []; + includes = [("tests", ["src"])] + } + ;; + +let conf = {MyOCamlbuildFindlib.no_automatic_syntax = false} + +let dispatch_default = MyOCamlbuildBase.dispatch_default conf package_default;; + +# 783 "myocamlbuild.ml" +(* OASIS_STOP *) +let has_safe_string = + try + let major = int_of_string (String.sub Sys.ocaml_version 0 1) in + let minor = int_of_string (String.sub Sys.ocaml_version 2 2) in + major >= 4 && minor >= 2 + with e -> + false + +(* https://github.com/mjambon/cppo/blob/master/ocamlbuild_plugin/ocamlbuild_cppo.ml + Add a dependency after dropping support for 4.01 and earlier. *) +let dispatch_cppo = function + | After_rules -> begin + let cppo_rules ext = + let dep = "%(name).cppo"-.-ext + and prod1 = "%(name: <*> and not <*.cppo>)"-.-ext + and prod2 = "%(name: <**/*> and not <**/*.cppo>)"-.-ext in + let cppo_rule prod env _build = + let dep = env dep in + let prod = env prod in + let tags = tags_of_pathname prod ++ "cppo" in + Cmd (S[A "cppo"; T tags; S [A "-o"; P prod]; P dep ]) + in + rule ("cppo: *.cppo."-.-ext^" -> *."-.-ext) ~dep ~prod:prod1 (cppo_rule prod1); + rule ("cppo: **/*.cppo."-.-ext^" -> **/*."-.-ext) ~dep ~prod:prod2 (cppo_rule prod2); + in + List.iter cppo_rules ["ml"; "mli"]; + + pflag ["cppo"] "cppo_D" (fun s -> S [A "-D"; A s]) ; + pflag ["cppo"] "cppo_U" (fun s -> S [A "-U"; A s]) ; + pflag ["cppo"] "cppo_I" (fun s -> + if Pathname.is_directory s then S [A "-I"; P s] + else S [A "-I"; P (Pathname.dirname s)] + ) ; + pdep ["cppo"] "cppo_I" (fun s -> + if Pathname.is_directory s then [] else [s]) ; + flag ["cppo"; "cppo_q"] (A "-q") ; + flag ["cppo"; "cppo_s"] (A "-s") ; + flag ["cppo"; "cppo_n"] (A "-n") ; + pflag ["cppo"] "cppo_x" (fun s -> S [A "-x"; A s]); + pflag ["cppo"] "cppo_V" (fun s -> S [A "-V"; A s]); + flag ["cppo"; "cppo_V_OCAML"] & S [A "-V"; A ("OCAML:" ^ Sys.ocaml_version)] + end + | _ -> () + +let () = + dispatch + (fun hook -> + dispatch_default hook; + dispatch_cppo hook; + match hook with + | After_rules -> + dep ["include_common"] + ["src"/"common.ml"; + "src"/"common_float.ml"; + "src"/"common_401.ml"; + "src"/"common_400.ml"]; + dep ["include_401"] + ["src"/"be_ocaml_401.ml"; + "src"/"le_ocaml_401.ml"; + "src"/"ne_ocaml_401.ml"]; + dep ["include_400"] + ["src"/"be_ocaml_400.ml"; + "src"/"le_ocaml_400.ml"; + "src"/"ne_ocaml_400.ml"]; + | _ -> + ()) diff --git a/setup.ml b/setup.ml new file mode 100644 index 0000000..9a7fcd2 --- /dev/null +++ b/setup.ml @@ -0,0 +1,7172 @@ +(* setup.ml generated for the first time by OASIS v0.3.0 *) + +(* OASIS_START *) +(* DO NOT EDIT (digest: 6fc07147e8f1ca4762a21ab844ef7dea) *) +(* + Regenerated by OASIS v0.4.6 + Visit http://oasis.forge.ocamlcore.org for more information and + documentation about functions used in this file. +*) +module OASISGettext = struct +(* # 22 "src/oasis/OASISGettext.ml" *) + + + let ns_ str = + str + + + let s_ str = + str + + + let f_ (str: ('a, 'b, 'c, 'd) format4) = + str + + + let fn_ fmt1 fmt2 n = + if n = 1 then + fmt1^^"" + else + fmt2^^"" + + + let init = + [] + + +end + +module OASISContext = struct +(* # 22 "src/oasis/OASISContext.ml" *) + + + open OASISGettext + + + type level = + [ `Debug + | `Info + | `Warning + | `Error] + + + type t = + { + (* TODO: replace this by a proplist. *) + quiet: bool; + info: bool; + debug: bool; + ignore_plugins: bool; + ignore_unknown_fields: bool; + printf: level -> string -> unit; + } + + + let printf lvl str = + let beg = + match lvl with + | `Error -> s_ "E: " + | `Warning -> s_ "W: " + | `Info -> s_ "I: " + | `Debug -> s_ "D: " + in + prerr_endline (beg^str) + + + let default = + ref + { + quiet = false; + info = false; + debug = false; + ignore_plugins = false; + ignore_unknown_fields = false; + printf = printf; + } + + + let quiet = + {!default with quiet = true} + + + let fspecs () = + (* TODO: don't act on default. *) + let ignore_plugins = ref false in + ["-quiet", + Arg.Unit (fun () -> default := {!default with quiet = true}), + s_ " Run quietly"; + + "-info", + Arg.Unit (fun () -> default := {!default with info = true}), + s_ " Display information message"; + + + "-debug", + Arg.Unit (fun () -> default := {!default with debug = true}), + s_ " Output debug message"; + + "-ignore-plugins", + Arg.Set ignore_plugins, + s_ " Ignore plugin's field."; + + "-C", + (* TODO: remove this chdir. *) + Arg.String (fun str -> Sys.chdir str), + s_ "dir Change directory before running."], + fun () -> {!default with ignore_plugins = !ignore_plugins} +end + +module OASISString = struct +(* # 22 "src/oasis/OASISString.ml" *) + + + (** Various string utilities. + + Mostly inspired by extlib and batteries ExtString and BatString libraries. + + @author Sylvain Le Gall + *) + + + let nsplitf str f = + if str = "" then + [] + else + let buf = Buffer.create 13 in + let lst = ref [] in + let push () = + lst := Buffer.contents buf :: !lst; + Buffer.clear buf + in + let str_len = String.length str in + for i = 0 to str_len - 1 do + if f str.[i] then + push () + else + Buffer.add_char buf str.[i] + done; + push (); + List.rev !lst + + + (** [nsplit c s] Split the string [s] at char [c]. It doesn't include the + separator. + *) + let nsplit str c = + nsplitf str ((=) c) + + + let find ~what ?(offset=0) str = + let what_idx = ref 0 in + let str_idx = ref offset in + while !str_idx < String.length str && + !what_idx < String.length what do + if str.[!str_idx] = what.[!what_idx] then + incr what_idx + else + what_idx := 0; + incr str_idx + done; + if !what_idx <> String.length what then + raise Not_found + else + !str_idx - !what_idx + + + let sub_start str len = + let str_len = String.length str in + if len >= str_len then + "" + else + String.sub str len (str_len - len) + + + let sub_end ?(offset=0) str len = + let str_len = String.length str in + if len >= str_len then + "" + else + String.sub str 0 (str_len - len) + + + let starts_with ~what ?(offset=0) str = + let what_idx = ref 0 in + let str_idx = ref offset in + let ok = ref true in + while !ok && + !str_idx < String.length str && + !what_idx < String.length what do + if str.[!str_idx] = what.[!what_idx] then + incr what_idx + else + ok := false; + incr str_idx + done; + if !what_idx = String.length what then + true + else + false + + + let strip_starts_with ~what str = + if starts_with ~what str then + sub_start str (String.length what) + else + raise Not_found + + + let ends_with ~what ?(offset=0) str = + let what_idx = ref ((String.length what) - 1) in + let str_idx = ref ((String.length str) - 1) in + let ok = ref true in + while !ok && + offset <= !str_idx && + 0 <= !what_idx do + if str.[!str_idx] = what.[!what_idx] then + decr what_idx + else + ok := false; + decr str_idx + done; + if !what_idx = -1 then + true + else + false + + + let strip_ends_with ~what str = + if ends_with ~what str then + sub_end str (String.length what) + else + raise Not_found + + + let replace_chars f s = + let buf = Buffer.create (String.length s) in + String.iter (fun c -> Buffer.add_char buf (f c)) s; + Buffer.contents buf + + let lowercase_ascii = + replace_chars + (fun c -> + if (c >= 'A' && c <= 'Z') then + Char.chr (Char.code c + 32) + else + c) + + let uncapitalize_ascii s = + if s <> "" then + (lowercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) + else + s + + let uppercase_ascii = + replace_chars + (fun c -> + if (c >= 'a' && c <= 'z') then + Char.chr (Char.code c - 32) + else + c) + + let capitalize_ascii s = + if s <> "" then + (uppercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) + else + s + +end + +module OASISUtils = struct +(* # 22 "src/oasis/OASISUtils.ml" *) + + + open OASISGettext + + + module MapExt = + struct + module type S = + sig + include Map.S + val add_list: 'a t -> (key * 'a) list -> 'a t + val of_list: (key * 'a) list -> 'a t + val to_list: 'a t -> (key * 'a) list + end + + module Make (Ord: Map.OrderedType) = + struct + include Map.Make(Ord) + + let rec add_list t = + function + | (k, v) :: tl -> add_list (add k v t) tl + | [] -> t + + let of_list lst = add_list empty lst + + let to_list t = fold (fun k v acc -> (k, v) :: acc) t [] + end + end + + + module MapString = MapExt.Make(String) + + + module SetExt = + struct + module type S = + sig + include Set.S + val add_list: t -> elt list -> t + val of_list: elt list -> t + val to_list: t -> elt list + end + + module Make (Ord: Set.OrderedType) = + struct + include Set.Make(Ord) + + let rec add_list t = + function + | e :: tl -> add_list (add e t) tl + | [] -> t + + let of_list lst = add_list empty lst + + let to_list = elements + end + end + + + module SetString = SetExt.Make(String) + + + let compare_csl s1 s2 = + String.compare (OASISString.lowercase_ascii s1) (OASISString.lowercase_ascii s2) + + + module HashStringCsl = + Hashtbl.Make + (struct + type t = string + let equal s1 s2 = (compare_csl s1 s2) = 0 + let hash s = Hashtbl.hash (OASISString.lowercase_ascii s) + end) + + module SetStringCsl = + SetExt.Make + (struct + type t = string + let compare = compare_csl + end) + + + let varname_of_string ?(hyphen='_') s = + if String.length s = 0 then + begin + invalid_arg "varname_of_string" + end + else + begin + let buf = + OASISString.replace_chars + (fun c -> + if ('a' <= c && c <= 'z') + || + ('A' <= c && c <= 'Z') + || + ('0' <= c && c <= '9') then + c + else + hyphen) + s; + in + let buf = + (* Start with a _ if digit *) + if '0' <= s.[0] && s.[0] <= '9' then + "_"^buf + else + buf + in + OASISString.lowercase_ascii buf + end + + + let varname_concat ?(hyphen='_') p s = + let what = String.make 1 hyphen in + let p = + try + OASISString.strip_ends_with ~what p + with Not_found -> + p + in + let s = + try + OASISString.strip_starts_with ~what s + with Not_found -> + s + in + p^what^s + + + let is_varname str = + str = varname_of_string str + + + let failwithf fmt = Printf.ksprintf failwith fmt + + +end + +module PropList = struct +(* # 22 "src/oasis/PropList.ml" *) + + + open OASISGettext + + + type name = string + + + exception Not_set of name * string option + exception No_printer of name + exception Unknown_field of name * name + + + let () = + Printexc.register_printer + (function + | Not_set (nm, Some rsn) -> + Some + (Printf.sprintf (f_ "Field '%s' is not set: %s") nm rsn) + | Not_set (nm, None) -> + Some + (Printf.sprintf (f_ "Field '%s' is not set") nm) + | No_printer nm -> + Some + (Printf.sprintf (f_ "No default printer for value %s") nm) + | Unknown_field (nm, schm) -> + Some + (Printf.sprintf + (f_ "Field %s is not defined in schema %s") nm schm) + | _ -> + None) + + + module Data = + struct + type t = + (name, unit -> unit) Hashtbl.t + + let create () = + Hashtbl.create 13 + + let clear t = + Hashtbl.clear t + + +(* # 78 "src/oasis/PropList.ml" *) + end + + + module Schema = + struct + type ('ctxt, 'extra) value = + { + get: Data.t -> string; + set: Data.t -> ?context:'ctxt -> string -> unit; + help: (unit -> string) option; + extra: 'extra; + } + + type ('ctxt, 'extra) t = + { + name: name; + fields: (name, ('ctxt, 'extra) value) Hashtbl.t; + order: name Queue.t; + name_norm: string -> string; + } + + let create ?(case_insensitive=false) nm = + { + name = nm; + fields = Hashtbl.create 13; + order = Queue.create (); + name_norm = + (if case_insensitive then + OASISString.lowercase_ascii + else + fun s -> s); + } + + let add t nm set get extra help = + let key = + t.name_norm nm + in + + if Hashtbl.mem t.fields key then + failwith + (Printf.sprintf + (f_ "Field '%s' is already defined in schema '%s'") + nm t.name); + Hashtbl.add + t.fields + key + { + set = set; + get = get; + help = help; + extra = extra; + }; + Queue.add nm t.order + + let mem t nm = + Hashtbl.mem t.fields nm + + let find t nm = + try + Hashtbl.find t.fields (t.name_norm nm) + with Not_found -> + raise (Unknown_field (nm, t.name)) + + let get t data nm = + (find t nm).get data + + let set t data nm ?context x = + (find t nm).set + data + ?context + x + + let fold f acc t = + Queue.fold + (fun acc k -> + let v = + find t k + in + f acc k v.extra v.help) + acc + t.order + + let iter f t = + fold + (fun () -> f) + () + t + + let name t = + t.name + end + + + module Field = + struct + type ('ctxt, 'value, 'extra) t = + { + set: Data.t -> ?context:'ctxt -> 'value -> unit; + get: Data.t -> 'value; + sets: Data.t -> ?context:'ctxt -> string -> unit; + gets: Data.t -> string; + help: (unit -> string) option; + extra: 'extra; + } + + let new_id = + let last_id = + ref 0 + in + fun () -> incr last_id; !last_id + + let create ?schema ?name ?parse ?print ?default ?update ?help extra = + (* Default value container *) + let v = + ref None + in + + (* If name is not given, create unique one *) + let nm = + match name with + | Some s -> s + | None -> Printf.sprintf "_anon_%d" (new_id ()) + in + + (* Last chance to get a value: the default *) + let default () = + match default with + | Some d -> d + | None -> raise (Not_set (nm, Some (s_ "no default value"))) + in + + (* Get data *) + let get data = + (* Get value *) + try + (Hashtbl.find data nm) (); + match !v with + | Some x -> x + | None -> default () + with Not_found -> + default () + in + + (* Set data *) + let set data ?context x = + let x = + match update with + | Some f -> + begin + try + f ?context (get data) x + with Not_set _ -> + x + end + | None -> + x + in + Hashtbl.replace + data + nm + (fun () -> v := Some x) + in + + (* Parse string value, if possible *) + let parse = + match parse with + | Some f -> + f + | None -> + fun ?context s -> + failwith + (Printf.sprintf + (f_ "Cannot parse field '%s' when setting value %S") + nm + s) + in + + (* Set data, from string *) + let sets data ?context s = + set ?context data (parse ?context s) + in + + (* Output value as string, if possible *) + let print = + match print with + | Some f -> + f + | None -> + fun _ -> raise (No_printer nm) + in + + (* Get data, as a string *) + let gets data = + print (get data) + in + + begin + match schema with + | Some t -> + Schema.add t nm sets gets extra help + | None -> + () + end; + + { + set = set; + get = get; + sets = sets; + gets = gets; + help = help; + extra = extra; + } + + let fset data t ?context x = + t.set data ?context x + + let fget data t = + t.get data + + let fsets data t ?context s = + t.sets data ?context s + + let fgets data t = + t.gets data + end + + + module FieldRO = + struct + let create ?schema ?name ?parse ?print ?default ?update ?help extra = + let fld = + Field.create ?schema ?name ?parse ?print ?default ?update ?help extra + in + fun data -> Field.fget data fld + end +end + +module OASISMessage = struct +(* # 22 "src/oasis/OASISMessage.ml" *) + + + open OASISGettext + open OASISContext + + + let generic_message ~ctxt lvl fmt = + let cond = + if ctxt.quiet then + false + else + match lvl with + | `Debug -> ctxt.debug + | `Info -> ctxt.info + | _ -> true + in + Printf.ksprintf + (fun str -> + if cond then + begin + ctxt.printf lvl str + end) + fmt + + + let debug ~ctxt fmt = + generic_message ~ctxt `Debug fmt + + + let info ~ctxt fmt = + generic_message ~ctxt `Info fmt + + + let warning ~ctxt fmt = + generic_message ~ctxt `Warning fmt + + + let error ~ctxt fmt = + generic_message ~ctxt `Error fmt + +end + +module OASISVersion = struct +(* # 22 "src/oasis/OASISVersion.ml" *) + + + open OASISGettext + + + + + + type s = string + + + type t = string + + + type comparator = + | VGreater of t + | VGreaterEqual of t + | VEqual of t + | VLesser of t + | VLesserEqual of t + | VOr of comparator * comparator + | VAnd of comparator * comparator + + + + (* Range of allowed characters *) + let is_digit c = + '0' <= c && c <= '9' + + + let is_alpha c = + ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') + + + let is_special = + function + | '.' | '+' | '-' | '~' -> true + | _ -> false + + + let rec version_compare v1 v2 = + if v1 <> "" || v2 <> "" then + begin + (* Compare ascii string, using special meaning for version + * related char + *) + let val_ascii c = + if c = '~' then -1 + else if is_digit c then 0 + else if c = '\000' then 0 + else if is_alpha c then Char.code c + else (Char.code c) + 256 + in + + let len1 = String.length v1 in + let len2 = String.length v2 in + + let p = ref 0 in + + (** Compare ascii part *) + let compare_vascii () = + let cmp = ref 0 in + while !cmp = 0 && + !p < len1 && !p < len2 && + not (is_digit v1.[!p] && is_digit v2.[!p]) do + cmp := (val_ascii v1.[!p]) - (val_ascii v2.[!p]); + incr p + done; + if !cmp = 0 && !p < len1 && !p = len2 then + val_ascii v1.[!p] + else if !cmp = 0 && !p = len1 && !p < len2 then + - (val_ascii v2.[!p]) + else + !cmp + in + + (** Compare digit part *) + let compare_digit () = + let extract_int v p = + let start_p = !p in + while !p < String.length v && is_digit v.[!p] do + incr p + done; + let substr = + String.sub v !p ((String.length v) - !p) + in + let res = + match String.sub v start_p (!p - start_p) with + | "" -> 0 + | s -> int_of_string s + in + res, substr + in + let i1, tl1 = extract_int v1 (ref !p) in + let i2, tl2 = extract_int v2 (ref !p) in + i1 - i2, tl1, tl2 + in + + match compare_vascii () with + | 0 -> + begin + match compare_digit () with + | 0, tl1, tl2 -> + if tl1 <> "" && is_digit tl1.[0] then + 1 + else if tl2 <> "" && is_digit tl2.[0] then + -1 + else + version_compare tl1 tl2 + | n, _, _ -> + n + end + | n -> + n + end + else + begin + 0 + end + + + let version_of_string str = str + + + let string_of_version t = t + + + let version_compare_string s1 s2 = + version_compare (version_of_string s1) (version_of_string s2) + + + let chop t = + try + let pos = + String.rindex t '.' + in + String.sub t 0 pos + with Not_found -> + t + + + let rec comparator_apply v op = + match op with + | VGreater cv -> + (version_compare v cv) > 0 + | VGreaterEqual cv -> + (version_compare v cv) >= 0 + | VLesser cv -> + (version_compare v cv) < 0 + | VLesserEqual cv -> + (version_compare v cv) <= 0 + | VEqual cv -> + (version_compare v cv) = 0 + | VOr (op1, op2) -> + (comparator_apply v op1) || (comparator_apply v op2) + | VAnd (op1, op2) -> + (comparator_apply v op1) && (comparator_apply v op2) + + + let rec string_of_comparator = + function + | VGreater v -> "> "^(string_of_version v) + | VEqual v -> "= "^(string_of_version v) + | VLesser v -> "< "^(string_of_version v) + | VGreaterEqual v -> ">= "^(string_of_version v) + | VLesserEqual v -> "<= "^(string_of_version v) + | VOr (c1, c2) -> + (string_of_comparator c1)^" || "^(string_of_comparator c2) + | VAnd (c1, c2) -> + (string_of_comparator c1)^" && "^(string_of_comparator c2) + + + let rec varname_of_comparator = + let concat p v = + OASISUtils.varname_concat + p + (OASISUtils.varname_of_string + (string_of_version v)) + in + function + | VGreater v -> concat "gt" v + | VLesser v -> concat "lt" v + | VEqual v -> concat "eq" v + | VGreaterEqual v -> concat "ge" v + | VLesserEqual v -> concat "le" v + | VOr (c1, c2) -> + (varname_of_comparator c1)^"_or_"^(varname_of_comparator c2) + | VAnd (c1, c2) -> + (varname_of_comparator c1)^"_and_"^(varname_of_comparator c2) + + + let rec comparator_ge v' = + let cmp v = version_compare v v' >= 0 in + function + | VEqual v + | VGreaterEqual v + | VGreater v -> cmp v + | VLesserEqual _ + | VLesser _ -> false + | VOr (c1, c2) -> comparator_ge v' c1 || comparator_ge v' c2 + | VAnd (c1, c2) -> comparator_ge v' c1 && comparator_ge v' c2 + + +end + +module OASISLicense = struct +(* # 22 "src/oasis/OASISLicense.ml" *) + + + (** License for _oasis fields + @author Sylvain Le Gall + *) + + + + + + type license = string + + + type license_exception = string + + + type license_version = + | Version of OASISVersion.t + | VersionOrLater of OASISVersion.t + | NoVersion + + + + type license_dep_5_unit = + { + license: license; + excption: license_exception option; + version: license_version; + } + + + + type license_dep_5 = + | DEP5Unit of license_dep_5_unit + | DEP5Or of license_dep_5 list + | DEP5And of license_dep_5 list + + + type t = + | DEP5License of license_dep_5 + | OtherLicense of string (* URL *) + + + +end + +module OASISExpr = struct +(* # 22 "src/oasis/OASISExpr.ml" *) + + + + + + open OASISGettext + + + type test = string + + + type flag = string + + + type t = + | EBool of bool + | ENot of t + | EAnd of t * t + | EOr of t * t + | EFlag of flag + | ETest of test * string + + + + type 'a choices = (t * 'a) list + + + let eval var_get t = + let rec eval' = + function + | EBool b -> + b + + | ENot e -> + not (eval' e) + + | EAnd (e1, e2) -> + (eval' e1) && (eval' e2) + + | EOr (e1, e2) -> + (eval' e1) || (eval' e2) + + | EFlag nm -> + let v = + var_get nm + in + assert(v = "true" || v = "false"); + (v = "true") + + | ETest (nm, vl) -> + let v = + var_get nm + in + (v = vl) + in + eval' t + + + let choose ?printer ?name var_get lst = + let rec choose_aux = + function + | (cond, vl) :: tl -> + if eval var_get cond then + vl + else + choose_aux tl + | [] -> + let str_lst = + if lst = [] then + s_ "" + else + String.concat + (s_ ", ") + (List.map + (fun (cond, vl) -> + match printer with + | Some p -> p vl + | None -> s_ "") + lst) + in + match name with + | Some nm -> + failwith + (Printf.sprintf + (f_ "No result for the choice list '%s': %s") + nm str_lst) + | None -> + failwith + (Printf.sprintf + (f_ "No result for a choice list: %s") + str_lst) + in + choose_aux (List.rev lst) + + +end + +module OASISText = struct +(* # 22 "src/oasis/OASISText.ml" *) + + + + type elt = + | Para of string + | Verbatim of string + | BlankLine + + + type t = elt list + +end + +module OASISTypes = struct +(* # 22 "src/oasis/OASISTypes.ml" *) + + + + + + type name = string + type package_name = string + type url = string + type unix_dirname = string + type unix_filename = string + type host_dirname = string + type host_filename = string + type prog = string + type arg = string + type args = string list + type command_line = (prog * arg list) + + + type findlib_name = string + type findlib_full = string + + + type compiled_object = + | Byte + | Native + | Best + + + + type dependency = + | FindlibPackage of findlib_full * OASISVersion.comparator option + | InternalLibrary of name + + + + type tool = + | ExternalTool of name + | InternalExecutable of name + + + + type vcs = + | Darcs + | Git + | Svn + | Cvs + | Hg + | Bzr + | Arch + | Monotone + | OtherVCS of url + + + + type plugin_kind = + [ `Configure + | `Build + | `Doc + | `Test + | `Install + | `Extra + ] + + + type plugin_data_purpose = + [ `Configure + | `Build + | `Install + | `Clean + | `Distclean + | `Install + | `Uninstall + | `Test + | `Doc + | `Extra + | `Other of string + ] + + + type 'a plugin = 'a * name * OASISVersion.t option + + + type all_plugin = plugin_kind plugin + + + type plugin_data = (all_plugin * plugin_data_purpose * (unit -> unit)) list + + +(* # 115 "src/oasis/OASISTypes.ml" *) + + + type 'a conditional = 'a OASISExpr.choices + + + type custom = + { + pre_command: (command_line option) conditional; + post_command: (command_line option) conditional; + } + + + + type common_section = + { + cs_name: name; + cs_data: PropList.Data.t; + cs_plugin_data: plugin_data; + } + + + + type build_section = + { + bs_build: bool conditional; + bs_install: bool conditional; + bs_path: unix_dirname; + bs_compiled_object: compiled_object; + bs_build_depends: dependency list; + bs_build_tools: tool list; + bs_c_sources: unix_filename list; + bs_data_files: (unix_filename * unix_filename option) list; + bs_ccopt: args conditional; + bs_cclib: args conditional; + bs_dlllib: args conditional; + bs_dllpath: args conditional; + bs_byteopt: args conditional; + bs_nativeopt: args conditional; + } + + + + type library = + { + lib_modules: string list; + lib_pack: bool; + lib_internal_modules: string list; + lib_findlib_parent: findlib_name option; + lib_findlib_name: findlib_name option; + lib_findlib_containers: findlib_name list; + } + + + type object_ = + { + obj_modules: string list; + obj_findlib_fullname: findlib_name list option; + } + + + type executable = + { + exec_custom: bool; + exec_main_is: unix_filename; + } + + + type flag = + { + flag_description: string option; + flag_default: bool conditional; + } + + + type source_repository = + { + src_repo_type: vcs; + src_repo_location: url; + src_repo_browser: url option; + src_repo_module: string option; + src_repo_branch: string option; + src_repo_tag: string option; + src_repo_subdir: unix_filename option; + } + + + type test = + { + test_type: [`Test] plugin; + test_command: command_line conditional; + test_custom: custom; + test_working_directory: unix_filename option; + test_run: bool conditional; + test_tools: tool list; + } + + + type doc_format = + | HTML of unix_filename + | DocText + | PDF + | PostScript + | Info of unix_filename + | DVI + | OtherDoc + + + + type doc = + { + doc_type: [`Doc] plugin; + doc_custom: custom; + doc_build: bool conditional; + doc_install: bool conditional; + doc_install_dir: unix_filename; + doc_title: string; + doc_authors: string list; + doc_abstract: string option; + doc_format: doc_format; + doc_data_files: (unix_filename * unix_filename option) list; + doc_build_tools: tool list; + } + + + type section = + | Library of common_section * build_section * library + | Object of common_section * build_section * object_ + | Executable of common_section * build_section * executable + | Flag of common_section * flag + | SrcRepo of common_section * source_repository + | Test of common_section * test + | Doc of common_section * doc + + + + type section_kind = + [ `Library | `Object | `Executable | `Flag | `SrcRepo | `Test | `Doc ] + + + type package = + { + oasis_version: OASISVersion.t; + ocaml_version: OASISVersion.comparator option; + findlib_version: OASISVersion.comparator option; + alpha_features: string list; + beta_features: string list; + name: package_name; + version: OASISVersion.t; + license: OASISLicense.t; + license_file: unix_filename option; + copyrights: string list; + maintainers: string list; + authors: string list; + homepage: url option; + synopsis: string; + description: OASISText.t option; + categories: url list; + + conf_type: [`Configure] plugin; + conf_custom: custom; + + build_type: [`Build] plugin; + build_custom: custom; + + install_type: [`Install] plugin; + install_custom: custom; + uninstall_custom: custom; + + clean_custom: custom; + distclean_custom: custom; + + files_ab: unix_filename list; + sections: section list; + plugins: [`Extra] plugin list; + disable_oasis_section: unix_filename list; + schema_data: PropList.Data.t; + plugin_data: plugin_data; + } + + +end + +module OASISFeatures = struct +(* # 22 "src/oasis/OASISFeatures.ml" *) + + open OASISTypes + open OASISUtils + open OASISGettext + open OASISVersion + + module MapPlugin = + Map.Make + (struct + type t = plugin_kind * name + let compare = Pervasives.compare + end) + + module Data = + struct + type t = + { + oasis_version: OASISVersion.t; + plugin_versions: OASISVersion.t option MapPlugin.t; + alpha_features: string list; + beta_features: string list; + } + + let create oasis_version alpha_features beta_features = + { + oasis_version = oasis_version; + plugin_versions = MapPlugin.empty; + alpha_features = alpha_features; + beta_features = beta_features + } + + let of_package pkg = + create + pkg.OASISTypes.oasis_version + pkg.OASISTypes.alpha_features + pkg.OASISTypes.beta_features + + let add_plugin (plugin_kind, plugin_name, plugin_version) t = + {t with + plugin_versions = MapPlugin.add + (plugin_kind, plugin_name) + plugin_version + t.plugin_versions} + + let plugin_version plugin_kind plugin_name t = + MapPlugin.find (plugin_kind, plugin_name) t.plugin_versions + + let to_string t = + Printf.sprintf + "oasis_version: %s; alpha_features: %s; beta_features: %s; \ + plugins_version: %s" + (OASISVersion.string_of_version t.oasis_version) + (String.concat ", " t.alpha_features) + (String.concat ", " t.beta_features) + (String.concat ", " + (MapPlugin.fold + (fun (_, plg) ver_opt acc -> + (plg^ + (match ver_opt with + | Some v -> + " "^(OASISVersion.string_of_version v) + | None -> "")) + :: acc) + t.plugin_versions [])) + end + + type origin = + | Field of string * string + | Section of string + | NoOrigin + + type stage = Alpha | Beta + + + let string_of_stage = + function + | Alpha -> "alpha" + | Beta -> "beta" + + + let field_of_stage = + function + | Alpha -> "AlphaFeatures" + | Beta -> "BetaFeatures" + + type publication = InDev of stage | SinceVersion of OASISVersion.t + + type t = + { + name: string; + plugin: all_plugin option; + publication: publication; + description: unit -> string; + } + + (* TODO: mutex protect this. *) + let all_features = Hashtbl.create 13 + + + let since_version ver_str = SinceVersion (version_of_string ver_str) + let alpha = InDev Alpha + let beta = InDev Beta + + + let to_string t = + Printf.sprintf + "feature: %s; plugin: %s; publication: %s" + t.name + (match t.plugin with + | None -> "" + | Some (_, nm, _) -> nm) + (match t.publication with + | InDev stage -> string_of_stage stage + | SinceVersion ver -> ">= "^(OASISVersion.string_of_version ver)) + + let data_check t data origin = + let no_message = "no message" in + + let check_feature features stage = + let has_feature = List.mem t.name features in + if not has_feature then + match origin with + | Field (fld, where) -> + Some + (Printf.sprintf + (f_ "Field %s in %s is only available when feature %s \ + is in field %s.") + fld where t.name (field_of_stage stage)) + | Section sct -> + Some + (Printf.sprintf + (f_ "Section %s is only available when features %s \ + is in field %s.") + sct t.name (field_of_stage stage)) + | NoOrigin -> + Some no_message + else + None + in + + let version_is_good ~min_version version fmt = + let version_is_good = + OASISVersion.comparator_apply + version (OASISVersion.VGreaterEqual min_version) + in + Printf.ksprintf + (fun str -> + if version_is_good then + None + else + Some str) + fmt + in + + match origin, t.plugin, t.publication with + | _, _, InDev Alpha -> check_feature data.Data.alpha_features Alpha + | _, _, InDev Beta -> check_feature data.Data.beta_features Beta + | Field(fld, where), None, SinceVersion min_version -> + version_is_good ~min_version data.Data.oasis_version + (f_ "Field %s in %s is only valid since OASIS v%s, update \ + OASISFormat field from '%s' to '%s' after checking \ + OASIS changelog.") + fld where (string_of_version min_version) + (string_of_version data.Data.oasis_version) + (string_of_version min_version) + + | Field(fld, where), Some(plugin_knd, plugin_name, _), + SinceVersion min_version -> + begin + try + let plugin_version_current = + try + match Data.plugin_version plugin_knd plugin_name data with + | Some ver -> ver + | None -> + failwithf + (f_ "Field %s in %s is only valid for the OASIS \ + plugin %s since v%s, but no plugin version is \ + defined in the _oasis file, change '%s' to \ + '%s (%s)' in your _oasis file.") + fld where plugin_name (string_of_version min_version) + plugin_name + plugin_name (string_of_version min_version) + with Not_found -> + failwithf + (f_ "Field %s in %s is only valid when the OASIS plugin %s \ + is defined.") + fld where plugin_name + in + version_is_good ~min_version plugin_version_current + (f_ "Field %s in %s is only valid for the OASIS plugin %s \ + since v%s, update your plugin from '%s (%s)' to \ + '%s (%s)' after checking the plugin's changelog.") + fld where plugin_name (string_of_version min_version) + plugin_name (string_of_version plugin_version_current) + plugin_name (string_of_version min_version) + with Failure msg -> + Some msg + end + + | Section sct, None, SinceVersion min_version -> + version_is_good ~min_version data.Data.oasis_version + (f_ "Section %s is only valid for since OASIS v%s, update \ + OASISFormat field from '%s' to '%s' after checking OASIS \ + changelog.") + sct (string_of_version min_version) + (string_of_version data.Data.oasis_version) + (string_of_version min_version) + + | Section sct, Some(plugin_knd, plugin_name, _), + SinceVersion min_version -> + begin + try + let plugin_version_current = + try + match Data.plugin_version plugin_knd plugin_name data with + | Some ver -> ver + | None -> + failwithf + (f_ "Section %s is only valid for the OASIS \ + plugin %s since v%s, but no plugin version is \ + defined in the _oasis file, change '%s' to \ + '%s (%s)' in your _oasis file.") + sct plugin_name (string_of_version min_version) + plugin_name + plugin_name (string_of_version min_version) + with Not_found -> + failwithf + (f_ "Section %s is only valid when the OASIS plugin %s \ + is defined.") + sct plugin_name + in + version_is_good ~min_version plugin_version_current + (f_ "Section %s is only valid for the OASIS plugin %s \ + since v%s, update your plugin from '%s (%s)' to \ + '%s (%s)' after checking the plugin's changelog.") + sct plugin_name (string_of_version min_version) + plugin_name (string_of_version plugin_version_current) + plugin_name (string_of_version min_version) + with Failure msg -> + Some msg + end + + | NoOrigin, None, SinceVersion min_version -> + version_is_good ~min_version data.Data.oasis_version "%s" no_message + + | NoOrigin, Some(plugin_knd, plugin_name, _), SinceVersion min_version -> + begin + try + let plugin_version_current = + match Data.plugin_version plugin_knd plugin_name data with + | Some ver -> ver + | None -> raise Not_found + in + version_is_good ~min_version plugin_version_current + "%s" no_message + with Not_found -> + Some no_message + end + + + let data_assert t data origin = + match data_check t data origin with + | None -> () + | Some str -> failwith str + + + let data_test t data = + match data_check t data NoOrigin with + | None -> true + | Some str -> false + + + let package_test t pkg = + data_test t (Data.of_package pkg) + + + let create ?plugin name publication description = + let () = + if Hashtbl.mem all_features name then + failwithf "Feature '%s' is already declared." name + in + let t = + { + name = name; + plugin = plugin; + publication = publication; + description = description; + } + in + Hashtbl.add all_features name t; + t + + + let get_stage name = + try + (Hashtbl.find all_features name).publication + with Not_found -> + failwithf (f_ "Feature %s doesn't exist.") name + + + let list () = + Hashtbl.fold (fun _ v acc -> v :: acc) all_features [] + + (* + * Real flags. + *) + + + let features = + create "features_fields" + (since_version "0.4") + (fun () -> + s_ "Enable to experiment not yet official features.") + + + let flag_docs = + create "flag_docs" + (since_version "0.3") + (fun () -> + s_ "Building docs require '-docs' flag at configure.") + + + let flag_tests = + create "flag_tests" + (since_version "0.3") + (fun () -> + s_ "Running tests require '-tests' flag at configure.") + + + let pack = + create "pack" + (since_version "0.3") + (fun () -> + s_ "Allow to create packed library.") + + + let section_object = + create "section_object" beta + (fun () -> + s_ "Implement an object section.") + + + let dynrun_for_release = + create "dynrun_for_release" alpha + (fun () -> + s_ "Make '-setup-update dynamic' suitable for releasing project.") + + + let compiled_setup_ml = + create "compiled_setup_ml" alpha + (fun () -> + s_ "It compiles the setup.ml and speed-up actions done with it.") + + let disable_oasis_section = + create "disable_oasis_section" alpha + (fun () -> + s_ "Allows the OASIS section comments and digest to be omitted in \ + generated files.") + + let no_automatic_syntax = + create "no_automatic_syntax" alpha + (fun () -> + s_ "Disable the automatic inclusion of -syntax camlp4o for packages \ + that matches the internal heuristic (if a dependency ends with \ + a .syntax or is a well known syntax).") +end + +module OASISUnixPath = struct +(* # 22 "src/oasis/OASISUnixPath.ml" *) + + + type unix_filename = string + type unix_dirname = string + + + type host_filename = string + type host_dirname = string + + + let current_dir_name = "." + + + let parent_dir_name = ".." + + + let is_current_dir fn = + fn = current_dir_name || fn = "" + + + let concat f1 f2 = + if is_current_dir f1 then + f2 + else + let f1' = + try OASISString.strip_ends_with ~what:"/" f1 with Not_found -> f1 + in + f1'^"/"^f2 + + + let make = + function + | hd :: tl -> + List.fold_left + (fun f p -> concat f p) + hd + tl + | [] -> + invalid_arg "OASISUnixPath.make" + + + let dirname f = + try + String.sub f 0 (String.rindex f '/') + with Not_found -> + current_dir_name + + + let basename f = + try + let pos_start = + (String.rindex f '/') + 1 + in + String.sub f pos_start ((String.length f) - pos_start) + with Not_found -> + f + + + let chop_extension f = + try + let last_dot = + String.rindex f '.' + in + let sub = + String.sub f 0 last_dot + in + try + let last_slash = + String.rindex f '/' + in + if last_slash < last_dot then + sub + else + f + with Not_found -> + sub + + with Not_found -> + f + + + let capitalize_file f = + let dir = dirname f in + let base = basename f in + concat dir (OASISString.capitalize_ascii base) + + + let uncapitalize_file f = + let dir = dirname f in + let base = basename f in + concat dir (OASISString.uncapitalize_ascii base) + + +end + +module OASISHostPath = struct +(* # 22 "src/oasis/OASISHostPath.ml" *) + + + open Filename + + + module Unix = OASISUnixPath + + + let make = + function + | [] -> + invalid_arg "OASISHostPath.make" + | hd :: tl -> + List.fold_left Filename.concat hd tl + + + let of_unix ufn = + if Sys.os_type = "Unix" then + ufn + else + make + (List.map + (fun p -> + if p = Unix.current_dir_name then + current_dir_name + else if p = Unix.parent_dir_name then + parent_dir_name + else + p) + (OASISString.nsplit ufn '/')) + + +end + +module OASISSection = struct +(* # 22 "src/oasis/OASISSection.ml" *) + + + open OASISTypes + + + let section_kind_common = + function + | Library (cs, _, _) -> + `Library, cs + | Object (cs, _, _) -> + `Object, cs + | Executable (cs, _, _) -> + `Executable, cs + | Flag (cs, _) -> + `Flag, cs + | SrcRepo (cs, _) -> + `SrcRepo, cs + | Test (cs, _) -> + `Test, cs + | Doc (cs, _) -> + `Doc, cs + + + let section_common sct = + snd (section_kind_common sct) + + + let section_common_set cs = + function + | Library (_, bs, lib) -> Library (cs, bs, lib) + | Object (_, bs, obj) -> Object (cs, bs, obj) + | Executable (_, bs, exec) -> Executable (cs, bs, exec) + | Flag (_, flg) -> Flag (cs, flg) + | SrcRepo (_, src_repo) -> SrcRepo (cs, src_repo) + | Test (_, tst) -> Test (cs, tst) + | Doc (_, doc) -> Doc (cs, doc) + + + (** Key used to identify section + *) + let section_id sct = + let k, cs = + section_kind_common sct + in + k, cs.cs_name + + + let string_of_section sct = + let k, nm = + section_id sct + in + (match k with + | `Library -> "library" + | `Object -> "object" + | `Executable -> "executable" + | `Flag -> "flag" + | `SrcRepo -> "src repository" + | `Test -> "test" + | `Doc -> "doc") + ^" "^nm + + + let section_find id scts = + List.find + (fun sct -> id = section_id sct) + scts + + + module CSection = + struct + type t = section + + let id = section_id + + let compare t1 t2 = + compare (id t1) (id t2) + + let equal t1 t2 = + (id t1) = (id t2) + + let hash t = + Hashtbl.hash (id t) + end + + + module MapSection = Map.Make(CSection) + module SetSection = Set.Make(CSection) + + +end + +module OASISBuildSection = struct +(* # 22 "src/oasis/OASISBuildSection.ml" *) + + +end + +module OASISExecutable = struct +(* # 22 "src/oasis/OASISExecutable.ml" *) + + + open OASISTypes + + + let unix_exec_is (cs, bs, exec) is_native ext_dll suffix_program = + let dir = + OASISUnixPath.concat + bs.bs_path + (OASISUnixPath.dirname exec.exec_main_is) + in + let is_native_exec = + match bs.bs_compiled_object with + | Native -> true + | Best -> is_native () + | Byte -> false + in + + OASISUnixPath.concat + dir + (cs.cs_name^(suffix_program ())), + + if not is_native_exec && + not exec.exec_custom && + bs.bs_c_sources <> [] then + Some (dir^"/dll"^cs.cs_name^"_stubs"^(ext_dll ())) + else + None + + +end + +module OASISLibrary = struct +(* # 22 "src/oasis/OASISLibrary.ml" *) + + + open OASISTypes + open OASISUtils + open OASISGettext + open OASISSection + + + (* Look for a module file, considering capitalization or not. *) + let find_module source_file_exists bs modul = + let possible_base_fn = + List.map + (OASISUnixPath.concat bs.bs_path) + [modul; + OASISUnixPath.uncapitalize_file modul; + OASISUnixPath.capitalize_file modul] + in + (* TODO: we should be able to be able to determine the source for every + * files. Hence we should introduce a Module(source: fn) for the fields + * Modules and InternalModules + *) + List.fold_left + (fun acc base_fn -> + match acc with + | `No_sources _ -> + begin + let file_found = + List.fold_left + (fun acc ext -> + if source_file_exists (base_fn^ext) then + (base_fn^ext) :: acc + else + acc) + [] + [".ml"; ".mli"; ".mll"; ".mly"] + in + match file_found with + | [] -> + acc + | lst -> + `Sources (base_fn, lst) + end + | `Sources _ -> + acc) + (`No_sources possible_base_fn) + possible_base_fn + + + let source_unix_files ~ctxt (cs, bs, lib) source_file_exists = + List.fold_left + (fun acc modul -> + match find_module source_file_exists bs modul with + | `Sources (base_fn, lst) -> + (base_fn, lst) :: acc + | `No_sources _ -> + OASISMessage.warning + ~ctxt + (f_ "Cannot find source file matching \ + module '%s' in library %s") + modul cs.cs_name; + acc) + [] + (lib.lib_modules @ lib.lib_internal_modules) + + + let generated_unix_files + ~ctxt + ~is_native + ~has_native_dynlink + ~ext_lib + ~ext_dll + ~source_file_exists + (cs, bs, lib) = + + let find_modules lst ext = + let find_module modul = + match find_module source_file_exists bs modul with + | `Sources (base_fn, [fn]) when ext <> "cmi" + && Filename.check_suffix fn ".mli" -> + None (* No implementation files for pure interface. *) + | `Sources (base_fn, _) -> + Some [base_fn] + | `No_sources lst -> + OASISMessage.warning + ~ctxt + (f_ "Cannot find source file matching \ + module '%s' in library %s") + modul cs.cs_name; + Some lst + in + List.fold_left + (fun acc nm -> + match find_module nm with + | None -> acc + | Some base_fns -> + List.map (fun base_fn -> base_fn ^"."^ext) base_fns :: acc) + [] + lst + in + + (* The .cmx that be compiled along *) + let cmxs = + let should_be_built = + match bs.bs_compiled_object with + | Native -> true + | Best -> is_native + | Byte -> false + in + if should_be_built then + if lib.lib_pack then + find_modules + [cs.cs_name] + "cmx" + else + find_modules + (lib.lib_modules @ lib.lib_internal_modules) + "cmx" + else + [] + in + + let acc_nopath = + [] + in + + (* The headers and annot/cmt files that should be compiled along *) + let headers = + let sufx = + if lib.lib_pack + then [".cmti"; ".cmt"; ".annot"] + else [".cmi"; ".cmti"; ".cmt"; ".annot"] + in + List.map + begin + List.fold_left + begin fun accu s -> + let dot = String.rindex s '.' in + let base = String.sub s 0 dot in + List.map ((^) base) sufx @ accu + end + [] + end + (find_modules lib.lib_modules "cmi") + in + + (* Compute what libraries should be built *) + let acc_nopath = + (* Add the packed header file if required *) + let add_pack_header acc = + if lib.lib_pack then + [cs.cs_name^".cmi"; cs.cs_name^".cmti"; cs.cs_name^".cmt"] :: acc + else + acc + in + let byte acc = + add_pack_header ([cs.cs_name^".cma"] :: acc) + in + let native acc = + let acc = + add_pack_header + (if has_native_dynlink then + [cs.cs_name^".cmxs"] :: acc + else acc) + in + [cs.cs_name^".cmxa"] :: [cs.cs_name^ext_lib] :: acc + in + match bs.bs_compiled_object with + | Native -> + byte (native acc_nopath) + | Best when is_native -> + byte (native acc_nopath) + | Byte | Best -> + byte acc_nopath + in + + (* Add C library to be built *) + let acc_nopath = + if bs.bs_c_sources <> [] then + begin + ["lib"^cs.cs_name^"_stubs"^ext_lib] + :: + ["dll"^cs.cs_name^"_stubs"^ext_dll] + :: + acc_nopath + end + else + acc_nopath + in + + (* All the files generated *) + List.rev_append + (List.rev_map + (List.rev_map + (OASISUnixPath.concat bs.bs_path)) + acc_nopath) + (headers @ cmxs) + + +end + +module OASISObject = struct +(* # 22 "src/oasis/OASISObject.ml" *) + + + open OASISTypes + open OASISGettext + + + let source_unix_files ~ctxt (cs, bs, obj) source_file_exists = + List.fold_left + (fun acc modul -> + match OASISLibrary.find_module source_file_exists bs modul with + | `Sources (base_fn, lst) -> + (base_fn, lst) :: acc + | `No_sources _ -> + OASISMessage.warning + ~ctxt + (f_ "Cannot find source file matching \ + module '%s' in object %s") + modul cs.cs_name; + acc) + [] + obj.obj_modules + + + let generated_unix_files + ~ctxt + ~is_native + ~source_file_exists + (cs, bs, obj) = + + let find_module ext modul = + match OASISLibrary.find_module source_file_exists bs modul with + | `Sources (base_fn, _) -> [base_fn ^ ext] + | `No_sources lst -> + OASISMessage.warning + ~ctxt + (f_ "Cannot find source file matching \ + module '%s' in object %s") + modul cs.cs_name ; + lst + in + + let header, byte, native, c_object, f = + match obj.obj_modules with + | [ m ] -> (find_module ".cmi" m, + find_module ".cmo" m, + find_module ".cmx" m, + find_module ".o" m, + fun x -> x) + | _ -> ([cs.cs_name ^ ".cmi"], + [cs.cs_name ^ ".cmo"], + [cs.cs_name ^ ".cmx"], + [cs.cs_name ^ ".o"], + OASISUnixPath.concat bs.bs_path) + in + List.map (List.map f) ( + match bs.bs_compiled_object with + | Native -> + native :: c_object :: byte :: header :: [] + | Best when is_native -> + native :: c_object :: byte :: header :: [] + | Byte | Best -> + byte :: header :: []) + + +end + +module OASISFindlib = struct +(* # 22 "src/oasis/OASISFindlib.ml" *) + + + open OASISTypes + open OASISUtils + open OASISGettext + open OASISSection + + + type library_name = name + type findlib_part_name = name + type 'a map_of_findlib_part_name = 'a OASISUtils.MapString.t + + + exception InternalLibraryNotFound of library_name + exception FindlibPackageNotFound of findlib_name + + + type group_t = + | Container of findlib_name * group_t list + | Package of (findlib_name * + common_section * + build_section * + [`Library of library | `Object of object_] * + group_t list) + + + type data = common_section * + build_section * + [`Library of library | `Object of object_] + type tree = + | Node of (data option) * (tree MapString.t) + | Leaf of data + + + let findlib_mapping pkg = + (* Map from library name to either full findlib name or parts + parent. *) + let fndlb_parts_of_lib_name = + let fndlb_parts cs lib = + let name = + match lib.lib_findlib_name with + | Some nm -> nm + | None -> cs.cs_name + in + let name = + String.concat "." (lib.lib_findlib_containers @ [name]) + in + name + in + List.fold_left + (fun mp -> + function + | Library (cs, _, lib) -> + begin + let lib_name = cs.cs_name in + let fndlb_parts = fndlb_parts cs lib in + if MapString.mem lib_name mp then + failwithf + (f_ "The library name '%s' is used more than once.") + lib_name; + match lib.lib_findlib_parent with + | Some lib_name_parent -> + MapString.add + lib_name + (`Unsolved (lib_name_parent, fndlb_parts)) + mp + | None -> + MapString.add + lib_name + (`Solved fndlb_parts) + mp + end + + | Object (cs, _, obj) -> + begin + let obj_name = cs.cs_name in + if MapString.mem obj_name mp then + failwithf + (f_ "The object name '%s' is used more than once.") + obj_name; + let findlib_full_name = match obj.obj_findlib_fullname with + | Some ns -> String.concat "." ns + | None -> obj_name + in + MapString.add + obj_name + (`Solved findlib_full_name) + mp + end + + | Executable _ | Test _ | Flag _ | SrcRepo _ | Doc _ -> + mp) + MapString.empty + pkg.sections + in + + (* Solve the above graph to be only library name to full findlib name. *) + let fndlb_name_of_lib_name = + let rec solve visited mp lib_name lib_name_child = + if SetString.mem lib_name visited then + failwithf + (f_ "Library '%s' is involved in a cycle \ + with regard to findlib naming.") + lib_name; + let visited = SetString.add lib_name visited in + try + match MapString.find lib_name mp with + | `Solved fndlb_nm -> + fndlb_nm, mp + | `Unsolved (lib_nm_parent, post_fndlb_nm) -> + let pre_fndlb_nm, mp = + solve visited mp lib_nm_parent lib_name + in + let fndlb_nm = pre_fndlb_nm^"."^post_fndlb_nm in + fndlb_nm, MapString.add lib_name (`Solved fndlb_nm) mp + with Not_found -> + failwithf + (f_ "Library '%s', which is defined as the findlib parent of \ + library '%s', doesn't exist.") + lib_name lib_name_child + in + let mp = + MapString.fold + (fun lib_name status mp -> + match status with + | `Solved _ -> + (* Solved initialy, no need to go further *) + mp + | `Unsolved _ -> + let _, mp = solve SetString.empty mp lib_name "" in + mp) + fndlb_parts_of_lib_name + fndlb_parts_of_lib_name + in + MapString.map + (function + | `Solved fndlb_nm -> fndlb_nm + | `Unsolved _ -> assert false) + mp + in + + (* Convert an internal library name to a findlib name. *) + let findlib_name_of_library_name lib_nm = + try + MapString.find lib_nm fndlb_name_of_lib_name + with Not_found -> + raise (InternalLibraryNotFound lib_nm) + in + + (* Add a library to the tree. + *) + let add sct mp = + let fndlb_fullname = + let cs, _, _ = sct in + let lib_name = cs.cs_name in + findlib_name_of_library_name lib_name + in + let rec add_children nm_lst (children: tree MapString.t) = + match nm_lst with + | (hd :: tl) -> + begin + let node = + try + add_node tl (MapString.find hd children) + with Not_found -> + (* New node *) + new_node tl + in + MapString.add hd node children + end + | [] -> + (* Should not have a nameless library. *) + assert false + and add_node tl node = + if tl = [] then + begin + match node with + | Node (None, children) -> + Node (Some sct, children) + | Leaf (cs', _, _) | Node (Some (cs', _, _), _) -> + (* TODO: allow to merge Package, i.e. + * archive(byte) = "foo.cma foo_init.cmo" + *) + let cs, _, _ = sct in + failwithf + (f_ "Library '%s' and '%s' have the same findlib name '%s'") + cs.cs_name cs'.cs_name fndlb_fullname + end + else + begin + match node with + | Leaf data -> + Node (Some data, add_children tl MapString.empty) + | Node (data_opt, children) -> + Node (data_opt, add_children tl children) + end + and new_node = + function + | [] -> + Leaf sct + | hd :: tl -> + Node (None, MapString.add hd (new_node tl) MapString.empty) + in + add_children (OASISString.nsplit fndlb_fullname '.') mp + in + + let rec group_of_tree mp = + MapString.fold + (fun nm node acc -> + let cur = + match node with + | Node (Some (cs, bs, lib), children) -> + Package (nm, cs, bs, lib, group_of_tree children) + | Node (None, children) -> + Container (nm, group_of_tree children) + | Leaf (cs, bs, lib) -> + Package (nm, cs, bs, lib, []) + in + cur :: acc) + mp [] + in + + let group_mp = + List.fold_left + (fun mp -> + function + | Library (cs, bs, lib) -> + add (cs, bs, `Library lib) mp + | Object (cs, bs, obj) -> + add (cs, bs, `Object obj) mp + | _ -> + mp) + MapString.empty + pkg.sections + in + + let groups = + group_of_tree group_mp + in + + let library_name_of_findlib_name = + lazy begin + (* Revert findlib_name_of_library_name. *) + MapString.fold + (fun k v mp -> MapString.add v k mp) + fndlb_name_of_lib_name + MapString.empty + end + in + let library_name_of_findlib_name fndlb_nm = + try + MapString.find fndlb_nm (Lazy.force library_name_of_findlib_name) + with Not_found -> + raise (FindlibPackageNotFound fndlb_nm) + in + + groups, + findlib_name_of_library_name, + library_name_of_findlib_name + + + let findlib_of_group = + function + | Container (fndlb_nm, _) + | Package (fndlb_nm, _, _, _, _) -> fndlb_nm + + + let root_of_group grp = + let rec root_lib_aux = + (* We do a DFS in the group. *) + function + | Container (_, children) -> + List.fold_left + (fun res grp -> + if res = None then + root_lib_aux grp + else + res) + None + children + | Package (_, cs, bs, lib, _) -> + Some (cs, bs, lib) + in + match root_lib_aux grp with + | Some res -> + res + | None -> + failwithf + (f_ "Unable to determine root library of findlib library '%s'") + (findlib_of_group grp) + + +end + +module OASISFlag = struct +(* # 22 "src/oasis/OASISFlag.ml" *) + + +end + +module OASISPackage = struct +(* # 22 "src/oasis/OASISPackage.ml" *) + + +end + +module OASISSourceRepository = struct +(* # 22 "src/oasis/OASISSourceRepository.ml" *) + + +end + +module OASISTest = struct +(* # 22 "src/oasis/OASISTest.ml" *) + + +end + +module OASISDocument = struct +(* # 22 "src/oasis/OASISDocument.ml" *) + + +end + +module OASISExec = struct +(* # 22 "src/oasis/OASISExec.ml" *) + + + open OASISGettext + open OASISUtils + open OASISMessage + + + (* TODO: I don't like this quote, it is there because $(rm) foo expands to + * 'rm -f' foo... + *) + let run ~ctxt ?f_exit_code ?(quote=true) cmd args = + let cmd = + if quote then + if Sys.os_type = "Win32" then + if String.contains cmd ' ' then + (* Double the 1st double quote... win32... sigh *) + "\""^(Filename.quote cmd) + else + cmd + else + Filename.quote cmd + else + cmd + in + let cmdline = + String.concat " " (cmd :: args) + in + info ~ctxt (f_ "Running command '%s'") cmdline; + match f_exit_code, Sys.command cmdline with + | None, 0 -> () + | None, i -> + failwithf + (f_ "Command '%s' terminated with error code %d") + cmdline i + | Some f, i -> + f i + + + let run_read_output ~ctxt ?f_exit_code cmd args = + let fn = + Filename.temp_file "oasis-" ".txt" + in + try + begin + let () = + run ~ctxt ?f_exit_code cmd (args @ [">"; Filename.quote fn]) + in + let chn = + open_in fn + in + let routput = + ref [] + in + begin + try + while true do + routput := (input_line chn) :: !routput + done + with End_of_file -> + () + end; + close_in chn; + Sys.remove fn; + List.rev !routput + end + with e -> + (try Sys.remove fn with _ -> ()); + raise e + + + let run_read_one_line ~ctxt ?f_exit_code cmd args = + match run_read_output ~ctxt ?f_exit_code cmd args with + | [fst] -> + fst + | lst -> + failwithf + (f_ "Command return unexpected output %S") + (String.concat "\n" lst) +end + +module OASISFileUtil = struct +(* # 22 "src/oasis/OASISFileUtil.ml" *) + + + open OASISGettext + + + let file_exists_case fn = + let dirname = Filename.dirname fn in + let basename = Filename.basename fn in + if Sys.file_exists dirname then + if basename = Filename.current_dir_name then + true + else + List.mem + basename + (Array.to_list (Sys.readdir dirname)) + else + false + + + let find_file ?(case_sensitive=true) paths exts = + + (* Cardinal product of two list *) + let ( * ) lst1 lst2 = + List.flatten + (List.map + (fun a -> + List.map + (fun b -> a, b) + lst2) + lst1) + in + + let rec combined_paths lst = + match lst with + | p1 :: p2 :: tl -> + let acc = + (List.map + (fun (a, b) -> Filename.concat a b) + (p1 * p2)) + in + combined_paths (acc :: tl) + | [e] -> + e + | [] -> + [] + in + + let alternatives = + List.map + (fun (p, e) -> + if String.length e > 0 && e.[0] <> '.' then + p ^ "." ^ e + else + p ^ e) + ((combined_paths paths) * exts) + in + List.find (fun file -> + (if case_sensitive then + file_exists_case file + else + Sys.file_exists file) + && not (Sys.is_directory file) + ) alternatives + + + let which ~ctxt prg = + let path_sep = + match Sys.os_type with + | "Win32" -> + ';' + | _ -> + ':' + in + let path_lst = OASISString.nsplit (Sys.getenv "PATH") path_sep in + let exec_ext = + match Sys.os_type with + | "Win32" -> + "" :: (OASISString.nsplit (Sys.getenv "PATHEXT") path_sep) + | _ -> + [""] + in + find_file ~case_sensitive:false [path_lst; [prg]] exec_ext + + + (**/**) + let rec fix_dir dn = + (* Windows hack because Sys.file_exists "src\\" = false when + * Sys.file_exists "src" = true + *) + let ln = + String.length dn + in + if Sys.os_type = "Win32" && ln > 0 && dn.[ln - 1] = '\\' then + fix_dir (String.sub dn 0 (ln - 1)) + else + dn + + + let q = Filename.quote + (**/**) + + + let cp ~ctxt ?(recurse=false) src tgt = + if recurse then + match Sys.os_type with + | "Win32" -> + OASISExec.run ~ctxt + "xcopy" [q src; q tgt; "/E"] + | _ -> + OASISExec.run ~ctxt + "cp" ["-r"; q src; q tgt] + else + OASISExec.run ~ctxt + (match Sys.os_type with + | "Win32" -> "copy" + | _ -> "cp") + [q src; q tgt] + + + let mkdir ~ctxt tgt = + OASISExec.run ~ctxt + (match Sys.os_type with + | "Win32" -> "md" + | _ -> "mkdir") + [q tgt] + + + let rec mkdir_parent ~ctxt f tgt = + let tgt = + fix_dir tgt + in + if Sys.file_exists tgt then + begin + if not (Sys.is_directory tgt) then + OASISUtils.failwithf + (f_ "Cannot create directory '%s', a file of the same name already \ + exists") + tgt + end + else + begin + mkdir_parent ~ctxt f (Filename.dirname tgt); + if not (Sys.file_exists tgt) then + begin + f tgt; + mkdir ~ctxt tgt + end + end + + + let rmdir ~ctxt tgt = + if Sys.readdir tgt = [||] then begin + match Sys.os_type with + | "Win32" -> + OASISExec.run ~ctxt "rd" [q tgt] + | _ -> + OASISExec.run ~ctxt "rm" ["-r"; q tgt] + end else begin + OASISMessage.error ~ctxt + (f_ "Cannot remove directory '%s': not empty.") + tgt + end + + + let glob ~ctxt fn = + let basename = + Filename.basename fn + in + if String.length basename >= 2 && + basename.[0] = '*' && + basename.[1] = '.' then + begin + let ext_len = + (String.length basename) - 2 + in + let ext = + String.sub basename 2 ext_len + in + let dirname = + Filename.dirname fn + in + Array.fold_left + (fun acc fn -> + try + let fn_ext = + String.sub + fn + ((String.length fn) - ext_len) + ext_len + in + if fn_ext = ext then + (Filename.concat dirname fn) :: acc + else + acc + with Invalid_argument _ -> + acc) + [] + (Sys.readdir dirname) + end + else + begin + if file_exists_case fn then + [fn] + else + [] + end +end + + +# 2916 "setup.ml" +module BaseEnvLight = struct +(* # 22 "src/base/BaseEnvLight.ml" *) + + + module MapString = Map.Make(String) + + + type t = string MapString.t + + + let default_filename = + Filename.concat + (Sys.getcwd ()) + "setup.data" + + + let load ?(allow_empty=false) ?(filename=default_filename) () = + if Sys.file_exists filename then + begin + let chn = + open_in_bin filename + in + let st = + Stream.of_channel chn + in + let line = + ref 1 + in + let st_line = + Stream.from + (fun _ -> + try + match Stream.next st with + | '\n' -> incr line; Some '\n' + | c -> Some c + with Stream.Failure -> None) + in + let lexer = + Genlex.make_lexer ["="] st_line + in + let rec read_file mp = + match Stream.npeek 3 lexer with + | [Genlex.Ident nm; Genlex.Kwd "="; Genlex.String value] -> + Stream.junk lexer; + Stream.junk lexer; + Stream.junk lexer; + read_file (MapString.add nm value mp) + | [] -> + mp + | _ -> + failwith + (Printf.sprintf + "Malformed data file '%s' line %d" + filename !line) + in + let mp = + read_file MapString.empty + in + close_in chn; + mp + end + else if allow_empty then + begin + MapString.empty + end + else + begin + failwith + (Printf.sprintf + "Unable to load environment, the file '%s' doesn't exist." + filename) + end + + + let rec var_expand str env = + let buff = + Buffer.create ((String.length str) * 2) + in + Buffer.add_substitute + buff + (fun var -> + try + var_expand (MapString.find var env) env + with Not_found -> + failwith + (Printf.sprintf + "No variable %s defined when trying to expand %S." + var + str)) + str; + Buffer.contents buff + + + let var_get name env = + var_expand (MapString.find name env) env + + + let var_choose lst env = + OASISExpr.choose + (fun nm -> var_get nm env) + lst +end + + +# 3021 "setup.ml" +module BaseContext = struct +(* # 22 "src/base/BaseContext.ml" *) + + (* TODO: get rid of this module. *) + open OASISContext + + + let args () = fst (fspecs ()) + + + let default = default + +end + +module BaseMessage = struct +(* # 22 "src/base/BaseMessage.ml" *) + + + (** Message to user, overrid for Base + @author Sylvain Le Gall + *) + open OASISMessage + open BaseContext + + + let debug fmt = debug ~ctxt:!default fmt + + + let info fmt = info ~ctxt:!default fmt + + + let warning fmt = warning ~ctxt:!default fmt + + + let error fmt = error ~ctxt:!default fmt + +end + +module BaseEnv = struct +(* # 22 "src/base/BaseEnv.ml" *) + + open OASISGettext + open OASISUtils + open PropList + + + module MapString = BaseEnvLight.MapString + + + type origin_t = + | ODefault + | OGetEnv + | OFileLoad + | OCommandLine + + + type cli_handle_t = + | CLINone + | CLIAuto + | CLIWith + | CLIEnable + | CLIUser of (Arg.key * Arg.spec * Arg.doc) list + + + type definition_t = + { + hide: bool; + dump: bool; + cli: cli_handle_t; + arg_help: string option; + group: string option; + } + + + let schema = + Schema.create "environment" + + + (* Environment data *) + let env = + Data.create () + + + (* Environment data from file *) + let env_from_file = + ref MapString.empty + + + (* Lexer for var *) + let var_lxr = + Genlex.make_lexer [] + + + let rec var_expand str = + let buff = + Buffer.create ((String.length str) * 2) + in + Buffer.add_substitute + buff + (fun var -> + try + (* TODO: this is a quick hack to allow calling Test.Command + * without defining executable name really. I.e. if there is + * an exec Executable toto, then $(toto) should be replace + * by its real name. It is however useful to have this function + * for other variable that depend on the host and should be + * written better than that. + *) + let st = + var_lxr (Stream.of_string var) + in + match Stream.npeek 3 st with + | [Genlex.Ident "utoh"; Genlex.Ident nm] -> + OASISHostPath.of_unix (var_get nm) + | [Genlex.Ident "utoh"; Genlex.String s] -> + OASISHostPath.of_unix s + | [Genlex.Ident "ocaml_escaped"; Genlex.Ident nm] -> + String.escaped (var_get nm) + | [Genlex.Ident "ocaml_escaped"; Genlex.String s] -> + String.escaped s + | [Genlex.Ident nm] -> + var_get nm + | _ -> + failwithf + (f_ "Unknown expression '%s' in variable expansion of %s.") + var + str + with + | Unknown_field (_, _) -> + failwithf + (f_ "No variable %s defined when trying to expand %S.") + var + str + | Stream.Error e -> + failwithf + (f_ "Syntax error when parsing '%s' when trying to \ + expand %S: %s") + var + str + e) + str; + Buffer.contents buff + + + and var_get name = + let vl = + try + Schema.get schema env name + with Unknown_field _ as e -> + begin + try + MapString.find name !env_from_file + with Not_found -> + raise e + end + in + var_expand vl + + + let var_choose ?printer ?name lst = + OASISExpr.choose + ?printer + ?name + var_get + lst + + + let var_protect vl = + let buff = + Buffer.create (String.length vl) + in + String.iter + (function + | '$' -> Buffer.add_string buff "\\$" + | c -> Buffer.add_char buff c) + vl; + Buffer.contents buff + + + let var_define + ?(hide=false) + ?(dump=true) + ?short_desc + ?(cli=CLINone) + ?arg_help + ?group + name (* TODO: type constraint on the fact that name must be a valid OCaml + id *) + dflt = + + let default = + [ + OFileLoad, (fun () -> MapString.find name !env_from_file); + ODefault, dflt; + OGetEnv, (fun () -> Sys.getenv name); + ] + in + + let extra = + { + hide = hide; + dump = dump; + cli = cli; + arg_help = arg_help; + group = group; + } + in + + (* Try to find a value that can be defined + *) + let var_get_low lst = + let errors, res = + List.fold_left + (fun (errors, res) (o, v) -> + if res = None then + begin + try + errors, Some (v ()) + with + | Not_found -> + errors, res + | Failure rsn -> + (rsn :: errors), res + | e -> + (Printexc.to_string e) :: errors, res + end + else + errors, res) + ([], None) + (List.sort + (fun (o1, _) (o2, _) -> + Pervasives.compare o2 o1) + lst) + in + match res, errors with + | Some v, _ -> + v + | None, [] -> + raise (Not_set (name, None)) + | None, lst -> + raise (Not_set (name, Some (String.concat (s_ ", ") lst))) + in + + let help = + match short_desc with + | Some fs -> Some fs + | None -> None + in + + let var_get_lst = + FieldRO.create + ~schema + ~name + ~parse:(fun ?(context=ODefault) s -> [context, fun () -> s]) + ~print:var_get_low + ~default + ~update:(fun ?context x old_x -> x @ old_x) + ?help + extra + in + + fun () -> + var_expand (var_get_low (var_get_lst env)) + + + let var_redefine + ?hide + ?dump + ?short_desc + ?cli + ?arg_help + ?group + name + dflt = + if Schema.mem schema name then + begin + (* TODO: look suspsicious, we want to memorize dflt not dflt () *) + Schema.set schema env ~context:ODefault name (dflt ()); + fun () -> var_get name + end + else + begin + var_define + ?hide + ?dump + ?short_desc + ?cli + ?arg_help + ?group + name + dflt + end + + + let var_ignore (e: unit -> string) = () + + + let print_hidden = + var_define + ~hide:true + ~dump:false + ~cli:CLIAuto + ~arg_help:"Print even non-printable variable. (debug)" + "print_hidden" + (fun () -> "false") + + + let var_all () = + List.rev + (Schema.fold + (fun acc nm def _ -> + if not def.hide || bool_of_string (print_hidden ()) then + nm :: acc + else + acc) + [] + schema) + + + let default_filename = + BaseEnvLight.default_filename + + + let load ?allow_empty ?filename () = + env_from_file := BaseEnvLight.load ?allow_empty ?filename () + + + let unload () = + env_from_file := MapString.empty; + Data.clear env + + + let dump ?(filename=default_filename) () = + let chn = + open_out_bin filename + in + let output nm value = + Printf.fprintf chn "%s=%S\n" nm value + in + let mp_todo = + (* Dump data from schema *) + Schema.fold + (fun mp_todo nm def _ -> + if def.dump then + begin + try + let value = + Schema.get + schema + env + nm + in + output nm value + with Not_set _ -> + () + end; + MapString.remove nm mp_todo) + !env_from_file + schema + in + (* Dump data defined outside of schema *) + MapString.iter output mp_todo; + + (* End of the dump *) + close_out chn + + + let print () = + let printable_vars = + Schema.fold + (fun acc nm def short_descr_opt -> + if not def.hide || bool_of_string (print_hidden ()) then + begin + try + let value = + Schema.get + schema + env + nm + in + let txt = + match short_descr_opt with + | Some s -> s () + | None -> nm + in + (txt, value) :: acc + with Not_set _ -> + acc + end + else + acc) + [] + schema + in + let max_length = + List.fold_left max 0 + (List.rev_map String.length + (List.rev_map fst printable_vars)) + in + let dot_pad str = + String.make ((max_length - (String.length str)) + 3) '.' + in + + Printf.printf "\nConfiguration: \n"; + List.iter + (fun (name, value) -> + Printf.printf "%s: %s %s\n" name (dot_pad name) value) + (List.rev printable_vars); + Printf.printf "\n%!" + + + let args () = + let arg_concat = + OASISUtils.varname_concat ~hyphen:'-' + in + [ + "--override", + Arg.Tuple + ( + let rvr = ref "" + in + let rvl = ref "" + in + [ + Arg.Set_string rvr; + Arg.Set_string rvl; + Arg.Unit + (fun () -> + Schema.set + schema + env + ~context:OCommandLine + !rvr + !rvl) + ] + ), + "var+val Override any configuration variable."; + + ] + @ + List.flatten + (Schema.fold + (fun acc name def short_descr_opt -> + let var_set s = + Schema.set + schema + env + ~context:OCommandLine + name + s + in + + let arg_name = + OASISUtils.varname_of_string ~hyphen:'-' name + in + + let hlp = + match short_descr_opt with + | Some txt -> txt () + | None -> "" + in + + let arg_hlp = + match def.arg_help with + | Some s -> s + | None -> "str" + in + + let default_value = + try + Printf.sprintf + (f_ " [%s]") + (Schema.get + schema + env + name) + with Not_set _ -> + "" + in + + let args = + match def.cli with + | CLINone -> + [] + | CLIAuto -> + [ + arg_concat "--" arg_name, + Arg.String var_set, + Printf.sprintf (f_ "%s %s%s") arg_hlp hlp default_value + ] + | CLIWith -> + [ + arg_concat "--with-" arg_name, + Arg.String var_set, + Printf.sprintf (f_ "%s %s%s") arg_hlp hlp default_value + ] + | CLIEnable -> + let dflt = + if default_value = " [true]" then + s_ " [default: enabled]" + else + s_ " [default: disabled]" + in + [ + arg_concat "--enable-" arg_name, + Arg.Unit (fun () -> var_set "true"), + Printf.sprintf (f_ " %s%s") hlp dflt; + + arg_concat "--disable-" arg_name, + Arg.Unit (fun () -> var_set "false"), + Printf.sprintf (f_ " %s%s") hlp dflt + ] + | CLIUser lst -> + lst + in + args :: acc) + [] + schema) +end + +module BaseArgExt = struct +(* # 22 "src/base/BaseArgExt.ml" *) + + + open OASISUtils + open OASISGettext + + + let parse argv args = + (* Simulate command line for Arg *) + let current = + ref 0 + in + + try + Arg.parse_argv + ~current:current + (Array.concat [[|"none"|]; argv]) + (Arg.align args) + (failwithf (f_ "Don't know what to do with arguments: '%s'")) + (s_ "configure options:") + with + | Arg.Help txt -> + print_endline txt; + exit 0 + | Arg.Bad txt -> + prerr_endline txt; + exit 1 +end + +module BaseCheck = struct +(* # 22 "src/base/BaseCheck.ml" *) + + + open BaseEnv + open BaseMessage + open OASISUtils + open OASISGettext + + + let prog_best prg prg_lst = + var_redefine + prg + (fun () -> + let alternate = + List.fold_left + (fun res e -> + match res with + | Some _ -> + res + | None -> + try + Some (OASISFileUtil.which ~ctxt:!BaseContext.default e) + with Not_found -> + None) + None + prg_lst + in + match alternate with + | Some prg -> prg + | None -> raise Not_found) + + + let prog prg = + prog_best prg [prg] + + + let prog_opt prg = + prog_best prg [prg^".opt"; prg] + + + let ocamlfind = + prog "ocamlfind" + + + let version + var_prefix + cmp + fversion + () = + (* Really compare version provided *) + let var = + var_prefix^"_version_"^(OASISVersion.varname_of_comparator cmp) + in + var_redefine + ~hide:true + var + (fun () -> + let version_str = + match fversion () with + | "[Distributed with OCaml]" -> + begin + try + (var_get "ocaml_version") + with Not_found -> + warning + (f_ "Variable ocaml_version not defined, fallback \ + to default"); + Sys.ocaml_version + end + | res -> + res + in + let version = + OASISVersion.version_of_string version_str + in + if OASISVersion.comparator_apply version cmp then + version_str + else + failwithf + (f_ "Cannot satisfy version constraint on %s: %s (version: %s)") + var_prefix + (OASISVersion.string_of_comparator cmp) + version_str) + () + + + let package_version pkg = + OASISExec.run_read_one_line ~ctxt:!BaseContext.default + (ocamlfind ()) + ["query"; "-format"; "%v"; pkg] + + + let package ?version_comparator pkg () = + let var = + OASISUtils.varname_concat + "pkg_" + (OASISUtils.varname_of_string pkg) + in + let findlib_dir pkg = + let dir = + OASISExec.run_read_one_line ~ctxt:!BaseContext.default + (ocamlfind ()) + ["query"; "-format"; "%d"; pkg] + in + if Sys.file_exists dir && Sys.is_directory dir then + dir + else + failwithf + (f_ "When looking for findlib package %s, \ + directory %s return doesn't exist") + pkg dir + in + let vl = + var_redefine + var + (fun () -> findlib_dir pkg) + () + in + ( + match version_comparator with + | Some ver_cmp -> + ignore + (version + var + ver_cmp + (fun _ -> package_version pkg) + ()) + | None -> + () + ); + vl +end + +module BaseOCamlcConfig = struct +(* # 22 "src/base/BaseOCamlcConfig.ml" *) + + + open BaseEnv + open OASISUtils + open OASISGettext + + + module SMap = Map.Make(String) + + + let ocamlc = + BaseCheck.prog_opt "ocamlc" + + + let ocamlc_config_map = + (* Map name to value for ocamlc -config output + (name ^": "^value) + *) + let rec split_field mp lst = + match lst with + | line :: tl -> + let mp = + try + let pos_semicolon = + String.index line ':' + in + if pos_semicolon > 1 then + ( + let name = + String.sub line 0 pos_semicolon + in + let linelen = + String.length line + in + let value = + if linelen > pos_semicolon + 2 then + String.sub + line + (pos_semicolon + 2) + (linelen - pos_semicolon - 2) + else + "" + in + SMap.add name value mp + ) + else + ( + mp + ) + with Not_found -> + ( + mp + ) + in + split_field mp tl + | [] -> + mp + in + + let cache = + lazy + (var_protect + (Marshal.to_string + (split_field + SMap.empty + (OASISExec.run_read_output + ~ctxt:!BaseContext.default + (ocamlc ()) ["-config"])) + [])) + in + var_redefine + "ocamlc_config_map" + ~hide:true + ~dump:false + (fun () -> + (* TODO: update if ocamlc change !!! *) + Lazy.force cache) + + + let var_define nm = + (* Extract data from ocamlc -config *) + let avlbl_config_get () = + Marshal.from_string + (ocamlc_config_map ()) + 0 + in + let chop_version_suffix s = + try + String.sub s 0 (String.index s '+') + with _ -> + s + in + + let nm_config, value_config = + match nm with + | "ocaml_version" -> + "version", chop_version_suffix + | _ -> nm, (fun x -> x) + in + var_redefine + nm + (fun () -> + try + let map = + avlbl_config_get () + in + let value = + SMap.find nm_config map + in + value_config value + with Not_found -> + failwithf + (f_ "Cannot find field '%s' in '%s -config' output") + nm + (ocamlc ())) + +end + +module BaseStandardVar = struct +(* # 22 "src/base/BaseStandardVar.ml" *) + + + open OASISGettext + open OASISTypes + open OASISExpr + open BaseCheck + open BaseEnv + + + let ocamlfind = BaseCheck.ocamlfind + let ocamlc = BaseOCamlcConfig.ocamlc + let ocamlopt = prog_opt "ocamlopt" + let ocamlbuild = prog "ocamlbuild" + + + (**/**) + let rpkg = + ref None + + + let pkg_get () = + match !rpkg with + | Some pkg -> pkg + | None -> failwith (s_ "OASIS Package is not set") + + + let var_cond = ref [] + + + let var_define_cond ~since_version f dflt = + let holder = ref (fun () -> dflt) in + let since_version = + OASISVersion.VGreaterEqual (OASISVersion.version_of_string since_version) + in + var_cond := + (fun ver -> + if OASISVersion.comparator_apply ver since_version then + holder := f ()) :: !var_cond; + fun () -> !holder () + + + (**/**) + + + let pkg_name = + var_define + ~short_desc:(fun () -> s_ "Package name") + "pkg_name" + (fun () -> (pkg_get ()).name) + + + let pkg_version = + var_define + ~short_desc:(fun () -> s_ "Package version") + "pkg_version" + (fun () -> + (OASISVersion.string_of_version (pkg_get ()).version)) + + + let c = BaseOCamlcConfig.var_define + + + let os_type = c "os_type" + let system = c "system" + let architecture = c "architecture" + let ccomp_type = c "ccomp_type" + let ocaml_version = c "ocaml_version" + + + (* TODO: Check standard variable presence at runtime *) + + + let standard_library_default = c "standard_library_default" + let standard_library = c "standard_library" + let standard_runtime = c "standard_runtime" + let bytecomp_c_compiler = c "bytecomp_c_compiler" + let native_c_compiler = c "native_c_compiler" + let model = c "model" + let ext_obj = c "ext_obj" + let ext_asm = c "ext_asm" + let ext_lib = c "ext_lib" + let ext_dll = c "ext_dll" + let default_executable_name = c "default_executable_name" + let systhread_supported = c "systhread_supported" + + + let flexlink = + BaseCheck.prog "flexlink" + + + let flexdll_version = + var_define + ~short_desc:(fun () -> "FlexDLL version (Win32)") + "flexdll_version" + (fun () -> + let lst = + OASISExec.run_read_output ~ctxt:!BaseContext.default + (flexlink ()) ["-help"] + in + match lst with + | line :: _ -> + Scanf.sscanf line "FlexDLL version %s" (fun ver -> ver) + | [] -> + raise Not_found) + + + (**/**) + let p name hlp dflt = + var_define + ~short_desc:hlp + ~cli:CLIAuto + ~arg_help:"dir" + name + dflt + + + let (/) a b = + if os_type () = Sys.os_type then + Filename.concat a b + else if os_type () = "Unix" then + OASISUnixPath.concat a b + else + OASISUtils.failwithf (f_ "Cannot handle os_type %s filename concat") + (os_type ()) + (**/**) + + + let prefix = + p "prefix" + (fun () -> s_ "Install architecture-independent files dir") + (fun () -> + match os_type () with + | "Win32" -> + let program_files = + Sys.getenv "PROGRAMFILES" + in + program_files/(pkg_name ()) + | _ -> + "/usr/local") + + + let exec_prefix = + p "exec_prefix" + (fun () -> s_ "Install architecture-dependent files in dir") + (fun () -> "$prefix") + + + let bindir = + p "bindir" + (fun () -> s_ "User executables") + (fun () -> "$exec_prefix"/"bin") + + + let sbindir = + p "sbindir" + (fun () -> s_ "System admin executables") + (fun () -> "$exec_prefix"/"sbin") + + + let libexecdir = + p "libexecdir" + (fun () -> s_ "Program executables") + (fun () -> "$exec_prefix"/"libexec") + + + let sysconfdir = + p "sysconfdir" + (fun () -> s_ "Read-only single-machine data") + (fun () -> "$prefix"/"etc") + + + let sharedstatedir = + p "sharedstatedir" + (fun () -> s_ "Modifiable architecture-independent data") + (fun () -> "$prefix"/"com") + + + let localstatedir = + p "localstatedir" + (fun () -> s_ "Modifiable single-machine data") + (fun () -> "$prefix"/"var") + + + let libdir = + p "libdir" + (fun () -> s_ "Object code libraries") + (fun () -> "$exec_prefix"/"lib") + + + let datarootdir = + p "datarootdir" + (fun () -> s_ "Read-only arch-independent data root") + (fun () -> "$prefix"/"share") + + + let datadir = + p "datadir" + (fun () -> s_ "Read-only architecture-independent data") + (fun () -> "$datarootdir") + + + let infodir = + p "infodir" + (fun () -> s_ "Info documentation") + (fun () -> "$datarootdir"/"info") + + + let localedir = + p "localedir" + (fun () -> s_ "Locale-dependent data") + (fun () -> "$datarootdir"/"locale") + + + let mandir = + p "mandir" + (fun () -> s_ "Man documentation") + (fun () -> "$datarootdir"/"man") + + + let docdir = + p "docdir" + (fun () -> s_ "Documentation root") + (fun () -> "$datarootdir"/"doc"/"$pkg_name") + + + let htmldir = + p "htmldir" + (fun () -> s_ "HTML documentation") + (fun () -> "$docdir") + + + let dvidir = + p "dvidir" + (fun () -> s_ "DVI documentation") + (fun () -> "$docdir") + + + let pdfdir = + p "pdfdir" + (fun () -> s_ "PDF documentation") + (fun () -> "$docdir") + + + let psdir = + p "psdir" + (fun () -> s_ "PS documentation") + (fun () -> "$docdir") + + + let destdir = + p "destdir" + (fun () -> s_ "Prepend a path when installing package") + (fun () -> + raise + (PropList.Not_set + ("destdir", + Some (s_ "undefined by construct")))) + + + let findlib_version = + var_define + "findlib_version" + (fun () -> + BaseCheck.package_version "findlib") + + + let is_native = + var_define + "is_native" + (fun () -> + try + let _s: string = + ocamlopt () + in + "true" + with PropList.Not_set _ -> + let _s: string = + ocamlc () + in + "false") + + + let ext_program = + var_define + "suffix_program" + (fun () -> + match os_type () with + | "Win32" | "Cygwin" -> ".exe" + | _ -> "") + + + let rm = + var_define + ~short_desc:(fun () -> s_ "Remove a file.") + "rm" + (fun () -> + match os_type () with + | "Win32" -> "del" + | _ -> "rm -f") + + + let rmdir = + var_define + ~short_desc:(fun () -> s_ "Remove a directory.") + "rmdir" + (fun () -> + match os_type () with + | "Win32" -> "rd" + | _ -> "rm -rf") + + + let debug = + var_define + ~short_desc:(fun () -> s_ "Turn ocaml debug flag on") + ~cli:CLIEnable + "debug" + (fun () -> "true") + + + let profile = + var_define + ~short_desc:(fun () -> s_ "Turn ocaml profile flag on") + ~cli:CLIEnable + "profile" + (fun () -> "false") + + + let tests = + var_define_cond ~since_version:"0.3" + (fun () -> + var_define + ~short_desc:(fun () -> + s_ "Compile tests executable and library and run them") + ~cli:CLIEnable + "tests" + (fun () -> "false")) + "true" + + + let docs = + var_define_cond ~since_version:"0.3" + (fun () -> + var_define + ~short_desc:(fun () -> s_ "Create documentations") + ~cli:CLIEnable + "docs" + (fun () -> "true")) + "true" + + + let native_dynlink = + var_define + ~short_desc:(fun () -> s_ "Compiler support generation of .cmxs.") + ~cli:CLINone + "native_dynlink" + (fun () -> + let res = + let ocaml_lt_312 () = + OASISVersion.comparator_apply + (OASISVersion.version_of_string (ocaml_version ())) + (OASISVersion.VLesser + (OASISVersion.version_of_string "3.12.0")) + in + let flexdll_lt_030 () = + OASISVersion.comparator_apply + (OASISVersion.version_of_string (flexdll_version ())) + (OASISVersion.VLesser + (OASISVersion.version_of_string "0.30")) + in + let has_native_dynlink = + let ocamlfind = ocamlfind () in + try + let fn = + OASISExec.run_read_one_line + ~ctxt:!BaseContext.default + ocamlfind + ["query"; "-predicates"; "native"; "dynlink"; + "-format"; "%d/%a"] + in + Sys.file_exists fn + with _ -> + false + in + if not has_native_dynlink then + false + else if ocaml_lt_312 () then + false + else if (os_type () = "Win32" || os_type () = "Cygwin") + && flexdll_lt_030 () then + begin + BaseMessage.warning + (f_ ".cmxs generation disabled because FlexDLL needs to be \ + at least 0.30. Please upgrade FlexDLL from %s to 0.30.") + (flexdll_version ()); + false + end + else + true + in + string_of_bool res) + + + let init pkg = + rpkg := Some pkg; + List.iter (fun f -> f pkg.oasis_version) !var_cond + +end + +module BaseFileAB = struct +(* # 22 "src/base/BaseFileAB.ml" *) + + + open BaseEnv + open OASISGettext + open BaseMessage + + + let to_filename fn = + let fn = + OASISHostPath.of_unix fn + in + if not (Filename.check_suffix fn ".ab") then + warning + (f_ "File '%s' doesn't have '.ab' extension") + fn; + Filename.chop_extension fn + + + let replace fn_lst = + let buff = + Buffer.create 13 + in + List.iter + (fun fn -> + let fn = + OASISHostPath.of_unix fn + in + let chn_in = + open_in fn + in + let chn_out = + open_out (to_filename fn) + in + ( + try + while true do + Buffer.add_string buff (var_expand (input_line chn_in)); + Buffer.add_char buff '\n' + done + with End_of_file -> + () + ); + Buffer.output_buffer chn_out buff; + Buffer.clear buff; + close_in chn_in; + close_out chn_out) + fn_lst +end + +module BaseLog = struct +(* # 22 "src/base/BaseLog.ml" *) + + + open OASISUtils + + + let default_filename = + Filename.concat + (Filename.dirname BaseEnv.default_filename) + "setup.log" + + + module SetTupleString = + Set.Make + (struct + type t = string * string + let compare (s11, s12) (s21, s22) = + match String.compare s11 s21 with + | 0 -> String.compare s12 s22 + | n -> n + end) + + + let load () = + if Sys.file_exists default_filename then + begin + let chn = + open_in default_filename + in + let scbuf = + Scanf.Scanning.from_file default_filename + in + let rec read_aux (st, lst) = + if not (Scanf.Scanning.end_of_input scbuf) then + begin + let acc = + try + Scanf.bscanf scbuf "%S %S\n" + (fun e d -> + let t = + e, d + in + if SetTupleString.mem t st then + st, lst + else + SetTupleString.add t st, + t :: lst) + with Scanf.Scan_failure _ -> + failwith + (Scanf.bscanf scbuf + "%l" + (fun line -> + Printf.sprintf + "Malformed log file '%s' at line %d" + default_filename + line)) + in + read_aux acc + end + else + begin + close_in chn; + List.rev lst + end + in + read_aux (SetTupleString.empty, []) + end + else + begin + [] + end + + + let register event data = + let chn_out = + open_out_gen [Open_append; Open_creat; Open_text] 0o644 default_filename + in + Printf.fprintf chn_out "%S %S\n" event data; + close_out chn_out + + + let unregister event data = + if Sys.file_exists default_filename then + begin + let lst = + load () + in + let chn_out = + open_out default_filename + in + let write_something = + ref false + in + List.iter + (fun (e, d) -> + if e <> event || d <> data then + begin + write_something := true; + Printf.fprintf chn_out "%S %S\n" e d + end) + lst; + close_out chn_out; + if not !write_something then + Sys.remove default_filename + end + + + let filter events = + let st_events = + List.fold_left + (fun st e -> + SetString.add e st) + SetString.empty + events + in + List.filter + (fun (e, _) -> SetString.mem e st_events) + (load ()) + + + let exists event data = + List.exists + (fun v -> (event, data) = v) + (load ()) +end + +module BaseBuilt = struct +(* # 22 "src/base/BaseBuilt.ml" *) + + + open OASISTypes + open OASISGettext + open BaseStandardVar + open BaseMessage + + + type t = + | BExec (* Executable *) + | BExecLib (* Library coming with executable *) + | BLib (* Library *) + | BObj (* Library *) + | BDoc (* Document *) + + + let to_log_event_file t nm = + "built_"^ + (match t with + | BExec -> "exec" + | BExecLib -> "exec_lib" + | BLib -> "lib" + | BObj -> "obj" + | BDoc -> "doc")^ + "_"^nm + + + let to_log_event_done t nm = + "is_"^(to_log_event_file t nm) + + + let register t nm lst = + BaseLog.register + (to_log_event_done t nm) + "true"; + List.iter + (fun alt -> + let registered = + List.fold_left + (fun registered fn -> + if OASISFileUtil.file_exists_case fn then + begin + BaseLog.register + (to_log_event_file t nm) + (if Filename.is_relative fn then + Filename.concat (Sys.getcwd ()) fn + else + fn); + true + end + else + registered) + false + alt + in + if not registered then + warning + (f_ "Cannot find an existing alternative files among: %s") + (String.concat (s_ ", ") alt)) + lst + + + let unregister t nm = + List.iter + (fun (e, d) -> + BaseLog.unregister e d) + (BaseLog.filter + [to_log_event_file t nm; + to_log_event_done t nm]) + + + let fold t nm f acc = + List.fold_left + (fun acc (_, fn) -> + if OASISFileUtil.file_exists_case fn then + begin + f acc fn + end + else + begin + warning + (f_ "File '%s' has been marked as built \ + for %s but doesn't exist") + fn + (Printf.sprintf + (match t with + | BExec | BExecLib -> + (f_ "executable %s") + | BLib -> + (f_ "library %s") + | BObj -> + (f_ "object %s") + | BDoc -> + (f_ "documentation %s")) + nm); + acc + end) + acc + (BaseLog.filter + [to_log_event_file t nm]) + + + let is_built t nm = + List.fold_left + (fun is_built (_, d) -> + (try + bool_of_string d + with _ -> + false)) + false + (BaseLog.filter + [to_log_event_done t nm]) + + + let of_executable ffn (cs, bs, exec) = + let unix_exec_is, unix_dll_opt = + OASISExecutable.unix_exec_is + (cs, bs, exec) + (fun () -> + bool_of_string + (is_native ())) + ext_dll + ext_program + in + let evs = + (BExec, cs.cs_name, [[ffn unix_exec_is]]) + :: + (match unix_dll_opt with + | Some fn -> + [BExecLib, cs.cs_name, [[ffn fn]]] + | None -> + []) + in + evs, + unix_exec_is, + unix_dll_opt + + + let of_library ffn (cs, bs, lib) = + let unix_lst = + OASISLibrary.generated_unix_files + ~ctxt:!BaseContext.default + ~source_file_exists:(fun fn -> + OASISFileUtil.file_exists_case (OASISHostPath.of_unix fn)) + ~is_native:(bool_of_string (is_native ())) + ~has_native_dynlink:(bool_of_string (native_dynlink ())) + ~ext_lib:(ext_lib ()) + ~ext_dll:(ext_dll ()) + (cs, bs, lib) + in + let evs = + [BLib, + cs.cs_name, + List.map (List.map ffn) unix_lst] + in + evs, unix_lst + + + let of_object ffn (cs, bs, obj) = + let unix_lst = + OASISObject.generated_unix_files + ~ctxt:!BaseContext.default + ~source_file_exists:(fun fn -> + OASISFileUtil.file_exists_case (OASISHostPath.of_unix fn)) + ~is_native:(bool_of_string (is_native ())) + (cs, bs, obj) + in + let evs = + [BObj, + cs.cs_name, + List.map (List.map ffn) unix_lst] + in + evs, unix_lst + +end + +module BaseCustom = struct +(* # 22 "src/base/BaseCustom.ml" *) + + + open BaseEnv + open BaseMessage + open OASISTypes + open OASISGettext + + + let run cmd args extra_args = + OASISExec.run ~ctxt:!BaseContext.default ~quote:false + (var_expand cmd) + (List.map + var_expand + (args @ (Array.to_list extra_args))) + + + let hook ?(failsafe=false) cstm f e = + let optional_command lst = + let printer = + function + | Some (cmd, args) -> String.concat " " (cmd :: args) + | None -> s_ "No command" + in + match + var_choose + ~name:(s_ "Pre/Post Command") + ~printer + lst with + | Some (cmd, args) -> + begin + try + run cmd args [||] + with e when failsafe -> + warning + (f_ "Command '%s' fail with error: %s") + (String.concat " " (cmd :: args)) + (match e with + | Failure msg -> msg + | e -> Printexc.to_string e) + end + | None -> + () + in + let res = + optional_command cstm.pre_command; + f e + in + optional_command cstm.post_command; + res +end + +module BaseDynVar = struct +(* # 22 "src/base/BaseDynVar.ml" *) + + + open OASISTypes + open OASISGettext + open BaseEnv + open BaseBuilt + + + let init pkg = + (* TODO: disambiguate exec vs other variable by adding exec_VARNAME. *) + (* TODO: provide compile option for library libary_byte_args_VARNAME... *) + List.iter + (function + | Executable (cs, bs, exec) -> + if var_choose bs.bs_build then + var_ignore + (var_redefine + (* We don't save this variable *) + ~dump:false + ~short_desc:(fun () -> + Printf.sprintf + (f_ "Filename of executable '%s'") + cs.cs_name) + (OASISUtils.varname_of_string cs.cs_name) + (fun () -> + let fn_opt = + fold + BExec cs.cs_name + (fun _ fn -> Some fn) + None + in + match fn_opt with + | Some fn -> fn + | None -> + raise + (PropList.Not_set + (cs.cs_name, + Some (Printf.sprintf + (f_ "Executable '%s' not yet built.") + cs.cs_name))))) + + | Library _ | Object _ | Flag _ | Test _ | SrcRepo _ | Doc _ -> + ()) + pkg.sections +end + +module BaseTest = struct +(* # 22 "src/base/BaseTest.ml" *) + + + open BaseEnv + open BaseMessage + open OASISTypes + open OASISExpr + open OASISGettext + + + let test lst pkg extra_args = + + let one_test (failure, n) (test_plugin, cs, test) = + if var_choose + ~name:(Printf.sprintf + (f_ "test %s run") + cs.cs_name) + ~printer:string_of_bool + test.test_run then + begin + let () = + info (f_ "Running test '%s'") cs.cs_name + in + let back_cwd = + match test.test_working_directory with + | Some dir -> + let cwd = + Sys.getcwd () + in + let chdir d = + info (f_ "Changing directory to '%s'") d; + Sys.chdir d + in + chdir dir; + fun () -> chdir cwd + + | None -> + fun () -> () + in + try + let failure_percent = + BaseCustom.hook + test.test_custom + (test_plugin pkg (cs, test)) + extra_args + in + back_cwd (); + (failure_percent +. failure, n + 1) + with e -> + begin + back_cwd (); + raise e + end + end + else + begin + info (f_ "Skipping test '%s'") cs.cs_name; + (failure, n) + end + in + let failed, n = + List.fold_left + one_test + (0.0, 0) + lst + in + let failure_percent = + if n = 0 then + 0.0 + else + failed /. (float_of_int n) + in + let msg = + Printf.sprintf + (f_ "Tests had a %.2f%% failure rate") + (100. *. failure_percent) + in + if failure_percent > 0.0 then + failwith msg + else + info "%s" msg; + + (* Possible explanation why the tests where not run. *) + if OASISFeatures.package_test OASISFeatures.flag_tests pkg && + not (bool_of_string (BaseStandardVar.tests ())) && + lst <> [] then + BaseMessage.warning + "Tests are turned off, consider enabling with \ + 'ocaml setup.ml -configure --enable-tests'" +end + +module BaseDoc = struct +(* # 22 "src/base/BaseDoc.ml" *) + + + open BaseEnv + open BaseMessage + open OASISTypes + open OASISGettext + + + let doc lst pkg extra_args = + + let one_doc (doc_plugin, cs, doc) = + if var_choose + ~name:(Printf.sprintf + (f_ "documentation %s build") + cs.cs_name) + ~printer:string_of_bool + doc.doc_build then + begin + info (f_ "Building documentation '%s'") cs.cs_name; + BaseCustom.hook + doc.doc_custom + (doc_plugin pkg (cs, doc)) + extra_args + end + in + List.iter one_doc lst; + + if OASISFeatures.package_test OASISFeatures.flag_docs pkg && + not (bool_of_string (BaseStandardVar.docs ())) && + lst <> [] then + BaseMessage.warning + "Docs are turned off, consider enabling with \ + 'ocaml setup.ml -configure --enable-docs'" +end + +module BaseSetup = struct +(* # 22 "src/base/BaseSetup.ml" *) + + open BaseEnv + open BaseMessage + open OASISTypes + open OASISSection + open OASISGettext + open OASISUtils + + + type std_args_fun = + package -> string array -> unit + + + type ('a, 'b) section_args_fun = + name * (package -> (common_section * 'a) -> string array -> 'b) + + + type t = + { + configure: std_args_fun; + build: std_args_fun; + doc: ((doc, unit) section_args_fun) list; + test: ((test, float) section_args_fun) list; + install: std_args_fun; + uninstall: std_args_fun; + clean: std_args_fun list; + clean_doc: (doc, unit) section_args_fun list; + clean_test: (test, unit) section_args_fun list; + distclean: std_args_fun list; + distclean_doc: (doc, unit) section_args_fun list; + distclean_test: (test, unit) section_args_fun list; + package: package; + oasis_fn: string option; + oasis_version: string; + oasis_digest: Digest.t option; + oasis_exec: string option; + oasis_setup_args: string list; + setup_update: bool; + } + + + (* Associate a plugin function with data from package *) + let join_plugin_sections filter_map lst = + List.rev + (List.fold_left + (fun acc sct -> + match filter_map sct with + | Some e -> + e :: acc + | None -> + acc) + [] + lst) + + + (* Search for plugin data associated with a section name *) + let lookup_plugin_section plugin action nm lst = + try + List.assoc nm lst + with Not_found -> + failwithf + (f_ "Cannot find plugin %s matching section %s for %s action") + plugin + nm + action + + + let configure t args = + (* Run configure *) + BaseCustom.hook + t.package.conf_custom + (fun () -> + (* Reload if preconf has changed it *) + begin + try + unload (); + load (); + with _ -> + () + end; + + (* Run plugin's configure *) + t.configure t.package args; + + (* Dump to allow postconf to change it *) + dump ()) + (); + + (* Reload environment *) + unload (); + load (); + + (* Save environment *) + print (); + + (* Replace data in file *) + BaseFileAB.replace t.package.files_ab + + + let build t args = + BaseCustom.hook + t.package.build_custom + (t.build t.package) + args + + + let doc t args = + BaseDoc.doc + (join_plugin_sections + (function + | Doc (cs, e) -> + Some + (lookup_plugin_section + "documentation" + (s_ "build") + cs.cs_name + t.doc, + cs, + e) + | _ -> + None) + t.package.sections) + t.package + args + + + let test t args = + BaseTest.test + (join_plugin_sections + (function + | Test (cs, e) -> + Some + (lookup_plugin_section + "test" + (s_ "run") + cs.cs_name + t.test, + cs, + e) + | _ -> + None) + t.package.sections) + t.package + args + + + let all t args = + let rno_doc = + ref false + in + let rno_test = + ref false + in + let arg_rest = + ref [] + in + Arg.parse_argv + ~current:(ref 0) + (Array.of_list + ((Sys.executable_name^" all") :: + (Array.to_list args))) + [ + "-no-doc", + Arg.Set rno_doc, + s_ "Don't run doc target"; + + "-no-test", + Arg.Set rno_test, + s_ "Don't run test target"; + + "--", + Arg.Rest (fun arg -> arg_rest := arg :: !arg_rest), + s_ "All arguments for configure."; + ] + (failwithf (f_ "Don't know what to do with '%s'")) + ""; + + info "Running configure step"; + configure t (Array.of_list (List.rev !arg_rest)); + + info "Running build step"; + build t [||]; + + (* Load setup.log dynamic variables *) + BaseDynVar.init t.package; + + if not !rno_doc then + begin + info "Running doc step"; + doc t [||]; + end + else + begin + info "Skipping doc step" + end; + + if not !rno_test then + begin + info "Running test step"; + test t [||] + end + else + begin + info "Skipping test step" + end + + + let install t args = + BaseCustom.hook + t.package.install_custom + (t.install t.package) + args + + + let uninstall t args = + BaseCustom.hook + t.package.uninstall_custom + (t.uninstall t.package) + args + + + let reinstall t args = + uninstall t args; + install t args + + + let clean, distclean = + let failsafe f a = + try + f a + with e -> + warning + (f_ "Action fail with error: %s") + (match e with + | Failure msg -> msg + | e -> Printexc.to_string e) + in + + let generic_clean t cstm mains docs tests args = + BaseCustom.hook + ~failsafe:true + cstm + (fun () -> + (* Clean section *) + List.iter + (function + | Test (cs, test) -> + let f = + try + List.assoc cs.cs_name tests + with Not_found -> + fun _ _ _ -> () + in + failsafe + (f t.package (cs, test)) + args + | Doc (cs, doc) -> + let f = + try + List.assoc cs.cs_name docs + with Not_found -> + fun _ _ _ -> () + in + failsafe + (f t.package (cs, doc)) + args + | Library _ + | Object _ + | Executable _ + | Flag _ + | SrcRepo _ -> + ()) + t.package.sections; + (* Clean whole package *) + List.iter + (fun f -> + failsafe + (f t.package) + args) + mains) + () + in + + let clean t args = + generic_clean + t + t.package.clean_custom + t.clean + t.clean_doc + t.clean_test + args + in + + let distclean t args = + (* Call clean *) + clean t args; + + (* Call distclean code *) + generic_clean + t + t.package.distclean_custom + t.distclean + t.distclean_doc + t.distclean_test + args; + + (* Remove generated file *) + List.iter + (fun fn -> + if Sys.file_exists fn then + begin + info (f_ "Remove '%s'") fn; + Sys.remove fn + end) + (BaseEnv.default_filename + :: + BaseLog.default_filename + :: + (List.rev_map BaseFileAB.to_filename t.package.files_ab)) + in + + clean, distclean + + + let version t _ = + print_endline t.oasis_version + + + let update_setup_ml, no_update_setup_ml_cli = + let b = ref true in + b, + ("-no-update-setup-ml", + Arg.Clear b, + s_ " Don't try to update setup.ml, even if _oasis has changed.") + + + let default_oasis_fn = "_oasis" + + + let update_setup_ml t = + let oasis_fn = + match t.oasis_fn with + | Some fn -> fn + | None -> default_oasis_fn + in + let oasis_exec = + match t.oasis_exec with + | Some fn -> fn + | None -> "oasis" + in + let ocaml = + Sys.executable_name + in + let setup_ml, args = + match Array.to_list Sys.argv with + | setup_ml :: args -> + setup_ml, args + | [] -> + failwith + (s_ "Expecting non-empty command line arguments.") + in + let ocaml, setup_ml = + if Sys.executable_name = Sys.argv.(0) then + (* We are not running in standard mode, probably the script + * is precompiled. + *) + "ocaml", "setup.ml" + else + ocaml, setup_ml + in + let no_update_setup_ml_cli, _, _ = no_update_setup_ml_cli in + let do_update () = + let oasis_exec_version = + OASISExec.run_read_one_line + ~ctxt:!BaseContext.default + ~f_exit_code: + (function + | 0 -> + () + | 1 -> + failwithf + (f_ "Executable '%s' is probably an old version \ + of oasis (< 0.3.0), please update to version \ + v%s.") + oasis_exec t.oasis_version + | 127 -> + failwithf + (f_ "Cannot find executable '%s', please install \ + oasis v%s.") + oasis_exec t.oasis_version + | n -> + failwithf + (f_ "Command '%s version' exited with code %d.") + oasis_exec n) + oasis_exec ["version"] + in + if OASISVersion.comparator_apply + (OASISVersion.version_of_string oasis_exec_version) + (OASISVersion.VGreaterEqual + (OASISVersion.version_of_string t.oasis_version)) then + begin + (* We have a version >= for the executable oasis, proceed with + * update. + *) + (* TODO: delegate this check to 'oasis setup'. *) + if Sys.os_type = "Win32" then + failwithf + (f_ "It is not possible to update the running script \ + setup.ml on Windows. Please update setup.ml by \ + running '%s'.") + (String.concat " " (oasis_exec :: "setup" :: t.oasis_setup_args)) + else + begin + OASISExec.run + ~ctxt:!BaseContext.default + ~f_exit_code: + (function + | 0 -> + () + | n -> + failwithf + (f_ "Unable to update setup.ml using '%s', \ + please fix the problem and retry.") + oasis_exec) + oasis_exec ("setup" :: t.oasis_setup_args); + OASISExec.run ~ctxt:!BaseContext.default ocaml (setup_ml :: args) + end + end + else + failwithf + (f_ "The version of '%s' (v%s) doesn't match the version of \ + oasis used to generate the %s file. Please install at \ + least oasis v%s.") + oasis_exec oasis_exec_version setup_ml t.oasis_version + in + + if !update_setup_ml then + begin + try + match t.oasis_digest with + | Some dgst -> + if Sys.file_exists oasis_fn && + dgst <> Digest.file default_oasis_fn then + begin + do_update (); + true + end + else + false + | None -> + false + with e -> + error + (f_ "Error when updating setup.ml. If you want to avoid this error, \ + you can bypass the update of %s by running '%s %s %s %s'") + setup_ml ocaml setup_ml no_update_setup_ml_cli + (String.concat " " args); + raise e + end + else + false + + + let setup t = + let catch_exn = + ref true + in + try + let act_ref = + ref (fun _ -> + failwithf + (f_ "No action defined, run '%s %s -help'") + Sys.executable_name + Sys.argv.(0)) + + in + let extra_args_ref = + ref [] + in + let allow_empty_env_ref = + ref false + in + let arg_handle ?(allow_empty_env=false) act = + Arg.Tuple + [ + Arg.Rest (fun str -> extra_args_ref := str :: !extra_args_ref); + + Arg.Unit + (fun () -> + allow_empty_env_ref := allow_empty_env; + act_ref := act); + ] + in + + Arg.parse + (Arg.align + ([ + "-configure", + arg_handle ~allow_empty_env:true configure, + s_ "[options*] Configure the whole build process."; + + "-build", + arg_handle build, + s_ "[options*] Build executables and libraries."; + + "-doc", + arg_handle doc, + s_ "[options*] Build documents."; + + "-test", + arg_handle test, + s_ "[options*] Run tests."; + + "-all", + arg_handle ~allow_empty_env:true all, + s_ "[options*] Run configure, build, doc and test targets."; + + "-install", + arg_handle install, + s_ "[options*] Install libraries, data, executables \ + and documents."; + + "-uninstall", + arg_handle uninstall, + s_ "[options*] Uninstall libraries, data, executables \ + and documents."; + + "-reinstall", + arg_handle reinstall, + s_ "[options*] Uninstall and install libraries, data, \ + executables and documents."; + + "-clean", + arg_handle ~allow_empty_env:true clean, + s_ "[options*] Clean files generated by a build."; + + "-distclean", + arg_handle ~allow_empty_env:true distclean, + s_ "[options*] Clean files generated by a build and configure."; + + "-version", + arg_handle ~allow_empty_env:true version, + s_ " Display version of OASIS used to generate this setup.ml."; + + "-no-catch-exn", + Arg.Clear catch_exn, + s_ " Don't catch exception, useful for debugging."; + ] + @ + (if t.setup_update then + [no_update_setup_ml_cli] + else + []) + @ (BaseContext.args ()))) + (failwithf (f_ "Don't know what to do with '%s'")) + (s_ "Setup and run build process current package\n"); + + (* Build initial environment *) + load ~allow_empty:!allow_empty_env_ref (); + + (** Initialize flags *) + List.iter + (function + | Flag (cs, {flag_description = hlp; + flag_default = choices}) -> + begin + let apply ?short_desc () = + var_ignore + (var_define + ~cli:CLIEnable + ?short_desc + (OASISUtils.varname_of_string cs.cs_name) + (fun () -> + string_of_bool + (var_choose + ~name:(Printf.sprintf + (f_ "default value of flag %s") + cs.cs_name) + ~printer:string_of_bool + choices))) + in + match hlp with + | Some hlp -> + apply ~short_desc:(fun () -> hlp) () + | None -> + apply () + end + | _ -> + ()) + t.package.sections; + + BaseStandardVar.init t.package; + + BaseDynVar.init t.package; + + if t.setup_update && update_setup_ml t then + () + else + !act_ref t (Array.of_list (List.rev !extra_args_ref)) + + with e when !catch_exn -> + error "%s" (Printexc.to_string e); + exit 1 + + +end + + +# 5432 "setup.ml" +module InternalConfigurePlugin = struct +(* # 22 "src/plugins/internal/InternalConfigurePlugin.ml" *) + + + (** Configure using internal scheme + @author Sylvain Le Gall + *) + + + open BaseEnv + open OASISTypes + open OASISUtils + open OASISGettext + open BaseMessage + + + (** Configure build using provided series of check to be done + * and then output corresponding file. + *) + let configure pkg argv = + let var_ignore_eval var = let _s: string = var () in () in + let errors = ref SetString.empty in + let buff = Buffer.create 13 in + + let add_errors fmt = + Printf.kbprintf + (fun b -> + errors := SetString.add (Buffer.contents b) !errors; + Buffer.clear b) + buff + fmt + in + + let warn_exception e = + warning "%s" (Printexc.to_string e) + in + + (* Check tools *) + let check_tools lst = + List.iter + (function + | ExternalTool tool -> + begin + try + var_ignore_eval (BaseCheck.prog tool) + with e -> + warn_exception e; + add_errors (f_ "Cannot find external tool '%s'") tool + end + | InternalExecutable nm1 -> + (* Check that matching tool is built *) + List.iter + (function + | Executable ({cs_name = nm2}, + {bs_build = build}, + _) when nm1 = nm2 -> + if not (var_choose build) then + add_errors + (f_ "Cannot find buildable internal executable \ + '%s' when checking build depends") + nm1 + | _ -> + ()) + pkg.sections) + lst + in + + let build_checks sct bs = + if var_choose bs.bs_build then + begin + if bs.bs_compiled_object = Native then + begin + try + var_ignore_eval BaseStandardVar.ocamlopt + with e -> + warn_exception e; + add_errors + (f_ "Section %s requires native compilation") + (OASISSection.string_of_section sct) + end; + + (* Check tools *) + check_tools bs.bs_build_tools; + + (* Check depends *) + List.iter + (function + | FindlibPackage (findlib_pkg, version_comparator) -> + begin + try + var_ignore_eval + (BaseCheck.package ?version_comparator findlib_pkg) + with e -> + warn_exception e; + match version_comparator with + | None -> + add_errors + (f_ "Cannot find findlib package %s") + findlib_pkg + | Some ver_cmp -> + add_errors + (f_ "Cannot find findlib package %s (%s)") + findlib_pkg + (OASISVersion.string_of_comparator ver_cmp) + end + | InternalLibrary nm1 -> + (* Check that matching library is built *) + List.iter + (function + | Library ({cs_name = nm2}, + {bs_build = build}, + _) when nm1 = nm2 -> + if not (var_choose build) then + add_errors + (f_ "Cannot find buildable internal library \ + '%s' when checking build depends") + nm1 + | _ -> + ()) + pkg.sections) + bs.bs_build_depends + end + in + + (* Parse command line *) + BaseArgExt.parse argv (BaseEnv.args ()); + + (* OCaml version *) + begin + match pkg.ocaml_version with + | Some ver_cmp -> + begin + try + var_ignore_eval + (BaseCheck.version + "ocaml" + ver_cmp + BaseStandardVar.ocaml_version) + with e -> + warn_exception e; + add_errors + (f_ "OCaml version %s doesn't match version constraint %s") + (BaseStandardVar.ocaml_version ()) + (OASISVersion.string_of_comparator ver_cmp) + end + | None -> + () + end; + + (* Findlib version *) + begin + match pkg.findlib_version with + | Some ver_cmp -> + begin + try + var_ignore_eval + (BaseCheck.version + "findlib" + ver_cmp + BaseStandardVar.findlib_version) + with e -> + warn_exception e; + add_errors + (f_ "Findlib version %s doesn't match version constraint %s") + (BaseStandardVar.findlib_version ()) + (OASISVersion.string_of_comparator ver_cmp) + end + | None -> + () + end; + (* Make sure the findlib version is fine for the OCaml compiler. *) + begin + let ocaml_ge4 = + OASISVersion.version_compare + (OASISVersion.version_of_string (BaseStandardVar.ocaml_version())) + (OASISVersion.version_of_string "4.0.0") >= 0 in + if ocaml_ge4 then + let findlib_lt132 = + OASISVersion.version_compare + (OASISVersion.version_of_string (BaseStandardVar.findlib_version())) + (OASISVersion.version_of_string "1.3.2") < 0 in + if findlib_lt132 then + add_errors "OCaml >= 4.0.0 requires Findlib version >= 1.3.2" + end; + + (* FlexDLL *) + if BaseStandardVar.os_type () = "Win32" || + BaseStandardVar.os_type () = "Cygwin" then + begin + try + var_ignore_eval BaseStandardVar.flexlink + with e -> + warn_exception e; + add_errors (f_ "Cannot find 'flexlink'") + end; + + (* Check build depends *) + List.iter + (function + | Executable (_, bs, _) + | Library (_, bs, _) as sct -> + build_checks sct bs + | Doc (_, doc) -> + if var_choose doc.doc_build then + check_tools doc.doc_build_tools + | Test (_, test) -> + if var_choose test.test_run then + check_tools test.test_tools + | _ -> + ()) + pkg.sections; + + (* Check if we need native dynlink (presence of libraries that compile to + * native) + *) + begin + let has_cmxa = + List.exists + (function + | Library (_, bs, _) -> + var_choose bs.bs_build && + (bs.bs_compiled_object = Native || + (bs.bs_compiled_object = Best && + bool_of_string (BaseStandardVar.is_native ()))) + | _ -> + false) + pkg.sections + in + if has_cmxa then + var_ignore_eval BaseStandardVar.native_dynlink + end; + + (* Check errors *) + if SetString.empty != !errors then + begin + List.iter + (fun e -> error "%s" e) + (SetString.elements !errors); + failwithf + (fn_ + "%d configuration error" + "%d configuration errors" + (SetString.cardinal !errors)) + (SetString.cardinal !errors) + end + + +end + +module InternalInstallPlugin = struct +(* # 22 "src/plugins/internal/InternalInstallPlugin.ml" *) + + + (** Install using internal scheme + @author Sylvain Le Gall + *) + + + open BaseEnv + open BaseStandardVar + open BaseMessage + open OASISTypes + open OASISFindlib + open OASISGettext + open OASISUtils + + + let exec_hook = + ref (fun (cs, bs, exec) -> cs, bs, exec) + + + let lib_hook = + ref (fun (cs, bs, lib) -> cs, bs, lib, []) + + + let obj_hook = + ref (fun (cs, bs, obj) -> cs, bs, obj, []) + + + let doc_hook = + ref (fun (cs, doc) -> cs, doc) + + + let install_file_ev = + "install-file" + + + let install_dir_ev = + "install-dir" + + + let install_findlib_ev = + "install-findlib" + + + let win32_max_command_line_length = 8000 + + + let split_install_command ocamlfind findlib_name meta files = + if Sys.os_type = "Win32" then + (* Arguments for the first command: *) + let first_args = ["install"; findlib_name; meta] in + (* Arguments for remaining commands: *) + let other_args = ["install"; findlib_name; "-add"] in + (* Extract as much files as possible from [files], [len] is + the current command line length: *) + let rec get_files len acc files = + match files with + | [] -> + (List.rev acc, []) + | file :: rest -> + let len = len + 1 + String.length file in + if len > win32_max_command_line_length then + (List.rev acc, files) + else + get_files len (file :: acc) rest + in + (* Split the command into several commands. *) + let rec split args files = + match files with + | [] -> + [] + | _ -> + (* Length of "ocamlfind install [META|-add]" *) + let len = + List.fold_left + (fun len arg -> + len + 1 (* for the space *) + String.length arg) + (String.length ocamlfind) + args + in + match get_files len [] files with + | ([], _) -> + failwith (s_ "Command line too long.") + | (firsts, others) -> + let cmd = args @ firsts in + (* Use -add for remaining commands: *) + let () = + let findlib_ge_132 = + OASISVersion.comparator_apply + (OASISVersion.version_of_string + (BaseStandardVar.findlib_version ())) + (OASISVersion.VGreaterEqual + (OASISVersion.version_of_string "1.3.2")) + in + if not findlib_ge_132 then + failwithf + (f_ "Installing the library %s require to use the \ + flag '-add' of ocamlfind because the command \ + line is too long. This flag is only available \ + for findlib 1.3.2. Please upgrade findlib from \ + %s to 1.3.2") + findlib_name (BaseStandardVar.findlib_version ()) + in + let cmds = split other_args others in + cmd :: cmds + in + (* The first command does not use -add: *) + split first_args files + else + ["install" :: findlib_name :: meta :: files] + + + let install pkg argv = + + let in_destdir = + try + let destdir = + destdir () + in + (* Practically speaking destdir is prepended + * at the beginning of the target filename + *) + fun fn -> destdir^fn + with PropList.Not_set _ -> + fun fn -> fn + in + + let install_file ?tgt_fn src_file envdir = + let tgt_dir = + in_destdir (envdir ()) + in + let tgt_file = + Filename.concat + tgt_dir + (match tgt_fn with + | Some fn -> + fn + | None -> + Filename.basename src_file) + in + (* Create target directory if needed *) + OASISFileUtil.mkdir_parent + ~ctxt:!BaseContext.default + (fun dn -> + info (f_ "Creating directory '%s'") dn; + BaseLog.register install_dir_ev dn) + tgt_dir; + + (* Really install files *) + info (f_ "Copying file '%s' to '%s'") src_file tgt_file; + OASISFileUtil.cp ~ctxt:!BaseContext.default src_file tgt_file; + BaseLog.register install_file_ev tgt_file + in + + (* Install data into defined directory *) + let install_data srcdir lst tgtdir = + let tgtdir = + OASISHostPath.of_unix (var_expand tgtdir) + in + List.iter + (fun (src, tgt_opt) -> + let real_srcs = + OASISFileUtil.glob + ~ctxt:!BaseContext.default + (Filename.concat srcdir src) + in + if real_srcs = [] then + failwithf + (f_ "Wildcard '%s' doesn't match any files") + src; + List.iter + (fun fn -> + install_file + fn + (fun () -> + match tgt_opt with + | Some s -> + OASISHostPath.of_unix (var_expand s) + | None -> + tgtdir)) + real_srcs) + lst + in + + let make_fnames modul sufx = + List.fold_right + begin fun sufx accu -> + (OASISString.capitalize_ascii modul ^ sufx) :: + (OASISString.uncapitalize_ascii modul ^ sufx) :: + accu + end + sufx + [] + in + + (** Install all libraries *) + let install_libs pkg = + + let files_of_library (f_data, acc) data_lib = + let cs, bs, lib, lib_extra = + !lib_hook data_lib + in + if var_choose bs.bs_install && + BaseBuilt.is_built BaseBuilt.BLib cs.cs_name then + begin + let acc = + (* Start with acc + lib_extra *) + List.rev_append lib_extra acc + in + let acc = + (* Add uncompiled header from the source tree *) + let path = + OASISHostPath.of_unix bs.bs_path + in + List.fold_left + begin fun acc modul -> + begin + try + [List.find + OASISFileUtil.file_exists_case + (List.map + (Filename.concat path) + (make_fnames modul [".mli"; ".ml"]))] + with Not_found -> + warning + (f_ "Cannot find source header for module %s \ + in library %s") + modul cs.cs_name; + [] + end + @ + List.filter + OASISFileUtil.file_exists_case + (List.map + (Filename.concat path) + (make_fnames modul [".annot";".cmti";".cmt"])) + @ acc + end + acc + lib.lib_modules + in + + let acc = + (* Get generated files *) + BaseBuilt.fold + BaseBuilt.BLib + cs.cs_name + (fun acc fn -> fn :: acc) + acc + in + + let f_data () = + (* Install data associated with the library *) + install_data + bs.bs_path + bs.bs_data_files + (Filename.concat + (datarootdir ()) + pkg.name); + f_data () + in + + (f_data, acc) + end + else + begin + (f_data, acc) + end + and files_of_object (f_data, acc) data_obj = + let cs, bs, obj, obj_extra = + !obj_hook data_obj + in + if var_choose bs.bs_install && + BaseBuilt.is_built BaseBuilt.BObj cs.cs_name then + begin + let acc = + (* Start with acc + obj_extra *) + List.rev_append obj_extra acc + in + let acc = + (* Add uncompiled header from the source tree *) + let path = + OASISHostPath.of_unix bs.bs_path + in + List.fold_left + begin fun acc modul -> + begin + try + [List.find + OASISFileUtil.file_exists_case + (List.map + (Filename.concat path) + (make_fnames modul [".mli"; ".ml"]))] + with Not_found -> + warning + (f_ "Cannot find source header for module %s \ + in object %s") + modul cs.cs_name; + [] + end + @ + List.filter + OASISFileUtil.file_exists_case + (List.map + (Filename.concat path) + (make_fnames modul [".annot";".cmti";".cmt"])) + @ acc + end + acc + obj.obj_modules + in + + let acc = + (* Get generated files *) + BaseBuilt.fold + BaseBuilt.BObj + cs.cs_name + (fun acc fn -> fn :: acc) + acc + in + + let f_data () = + (* Install data associated with the object *) + install_data + bs.bs_path + bs.bs_data_files + (Filename.concat + (datarootdir ()) + pkg.name); + f_data () + in + + (f_data, acc) + end + else + begin + (f_data, acc) + end + + in + + (* Install one group of library *) + let install_group_lib grp = + (* Iterate through all group nodes *) + let rec install_group_lib_aux data_and_files grp = + let data_and_files, children = + match grp with + | Container (_, children) -> + data_and_files, children + | Package (_, cs, bs, `Library lib, children) -> + files_of_library data_and_files (cs, bs, lib), children + | Package (_, cs, bs, `Object obj, children) -> + files_of_object data_and_files (cs, bs, obj), children + in + List.fold_left + install_group_lib_aux + data_and_files + children + in + + (* Findlib name of the root library *) + let findlib_name = + findlib_of_group grp + in + + (* Determine root library *) + let root_lib = + root_of_group grp + in + + (* All files to install for this library *) + let f_data, files = + install_group_lib_aux (ignore, []) grp + in + + (* Really install, if there is something to install *) + if files = [] then + begin + warning + (f_ "Nothing to install for findlib library '%s'") + findlib_name + end + else + begin + let meta = + (* Search META file *) + let _, bs, _ = + root_lib + in + let res = + Filename.concat bs.bs_path "META" + in + if not (OASISFileUtil.file_exists_case res) then + failwithf + (f_ "Cannot find file '%s' for findlib library %s") + res + findlib_name; + res + in + let files = + (* Make filename shorter to avoid hitting command max line length + * too early, esp. on Windows. + *) + let remove_prefix p n = + let plen = String.length p in + let nlen = String.length n in + if plen <= nlen && String.sub n 0 plen = p then + begin + let fn_sep = + if Sys.os_type = "Win32" then + '\\' + else + '/' + in + let cutpoint = plen + + (if plen < nlen && n.[plen] = fn_sep then + 1 + else + 0) + in + String.sub n cutpoint (nlen - cutpoint) + end + else + n + in + List.map (remove_prefix (Sys.getcwd ())) files + in + info + (f_ "Installing findlib library '%s'") + findlib_name; + let ocamlfind = ocamlfind () in + let commands = + split_install_command + ocamlfind + findlib_name + meta + files + in + List.iter + (OASISExec.run ~ctxt:!BaseContext.default ocamlfind) + commands; + BaseLog.register install_findlib_ev findlib_name + end; + + (* Install data files *) + f_data (); + + in + + let group_libs, _, _ = + findlib_mapping pkg + in + + (* We install libraries in groups *) + List.iter install_group_lib group_libs + in + + let install_execs pkg = + let install_exec data_exec = + let cs, bs, exec = + !exec_hook data_exec + in + if var_choose bs.bs_install && + BaseBuilt.is_built BaseBuilt.BExec cs.cs_name then + begin + let exec_libdir () = + Filename.concat + (libdir ()) + pkg.name + in + BaseBuilt.fold + BaseBuilt.BExec + cs.cs_name + (fun () fn -> + install_file + ~tgt_fn:(cs.cs_name ^ ext_program ()) + fn + bindir) + (); + BaseBuilt.fold + BaseBuilt.BExecLib + cs.cs_name + (fun () fn -> + install_file + fn + exec_libdir) + (); + install_data + bs.bs_path + bs.bs_data_files + (Filename.concat + (datarootdir ()) + pkg.name) + end + in + List.iter + (function + | Executable (cs, bs, exec)-> + install_exec (cs, bs, exec) + | _ -> + ()) + pkg.sections + in + + let install_docs pkg = + let install_doc data = + let cs, doc = + !doc_hook data + in + if var_choose doc.doc_install && + BaseBuilt.is_built BaseBuilt.BDoc cs.cs_name then + begin + let tgt_dir = + OASISHostPath.of_unix (var_expand doc.doc_install_dir) + in + BaseBuilt.fold + BaseBuilt.BDoc + cs.cs_name + (fun () fn -> + install_file + fn + (fun () -> tgt_dir)) + (); + install_data + Filename.current_dir_name + doc.doc_data_files + doc.doc_install_dir + end + in + List.iter + (function + | Doc (cs, doc) -> + install_doc (cs, doc) + | _ -> + ()) + pkg.sections + in + + install_libs pkg; + install_execs pkg; + install_docs pkg + + + (* Uninstall already installed data *) + let uninstall _ argv = + List.iter + (fun (ev, data) -> + if ev = install_file_ev then + begin + if OASISFileUtil.file_exists_case data then + begin + info + (f_ "Removing file '%s'") + data; + Sys.remove data + end + else + begin + warning + (f_ "File '%s' doesn't exist anymore") + data + end + end + else if ev = install_dir_ev then + begin + if Sys.file_exists data && Sys.is_directory data then + begin + if Sys.readdir data = [||] then + begin + info + (f_ "Removing directory '%s'") + data; + OASISFileUtil.rmdir ~ctxt:!BaseContext.default data + end + else + begin + warning + (f_ "Directory '%s' is not empty (%s)") + data + (String.concat + ", " + (Array.to_list + (Sys.readdir data))) + end + end + else + begin + warning + (f_ "Directory '%s' doesn't exist anymore") + data + end + end + else if ev = install_findlib_ev then + begin + info (f_ "Removing findlib library '%s'") data; + OASISExec.run ~ctxt:!BaseContext.default + (ocamlfind ()) ["remove"; data] + end + else + failwithf (f_ "Unknown log event '%s'") ev; + BaseLog.unregister ev data) + (* We process event in reverse order *) + (List.rev + (BaseLog.filter + [install_file_ev; + install_dir_ev; + install_findlib_ev])) + + +end + + +# 6296 "setup.ml" +module OCamlbuildCommon = struct +(* # 22 "src/plugins/ocamlbuild/OCamlbuildCommon.ml" *) + + + (** Functions common to OCamlbuild build and doc plugin + *) + + + open OASISGettext + open BaseEnv + open BaseStandardVar + open OASISTypes + + + + + type extra_args = string list + + + let ocamlbuild_clean_ev = "ocamlbuild-clean" + + + let ocamlbuildflags = + var_define + ~short_desc:(fun () -> "OCamlbuild additional flags") + "ocamlbuildflags" + (fun () -> "") + + + (** Fix special arguments depending on environment *) + let fix_args args extra_argv = + List.flatten + [ + if (os_type ()) = "Win32" then + [ + "-classic-display"; + "-no-log"; + "-no-links"; + "-install-lib-dir"; + (Filename.concat (standard_library ()) "ocamlbuild") + ] + else + []; + + if not (bool_of_string (is_native ())) || (os_type ()) = "Win32" then + [ + "-byte-plugin" + ] + else + []; + args; + + if bool_of_string (debug ()) then + ["-tag"; "debug"] + else + []; + + if bool_of_string (tests ()) then + ["-tag"; "tests"] + else + []; + + if bool_of_string (profile ()) then + ["-tag"; "profile"] + else + []; + + OASISString.nsplit (ocamlbuildflags ()) ' '; + + Array.to_list extra_argv; + ] + + + (** Run 'ocamlbuild -clean' if not already done *) + let run_clean extra_argv = + let extra_cli = + String.concat " " (Array.to_list extra_argv) + in + (* Run if never called with these args *) + if not (BaseLog.exists ocamlbuild_clean_ev extra_cli) then + begin + OASISExec.run ~ctxt:!BaseContext.default + (ocamlbuild ()) (fix_args ["-clean"] extra_argv); + BaseLog.register ocamlbuild_clean_ev extra_cli; + at_exit + (fun () -> + try + BaseLog.unregister ocamlbuild_clean_ev extra_cli + with _ -> + ()) + end + + + (** Run ocamlbuild, unregister all clean events *) + let run_ocamlbuild args extra_argv = + (* TODO: enforce that target in args must be UNIX encoded i.e. toto/index.html + *) + OASISExec.run ~ctxt:!BaseContext.default + (ocamlbuild ()) (fix_args args extra_argv); + (* Remove any clean event, we must run it again *) + List.iter + (fun (e, d) -> BaseLog.unregister e d) + (BaseLog.filter [ocamlbuild_clean_ev]) + + + (** Determine real build directory *) + let build_dir extra_argv = + let rec search_args dir = + function + | "-build-dir" :: dir :: tl -> + search_args dir tl + | _ :: tl -> + search_args dir tl + | [] -> + dir + in + search_args "_build" (fix_args [] extra_argv) + + +end + +module OCamlbuildPlugin = struct +(* # 22 "src/plugins/ocamlbuild/OCamlbuildPlugin.ml" *) + + + (** Build using ocamlbuild + @author Sylvain Le Gall + *) + + + open OASISTypes + open OASISGettext + open OASISUtils + open OASISString + open BaseEnv + open OCamlbuildCommon + open BaseStandardVar + open BaseMessage + + + + + + let cond_targets_hook = + ref (fun lst -> lst) + + + let build extra_args pkg argv = + (* Return the filename in build directory *) + let in_build_dir fn = + Filename.concat + (build_dir argv) + fn + in + + (* Return the unix filename in host build directory *) + let in_build_dir_of_unix fn = + in_build_dir (OASISHostPath.of_unix fn) + in + + let cond_targets = + List.fold_left + (fun acc -> + function + | Library (cs, bs, lib) when var_choose bs.bs_build -> + begin + let evs, unix_files = + BaseBuilt.of_library + in_build_dir_of_unix + (cs, bs, lib) + in + + let tgts = + List.flatten + (List.filter + (fun l -> l <> []) + (List.map + (List.filter + (fun fn -> + ends_with ~what:".cma" fn + || ends_with ~what:".cmxs" fn + || ends_with ~what:".cmxa" fn + || ends_with ~what:(ext_lib ()) fn + || ends_with ~what:(ext_dll ()) fn)) + unix_files)) + in + + match tgts with + | _ :: _ -> + (evs, tgts) :: acc + | [] -> + failwithf + (f_ "No possible ocamlbuild targets for library %s") + cs.cs_name + end + + | Object (cs, bs, obj) when var_choose bs.bs_build -> + begin + let evs, unix_files = + BaseBuilt.of_object + in_build_dir_of_unix + (cs, bs, obj) + in + + let tgts = + List.flatten + (List.filter + (fun l -> l <> []) + (List.map + (List.filter + (fun fn -> + ends_with ".cmo" fn + || ends_with ".cmx" fn)) + unix_files)) + in + + match tgts with + | _ :: _ -> + (evs, tgts) :: acc + | [] -> + failwithf + (f_ "No possible ocamlbuild targets for object %s") + cs.cs_name + end + + | Executable (cs, bs, exec) when var_choose bs.bs_build -> + begin + let evs, unix_exec_is, unix_dll_opt = + BaseBuilt.of_executable + in_build_dir_of_unix + (cs, bs, exec) + in + + let target ext = + let unix_tgt = + (OASISUnixPath.concat + bs.bs_path + (OASISUnixPath.chop_extension + exec.exec_main_is))^ext + in + let evs = + (* Fix evs, we want to use the unix_tgt, without copying *) + List.map + (function + | BaseBuilt.BExec, nm, lst when nm = cs.cs_name -> + BaseBuilt.BExec, nm, + [[in_build_dir_of_unix unix_tgt]] + | ev -> + ev) + evs + in + evs, [unix_tgt] + in + + (* Add executable *) + let acc = + match bs.bs_compiled_object with + | Native -> + (target ".native") :: acc + | Best when bool_of_string (is_native ()) -> + (target ".native") :: acc + | Byte + | Best -> + (target ".byte") :: acc + in + acc + end + + | Library _ | Object _ | Executable _ | Test _ + | SrcRepo _ | Flag _ | Doc _ -> + acc) + [] + (* Keep the pkg.sections ordered *) + (List.rev pkg.sections); + in + + (* Check and register built files *) + let check_and_register (bt, bnm, lst) = + List.iter + (fun fns -> + if not (List.exists OASISFileUtil.file_exists_case fns) then + failwithf + (fn_ + "Expected built file %s doesn't exist." + "None of expected built files %s exists." + (List.length fns)) + (String.concat (s_ " or ") (List.map (Printf.sprintf "'%s'") fns))) + lst; + (BaseBuilt.register bt bnm lst) + in + + (* Run the hook *) + let cond_targets = !cond_targets_hook cond_targets in + + (* Run a list of target... *) + run_ocamlbuild (List.flatten (List.map snd cond_targets) @ extra_args) argv; + (* ... and register events *) + List.iter check_and_register (List.flatten (List.map fst cond_targets)) + + + let clean pkg extra_args = + run_clean extra_args; + List.iter + (function + | Library (cs, _, _) -> + BaseBuilt.unregister BaseBuilt.BLib cs.cs_name + | Executable (cs, _, _) -> + BaseBuilt.unregister BaseBuilt.BExec cs.cs_name; + BaseBuilt.unregister BaseBuilt.BExecLib cs.cs_name + | _ -> + ()) + pkg.sections + + +end + +module OCamlbuildDocPlugin = struct +(* # 22 "src/plugins/ocamlbuild/OCamlbuildDocPlugin.ml" *) + + + (* Create documentation using ocamlbuild .odocl files + @author Sylvain Le Gall + *) + + + open OASISTypes + open OASISGettext + open OASISMessage + open OCamlbuildCommon + open BaseStandardVar + + + + + type run_t = + { + extra_args: string list; + run_path: unix_filename; + } + + + let doc_build run pkg (cs, doc) argv = + let index_html = + OASISUnixPath.make + [ + run.run_path; + cs.cs_name^".docdir"; + "index.html"; + ] + in + let tgt_dir = + OASISHostPath.make + [ + build_dir argv; + OASISHostPath.of_unix run.run_path; + cs.cs_name^".docdir"; + ] + in + run_ocamlbuild (index_html :: run.extra_args) argv; + List.iter + (fun glb -> + BaseBuilt.register + BaseBuilt.BDoc + cs.cs_name + [OASISFileUtil.glob ~ctxt:!BaseContext.default + (Filename.concat tgt_dir glb)]) + ["*.html"; "*.css"] + + + let doc_clean run pkg (cs, doc) argv = + run_clean argv; + BaseBuilt.unregister BaseBuilt.BDoc cs.cs_name + + +end + + +# 6674 "setup.ml" +module CustomPlugin = struct +(* # 22 "src/plugins/custom/CustomPlugin.ml" *) + + + (** Generate custom configure/build/doc/test/install system + @author + *) + + + open BaseEnv + open OASISGettext + open OASISTypes + + + + + + type t = + { + cmd_main: command_line conditional; + cmd_clean: (command_line option) conditional; + cmd_distclean: (command_line option) conditional; + } + + + let run = BaseCustom.run + + + let main t _ extra_args = + let cmd, args = + var_choose + ~name:(s_ "main command") + t.cmd_main + in + run cmd args extra_args + + + let clean t pkg extra_args = + match var_choose t.cmd_clean with + | Some (cmd, args) -> + run cmd args extra_args + | _ -> + () + + + let distclean t pkg extra_args = + match var_choose t.cmd_distclean with + | Some (cmd, args) -> + run cmd args extra_args + | _ -> + () + + + module Build = + struct + let main t pkg extra_args = + main t pkg extra_args; + List.iter + (fun sct -> + let evs = + match sct with + | Library (cs, bs, lib) when var_choose bs.bs_build -> + begin + let evs, _ = + BaseBuilt.of_library + OASISHostPath.of_unix + (cs, bs, lib) + in + evs + end + | Executable (cs, bs, exec) when var_choose bs.bs_build -> + begin + let evs, _, _ = + BaseBuilt.of_executable + OASISHostPath.of_unix + (cs, bs, exec) + in + evs + end + | _ -> + [] + in + List.iter + (fun (bt, bnm, lst) -> BaseBuilt.register bt bnm lst) + evs) + pkg.sections + + let clean t pkg extra_args = + clean t pkg extra_args; + (* TODO: this seems to be pretty generic (at least wrt to ocamlbuild + * considering moving this to BaseSetup? + *) + List.iter + (function + | Library (cs, _, _) -> + BaseBuilt.unregister BaseBuilt.BLib cs.cs_name + | Executable (cs, _, _) -> + BaseBuilt.unregister BaseBuilt.BExec cs.cs_name; + BaseBuilt.unregister BaseBuilt.BExecLib cs.cs_name + | _ -> + ()) + pkg.sections + + let distclean t pkg extra_args = + distclean t pkg extra_args + end + + + module Test = + struct + let main t pkg (cs, test) extra_args = + try + main t pkg extra_args; + 0.0 + with Failure s -> + BaseMessage.warning + (f_ "Test '%s' fails: %s") + cs.cs_name + s; + 1.0 + + let clean t pkg (cs, test) extra_args = + clean t pkg extra_args + + let distclean t pkg (cs, test) extra_args = + distclean t pkg extra_args + end + + + module Doc = + struct + let main t pkg (cs, _) extra_args = + main t pkg extra_args; + BaseBuilt.register BaseBuilt.BDoc cs.cs_name [] + + let clean t pkg (cs, _) extra_args = + clean t pkg extra_args; + BaseBuilt.unregister BaseBuilt.BDoc cs.cs_name + + let distclean t pkg (cs, _) extra_args = + distclean t pkg extra_args + end + + +end + + +# 6822 "setup.ml" +open OASISTypes;; + +let setup_t = + { + BaseSetup.configure = InternalConfigurePlugin.configure; + build = OCamlbuildPlugin.build []; + test = + [ + ("test", + CustomPlugin.Test.main + { + CustomPlugin.cmd_main = + [(OASISExpr.EBool true, ("$test", []))]; + cmd_clean = [(OASISExpr.EBool true, None)]; + cmd_distclean = [(OASISExpr.EBool true, None)] + }) + ]; + doc = + [ + ("api", + OCamlbuildDocPlugin.doc_build + {OCamlbuildDocPlugin.extra_args = []; run_path = "./"}) + ]; + install = InternalInstallPlugin.install; + uninstall = InternalInstallPlugin.uninstall; + clean = [OCamlbuildPlugin.clean]; + clean_test = + [ + ("test", + CustomPlugin.Test.clean + { + CustomPlugin.cmd_main = + [(OASISExpr.EBool true, ("$test", []))]; + cmd_clean = [(OASISExpr.EBool true, None)]; + cmd_distclean = [(OASISExpr.EBool true, None)] + }) + ]; + clean_doc = + [ + ("api", + OCamlbuildDocPlugin.doc_clean + {OCamlbuildDocPlugin.extra_args = []; run_path = "./"}) + ]; + distclean = []; + distclean_test = + [ + ("test", + CustomPlugin.Test.distclean + { + CustomPlugin.cmd_main = + [(OASISExpr.EBool true, ("$test", []))]; + cmd_clean = [(OASISExpr.EBool true, None)]; + cmd_distclean = [(OASISExpr.EBool true, None)] + }) + ]; + distclean_doc = []; + package = + { + oasis_version = "0.3"; + ocaml_version = None; + findlib_version = None; + alpha_features = []; + beta_features = []; + name = "ocplib-endian"; + version = "1.0"; + license = + OASISLicense.DEP5License + (OASISLicense.DEP5Unit + { + OASISLicense.license = "LGPL"; + excption = Some "OCaml linking"; + version = OASISLicense.Version "2.1" + }); + license_file = None; + copyrights = []; + maintainers = []; + authors = ["Pierre Chambart"]; + homepage = None; + synopsis = + "Optimised functions to read and write int16/32/64 from strings and\nbigarrays"; + description = None; + categories = []; + conf_type = (`Configure, "internal", Some "0.4"); + conf_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + build_type = (`Build, "ocamlbuild", Some "0.4"); + build_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + install_type = (`Install, "internal", Some "0.4"); + install_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + uninstall_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + clean_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + distclean_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + files_ab = []; + sections = + [ + Library + ({ + cs_name = "ocplib_endian"; + cs_data = PropList.Data.create (); + cs_plugin_data = [] + }, + { + bs_build = [(OASISExpr.EBool true, true)]; + bs_install = [(OASISExpr.EBool true, true)]; + bs_path = "src"; + bs_compiled_object = Best; + bs_build_depends = [FindlibPackage ("bytes", None)]; + bs_build_tools = [ExternalTool "ocamlbuild"]; + bs_c_sources = []; + bs_data_files = []; + bs_ccopt = [(OASISExpr.EBool true, [])]; + bs_cclib = [(OASISExpr.EBool true, [])]; + bs_dlllib = [(OASISExpr.EBool true, [])]; + bs_dllpath = [(OASISExpr.EBool true, [])]; + bs_byteopt = [(OASISExpr.EBool true, [])]; + bs_nativeopt = [(OASISExpr.EBool true, [])] + }, + { + lib_modules = ["EndianString"; "EndianBytes"]; + lib_pack = false; + lib_internal_modules = []; + lib_findlib_parent = None; + lib_findlib_name = Some "ocplib-endian"; + lib_findlib_containers = [] + }); + Library + ({ + cs_name = "bigstring"; + cs_data = PropList.Data.create (); + cs_plugin_data = [] + }, + { + bs_build = [(OASISExpr.EBool true, true)]; + bs_install = [(OASISExpr.EBool true, true)]; + bs_path = "src"; + bs_compiled_object = Best; + bs_build_depends = + [ + FindlibPackage ("bigarray", None); + FindlibPackage ("bytes", None) + ]; + bs_build_tools = [ExternalTool "ocamlbuild"]; + bs_c_sources = []; + bs_data_files = []; + bs_ccopt = [(OASISExpr.EBool true, [])]; + bs_cclib = [(OASISExpr.EBool true, [])]; + bs_dlllib = [(OASISExpr.EBool true, [])]; + bs_dllpath = [(OASISExpr.EBool true, [])]; + bs_byteopt = [(OASISExpr.EBool true, [])]; + bs_nativeopt = [(OASISExpr.EBool true, [])] + }, + { + lib_modules = ["EndianBigstring"]; + lib_pack = false; + lib_internal_modules = []; + lib_findlib_parent = Some "ocplib_endian"; + lib_findlib_name = Some "bigstring"; + lib_findlib_containers = [] + }); + Executable + ({ + cs_name = "test"; + cs_data = PropList.Data.create (); + cs_plugin_data = [] + }, + { + bs_build = + [ + (OASISExpr.EBool true, false); + (OASISExpr.EFlag "tests", true) + ]; + bs_install = [(OASISExpr.EBool true, false)]; + bs_path = "tests"; + bs_compiled_object = Best; + bs_build_depends = + [ + InternalLibrary "ocplib_endian"; + InternalLibrary "bigstring" + ]; + bs_build_tools = [ExternalTool "ocamlbuild"]; + bs_c_sources = []; + bs_data_files = []; + bs_ccopt = [(OASISExpr.EBool true, [])]; + bs_cclib = [(OASISExpr.EBool true, [])]; + bs_dlllib = [(OASISExpr.EBool true, [])]; + bs_dllpath = [(OASISExpr.EBool true, [])]; + bs_byteopt = [(OASISExpr.EBool true, [])]; + bs_nativeopt = [(OASISExpr.EBool true, [])] + }, + {exec_custom = false; exec_main_is = "test.ml"}); + Executable + ({ + cs_name = "benchmark"; + cs_data = PropList.Data.create (); + cs_plugin_data = [] + }, + { + bs_build = + [ + (OASISExpr.EBool true, false); + (OASISExpr.EFlag "tests", true) + ]; + bs_install = [(OASISExpr.EBool true, false)]; + bs_path = "tests"; + bs_compiled_object = Best; + bs_build_depends = + [ + InternalLibrary "ocplib_endian"; + InternalLibrary "bigstring" + ]; + bs_build_tools = [ExternalTool "ocamlbuild"]; + bs_c_sources = []; + bs_data_files = []; + bs_ccopt = [(OASISExpr.EBool true, [])]; + bs_cclib = [(OASISExpr.EBool true, [])]; + bs_dlllib = [(OASISExpr.EBool true, [])]; + bs_dllpath = [(OASISExpr.EBool true, [])]; + bs_byteopt = [(OASISExpr.EBool true, [])]; + bs_nativeopt = [(OASISExpr.EBool true, [])] + }, + {exec_custom = false; exec_main_is = "bench.ml"}); + Test + ({ + cs_name = "test"; + cs_data = PropList.Data.create (); + cs_plugin_data = [] + }, + { + test_type = (`Test, "custom", Some "0.4"); + test_command = [(OASISExpr.EBool true, ("$test", []))]; + test_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + test_working_directory = None; + test_run = + [ + (OASISExpr.ENot (OASISExpr.EFlag "tests"), false); + (OASISExpr.EFlag "tests", false); + (OASISExpr.EAnd + (OASISExpr.EFlag "tests", + OASISExpr.EFlag "tests"), + true) + ]; + test_tools = + [ExternalTool "ocamlbuild"; InternalExecutable "test" + ] + }); + Doc + ({ + cs_name = "api"; + cs_data = PropList.Data.create (); + cs_plugin_data = [] + }, + { + doc_type = (`Doc, "ocamlbuild", Some "0.3"); + doc_custom = + { + pre_command = [(OASISExpr.EBool true, None)]; + post_command = [(OASISExpr.EBool true, None)] + }; + doc_build = + [ + (OASISExpr.ENot (OASISExpr.EFlag "docs"), false); + (OASISExpr.EFlag "docs", true) + ]; + doc_install = [(OASISExpr.EBool true, true)]; + doc_install_dir = "$docdir"; + doc_title = "API reference for ocplib-endian"; + doc_authors = []; + doc_abstract = None; + doc_format = OtherDoc; + doc_data_files = []; + doc_build_tools = + [ExternalTool "ocamlbuild"; ExternalTool "ocamldoc"] + }); + SrcRepo + ({ + cs_name = "head"; + cs_data = PropList.Data.create (); + cs_plugin_data = [] + }, + { + src_repo_type = Git; + src_repo_location = + "https://github.com/OCamlPro/ocplib-endian.git"; + src_repo_browser = + Some "https://github.com/OCamlPro/ocplib-endian"; + src_repo_module = None; + src_repo_branch = None; + src_repo_tag = None; + src_repo_subdir = None + }) + ]; + plugins = + [(`Extra, "DevFiles", Some "0.3"); (`Extra, "META", Some "0.3")]; + disable_oasis_section = []; + schema_data = PropList.Data.create (); + plugin_data = [] + }; + oasis_fn = Some "_oasis"; + oasis_version = "0.4.6"; + oasis_digest = Some "\168YR7n\1347\1363)\206\003\012\168\141t"; + oasis_exec = None; + oasis_setup_args = []; + setup_update = false + };; + +let setup () = BaseSetup.setup setup_t;; + +# 7158 "setup.ml" +(* OASIS_STOP *) + +let () = + InternalInstallPlugin.lib_hook := + fun (cs, bs, lib) -> + match lib.OASISTypes.lib_findlib_name with + | Some "ocplib-endian" -> + (cs, bs, lib, ["_build/src/endianString.mli"; "_build/src/endianBytes.mli"]) + | Some "bigstring" -> + (cs, bs, lib, ["_build/src/endianBigstring.mli"]) + | _ -> + (cs, bs, lib, []) +;; + +let () = setup ();; diff --git a/src/META b/src/META new file mode 100644 index 0000000..4b83b01 --- /dev/null +++ b/src/META @@ -0,0 +1,24 @@ +# OASIS_START +# DO NOT EDIT (digest: b678317118db25f5e609c9c42e12deae) +version = "1.0" +description = +"Optimised functions to read and write int16/32/64 from strings and bigarrays" +requires = "bytes" +archive(byte) = "ocplib_endian.cma" +archive(byte, plugin) = "ocplib_endian.cma" +archive(native) = "ocplib_endian.cmxa" +archive(native, plugin) = "ocplib_endian.cmxs" +exists_if = "ocplib_endian.cma" +package "bigstring" ( + version = "1.0" + description = + "Optimised functions to read and write int16/32/64 from strings and bigarrays" + requires = "bigarray bytes" + archive(byte) = "bigstring.cma" + archive(byte, plugin) = "bigstring.cma" + archive(native) = "bigstring.cmxa" + archive(native, plugin) = "bigstring.cmxs" + exists_if = "bigstring.cma" +) +# OASIS_STOP + diff --git a/src/be_ocaml_400.ml b/src/be_ocaml_400.ml new file mode 100644 index 0000000..310aa51 --- /dev/null +++ b/src/be_ocaml_400.ml @@ -0,0 +1,28 @@ + let get_uint16 s off = + let hi = get_uint8 s off in + let lo = get_uint8 s (off+1) in + (hi lsl 8) + lo + + let get_int16 s off = + sign16 (get_uint16 s off) + + let get_int32 s off = + let hi = get_uint16 s off in + let lo = get_uint16 s (off+2) in + Int32.(logor (shift_left (of_int hi) 16) (of_int lo)) + + let get_int64 s off = + Int64.(logor (shift_left (of_int32 (get_int32 s off)) 32) + (logand (of_int32 (get_int32 s (off+4))) 0xffffffff_L)) + + let set_int16 s off v = + set_int8 s off (v lsr 8); + set_int8 s (off+1) (v land 0xff) + + let set_int32 s off v = + set_int16 s off (Int32.(to_int (shift_right_logical v 16))); + set_int16 s (off+2) (Int32.(to_int (logand v 0xffff_l))) + + let set_int64 s off v = + set_int32 s off (Int64.(to_int32 (shift_right_logical v 32))); + set_int32 s (off+4) (Int64.(to_int32 (logand v 0xffffffff_L))) diff --git a/src/be_ocaml_401.ml b/src/be_ocaml_401.ml new file mode 100644 index 0000000..38de28c --- /dev/null +++ b/src/be_ocaml_401.ml @@ -0,0 +1,32 @@ + let get_uint16 s off = + if not Sys.big_endian + then swap16 (get_16 s off) + else get_16 s off + + let get_int16 s off = + ((get_uint16 s off) lsl ( Sys.word_size - 17 )) asr ( Sys.word_size - 17 ) + + let get_int32 s off = + if not Sys.big_endian + then swap32 (get_32 s off) + else get_32 s off + + let get_int64 s off = + if not Sys.big_endian + then swap64 (get_64 s off) + else get_64 s off + + let set_int16 s off v = + if not Sys.big_endian + then (set_16 s off (swap16 v)) + else set_16 s off v + + let set_int32 s off v = + if not Sys.big_endian + then set_32 s off (swap32 v) + else set_32 s off v + + let set_int64 s off v = + if not Sys.big_endian + then set_64 s off (swap64 v) + else set_64 s off v diff --git a/src/bigstring.mldylib b/src/bigstring.mldylib new file mode 100644 index 0000000..ac5ae9e --- /dev/null +++ b/src/bigstring.mldylib @@ -0,0 +1,4 @@ +# OASIS_START +# DO NOT EDIT (digest: 13441c87c5f1bc75fb23bce104d0d6a4) +EndianBigstring +# OASIS_STOP diff --git a/src/bigstring.mllib b/src/bigstring.mllib new file mode 100644 index 0000000..ac5ae9e --- /dev/null +++ b/src/bigstring.mllib @@ -0,0 +1,4 @@ +# OASIS_START +# DO NOT EDIT (digest: 13441c87c5f1bc75fb23bce104d0d6a4) +EndianBigstring +# OASIS_STOP diff --git a/src/common.ml b/src/common.ml new file mode 100644 index 0000000..269dc29 --- /dev/null +++ b/src/common.ml @@ -0,0 +1,22 @@ +let sign8 v = + (v lsl ( Sys.word_size - 9 )) asr ( Sys.word_size - 9 ) + +let sign16 v = + (v lsl ( Sys.word_size - 17 )) asr ( Sys.word_size - 17 ) + +let get_uint8 s off = + Char.code (get_char s off) +let get_int8 s off = + ((get_uint8 s off) lsl ( Sys.word_size - 9 )) asr ( Sys.word_size - 9 ) +let set_int8 s off v = + (* It is ok to cast using unsafe_chr because both String.set + and Bigarray.Array1.set (on bigstrings) use the 'store unsigned int8' + primitives that effectively extract the bits before writing *) + set_char s off (Char.unsafe_chr v) + +let unsafe_get_uint8 s off = + Char.code (unsafe_get_char s off) +let unsafe_get_int8 s off = + ((unsafe_get_uint8 s off) lsl ( Sys.word_size - 9 )) asr ( Sys.word_size - 9 ) +let unsafe_set_int8 s off v = + unsafe_set_char s off (Char.unsafe_chr v) diff --git a/src/common_400.cppo.ml b/src/common_400.cppo.ml new file mode 100644 index 0000000..e5d4c40 --- /dev/null +++ b/src/common_400.cppo.ml @@ -0,0 +1,79 @@ +module BigEndian = struct + + let get_char = get_char + let get_uint8 = get_uint8 + let get_int8 = get_int8 + let set_char = set_char + let set_int8 = set_int8 + +#include "be_ocaml_400.ml" +#include "common_float.ml" + +end + +module BigEndian_unsafe = struct + + let get_char = unsafe_get_char + let get_uint8 = unsafe_get_uint8 + let get_int8 = unsafe_get_int8 + let set_char = unsafe_set_char + let set_int8 = unsafe_set_int8 + +#include "be_ocaml_400.ml" +#include "common_float.ml" + +end + +module LittleEndian = struct + + let get_char = get_char + let get_uint8 = get_uint8 + let get_int8 = get_int8 + let set_char = set_char + let set_int8 = set_int8 + +#include "le_ocaml_400.ml" +#include "common_float.ml" + +end + +module LittleEndian_unsafe = struct + + let get_char = unsafe_get_char + let get_uint8 = unsafe_get_uint8 + let get_int8 = unsafe_get_int8 + let set_char = unsafe_set_char + let set_int8 = unsafe_set_int8 + +#include "le_ocaml_400.ml" +#include "common_float.ml" + +end + +#if OCAML_VERSION >= (4, 00, 0) +module NativeEndian = struct + + let get_char = get_char + let get_uint8 = get_uint8 + let get_int8 = get_int8 + let set_char = set_char + let set_int8 = set_int8 + +#include "ne_ocaml_400.ml" +#include "common_float.ml" + +end + +module NativeEndian_unsafe = struct + + let get_char = unsafe_get_char + let get_uint8 = unsafe_get_uint8 + let get_int8 = unsafe_get_int8 + let set_char = unsafe_set_char + let set_int8 = unsafe_set_int8 + +#include "ne_ocaml_400.ml" +#include "common_float.ml" + +end +#endif diff --git a/src/common_401.cppo.ml b/src/common_401.cppo.ml new file mode 100644 index 0000000..eba9509 --- /dev/null +++ b/src/common_401.cppo.ml @@ -0,0 +1,100 @@ +external swap16 : int -> int = "%bswap16" +external swap32 : int32 -> int32 = "%bswap_int32" +external swap64 : int64 -> int64 = "%bswap_int64" +external swapnative : nativeint -> nativeint = "%bswap_native" + +module BigEndian = struct + + let get_char = get_char + let get_uint8 = get_uint8 + let get_int8 = get_int8 + let set_char = set_char + let set_int8 = set_int8 + +#include "be_ocaml_401.ml" +#include "common_float.ml" + +end + +module BigEndian_unsafe = struct + + let get_char = unsafe_get_char + let get_uint8 = unsafe_get_uint8 + let get_int8 = unsafe_get_int8 + let set_char = unsafe_set_char + let set_int8 = unsafe_set_int8 + let get_16 = unsafe_get_16 + let get_32 = unsafe_get_32 + let get_64 = unsafe_get_64 + let set_16 = unsafe_set_16 + let set_32 = unsafe_set_32 + let set_64 = unsafe_set_64 + +#include "be_ocaml_401.ml" +#include "common_float.ml" + +end + +module LittleEndian = struct + + let get_char = get_char + let get_uint8 = get_uint8 + let get_int8 = get_int8 + let set_char = set_char + let set_int8 = set_int8 + +#include "le_ocaml_401.ml" +#include "common_float.ml" + +end + +module LittleEndian_unsafe = struct + + let get_char = unsafe_get_char + let get_uint8 = unsafe_get_uint8 + let get_int8 = unsafe_get_int8 + let set_char = unsafe_set_char + let set_int8 = unsafe_set_int8 + let get_16 = unsafe_get_16 + let get_32 = unsafe_get_32 + let get_64 = unsafe_get_64 + let set_16 = unsafe_set_16 + let set_32 = unsafe_set_32 + let set_64 = unsafe_set_64 + +#include "le_ocaml_401.ml" +#include "common_float.ml" + +end + +module NativeEndian = struct + + let get_char = get_char + let get_uint8 = get_uint8 + let get_int8 = get_int8 + let set_char = set_char + let set_int8 = set_int8 + +#include "ne_ocaml_401.ml" +#include "common_float.ml" + +end + +module NativeEndian_unsafe = struct + + let get_char = unsafe_get_char + let get_uint8 = unsafe_get_uint8 + let get_int8 = unsafe_get_int8 + let set_char = unsafe_set_char + let set_int8 = unsafe_set_int8 + let get_16 = unsafe_get_16 + let get_32 = unsafe_get_32 + let get_64 = unsafe_get_64 + let set_16 = unsafe_set_16 + let set_32 = unsafe_set_32 + let set_64 = unsafe_set_64 + +#include "ne_ocaml_401.ml" +#include "common_float.ml" + +end diff --git a/src/common_float.ml b/src/common_float.ml new file mode 100644 index 0000000..3d28d2d --- /dev/null +++ b/src/common_float.ml @@ -0,0 +1,5 @@ + +let get_float buff i = Int32.float_of_bits (get_int32 buff i) +let get_double buff i = Int64.float_of_bits (get_int64 buff i) +let set_float buff i v = set_int32 buff i (Int32.bits_of_float v) +let set_double buff i v = set_int64 buff i (Int64.bits_of_float v) diff --git a/src/endianBigstring.cppo.ml b/src/endianBigstring.cppo.ml new file mode 100644 index 0000000..21c3956 --- /dev/null +++ b/src/endianBigstring.cppo.ml @@ -0,0 +1,120 @@ +(************************************************************************) +(* ocplib-endian *) +(* *) +(* Copyright 2012 OCamlPro *) +(* *) +(* This file is distributed under the terms of the GNU Lesser General *) +(* Public License as published by the Free Software Foundation; either *) +(* version 2.1 of the License, or (at your option) any later version, *) +(* with the OCaml static compilation exception. *) +(* *) +(* ocplib-endian 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 General Public License for more details. *) +(* *) +(************************************************************************) + +open Bigarray + +type bigstring = (char, int8_unsigned_elt, c_layout) Array1.t + +module type EndianBigstringSig = sig + (** Functions reading according to Big Endian byte order *) + + val get_char : bigstring -> int -> char + (** [get_char buff i] reads 1 byte at offset i as a char *) + + val get_uint8 : bigstring -> int -> int + (** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8 + bits. i.e. It returns a value between 0 and 2^8-1 *) + + val get_int8 : bigstring -> int -> int + (** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8 + bits. i.e. It returns a value between -2^7 and 2^7-1 *) + + val get_uint16 : bigstring -> int -> int + (** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int + of 16 bits. i.e. It returns a value between 0 and 2^16-1 *) + + val get_int16 : bigstring -> int -> int + (** [get_int16 buff i] reads 2 byte at offset i as a signed int of + 16 bits. i.e. It returns a value between -2^15 and 2^15-1 *) + + val get_int32 : bigstring -> int -> int32 + (** [get_int32 buff i] reads 4 bytes at offset i as an int32. *) + + val get_int64 : bigstring -> int -> int64 + (** [get_int64 buff i] reads 8 bytes at offset i as an int64. *) + + val get_float : bigstring -> int -> float + (** [get_float buff i] is equivalent to + [Int32.float_of_bits (get_int32 buff i)] *) + + val get_double : bigstring -> int -> float + (** [get_double buff i] is equivalent to + [Int64.float_of_bits (get_int64 buff i)] *) + + val set_char : bigstring -> int -> char -> unit + (** [set_char buff i v] writes [v] to [buff] at offset [i] *) + + val set_int8 : bigstring -> int -> int -> unit + (** [set_int8 buff i v] writes the least significant 8 bits of [v] + to [buff] at offset [i] *) + + val set_int16 : bigstring -> int -> int -> unit + (** [set_int16 buff i v] writes the least significant 16 bits of [v] + to [buff] at offset [i] *) + + val set_int32 : bigstring -> int -> int32 -> unit + (** [set_int32 buff i v] writes [v] to [buff] at offset [i] *) + + val set_int64 : bigstring -> int -> int64 -> unit + (** [set_int64 buff i v] writes [v] to [buff] at offset [i] *) + + val set_float : bigstring -> int -> float -> unit + (** [set_float buff i v] is equivalent to + [set_int32 buff i (Int32.bits_of_float v)] *) + + val set_double : bigstring -> int -> float -> unit + (** [set_double buff i v] is equivalent to + [set_int64 buff i (Int64.bits_of_float v)] *) + +end + +let get_char (s:bigstring) off = + Array1.get s off +let set_char (s:bigstring) off v = + Array1.set s off v +let unsafe_get_char (s:bigstring) off = + Array1.unsafe_get s off +let unsafe_set_char (s:bigstring) off v = + Array1.unsafe_set s off v + +#include "common.ml" + +#if OCAML_VERSION >= (4, 01, 0) + +external unsafe_get_16 : bigstring -> int -> int = "%caml_bigstring_get16u" +external unsafe_get_32 : bigstring -> int -> int32 = "%caml_bigstring_get32u" +external unsafe_get_64 : bigstring -> int -> int64 = "%caml_bigstring_get64u" + +external unsafe_set_16 : bigstring -> int -> int -> unit = "%caml_bigstring_set16u" +external unsafe_set_32 : bigstring -> int -> int32 -> unit = "%caml_bigstring_set32u" +external unsafe_set_64 : bigstring -> int -> int64 -> unit = "%caml_bigstring_set64u" + +external get_16 : bigstring -> int -> int = "%caml_bigstring_get16" +external get_32 : bigstring -> int -> int32 = "%caml_bigstring_get32" +external get_64 : bigstring -> int -> int64 = "%caml_bigstring_get64" + +external set_16 : bigstring -> int -> int -> unit = "%caml_bigstring_set16" +external set_32 : bigstring -> int -> int32 -> unit = "%caml_bigstring_set32" +external set_64 : bigstring -> int -> int64 -> unit = "%caml_bigstring_set64" + +#include "common_401.ml" + +#else + +#include "common_400.ml" + +#endif diff --git a/src/endianBigstring.cppo.mli b/src/endianBigstring.cppo.mli new file mode 100644 index 0000000..24bba95 --- /dev/null +++ b/src/endianBigstring.cppo.mli @@ -0,0 +1,130 @@ +(************************************************************************) +(* ocplib-endian *) +(* *) +(* Copyright 2012 OCamlPro *) +(* *) +(* This file is distributed under the terms of the GNU Lesser General *) +(* Public License as published by the Free Software Foundation; either *) +(* version 2.1 of the License, or (at your option) any later version, *) +(* with the OCaml static compilation exception. *) +(* *) +(* ocplib-endian 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 General Public License for more details. *) +(* *) +(************************************************************************) + +open Bigarray +type bigstring = (char, int8_unsigned_elt, c_layout) Array1.t + +module type EndianBigstringSig = sig + (** Functions reading according to Big Endian byte order *) + + val get_char : bigstring -> int -> char + (** [get_char buff i] reads 1 byte at offset i as a char *) + + val get_uint8 : bigstring -> int -> int + (** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8 + bits. i.e. It returns a value between 0 and 2^8-1 *) + + val get_int8 : bigstring -> int -> int + (** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8 + bits. i.e. It returns a value between -2^7 and 2^7-1 *) + + val get_uint16 : bigstring -> int -> int + (** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int + of 16 bits. i.e. It returns a value between 0 and 2^16-1 *) + + val get_int16 : bigstring -> int -> int + (** [get_int16 buff i] reads 2 byte at offset i as a signed int of + 16 bits. i.e. It returns a value between -2^15 and 2^15-1 *) + + val get_int32 : bigstring -> int -> int32 + (** [get_int32 buff i] reads 4 bytes at offset i as an int32. *) + + val get_int64 : bigstring -> int -> int64 + (** [get_int64 buff i] reads 8 bytes at offset i as an int64. *) + + val get_float : bigstring -> int -> float + (** [get_float buff i] is equivalent to + [Int32.float_of_bits (get_int32 buff i)] *) + + val get_double : bigstring -> int -> float + (** [get_double buff i] is equivalent to + [Int64.float_of_bits (get_int64 buff i)] *) + + val set_char : bigstring -> int -> char -> unit + (** [set_char buff i v] writes [v] to [buff] at offset [i] *) + + val set_int8 : bigstring -> int -> int -> unit + (** [set_int8 buff i v] writes the least significant 8 bits of [v] + to [buff] at offset [i] *) + + val set_int16 : bigstring -> int -> int -> unit + (** [set_int16 buff i v] writes the least significant 16 bits of [v] + to [buff] at offset [i] *) + + val set_int32 : bigstring -> int -> int32 -> unit + (** [set_int32 buff i v] writes [v] to [buff] at offset [i] *) + + val set_int64 : bigstring -> int -> int64 -> unit + (** [set_int64 buff i v] writes [v] to [buff] at offset [i] *) + + val set_float : bigstring -> int -> float -> unit + (** [set_float buff i v] is equivalent to + [set_int32 buff i (Int32.bits_of_float v)] *) + + val set_double : bigstring -> int -> float -> unit + (** [set_double buff i v] is equivalent to + [set_int64 buff i (Int64.bits_of_float v)] *) + +end + +module BigEndian : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianBigstringSig + +end + +module BigEndian_unsafe : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianBigstringSig + +end + +module LittleEndian : sig + (** Functions reading according to Little Endian byte order *) + + include EndianBigstringSig + +end + +module LittleEndian_unsafe : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianBigstringSig + +end + +#if OCAML_VERSION >= (4, 00, 0) +module NativeEndian : sig + (** Functions reading according to machine endianness *) + + include EndianBigstringSig + +end + +module NativeEndian_unsafe : sig + (** Functions reading according to machine endianness without + checking for overflow *) + + include EndianBigstringSig + +end +#endif diff --git a/src/endianBytes.cppo.ml b/src/endianBytes.cppo.ml new file mode 100644 index 0000000..7c636b6 --- /dev/null +++ b/src/endianBytes.cppo.ml @@ -0,0 +1,116 @@ +(************************************************************************) +(* ocplib-endian *) +(* *) +(* Copyright 2014 OCamlPro *) +(* *) +(* This file is distributed under the terms of the GNU Lesser General *) +(* Public License as published by the Free Software Foundation; either *) +(* version 2.1 of the License, or (at your option) any later version, *) +(* with the OCaml static compilation exception. *) +(* *) +(* ocplib-endian 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 General Public License for more details. *) +(* *) +(************************************************************************) + +module type EndianBytesSig = sig + (** Functions reading according to Big Endian byte order *) + + val get_char : Bytes.t -> int -> char + (** [get_char buff i] reads 1 byte at offset i as a char *) + + val get_uint8 : Bytes.t -> int -> int + (** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8 + bits. i.e. It returns a value between 0 and 2^8-1 *) + + val get_int8 : Bytes.t -> int -> int + (** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8 + bits. i.e. It returns a value between -2^7 and 2^7-1 *) + + val get_uint16 : Bytes.t -> int -> int + (** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int + of 16 bits. i.e. It returns a value between 0 and 2^16-1 *) + + val get_int16 : Bytes.t -> int -> int + (** [get_int16 buff i] reads 2 byte at offset i as a signed int of + 16 bits. i.e. It returns a value between -2^15 and 2^15-1 *) + + val get_int32 : Bytes.t -> int -> int32 + (** [get_int32 buff i] reads 4 bytes at offset i as an int32. *) + + val get_int64 : Bytes.t -> int -> int64 + (** [get_int64 buff i] reads 8 bytes at offset i as an int64. *) + + val get_float : Bytes.t -> int -> float + (** [get_float buff i] is equivalent to + [Int32.float_of_bits (get_int32 buff i)] *) + + val get_double : Bytes.t -> int -> float + (** [get_double buff i] is equivalent to + [Int64.float_of_bits (get_int64 buff i)] *) + + val set_char : Bytes.t -> int -> char -> unit + (** [set_char buff i v] writes [v] to [buff] at offset [i] *) + + val set_int8 : Bytes.t -> int -> int -> unit + (** [set_int8 buff i v] writes the least significant 8 bits of [v] + to [buff] at offset [i] *) + + val set_int16 : Bytes.t -> int -> int -> unit + (** [set_int16 buff i v] writes the least significant 16 bits of [v] + to [buff] at offset [i] *) + + val set_int32 : Bytes.t -> int -> int32 -> unit + (** [set_int32 buff i v] writes [v] to [buff] at offset [i] *) + + val set_int64 : Bytes.t -> int -> int64 -> unit + (** [set_int64 buff i v] writes [v] to [buff] at offset [i] *) + + val set_float : Bytes.t -> int -> float -> unit + (** [set_float buff i v] is equivalent to + [set_int32 buff i (Int32.bits_of_float v)] *) + + val set_double : Bytes.t -> int -> float -> unit + (** [set_double buff i v] is equivalent to + [set_int64 buff i (Int64.bits_of_float v)] *) + +end + +let get_char (s:Bytes.t) off = + Bytes.get s off +let set_char (s:Bytes.t) off v = + Bytes.set s off v +let unsafe_get_char (s:Bytes.t) off = + Bytes.unsafe_get s off +let unsafe_set_char (s:Bytes.t) off v = + Bytes.unsafe_set s off v + +#include "common.ml" + +#if OCAML_VERSION >= (4, 01, 0) + +external unsafe_get_16 : Bytes.t -> int -> int = "%caml_string_get16u" +external unsafe_get_32 : Bytes.t -> int -> int32 = "%caml_string_get32u" +external unsafe_get_64 : Bytes.t -> int -> int64 = "%caml_string_get64u" + +external unsafe_set_16 : Bytes.t -> int -> int -> unit = "%caml_string_set16u" +external unsafe_set_32 : Bytes.t -> int -> int32 -> unit = "%caml_string_set32u" +external unsafe_set_64 : Bytes.t -> int -> int64 -> unit = "%caml_string_set64u" + +external get_16 : Bytes.t -> int -> int = "%caml_string_get16" +external get_32 : Bytes.t -> int -> int32 = "%caml_string_get32" +external get_64 : Bytes.t -> int -> int64 = "%caml_string_get64" + +external set_16 : Bytes.t -> int -> int -> unit = "%caml_string_set16" +external set_32 : Bytes.t -> int -> int32 -> unit = "%caml_string_set32" +external set_64 : Bytes.t -> int -> int64 -> unit = "%caml_string_set64" + +#include "common_401.ml" + +#else + +#include "common_400.ml" + +#endif diff --git a/src/endianBytes.cppo.mli b/src/endianBytes.cppo.mli new file mode 100644 index 0000000..f5facfe --- /dev/null +++ b/src/endianBytes.cppo.mli @@ -0,0 +1,127 @@ +(************************************************************************) +(* ocplib-endian *) +(* *) +(* Copyright 2014 OCamlPro *) +(* *) +(* This file is distributed under the terms of the GNU Lesser General *) +(* Public License as published by the Free Software Foundation; either *) +(* version 2.1 of the License, or (at your option) any later version, *) +(* with the OCaml static compilation exception. *) +(* *) +(* ocplib-endian 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 General Public License for more details. *) +(* *) +(************************************************************************) + +module type EndianBytesSig = sig + (** Functions reading according to Big Endian byte order *) + + val get_char : Bytes.t -> int -> char + (** [get_char buff i] reads 1 byte at offset i as a char *) + + val get_uint8 : Bytes.t -> int -> int + (** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8 + bits. i.e. It returns a value between 0 and 2^8-1 *) + + val get_int8 : Bytes.t -> int -> int + (** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8 + bits. i.e. It returns a value between -2^7 and 2^7-1 *) + + val get_uint16 : Bytes.t -> int -> int + (** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int + of 16 bits. i.e. It returns a value between 0 and 2^16-1 *) + + val get_int16 : Bytes.t -> int -> int + (** [get_int16 buff i] reads 2 byte at offset i as a signed int of + 16 bits. i.e. It returns a value between -2^15 and 2^15-1 *) + + val get_int32 : Bytes.t -> int -> int32 + (** [get_int32 buff i] reads 4 bytes at offset i as an int32. *) + + val get_int64 : Bytes.t -> int -> int64 + (** [get_int64 buff i] reads 8 bytes at offset i as an int64. *) + + val get_float : Bytes.t -> int -> float + (** [get_float buff i] is equivalent to + [Int32.float_of_bits (get_int32 buff i)] *) + + val get_double : Bytes.t -> int -> float + (** [get_double buff i] is equivalent to + [Int64.float_of_bits (get_int64 buff i)] *) + + val set_char : Bytes.t -> int -> char -> unit + (** [set_char buff i v] writes [v] to [buff] at offset [i] *) + + val set_int8 : Bytes.t -> int -> int -> unit + (** [set_int8 buff i v] writes the least significant 8 bits of [v] + to [buff] at offset [i] *) + + val set_int16 : Bytes.t -> int -> int -> unit + (** [set_int16 buff i v] writes the least significant 16 bits of [v] + to [buff] at offset [i] *) + + val set_int32 : Bytes.t -> int -> int32 -> unit + (** [set_int32 buff i v] writes [v] to [buff] at offset [i] *) + + val set_int64 : Bytes.t -> int -> int64 -> unit + (** [set_int64 buff i v] writes [v] to [buff] at offset [i] *) + + val set_float : Bytes.t -> int -> float -> unit + (** [set_float buff i v] is equivalent to + [set_int32 buff i (Int32.bits_of_float v)] *) + + val set_double : Bytes.t -> int -> float -> unit + (** [set_double buff i v] is equivalent to + [set_int64 buff i (Int64.bits_of_float v)] *) + +end + +module BigEndian : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianBytesSig + +end + +module BigEndian_unsafe : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianBytesSig + +end + +module LittleEndian : sig + (** Functions reading according to Little Endian byte order *) + + include EndianBytesSig + +end + +module LittleEndian_unsafe : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianBytesSig + +end + +#if OCAML_VERSION >= (4, 00, 0) +module NativeEndian : sig + (** Functions reading according to machine endianness *) + + include EndianBytesSig + +end + +module NativeEndian_unsafe : sig + (** Functions reading according to machine endianness without + checking for overflow *) + + include EndianBytesSig + +end +#endif diff --git a/src/endianString.cppo.ml b/src/endianString.cppo.ml new file mode 100644 index 0000000..47e5617 --- /dev/null +++ b/src/endianString.cppo.ml @@ -0,0 +1,112 @@ +(************************************************************************) +(* ocplib-endian *) +(* *) +(* Copyright 2012 OCamlPro *) +(* *) +(* This file is distributed under the terms of the GNU Lesser General *) +(* Public License as published by the Free Software Foundation; either *) +(* version 2.1 of the License, or (at your option) any later version, *) +(* with the OCaml static compilation exception. *) +(* *) +(* ocplib-endian 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 General Public License for more details. *) +(* *) +(************************************************************************) + +module type EndianStringSig = sig + (** Functions reading according to Big Endian byte order *) + + val get_char : string -> int -> char + (** [get_char buff i] reads 1 byte at offset i as a char *) + + val get_uint8 : string -> int -> int + (** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8 + bits. i.e. It returns a value between 0 and 2^8-1 *) + + val get_int8 : string -> int -> int + (** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8 + bits. i.e. It returns a value between -2^7 and 2^7-1 *) + + val get_uint16 : string -> int -> int + (** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int + of 16 bits. i.e. It returns a value between 0 and 2^16-1 *) + + val get_int16 : string -> int -> int + (** [get_int16 buff i] reads 2 byte at offset i as a signed int of + 16 bits. i.e. It returns a value between -2^15 and 2^15-1 *) + + val get_int32 : string -> int -> int32 + (** [get_int32 buff i] reads 4 bytes at offset i as an int32. *) + + val get_int64 : string -> int -> int64 + (** [get_int64 buff i] reads 8 bytes at offset i as an int64. *) + + val get_float : string -> int -> float + (** [get_float buff i] is equivalent to + [Int32.float_of_bits (get_int32 buff i)] *) + + val get_double : string -> int -> float + (** [get_double buff i] is equivalent to + [Int64.float_of_bits (get_int64 buff i)] *) + + val set_char : Bytes.t -> int -> char -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_char}. *) + + val set_int8 : Bytes.t -> int -> int -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int8}. *) + + val set_int16 : Bytes.t -> int -> int -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int16}. *) + + val set_int32 : Bytes.t -> int -> int32 -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int32}. *) + + val set_int64 : Bytes.t -> int -> int64 -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int64}. *) + + val set_float : Bytes.t -> int -> float -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_float}. *) + + val set_double : Bytes.t -> int -> float -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_double}. *) + +end + +let get_char (s:string) off = + String.get s off +let set_char (s:Bytes.t) off v = + Bytes.set s off v +let unsafe_get_char (s:string) off = + String.unsafe_get s off +let unsafe_set_char (s:Bytes.t) off v = + Bytes.unsafe_set s off v + +#include "common.ml" + +#if OCAML_VERSION >= (4, 01, 0) + +external unsafe_get_16 : string -> int -> int = "%caml_string_get16u" +external unsafe_get_32 : string -> int -> int32 = "%caml_string_get32u" +external unsafe_get_64 : string -> int -> int64 = "%caml_string_get64u" + +external unsafe_set_16 : Bytes.t -> int -> int -> unit = "%caml_string_set16u" +external unsafe_set_32 : Bytes.t -> int -> int32 -> unit = "%caml_string_set32u" +external unsafe_set_64 : Bytes.t -> int -> int64 -> unit = "%caml_string_set64u" + +external get_16 : string -> int -> int = "%caml_string_get16" +external get_32 : string -> int -> int32 = "%caml_string_get32" +external get_64 : string -> int -> int64 = "%caml_string_get64" + +external set_16 : Bytes.t -> int -> int -> unit = "%caml_string_set16" +external set_32 : Bytes.t -> int -> int32 -> unit = "%caml_string_set32" +external set_64 : Bytes.t -> int -> int64 -> unit = "%caml_string_set64" + +#include "common_401.ml" + +#else + +#include "common_400.ml" + +#endif diff --git a/src/endianString.cppo.mli b/src/endianString.cppo.mli new file mode 100644 index 0000000..67f6818 --- /dev/null +++ b/src/endianString.cppo.mli @@ -0,0 +1,123 @@ +(************************************************************************) +(* ocplib-endian *) +(* *) +(* Copyright 2012 OCamlPro *) +(* *) +(* This file is distributed under the terms of the GNU Lesser General *) +(* Public License as published by the Free Software Foundation; either *) +(* version 2.1 of the License, or (at your option) any later version, *) +(* with the OCaml static compilation exception. *) +(* *) +(* ocplib-endian 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 General Public License for more details. *) +(* *) +(************************************************************************) + +module type EndianStringSig = sig + (** Functions reading according to Big Endian byte order *) + + val get_char : string -> int -> char + (** [get_char buff i] reads 1 byte at offset i as a char *) + + val get_uint8 : string -> int -> int + (** [get_uint8 buff i] reads 1 byte at offset i as an unsigned int of 8 + bits. i.e. It returns a value between 0 and 2^8-1 *) + + val get_int8 : string -> int -> int + (** [get_int8 buff i] reads 1 byte at offset i as a signed int of 8 + bits. i.e. It returns a value between -2^7 and 2^7-1 *) + + val get_uint16 : string -> int -> int + (** [get_uint16 buff i] reads 2 bytes at offset i as an unsigned int + of 16 bits. i.e. It returns a value between 0 and 2^16-1 *) + + val get_int16 : string -> int -> int + (** [get_int16 buff i] reads 2 byte at offset i as a signed int of + 16 bits. i.e. It returns a value between -2^15 and 2^15-1 *) + + val get_int32 : string -> int -> int32 + (** [get_int32 buff i] reads 4 bytes at offset i as an int32. *) + + val get_int64 : string -> int -> int64 + (** [get_int64 buff i] reads 8 bytes at offset i as an int64. *) + + val get_float : string -> int -> float + (** [get_float buff i] is equivalent to + [Int32.float_of_bits (get_int32 buff i)] *) + + val get_double : string -> int -> float + (** [get_double buff i] is equivalent to + [Int64.float_of_bits (get_int64 buff i)] *) + + val set_char : Bytes.t -> int -> char -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_char}. *) + + val set_int8 : Bytes.t -> int -> int -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int8}. *) + + val set_int16 : Bytes.t -> int -> int -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int16}. *) + + val set_int32 : Bytes.t -> int -> int32 -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int32}. *) + + val set_int64 : Bytes.t -> int -> int64 -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_int64}. *) + + val set_float : Bytes.t -> int -> float -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_float}. *) + + val set_double : Bytes.t -> int -> float -> unit + (** @deprecated This is a deprecated alias of {!endianBytes.set_double}. *) + +end + +module BigEndian : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianStringSig + +end + +module BigEndian_unsafe : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianStringSig + +end + +module LittleEndian : sig + (** Functions reading according to Little Endian byte order *) + + include EndianStringSig + +end + +module LittleEndian_unsafe : sig + (** Functions reading according to Big Endian byte order without + checking for overflow *) + + include EndianStringSig + +end + +#if OCAML_VERSION >= (4, 00, 0) +module NativeEndian : sig + (** Functions reading according to machine endianness *) + + include EndianStringSig + +end + +module NativeEndian_unsafe : sig + (** Functions reading according to machine endianness without + checking for overflow *) + + include EndianStringSig + +end +#endif diff --git a/src/le_ocaml_400.ml b/src/le_ocaml_400.ml new file mode 100644 index 0000000..1c8acea --- /dev/null +++ b/src/le_ocaml_400.ml @@ -0,0 +1,28 @@ + let get_uint16 s off = + let hi = get_uint8 s (off+1) in + let lo = get_uint8 s off in + (hi lsl 8) + lo + + let get_int16 s off = + sign16 (get_uint16 s off) + + let get_int32 s off = + let hi = get_uint16 s (off+2) in + let lo = get_uint16 s off in + Int32.(logor (shift_left (of_int hi) 16) (of_int lo)) + + let get_int64 s off = + Int64.(logor (shift_left (of_int32 (get_int32 s (off+4))) 32) + (logand (of_int32 (get_int32 s off)) 0xffffffff_L)) + + let set_int16 s off v = + set_int8 s (off+1) (v lsr 8); + set_int8 s off (v land 0xff) + + let set_int32 s off v = + set_int16 s (off+2) (Int32.(to_int (shift_right_logical v 16))); + set_int16 s off (Int32.(to_int (logand v 0xffff_l))) + + let set_int64 s off v = + set_int32 s (off+4) (Int64.(to_int32 (shift_right_logical v 32))); + set_int32 s off (Int64.(to_int32 (logand v 0xffffffff_L))) diff --git a/src/le_ocaml_401.ml b/src/le_ocaml_401.ml new file mode 100644 index 0000000..b65184c --- /dev/null +++ b/src/le_ocaml_401.ml @@ -0,0 +1,32 @@ + let get_uint16 s off = + if Sys.big_endian + then swap16 (get_16 s off) + else get_16 s off + + let get_int16 s off = + ((get_uint16 s off) lsl ( Sys.word_size - 17 )) asr ( Sys.word_size - 17 ) + + let get_int32 s off = + if Sys.big_endian + then swap32 (get_32 s off) + else get_32 s off + + let get_int64 s off = + if Sys.big_endian + then swap64 (get_64 s off) + else get_64 s off + + let set_int16 s off v = + if Sys.big_endian + then (set_16 s off (swap16 v)) + else set_16 s off v + + let set_int32 s off v = + if Sys.big_endian + then set_32 s off (swap32 v) + else set_32 s off v + + let set_int64 s off v = + if Sys.big_endian + then set_64 s off (swap64 v) + else set_64 s off v diff --git a/src/ne_ocaml_400.ml b/src/ne_ocaml_400.ml new file mode 100644 index 0000000..f1a132e --- /dev/null +++ b/src/ne_ocaml_400.ml @@ -0,0 +1,66 @@ + let get_uint16 s off = + if Sys.big_endian + then + let hi = get_uint8 s off in + let lo = get_uint8 s (off+1) in + (hi lsl 8) + lo + else + let hi = get_uint8 s (off+1) in + let lo = get_uint8 s off in + (hi lsl 8) + lo + + let get_int16 s off = + sign16 (get_uint16 s off) + + let get_int32 s off = + if Sys.big_endian + then + let hi = get_uint16 s off in + let lo = get_uint16 s (off+2) in + Int32.(logor (shift_left (of_int hi) 16) (of_int lo)) + else + let hi = get_uint16 s (off+2) in + let lo = get_uint16 s off in + Int32.(logor (shift_left (of_int hi) 16) (of_int lo)) + + let get_int64 s off = + if Sys.big_endian + then + Int64.(logor (shift_left (of_int32 (get_int32 s off)) 32) + (logand (of_int32 (get_int32 s (off+4))) 0xffffffff_L)) + else + Int64.(logor (shift_left (of_int32 (get_int32 s (off+4))) 32) + (logand (of_int32 (get_int32 s off)) 0xffffffff_L)) + + let set_int16 s off v = + if Sys.big_endian + then begin + set_int8 s off (v lsr 8); + set_int8 s (off+1) (v land 0xff) + end + else begin + set_int8 s (off+1) (v lsr 8); + set_int8 s off (v land 0xff) + end + + let set_int32 s off v = + if Sys.big_endian + then begin + set_int16 s off (Int32.(to_int (shift_right_logical v 16))); + set_int16 s (off+2) (Int32.(to_int (logand v 0xffff_l))) + end + else begin + set_int16 s (off+2) (Int32.(to_int (shift_right_logical v 16))); + set_int16 s off (Int32.(to_int (logand v 0xffff_l))) + end + + let set_int64 s off v = + if Sys.big_endian + then begin + set_int32 s off (Int64.(to_int32 (shift_right_logical v 32))); + set_int32 s (off+4) (Int64.(to_int32 (logand v 0xffffffff_L))) + end + else begin + set_int32 s (off+4) (Int64.(to_int32 (shift_right_logical v 32))); + set_int32 s off (Int64.(to_int32 (logand v 0xffffffff_L))) + end diff --git a/src/ne_ocaml_401.ml b/src/ne_ocaml_401.ml new file mode 100644 index 0000000..2348135 --- /dev/null +++ b/src/ne_ocaml_401.ml @@ -0,0 +1,20 @@ + let get_uint16 s off = + get_16 s off + + let get_int16 s off = + ((get_uint16 s off) lsl ( Sys.word_size - 17 )) asr ( Sys.word_size - 17 ) + + let get_int32 s off = + get_32 s off + + let get_int64 s off = + get_64 s off + + let set_int16 s off v = + set_16 s off v + + let set_int32 s off v = + set_32 s off v + + let set_int64 s off v = + set_64 s off v diff --git a/src/ocplib_endian.mldylib b/src/ocplib_endian.mldylib new file mode 100644 index 0000000..0878141 --- /dev/null +++ b/src/ocplib_endian.mldylib @@ -0,0 +1,5 @@ +# OASIS_START +# DO NOT EDIT (digest: ab3ddb70519491b8b79a4abe5c915c20) +EndianString +EndianBytes +# OASIS_STOP diff --git a/src/ocplib_endian.mllib b/src/ocplib_endian.mllib new file mode 100644 index 0000000..0878141 --- /dev/null +++ b/src/ocplib_endian.mllib @@ -0,0 +1,5 @@ +# OASIS_START +# DO NOT EDIT (digest: ab3ddb70519491b8b79a4abe5c915c20) +EndianString +EndianBytes +# OASIS_STOP diff --git a/tests/bench.ml b/tests/bench.ml new file mode 100644 index 0000000..8b0c88d --- /dev/null +++ b/tests/bench.ml @@ -0,0 +1,436 @@ + +let buffer_size = 10000 +let loops = 10000 + +let allocdiff = + let stat1 = Gc.quick_stat () in + let stat2 = Gc.quick_stat () in + (stat2.Gc.minor_words -. stat1.Gc.minor_words) + +let test_fun s f = + let t1 = Unix.gettimeofday () in + let stat1 = Gc.quick_stat () in + f (); + let stat2 = Gc.quick_stat () in + let t2 = Unix.gettimeofday () in + Printf.printf "%s: time %f alloc: %f\n%!" s (t2 -. t1) + (stat2.Gc.minor_words -. stat1.Gc.minor_words -. allocdiff) + +module Bytes_test = struct + open EndianBytes + module BE = BigEndian + module LE = LittleEndian + + let buffer = Bytes.create buffer_size + + let loop_read_uint16_be () = + for i = 0 to Bytes.length buffer - 2 do + ignore(BE.get_uint16 buffer i) + done + + let loop_read_uint16_le () = + for i = 0 to Bytes.length buffer - 2 do + ignore(LE.get_uint16 buffer i) + done + + let loop_read_int16_be () = + for i = 0 to Bytes.length buffer - 2 do + ignore(BE.get_int16 buffer i) + done + + let loop_read_int16_le () = + for i = 0 to Bytes.length buffer - 2 do + ignore(LE.get_int16 buffer i) + done + + let loop_read_int32_be () = + for i = 0 to Bytes.length buffer - 4 do + ignore(Int32.to_int (BE.get_int32 buffer i)) + done + + let loop_read_int32_le () = + for i = 0 to Bytes.length buffer - 4 do + ignore(Int32.to_int (LE.get_int32 buffer i)) + done + + let loop_read_int64_be () = + for i = 0 to Bytes.length buffer - 8 do + ignore(Int64.to_int (BE.get_int64 buffer i)) + done + + let loop_read_int64_le () = + for i = 0 to Bytes.length buffer - 8 do + ignore(Int64.to_int (LE.get_int64 buffer i)) + done + + let loop_write_int16_be () = + for i = 0 to Bytes.length buffer - 2 do + ignore(BE.set_int16 buffer i 10) + done + + let loop_write_int16_le () = + for i = 0 to Bytes.length buffer - 2 do + ignore(LE.set_int16 buffer i 10) + done + + let loop_write_int32_be () = + for i = 0 to Bytes.length buffer - 4 do + ignore((BE.set_int32 buffer i) 10l) + done + + let loop_write_int32_le () = + for i = 0 to Bytes.length buffer - 4 do + ignore((LE.set_int32 buffer i) 10l) + done + + let loop_write_int64_be () = + for i = 0 to Bytes.length buffer - 8 do + ignore((BE.set_int64 buffer i) 10L) + done + + let loop_write_int64_le () = + for i = 0 to Bytes.length buffer - 8 do + ignore((LE.set_int64 buffer i) 10L) + done + + let do_loop f () = + for i = 0 to loops - 1 do + f () + done + + let run s f = test_fun s (do_loop f) + + let run_test () = + run "loop_read_uint16_be" loop_read_uint16_be; + run "loop_read_uint16_le" loop_read_uint16_le; + run "loop_read_int16_be" loop_read_int16_be; + run "loop_read_int16_le" loop_read_int16_le; + run "loop_read_int32_be" loop_read_int32_be; + run "loop_read_int32_le" loop_read_int32_le; + run "loop_read_int64_be" loop_read_int64_be; + run "loop_read_int64_le" loop_read_int64_le; + run "loop_write_int16_be" loop_write_int16_be; + run "loop_write_int16_le" loop_write_int16_le; + run "loop_write_int32_be" loop_write_int32_be; + run "loop_write_int32_le" loop_write_int32_le; + run "loop_write_int64_be" loop_write_int64_be; + run "loop_write_int64_le" loop_write_int64_le + +end + +module Bytes_unsafe_test = struct + open EndianBytes + module BE = BigEndian_unsafe + module LE = LittleEndian_unsafe + + let buffer = Bytes.create buffer_size + + let loop_read_uint16_be () = + for i = 0 to Bytes.length buffer - 2 do + ignore(BE.get_uint16 buffer i) + done + + let loop_read_uint16_le () = + for i = 0 to Bytes.length buffer - 2 do + ignore(LE.get_uint16 buffer i) + done + + let loop_read_int16_be () = + for i = 0 to Bytes.length buffer - 2 do + ignore(BE.get_int16 buffer i) + done + + let loop_read_int16_le () = + for i = 0 to Bytes.length buffer - 2 do + ignore(LE.get_int16 buffer i) + done + + let loop_read_int32_be () = + for i = 0 to Bytes.length buffer - 4 do + ignore(Int32.to_int (BE.get_int32 buffer i)) + done + + let loop_read_int32_le () = + for i = 0 to Bytes.length buffer - 4 do + ignore(Int32.to_int (LE.get_int32 buffer i)) + done + + let loop_read_int64_be () = + for i = 0 to Bytes.length buffer - 8 do + ignore(Int64.to_int (BE.get_int64 buffer i)) + done + + let loop_read_int64_le () = + for i = 0 to Bytes.length buffer - 8 do + ignore(Int64.to_int (LE.get_int64 buffer i)) + done + + let loop_write_int16_be () = + for i = 0 to Bytes.length buffer - 2 do + ignore(BE.set_int16 buffer i 10) + done + + let loop_write_int16_le () = + for i = 0 to Bytes.length buffer - 2 do + ignore(LE.set_int16 buffer i 10) + done + + let loop_write_int32_be () = + for i = 0 to Bytes.length buffer - 4 do + ignore((BE.set_int32 buffer i) 10l) + done + + let loop_write_int32_le () = + for i = 0 to Bytes.length buffer - 4 do + ignore((LE.set_int32 buffer i) 10l) + done + + let loop_write_int64_be () = + for i = 0 to Bytes.length buffer - 8 do + ignore((BE.set_int64 buffer i) 10L) + done + + let loop_write_int64_le () = + for i = 0 to Bytes.length buffer - 8 do + ignore((LE.set_int64 buffer i) 10L) + + done + + let do_loop f () = + for i = 0 to loops - 1 do + f () + done + + let run s f = test_fun s (do_loop f) + + let run_test () = + run "loop_read_uint16_be" loop_read_uint16_be; + run "loop_read_uint16_le" loop_read_uint16_le; + run "loop_read_int16_be" loop_read_int16_be; + run "loop_read_int16_le" loop_read_int16_le; + run "loop_read_int32_be" loop_read_int32_be; + run "loop_read_int32_le" loop_read_int32_le; + run "loop_read_int64_be" loop_read_int64_be; + run "loop_read_int64_le" loop_read_int64_le; + run "loop_write_int16_be" loop_write_int16_be; + run "loop_write_int16_le" loop_write_int16_le; + run "loop_write_int32_be" loop_write_int32_be; + run "loop_write_int32_le" loop_write_int32_le; + run "loop_write_int64_be" loop_write_int64_be; + run "loop_write_int64_le" loop_write_int64_le + +end + +module Bigstring_test = struct + open EndianBigstring + module BE = BigEndian + module LE = LittleEndian + open Bigarray + let buffer = Array1.create char c_layout buffer_size + + let loop_read_uint16_be () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(BE.get_uint16 buffer i) + done + + let loop_read_uint16_le () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(LE.get_uint16 buffer i) + done + + let loop_read_int16_be () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(BE.get_int16 buffer i) + done + + let loop_read_int16_le () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(LE.get_int16 buffer i) + done + + let loop_read_int32_be () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore(Int32.to_int (BE.get_int32 buffer i)) + done + + let loop_read_int32_le () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore(Int32.to_int (LE.get_int32 buffer i)) + done + + let loop_read_int64_be () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore(Int64.to_int (BE.get_int64 buffer i)) + done + + let loop_read_int64_le () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore(Int64.to_int (LE.get_int64 buffer i)) + done + + let loop_write_int16_be () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(BE.set_int16 buffer i 10) + done + + let loop_write_int16_le () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(LE.set_int16 buffer i 10) + done + + let loop_write_int32_be () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore((BE.set_int32 buffer i) 10l) + done + + let loop_write_int32_le () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore((LE.set_int32 buffer i) 10l) + done + + let loop_write_int64_be () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore((BE.set_int64 buffer i) 10L) + done + + let loop_write_int64_le () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore((LE.set_int64 buffer i) 10L) + done + + let do_loop f () = + for i = 0 to loops - 1 do + f () + done + + let run s f = test_fun s (do_loop f) + + let run_test () = + run "loop_read_uint16_be" loop_read_uint16_be; + run "loop_read_uint16_le" loop_read_uint16_le; + run "loop_read_int16_be" loop_read_int16_be; + run "loop_read_int16_le" loop_read_int16_le; + run "loop_read_int32_be" loop_read_int32_be; + run "loop_read_int32_le" loop_read_int32_le; + run "loop_read_int64_be" loop_read_int64_be; + run "loop_read_int64_le" loop_read_int64_le; + run "loop_write_int16_be" loop_write_int16_be; + run "loop_write_int16_le" loop_write_int16_le; + run "loop_write_int32_be" loop_write_int32_be; + run "loop_write_int32_le" loop_write_int32_le; + run "loop_write_int64_be" loop_write_int64_be; + run "loop_write_int64_le" loop_write_int64_le + +end + +module Bigstring_unsafe_test = struct + open EndianBigstring + module BE = BigEndian_unsafe + module LE = LittleEndian_unsafe + open Bigarray + let buffer = Array1.create char c_layout buffer_size + + let loop_read_uint16_be () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(BE.get_uint16 buffer i) + done + + let loop_read_uint16_le () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(LE.get_uint16 buffer i) + done + + let loop_read_int16_be () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(BE.get_int16 buffer i) + done + + let loop_read_int16_le () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(LE.get_int16 buffer i) + done + + let loop_read_int32_be () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore(Int32.to_int (BE.get_int32 buffer i)) + done + + let loop_read_int32_le () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore(Int32.to_int (LE.get_int32 buffer i)) + done + + let loop_read_int64_be () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore(Int64.to_int (BE.get_int64 buffer i)) + done + + let loop_read_int64_le () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore(Int64.to_int (LE.get_int64 buffer i)) + done + + let loop_write_int16_be () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(BE.set_int16 buffer i 10) + done + + let loop_write_int16_le () = + for i = 0 to Bigarray.Array1.dim buffer - 2 do + ignore(LE.set_int16 buffer i 10) + done + + let loop_write_int32_be () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore((BE.set_int32 buffer i) 10l) + done + + let loop_write_int32_le () = + for i = 0 to Bigarray.Array1.dim buffer - 4 do + ignore((LE.set_int32 buffer i) 10l) + done + + let loop_write_int64_be () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore((BE.set_int64 buffer i) 10L) + done + + let loop_write_int64_le () = + for i = 0 to Bigarray.Array1.dim buffer - 8 do + ignore((LE.set_int64 buffer i) 10L) + done + + let do_loop f () = + for i = 0 to loops - 1 do + f () + done + + let run s f = test_fun s (do_loop f) + + let run_test () = + run "loop_read_uint16_be" loop_read_uint16_be; + run "loop_read_uint16_le" loop_read_uint16_le; + run "loop_read_int16_be" loop_read_int16_be; + run "loop_read_int16_le" loop_read_int16_le; + run "loop_read_int32_be" loop_read_int32_be; + run "loop_read_int32_le" loop_read_int32_le; + run "loop_read_int64_be" loop_read_int64_be; + run "loop_read_int64_le" loop_read_int64_le; + run "loop_write_int16_be" loop_write_int16_be; + run "loop_write_int16_le" loop_write_int16_le; + run "loop_write_int32_be" loop_write_int32_be; + run "loop_write_int32_le" loop_write_int32_le; + run "loop_write_int64_be" loop_write_int64_be; + run "loop_write_int64_le" loop_write_int64_le + +end + +let () = + Printf.printf "safe bytes:\n%!"; + Bytes_test.run_test (); + Printf.printf "unsafe bytes:\n%!"; + Bytes_unsafe_test.run_test (); + Printf.printf "safe bigstring:\n%!"; + Bigstring_test.run_test (); + Printf.printf "unsafe bigstring:\n%!"; + Bigstring_unsafe_test.run_test () diff --git a/tests/test.ml b/tests/test.ml new file mode 100644 index 0000000..07a83a7 --- /dev/null +++ b/tests/test.ml @@ -0,0 +1,45 @@ + +let allocdiff = + let stat1 = Gc.quick_stat () in + let stat2 = Gc.quick_stat () in + (stat2.Gc.minor_words -. stat1.Gc.minor_words) + +let version_over_4_01 = + try + Scanf.sscanf Sys.ocaml_version "%i.%i.%i" + (fun major minor patch -> major > 4 || (major = 4 && minor >= 1)) + with _ -> false + +let () = + Test_bigstring.test1 (); + let stat1 = Gc.quick_stat () in + Test_bigstring.test2 (); + if Sys.word_size = 64 then Test_bigstring.test_64 (); + let stat2 = Gc.quick_stat () in + (* with a 32 bit system, int64 must be heap allocated *) + if Sys.word_size = 32 then Test_bigstring.test_64 (); + let alloc1 = stat2.Gc.minor_words -. stat1.Gc.minor_words -. allocdiff in + Printf.printf "bigstring: allocated words %f\n%!" alloc1; + + Test_string.test1 (); + let stat1 = Gc.quick_stat () in + Test_string.test2 (); + if Sys.word_size = 64 then Test_string.test_64 (); + let stat2 = Gc.quick_stat () in + if Sys.word_size = 32 then Test_string.test_64 (); + let alloc2 = stat2.Gc.minor_words -. stat1.Gc.minor_words -. allocdiff in + Printf.printf "string: allocated words %f\n%!" alloc2; + + Test_bytes.test1 (); + let stat1 = Gc.quick_stat () in + Test_bytes.test2 (); + if Sys.word_size = 64 then Test_string.test_64 (); + let stat2 = Gc.quick_stat () in + if Sys.word_size = 32 then Test_string.test_64 (); + let alloc3 = stat2.Gc.minor_words -. stat1.Gc.minor_words -. allocdiff in + Printf.printf "bytes: allocated words %f\n%!" alloc3; + (* we cannot ensure that there are no allocations only with the + primives added in 4.01.0 *) + if version_over_4_01 && (alloc1 <> 0. || alloc2 <> 0. || alloc3 <> 0.) + then exit 1 + else exit 0 diff --git a/tests/test_bigstring.cppo.ml b/tests/test_bigstring.cppo.ml new file mode 100644 index 0000000..ff572e8 --- /dev/null +++ b/tests/test_bigstring.cppo.ml @@ -0,0 +1,211 @@ +open Bigarray +open EndianBigstring + +module BE = BigEndian +module LE = LittleEndian +#if OCAML_VERSION >= (4, 00, 0) +module NE = NativeEndian +#endif + +#if OCAML_VERSION >= (4, 00, 0) +let big_endian = Sys.big_endian +#else +(* Sys.big_endian is not available on ocaml <= 3.12 *) +#endif + +let bigstring_of_string s = + let a = Array1.create char c_layout (String.length s) in + for i = 0 to String.length s - 1 do + a.{i} <- s.[i] + done; + a + +let s = bigstring_of_string (String.make 10 '\x00') + +let assert_bound_check2 f v1 v2 = + try + ignore(f v1 v2); + assert false + with + | Invalid_argument("index out of bounds") -> () + +let assert_bound_check3 f v1 v2 v3 = + try + ignore(f v1 v2 v3); + assert false + with + | Invalid_argument("index out of bounds") -> () + +let test1 () = + assert_bound_check2 BE.get_int8 s (-1); + assert_bound_check2 BE.get_int8 s 10; + assert_bound_check2 BE.get_uint16 s (-1); + assert_bound_check2 BE.get_uint16 s 9; + assert_bound_check2 BE.get_int32 s (-1); + assert_bound_check2 BE.get_int32 s 7; + assert_bound_check2 BE.get_int64 s (-1); + assert_bound_check2 BE.get_int64 s 3; + + assert_bound_check3 BE.set_int8 s (-1) 0; + assert_bound_check3 BE.set_int8 s 10 0; + assert_bound_check3 BE.set_int16 s (-1) 0; + assert_bound_check3 BE.set_int16 s 9 0; + assert_bound_check3 BE.set_int32 s (-1) 0l; + assert_bound_check3 BE.set_int32 s 7 0l; + assert_bound_check3 BE.set_int64 s (-1) 0L; + assert_bound_check3 BE.set_int64 s 3 0L + +let test2 () = + BE.set_int8 s 0 63; (* in [0; 127] *) + assert( BE.get_uint8 s 0 = 63 ); + assert( BE.get_int8 s 0 = 63 ); + + BE.set_int8 s 0 155; (* in [128; 255] *) + assert( BE.get_uint8 s 0 = 155 ); + + BE.set_int8 s 0 (-103); (* in [-128; -1] *) + assert( BE.get_int8 s 0 = (-103) ); + + BE.set_int8 s 0 0x1234; (* outside of the [-127;255] range *) + assert( BE.get_uint8 s 0 = 0x34 ); + assert( BE.get_int8 s 0 = 0x34 ); + + BE.set_int8 s 0 0xAACD; (* outside of the [-127;255] range, -0x33 land 0xFF = 0xCD*) + assert( BE.get_uint8 s 0 = 0xCD ); + assert( BE.get_int8 s 0 = (-0x33) ); + + BE.set_int16 s 0 0x1234; + assert( BE.get_uint16 s 0 = 0x1234 ); + assert( BE.get_uint16 s 1 = 0x3400 ); + assert( BE.get_uint16 s 2 = 0 ); + + assert( LE.get_uint16 s 0 = 0x3412 ); + assert( LE.get_uint16 s 1 = 0x0034 ); + assert( LE.get_uint16 s 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian then begin + assert( BE.get_uint16 s 0 = NE.get_uint16 s 0 ); + assert( BE.get_uint16 s 1 = NE.get_uint16 s 1 ); + assert( BE.get_uint16 s 2 = NE.get_uint16 s 2 ); + end + else begin + assert( LE.get_uint16 s 0 = NE.get_uint16 s 0 ); + assert( LE.get_uint16 s 1 = NE.get_uint16 s 1 ); + assert( LE.get_uint16 s 2 = NE.get_uint16 s 2 ); + end; +#endif + + assert( BE.get_int16 s 0 = 0x1234 ); + assert( BE.get_int16 s 1 = 0x3400 ); + assert( BE.get_int16 s 2 = 0 ); + + BE.set_int16 s 0 0xFEDC; + assert( BE.get_uint16 s 0 = 0xFEDC ); + assert( BE.get_uint16 s 1 = 0xDC00 ); + assert( BE.get_uint16 s 2 = 0 ); + + assert( LE.get_uint16 s 0 = 0xDCFE ); + assert( LE.get_uint16 s 1 = 0x00DC ); + assert( LE.get_uint16 s 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian then begin + assert( BE.get_uint16 s 0 = NE.get_uint16 s 0 ); + assert( BE.get_uint16 s 1 = NE.get_uint16 s 1 ); + assert( BE.get_uint16 s 2 = NE.get_uint16 s 2 ); + end + else begin + assert( LE.get_uint16 s 0 = NE.get_uint16 s 0 ); + assert( LE.get_uint16 s 1 = NE.get_uint16 s 1 ); + assert( LE.get_uint16 s 2 = NE.get_uint16 s 2 ); + end; +#endif + + assert( BE.get_int16 s 0 = -292 ); + assert( BE.get_int16 s 1 = -9216 ); + assert( BE.get_int16 s 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then begin + NE.set_int16 s 0 0x1234; + assert( BE.get_uint16 s 0 = 0xFEDC ); + assert( BE.get_uint16 s 1 = 0xDC00 ); + assert( BE.get_uint16 s 2 = 0 ) + end; +#endif + + LE.set_int16 s 0 0x1234; + assert( BE.get_uint16 s 0 = 0x3412 ); + assert( BE.get_uint16 s 1 = 0x1200 ); + assert( BE.get_uint16 s 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if not big_endian + then begin + NE.set_int16 s 0 0x1234; + assert( BE.get_uint16 s 0 = 0x3412 ); + assert( BE.get_uint16 s 1 = 0x1200 ); + assert( BE.get_uint16 s 2 = 0 ) + end; +#endif + + LE.set_int16 s 0 0xFEDC; + assert( LE.get_uint16 s 0 = 0xFEDC ); + assert( LE.get_uint16 s 1 = 0x00FE ); + assert( LE.get_uint16 s 2 = 0 ); + + BE.set_int32 s 0 0x12345678l; + assert( BE.get_int32 s 0 = 0x12345678l ); + assert( LE.get_int32 s 0 = 0x78563412l ); +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int32 s 0 = NE.get_int32 s 0 ) + else assert( LE.get_int32 s 0 = NE.get_int32 s 0 ); +#endif + + LE.set_int32 s 0 0x12345678l; + assert( LE.get_int32 s 0 = 0x12345678l ); + assert( BE.get_int32 s 0 = 0x78563412l ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int32 s 0 = NE.get_int32 s 0 ) + else assert( LE.get_int32 s 0 = NE.get_int32 s 0 ); + + NE.set_int32 s 0 0x12345678l; + if big_endian + then assert( BE.get_int32 s 0 = 0x12345678l ) + else assert( LE.get_int32 s 0 = 0x12345678l ); +#endif + + () + +let test_64 () = + BE.set_int64 s 0 0x1234567890ABCDEFL; + assert( BE.get_int64 s 0 = 0x1234567890ABCDEFL ); + assert( LE.get_int64 s 0 = 0xEFCDAB9078563412L ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int64 s 0 = NE.get_int64 s 0 ) + else assert( LE.get_int64 s 0 = NE.get_int64 s 0 ); +#endif + + LE.set_int64 s 0 0x1234567890ABCDEFL; + assert( LE.get_int64 s 0 = 0x1234567890ABCDEFL ); + assert( BE.get_int64 s 0 = 0xEFCDAB9078563412L ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int64 s 0 = NE.get_int64 s 0 ) + else assert( LE.get_int64 s 0 = NE.get_int64 s 0 ); + + NE.set_int64 s 0 0x1234567890ABCDEFL; + if big_endian + then assert( BE.get_int64 s 0 = 0x1234567890ABCDEFL ) + else assert( LE.get_int64 s 0 = 0x1234567890ABCDEFL ); +#endif + + () diff --git a/tests/test_bytes.cppo.ml b/tests/test_bytes.cppo.ml new file mode 100644 index 0000000..24a31bd --- /dev/null +++ b/tests/test_bytes.cppo.ml @@ -0,0 +1,206 @@ +open EndianBytes + +let to_t x = x +(* do not allocate to avoid breaking tests *) + +module BE = BigEndian +module LE = LittleEndian +#if OCAML_VERSION >= (4, 00, 0) +module NE = NativeEndian +#endif + +#if OCAML_VERSION >= (4, 00, 0) +let big_endian = Sys.big_endian +#else +(* Sys.big_endian is not available on ocaml <= 3.12 *) +#endif + +let s = Bytes.make 10 '\x00' + +let assert_bound_check2 f v1 v2 = + try + ignore(f v1 v2); + assert false + with + | Invalid_argument("index out of bounds") -> () + +let assert_bound_check3 f v1 v2 v3 = + try + ignore(f v1 v2 v3); + assert false + with + | Invalid_argument("index out of bounds") -> () + +let test1 () = + assert_bound_check2 BE.get_int8 (to_t s) (-1); + assert_bound_check2 BE.get_int8 (to_t s) 10; + assert_bound_check2 BE.get_uint16 (to_t s) (-1); + assert_bound_check2 BE.get_uint16 (to_t s) 9; + assert_bound_check2 BE.get_int32 (to_t s) (-1); + assert_bound_check2 BE.get_int32 (to_t s) 7; + assert_bound_check2 BE.get_int64 (to_t s) (-1); + assert_bound_check2 BE.get_int64 (to_t s) 3; + + assert_bound_check3 BE.set_int8 s (-1) 0; + assert_bound_check3 BE.set_int8 s 10 0; + assert_bound_check3 BE.set_int16 s (-1) 0; + assert_bound_check3 BE.set_int16 s 9 0; + assert_bound_check3 BE.set_int32 s (-1) 0l; + assert_bound_check3 BE.set_int32 s 7 0l; + assert_bound_check3 BE.set_int64 s (-1) 0L; + assert_bound_check3 BE.set_int64 s 3 0L + +let test2 () = + BE.set_int8 s 0 63; (* in [0; 127] *) + assert( BE.get_uint8 (to_t s) 0 = 63 ); + assert( BE.get_int8 (to_t s) 0 = 63 ); + + BE.set_int8 s 0 155; (* in [128; 255] *) + assert( BE.get_uint8 (to_t s) 0 = 155 ); + + BE.set_int8 s 0 (-103); (* in [-128; -1] *) + assert( BE.get_int8 (to_t s) 0 = (-103) ); + + BE.set_int8 s 0 0x1234; (* outside of the [-127;255] range *) + assert( BE.get_uint8 (to_t s) 0 = 0x34 ); + assert( BE.get_int8 (to_t s) 0 = 0x34 ); + + BE.set_int8 s 0 0xAACD; (* outside of the [-127;255] range, -0x33 land 0xFF = 0xCD*) + assert( BE.get_uint8 (to_t s) 0 = 0xCD ); + assert( BE.get_int8 (to_t s) 0 = (-0x33) ); + + BE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0x1234 ); + assert( BE.get_uint16 (to_t s) 1 = 0x3400 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ); + + assert( LE.get_uint16 (to_t s) 0 = 0x3412 ); + assert( LE.get_uint16 (to_t s) 1 = 0x0034 ); + assert( LE.get_uint16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian then begin + assert( BE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( BE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( BE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end + else begin + assert( LE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( LE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( LE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end; +#endif + + assert( BE.get_int16 (to_t s) 0 = 0x1234 ); + assert( BE.get_int16 (to_t s) 1 = 0x3400 ); + assert( BE.get_int16 (to_t s) 2 = 0 ); + + BE.set_int16 s 0 0xFEDC; + assert( BE.get_uint16 (to_t s) 0 = 0xFEDC ); + assert( BE.get_uint16 (to_t s) 1 = 0xDC00 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ); + + assert( LE.get_uint16 (to_t s) 0 = 0xDCFE ); + assert( LE.get_uint16 (to_t s) 1 = 0x00DC ); + assert( LE.get_uint16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian then begin + assert( BE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( BE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( BE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end + else begin + assert( LE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( LE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( LE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end; +#endif + + assert( BE.get_int16 (to_t s) 0 = -292 ); + assert( BE.get_int16 (to_t s) 1 = -9216 ); + assert( BE.get_int16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then begin + NE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0xFEDC ); + assert( BE.get_uint16 (to_t s) 1 = 0xDC00 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ) + end; +#endif + + LE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0x3412 ); + assert( BE.get_uint16 (to_t s) 1 = 0x1200 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if not big_endian + then begin + NE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0x3412 ); + assert( BE.get_uint16 (to_t s) 1 = 0x1200 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ) + end; +#endif + + LE.set_int16 s 0 0xFEDC; + assert( LE.get_uint16 (to_t s) 0 = 0xFEDC ); + assert( LE.get_uint16 (to_t s) 1 = 0x00FE ); + assert( LE.get_uint16 (to_t s) 2 = 0 ); + + BE.set_int32 s 0 0x12345678l; + assert( BE.get_int32 (to_t s) 0 = 0x12345678l ); + assert( LE.get_int32 (to_t s) 0 = 0x78563412l ); +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ) + else assert( LE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ); +#endif + + LE.set_int32 s 0 0x12345678l; + assert( LE.get_int32 (to_t s) 0 = 0x12345678l ); + assert( BE.get_int32 (to_t s) 0 = 0x78563412l ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ) + else assert( LE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ); + + NE.set_int32 s 0 0x12345678l; + if big_endian + then assert( BE.get_int32 (to_t s) 0 = 0x12345678l ) + else assert( LE.get_int32 (to_t s) 0 = 0x12345678l ); +#endif + + () + +let test_64 () = + BE.set_int64 s 0 0x1234567890ABCDEFL; + assert( BE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ); + assert( LE.get_int64 (to_t s) 0 = 0xEFCDAB9078563412L ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ) + else assert( LE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ); +#endif + + LE.set_int64 s 0 0x1234567890ABCDEFL; + assert( LE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ); + assert( BE.get_int64 (to_t s) 0 = 0xEFCDAB9078563412L ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ) + else assert( LE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ); + + NE.set_int64 s 0 0x1234567890ABCDEFL; + if big_endian + then assert( BE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ) + else assert( LE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ); +#endif + + () diff --git a/tests/test_string.cppo.ml b/tests/test_string.cppo.ml new file mode 100644 index 0000000..6f5f9a9 --- /dev/null +++ b/tests/test_string.cppo.ml @@ -0,0 +1,206 @@ +open EndianString + +let to_t = Bytes.unsafe_to_string +(* do not allocate to avoid breaking tests *) + +module BE = BigEndian +module LE = LittleEndian +#if OCAML_VERSION >= (4, 00, 0) +module NE = NativeEndian +#endif + +#if OCAML_VERSION >= (4, 00, 0) +let big_endian = Sys.big_endian +#else +(* Sys.big_endian is not available on ocaml <= 3.12 *) +#endif + +let s = Bytes.make 10 '\x00' + +let assert_bound_check2 f v1 v2 = + try + ignore(f v1 v2); + assert false + with + | Invalid_argument("index out of bounds") -> () + +let assert_bound_check3 f v1 v2 v3 = + try + ignore(f v1 v2 v3); + assert false + with + | Invalid_argument("index out of bounds") -> () + +let test1 () = + assert_bound_check2 BE.get_int8 (to_t s) (-1); + assert_bound_check2 BE.get_int8 (to_t s) 10; + assert_bound_check2 BE.get_uint16 (to_t s) (-1); + assert_bound_check2 BE.get_uint16 (to_t s) 9; + assert_bound_check2 BE.get_int32 (to_t s) (-1); + assert_bound_check2 BE.get_int32 (to_t s) 7; + assert_bound_check2 BE.get_int64 (to_t s) (-1); + assert_bound_check2 BE.get_int64 (to_t s) 3; + + assert_bound_check3 BE.set_int8 s (-1) 0; + assert_bound_check3 BE.set_int8 s 10 0; + assert_bound_check3 BE.set_int16 s (-1) 0; + assert_bound_check3 BE.set_int16 s 9 0; + assert_bound_check3 BE.set_int32 s (-1) 0l; + assert_bound_check3 BE.set_int32 s 7 0l; + assert_bound_check3 BE.set_int64 s (-1) 0L; + assert_bound_check3 BE.set_int64 s 3 0L + +let test2 () = + BE.set_int8 s 0 63; (* in [0; 127] *) + assert( BE.get_uint8 (to_t s) 0 = 63 ); + assert( BE.get_int8 (to_t s) 0 = 63 ); + + BE.set_int8 s 0 155; (* in [128; 255] *) + assert( BE.get_uint8 (to_t s) 0 = 155 ); + + BE.set_int8 s 0 (-103); (* in [-128; -1] *) + assert( BE.get_int8 (to_t s) 0 = (-103) ); + + BE.set_int8 s 0 0x1234; (* outside of the [-127;255] range *) + assert( BE.get_uint8 (to_t s) 0 = 0x34 ); + assert( BE.get_int8 (to_t s) 0 = 0x34 ); + + BE.set_int8 s 0 0xAACD; (* outside of the [-127;255] range, -0x33 land 0xFF = 0xCD*) + assert( BE.get_uint8 (to_t s) 0 = 0xCD ); + assert( BE.get_int8 (to_t s) 0 = (-0x33) ); + + BE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0x1234 ); + assert( BE.get_uint16 (to_t s) 1 = 0x3400 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ); + + assert( LE.get_uint16 (to_t s) 0 = 0x3412 ); + assert( LE.get_uint16 (to_t s) 1 = 0x0034 ); + assert( LE.get_uint16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian then begin + assert( BE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( BE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( BE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end + else begin + assert( LE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( LE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( LE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end; +#endif + + assert( BE.get_int16 (to_t s) 0 = 0x1234 ); + assert( BE.get_int16 (to_t s) 1 = 0x3400 ); + assert( BE.get_int16 (to_t s) 2 = 0 ); + + BE.set_int16 s 0 0xFEDC; + assert( BE.get_uint16 (to_t s) 0 = 0xFEDC ); + assert( BE.get_uint16 (to_t s) 1 = 0xDC00 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ); + + assert( LE.get_uint16 (to_t s) 0 = 0xDCFE ); + assert( LE.get_uint16 (to_t s) 1 = 0x00DC ); + assert( LE.get_uint16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian then begin + assert( BE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( BE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( BE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end + else begin + assert( LE.get_uint16 (to_t s) 0 = NE.get_uint16 (to_t s) 0 ); + assert( LE.get_uint16 (to_t s) 1 = NE.get_uint16 (to_t s) 1 ); + assert( LE.get_uint16 (to_t s) 2 = NE.get_uint16 (to_t s) 2 ); + end; +#endif + + assert( BE.get_int16 (to_t s) 0 = -292 ); + assert( BE.get_int16 (to_t s) 1 = -9216 ); + assert( BE.get_int16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then begin + NE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0xFEDC ); + assert( BE.get_uint16 (to_t s) 1 = 0xDC00 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ) + end; +#endif + + LE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0x3412 ); + assert( BE.get_uint16 (to_t s) 1 = 0x1200 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ); + +#if OCAML_VERSION >= (4, 00, 0) + if not big_endian + then begin + NE.set_int16 s 0 0x1234; + assert( BE.get_uint16 (to_t s) 0 = 0x3412 ); + assert( BE.get_uint16 (to_t s) 1 = 0x1200 ); + assert( BE.get_uint16 (to_t s) 2 = 0 ) + end; +#endif + + LE.set_int16 s 0 0xFEDC; + assert( LE.get_uint16 (to_t s) 0 = 0xFEDC ); + assert( LE.get_uint16 (to_t s) 1 = 0x00FE ); + assert( LE.get_uint16 (to_t s) 2 = 0 ); + + BE.set_int32 s 0 0x12345678l; + assert( BE.get_int32 (to_t s) 0 = 0x12345678l ); + assert( LE.get_int32 (to_t s) 0 = 0x78563412l ); +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ) + else assert( LE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ); +#endif + + LE.set_int32 s 0 0x12345678l; + assert( LE.get_int32 (to_t s) 0 = 0x12345678l ); + assert( BE.get_int32 (to_t s) 0 = 0x78563412l ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ) + else assert( LE.get_int32 (to_t s) 0 = NE.get_int32 (to_t s) 0 ); + + NE.set_int32 s 0 0x12345678l; + if big_endian + then assert( BE.get_int32 (to_t s) 0 = 0x12345678l ) + else assert( LE.get_int32 (to_t s) 0 = 0x12345678l ); +#endif + + () + +let test_64 () = + BE.set_int64 s 0 0x1234567890ABCDEFL; + assert( BE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ); + assert( LE.get_int64 (to_t s) 0 = 0xEFCDAB9078563412L ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ) + else assert( LE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ); +#endif + + LE.set_int64 s 0 0x1234567890ABCDEFL; + assert( LE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ); + assert( BE.get_int64 (to_t s) 0 = 0xEFCDAB9078563412L ); + +#if OCAML_VERSION >= (4, 00, 0) + if big_endian + then assert( BE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ) + else assert( LE.get_int64 (to_t s) 0 = NE.get_int64 (to_t s) 0 ); + + NE.set_int64 s 0 0x1234567890ABCDEFL; + if big_endian + then assert( BE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ) + else assert( LE.get_int64 (to_t s) 0 = 0x1234567890ABCDEFL ); +#endif + + () -- cgit v1.2.3