Add {-# OPTIONS_GHC -w #-} and some blurb to all compiler modules
[ghc.git] / compiler / cmm / CmmLex.x
1 -----------------------------------------------------------------------------
2 --
3 -- (c) The University of Glasgow, 2004-2006
4 --
5 -- Lexer for concrete Cmm.  We try to stay close to the C-- spec, but there
6 -- are a few minor differences:
7 --
8 --   * extra keywords for our macros, and float32/float64 types
9 --   * global registers (Sp,Hp, etc.)
10 --
11 -----------------------------------------------------------------------------
12
13 {
14 {-# OPTIONS_GHC -w #-}
15 -- The above warning supression flag is a temporary kludge.
16 -- While working on this module you are encouraged to remove it and fix
17 -- any warnings in the module. See
18 --     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
19 -- for details
20
21 module CmmLex (
22    CmmToken(..), cmmlex,
23   ) where
24
25 #include "HsVersions.h"
26
27 import Cmm
28 import Lexer
29
30 import SrcLoc
31 import UniqFM
32 import StringBuffer
33 import FastString
34 import Ctype
35 import Util
36 --import TRACE
37 }
38
39 $whitechar   = [\ \t\n\r\f\v\xa0] -- \xa0 is Unicode no-break space
40 $white_no_nl = $whitechar # \n
41
42 $ascdigit  = 0-9
43 $unidigit  = \x01 -- Trick Alex into handling Unicode. See alexGetChar.
44 $digit     = [$ascdigit $unidigit]
45 $octit     = 0-7
46 $hexit     = [$digit A-F a-f]
47
48 $unilarge  = \x03 -- Trick Alex into handling Unicode. See alexGetChar.
49 $asclarge  = [A-Z \xc0-\xd6 \xd8-\xde]
50 $large     = [$asclarge $unilarge]
51
52 $unismall  = \x04 -- Trick Alex into handling Unicode. See alexGetChar.
53 $ascsmall  = [a-z \xdf-\xf6 \xf8-\xff]
54 $small     = [$ascsmall $unismall \_]
55
56 $namebegin = [$large $small \. \$ \@]
57 $namechar  = [$namebegin $digit]
58
59 @decimal     = $digit+
60 @octal       = $octit+
61 @hexadecimal = $hexit+
62 @exponent    = [eE] [\-\+]? @decimal
63
64 @floating_point = @decimal \. @decimal @exponent? | @decimal @exponent
65
66 @escape      = \\ ([abfnrt\\\'\"\?] | x $hexit{1,2} | $octit{1,3})
67 @strchar     = ($printable # [\"\\]) | @escape
68
69 cmm :-
70
71 $white_no_nl+           ;
72 ^\# pragma .* \n        ; -- Apple GCC 3.3 CPP generates pragmas in its output
73
74 ^\# (line)?             { begin line_prag }
75
76 -- single-line line pragmas, of the form
77 --    # <line> "<file>" <extra-stuff> \n
78 <line_prag> $digit+                     { setLine line_prag1 }
79 <line_prag1> \" ($printable # \")* \"   { setFile line_prag2 }
80 <line_prag2> .*                         { pop }
81
82 <0> {
83   \n                    ;
84
85   [\:\;\{\}\[\]\(\)\=\`\~\/\*\%\-\+\&\^\|\>\<\,\!]      { special_char }
86   
87   ".."                  { kw CmmT_DotDot }
88   "::"                  { kw CmmT_DoubleColon }
89   ">>"                  { kw CmmT_Shr }
90   "<<"                  { kw CmmT_Shl }
91   ">="                  { kw CmmT_Ge }
92   "<="                  { kw CmmT_Le }
93   "=="                  { kw CmmT_Eq }
94   "!="                  { kw CmmT_Ne }
95   "&&"                  { kw CmmT_BoolAnd }
96   "||"                  { kw CmmT_BoolOr }
97   
98   R@decimal             { global_regN VanillaReg }
99   F@decimal             { global_regN FloatReg }
100   D@decimal             { global_regN DoubleReg }
101   L@decimal             { global_regN LongReg }
102   Sp                    { global_reg Sp }
103   SpLim                 { global_reg SpLim }
104   Hp                    { global_reg Hp }
105   HpLim                 { global_reg HpLim }
106   CurrentTSO            { global_reg CurrentTSO }
107   CurrentNursery        { global_reg CurrentNursery }
108   HpAlloc               { global_reg HpAlloc }
109   BaseReg               { global_reg BaseReg }
110   
111   $namebegin $namechar* { name }
112   
113   0 @octal              { tok_octal }
114   @decimal              { tok_decimal }
115   0[xX] @hexadecimal    { tok_hexadecimal }
116   @floating_point       { strtoken tok_float }
117   
118   \" @strchar* \"       { strtoken tok_string }
119 }
120
121 {
122 data CmmToken
123   = CmmT_SpecChar  Char
124   | CmmT_DotDot
125   | CmmT_DoubleColon
126   | CmmT_Shr
127   | CmmT_Shl
128   | CmmT_Ge
129   | CmmT_Le
130   | CmmT_Eq
131   | CmmT_Ne
132   | CmmT_BoolAnd
133   | CmmT_BoolOr
134   | CmmT_CLOSURE
135   | CmmT_INFO_TABLE
136   | CmmT_INFO_TABLE_RET
137   | CmmT_INFO_TABLE_FUN
138   | CmmT_INFO_TABLE_CONSTR
139   | CmmT_INFO_TABLE_SELECTOR
140   | CmmT_else
141   | CmmT_export
142   | CmmT_section
143   | CmmT_align
144   | CmmT_goto
145   | CmmT_if
146   | CmmT_jump
147   | CmmT_foreign
148   | CmmT_never
149   | CmmT_prim
150   | CmmT_return
151   | CmmT_returns
152   | CmmT_import
153   | CmmT_switch
154   | CmmT_case
155   | CmmT_default
156   | CmmT_bits8
157   | CmmT_bits16
158   | CmmT_bits32
159   | CmmT_bits64
160   | CmmT_float32
161   | CmmT_float64
162   | CmmT_GlobalReg GlobalReg
163   | CmmT_Name      FastString
164   | CmmT_String    String
165   | CmmT_Int       Integer
166   | CmmT_Float     Rational
167   | CmmT_EOF
168 #ifdef DEBUG
169   deriving (Show)
170 #endif
171
172 -- -----------------------------------------------------------------------------
173 -- Lexer actions
174
175 type Action = SrcSpan -> StringBuffer -> Int -> P (Located CmmToken)
176
177 begin :: Int -> Action
178 begin code _span _str _len = do pushLexState code; lexToken
179
180 pop :: Action
181 pop _span _buf _len = do popLexState; lexToken
182
183 special_char :: Action
184 special_char span buf len = return (L span (CmmT_SpecChar (currentChar buf)))
185
186 kw :: CmmToken -> Action
187 kw tok span buf len = return (L span tok)
188
189 global_regN :: (Int -> GlobalReg) -> Action
190 global_regN con span buf len 
191   = return (L span (CmmT_GlobalReg (con (fromIntegral n))))
192   where buf' = stepOn buf
193         n = parseUnsignedInteger buf' (len-1) 10 octDecDigit
194
195 global_reg :: GlobalReg -> Action
196 global_reg r span buf len = return (L span (CmmT_GlobalReg r))
197
198 strtoken :: (String -> CmmToken) -> Action
199 strtoken f span buf len = 
200   return (L span $! (f $! lexemeToString buf len))
201
202 name :: Action
203 name span buf len = 
204   case lookupUFM reservedWordsFM fs of
205         Just tok -> return (L span tok)
206         Nothing  -> return (L span (CmmT_Name fs))
207   where
208         fs = lexemeToFastString buf len
209
210 reservedWordsFM = listToUFM $
211         map (\(x, y) -> (mkFastString x, y)) [
212         ( "CLOSURE",            CmmT_CLOSURE ),
213         ( "INFO_TABLE",         CmmT_INFO_TABLE ),
214         ( "INFO_TABLE_RET",     CmmT_INFO_TABLE_RET ),
215         ( "INFO_TABLE_FUN",     CmmT_INFO_TABLE_FUN ),
216         ( "INFO_TABLE_CONSTR",  CmmT_INFO_TABLE_CONSTR ),
217         ( "INFO_TABLE_SELECTOR",CmmT_INFO_TABLE_SELECTOR ),
218         ( "else",               CmmT_else ),
219         ( "export",             CmmT_export ),
220         ( "section",            CmmT_section ),
221         ( "align",              CmmT_align ),
222         ( "goto",               CmmT_goto ),
223         ( "if",                 CmmT_if ),
224         ( "jump",               CmmT_jump ),
225         ( "foreign",            CmmT_foreign ),
226         ( "never",              CmmT_never ),
227         ( "prim",               CmmT_prim ),
228         ( "return",             CmmT_return ),
229         ( "returns",            CmmT_returns ),
230         ( "import",             CmmT_import ),
231         ( "switch",             CmmT_switch ),
232         ( "case",               CmmT_case ),
233         ( "default",            CmmT_default ),
234         ( "bits8",              CmmT_bits8 ),
235         ( "bits16",             CmmT_bits16 ),
236         ( "bits32",             CmmT_bits32 ),
237         ( "bits64",             CmmT_bits64 ),
238         ( "float32",            CmmT_float32 ),
239         ( "float64",            CmmT_float64 )
240         ]
241
242 tok_decimal span buf len 
243   = return (L span (CmmT_Int  $! parseUnsignedInteger buf len 10 octDecDigit))
244
245 tok_octal span buf len 
246   = return (L span (CmmT_Int  $! parseUnsignedInteger (offsetBytes 1 buf) (len-1) 8 octDecDigit))
247
248 tok_hexadecimal span buf len 
249   = return (L span (CmmT_Int  $! parseUnsignedInteger (offsetBytes 2 buf) (len-2) 16 hexDigit))
250
251 tok_float str = CmmT_Float $! readRational str
252
253 tok_string str = CmmT_String (read str)
254                  -- urk, not quite right, but it'll do for now
255
256 -- -----------------------------------------------------------------------------
257 -- Line pragmas
258
259 setLine :: Int -> Action
260 setLine code span buf len = do
261   let line = parseUnsignedInteger buf len 10 octDecDigit
262   setSrcLoc (mkSrcLoc (srcSpanFile span) (fromIntegral line - 1) 0)
263         -- subtract one: the line number refers to the *following* line
264   -- trace ("setLine "  ++ show line) $ do
265   popLexState
266   pushLexState code
267   lexToken
268
269 setFile :: Int -> Action
270 setFile code span buf len = do
271   let file = lexemeToFastString (stepOn buf) (len-2)
272   setSrcLoc (mkSrcLoc file (srcSpanEndLine span) (srcSpanEndCol span))
273   popLexState
274   pushLexState code
275   lexToken
276
277 -- -----------------------------------------------------------------------------
278 -- This is the top-level function: called from the parser each time a
279 -- new token is to be read from the input.
280
281 cmmlex :: (Located CmmToken -> P a) -> P a
282 cmmlex cont = do
283   tok@(L _ tok__) <- lexToken
284   --trace ("token: " ++ show tok__) $ do
285   cont tok
286
287 lexToken :: P (Located CmmToken)
288 lexToken = do
289   inp@(loc1,buf) <- getInput
290   sc <- getLexState
291   case alexScan inp sc of
292     AlexEOF -> do let span = mkSrcSpan loc1 loc1
293                   setLastToken span 0 0
294                   return (L span CmmT_EOF)
295     AlexError (loc2,_) -> do failLocMsgP loc1 loc2 "lexical error"
296     AlexSkip inp2 _ -> do
297         setInput inp2
298         lexToken
299     AlexToken inp2@(end,buf2) len t -> do
300         setInput inp2
301         let span = mkSrcSpan loc1 end
302         span `seq` setLastToken span len len
303         t span buf len
304
305 -- -----------------------------------------------------------------------------
306 -- Monad stuff
307
308 -- Stuff that Alex needs to know about our input type:
309 type AlexInput = (SrcLoc,StringBuffer)
310
311 alexInputPrevChar :: AlexInput -> Char
312 alexInputPrevChar (_,s) = prevChar s '\n'
313
314 alexGetChar :: AlexInput -> Maybe (Char,AlexInput)
315 alexGetChar (loc,s) 
316   | atEnd s   = Nothing
317   | otherwise = c `seq` loc' `seq` s' `seq` Just (c, (loc', s'))
318   where c = currentChar s
319         loc' = advanceSrcLoc loc c
320         s'   = stepOn s
321
322 getInput :: P AlexInput
323 getInput = P $ \s@PState{ loc=l, buffer=b } -> POk s (l,b)
324
325 setInput :: AlexInput -> P ()
326 setInput (l,b) = P $ \s -> POk s{ loc=l, buffer=b } ()
327 }