diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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 2016 functils Developers + +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/LICENSE-MIT b/LICENSE-MIT new file mode 100644 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2016 functils Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/benches/Benches.hs b/benches/Benches.hs new file mode 100644 --- /dev/null +++ b/benches/Benches.hs @@ -0,0 +1,2 @@ +main :: IO () +main = putStrLn "Benchmarks not yet implemented" diff --git a/curryrs.cabal b/curryrs.cabal new file mode 100644 --- /dev/null +++ b/curryrs.cabal @@ -0,0 +1,50 @@ +name: curryrs +version: 0.1.0.0 +synopsis: Easy to use FFI Bridge for using Rust in Haskell +description: Please see README.md for more information on how to use this library. +homepage: https://github.com/mgattozzi/curryrs#readme +license: OtherLicense +license-files: LICENSE-MIT, LICENSE-APACHE +author: Michael Gattozzi +maintainer: mgattozzi@gmail.com +copyright: 2016 Michael Gattozzi +category: FFI +build-type: Simple +cabal-version: >=1.10 + +library + hs-source-dirs: src + exposed-modules: Types + , Convert + build-depends: base >= 4.7 && < 5 + , mtl >= 2.2 && < 2.3 + default-language: Haskell2010 + +test-suite curryrs-test + type: exitcode-stdio-1.0 + hs-source-dirs: haskell-tests + other-extensions: ForeignFunctionInterface + main-is: Test.hs + build-depends: base + , curryrs + , tasty >= 0.11 + , tasty-hunit >= 0.9.2 + -- We only have to do this because ghc-pkg doesn't work with relative paths for + -- extra-lib-dirs. + ghc-options: -threaded -rtsopts -with-rtsopts=-N -Ltarget/release -lrtest -lpthread + default-language: Haskell2010 + +benchmark curryrs-bench + type: exitcode-stdio-1.0 + hs-source-dirs: benches + main-is: Benches.hs + build-depends: base + , curryrs + -- We only have to do this because ghc-pkg doesn't work with relative paths for + -- extra-lib-dirs. + ghc-options: -threaded -rtsopts -with-rtsopts=-N -Ltarget/release -lrtest -lpthread + default-language: Haskell2010 + +source-repository head + type: git + location: https://github.com/mgattozzi/curryrs diff --git a/haskell-tests/Test.hs b/haskell-tests/Test.hs new file mode 100644 --- /dev/null +++ b/haskell-tests/Test.hs @@ -0,0 +1,25 @@ +module Main where + +import Types +import Convert +import Test.Tasty +import Test.Tasty.HUnit + +foreign import ccall "double_input" doubleInput :: I32 -> I32 +foreign import ccall "get_true" getTrue :: Boolean +foreign import ccall "get_false" getFalse :: Boolean + +main :: IO () +main = defaultMain tests + +tests :: TestTree +tests = testGroup "Tests" [unitTests] + +unitTests = testGroup "Unit Tests" + [ testCase "Check that double_input works" $ + doubleInput 3 @?= 6, + testCase "Check that getTrue works" $ + fromBoolean getTrue @?= (Right True), + testCase "Check that getFalse works" $ + fromBoolean getFalse @?= (Right False) + ] diff --git a/src/Convert.hs b/src/Convert.hs new file mode 100644 --- /dev/null +++ b/src/Convert.hs @@ -0,0 +1,39 @@ +-- | +-- The Convert module contains various functions used for converting +-- values to or from their FFI form. It also contains Error types in +-- case conversions to not go as planned. +module Convert ( + fromBoolean + , ConversionError + ) where + +import Types (Boolean) + +-- | +-- This method tries to to turn a number returned +-- by FFI into a Bool. It's wrapped in an either +-- in case the underlying number representing the Boolean +-- is not 0 or 1 +-- +-- >>> fromBoolean 1 +-- Right True +-- +-- >>> fromBoolean 0 +-- Right False +-- +-- >>> fromBoolean 3 +-- Left Failed to extract a boolean value in the use of fromBoolean. Number was not 0 or 1 +fromBoolean :: Boolean -> Either ConversionError Bool +fromBoolean x = case x of + 0 -> (Right False) + 1 -> (Right True) + _ -> (Left Boolean) + +-- | +-- Error data type for conversions that have failed going to or from +-- their FFI form +data ConversionError = Boolean + deriving Eq + +instance Show ConversionError where + show Boolean = "Failed to extract a boolean value in the use of fromBoolean. Number was not 0 or 1" diff --git a/src/Types.hs b/src/Types.hs new file mode 100644 --- /dev/null +++ b/src/Types.hs @@ -0,0 +1,79 @@ +-- | +-- Definitions of each FFI type that can be used in Rust. These are +-- standardized accross the Rust and Haskell Curryrs library for easy +-- translation of function headers between the two. +module Types ( + module Foreign.C.Types + , module Foreign.C.String + , Chr + , Str + , U8 + , U16 + , U32 + , U64 + , I8 + , I16 + , I32 + , I64 + , F32 + , F64 + , Boolean + ) where + +import Foreign.C.Types +import Foreign.C.String + +-- We are only defining types that map to Rust types here +-- We don't need the full array of C types in Rust + +-- | +-- Used to represent Char in both languages +type Chr = CChar + +-- | +-- Used to represent Strings in both languages +type Str = CString + +-- | +-- Used to represent 8 bit unsigned numbers in both languages +type U8 = CUChar + +-- | +-- Used to represent 16 bit unsigned numbers in both languages +type U16 = CUShort + +-- | +-- Used to represent 32 bit unsigned numbers in both languages +type U32 = CUInt + +-- | +-- Used to represent 64 bit unsigned numbers in both languages +type U64 = CULong + +-- | +-- Used to represent 8 bit signed numbers in both languages +type I8 = CSChar + +-- | +-- Used to represent 16 bit signed numbers in both languages +type I16 = CShort + +-- | +-- Used to represent 32 bit signed numbers in both languages +type I32 = CInt + +-- | +-- Used to represent 64 bit signed numbers in both languages +type I64 = CLong + +-- | +-- Used to represent 32 bit floating point numbers in both languages +type F32 = CFloat + +-- | +-- Used to represent 64 bit floating point numbers in both languages +type F64 = CDouble + +-- | +-- Used to represent Booleans in both languages +type Boolean = CUChar