From 7cecea9df8df158e5d86cfa82b231317daf6a850 Mon Sep 17 00:00:00 2001 From: Sean Chalmers Date: Mon, 30 Dec 2019 21:43:39 +0000 Subject: [PATCH] Start adding stb_truetype wrapper --- shell.nix | 53 ++++ stb-truetype/CHANGELOG.md | 5 + stb-truetype/LICENSE.md | 230 ++++++++++++++++++ stb-truetype/README.md | 3 + stb-truetype/Setup.hs | 2 + stb-truetype/src/Graphics/STB/TrueType.hs | 6 + .../src/Graphics/STB/TrueType/Internal.hsc | 31 +++ stb-truetype/stb-truetype.cabal | 53 ++++ stb-truetype/tests/Main.hs | 4 + 9 files changed, 387 insertions(+) create mode 100644 stb-truetype/CHANGELOG.md create mode 100644 stb-truetype/LICENSE.md create mode 100644 stb-truetype/README.md create mode 100644 stb-truetype/Setup.hs create mode 100644 stb-truetype/src/Graphics/STB/TrueType.hs create mode 100644 stb-truetype/src/Graphics/STB/TrueType/Internal.hsc create mode 100644 stb-truetype/stb-truetype.cabal create mode 100644 stb-truetype/tests/Main.hs diff --git a/shell.nix b/shell.nix index 3eb00d92..d92eafe6 100644 --- a/shell.nix +++ b/shell.nix @@ -2,8 +2,43 @@ , compiler ? "ghc881" , withHoogle ? false }: let + overlay = self: super: + let + cherrypick-stb-lib = name: file: ver: desc: super.stdenv.mkDerivation { + pname = name; + version = ver; + src = super.fetchFromGitHub { + owner = "nothings"; + repo = "stb"; + rev = "f67165c2bb2af3060ecae7d20d6f731173485ad0"; + sha256 = "1b8r55q4siqfvm1r4wdqgj4vwzw0bfhypgm60dk4b5c7i7rgxx3g"; + }; + phases = [ "unpackPhase" "installPhase" ]; + outputs = [ "out" "dev" ]; + nativeBuildInputs = [ self.pkgconfig ]; + installPhase = '' + mkdir -p $out/include/${name} + # We only care about a single library/header + cp ${file} $out/include/${name}/ + + mkdir -p $dev/lib/pkgconfig + + # These should exist in the stb repo, probably... + cat >> $dev/lib/pkgconfig/${name}.pc << EOF + prefix=$out + exec_prefix=$out + includedir=$out/include/${name} + + Name: ${name} + Description: ${desc} + Version: ${ver} + Cflags: -I$out/include/${name} + EOF + ''; + }; + # Codex packages, add new source locations here first. If you # hit infinite recursion errors when trying to 'nix-shell' you # might need to pass in some other packages explicitly like @@ -26,6 +61,7 @@ weak = { path = ./weak; args = {}; }; tabulation-hash = { path = ./tabulation-hash; args = {}; }; language-server = { path = ./language-server; args = {}; }; + stb-truetype = { path = ./stb-truetype; args = {}; }; # Snowflakes who need things passed in explicitly, usually # because they depend on a system library of their own name. @@ -64,6 +100,10 @@ codexPackageFixes = hself: hsuper: with pkgs.haskell.lib; { harfbuzz = addBuildDepends hsuper.harfbuzz [ self.freetype ]; + stb-truetype = addPkgconfigDepends hsuper.stb-truetype + [ self.stb_rect_pack + self.stb_truetype + ]; }; baseHaskellPackages = if compiler == "default" @@ -103,6 +143,19 @@ # some renames to keep cabal & pkg-config happy icu-uc = super.icu; + # pin stb to recent version + stb_rect_pack = cherrypick-stb-lib + "stb_rect_pack" + "stb_rect_pack.h" + "1.00" + "simple 2D rectangle packer with decent quality"; + + stb_truetype = cherrypick-stb-lib + "stb_truetype" + "stb_truetype.h" + "1.22" + "Font text rasteriser"; + codexShell = self.haskellPackages.shellFor { nativeBuildInputs = [ self.haskellPackages.ghcid diff --git a/stb-truetype/CHANGELOG.md b/stb-truetype/CHANGELOG.md new file mode 100644 index 00000000..fac85cb7 --- /dev/null +++ b/stb-truetype/CHANGELOG.md @@ -0,0 +1,5 @@ +# Revision history for stb-truetype + +## 0.1.0.0 -- YYYY-mm-dd + +* First version. Released on an unsuspecting world. diff --git a/stb-truetype/LICENSE.md b/stb-truetype/LICENSE.md new file mode 100644 index 00000000..e5414504 --- /dev/null +++ b/stb-truetype/LICENSE.md @@ -0,0 +1,230 @@ +# License + +Licensed under either of + * Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) + * BSD 2-Clause license (https://opensource.org/licenses/BSD-2-Clause) +at your option. + +## BSD 2-Clause License + +- Copyright 2019 Edward Kmett + +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR +IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +## Apache License + +_Version 2.0, January 2004_ +_<>_ + +### Terms and Conditions for use, reproduction, and distribution + +#### 1. Definitions + +“License” shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +“Licensor” shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +“Legal Entity” shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, “control” means **(i)** the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the +outstanding shares, or **(iii)** beneficial ownership of such entity. + +“You” (or “Your”) shall mean an individual or Legal Entity exercising +permissions granted by this License. + +“Source” form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +“Object” form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +“Work” shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +“Derivative Works” shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +“Contribution” shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +“submitted” means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as “Not a Contribution.” + +“Contributor” shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +#### 2. Grant of Copyright License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +#### 3. Grant of Patent License + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +#### 4. Redistribution + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +* **(a)** You must give any other recipients of the Work or Derivative Works a copy of +this License; and +* **(b)** You must cause any modified files to carry prominent notices stating that You +changed the files; and +* **(c)** You must retain, in the Source form of any Derivative Works that You distribute, +all copyright, patent, trademark, and attribution notices from the Source form +of the Work, excluding those notices that do not pertain to any part of the +Derivative Works; and +* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any +Derivative Works that You distribute must include a readable copy of the +attribution notices contained within such NOTICE file, excluding those notices +that do not pertain to any part of the Derivative Works, in at least one of the +following places: within a NOTICE text file distributed as part of the +Derivative Works; within the Source form or documentation, if provided along +with the Derivative Works; or, within a display generated by the Derivative +Works, if and wherever such third-party notices normally appear. The contents of +the NOTICE file are for informational purposes only and do not modify the +License. You may add Your own attribution notices within Derivative Works that +You distribute, alongside or as an addendum to the NOTICE text from the Work, +provided that such additional attribution notices cannot be construed as +modifying the License. + +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +#### 5. Submission of Contributions + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +#### 6. Trademarks + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +#### 7. Disclaimer of Warranty + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, +NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +#### 8. Limitation of Liability + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +#### 9. Accepting Warranty or Additional Liability + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +_END OF TERMS AND CONDITIONS_ + +### APPENDIX: How to apply the Apache License to your work + +To apply the Apache License to your work, attach the following boilerplate +notice, with the fields enclosed by brackets `[]` replaced with your own +identifying information. (Don't include the brackets!) The text should be +enclosed in the appropriate comment syntax for the file format. We also +recommend that a file or class name and description of purpose be included on +the same “printed page” as the copyright notice for easier identification within +third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/stb-truetype/README.md b/stb-truetype/README.md new file mode 100644 index 00000000..2bd0ad22 --- /dev/null +++ b/stb-truetype/README.md @@ -0,0 +1,3 @@ +# STB TrueType + +Haskell wrapper for the open source [`stb-truetype.h` package](https://github.com/nothings/stb/blob/master/stb_truetype.h). diff --git a/stb-truetype/Setup.hs b/stb-truetype/Setup.hs new file mode 100644 index 00000000..9a994af6 --- /dev/null +++ b/stb-truetype/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/stb-truetype/src/Graphics/STB/TrueType.hs b/stb-truetype/src/Graphics/STB/TrueType.hs new file mode 100644 index 00000000..76d664cd --- /dev/null +++ b/stb-truetype/src/Graphics/STB/TrueType.hs @@ -0,0 +1,6 @@ +module Graphics.STB.TrueType where + +import Graphics.STB.TrueType.Internal + +someFunc :: IO () +someFunc = putStrLn "someFunc" diff --git a/stb-truetype/src/Graphics/STB/TrueType/Internal.hsc b/stb-truetype/src/Graphics/STB/TrueType/Internal.hsc new file mode 100644 index 00000000..e2f08a0b --- /dev/null +++ b/stb-truetype/src/Graphics/STB/TrueType/Internal.hsc @@ -0,0 +1,31 @@ +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE QuasiQuotes #-} +{-# LANGUAGE OverloadedStrings #-} +module Graphics.STB.TrueType.Internal where + +import qualified Data.Map as Map +import Linear.V4 (V4) +import Linear.V2 (V2) +import Foreign.C.Types (CShort,CFloat) + +import qualified Language.C.Inline as C +import qualified Language.C.Inline.Context as C +import qualified Language.C.Inline.HaskellIdentifier as C +import qualified Language.C.Types as C + +C.include "" +C.include "" + +data PackedChar = PackedChar + { _packedChar_boundingBox :: V4 CShort + , _packedChar_off1 :: V2 CFloat + , _packedChar_xadvance :: CFloat + , _packedChar_off2 :: V2 CFloat + } + +stbTrueTypeCtx :: C.Context +stbTrueTypeCtx = mempty + { C.ctxTypesTable = Map.fromList + [ (C.TypeName "stbtt_packedchar", [t|PackedChar|]) + ] + } diff --git a/stb-truetype/stb-truetype.cabal b/stb-truetype/stb-truetype.cabal new file mode 100644 index 00000000..35f745d1 --- /dev/null +++ b/stb-truetype/stb-truetype.cabal @@ -0,0 +1,53 @@ +cabal-version: 2.4 +name: stb-truetype +version: 0 +synopsis: Wrappr for the stb-truetype library +description: Wrappr for the stb-truetype library +license: BSD-2-Clause OR Apache-2.0 +license-file: LICENSE.md +author: Edward Kmett and Sean Chalmers +maintainer: Edward Kmett +copyright: Copyright (c) 2019 Edward Kmett, Sean Chalmers +stability: experimental +category: Graphics +build-type: Simple +extra-doc-files: + README.md, + CHANGELOG.md + +source-repository head + type: git + location: https://github.com/ekmett/codex + subdir: stb-truetype + +library + hs-source-dirs: src + default-language: Haskell2010 + build-tool-depends: hsc2hs:hsc2hs + pkgconfig-depends: + stb_truetype >= 1.22, + stb_rect_pack >= 1.00 + exposed-modules: + Graphics.STB.TrueType.Internal + Graphics.STB.TrueType + ghc-options: -optc -Wno-pointer-sign + build-depends: + base >=4.13 && <5, + -- bytestring, + containers >= 0.6, + -- ghc-prim, + -- hashable, + inline-c, + -- primitive, + -- primitive-extras, + -- template-haskell, + -- transformers, + linear + +test-suite stb-truetype-test + default-language: Haskell2010 + type: exitcode-stdio-1.0 + hs-source-dirs: tests + main-is: Main.hs + build-depends: + base >=4.13 && <5 diff --git a/stb-truetype/tests/Main.hs b/stb-truetype/tests/Main.hs new file mode 100644 index 00000000..65ae4a05 --- /dev/null +++ b/stb-truetype/tests/Main.hs @@ -0,0 +1,4 @@ +module Main where + +main :: IO () +main = putStrLn "Hello, Haskell!"