pax_global_header00006660000000000000000000000064127103557560014525gustar00rootroot0000000000000052 comment=2792b72e21f1b46bc822d8535f2808020c57b4b9 fieldslib-113.33.03/000077500000000000000000000000001271035575600137755ustar00rootroot00000000000000fieldslib-113.33.03/.gitignore000066400000000000000000000001021271035575600157560ustar00rootroot00000000000000_build/ /setup.data /setup.log /*.exe /*.docdir /*.native /*.byte fieldslib-113.33.03/CHANGES.md000066400000000000000000000030621271035575600153700ustar00rootroot00000000000000## 113.00.00 - Added `Fields.Direct.set_all_mutable_fields`, a function intended to guarantee when pooling records that one cannot forget to reinitialize some fields. Obviously one could achieve this through something like `Fields.Direct.iter`, but we want a more efficient version that doesn't force the call side to create closures. ## 109.19.00 - Made `with fields` generate the same functions in the `Fields` and `Fields_of_*` modules whether the type is called `t` or not. ## 109.14.00 - Made `with fields` expose first-class fields for private types while preserving privacy. There is now an additional phantom type in a first-class field that prevents building or modifying elements of a private type. One consequence of this change is that the `Field.t` type is now an abstract type -- it used to be exposed as a record type. So, one must, e.g., change `field.Field.name` to `Field.name field`. ## 109.12.00 - Added back `Fields.fold` to `with fields` for `private` types. We had removed `Fields.fold` for `private` types, but this caused some pain. So we're putting it back. At some point, we'll patch `with fields` to prevent setting mutable fields on private types via the fields provided by `fold`. ## 109.11.00 - `with fields`, for a type `u` that isn't named `t`, creates module `Fields_of_u` rather than module `Fields`. This allows one to us `with fields` on several types in the same structure. ## 109.10.00 - Changed `with fields` on `private` types to not expose mutators or creators. fieldslib-113.33.03/INRIA-DISCLAIMER.txt000066400000000000000000000013321271035575600170110ustar00rootroot00000000000000THIS SOFTWARE IS PROVIDED BY INRIA AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INRIA OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. fieldslib-113.33.03/LICENSE.txt000066400000000000000000000261361271035575600156300ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. fieldslib-113.33.03/META.ab000066400000000000000000000006171271035575600150330ustar00rootroot00000000000000version = "$(pkg_version)" description = "Syntax extension to define first class values representing record fields, to get and set record fields, iterate and fold over all fields of a record and create new record values" requires = "" archive(byte ) = "fieldslib.cma" archive(native) = "fieldslib.cmxa" plugin(byte ) = "fieldslib.cma" plugin(native) = "fieldslib.cmxs" exists_if = "fieldslib.cma" fieldslib-113.33.03/Makefile000066400000000000000000000034171271035575600154420ustar00rootroot00000000000000# Generic Makefile for oasis project SETUP := setup.exe NAME := fieldslib PREFIX = $(shell grep ^prefix= setup.data | cut -d\" -f 2) # Default rule default: build setup.exe: _oasis setup.ml ocamlfind ocamlopt -o $@ -linkpkg -package ocamlbuild,oasis.dynrun setup.ml || \ ocamlfind ocamlc -o $@ -linkpkg -package ocamlbuild,oasis.dynrun setup.ml || true for f in setup.*; do [ $$f = $@ -o $$f = setup.ml ] || rm -f $$f; done build: $(SETUP) setup.data ./$(SETUP) -build $(BUILDFLAGS) $(MAKE) $(NAME).install doc: $(SETUP) setup.data build ./$(SETUP) -doc $(DOCFLAGS) test: $(SETUP) setup.data build ./$(SETUP) -test $(TESTFLAGS) all: $(SETUP) ./$(SETUP) -all $(ALLFLAGS) $(MAKE) $(NAME).install $(NAME).install: install.ml setup.log setup.data ocaml -I "$(OCAML_TOPLEVEL_PATH)" install.ml install: $(NAME).install opam-installer -i --prefix $(PREFIX) $(NAME).install uninstall: $(NAME).install opam-installer -u --prefix $(PREFIX) $(NAME).install reinstall: $(NAME).install opam-installer -u --prefix $(PREFIX) $(NAME).install &> /dev/null || true opam-installer -i --prefix $(PREFIX) $(NAME).install bin.tar.gz: $(NAME).install rm -rf _install mkdir _install opam-installer -i --prefix _install $(NAME).install tar czf bin.tar.gz -C _install . rm -rf _install bin.lzo: $(NAME).install rm -rf _install mkdir _install opam-installer -i --prefix _install $(NAME).install cd _install && lzop -1 -P -o ../bin.lzo `find . -type f` rm -rf _install clean: $(SETUP) ./$(SETUP) -clean $(CLEANFLAGS) distclean: $(SETUP) ./$(SETUP) -distclean $(DISTCLEANFLAGS) configure: $(SETUP) ./$(SETUP) -configure $(CONFIGUREFLAGS) setup.data: $(SETUP) ./$(SETUP) -configure $(CONFIGUREFLAGS) .PHONY: default build doc test all install uninstall reinstall clean distclean configure fieldslib-113.33.03/THIRD-PARTY.txt000066400000000000000000000013601271035575600163050ustar00rootroot00000000000000The repository contains 3rd-party code in the following locations and under the following licenses: - type_conv, sexplib and bin_prot: based on Tywith, by Martin Sandin. License can be found in base/sexplib/LICENSE-Tywith.txt, base/type_conv/LICENSE-Tywith.txt, and base/bin_prot/LICENSE-Tywith.txt. - Core's implementation of union-find: based on an implementation by Henry Matthew Fluet, Suresh Jagannathan, and Stephen Weeks. License can be found in base/core/MLton-license. - Various Core libraries are based on INRIA's OCaml distribution. Relicensed under Apache 2.0, as permitted under the Caml License for Consortium members: http://caml.inria.fr/consortium/license.en.html See also the disclaimer INRIA-DISCLAIMER.txt. fieldslib-113.33.03/_oasis000066400000000000000000000024771271035575600152070ustar00rootroot00000000000000OASISFormat: 0.4 OCamlVersion: >= 4.02.3 FindlibVersion: >= 1.3.2 Name: fieldslib Version: 113.33.03 Synopsis: Syntax extension to define first class values representing record fields, to get and set record fields, iterate and fold over all fields of a record and create new record values Authors: Jane Street Group, LLC Copyrights: (C) 2009-2016 Jane Street Group LLC Maintainers: Jane Street Group, LLC License: Apache-2.0 LicenseFile: LICENSE.txt Homepage: https://github.com/janestreet/fieldslib Plugins: StdFiles (0.3), DevFiles (0.3) XStdFilesAUTHORS: false XStdFilesREADME: false BuildTools: ocamlbuild BetaFeatures: section_object AlphaFeatures: ocamlbuild_more_args XOCamlbuildPluginTags: package(js-build-tools.ocamlbuild_goodies) FilesAB: META.ab Description: Part of Jane Street’s Core library The Core suite of libraries is an industrial strength alternative to OCaml's standard library that was developed by Jane Street, the largest industrial user of OCaml. Library fieldslib Path: src Pack: true Modules: Field fieldslib-113.33.03/_tags000066400000000000000000000003231271035575600150130ustar00rootroot00000000000000<**/*.ml{,i}>: warn(-40), no_alias_deps <**/*>: thread # This prevents the implicit addition of -ppx options by ocamlfind <**/*>: predicate(custom_ppx) : for-pack(Fieldslib) # OASIS_START # OASIS_STOP fieldslib-113.33.03/configure000077500000000000000000000001111271035575600156750ustar00rootroot00000000000000#!/bin/sh # OASIS_START make configure CONFIGUREFLAGS="$*" # OASIS_STOP fieldslib-113.33.03/descr000066400000000000000000000005761271035575600150300ustar00rootroot00000000000000Syntax extension to define first class values representing record fields, to get and set record fields, iterate and fold over all fields of a record and create new record values Part of Jane Street’s Core library The Core suite of libraries is an industrial strength alternative to OCaml's standard library that was developed by Jane Street, the largest industrial user of OCaml. fieldslib-113.33.03/install.ml000066400000000000000000000002671271035575600160020ustar00rootroot00000000000000#use "topfind";; #require "js-build-tools.oasis2opam_install";; open Oasis2opam_install;; generate ~package:"fieldslib" [ oasis_lib "fieldslib" ; file "META" ~section:"lib" ] fieldslib-113.33.03/myocamlbuild.ml000066400000000000000000000005301271035575600170060ustar00rootroot00000000000000(* OASIS_START *) (* OASIS_STOP *) # 3 "myocamlbuild.ml" module JS = Jane_street_ocamlbuild_goodies let dev_mode = true let () = Ocamlbuild_plugin.dispatch (fun hook -> JS.alt_cmxs_of_cmxa_rule hook; JS.pass_predicates_to_ocamldep hook; if dev_mode && not Sys.win32 then JS.track_external_deps hook; dispatch_default hook) fieldslib-113.33.03/opam000066400000000000000000000010551271035575600146550ustar00rootroot00000000000000opam-version: "1.2" maintainer: "opensource@janestreet.com" authors: ["Jane Street Group, LLC "] homepage: "https://github.com/janestreet/fieldslib" bug-reports: "https://github.com/janestreet/fieldslib/issues" dev-repo: "https://github.com/janestreet/fieldslib.git" license: "Apache-2.0" build: [ ["./configure" "--prefix" prefix] [make] ] depends: [ "ocamlbuild" {build} "oasis" {build & >= "0.4"} "ocamlfind" {build & >= "1.3.2"} "js-build-tools" {build} ] available: [ ocaml-version = "4.02.3" ] fieldslib-113.33.03/setup.ml000066400000000000000000000001331271035575600154640ustar00rootroot00000000000000(* OASIS_START *) open OASISDynRun;; open OASISTypes;; (* OASIS_STOP *) let () = setup () fieldslib-113.33.03/src/000077500000000000000000000000001271035575600145645ustar00rootroot00000000000000fieldslib-113.33.03/src/field.ml000066400000000000000000000051431271035575600162040ustar00rootroot00000000000000(* The type [t] should be abstract to make the fset and set functions unavailable for private types at the level of types (and not by putting None in the field). Unfortunately, making the type abstract means that when creating fields (through a [create] function) value restriction kicks in. This is worked around by instead not making the type abstract, but forcing anyone breaking the abstraction to use the [For_generated_code] module, making it obvious to any reader that something ugly is going on. t_with_perm (and derivatives) is the type that users really use. It is a constructor because: 1. it makes type errors more readable (less aliasing) 2. the typer in ocaml 4.01 allows this: module A = struct type t = {a : int} end type t = A.t let f (x : t) = x.a (although with Warning 40: a is used out of scope) which means that if [t_with_perm] was really an alias on [For_generated_code.t], people could say [t.setter] and break the abstraction with no indication that something ugly is going on in the source code. The warning is (I think) for people who want to make their code compatible with previous versions of ocaml, so we may very well turn it off. The type t_with_perm could also have been a [unit -> For_generated_code.t] to work around value restriction and then [For_generated_code.t] would have been a proper abstract type, but it looks like it could impact performance (for example, a fold on a record type with 40 fields would actually allocate the 40 [For_generated_code.t]'s at every single fold.) *) module For_generated_code = struct type ('perm, 'record, 'field) t = { force_variance : 'perm -> unit; (* force [t] to be contravariant in ['perm], because phantom type variables on concrete types don't work that well otherwise (using :> can remove them easily) *) name : string; setter : ('record -> 'field -> unit) option; getter : ('record -> 'field); fset : ('record -> 'field -> 'record); } end type ('perm, 'record, 'field) t_with_perm = | Field of ('perm, 'record, 'field) For_generated_code.t type ('record, 'field) t = ([ `Read | `Set_and_create], 'record, 'field) t_with_perm type ('record, 'field) readonly_t = ([ `Read ], 'record, 'field) t_with_perm let name (Field f) = f.For_generated_code.name let get (Field f) r = f.For_generated_code.getter r let fset (Field f) r v = f.For_generated_code.fset r v let setter (Field f) = f.For_generated_code.setter type ('perm, 'record, 'result) user = { f : 'field. ('perm, 'record, 'field) t_with_perm -> 'result } fieldslib-113.33.03/src/field.mli000066400000000000000000000024361271035575600163570ustar00rootroot00000000000000(** OCaml record field. *) (**/**) module For_generated_code : sig (* don't use this by hand, it is only meant for pa_fields_conv *) type ('perm, 'record, 'field) t = { force_variance : 'perm -> unit; name : string; setter : ('record -> 'field -> unit) option; getter : ('record -> 'field); fset : ('record -> 'field -> 'record); } end (**/**) (** ['record] is the type of the record. ['field] is the type of the values stored in the record field with name [name]. ['perm] is a way of restricting the operations that can be used. *) type ('perm, 'record, 'field) t_with_perm = | Field of ('perm, 'record, 'field) For_generated_code.t (** A record field with no restriction. *) type ('record, 'field) t = ([ `Read | `Set_and_create], 'record, 'field) t_with_perm (** A record that can only be read, because it belongs to a private type. *) type ('record, 'field) readonly_t = ([ `Read ], 'record, 'field) t_with_perm val name : (_, _, _) t_with_perm -> string val get : (_, 'r, 'a) t_with_perm -> 'r -> 'a val fset : ([> `Set_and_create], 'r, 'a) t_with_perm -> 'r -> 'a -> 'r val setter : ([> `Set_and_create], 'r, 'a) t_with_perm -> ('r -> 'a -> unit) option type ('perm, 'record, 'result) user = { f : 'field. ('perm, 'record, 'field) t_with_perm -> 'result } fieldslib-113.33.03/src/fieldslib.odocl000066400000000000000000000001321271035575600175370ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: 6f16a5f8ff5d75ab84c018adacdfcbb7) Field # OASIS_STOP