summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorBenjamin Barenblat <bbarenblat@galois.com>2014-01-13 15:39:44 -0800
committerBenjamin Barenblat <bbarenblat@galois.com>2014-01-13 15:39:44 -0800
commit5166756cdcf8a3979176006cde2a4f0db5b09ebf (patch)
tree39a916f9bd17b3f370187ffd61703e6d6990582e
Initial commit
-rw-r--r--.gitignore10
-rw-r--r--LICENSE202
-rw-r--r--Setup.hs17
-rw-r--r--hierarchical-exceptions.cabal31
-rw-r--r--src/Control/Exception/Hierarchical.hs216
5 files changed, 476 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d5e783d
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,10 @@
+# .gitignore for hierarchical-exceptions -*- conf -*-
+# This file is in the public domain.
+
+# Editor backup files
+*~
+\#*
+.\#*
+
+# Cabal
+dist*/
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -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.
diff --git a/Setup.hs b/Setup.hs
new file mode 100644
index 0000000..9a8404a
--- /dev/null
+++ b/Setup.hs
@@ -0,0 +1,17 @@
+{- Setup.hs -- Cabal distribution script for hierarchical-exceptions
+Copyright (C) 2014 Galois, Inc.
+
+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
diff --git a/hierarchical-exceptions.cabal b/hierarchical-exceptions.cabal
new file mode 100644
index 0000000..a33ca69
--- /dev/null
+++ b/hierarchical-exceptions.cabal
@@ -0,0 +1,31 @@
+cabal-version: >=1.10
+name: hierarchical-exceptions
+version: 1.0.0
+synopsis: Template Haskell functions to easily create exception
+ hierarchies
+description:
+ Haskell supports exception hierarchies, but they require quite a bit of
+ boilerplate to declare. This package leverages Template Haskell to automate
+ declaration of large exception hierarchies.
+ .
+ This package requires GHC 7.6, as a bug in GHC 7.4 prevents expansion of
+ Template Haskell splices using 'deriving Typeable'.
+license: Apache-2.0
+license-file: LICENSE
+author: Benjamin Barenblat
+maintainer: bbarenblat@galois.com
+copyright: © 2014 Galois, Inc.
+stability: provisional
+category: Language
+build-type: Simple
+tested-with: GHC==7.6.3
+
+library
+ hs-source-dirs: src
+ default-language: Haskell2010
+ default-extensions: TemplateHaskell
+ other-extensions: DeriveDataTypeable, ExistentialQuantification
+ exposed-modules: Control.Exception.Hierarchical
+ build-depends: base >=4.6 && <5
+ , template-haskell >= 2.2.0.0 && <3
+ ghc-options: -Wall
diff --git a/src/Control/Exception/Hierarchical.hs b/src/Control/Exception/Hierarchical.hs
new file mode 100644
index 0000000..f906270
--- /dev/null
+++ b/src/Control/Exception/Hierarchical.hs
@@ -0,0 +1,216 @@
+{- Control.Exception.Hierarchical -- Template Haskell for defining exceptions
+Copyright (C) 2014 Galois, Inc.
+
+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. -}
+
+{-| "Control.Exception" leverages "Data.Typeable" to fake subtyping and thereby
+give Haskell support for hierarchies of exceptions. However, defining
+exception hierarchies requires quite a bit of boilerplate. For instance, to
+define
+
+ * a top-level exception, 'TracerException',
+
+ * a sub-exception, 'TimingFailure', and
+
+ * a sub-exception, 'WriteFailure',
+
+requires several paragraphs of code:
+
+> import Control.Exception
+> import Data.Typeable (Typeable, cast)
+>
+> data TracerException = forall e. Exception e => TracerException e
+> deriving Typeable
+>
+> instance Show TracerException where
+> show (TracerException e) = show e
+>
+> instance Exception TracerException
+>
+> data TimingFailure = TimingFailure
+> deriving (Show, Typeable)
+>
+> instance Exception TimingFailure where
+> toException = toException . TracerException
+> fromException x = do
+> TracerException a <- fromException x
+> cast a
+>
+> data WriteFailure = WriteFailure
+> deriving (Show, Typeable)
+>
+> instance Exception WriteFailure where
+> toException = toException . TracerException
+> fromException x = do
+> TracerException a <- fromException x
+> cast a
+
+Instead of writing this, one could simply write
+
+> import Control.Exception (SomeException(SomeException))
+> import Control.Exception.Hierarchical
+>
+> mkAbstractException 'SomeException "TracerException"
+> mkException 'TracerException "TimingFailure"
+> mkException 'TracerException "WriteFailure"
+
+and allow Template Haskell to fill in the rest.
+
+This libray deals with two types of exceptions: /abstract/ and /concrete/
+exceptions. Both types can be caught with 'Control.Exception.catch' and other
+associated functions; however, only you may only extend abstract exceptions,
+and you may only throw concrete ones. This is a fundamental limitation of the
+Haskell exception hierarchy system as it currently exists. -}
+
+module Control.Exception.Hierarchical
+ ( mkAbstractException
+ , mkException
+ ) where
+
+import Control.Exception (Exception(toException, fromException),
+ SomeException(SomeException))
+import Control.Monad ((>=>))
+import Data.Typeable (Typeable, cast)
+import Language.Haskell.TH
+
+
+--------------------------- Hierarchies and casting ----------------------------
+
+{-| Creates declarations to make a data type a sub-exception of another
+exception. This is best illustrated by some examples:
+
+> exceptionDeclaration 'SomeException 'MyAbstractException
+> ======>
+> instance Exception MyAbstractException
+
+> exceptionDeclaration 'MyAbstractException 'MyConcreteException
+> ======>
+> instance Exception MyConcreteException where
+> toException = toException . MyConcreteException
+> fromException = fromException >=> \(MyAbstractException x) -> cast x
+
+Note that exceptions directly under 'SomeException' are special-cased; the
+default implementation for the 'Exception' type class is sufficient in this
+case. -}
+exceptionDeclaration :: Name -- ^ the name of the super-exception
+ -> Name -- ^ the name of the sub-exception
+ -> Dec
+exceptionDeclaration super name =
+ InstanceD []
+ (AppT (ConT ''Exception) (ConT name))
+ (if super == 'SomeException
+ then
+ {- 'name' is directly under 'SomeException', so use the default
+ implementation for the conversion functions. -}
+ []
+ else
+ {- 'name' is directly under some other exception, so explicitly
+ define the conversion functions to set up the hierarchy
+ correctly. -}
+ exceptionHierarchyFunctions super)
+
+{-| Creates declarations to implement the 'Exception' instance for a
+sub-exception. -}
+exceptionHierarchyFunctions :: Name -- ^ the name of the super-exception
+ -> [Dec]
+exceptionHierarchyFunctions super =
+ let x = mkName "x" in
+ [ -- toException
+ ValD (VarP 'toException)
+ (NormalB (InfixE (Just (VarE 'toException))
+ (VarE '(.))
+ (Just (ConE super))))
+ []
+ -- fromException
+ , ValD (VarP 'fromException)
+ (NormalB (InfixE (Just (VarE 'fromException))
+ (VarE '(>=>))
+ (Just (LamE [ConP super [VarP x]]
+ (AppE (VarE 'cast) (VarE x))))))
+ [] ]
+
+
+
+----------------------------- Abstract exceptions ------------------------------
+
+{-| Creates an /abstract/ sub-exception of an existing exception. As discussed
+in the introduction, such an exception cannot be thrown; it can only be
+extended. -}
+mkAbstractException :: Name
+ -- ^ the name of the super-exception’s data constructor
+ -> String -- ^ the name of the exception to create
+ -> Q [Dec]
+mkAbstractException super name = do
+ let name' = mkName name
+ return [ abstractDataDeclaration name'
+ , abstractShowDeclaration name'
+ , exceptionDeclaration super name' ]
+
+{-| Defines a new data type suitable for use as an abstract exception. For
+example,
+
+> abstractDataDeclaration (mkName "Name")
+> ======>
+> data Name = forall e. Exception e => Name e
+> deriving Typeable -}
+abstractDataDeclaration :: Name -> Dec
+abstractDataDeclaration name =
+ let e = mkName "e" in
+ DataD [] name []
+ [ForallC [PlainTV e]
+ [ClassP ''Exception [VarT e]]
+ (NormalC name [(NotStrict, VarT e)])]
+ [''Typeable]
+
+{-| Creates an instance declaration for an abstract exception type. For
+example,
+
+> abstractShowDeclaration ''Name
+> ======>
+> instance Show Name where
+> show (Name e) = show e -}
+abstractShowDeclaration :: Name -> Dec
+abstractShowDeclaration name =
+ let e = mkName "e" in
+ InstanceD []
+ (AppT (ConT ''Show) (ConT name))
+ [FunD 'show [Clause [ConP name [VarP e]]
+ (NormalB (AppE (VarE 'show) (VarE e)))
+ []]]
+
+
+----------------------------- Concrete exceptions -----------------------------
+
+{-| Creates a /concrete/ sub-exception of an existing exception. As discussed
+in the introduction, such an exception cannot be extended; it can only be
+thrown. -}
+mkException :: Name
+ -- ^ the name of the super-exception’s data constructor
+ -> String -- ^ the name of the exception to create
+ -> Q [Dec]
+mkException super name = do
+ let name' = mkName name
+ return [ dataDeclaration name'
+ , exceptionDeclaration super name' ]
+
+{-| Defines a new data type suitable for use as a concrete exception. For
+example,
+
+> dataDeclaration (mkName "Name")
+> ======>
+> data Name = Name
+> deriving (Show, Typeable) -}
+dataDeclaration :: Name -> Dec
+dataDeclaration name =
+ DataD [] name []
+ [NormalC name []]
+ [''Show, ''Typeable]