├── .gitignore ├── .travis.yml ├── LICENSE ├── Makefile ├── Props ├── Char.idr ├── Nat.idr ├── String.idr └── Util.idr ├── README.md ├── Refined.idr ├── Test └── Spec.idr ├── idris-refined-test.ipkg └── idris-refined.ipkg /.gitignore: -------------------------------------------------------------------------------- 1 | *.ibc 2 | *.o 3 | *~ 4 | *.bak 5 | .DS_Store 6 | *.swp 7 | .idea/ 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | os: osx 2 | install: 3 | - brew install idris 4 | script: 5 | - make test 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .DEFAULT_GOAL := build 2 | 3 | all: install 4 | 5 | install: build 6 | idris --install idris-refined.ipkg 7 | 8 | build: 9 | idris --build idris-refined.ipkg 10 | 11 | test: build 12 | idris --testpkg idris-refined-test.ipkg 13 | 14 | clean: 15 | idris --clean idris-refined.ipkg 16 | -------------------------------------------------------------------------------- /Props/Char.idr: -------------------------------------------------------------------------------- 1 | module Props.Char 2 | 3 | import Data.List 4 | import public Props.Util 5 | 6 | %access public export 7 | 8 | digits : List Char 9 | digits = ['0'..'9'] 10 | 11 | lowerCase : List Char 12 | lowerCase = ['a'..'z'] 13 | 14 | upperCase : List Char 15 | upperCase = ['A'..'Z'] 16 | 17 | letters : List Char 18 | letters = lowerCase ++ upperCase 19 | 20 | whiteSpace : List Char 21 | whiteSpace = ['\n','\t',' '] 22 | 23 | Digit : Char -> Type 24 | Digit c = Elem c digits 25 | 26 | LowerCase : Char -> Type 27 | LowerCase c = Elem c lowerCase 28 | 29 | UpperCase : Char -> Type 30 | UpperCase c = Elem c upperCase 31 | 32 | Whitespace : Char -> Type 33 | Whitespace c = Elem c whiteSpace 34 | 35 | Letter : (c:Char) -> Type 36 | Letter = EitherK LowerCase UpperCase 37 | 38 | AlphaNumeric : Char -> Type 39 | AlphaNumeric = EitherK Letter Digit 40 | -------------------------------------------------------------------------------- /Props/Nat.idr: -------------------------------------------------------------------------------- 1 | module Props.Nat 2 | 3 | import Props.Util 4 | 5 | %access public export 6 | 7 | Greater : Nat -> Nat -> Type 8 | --Greater n m = GT m n 9 | Greater = flip GT 10 | 11 | GreaterEqual : Nat -> Nat -> Type 12 | GreaterEqual = flip GTE 13 | 14 | Less : Nat -> Nat -> Type 15 | Less = flip LT 16 | 17 | LessEqual : Nat -> Nat -> Type 18 | LessEqual = flip LTE 19 | -------------------------------------------------------------------------------- /Props/String.idr: -------------------------------------------------------------------------------- 1 | module Props.String 2 | 3 | import Props.Util 4 | 5 | %access public export 6 | 7 | NonEmpty : String -> Type 8 | NonEmpty s = Denied (decEq "" s) 9 | -------------------------------------------------------------------------------- /Props/Util.idr: -------------------------------------------------------------------------------- 1 | module Props.Util 2 | 3 | import public Data.List 4 | 5 | %access public export 6 | 7 | private 8 | mkNo : {xs' : List a} -> 9 | ((x' = y') -> Void) -> 10 | (Elem x' xs' -> Void) -> 11 | Elem x' (y' :: xs') -> Void 12 | mkNo f g Here = f Refl 13 | mkNo f g (There x) = g x 14 | 15 | -- Use this until https://github.com/idris-lang/Idris-dev/issues/4161 16 | fastIsElem : DecEq a => (x : a) -> (xs : List a) -> Dec (Elem x xs) 17 | fastIsElem x [] = No absurd 18 | fastIsElem x (y :: xs) with (decEq x y) 19 | fastIsElem x (x :: xs) | (Yes Refl) = Yes Here 20 | fastIsElem x (y :: xs) | (No contra) with (fastIsElem x xs) 21 | fastIsElem x (y :: xs) | (No contra) | (Yes prf) = Yes (There prf) 22 | fastIsElem x (y :: xs) | (No contra) | (No f) = No (mkNo contra f) 23 | 24 | using (a: Type, P : a -> Type, Q: a -> Type) 25 | 26 | data EitherK : { a : Type } -> ( P : a -> Type ) -> ( Q : a -> Type) -> a -> Type where 27 | LeftK : ( prf : P c ) -> EitherK P Q c 28 | RightK : ( prf : Q c ) -> EitherK P Q c 29 | 30 | -- Add these to not depend on contrib 31 | data Given : Dec x -> Type where 32 | Always : Given (Yes prf) 33 | 34 | data Denied : Dec x -> Type where 35 | Never : Denied (No contra) 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Idris-refined 2 | ==================== 3 | Port of [scala refined](https://github.com/fthomas/refined) library to idris using dependent pairs. 4 | 5 | # Installation 6 | ```bash 7 | git clone git@github.com:janschultecom/idris-refined.git 8 | make install 9 | idris -p Refined 10 | Idris> :module Refined 11 | ``` 12 | 13 | # Example 14 | 15 | Types can be refined using ```Refined```: 16 | 17 | ```idris 18 | -- Only digits 19 | zeroIsDigit : Refined Char Digit 20 | zeroIsDigit = '0' 21 | -- zeroIsDigit = 'a' will result in compile-time error 22 | 23 | -- Only letters 24 | upperAIsLetter : Refined Char Letter 25 | upperAIsLetter = 'A' 26 | -- upperAIsLetter = '0' will result in compile-time error 27 | 28 | -- Letters or Digits 29 | lowerAIsAlpha : Refined Char AlphaNumeric 30 | lowerAIsAlpha = 'a' 31 | 32 | upperAIsAlpha : Refined Char AlphaNumeric 33 | upperAIsAlpha = 'A' 34 | 35 | zeroIsAlpha : Refined Char AlphaNumeric 36 | zeroIsAlpha = '0' 37 | -- z = '$' will result in compile-time error 38 | 39 | ``` 40 | 41 | Refined types can be passed to functions expecting ordinary types. 42 | ```idris 43 | test : Char -> IO () 44 | test c = print $ show c 45 | 46 | main : IO () 47 | main = test Refined.x 48 | ``` 49 | See the Test case for more examples. 50 | 51 | # Predicates 52 | 53 | ## Nat 54 | 55 | * Greater n: checks if a ```Nat``` is strictly greater than n 56 | * GreaterEqual n: checks if a ```Nat``` is greater or equal to n 57 | * Less n: checks if a ```Nat``` is strictly less than n 58 | * LessEqual n: checks if a ```Nat``` is less or equal to n 59 | 60 | ## Char 61 | 62 | * Digit: checks if a ```Char``` is a digit 63 | * Letter: checks if a ```Char``` is a letter 64 | * AlphaNumeric: checks if a ```Char``` is a letter or digit 65 | * LowerCase: checks if a ```Char``` is a lower case character 66 | * UpperCase: checks if a ```Char``` is an upper case character 67 | * Whitespace: checks if a ```Char``` is white space 68 | 69 | ## String 70 | 71 | * NonEmpty : checks if a ```String``` has at least one character 72 | -------------------------------------------------------------------------------- /Refined.idr: -------------------------------------------------------------------------------- 1 | module Refined 2 | 3 | import Data.List 4 | 5 | %access public export 6 | 7 | Refined : (a : Type) -> (P : a -> Type) -> Type 8 | Refined = DPair 9 | 10 | implicit 11 | toRefined : { a : Type } -> { P : a -> Type } -> (x:a) -> { auto property : P x } -> Refined a P 12 | toRefined value {property} = (value ** property) 13 | 14 | -- Havent yet figured out how to make Idris use an implicit generic fromRefined 15 | implicit 16 | fromCharRefined : { P : Char -> Type } -> Refined Char P -> Char 17 | fromCharRefined = fst 18 | 19 | implicit 20 | fromStringRefined : { P : String -> Type } -> Refined String P -> String 21 | fromStringRefined = fst 22 | 23 | implicit 24 | fromNatRefined : { P : Nat -> Type } -> Refined Nat P -> Nat 25 | fromNatRefined = fst 26 | 27 | -------------------------------------------------------------------------------- /Test/Spec.idr: -------------------------------------------------------------------------------- 1 | module Test.Spec 2 | 3 | import Refined 4 | 5 | import Props.Util 6 | import Props.Char 7 | import Props.String 8 | import Props.Nat 9 | 10 | %access public export 11 | 12 | zeroIsDigit : Refined Char Digit 13 | zeroIsDigit = '0' 14 | 15 | upperAIsLetter : Refined Char Letter 16 | upperAIsLetter = 'A' 17 | 18 | lowerAIsAlpha : Refined Char AlphaNumeric 19 | lowerAIsAlpha = 'a' 20 | 21 | upperAIsAlpha : Refined Char AlphaNumeric 22 | upperAIsAlpha = 'A' 23 | 24 | zeroIsAlpha : Refined Char AlphaNumeric 25 | zeroIsAlpha = '0' 26 | 27 | -- TODO: Proof these using Void 28 | --dollarIsNotAlpha : Refined Char AlphaNumeric -> Void 29 | --dollarIsNotAlpha = '$' 30 | 31 | blankIsWhitespace : Refined Char Whitespace 32 | blankIsWhitespace = ' ' 33 | 34 | textIsNonEmpty : Refined String NonEmpty 35 | textIsNonEmpty = "text" 36 | 37 | -- FIXME: Somehow implicit conversion doesnt work here 38 | oneIsGreaterThanZero : Refined Nat (Greater Z) 39 | oneIsGreaterThanZero = toRefined $ S Z 40 | 41 | --zeroIsGreaterThanZero : Refined Nat (Greater Z) 42 | --zeroIsGreaterThanZero = toRefined $ Z 43 | 44 | oneIsGreaterEqualOne : Refined Nat $ GreaterEqual $ S Z 45 | oneIsGreaterEqualOne = toRefined $ S Z 46 | 47 | zeroIsLessThanOne : Refined Nat (Less (S Z)) 48 | zeroIsLessThanOne = toRefined Z 49 | 50 | --zeroIsLessThanZero : Refined Nat (Less Z) 51 | --zeroIsLessThanZero = toRefined Z 52 | 53 | testMe : IO() 54 | testMe = putStrLn("Passed") 55 | -------------------------------------------------------------------------------- /idris-refined-test.ipkg: -------------------------------------------------------------------------------- 1 | package Refined 2 | 3 | opts = "" 4 | 5 | modules = Props.Util 6 | , Props.Char 7 | , Props.String 8 | , Refined 9 | , Test.Spec 10 | 11 | tests = Test.Spec.testMe 12 | -------------------------------------------------------------------------------- /idris-refined.ipkg: -------------------------------------------------------------------------------- 1 | package Refined 2 | 3 | opts = "" 4 | 5 | modules = Props.Util 6 | , Props.Char 7 | , Refined 8 | 9 | --------------------------------------------------------------------------------