diff --git a/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -2,6 +2,13 @@ `redis-glob` uses [PVP Versioning][1]. +## 0.1.0.10 -- 2025-01-12 + +* Inline fromChar from ASCII.Superset, allowing it to be removed as a dependency + +* Copy the latest version ASCII.Char from ascii-char into the package, removing + it as a dependency + ## 0.1.0.9 -- 2025-01-06 * Expand upper bounds for megaparsec diff --git a/ascii-char/ASCII/Char.hs b/ascii-char/ASCII/Char.hs new file mode 100644 --- /dev/null +++ b/ascii-char/ASCII/Char.hs @@ -0,0 +1,399 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveDataTypeable #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE DerivingStrategies #-} +{-# LANGUAGE StandaloneDeriving #-} + +{- | The 'Char' type has 128 nullary constructors, listed in + order according to each character's 7-bit numeric code. + +Copyright 2021 Chris Martin + +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. +-} +module ASCII.Char ( + -- * The @Char@ type + Char (..), + + -- * @Int@ + toInt, + fromIntMaybe, + fromIntUnsafe, + + -- * @Word8@ + toWord8, + fromWord8Maybe, + fromWord8Unsafe, + + -- * Enumeration + allCharacters, + + -- * Notes + -- $notes +) where + +import Data.Bool (otherwise) +import Data.Data (Data) +import Data.Eq (Eq) +import Data.Hashable (Hashable) +import Data.Int (Int) +import Data.Maybe (Maybe (..)) +import Data.Ord (Ord, (<), (>)) +import Data.Word (Word8) +import GHC.Generics (Generic) +import Text.Show (Show) +import Prelude (Bounded, Enum, enumFromTo, fromEnum, fromIntegral, maxBound, minBound, toEnum) + + +-- | A character in the ASCII character set +data Char + = Null + | StartOfHeading + | StartOfText + | EndOfText + | EndOfTransmission + | Enquiry + | Acknowledgement + | Bell + | Backspace + | HorizontalTab + | LineFeed + | VerticalTab + | FormFeed + | CarriageReturn + | ShiftOut + | ShiftIn + | DataLinkEscape + | DeviceControl1 + | DeviceControl2 + | DeviceControl3 + | DeviceControl4 + | NegativeAcknowledgement + | SynchronousIdle + | EndOfTransmissionBlock + | Cancel + | EndOfMedium + | Substitute + | Escape + | FileSeparator + | GroupSeparator + | RecordSeparator + | UnitSeparator + | Space + | -- | ! + ExclamationMark + | -- | " + QuotationMark + | -- | # + NumberSign + | -- | \$ + DollarSign + | -- | % + PercentSign + | -- | & + Ampersand + | -- | # + Apostrophe + | -- | ( + LeftParenthesis + | -- | ) + RightParenthesis + | -- | \* + Asterisk + | -- | + + PlusSign + | -- | , + Comma + | -- | \- + HyphenMinus + | -- | . + FullStop + | -- | / + Slash + | Digit0 + | Digit1 + | Digit2 + | Digit3 + | Digit4 + | Digit5 + | Digit6 + | Digit7 + | Digit8 + | Digit9 + | -- | : + Colon + | -- | ; + Semicolon + | -- | \< + LessThanSign + | -- | = + EqualsSign + | -- | \> + GreaterThanSign + | -- | ? + QuestionMark + | -- | \@ + AtSign + | CapitalLetterA + | CapitalLetterB + | CapitalLetterC + | CapitalLetterD + | CapitalLetterE + | CapitalLetterF + | CapitalLetterG + | CapitalLetterH + | CapitalLetterI + | CapitalLetterJ + | CapitalLetterK + | CapitalLetterL + | CapitalLetterM + | CapitalLetterN + | CapitalLetterO + | CapitalLetterP + | CapitalLetterQ + | CapitalLetterR + | CapitalLetterS + | CapitalLetterT + | CapitalLetterU + | CapitalLetterV + | CapitalLetterW + | CapitalLetterX + | CapitalLetterY + | CapitalLetterZ + | -- | \[ + LeftSquareBracket + | -- | \\ + Backslash + | -- | \] + RightSquareBracket + | -- | \^ + Caret + | -- | _ + Underscore + | -- | \` + GraveAccent + | SmallLetterA + | SmallLetterB + | SmallLetterC + | SmallLetterD + | SmallLetterE + | SmallLetterF + | SmallLetterG + | SmallLetterH + | SmallLetterI + | SmallLetterJ + | SmallLetterK + | SmallLetterL + | SmallLetterM + | SmallLetterN + | SmallLetterO + | SmallLetterP + | SmallLetterQ + | SmallLetterR + | SmallLetterS + | SmallLetterT + | SmallLetterU + | SmallLetterV + | SmallLetterW + | SmallLetterX + | SmallLetterY + | SmallLetterZ + | -- | \{ + LeftCurlyBracket + | -- | \| + VerticalLine + | -- | \} + RightCurlyBracket + | -- | \~ + Tilde + | Delete + + +{- | ASCII characters can be compared for equality using '(==)'. +Comparisons are case-sensitive; @'SmallLetterA' '/=' 'CapitalLetterA'@. +-} +deriving stock instance Eq Char + + +{- | ASCII characters are ordered; for example, the letter /A/ is "less than" +('<') the letter /B/ because it appears earlier in the list. The ordering of +ASCII characters is the same as the ordering of the corresponding Unicode +'Data.Char.Char's. +-} +deriving stock instance Ord Char + + +{- | The 'Enum' instance allows us to use range syntax, for example +@['SmallLetterA' .. 'SmallLetterZ']@ is a list all lower-case letters from /a/ +to /z/. Instead of 'toEnum' and 'fromEnum', consider using 'toInt' and +'fromIntMaybe'. +-} +deriving stock instance Enum Char + + +{- | The least character is 'Null', and the greatest character is 'Delete'. You +can write @(['minBound' .. 'maxBound'] :: [ASCII.'Char'])@ to get a list of all +the ASCII characters. +-} +deriving stock instance Bounded Char + + +{- | 'show' produces the name of a constructor. For example, the character @e@ is +shown as “@SmallLetterE@”. See "ASCII.Char" for the complete list of constructor +names. +-} +deriving stock instance Show Char + + +{- | The 'Data' instance allows ASCII characters to be used with generic +programming in the “SYB” style. (See the + package and the 2003 paper + +by Ralf Lämmel and Simon Peyton Jones.) +-} +deriving stock instance Data Char + + +{- | The 'Generic' instance allows ASCII characters to be used with generic +programming in the “generic deriving” style. (See the + package and the 2010 paper + +by José Pedro Magalhães, Atze Dijkstra, Johan Jeuring, and Andres Löh.) +-} +deriving stock instance Generic Char + + +{- | The 'Hashable' instance lets us collect ASCII characters in hash-based sets, +and it lets us use ASCII characters as keys in hash-based maps. (See the +@unordered-containers@ package.) +-} +deriving anyclass instance Hashable Char + + +{- | Converts an ASCII character to its corresponding numeric value between 0 and 127 + +@ +toInt Null == 0 +toInt CapitalLetterA == 6 +toInt SmallLetterA == 97 +toInt Delete == 127 +@ +-} +toInt :: Char -> Int +toInt = Prelude.fromEnum + + +{- | Converts an ASCII character to its corresponding byte between 0 and 127 + +@ +toWord8 Null == 0 +toWord8 CapitalLetterA == 6 +toWord8 SmallLetterA == 97 +toWord8 Delete == 127 +@ +-} +toWord8 :: Char -> Word8 +toWord8 x = Prelude.fromIntegral (Prelude.fromEnum x) + + +{- | Returns 'Just' the ASCII character corresponding to a numeric value between + 0 and 127, or 'Nothing' for numbers outside this range + +@ +fromIntMaybe (-1) == Nothing +fromIntMaybe 0 == Just Null +fromIntMaybe 65 == Just CapitalLetterA +fromIntMaybe 127 == Just Delete +fromIntMaybe 128 == Nothing +@ +-} +fromIntMaybe :: Int -> Maybe Char +fromIntMaybe x + | x < 0 = Nothing + | x > 127 = Nothing + | otherwise = Just (fromIntUnsafe x) + + +{- | Returns 'Just' the ASCII character corresponding to a byte between + 0 and 127, or 'Nothing' for bytes above this range + +@ +fromWord8Maybe 0 == Just Null +fromWord8Maybe 65 == Just CapitalLetterA +fromWord8Maybe 127 == Just Delete +fromWord8Maybe 128 == Nothing +@ +-} +fromWord8Maybe :: Word8 -> Maybe Char +fromWord8Maybe x + | x > 127 = Nothing + | otherwise = Just (fromWord8Unsafe x) + + +{- | The inverse of 'toInt' + +This is marked as /unsafe/ because it is undefined for numbers below 0 +or above 127. The safe variant of this function is 'fromIntMaybe'. + +@ +fromIntUnsafe (-1) == undefined +fromIntUnsafe 65 == CapitalLetterA +fromIntUnsafe 66 == CapitalLetterB +fromIntUnsafe 67 == CapitalLetterC +fromIntUnsafe 128 == undefined +@ +-} +fromIntUnsafe :: Int -> Char +fromIntUnsafe = Prelude.toEnum + + +{- | The inverse of 'toWord8' + +This is marked as /unsafe/ because it is undefined bytes above 127. +The safe variant of this function is 'fromWord8Maybe'. + +@ +fromWord8Unsafe 65 == CapitalLetterA +fromWord8Unsafe 66 == CapitalLetterB +fromWord8Unsafe 67 == CapitalLetterC +fromWord8Unsafe 128 == undefined +@ +-} +fromWord8Unsafe :: Word8 -> Char +fromWord8Unsafe x = fromIntUnsafe (Prelude.fromIntegral x) + + +allCharacters :: [Char] +allCharacters = Prelude.enumFromTo Prelude.minBound Prelude.maxBound + + +{- $notes + +There are 128 characters in total. + +@ +length allCharacters == 128 +@ + +Null is the first character. + +@ +minBound == Null +@ + +Delete is the last character. + +@ +maxBound == Delete +@ +-} diff --git a/doctest/Main.hs b/doctest/Main.hs --- a/doctest/Main.hs +++ b/doctest/Main.hs @@ -3,4 +3,4 @@ main :: IO () -main = doctest ["src"] +main = doctest ["src", "ascii-char"] diff --git a/redis-glob.cabal b/redis-glob.cabal --- a/redis-glob.cabal +++ b/redis-glob.cabal @@ -1,11 +1,11 @@ cabal-version: 3.0 name: redis-glob -version: 0.1.0.9 +version: 0.1.0.10 license: BSD-3-Clause license-file: LICENSE maintainer: adetokunbo@emio.la author: Tim Emiola -tested-with: GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.6 +tested-with: GHC ==8.10.7 || ==9.0.2 || ==9.2.8 || ==9.4.8 || ==9.6.6 || ==9.8.2 || ==9.10.1 homepage: https://github.com/adetokunbo/redis-glob#readme bug-reports: https://github.com/adetokunbo/redis-glob/issues synopsis: Specify valid redis globs @@ -31,14 +31,15 @@ exposed-modules: Redis.Glob Redis.Glob.Internal + other-modules: ASCII.Char - hs-source-dirs: src + hs-source-dirs: src ascii-char default-language: Haskell2010 ghc-options: -Wall -Wincomplete-uni-patterns -fwarn-tabs build-depends: - , ascii-char >=1.0.1 && <1.1 , base >=4.11 && <5.0 , bytestring >=0.10.8.2 && <0.11 || >=0.11.3 && <0.13 + , hashable >=1.3.5 && <1.5 , megaparsec >=9.2.1 && <9.8 if impl(ghc >=8.4) @@ -47,15 +48,15 @@ test-suite test type: exitcode-stdio-1.0 main-is: Spec.hs - hs-source-dirs: test - other-modules: Redis.GlobSpec + hs-source-dirs: test ascii-char + other-modules: ASCII.Char + Redis.GlobSpec default-language: Haskell2010 ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall -fwarn-tabs build-depends: - , ascii-char - , ascii-superset , base , bytestring + , hashable , hspec >=2.1 , QuickCheck , redis-glob diff --git a/test/Redis/GlobSpec.hs b/test/Redis/GlobSpec.hs --- a/test/Redis/GlobSpec.hs +++ b/test/Redis/GlobSpec.hs @@ -11,7 +11,6 @@ module Redis.GlobSpec (spec, genWithOkPatterns) where import qualified ASCII.Char as A -import qualified ASCII.Superset as A import qualified Data.ByteString.Lazy as BL import Data.Word (Word8) import Redis.Glob @@ -164,7 +163,7 @@ genInnerChar :: Gen Word8 -genInnerChar = genPrintable `suchThat` (/= A.fromChar A.RightSquareBracket) +genInnerChar = genPrintable `suchThat` (/= fromChar' A.RightSquareBracket) genSimpleChar :: Gen Word8 @@ -183,4 +182,8 @@ avoidElem :: [A.Char] -> Gen Word8 -> Gen Word8 -avoidElem xs = (`suchThat` (\x -> x `notElem` map A.fromChar xs)) +avoidElem xs = (`suchThat` (\x -> x `notElem` map fromChar' xs)) + + +fromChar' :: A.Char -> Word8 +fromChar' = fromIntegral . A.toInt