diff options
| author | Matthew Pickering <matthewtpickering@gmail.com> | 2015-02-18 21:00:46 +0000 |
|---|---|---|
| committer | Matthew Pickering <matthewtpickering@gmail.com> | 2015-02-18 21:09:07 +0000 |
| commit | 48f442f4770c774534b3696e6dd696da45395874 (patch) | |
| tree | 78e7dfa1ae93991e24fa395fca13c8f47e70e133 /src/Text | |
| parent | f046531a6b260b9c1c6b5222d5ef7aecbd91238c (diff) | |
| download | pandoc-48f442f4770c774534b3696e6dd696da45395874.tar.gz | |
Update haddocks and copyright notices
Diffstat (limited to 'src/Text')
| -rw-r--r-- | src/Text/Pandoc/Error.hs | 36 |
1 files changed, 34 insertions, 2 deletions
diff --git a/src/Text/Pandoc/Error.hs b/src/Text/Pandoc/Error.hs index d4172f7ca..70c333bbf 100644 --- a/src/Text/Pandoc/Error.hs +++ b/src/Text/Pandoc/Error.hs @@ -1,3 +1,33 @@ +{- +Copyright (C) 2006-2015 John MacFarlane <jgm@berkeley.edu> + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +-} +{- | + Module : Text.Pandoc.Error + Copyright : Copyright (C) 2006-2015 John MacFarlane + License : GNU GPL, version 2 or above + + Maintainer : John MacFarlane <jgm@berkeley.edu> + Stability : alpha + Portability : portable + +This module provides a standard way to deal with possible errors encounted +during parsing. + +-} module Text.Pandoc.Error (PandocError(..), handleError,hush, mapLeft) where import Text.Parsec.Error @@ -6,7 +36,9 @@ import Text.Pandoc.Compat.Except type Input = String -data PandocError = ParseFailure String +data PandocError = -- | Generic parse failure + ParseFailure String + -- | Error thrown by a Parsec parser | ParsecError Input ParseError deriving (Show) @@ -14,7 +46,6 @@ data PandocError = ParseFailure String instance Error PandocError where strMsg = ParseFailure - mapLeft :: (a -> b) -> Either a c -> Either b c mapLeft f (Left x) = Left (f x) mapLeft _ (Right x) = Right x @@ -23,6 +54,7 @@ hush :: Either a b -> Maybe b hush (Left _) = Nothing hush (Right x) = Just x +-- | An unsafe method to handle `PandocError`s. handleError :: Either PandocError a -> a handleError (Right r) = r handleError (Left err) = |