Replace undefined with more descriptive error (#262)

* Replace undefined with more descriptive error

* Make sure alexScanUser is inlined

* Add missing issue_262.x

* Add LANGUAGE ScopedTypeVariables to issue_262.x

---------

Co-authored-by: Andreas Abel <[email protected]>

Author: brandonchinn178

alex.cabal

@@ -90,6 +90,7 @@ extra-source-files:
         tests/issue_119.x
         tests/issue_141.x
         tests/issue_197.x
+        tests/issue_262.x
         tests/strict_text_typeclass.x
         tests/posn_typeclass_strict_text.x
         tests/tokens_monadUserState_strict_text.x

data/AlexTemplate.hs

@@ -94,7 +94,12 @@ data AlexReturn a
 
 -- alexScan :: AlexInput -> StartCode -> AlexReturn a
 alexScan input__ IBOX(sc)
-  = alexScanUser undefined input__ IBOX(sc)
+  = alexScanUser (error "alex rule requiring context was invoked by alexScan; use alexScanUser instead?") input__ IBOX(sc)
+
+-- If the generated alexScan/alexScanUser functions are called multiple times
+-- in the same file, alexScanUser gets broken out into a separate function and
+-- increases memory usage. Make sure GHC inlines this function and optimizes it.
+{-# INLINE alexScanUser #-}
 
 alexScanUser user__ input__ IBOX(sc)
   = case alex_scan_tkn user__ input__ ILIT(0) input__ sc AlexNone of

tests/Makefile

@@ -58,6 +58,7 @@ TESTS = \
         issue_119.x \
         issue_141.x \
         issue_197.x \
+        issue_262.x \
         monad_typeclass.x \
         monad_typeclass_bytestring.x \
         monadUserState_typeclass.x \

tests/issue_262.x

@@ -0,0 +1,28 @@
+{
+-- https://github.com/haskell/alex/pull/262
+-- https://gitlab.haskell.org/ghc/ghc/-/issues/25609
+--
+-- Error happens when using alexScan with a lexer that
+-- inspects the context.
+
+{-# LANGUAGE ScopedTypeVariables #-}
+
+import Control.Exception
+import Data.List (isInfixOf)
+}
+
+%wrapper "basic"
+
+:-
+.* / { \state _ _ _ -> state == 'x' } { id }
+
+{
+main :: IO ()
+main = do
+  result <- try $ evaluate $ alexScan ('\n', [], "") 0 `seq` ()
+  case result of
+    Left (e :: SomeException)
+      | "use alexScanUser instead" `isInfixOf` show e
+      -> pure ()
+    _ -> error $ "Got unexpected result: " ++ show result
+}