Merge pull request #69 from GrammaticalFramework/pgf2-hackage

Update pgf2 metadata for uploading to Hackage

Even though this isn't able to package the C runtime itself into the Haskell package, I think these changes are still worth merging into master.

src/runtime/haskell-bind/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 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.
+
+## 1.0.0
+
+- Everything up until 2020-07-11.

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. <https://fsf.org/>
+ 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.

src/runtime/haskell-bind/PGF.hs

@@ -1,3 +0,0 @@
-module PGF(module PGF2) where
-
-import PGF2

src/runtime/haskell-bind/PGF/Internal.hs

@@ -1 +0,0 @@
-module PGF.Internal where

src/runtime/haskell-bind/README

@@ -1,26 +0,0 @@
-This is a binding to the new GF 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
-
-HOW TO COMPILE:
-
-cabal install
-
-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. Example:
-
-  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)

src/runtime/haskell-bind/README.md

@@ -0,0 +1,56 @@
+# PGF2
+
+This is a Haskell binding to the PGF runtime written in C.
+
+The exposed modules are:
+
+- `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
+
+**Important:** You must have the C runtime already installed and available on your system.
+See <https://github.com/GrammaticalFramework/gf-core/blob/master/src/runtime/c/INSTALL>
+
+Once the runtine is installed, you can install the library to your global Cabal installation:
+
+```
+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
+
+Simply import `PGF2` in your Haskell program.
+The Cabal infrastructure will make sure to tell the compiler where to find the relevant modules.
+
+## Example
+
+```haskell
+module Main where
+
+import PGF2
+import qualified Data.Map as Map
+
+main = do
+  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
+```

src/runtime/haskell-bind/pgf2.cabal

@@ -1,37 +1,47 @@
 name: pgf2
-version:             0.1.0.0
+version: 1.2.0
--- synopsis:
+synopsis: Bindings to the C version of the PGF runtime
--- description:
+description:
-homepage:            http://www.grammaticalframework.org
+  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
---license-file:        LICENSE
+license-file: LICENSE
-author:              Krasimir Angelov, Inari
+author: Krasimir Angelov
-maintainer:
+maintainer: kr.angelov@gmail.com
--- copyright:
 category: Language
 build-type: Simple
-extra-source-files:  README
+extra-source-files: CHANGELOG.md, README.md
 cabal-version: >=1.10
 
 library
-  exposed-modules:     PGF2, PGF2.Internal
+  exposed-modules:
-                       -- backwards compatibility API:
+    PGF2,
-                       --, PGF, PGF.Internal
+    PGF2.Internal
-  other-modules:       PGF2.FFI, PGF2.Expr, PGF2.Type
+  other-modules:
-  build-depends:       base >=4.3,
+    PGF2.FFI,
-                       containers, pretty
+    PGF2.Expr,
-  -- hs-source-dirs:
+    PGF2.Type
+  build-depends:
+    base >=4.3 && <5,
+    containers,
+    pretty
   default-language: Haskell2010
   build-tools: hsc2hs
-
   extra-libraries: pgf gu
   cc-options: -std=c99
   c-sources: utils.c
 
-executable pgf-shell
+-- executable pgf-shell
-  main-is:             pgf-shell.hs
+--   main-is: pgf-shell.hs
-  hs-source-dirs:      examples
+--   hs-source-dirs: examples
-  build-depends:       base, pgf2, containers, mtl, lifted-base
+--   build-depends:
-  default-language:    Haskell2010
+--     base,
-  if impl(ghc>=7.0)
+--     containers,
-    ghc-options: -rtsopts
+--     lifted-base,
+--     mtl,
+--     pgf2
+--   default-language: Haskell2010
+--   if impl(ghc>=7.0)
+--     ghc-options: -rtsopts

src/runtime/haskell-bind/stack.yaml

@@ -0,0 +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