From 2ac796dbbc8f210132665a580d1ad55145c21fea Mon Sep 17 00:00:00 2001 From: "John J. Camilleri" Date: Wed, 8 Jul 2020 21:55:42 +0200 Subject: [PATCH 1/5] Remove PGF from PGF2, clean up PGF2 cabal file. --- src/runtime/haskell-bind/PGF.hs | 3 - src/runtime/haskell-bind/PGF/Internal.hs | 1 - src/runtime/haskell-bind/pgf2.cabal | 72 ++++++++++++++---------- 3 files changed, 41 insertions(+), 35 deletions(-) delete mode 100644 src/runtime/haskell-bind/PGF.hs delete mode 100644 src/runtime/haskell-bind/PGF/Internal.hs diff --git a/src/runtime/haskell-bind/PGF.hs b/src/runtime/haskell-bind/PGF.hs deleted file mode 100644 index 8aeca7ab8..000000000 --- a/src/runtime/haskell-bind/PGF.hs +++ /dev/null @@ -1,3 +0,0 @@ -module PGF(module PGF2) where - -import PGF2 diff --git a/src/runtime/haskell-bind/PGF/Internal.hs b/src/runtime/haskell-bind/PGF/Internal.hs deleted file mode 100644 index e8193b788..000000000 --- a/src/runtime/haskell-bind/PGF/Internal.hs +++ /dev/null @@ -1 +0,0 @@ -module PGF.Internal where diff --git a/src/runtime/haskell-bind/pgf2.cabal b/src/runtime/haskell-bind/pgf2.cabal index 4022f0b9b..166369369 100644 --- a/src/runtime/haskell-bind/pgf2.cabal +++ b/src/runtime/haskell-bind/pgf2.cabal @@ -1,37 +1,47 @@ -name: pgf2 -version: 0.1.0.0 --- synopsis: --- description: -homepage: http://www.grammaticalframework.org -license: LGPL-3 ---license-file: LICENSE -author: Krasimir Angelov, Inari -maintainer: --- copyright: -category: Language -build-type: Simple -extra-source-files: README -cabal-version: >=1.10 +name: pgf2 +version: 1.0.0 +synopsis: Bindings to the Grammatical Framework C runtime +description: + GF, Grammatical Framework, is a programming language for multilingual grammar applications. + GF grammars are compiled into Portable Grammar Format (PGF) which can be used with the PGF runtime, written in C. + This package provides Haskell bindings to that runtime. +homepage: https://www.grammaticalframework.org +license: LGPL-3 +author: Krasimir Angelov, Inari Listenmaa +category: Language +build-type: Simple +extra-source-files: README +cabal-version: >=1.10 library - exposed-modules: PGF2, PGF2.Internal, SG - -- backwards compatibility API: - --, PGF, PGF.Internal - other-modules: PGF2.FFI, PGF2.Expr, PGF2.Type, SG.FFI - build-depends: base >=4.3, - containers, pretty - -- hs-source-dirs: - default-language: Haskell2010 - build-tools: hsc2hs - - extra-libraries: sg pgf gu - cc-options: -std=c99 - c-sources: utils.c + exposed-modules: + PGF2, + PGF2.Internal, + SG + other-modules: + PGF2.FFI, + PGF2.Expr, + PGF2.Type, + SG.FFI + build-depends: + base >=4.3, + containers, + pretty + default-language: Haskell2010 + build-tools: hsc2hs + extra-libraries: sg pgf gu + cc-options: -std=c99 + c-sources: utils.c executable pgf-shell - main-is: pgf-shell.hs - hs-source-dirs: examples - build-depends: base, pgf2, containers, mtl, lifted-base - default-language: Haskell2010 + main-is: pgf-shell.hs + hs-source-dirs: examples + build-depends: + base, + containers, + lifted-base, + mtl, + pgf2 + default-language: Haskell2010 if impl(ghc>=7.0) ghc-options: -rtsopts From 88a73c1d9e9e9bf1ac4c4194917e50df1bcce635 Mon Sep 17 00:00:00 2001 From: "John J. Camilleri" Date: Sat, 11 Jul 2020 20:00:25 +0200 Subject: [PATCH 2/5] Bump pgf2 to 1.1.0, update README --- src/runtime/haskell-bind/README | 50 ++++++++++++++++++++--------- src/runtime/haskell-bind/pgf2.cabal | 2 +- 2 files changed, 36 insertions(+), 16 deletions(-) diff --git a/src/runtime/haskell-bind/README b/src/runtime/haskell-bind/README index 4782c2d37..60251e653 100644 --- a/src/runtime/haskell-bind/README +++ b/src/runtime/haskell-bind/README @@ -1,26 +1,46 @@ -This is a binding to the new GF runtime in C. +# PGF2 + +This is a Haskell binding to the PGF runtime in C. The files are: -PGF2.hsc -- a user API similar to Python and Java APIs -PGF2/FFI.hs -- an internal module with FFI definitions for - -- the relevant C functions +- PGF2.hsc: a user API similar to Python and Java APIs +- PGF2/FFI.hs: an internal module with FFI definitions for the relevant C functions -HOW TO COMPILE: +## How to compile +``` cabal install +``` -HOW TO USE: +**Note:** you must have the PGF C runtime already installed and available. +See -- Import PGF to the Haskell program that you're writing. - The Cabal infrastructure will make sure to tell the compiler - where to find the relevant modules. Example: +## How to use - module Main where +Import PGF to the Haskell program that you're writing. +The Cabal infrastructure will make sure to tell the compiler +where to find the relevant modules. - import PGF2 - import qualified Data.Map as Map +## Example - main = do - pgf <- readPGF "Foo.pgf" - let Just english = Map.lookup "FooEng" (languages pgf) +```haskell +module Main where + +import PGF2 +import qualified Data.Map as Map + +main = do + pgf <- readPGF "Foo.pgf" + let Just english = Map.lookup "FooEng" (languages pgf) +``` + +## Changelog + +### 1.1.0 + +Remove SG library. + +### 1.0.0 + +Everything up until 2020-07-11. diff --git a/src/runtime/haskell-bind/pgf2.cabal b/src/runtime/haskell-bind/pgf2.cabal index 75b6e8a76..9e1e1e393 100644 --- a/src/runtime/haskell-bind/pgf2.cabal +++ b/src/runtime/haskell-bind/pgf2.cabal @@ -1,5 +1,5 @@ name: pgf2 -version: 1.0.0 +version: 1.1.0 synopsis: Bindings to the Grammatical Framework C runtime description: GF, Grammatical Framework, is a programming language for multilingual grammar applications. From 38f468eed3325d5e435021b8b137f80545f22a95 Mon Sep 17 00:00:00 2001 From: "John J. Camilleri" Date: Sat, 11 Jul 2020 21:06:08 +0200 Subject: [PATCH 3/5] (pgf2) Readme, license, changelog --- src/runtime/haskell-bind/CHANGELOG.md | 7 + src/runtime/haskell-bind/LICENSE | 165 ++++++++++++++++++ .../haskell-bind/{README => README.md} | 30 ++-- src/runtime/haskell-bind/pgf2.cabal | 10 +- 4 files changed, 193 insertions(+), 19 deletions(-) create mode 100644 src/runtime/haskell-bind/CHANGELOG.md create mode 100644 src/runtime/haskell-bind/LICENSE rename src/runtime/haskell-bind/{README => README.md} (51%) diff --git a/src/runtime/haskell-bind/CHANGELOG.md b/src/runtime/haskell-bind/CHANGELOG.md new file mode 100644 index 000000000..e3d6410fa --- /dev/null +++ b/src/runtime/haskell-bind/CHANGELOG.md @@ -0,0 +1,7 @@ +## 1.1.0 + +- Remove SG library. + +## 1.0.0 + +- Everything up until 2020-07-11. diff --git a/src/runtime/haskell-bind/LICENSE b/src/runtime/haskell-bind/LICENSE new file mode 100644 index 000000000..0a041280b --- /dev/null +++ b/src/runtime/haskell-bind/LICENSE @@ -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/src/runtime/haskell-bind/README b/src/runtime/haskell-bind/README.md similarity index 51% rename from src/runtime/haskell-bind/README rename to src/runtime/haskell-bind/README.md index 60251e653..a4ce0ef20 100644 --- a/src/runtime/haskell-bind/README +++ b/src/runtime/haskell-bind/README.md @@ -2,10 +2,10 @@ This is a Haskell binding to the PGF runtime in C. -The files are: +The exposed modules are: -- PGF2.hsc: a user API similar to Python and Java APIs -- PGF2/FFI.hs: an internal module with FFI definitions for the relevant C functions +- `PGF2`: a user API similar to Python and Java APIs +- `PGF2.Internal`: an internal module with FFI definitions for the relevant C functions ## How to compile @@ -31,16 +31,16 @@ import PGF2 import qualified Data.Map as Map main = do - pgf <- readPGF "Foo.pgf" - let Just english = Map.lookup "FooEng" (languages pgf) + pgf <- readPGF "App12.pgf" + let Just eng = Map.lookup "AppEng" (languages pgf) + + -- Parsing + let res = parse eng (startCat pgf) "this is a small theatre" + let ParseOk ((tree,prob):rest) = res + print tree + + -- Linearisation + let Just expr = readExpr "AdjCN (PositA red_A) (UseN theatre_N)" + let s = linearize eng expr + print s ``` - -## Changelog - -### 1.1.0 - -Remove SG library. - -### 1.0.0 - -Everything up until 2020-07-11. diff --git a/src/runtime/haskell-bind/pgf2.cabal b/src/runtime/haskell-bind/pgf2.cabal index 9e1e1e393..f0cc65e70 100644 --- a/src/runtime/haskell-bind/pgf2.cabal +++ b/src/runtime/haskell-bind/pgf2.cabal @@ -1,16 +1,18 @@ name: pgf2 version: 1.1.0 -synopsis: Bindings to the Grammatical Framework C runtime +synopsis: Bindings to the PGF runtime in C description: GF, Grammatical Framework, is a programming language for multilingual grammar applications. GF grammars are compiled into Portable Grammar Format (PGF) which can be used with the PGF runtime, written in C. This package provides Haskell bindings to that runtime. homepage: https://www.grammaticalframework.org license: LGPL-3 -author: Krasimir Angelov, Inari Listenmaa +license-file: LICENSE +author: Krasimir Angelov +maintainer: Krasimir Angelov, John J. Camilleri category: Language build-type: Simple -extra-source-files: README +extra-source-files: CHANGELOG.md, README.md cabal-version: >=1.10 library @@ -22,7 +24,7 @@ library PGF2.Expr, PGF2.Type build-depends: - base >=4.3, + base >=4.3 && <5, containers, pretty default-language: Haskell2010 From f00f0cb0ef46d1a203e9d4ac238ec1a2e867fd51 Mon Sep 17 00:00:00 2001 From: "John J. Camilleri" Date: Tue, 28 Jul 2020 22:36:49 +0200 Subject: [PATCH 4/5] Bump pgf2 to 1.2.0 --- src/runtime/haskell-bind/CHANGELOG.md | 6 ++++++ src/runtime/haskell-bind/README.md | 17 ++++++++------- src/runtime/haskell-bind/pgf2.cabal | 30 +++++++++++++-------------- src/runtime/haskell-bind/stack.yaml | 1 + 4 files changed, 31 insertions(+), 23 deletions(-) create mode 100644 src/runtime/haskell-bind/stack.yaml diff --git a/src/runtime/haskell-bind/CHANGELOG.md b/src/runtime/haskell-bind/CHANGELOG.md index e3d6410fa..e9da7fac4 100644 --- a/src/runtime/haskell-bind/CHANGELOG.md +++ b/src/runtime/haskell-bind/CHANGELOG.md @@ -1,3 +1,9 @@ +## 1.2.0 + +- Stop `pgf-shell` from being built by default. +- parseToChart also returns the category. +- bugfix in bracketedLinearize. + ## 1.1.0 - Remove SG library. diff --git a/src/runtime/haskell-bind/README.md b/src/runtime/haskell-bind/README.md index a4ce0ef20..f136ad2da 100644 --- a/src/runtime/haskell-bind/README.md +++ b/src/runtime/haskell-bind/README.md @@ -1,6 +1,6 @@ # PGF2 -This is a Haskell binding to the PGF runtime in C. +This is a Haskell binding to the PGF runtime written in C. The exposed modules are: @@ -9,18 +9,19 @@ The exposed modules are: ## How to compile -``` -cabal install -``` - **Note:** you must have the PGF C runtime already installed and available. See +Once the runtine is installed, you can use: + +``` +cabal install pgf2 +``` + ## How to use -Import PGF to the Haskell program that you're writing. -The Cabal infrastructure will make sure to tell the compiler -where to find the relevant modules. +Simply import `PGF2` in your Haskell program. +The Cabal infrastructure will make sure to tell the compiler where to find the relevant modules. ## Example diff --git a/src/runtime/haskell-bind/pgf2.cabal b/src/runtime/haskell-bind/pgf2.cabal index f0cc65e70..a4e113f3b 100644 --- a/src/runtime/haskell-bind/pgf2.cabal +++ b/src/runtime/haskell-bind/pgf2.cabal @@ -1,6 +1,6 @@ name: pgf2 -version: 1.1.0 -synopsis: Bindings to the PGF runtime in C +version: 1.2.0 +synopsis: Bindings to the C version of the PGF runtime description: GF, Grammatical Framework, is a programming language for multilingual grammar applications. GF grammars are compiled into Portable Grammar Format (PGF) which can be used with the PGF runtime, written in C. @@ -9,7 +9,7 @@ homepage: https://www.grammaticalframework.org license: LGPL-3 license-file: LICENSE author: Krasimir Angelov -maintainer: Krasimir Angelov, John J. Camilleri +maintainer: kr.angelov@gmail.com category: Language build-type: Simple extra-source-files: CHANGELOG.md, README.md @@ -33,15 +33,15 @@ library cc-options: -std=c99 c-sources: utils.c -executable pgf-shell - main-is: pgf-shell.hs - hs-source-dirs: examples - build-depends: - base, - containers, - lifted-base, - mtl, - pgf2 - default-language: Haskell2010 - if impl(ghc>=7.0) - ghc-options: -rtsopts +-- executable pgf-shell +-- main-is: pgf-shell.hs +-- hs-source-dirs: examples +-- build-depends: +-- base, +-- containers, +-- lifted-base, +-- mtl, +-- pgf2 +-- default-language: Haskell2010 +-- if impl(ghc>=7.0) +-- ghc-options: -rtsopts diff --git a/src/runtime/haskell-bind/stack.yaml b/src/runtime/haskell-bind/stack.yaml new file mode 100644 index 000000000..3d69a763f --- /dev/null +++ b/src/runtime/haskell-bind/stack.yaml @@ -0,0 +1 @@ +resolver: lts-12.26 # ghc 8.4.4 From c53353f08763fbbfb5c0abeaa03da6a23aa64080 Mon Sep 17 00:00:00 2001 From: "John J. Camilleri" Date: Tue, 28 Jul 2020 22:54:34 +0200 Subject: [PATCH 5/5] Updates to PGF2 readme --- src/runtime/haskell-bind/README.md | 15 ++++++++++++--- src/runtime/haskell-bind/stack.yaml | 2 ++ 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/src/runtime/haskell-bind/README.md b/src/runtime/haskell-bind/README.md index f136ad2da..1cb68df65 100644 --- a/src/runtime/haskell-bind/README.md +++ b/src/runtime/haskell-bind/README.md @@ -9,13 +9,22 @@ The exposed modules are: ## How to compile -**Note:** you must have the PGF C runtime already installed and available. +**Important:** You must have the C runtime already installed and available on your system. See -Once the runtine is installed, you can use: +Once the runtine is installed, you can install the library to your global Cabal installation: ``` -cabal install pgf2 +cabal install pgf2 --extra-lib-dirs=/usr/local/lib +``` + +or add it to your `stack.yaml` file: + +```yaml +extra-deps: + - pgf2 +extra-lib-dirs: + - /usr/local/lib ``` ## How to use diff --git a/src/runtime/haskell-bind/stack.yaml b/src/runtime/haskell-bind/stack.yaml index 3d69a763f..3b1a3092b 100644 --- a/src/runtime/haskell-bind/stack.yaml +++ b/src/runtime/haskell-bind/stack.yaml @@ -1 +1,3 @@ +# This is mainly here so that I can run `stack sdist` for uploading to Hackage + resolver: lts-12.26 # ghc 8.4.4