chore: init

Author: drlkf

.gitignore

@@ -0,0 +1,3 @@
+.stack-work/
+*~
+dist-newstyle/

CHANGELOG.md

@@ -0,0 +1,2 @@
+* megaparsec-utils
+Utilities to use on top of the [[https://hackage.haskell.org/package/megaparsec][Megaparsec]] library.

README.org

@@ -0,0 +1,52 @@
+cabal-version: 1.12
+
+-- This file has been generated from package.yaml by hpack version 0.36.0.
+--
+-- see: https://github.com/sol/hpack
+
+name:           megaparsec-utils
+version:        0.1.0.0
+description:    Utilities for the Megaparsec library.
+author:         drlkf
+maintainer:     [email protected]
+copyright:      2024 drlkf
+license:        GPL-3
+build-type:     Simple
+extra-source-files:
+    README.org
+    CHANGELOG.md
+
+library
+  exposed-modules:
+      Lib
+      Text.Megaparsec.Utils
+  other-modules:
+      Paths_megaparsec_utils
+  hs-source-dirs:
+      src
+  ghc-options: -Wall -Werror -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints
+  build-depends:
+      base >=4.7 && <5
+    , megaparsec
+    , parser-combinators
+    , uuid
+  default-language: Haskell2010
+
+test-suite megaparsec-utils-test
+  type: exitcode-stdio-1.0
+  main-is: Spec.hs
+  other-modules:
+      Text.Megaparsec.UtilsSpec
+      Paths_megaparsec_utils
+  hs-source-dirs:
+      test
+  ghc-options: -Wall -Werror -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N
+  build-depends:
+      QuickCheck
+    , base >=4.7 && <5
+    , hspec
+    , megaparsec
+    , megaparsec-utils
+    , parser-combinators
+    , uuid
+  default-language: Haskell2010

megaparsec-utils.cabal

@@ -0,0 +1,46 @@
+name:       megaparsec-utils
+version:    0.1.0.0
+license:    GPL-3
+author:     drlkf
+maintainer: [email protected]
+copyright:  2024 drlkf
+
+extra-source-files:
+- README.org
+- CHANGELOG.md
+
+description: Utilities for the Megaparsec library.
+
+dependencies:
+  - base >= 4.7 && < 5
+  - megaparsec
+  - parser-combinators
+  - uuid
+
+ghc-options:
+  - -Wall
+  - -Werror
+  - -Wcompat
+  - -Widentities
+  - -Wincomplete-record-updates
+  - -Wincomplete-uni-patterns
+  - -Wmissing-export-lists
+  - -Wmissing-home-modules
+  - -Wpartial-fields
+  - -Wredundant-constraints
+
+library:
+  source-dirs: src
+
+tests:
+  megaparsec-utils-test:
+    main: Spec.hs
+    source-dirs: test
+    ghc-options:
+      - -threaded
+      - -rtsopts
+      - -with-rtsopts=-N
+    dependencies:
+      - megaparsec-utils
+      - hspec
+      - QuickCheck

package.yaml

@@ -0,0 +1,6 @@
+module Lib
+  ( someFunc
+  ) where
+
+someFunc :: IO ()
+someFunc = putStrLn "someFunc"

src/Lib.hs

@@ -0,0 +1,87 @@
+{-# LANGUAGE TypeFamilies #-}
+
+module Text.Megaparsec.Utils
+  ( boolParser
+  , boundedEnumShowParser
+  , commaSeparated
+  , numParser
+  , occurrence
+  , occurrences
+  , parsecToReadsPrec
+  , posNumParser
+  , uuidParser
+  ) where
+
+import           Control.Applicative             (many, some, (<|>))
+import           Control.Applicative.Combinators (choice)
+import           Control.Monad                   (replicateM, void)
+import           Data.Functor                    (($>))
+import           Data.List                       (intercalate, sortOn)
+import           Data.List.NonEmpty              (NonEmpty ((:|)))
+import           Data.Maybe                      (fromJust)
+import           Data.UUID                       (UUID)
+import qualified Data.UUID                       as U (fromString)
+import           Data.Void                       (Void)
+import           Text.Megaparsec                 (Parsec, anySingle, runParser,
+                                                  try)
+import           Text.Megaparsec.Char            (char, digitChar, hexDigitChar,
+                                                  string')
+
+-- | Parse a case-insensitive human-readable boolean, including C-style numbers
+-- and English yes-no.
+boolParser :: Parsec Void String Bool
+boolParser = true <|> false
+  where true  = True  <$ choice (map string' ["true", "y", "yes", "1"])
+        false = False <$ choice (map string' ["false", "n", "no", "0"])
+
+-- | Parse a 'Bounded' 'Enum' type that has a 'Show' instance, trying all
+-- possibilities, case-insensitive, in the 'Enum' order.
+boundedEnumShowParser
+  :: Bounded a
+  => Enum a
+  => Show a
+  => Parsec Void String a
+boundedEnumShowParser =
+  choice . map parseShow $ sortOn (negate . length . show) [minBound ..]
+  where parseShow a = string' (show a) $> a
+
+-- | Parse a comma-separated list of items.
+commaSeparated :: Parsec Void String a -> Parsec Void String (NonEmpty a)
+commaSeparated p = (:|) <$> p <*> many (char ',' >> p)
+
+-- | Parse any occurrence of a given parser. Consumes any input before occurence.
+occurrence :: Parsec Void String a -> Parsec Void String a
+occurrence p = go
+  where go = p <|> (anySingle >> go)
+
+-- | Parse all occurrences of a given parser.
+occurrences :: Parsec Void String a -> Parsec Void String [a]
+occurrences = some . try . occurrence
+
+-- | Parse a positive integer.
+posNumParser :: Read a => Parsec Void String a
+posNumParser = read <$> some digitChar
+
+-- | Parse an integer, without any spaces between minus sign and digits.
+numParser :: Parsec Void String Int
+numParser = (char '-' >> negate <$> posNumParser) <|> posNumParser
+
+-- | Convert a 'Parsec' parser into a 'ReadS' parser. Useful for defining 'Read'
+-- instances with 'Megaparsec'.
+parsecToReadsPrec :: Parsec Void String a -> ReadS a
+parsecToReadsPrec p = either (const []) (\x -> [(x, "")]) . runParser p "string"
+
+-- | Parse a RFC4122-compliant UUID.
+uuidParser :: Parsec Void String UUID
+uuidParser = do
+  part1 <- replicateM 8 hexDigitChar
+  void $ char '-'
+  part2 <- replicateM 4 hexDigitChar
+  void $ char '-'
+  part3 <- replicateM 4 hexDigitChar
+  void $ char '-'
+  part4 <- replicateM 4 hexDigitChar
+  void $ char '-'
+  part5 <- replicateM 12 hexDigitChar
+
+  pure . fromJust . U.fromString $ intercalate "-" [part1, part2, part3, part4, part5]

src/Text/Megaparsec/Utils.hs

@@ -0,0 +1,5 @@
+resolver:
+  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/25.yaml
+
+packages:
+- .

stack.yaml

@@ -0,0 +1,13 @@
+# This file was autogenerated by Stack.
+# You should not edit this file by hand.
+# For more information, please see the documentation at:
+#   https://docs.haskellstack.org/en/stable/lock_files
+
+packages: []
+snapshots:
+- completed:
+    sha256: a81fb3877c4f9031e1325eb3935122e608d80715dc16b586eb11ddbff8671ecd
+    size: 640086
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/25.yaml
+  original:
+    url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/21/25.yaml

stack.yaml.lock

@@ -0,0 +1,2 @@
+{-# OPTIONS_GHC -Wno-missing-export-lists #-}
+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}