first public issue of fontforge-of-ocaml library under license LGPL 2.1

pbaudin · Apr 4, 2022 · 764c120 · 764c120
commit 764c120
Show file tree

Hide file tree

Showing 29 changed files with 6,600 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/_build/
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,3 @@
+## v1.1.0
+
+### First public release
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,15 @@
+# License of fontforge-of-ocaml library #
+
+The [fontforge-of-ocaml](https://github.com/pbaudin/[fontforge-of-ocaml) library is published under the license [LGPL v2.1](https://spdx.org/licenses/LGPL-2.1-only.html).
+
+About this library,
+you can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation, version 2.1.
+
+It is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.
+
+See the GNU Lesser General Public License version 2.1
+for more details (enclosed in the file [licenses/LGPLv2.1](licenses/LGPLv2.1))
diff --git a/Makefile b/Makefile
@@ -0,0 +1,77 @@
+##############################################################################
+#                                                                            #
+#  This file is part of fontforge-of-ocaml library                           #
+#                                                                            #
+#  Copyright (C) 2017-2022, Patrick BAUDIN                                   #
+#                           (https://github.com/pbaudin/fontforge-of-ocaml)  #
+#                                                                            #
+#  you can redistribute it and/or modify it under the terms of the GNU       #
+#  Lesser General Public License as published by the Free Software           #
+#  Foundation, version 2.1.                                                  #
+#                                                                            #
+#  It is distributed in the hope that it will be useful, but WITHOUT ANY     #
+#  WARRANTY; without even the implied warranty of MERCHANTABILITY or         #
+#  FITNESS FOR A PARTICULAR PURPOSE.                                         #
+#                                                                            #
+#  See the GNU Lesser General Public License version 2.1                     #
+#  for more details (enclosed in the file licenses/LGPLv2.1)                 #
+#                                                                            #
+##############################################################################
+
+.PHONY: all build clean
+
+PACKAGE=fontforge-of-ocaml
+
+all: $(PACKAGE).opam build
+
+build:
+	dune build @install
+
+$(PACKAGE).opam: $(PACKAGE).opam.template dune-project
+	rm -f $@
+	dune build $@
+
+PHONY: clean
+clean:
+	rm -fr _build
+
+##############################################################################
+
+.PHONY: tests
+tests:
+	dune build @runtest
+
+##############################################################################
+
+.PHONY: install uninstall
+
+FFOO_INSTALLDIR?=""
+
+install:
+ifeq ($(FFOO_INSTALLDIR),"")
+	dune install
+else
+	dune install --prefix ${FFOO_INSTALLDIR}
+endif
+
+uninstall:
+ifeq ($(FFOO_INSTALLDIR),"")
+	dune uninstall
+else
+	dune uninstall --prefix ${FFOO_INSTALLDIR}
+endif
+
+##############################################################################
+
+.PHONY: headers
+
+HEADER_FILES:=dune dune-project headers/headache_config.txt Makefile
+HEADER_FILES+=src/dune $(wildcard src/*.ml) $(wildcard src/*.mli)
+HEADER_FILES+=tests/dune tests/Makefile $(wildcard tests/*.ml) $(wildcard tests/*.mli)
+
+HEADACHE=headache -c headers/headache_config.txt -h headers/license.txt
+
+headers:
+	$(HEADACHE) $(HEADER_FILES)
+
+##############################################################################
diff --git a/README.md b/README.md
@@ -0,0 +1,67 @@
+<p>
+    <img src="images/fontforge-of-ocaml.png">
+</p>
+
+Copyright (C) 2017-2022, P. Baudin (https://github.com/pbaudin/fontforge-of-ocaml)
+
+<p>
+    <img src="https://img.shields.io/badge/Tool_License-LGPL_2.1_only-green" /> </br>
+    <img src="https://img.shields.io/badge/Built_with-FontForge_and_OCaml_libraries-green" />
+</br>
+
+# OCaml binding to FontForge #
+
+## Library usage ##
+
+The `fontforge-of-ocaml` library is published under the [LGPL v2.1](LICENSE.md) license and its API is documented in the file [src/FontForge.mli](src/FontForge.mli).
+
+### Example of use ###
+
+Look at the included test file [tests/test_FontForgeLib.ml](tests/test_FontForgeLib.ml).
+
+### Notice ###
+
+The binding is incomplete, but don't forget that the library is able to load `.fea` ([OpenType Feature](https://opentypecookbook.com/putting-it-together)) files to design complex fonts.
+
+### Installation ###
+
+The library can easily be installed from source-based package manager [Opam](https://opam.ocaml.org/)
+from a [pin](https://opam.ocaml.org/doc/Manual.html#Pinning) to this GitHub repository:
+```bash
+$ opam pin https://github.com/pbaudin/fontforge-of-ocaml
+```
+
+On Ubuntu, the library relies on `python3-fontforge` package that contains the `python3` binding to `FontForge`:
+```bash
+$ sudo apt-get install -y python3-fontforge
+```
+
+## Contributing ##
+
+Since the library meets my needs, I won't complete the binding from myself.
+Nevertheless, if you want to contribute you are welcome.
+Don't hesitate to open an issue for that and why not propose a pull request.
+
+## The story ##
+
+### Preamble ###
+
+This library was developed in 2017 and used for the design of several [Advanced Cross-Stitch Fonts](https://github.com/pbaudin/ACSF).
+Five years later, it time to publish the `fontforge-of-ocaml` library even if the binding is incomplete.
+
+### Development ###
+
+The first version of that library was written in [`OCaml`](https://ocaml.org/) and
+used the [`Lymp`](https://github.com/dbousque/lymp) library allowing you to use `Python` functions and objects of `FontForge` API from `OCaml` world.
+
+The `FontForge` API imposes type constraints between the arguments of the functions managing the contextual font tables.
+In order to offer an `OCaml` API as close as the `FontForge` API, the use of [Generalized Algebraic Data Type](https://caml.inria.fr/pub/docs/manual-ocaml/gadts.html) of `OCaml` was seen as an opportunity.
+That has not been so much used due to some bugs in the `Lymp` library raised by the hudge number of calls from `OCaml` to `Python`.
+A work around has been found in generating an intermediate file (specifying the [`OpenType Feature Data`](https://opentypecookbook.com/putting-it-together/) to use in a `.fea` file) to build the final fonts from `FontForge Python` API and the `OCaml` binding. That explains why the development of the `FontForge` binding was stopped earlier that expected.
+
+In the meantime, `Fontforge` API migrated to `Python 3` and the `Lymp` library was no more able to perform the binding with newer versions of `OCaml` compiler and various libraries.
+Nevertheless, with few effort the `Lymp` library was easily replaced by the [`PyMl`](https://github.com/thierry-martinez/pyml) library.
+
+<p>
+    <img src="images/author.png">
+</p>
diff --git a/dune b/dune
@@ -0,0 +1,21 @@
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;                                                                            ;;
+;;  This file is part of fontforge-of-ocaml library                           ;;
+;;                                                                            ;;
+;;  Copyright (C) 2017-2022, Patrick BAUDIN                                   ;;
+;;                           (https://github.com/pbaudin/fontforge-of-ocaml)  ;;
+;;                                                                            ;;
+;;  you can redistribute it and/or modify it under the terms of the GNU       ;;
+;;  Lesser General Public License as published by the Free Software           ;;
+;;  Foundation, version 2.1.                                                  ;;
+;;                                                                            ;;
+;;  It is distributed in the hope that it will be useful, but WITHOUT ANY     ;;
+;;  WARRANTY; without even the implied warranty of MERCHANTABILITY or         ;;
+;;  FITNESS FOR A PARTICULAR PURPOSE.                                         ;;
+;;                                                                            ;;
+;;  See the GNU Lesser General Public License version 2.1                     ;;
+;;  for more details (enclosed in the file licenses/LGPLv2.1)                 ;;
+;;                                                                            ;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(dirs src tests)
diff --git a/dune-project b/dune-project
@@ -0,0 +1,42 @@
+(lang dune 2.8)
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;                                                                            ;;
+;;  This file is part of fontforge-of-ocaml library                           ;;
+;;                                                                            ;;
+;;  Copyright (C) 2017-2022, Patrick BAUDIN                                   ;;
+;;                           (https://github.com/pbaudin/fontforge-of-ocaml)  ;;
+;;                                                                            ;;
+;;  you can redistribute it and/or modify it under the terms of the GNU       ;;
+;;  Lesser General Public License as published by the Free Software           ;;
+;;  Foundation, version 2.1.                                                  ;;
+;;                                                                            ;;
+;;  It is distributed in the hope that it will be useful, but WITHOUT ANY     ;;
+;;  WARRANTY; without even the implied warranty of MERCHANTABILITY or         ;;
+;;  FITNESS FOR A PARTICULAR PURPOSE.                                         ;;
+;;                                                                            ;;
+;;  See the GNU Lesser General Public License version 2.1                     ;;
+;;  for more details (enclosed in the file licenses/LGPLv2.1)                 ;;
+;;                                                                            ;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(generate_opam_files true)
+
+(name fontforge-of-ocaml)
+(maintainers "https://github.com/pbaudin/fontforge-of-ocaml")
+
+(package
+  (name fontforge-of-ocaml)
+  (depends
+    (ocaml (>= 4.09.0))
+    (base (>= v0.12.2))
+    (fmt (>= 0.8.9 ))
+    (pyml (>= 20200518 ))
+    (ppx_python (>= v0.12.0))
+  )
+  (depopts
+        (headache (>= 1.05))
+  )
+  ; (conflict ...)
+  (tags ("font" "fontforge" "binding")
+  )
+)
diff --git a/fontforge-of-ocaml.opam b/fontforge-of-ocaml.opam
@@ -0,0 +1,45 @@
+# This file is generated by dune, edit dune-project instead
+tags: ["font" "fontforge" "binding"]
+depends: [
+  "dune" {>= "2.8"}
+  "ocaml" {>= "4.09.0"}
+  "base" {>= "v0.12.2"}
+  "fmt" {>= "0.8.9"}
+  "pyml" {>= "20200518"}
+  "ppx_python" {>= "v0.12.0"}
+  "odoc" {with-doc}
+]
+depopts: [
+  "headache" {>= "1.05"}
+]
+build: [
+  ["dune" "subst"] {dev}
+  [
+    "dune"
+    "build"
+    "-p"
+    name
+    "-j"
+    jobs
+    "@install"
+    "@runtest" {with-test}
+    "@doc" {with-doc}
+  ]
+]
+opam-version: "2.0"
+name: "fontforge-of-ocaml"
+version: "1.1.0"
+synopsis: "OCaml binding of FontForge"
+description: """
+Library providing OCaml binding of FontForge Python API
+"""
+maintainer: "http://github.com/pbaudin"
+authors: [
+  "Patrick Baudin"
+]
+license: "LGPL-2.1-only"
+homepage: "http://github.com/pbaudin/fontforge-of-ocaml"
+bug-reports: "https://github.com/pbaudin/fontforge-of-ocaml"
+messages: [
+]
+dev-repo: "git+https://github.com/pbaudin/fontforge-of-ocaml"
diff --git a/fontforge-of-ocaml.opam.template b/fontforge-of-ocaml.opam.template
@@ -0,0 +1,17 @@
+opam-version: "2.0"
+name: "fontforge-of-ocaml"
+version: "1.1.0"
+synopsis: "OCaml binding of FontForge"
+description: """
+Library providing OCaml binding of FontForge Python API
+"""
+maintainer: "http://github.com/pbaudin"
+authors: [
+  "Patrick Baudin"
+]
+license: "LGPL-2.1-only"
+homepage: "http://github.com/pbaudin/fontforge-of-ocaml"
+bug-reports: "https://github.com/pbaudin/fontforge-of-ocaml"
+messages: [
+]
+dev-repo: "git+https://github.com/pbaudin/fontforge-of-ocaml"
diff --git a/headers/headache_config.txt b/headers/headache_config.txt
@@ -0,0 +1,39 @@
+##############################################################################
+#                                                                            #
+#  This file is part of fontforge-of-ocaml library                           #
+#                                                                            #
+#  Copyright (C) 2017-2022, Patrick BAUDIN                                   #
+#                           (https://github.com/pbaudin/fontforge-of-ocaml)  #
+#                                                                            #
+#  you can redistribute it and/or modify it under the terms of the GNU       #
+#  Lesser General Public License as published by the Free Software           #
+#  Foundation, version 2.1.                                                  #
+#                                                                            #
+#  It is distributed in the hope that it will be useful, but WITHOUT ANY     #
+#  WARRANTY; without even the implied warranty of MERCHANTABILITY or         #
+#  FITNESS FOR A PARTICULAR PURPOSE.                                         #
+#                                                                            #
+#  See the GNU Lesser General Public License version 2.1                     #
+#  for more details (enclosed in the file licenses/LGPLv2.1)                 #
+#                                                                            #
+##############################################################################
+
+## Usage
+# headache -c headache_config.txt -h license.txt ...
+
+## Dune ##
+# note: the skip directive requires a filename starting by ".*"
+#       since the skip directive looks at the full path-name
+| "dune-project"  -> frame open:";;" line:";" close:";;"
+| ".*dune-project" -> skip match:"(lang.*"
+| "dune"          -> frame open:";;" line:";" close:";;"
+
+## Makefile ##
+| "Make.*" -> frame open:"#"  line:"#" close:"#"
+
+## Shell scripts ##
+| ".*\.sh" -> frame open:"#"  line:"#" close:"#"
+| ".*\.sh" -> skip match:"#!.*"
+
+## Headache config ##
+| "headache_config.txt" -> frame open:"#"  line:"#" close:"#"
diff --git a/headers/license.txt b/headers/license.txt
@@ -0,0 +1,17 @@
+
+This file is part of fontforge-of-ocaml library
+
+Copyright (C) 2017-2022, Patrick BAUDIN
+                         (https://github.com/pbaudin/fontforge-of-ocaml)
+
+you can redistribute it and/or modify it under the terms of the GNU
+Lesser General Public License as published by the Free Software
+Foundation, version 2.1.
+
+It is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.
+
+See the GNU Lesser General Public License version 2.1
+for more details (enclosed in the file licenses/LGPLv2.1)
+
diff --git a/images/author.png b/images/author.png
diff --git a/images/fontforge-of-ocaml.png b/images/fontforge-of-ocaml.png