hoppy-runtime (empty) → 0.1.0

raw patch · 4 files changed

+496/−0 lines, 4 filesdep +basesetup-changed

Dependencies added: base

Files

• LICENSE +202/−0
• Setup.hs +18/−0
• hoppy-runtime.cabal +31/−0
• src/Foreign/Hoppy/Runtime.hs +245/−0

@@ -0,0 +1,202 @@++                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/++   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.

@@ -0,0 +1,18 @@+-- This file is part of Hoppy.+--+-- Copyright 2016 Bryan Gardiner <bog@khumba.net>+--+-- 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.++import Distribution.Simple+main = defaultMain

@@ -0,0 +1,31 @@+name: hoppy-runtime+version: 0.1.0+synopsis: C++ FFI generator - Runtime support+homepage: http://khumba.net/projects/hoppy+license: Apache-2.0+license-file: LICENSE+author: Bryan Gardiner <bog@khumba.net>+maintainer: Bryan Gardiner <bog@khumba.net>+copyright: Copyright 2015-2016 Bryan Gardiner+category: Foreign+build-type: Simple+cabal-version: >=1.10+description:+    Hoppy generates Haskell bindings to C++ libraries.+    .+    This package provides common runtime functionality used by generated+    bindings.++library+  exposed-modules:+      Foreign.Hoppy.Runtime+  default-extensions:+      FlexibleInstances+    , FunctionalDependencies+    , GeneralizedNewtypeDeriving+    , MultiParamTypeClasses+  build-depends:+      base >=4.7 && <4.9+  hs-source-dirs: src+  ghc-options: -W -fwarn-incomplete-patterns -fwarn-unused-do-bind+  default-language: Haskell2010

