diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..27ce47c --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.DS_Store +*.fasl +*.dx32fsl +*.dx64fsl +*.lx32fsl +*.lx64fsl +*.x86f +*~ +.#* +*.backup diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..788c488 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,41 @@ +language: common-lisp +sudo: false + +addons: + apt: + packages: + - libc6-i386 + - clisp + - openjdk-7-jre + +env: + global: + - PATH=~/.roswell/bin:$PATH + - ROSWELL_INSTALL_DIR=$HOME/.roswell + matrix: + - LISP=sbcl-bin + - LISP=ccl-bin + - LISP=abcl + - LISP=clisp + - LISP=ecl + - LISP=cmucl + - LISP=alisp + +matrix: + allow_failures: + - env: LISP=clisp + - env: LISP=abcl + - env: LISP=ecl + - env: LISP=cmucl + - env: LISP=alisp + +install: + - curl -L https://raw.githubusercontent.com/snmsts/roswell/release/scripts/install-for-ci.sh | sh + +cache: + directories: + - $HOME/.roswell + - $HOME/.config/common-lisp + +script: + - ./testscr.ros diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a2c23b1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Developer's Certificate of Origin + +To handle the legal aspects of contribution, we ask each Pull Request submitter +to sign the Developer's Certificate of Origin 1.1 (DCO) [1] that the Linux® +Kernel community uses [2] to manage code contributions. + +[1] legal/DCO1.1.txt +[2] https://elinux.org/Developer_Certificate_Of_Origin + +We simply ask that when submitting a patch for review, the developer must +include a sign-off statement in the commit message. + +Here is an example Signed-off-by line, which indicates that the submitter +accepts the DCO linked above: + + Signed-off-by: Your Name + +As of now, you need to add a sign-off message to every commit. To reduce the burden, +we recommend squashing the commits in the PR as much as possible, or use the following: + +You can include this automatically when you commit a change to your local git +repository using the following command: + + git commit -s + +Alternatively/in addition you can have a template for your commit text in a file +like git-commit-template with the DCO above, and run `git config commit.template +git-commit-template` once to have it as your default when running `git commit`. + diff --git a/LICENSE b/LICENSE new file mode 120000 index 0000000..98df9ab --- /dev/null +++ b/LICENSE @@ -0,0 +1 @@ +legal/COPYING.LESSER \ No newline at end of file diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6ccb3b7 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,2 @@ +Please read the [guidelines for contribution](CONTRIBUTING.md) about signing off +Developer's Certificate of Origin. diff --git a/README.org b/README.org new file mode 100644 index 0000000..7cc0e4a --- /dev/null +++ b/README.org @@ -0,0 +1,213 @@ + +* GTYPE + +This library is part of NUMCL. +It provides Julia-like runtime parametric type correctness in CL, based +on CLtL2 extensions. +*The main target of this library is the runtime correctness*, but it also adds the equivalent +type declarations (statically checked by SBCL). +It supports both SBCL and CCL, but CCL would not enjoy the the speed gain. + +#+begin_src lisp +(defun fn (a b) + (declare (gtype (array ?t 1) a)) + (declare (gtype ?t b)) + (resolve + ... + (values (length a) b ?t))) + +(fn (make-array 5 :element-type 'single-float) 0.0) ; -> 5, 0.0, 'single-float + +(fn (make-array 5 :element-type 'fixnum) 0 ) ; -> 5, 0, 'fixnum + +(fn (make-array 5 :element-type 'single-float) 0 ) ;; error -- type unification fails +(fn (make-array 5 :element-type 'fixnum) 0.0) ;; error -- type unification fails + +;; now the real fun starts here... + +(defun gemm (a b c) + (resolve + (declare (gtype (array ?t (?n1 ?n2)) a) + (gtype (array ?t (?n2 ?n3)) b) + (gtype (array ?t (?n1 ?n3)) c)) + (dotimes (i ?n1) + (dotimes (j ?n2) + (dotimes (k ?n3) + (setf (aref c i k) (* (aref a i j) (aref b j k)))))))) + +(let ((c (make-array '(2 2) :initial-element 0))) + (gemm #2A((0 1) (2 3)) + #2A((0 1) (2 3)) + c) + (print c)) + +;; -> #2A((2 3) (6 9)) + +;; see example.lisp for more usage. +#+end_src + +It does not modify/overwrite the =defun= macro or other special operators and +naturally blends into the existing common lisp code. The only requirement is to +use =gtype= declarations instead of =type= declarations, and the use of +=resolve= macro which enforces the type consistency. +There is also =resolving= macro, which is just an alias. + +** What it is not + +Convenient optimization based on the type is not the purpose of this library. For that purpose, +combine this library with [[../../../specialized-function/][specialized-function]] (to be published). + +Defining a algebraic type system is not the purpose of this library. For that purpose, +see [[http://quickdocs.org/cl-algebraic-data-type/][cl-algebraic-data-type]]. + +Currently this library does not have any instrument for defining a parametric structure. +For that purpose, see [[https://github.com/cosmos72/cl-parametric-types][cl-parametric-type]] at the moment. (but borrowing the idea is planned.) + +** Details + +=gtype= declarations also add its simplified versions as the standard =type= +declarations via =define-declaration=. Type variables such as =?t= are +automatically converted into =*=. + +However, currently no Common Lisp implementations +respect the additional declarations added by =define-declaration=. +Should they do so, it will compile to the same +efficient code as those with the =type= declarations. +CLtL2 [[https://www.cs.cmu.edu/Groups/AI/html/cltl/clm/node102.html][specifically mentions]] that the consequences are undefined +when the secondary value of =define-declaration= contains any standard declaration specifier, like =type=. +Maintainers of Lisp implementations (e.g. SBCL maintainers) could interpret it as a freedom of choice. +We also ultimately hope lisp implementations to propagate this =gtype= information +outside the function boundary, allowing Lisp to have a proper parametric compile-time checking. + +Even though the outer =gtype= declarations fail to make the compiler recognize the equivalent =type= declarations, +the ones *inside* the =resolving= macro are converted to the =type= declarations. +Also, the outer =gtype= declaration is inherited and recognized by the inner =resolve= macro. +In the example below, the =gtype= of =C= is matched against the =gtype= of =A= and =B=. + +#+begin_src lisp +(defun fn6 (a b fn) + (resolving + (declare (gtype (array ?t ?d) a)) + (declare (gtype (array ?t ?d) b)) + (print (list :first ?t ?d)) + (let ((c (funcall fn a b))) + (resolving + (declare (gtype (array ?t ?d) c)) + (print (list :second ?t ?d)) + (list a b c))))) + +(print (fn6 (make-array 2 :element-type 'fixnum) + (make-array 2 :element-type 'fixnum) + (lambda (a b) + (if (zerop (random 1)) + a + b)))) + +;; => (:FIRST FIXNUM (2)) +;; => (:SECOND FIXNUM (2)) +;; -> (#(0 0) #(0 0) #(0 0)) + +(print (fn6 (make-array 2 :element-type 'fixnum) + (make-array 2 :element-type 'fixnum) + (lambda (a b) + (declare (ignore a b)) + (make-array 2 :element-type 'single-float)))) + +;; => (:FIRST FIXNUM (2)) +;; -| error! type variable ?t fails to match, because fixnum and single-float are disjoint + +#+end_src + +The name =gtype= comes from generic-type. + +** Background + +There are several proof-of-concept libraries in CL that +tries to address some aspects of types in CL --- however, they are all subject to +the Lisp Curse of not being complete and practical. +Everyone implements half the feature they need personally, then stops there. +Importantly, none of them naturally fits into the existing code base of Common Lisp. +(This library is different, because it has a clear purpose and motivation --- implementing NUMCL.) + +The first one you might have heard (and never tried yourself) is +[[http://quickdocs.org/cl-algebraic-data-type/][cl-algebraic-data-type (or cl-adt in short)]]. *It does not support parametric +types.* From the documentation, it is also not clear if you can define a list +that contains only some type (i.e. the arguments to the type specifier is +evaluated lazily). It comes with its own pattern matcher, but it is not +complete and its performance does not seem like the focus. +As a result, the library is not widely adapted. + +The second one is [[https://github.com/cosmos72/cl-parametric-types][cl-parametric-type]], which provides a C++-like templates. +It can define functions/structures/classes: + +#+begin_src lisp +(template () + (defun less (a b) + (declare (type a b)) + (< a b))) +(template (&optional ( 'real) ( 'real)) + (defun multiply (a b) + (declare (type a) + (type b)) + (* a b))) +(template (&optional ( t) ( t)) + (defstruct pair + (first nil :type ) + (second nil :type ))) +(template (&optional ( t) ( t)) + (defclass pair2 () + (first :type ) + (second :type ))) +#+end_src + +but unfortunately has a nonstandard calling rule that depends on macros: + +#+begin_src lisp +;; i.e. instead of (MAKE-PAIR :FIRST 1 :SECOND 2) you must also specify +;; the concrete types to instantiate PAIR and MAKE-PAIR: +;; +(make-pair (bit fixnum) :first 1 :second 2) +; instantiating template-type (PAIR BIT FIXNUM) as +#S( :FIRST 1 :SECOND 2) + +(defvar *pair* *) ;; store last result into *pair* +*PAIR* + +(pair-first (bit fixnum) *pair*) +1 +#+end_src + +cl-parametric-type works by instantiating the variant of the function/structs etc., and +the reason for the nonstandard call syntax is that it has to +instantiate those specialized types beforehand. + +** Dependencies +This library is at least tested on implementation listed below: + ++ SBCL 1.5.2 on X86-64 Linux 4.4.0-146-generic (author's environment) + +Also, it depends on the following libraries: + ++ trivialib.type-unify : + ++ trivial-cltl2 by *Tomohiro Matsuyama* : + Compatibility package exporting CLtL2 functionality ++ trivia by *Masataro Asai* : + NON-optimized pattern matcher compatible with OPTIMA, with extensible optimizer interface and clean codebase ++ alexandria by *Nikodemus Siivola , and others.* : + Alexandria is a collection of portable public domain utilities. ++ iterate by ** : + Jonathan Amsterdam's iterator/gatherer/accumulator facility + +** Installation + + +** Author, License, Copyright + +Masataro Asai (guicho2.71828@gmail.com) + +Licensed under LGPL v3. + +Copyright (c) 2019 IBM Corporation + + diff --git a/asd-generator-data.asd b/asd-generator-data.asd new file mode 100644 index 0000000..0307c78 --- /dev/null +++ b/asd-generator-data.asd @@ -0,0 +1,23 @@ +#| + This file is a part of gtype project. + +This is a [asd-generator](https://github.com/phoe/asd-generator/) config file. +Run below for auto-regenerating the asd file: + +$ ros install phoe/asd-generator +$ update-asdf + + Copyright (c) 2019 Masataro Asai (guicho2.71828@gmail.com) +|# + +#| + parametric types in CL, based on CLtL2 extensions + + Author: Masataro Asai (guicho2.71828@gmail.com) +|# + + +((:dir :src + (:package) + (:rest))) + diff --git a/circle.yml b/circle.yml new file mode 100644 index 0000000..98b10a4 --- /dev/null +++ b/circle.yml @@ -0,0 +1,15 @@ +machine: + environment: + PATH: ~/.roswell/bin:$PATH + +dependencies: + pre: + - curl -L https://raw.githubusercontent.com/snmsts/roswell/master/scripts/install-for-ci.sh | sh + - ros install ccl-bin + cache_directories: + - ~/.roswell/ + +test: + override: + - ros -L sbcl-bin testscr.ros + - ros -L ccl-bin testscr.ros diff --git a/examples.lisp b/examples.lisp new file mode 100644 index 0000000..55e0d24 --- /dev/null +++ b/examples.lisp @@ -0,0 +1,111 @@ + +(in-package :gtype) + +(defun dot (a b) + (resolve + (declare (gtype (array ?t ?d) a b)) + ;; dummy work + :ok)) + +(print (dot (make-array 2) (make-array 2))) +(print (dot (make-array 2) (make-array 3))) ; error +(print (dot (make-array 2) (make-array '(3 3)))) ; error + +(print (dot (make-array 2 :element-type 'fixnum) + (make-array 2 :element-type 'fixnum))) +(print (dot (make-array 2 :element-type 'fixnum) + (make-array 2 :element-type 'single-float))) ; error +(print (dot (make-array 2 :element-type 'fixnum) + (make-array 3 :element-type 'fixnum))) ;error +(print (dot (make-array 2 :element-type 'fixnum) + (make-array 3 :element-type 'float))) ;error + +;; now the real fun starts here... + +(defun gemm (a b c) + (resolve + (declare (gtype (array ?t (?n1 ?n2)) a) + (gtype (array ?t (?n2 ?n3)) b) + (gtype (array ?t (?n1 ?n3)) c)) + (dotimes (i ?n1) + (dotimes (j ?n2) + (dotimes (k ?n3) + (setf (aref c i k) (* (aref a i j) (aref b j k)))))))) + +(let ((c (make-array '(2 2) :initial-element 0))) + (gemm #2A((0 1) (2 3)) + #2A((0 1) (2 3)) + c) + (print c)) + +;; -> #2A((2 3) (6 9)) + +(let ((c (make-array '(2 2) :initial-element 0))) + (gemm #2A((0 1) (2 3)) + #2A((0 1 3) (2 3 3)) + c)) +;; -| error! + +(let ((c (make-array '(2 2) :initial-element 0))) + (gemm #2A((0 1 3) (2 3 3)) + #2A((0 1) (2 3) (4 5)) + c) + (print c)) +;; -> #2A((12 15) (12 15)) + +(let ((c (make-array '(2 2) :initial-element 0))) + (gemm #2A((0 1) (2 3) (4 5)) + #2A((0 1 3) (2 3 3)) + c) + (print c)) +;; -| error! should be a 3x3 matrix + +(let ((c (make-array '(3 3) :initial-element 0))) + (gemm #2A((0 1) (2 3) (4 5)) + #2A((0 1 3) (2 3 3)) + c) + (print c)) +;; -> #2A((2 3 3) (6 9 9) (10 15 15)) + + + +;; resolve/resolving also recognizes the gtype immediately inside it + +(defun fn5 (a b) + (resolving + (declare (gtype (array ?t ?d) a)) + (declare (gtype (array ?t ?d) b)) + (list a b ?t ?d))) + +(print (fn5 (make-array 2 :element-type 'fixnum) + (make-array 2 :element-type 'fixnum))) + + + +;; nested resolve/resolving macro recognizes both the outer gtypes and inner gtypes. +;; Therefore, the type of C is matched against the type of A and B. + +(defun fn6 (a b fn) + (resolving + (declare (gtype (array ?t ?d) a)) + (declare (gtype (array ?t ?d) b)) + (print (list :first ?t ?d)) + (let ((c (funcall fn a b))) + (resolving + (declare (gtype (array ?t ?d) c)) + (print (list :second ?t ?d)) + (list a b c))))) + +(print (fn6 (make-array 2 :element-type 'fixnum) + (make-array 2 :element-type 'fixnum) + (lambda (a b) + (if (zerop (random 1)) + a + b)))) + +;; error! +(print (fn6 (make-array 2 :element-type 'fixnum) + (make-array 2 :element-type 'fixnum) + (lambda (a b) + (declare (ignore a b)) + (make-array 2 :element-type 'single-float)))) diff --git a/gtype.asd b/gtype.asd new file mode 100644 index 0000000..75b501f --- /dev/null +++ b/gtype.asd @@ -0,0 +1,25 @@ +;;;; Autogenerated ASD file for system "GTYPE" +;;;; In order to regenerate it, run update-asdf +;;;; from shell (see https://github.com/phoe-krk/asd-generator) +;;;; For those who do not have update-asdf, +;;;; run `ros install asd-generator` (if you have roswell installed) +;;;; There are also an interface available from lisp: +;;;; (asd-generator:regen &key im-sure) +(defsystem gtype + :version "0.1" + :author "Masataro Asai" + :mailto "guicho2.71828@gmail.com" + :license "LGPL" + :defsystem-depends-on () + :depends-on (:trivialib.type-unify + :trivial-cltl2 + :trivia + :alexandria + :iterate + :type-r) + :serial t + :components ((:module "src" + :components ((:file "package") + (:file "resolve")))) + :description "C++/Julia-like parametric types in CL, based on CLtL2 extensions" + :in-order-to ((test-op (test-op :gtype.test)))) diff --git a/gtype.test.asd b/gtype.test.asd new file mode 100644 index 0000000..74af1e2 --- /dev/null +++ b/gtype.test.asd @@ -0,0 +1,24 @@ +#| + This file is a part of gtype project. + Copyright (c) 2019 Masataro Asai (guicho2.71828@gmail.com) +|# + + +(in-package :cl-user) +(defpackage gtype.test-asd + (:use :cl :asdf)) +(in-package :gtype.test-asd) + + +(defsystem gtype.test + :author "Masataro Asai" + :mailto "guicho2.71828@gmail.com" + :description "Test system of gtype" + :license "LLGPL" + :depends-on (:gtype + :fiveam) + :components ((:module "t" + :components + ((:file "package")))) + :perform (test-op :after (op c) (eval (read-from-string "(5am:run! :gtype)")) +)) diff --git a/legal/COPYING b/legal/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/legal/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state 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 program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/legal/COPYING.LESSER b/legal/COPYING.LESSER new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/legal/COPYING.LESSER @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + 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 that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU 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 as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/legal/DCO1.1.txt b/legal/DCO1.1.txt new file mode 100644 index 0000000..8201f99 --- /dev/null +++ b/legal/DCO1.1.txt @@ -0,0 +1,37 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. diff --git a/src/package.lisp b/src/package.lisp new file mode 100644 index 0000000..aeeae96 --- /dev/null +++ b/src/package.lisp @@ -0,0 +1,104 @@ +#| + +This file is a part of NUMCL project. +Copyright (c) 2019 IBM Corporation +SPDX-License-Identifier: LGPL-3.0-or-later + +NUMCL is free software: you can redistribute it and/or modify it under the terms +of the GNU General Public License as published by the Free Software +Foundation,either version 3 of the License, or (at your option) any +later version. + +NUMCL 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. + +You should have received a copy of the GNU General Public License along with +NUMCL. If not, see . + +|# + +(in-package :cl-user) +(defpackage gtype + (:use :cl :trivialib.type-unify :trivial-cltl2 :trivia :alexandria :iterate :type-r) + (:export + #:gtype + #:resolve + #:resolving + #:in-compile-time)) +(in-package :gtype) + +;; blah blah blah. + +(defmacro in-compile-time ((&optional env) &body body) + (with-gensyms (macro) + `(macrolet ((,macro (&environment ,env) + ,@body)) + (,macro)))) + +#| +(proclaim '(declaration bogus)) + +(trivial-cltl2:define-declaration bogus (specifier env) + (declare (ignorable env)) + ;; (print specifier) + (values :declare specifier)) + +(defun bogus () + (declare (bogus a)) + (declare (bogus b)) ;the second bogus will overwrite the value + (in-compile-time (e) + `',(print (declaration-information 'bogus e)))) + + + +(proclaim '(declaration bogus2)) + +(trivial-cltl2:define-declaration bogus2 (specifier env) + (declare (ignorable env)) + ;; (print specifier) + (ematch specifier + ((list* 'bogus2 info) + (values :declare (list* 'bogus2 (append info (declaration-information 'bogus2 env))))))) + +(defun bogus2 () + (declare (bogus2 a)) + (declare (bogus2 b)) ; this way you can manually append information + (in-compile-time (e) + `',(print (declaration-information 'bogus2 e)))) +|# + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(defun variablep (symbol) + (match symbol + ((symbol :name (string* #\?)) + t))) + +(proclaim '(declaration gtype)) + + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +;; design sketch + +#| +;; the function should look like this: + +(defun fn2 (a b) + (declare (gtype (array ?t) a)) + (declare (gtype ?t b)) + (* a b)) + +;; ideally, defun, let, locally, lambda etc. should hook into it. + +;; note: on sbcl, trivial LOCALLY is not removed + +(defun fn (a b) + (declare (optimize (speed 3))) + ;; (declare (fixnum a b)) + (locally + (declare (fixnum a b)) + (max a b))) + +|# diff --git a/src/resolve.lisp b/src/resolve.lisp new file mode 100644 index 0000000..7f339c8 --- /dev/null +++ b/src/resolve.lisp @@ -0,0 +1,149 @@ +#| + +This file is a part of NUMCL project. +Copyright (c) 2019 IBM Corporation +SPDX-License-Identifier: LGPL-3.0-or-later + +NUMCL is free software: you can redistribute it and/or modify it under the terms +of the GNU General Public License as published by the Free Software +Foundation,either version 3 of the License, or (at your option) any +later version. + +NUMCL 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. + +You should have received a copy of the GNU General Public License along with +NUMCL. If not, see . + +|# + +#| + +A strategy that separates gtype declarations and resolve macros +to add type checks + +|# + +(in-package :gtype) + +(defun find-lexical-variables (env) + #+sbcl + (mapcar #'car + (sb-c::lexenv-vars + (sb-c::coerce-to-lexenv env))) + #+ccl + (let ((vars (ccl::lexenv.variables env))) + (when (listp vars) + (append (iter (for v in vars) + (for bits = (ccl::var-bits v)) + (when (and (typep bits 'integer) + (not (logbitp ccl::$vbittemporary bits)) + ;; (not (logbitp ccl::$vbitignoreunuused bits)) + ;; (not (logbitp ccl::$vbitignore bits)) + ;; (not (logbitp ccl::$vbitspecial bits)) + ) + (collect (ccl::var-name v)))) + (find-lexical-variables (ccl::lexenv.parent-env env))))) + #-(or sbcl ccl) + (error "this implementation is not supported. Pull request is welcome")) + +(trivial-cltl2:define-declaration gtype (specifier env) + (declare (ignorable env)) + ;; (print specifier) + (ematch specifier + ((list* 'gtype gtype variables) + ;; If the first value is :VARIABLE or :FUNCTION then the second value should be a + ;; list of elements of the form (BINDING-NAME KEY VALUE). conses (KEY . VALUE) + ;; will be added to the alist returned by: + (values :variable + (iter (for v in variables) + (collecting + (list v 'gtype gtype)) + ;; also add a regular type specifier + (collecting + (list v 'type (subst-if '* #'variablep gtype)))))))) + +(defun gvars (env) + (iter + (for v in (find-lexical-variables env)) + (for (values binding local-p alist) = (variable-information v env)) + (for key-value-pair = (assoc 'gtype alist)) + (when key-value-pair + (collect v)))) + +(defun gtemplates (env) + (iter + (for v in (find-lexical-variables env)) + (for (values binding local-p alist) = (variable-information v env)) + (for key-value-pair = (assoc 'gtype alist)) + (when key-value-pair + (collect (cdr key-value-pair))))) + +(defmacro resolve (&environment env &body body) + (multiple-value-bind (body decls) (alexandria:parse-body body) + (let* ((other-decls nil) + (gvars (gvars env)) + (gtemplates (gtemplates env))) + ;; replace templates with normal type declarations + + (iter (for decl in decls) + ;; (declare (...) (...)) + (iter (for subdecl in (cdr decl)) + (match subdecl + ((list* 'gtype template vars) + (iter (for var in vars) + (push var gvars) + (push template gtemplates)) + (let ((normal (subst-if '* #'variablep template))) + (push (list* 'type normal vars) + other-decls))) + (_ + (push subdecl other-decls))))) + (setf gvars (nreverse gvars) + gtemplates (nreverse gtemplates) + other-decls (nreverse other-decls)) + + (let ((parameters + (remove-if-not #'variablep + (remove-duplicates + (flatten gtemplates))))) + (with-gensyms (assignment unified-p) + `(locally + (declare ,@other-decls + ,@(mapcar (lambda (template var) `(gtype ,template ,var)) + gtemplates + gvars)) + (multiple-value-bind (,assignment ,unified-p) + (type-unify ',parameters ',gtemplates (list ,@(mapcar (lambda (v) `(type-of ,v)) gvars))) + ;; (format t "assignment: ~a" ,assignment) + (assert ,unified-p nil "gtypes failed to unify to the actual types:~% ~a~% against~% ~a" + ',gtemplates + (list ,@(mapcar (lambda (v) `(type-of ,v)) gvars))) + (let ,(mapcar (lambda (p) + `(,p (cdr (assoc ',p ,assignment)))) + parameters) + (declare (ignorable ,@parameters)) + ,@body)))))))) + + +(defmacro resolving (&body body) + `(resolve ,@body)) + + + +;; no functions for now +#+(or) +(defun function-gtypes (env fns) + (iter + (for v in fns) + (for (values binding local-p alist) = (function-information v env)) + (collect (cdr (or (assoc 'gtype alist) + (assoc 'ftype alist)))))) + +#+(or) +(defun find-lexical-funs (env) + #+sbcl + (mapcar #'car + (sb-c::lexenv-funs + (sb-c::coerce-to-lexenv env)))) diff --git a/t/package.lisp b/t/package.lisp new file mode 100644 index 0000000..a039b9b --- /dev/null +++ b/t/package.lisp @@ -0,0 +1,163 @@ +#| + This file is a part of gtype project. + Copyright (c) 2019 Masataro Asai (guicho2.71828@gmail.com) +|# + +(in-package :cl-user) +(defpackage :gtype.test + (:use :cl + :gtype + :fiveam + :trivialib.type-unify :trivial-cltl2 :trivia :alexandria :iterate)) +(in-package :gtype.test) + + + +(def-suite :gtype) +(in-suite :gtype) + +;; run test with (run! test-name) + +(defun dot1 (a b) + (resolve + (declare (gtype (array ?t ?d) a b)) + (declare (optimize)) + (print (list a b ?t ?d)) + :ok)) + +(defun dot2 (a b) + (resolve + (declare (gtype (array fixnum ?d) a b)) + (print ?d) + :ok)) + +(defun dot3 (a b) + (resolve + (declare (gtype (array ?t ?d) a)) + (declare (gtype (array ?t ?d) b)) + (print (list ?t ?d)) + :ok)) + +(defun dot4 (a b) + (resolve + (declare (gtype (array ?t ?d) a) + (gtype (array ?t ?d) b)) + (print (list ?t ?d)) + :ok)) + +(defun mul (a b result) + (resolve + (declare (gtype (array fixnum ?d) a b result)) + (print (list ?d)) + :ok)) + +(defun gemm (a b c) + (resolve + (declare (gtype (array ?t (?n1 ?n2)) a) + (gtype (array ?t (?n2 ?n3)) b) + (gtype (array ?t (?n1 ?n3)) c)) + (print (list ?n1 ?n2 ?n3)) + :ok)) + +(defun conv2d (input kernel result) + (resolve + (declare (gtype (array ?t (?b ?h ?w ?c1)) input) + (gtype (array ?t (?kh ?kw ?f)) kernel) + (gtype (array ?t (?b ?h ?w ?c2)) result)) + (print (list ?t ?b ?h ?w ?c1 ?c2)) + :ok)) + +(defun a (type &optional (n 1)) + (make-array n :element-type type)) + +(test dot1 + + (is (eq :ok (dot1 (a 'fixnum) (a 'fixnum)))) + (is (eq :ok (dot1 (a 'single-float) (a 'single-float)))) + (signals error + (dot1 (a 'single-float) (a 'fixnum)))) + +(test dot2 + (is (eq :ok (dot2 (a 'fixnum) (a 'fixnum)))) + (signals error + ;; this is due to fixnum specification + (dot2 (a 'single-float) (a 'single-float))) + (signals error + (dot2 (a 'fixnum) (a 'fixnum 2)))) + +(test dot3 + (is (eq :ok (dot3 (a 'fixnum) (a 'fixnum)))) + (is (eq :ok (dot3 (a 'single-float) (a 'single-float)))) + (signals error + (dot3 (a 'single-float) (a 'fixnum)))) + +(test dot4 + + (is (eq :ok (dot4 (a 'fixnum) (a 'fixnum)))) + (is (eq :ok (dot4 (a 'single-float) (a 'single-float)))) + (signals error + (dot4 (a 'single-float) (a 'fixnum)))) + +(test mul + (is (eq :ok (mul (a 'fixnum) (a 'fixnum) (a 'fixnum)))) + (signals type-error + ;; this is due to fixnum specification + (mul (a 'single-float) (a 'fixnum) (a 'fixnum)))) + +(test gemm + (is (eq :ok (gemm (a 'fixnum '(3 5)) + (a 'fixnum '(5 4)) + (a 'fixnum '(3 4))))) + (is (eq :ok (gemm (a 'fixnum '(2 2)) + (a 'fixnum '(2 2)) + (a 'fixnum '(2 2))))) + (is (eq :ok (gemm (a 'fixnum '(1 2)) + (a 'fixnum '(2 1)) + (a 'fixnum '(1 1))))) + (is (eq :ok (gemm (a 'fixnum '(2 1)) + (a 'fixnum '(1 2)) + (a 'fixnum '(2 2))))) + (signals error + (gemm (a 'fixnum '(3 5)) + (a 'fixnum '(5 6)) + (a 'fixnum '(3 4)))) + (signals error + (gemm (a 'fixnum '(2 2)) + (a 'fixnum '(2 2)) + (a 'fixnum '(2 3)))) + (signals error + (gemm (a 'fixnum '(2 2)) + (a 'fixnum '(2 1)) + (a 'fixnum '(1 1)))) + (signals error + (gemm (a 'fixnum '(2 1)) + (a 'fixnum '(1 2 4)) + (a 'fixnum '(2 2))))) + +(test gemm2 + (signals error + (gemm (a 'single-float '(2 1)) + (a 'fixnum '(1 2)) + (a 'fixnum '(2 2)))) + (signals error + (gemm (a 'fixnum '(2 1)) + (a 'single-float '(1 2)) + (a 'fixnum '(2 2)))) + (signals error + (gemm (a 'fixnum '(2 1)) + (a 'fixnum '(1 2)) + (a 'single-float '(2 2)))) + (signals error + (gemm (a 'fixnum '(2 1)) + (a 'single-float '(1 2)) + (a 'single-float '(2 2)))) + (signals error + (gemm (a 'single-float '(2 1)) + (a 'fixnum '(1 2)) + (a 'single-float '(2 2)))) + (is (eq :ok (gemm (a 'single-float '(2 1)) + (a 'single-float '(1 2)) + (a 'single-float '(2 2)))))) + + + diff --git a/testscr.ros b/testscr.ros new file mode 100755 index 0000000..d232ced --- /dev/null +++ b/testscr.ros @@ -0,0 +1,17 @@ +#!/bin/sh +#|-*- mode:lisp -*-|# +#| +exec ros -Q -- $0 "$@" +|# + +(defun main (&rest argv) + (declare (ignorable argv)) + (uiop:quit (if (handler-case + (progn + (ql:quickload :gtype.test) + (eval (read-from-string "(5am:run! :gtype)")) +) + (serious-condition (c) + (describe c) + (uiop:quit 2))) + 0 1)))