Add Eq, Ord instances for location and range, also non-IO drivers

Author: benl23x5

Changelog.md

@@ -1,4 +1,4 @@
-## inchworm-1.1.1.1:
+## inchworm-1.1.1:
 
  * Matching combinators now produce the range of source locations that matched,
    instead of just the starting location.

Readme.md

@@ -67,6 +67,6 @@ main :: IO ()
 main 
  = do   let fileName = "Source.lispy"
         let source   = "(some (Lispy like) 26 Program 93 (for you))"
-        toks    <- scanStringIO source (scanner fileName)
+        let toks     = scanString source (scanner fileName)
         print toks
 ```

Text/Lexer/Inchworm.hs

@@ -73,6 +73,7 @@ module Text.Lexer.Inchworm
         , Scanner
 
           -- * Generic Scanning
+        , scanList
         , scanListIO
 
           -- ** Source Construction
@@ -101,15 +102,30 @@ where
 import Text.Lexer.Inchworm.Source
 import Text.Lexer.Inchworm.Scanner
 import Text.Lexer.Inchworm.Combinator
+import System.IO.Unsafe
 
 
 -- | Scan a list of generic input tokens in the IO monad,
 --   returning the source location of the final input token, 
 --   along with the remaining input.
 --
 --   NOTE: If you just want to scan a `String` of characters
---   use @scanStringIO@ from "Text.Lexer.Inchworm.Char"
+--   use @scanString@ from "Text.Lexer.Inchworm.Char"
 --
+scanList 
+        :: Eq i
+        => loc                   -- ^ Starting source location.
+        -> (i -> loc -> loc)     -- ^ Function to bump the current location by one input token.
+        -> [i]                   -- ^ List of input tokens.
+        -> Scanner IO loc [i] a  -- ^ Scanner to apply.
+        -> ([a], loc, [i])
+         
+scanList loc bump input scanner
+ = unsafePerformIO $ scanListIO loc bump input scanner
+
+
+ -- | Implementation for `scanList`,
+--   that uses the IO monad to manage its state.
 scanListIO 
         :: Eq i
         => loc                   -- ^ Starting source location.
@@ -121,3 +137,5 @@ scanListIO
 scanListIO loc bump input scanner
  = do   src     <- makeListSourceIO loc bump input
         scanSourceToList src scanner
+
+

Text/Lexer/Inchworm/Char.hs

@@ -4,6 +4,7 @@ module Text.Lexer.Inchworm.Char
         ( module Text.Lexer.Inchworm
 
           -- * Driver
+        , scanString
         , scanStringIO
 
           -- * Locations
@@ -19,13 +20,29 @@ module Text.Lexer.Inchworm.Char
 where
 import Text.Lexer.Inchworm
 import Text.Lexer.Inchworm.Source
+import System.IO.Unsafe
 import qualified Data.Char              as Char
 import qualified Data.List              as List
 import qualified Numeric                as Numeric
 
 
 -- Driver ---------------------------------------------------------------------
--- | Scan a string, using the IO monad to maintain internal state.
+-- | Scan a string.
+scanString
+        :: String
+        -> Scanner IO Location String a
+        -> ([a], Location, String)
+
+scanString str scanner
+ = unsafePerformIO 
+ $ scanListIO
+        (Location 0 0)
+        bumpLocationWithChar 
+        str scanner
+
+
+-- | Implementation for `scanString`,
+--   that uses the IO monad to maintain internal state.
 scanStringIO
         :: String
         -> Scanner IO Location String a

Text/Lexer/Inchworm/Source.hs

@@ -203,7 +203,7 @@ makeListSourceIO loc00 bumpLoc cs0
 -- | A range of locations in a source file.
 data Range loc
         = Range !loc !loc
-        deriving Show
+        deriving (Show, Eq, Ord)
 
 
 -- | A location in a source file.
@@ -215,7 +215,7 @@ data Location
         = Location   
                 !Int    -- Line.
                 !Int    -- Column.
-        deriving Show
+        deriving (Show, Eq, Ord)
 
 
 {-# SPECIALIZE INLINE

examples/lispy/Main.hs

@@ -35,5 +35,5 @@ main :: IO ()
 main 
  = do   let fileName = "Source.lispy"
         let source   = "(some (Lispy like) 26 Program 93 (for you))"
-        toks    <- scanStringIO source (scanner fileName)
+        let toks     = scanString source (scanner fileName)
         print toks

examples/mlish/Main.hs

@@ -20,7 +20,7 @@ main
                 , "'\\137'"
                 , "\"derpo\\ntro\\BELnic\""]
 
-        result  <- scanStringIO source (scanner fileName)
+        let result = scanString source (scanner fileName)
         print result
 
 

inchworm.cabal

@@ -1,5 +1,5 @@
 name:           inchworm
-version:        1.1.1.1
+version:        1.1.1.2
 license:        MIT
 license-file:   LICENSE
 author:         The Inchworm Development Team