@@ -0,0 +1,245 @@+-- This file is part of Hoppy.+--+-- Copyright 2015-2016 Bryan Gardiner <bog@khumba.net>+--+-- 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.++-- | Runtime support for generated Haskell bindings.+module Foreign.Hoppy.Runtime (+  -- * Primitive types+  CBool (..),+  -- CBool is a newtype for CUChar, so GHC 7.10 (at least) requires reexporting+  -- the CUChar data constructor for CBool to be marshalled in foreign imports.+  CUChar (CUChar),+  coerceIntegral,+  -- * Objects+  CppPtr (..),+  Deletable (..),+  Assignable (..),+  Encodable (..),+  encodeAs,+  Decodable (..),+  decodeAndDelete,+  withCppObj,+  withScopedPtr,+  -- * Containers+  HasContents (..),+  FromContents (..),+  -- * Internal+  CCallback (..),+  freeHaskellFunPtrFunPtr,+  ) where++import Control.Exception (bracket)+import Data.Typeable (Typeable, typeOf)+import Foreign (FunPtr, Ptr, Storable, freeHaskellFunPtr, peek, poke)+import Foreign.C (+  CChar,+  CDouble,+  CFloat,+  CInt,+  CLLong,+  CLong,+  CShort,+  CSize,+  CUChar (CUChar),+  CUInt,+  CULLong,+  CULong,+  CUShort,+  )+import System.IO.Unsafe (unsafePerformIO)++foreign import ccall "wrapper" newFreeHaskellFunPtrFunPtr+  :: (FunPtr (IO ()) -> IO ())+  -> IO (FunPtr (FunPtr (IO ()) -> IO ()))++-- | A numeric type representing a C++ boolean.+newtype CBool = CBool CUChar+  deriving (Eq, Integral, Num, Ord, Real, Show, Storable)++instance Bounded CBool where+  minBound = 0+  maxBound = 1++instance Enum CBool where+  fromEnum (CBool n) = fromIntegral n++  toEnum n =+    if n == 0 || n == 1+    then CBool $ fromIntegral n+    else error $ concat ["CBool.toEnum: Invalid value ", show n, "."]++-- | Converts between integral types by going from @a@ to @b@, and also+-- round-tripping the @b@ value back to an @a@ value.  If the two @a@ values+-- don't match, then an error is signalled.+coerceIntegral :: (Integral a, Integral b, Typeable a, Typeable b, Show a) => a -> b+coerceIntegral a =+  let b = fromIntegral a+      a' = fromIntegral b+  in if a' == a+     then b+     else error $ "Conversion from " ++ show (typeOf a) ++ " to " +++          show (typeOf b) ++ " is not idempotent for value " ++ show a ++ "."++-- | An instance of this class represents a pointer to a C++ object.  All C+++-- classes bound by Hoppy have instances of @CppPtr@.+class CppPtr this where+  -- | Polymorphic null pointer.+  nullptr :: this++  -- | Converts to a regular pointer.+  toPtr :: this -> Ptr this++-- | C++ values that can be deleted.  All C++ classes bound by Hoppy have+-- instances of @Deletable@.+class Deletable this where+  -- | Deletes the object with the C++ @delete@ operator.+  delete :: this -> IO ()++-- | A typeclass for references to C++ values that can be assigned to.  This+-- includes raw pointers ('Ptr'), as well as pointers to object types that have+-- an assignment operator (see+-- 'Foreign.Hoppy.Generator.Spec.ClassFeature.Assignable').+class Assignable cppType value where+  -- | @assign x v@ assigns the value @v@ at the location pointed to by @x@.+  assign :: cppType -> value -> IO ()++instance Assignable (Ptr CBool) Bool where+  assign p b = poke p $ if b then 1 else 0++instance Storable a => Assignable (Ptr a) a where+  assign = poke++-- | For a C++ class that also has a native Haskell representation (e.g. value+-- types such as @std::string@), this typeclass allows converting a Haskell+-- value into a C++ object on the heap.  Encoding to both the non-const and+-- const objects is supported.+--+-- Because the functional dependency points in the direction it does, calls of+-- the form @'encode' value@ are ambiguously typed, so 'encodeAs' is provided to+-- resolve the ambiguity.+--+-- Prefer 'withCppObj' over calling 'encode' directly, to manage the lifetime of+-- the object.+--+-- See also 'Decodable'.+class Encodable cppPtrType hsType | cppPtrType -> hsType where+  encode :: hsType -> IO cppPtrType++-- | Takes a dummy argument to help with type resolution of 'encode', a la+-- 'asTypeOf'.  For example, for a C++ pointer type @StdString@ that gets+-- converted to a regular haskell 'String', the expected usage is:+--+-- > str :: String+-- > encodeAs (undefined :: StdString) str+encodeAs :: Encodable cppPtrType hsType => cppPtrType -> hsType -> IO cppPtrType+encodeAs to = fmap (`asTypeOf` to) . encode++-- | A typeclass for converting references to C++ values into Haskell values.+-- What this means depends on the type of C++ value.  Pointers to numeric types+-- and to other pointers (i.e. @'Ptr' ('Ptr' ...)@) are decodable by peeking at+-- the value.+--+-- For a C++ class that also has a native Haskell representation (e.g. value+-- types such as @std::string@), this typeclass allows converting a C++ heap+-- object into a Haskell value based on the defined conversion.  Decoding from+-- both the non-const and const objects is supported.+--+-- See also 'Encodable'.+class Decodable cppPtrType hsType | cppPtrType -> hsType where+  decode :: cppPtrType -> IO hsType++instance Decodable (Ptr CBool) Bool where decode = fmap (/= 0) . peek+instance Decodable (Ptr CChar) CChar where decode = peek+instance Decodable (Ptr CUChar) CUChar where decode = peek+instance Decodable (Ptr CShort) CShort where decode = peek+instance Decodable (Ptr CUShort) CUShort where decode = peek+instance Decodable (Ptr CInt) CInt where decode = peek+instance Decodable (Ptr CUInt) CUInt where decode = peek+instance Decodable (Ptr CLong) CLong where decode = peek+instance Decodable (Ptr CULong) CULong where decode = peek+instance Decodable (Ptr CLLong) CLLong where decode = peek+instance Decodable (Ptr CULLong) CULLong where decode = peek+instance Decodable (Ptr CFloat) CFloat where decode = peek+instance Decodable (Ptr CDouble) CDouble where decode = peek+instance Decodable (Ptr CSize) CSize where decode = peek++instance Decodable (Ptr (Ptr a)) (Ptr a) where decode = peek++-- | Decodes a C++ object to a Haskell value with 'decode', releases the+-- original object with 'delete', then returns the Haskell value.+decodeAndDelete :: (Deletable cppPtrType, Decodable cppPtrType hsType)+                => cppPtrType -> IO hsType+decodeAndDelete ptr = do+  result <- decode ptr+  delete ptr+  return result++-- | Temporarily encodes the Haskell value into a C++ object and passes it to+-- the given function.  When the function finishes, the C++ object is deleted.+withCppObj :: (Deletable cppPtrType, Encodable cppPtrType hsType)+           => hsType -> (cppPtrType -> IO a) -> IO a+withCppObj x = bracket (encode x) delete++-- | @withScopedPtr m f@ runs @m@ to get a pointer, which is given to @f@ to+-- execute.  When @f@ finishes, the pointer is deleted.+withScopedPtr :: Deletable cppPtrType => IO cppPtrType -> (cppPtrType -> IO a) -> IO a+withScopedPtr p = bracket p delete++-- | Containers whose contents can be convered to a list.+--+-- For a container @Cont@ holding values with C-side type @Foo@ and Haskell-side+-- type @Bar@, if the container uses 'Foreign.Hoppy.Generator.Std.ConvertPtr'+-- then the following instances are recommended:+--+-- > instance HasContents ContConst FooConst+-- > instance HasContents Cont Foo+--+-- If the container uses 'Foreign.Hoppy.Generator.Std.ConvertValue' then the+-- following instances are recommended:+--+-- > instance HasContents ContConst Bar+-- > instance HasContents Cont Bar+class HasContents c e | c -> e where+  -- | Extracts the contents of a container, returning the elements in a list.+  toContents :: c -> IO [e]++-- | Containers that can be created from a list.+--+-- For a container @Cont@ holding values with C-side type @Foo@ and Haskell-side+-- type @Bar@, if the container uses 'Foreign.Hoppy.Generator.Std.ConvertPtr'+-- then the following instance is recommended:+--+-- > instance FromContents Cont Foo+--+-- If the container uses 'Foreign.Hoppy.Generator.Std.ConvertValue' then the+-- following instance is recommended:+--+-- > instance HasContents Cont Bar+--+-- No instances for @ContConst@ are needed because it is easy enough to cast the+-- resulting collection to a const pointer.+class FromContents c e | c -> e where+  -- | Creates and returns a new container holding the given elements.+  fromContents :: [e] -> IO c++-- | Internal type that represents a pointer to a C++ callback object (callback+-- impl object, specifically).+newtype CCallback fnHsCType = CCallback (Ptr ())++-- | A global constant function pointer that points to 'freeHaskellFunPtr'.+freeHaskellFunPtrFunPtr :: FunPtr (FunPtr (IO ()) -> IO ())+{-# NOINLINE freeHaskellFunPtrFunPtr #-}+freeHaskellFunPtrFunPtr =+  unsafePerformIO $ newFreeHaskellFunPtrFunPtr freeHaskellFunPtr