File: Tokenise.hs

package info (click to toggle)
cpphs 0.7-4
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny
  • size: 360 kB
  • ctags: 18
  • sloc: haskell: 940; makefile: 79; sh: 36; ansic: 11
file content (223 lines) | stat: -rw-r--r-- 11,283 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
-----------------------------------------------------------------------------
-- |
-- Module      :  Tokenise
-- Copyright   :  2004 Malcolm Wallace
-- Licence     :  LGPL
--
-- Maintainer  :  Malcolm Wallace <Malcolm.Wallace@cs.york.ac.uk>
-- Stability   :  experimental
-- Portability :  All
--
-- The purpose of this module is to lex a source file (language
-- unspecified) into tokens such that cpp can recognise a replaceable
-- symbol or macro-use, and do the right thing.
-----------------------------------------------------------------------------

module Tokenise
  ( linesCpp
  , reslash
  , tokenise
  , WordStyle(..)
  , deWordStyle
  , parseMacroCall
  ) where

import Char
import HashDefine
import Position

-- | A Mode value describes whether to tokenise a la Haskell, or a la Cpp.
--   The main difference is that in Cpp mode we should recognise line
--   continuation characters.
data Mode = Haskell | Cpp

-- | linesCpp is, broadly speaking, Prelude.lines, except that
--   on a line beginning with a #, line continuation characters are
--   recognised.  In a continuation, the newline character is
--   preserved, but the backslash is not.
linesCpp :: String -> [String]
linesCpp  []                 = []
linesCpp (x:xs) | x=='#'     = tok Cpp     ['#'] xs
                | otherwise  = tok Haskell [] (x:xs)
  where
    tok Cpp   acc ('\\':'\n':ys)   = tok Cpp ('\n':acc) ys
    tok _     acc ('\n':'#':ys)    = reverse acc: tok Cpp ['#'] ys
    tok _     acc ('\n':ys)        = reverse acc: tok Haskell [] ys
    tok _     acc []               = reverse acc: []
    tok mode  acc (y:ys)           = tok mode (y:acc) ys

-- | Put back the line-continuation characters.
reslash :: String -> String
reslash ('\n':xs) = '\\':'\n':reslash xs
reslash (x:xs)    = x: reslash xs
reslash   []      = []

----
-- | Submodes are required to deal correctly with nesting of lexical
--   structures.
data SubMode = Any | Pred (Char->Bool) (Posn->String->WordStyle)
             | String Char | LineComment | NestComment Int
             | CComment

-- | Each token is classified as one of Ident, Other, or Cmd
--   * Ident is a word that could potentially match a macro name.
--   * Cmd is a complete cpp directive (#define etc).
--   * Other is anything else.
data WordStyle = Ident Posn String | Other String | Cmd (Maybe HashDefine)
  deriving (Eq,Show)
other _ s = Other s

deWordStyle :: WordStyle -> String
deWordStyle (Ident _ i) = i
deWordStyle (Other i)   = i
deWordStyle (Cmd _)     = "\n"

-- | tokenise is, broadly-speaking, Prelude.words, except that:
--    * the input is already divided into lines
--    * each word-like "token" is categorised as one of {Ident,Other,Cmd}
--    * #define's are parsed and returned out-of-band using the Cmd variant
--    * All whitespace is preserved intact as tokens.
--    * C-comments are converted to white-space (depending on first param)
--    * Parens and commas are tokens in their own right.
--    * Any cpp line continuations are respected.
--   No errors can be raised.
--   The inverse of tokenise is (concatMap deWordStyle).
tokenise :: Bool -> Bool -> [(Posn,String)] -> [WordStyle]
tokenise _     _    [] = []
tokenise strip ansi ((pos,str):pos_strs) = haskell Any [] pos pos_strs str
 where
    -- rules to lex Haskell
  haskell :: SubMode -> String -> Posn -> [(Posn,String)]
             -> String -> [WordStyle]
  haskell Any acc p ls ('\n':'#':xs)      = emit acc $  -- emit "\n" $
                                            cpp Any [] [] p ls xs
    -- warning: non-maximal munch on comment
  haskell Any acc p ls ('-':'-':xs)       = emit acc $
                                            haskell LineComment "--" p ls xs
  haskell Any acc p ls ('{':'-':xs)       = emit acc $
                                            haskell (NestComment 0) "-{" p ls xs
  haskell Any acc p ls ('/':'*':xs)|strip = emit acc $
                                            haskell CComment "  " p ls xs
  haskell Any acc p ls ('"':xs)           = emit acc $
                                            haskell (String '"') ['"'] p ls xs
  haskell Any acc p ls ('\'':xs)          = emit acc $
                                            haskell (String '\'') "'" p ls xs
  haskell Any acc p ls (x:xs) | single x  = emit acc $ emit [x] $
                                            haskell Any [] p ls xs
  haskell Any acc p ls (x:xs) | space x   = emit acc $
                                            haskell (Pred space other) [x]
                                                                        p ls xs
  haskell Any acc p ls (x:xs) | symbol x  = emit acc $
                                            haskell (Pred symbol other) [x]
                                                                        p ls xs
 -- haskell Any [] p ls (x:xs) | ident0 x  = id $
  haskell Any acc p ls (x:xs) | ident0 x  = emit acc $
                                            haskell (Pred ident1 Ident) [x]
                                                                        p ls xs
  haskell Any acc p ls (x:xs)             = haskell Any (x:acc) p ls xs

  haskell pre@(Pred pred ws) acc p ls (x:xs)
                        | pred x    = haskell pre (x:acc) p ls xs
                        | otherwise = ws p (reverse acc):
                                      haskell Any [] p ls (x:xs)
  haskell (Pred _ ws) acc p [] []   = ws p (reverse acc): []
  haskell (String c) acc p ls ('\\':x:xs)
                        | x=='\\'   = haskell (String c) ('\\':'\\':acc) p ls xs
                        | x==c      = haskell (String c) (c:'\\':acc) p ls xs
  haskell (String c) acc p ls (x:xs)
                        | x==c      = emit (c:acc) $ haskell Any [] p ls xs
                        | otherwise = haskell (String c) (x:acc) p ls xs
  haskell LineComment acc p ls xs@('\n':_) = emit acc $ haskell Any [] p ls xs
  haskell LineComment acc p ls (x:xs)      = haskell LineComment (x:acc) p ls xs
  haskell (NestComment n) acc p ls ('{':'-':xs)
                                    = haskell (NestComment (n+1))
                                                            ("-{"++acc) p ls xs
  haskell (NestComment 0) acc p ls ('-':'}':xs)
                                    = emit ("}-"++acc) $ haskell Any [] p ls xs
  haskell (NestComment n) acc p ls ('-':'}':xs)
                                    = haskell (NestComment (n-1))
                                                            ("}-"++acc) p ls xs
  haskell (NestComment n) acc p ls (x:xs) = haskell (NestComment n) (x:acc)
                                                                        p ls xs
  haskell CComment acc p ls ('*':'/':xs)  = emit ("  "++acc) $
                                            haskell Any [] p ls xs
  haskell CComment acc p ls (_:xs)        = haskell CComment (' ':acc) p ls xs
  haskell mode acc _ ((p,l):ls) []        = haskell mode acc p ls ('\n':l)
  haskell _    acc _ [] []                = emit acc $ []

  -- rules to lex Cpp
  cpp :: SubMode -> String -> [String] -> Posn -> [(Posn,String)]
         -> String -> [WordStyle]
  cpp Any w l p ls ('/':'*':xs)        = cpp (NestComment 0) "" (w*/*l) p ls xs
  cpp Any w l p ls ('/':'/':xs)        = cpp LineComment "  " (w*/*l) p ls xs
  cpp Any w l _ ((p,l'):ls) ('\\':[])  = cpp Any [] ("\n":w*/*l) p ls l'
  cpp Any w l p ls ('\\':'\n':xs)      = cpp Any [] ("\n":w*/*l) p ls xs
  cpp Any w l p ls xs@('\n':_)         = Cmd (parseHashDefine ansi
                                                           (reverse (w*/*l))):
                                         haskell Any [] p ls xs
 -- cpp Any w l p ls ('"':xs)          = cpp (String '"') ['"'] (w*/*l) p ls xs
 -- cpp Any w l p ls ('\'':xs)         = cpp (String '\'') "'"  (w*/*l) p ls xs
  cpp Any w l p ls ('"':xs)            = cpp Any [] ("\"":(w*/*l)) p ls xs
  cpp Any w l p ls ('\'':xs)           = cpp Any [] ("'": (w*/*l)) p ls xs
  cpp Any [] l p ls (x:xs) | ident0 x  = cpp (Pred ident1 Ident) [x] l p ls xs
 -- cpp Any w l p ls (x:xs) | ident0 x  = cpp (Pred ident1 Ident) [x] (w*/*l) p ls xs
  cpp Any w l p ls (x:xs)  | single x  = cpp Any [] ([x]:w*/*l) p ls xs
                           | space x   = cpp (Pred space other) [x] (w*/*l)
                                                                        p ls xs
                           | symbol x  = cpp (Pred symbol other) [x] (w*/*l)
                                                                        p ls xs
                           | otherwise = cpp Any (x:w) l p ls xs
  cpp pre@(Pred pred _) w l p ls (x:xs)
                           | pred x    = cpp pre (x:w) l p ls xs
                           | otherwise = cpp Any [] (w*/*l) p ls (x:xs)
  cpp      (Pred _ _) w l p [] []      = cpp Any [] (w*/*l) p [] "\n"
  cpp (String c) w l p ls ('\\':x:xs)
                           | x=='\\'   = cpp (String c) ('\\':'\\':w) l p ls xs
                           | x==c      = cpp (String c) (c:'\\':w) l p ls xs
  cpp (String c) w l p ls (x:xs)
                           | x==c      = cpp Any [] ((c:w)*/*l) p ls xs
                           | otherwise = cpp (String c) (x:w) l p ls xs
  cpp LineComment w l _ ((p,l'):ls) ('\\':[])
                                       = cpp LineComment [] (('\n':w)*/*l)
                                                                        p ls l'
  cpp LineComment w l p ls ('\\':'\n':xs)
                                       = cpp LineComment [] (('\n':w)*/*l)
                                                                        p ls xs
  cpp LineComment w l p ls xs@('\n':_) = cpp Any w l p ls xs
  cpp LineComment w l p ls (_:xs)      = cpp LineComment (' ':w) l p ls xs
  cpp (NestComment _) w l p ls ('*':'/':xs)
                                       = cpp Any [] (w*/*l) p ls xs
  cpp (NestComment n) w l p ls (_:xs)  = cpp (NestComment n) (' ':w) l p ls xs
  cpp mode w l _ ((p,l'):ls) []        = cpp mode w l p ls ('\n':l')
  cpp _ _ _ _ [] []                    = []

  -- predicates for lexing Haskell.
  ident0 x = isAlpha x    || x `elem` "_`"
  ident1 x = isAlphaNum x || x `elem` "'_`"
  symbol x = x `elem` ":!#$%&*+./<=>?@\\^|-~"
  single x = x `elem` "(),[];{}"
  space  x = x `elem` " \t"
  -- emit a token (if there is one) from the accumulator
  emit ""  = id
  emit xs  = (Other (reverse xs):)
  -- add a reversed word to the accumulator
  "" */* l = l
  w */* l  = reverse w : l


-- | parse a possible macro call, returning argument list and remaining input
parseMacroCall :: [WordStyle] -> Maybe ([String],[WordStyle])
parseMacroCall = call . skip
  where
    skip (Other x:xs) | all isSpace x = skip xs
    skip xss                          = xss
    call (Other "(":xs)   = (args (0::Int) [] [] . skip) xs
    call _                = Nothing
    args 0 w acc (Other ",":xs)   = args 0 [] (addone w acc) (skip xs)
    args n w acc (Other "(":xs)   = args (n+1) ("(":w) acc xs
    args 0 w acc (Other ")":xs)   = Just (reverse (addone w acc), xs)
    args n w acc (Other ")":xs)   = args (n-1) (")":w) acc xs
    args n w acc (Ident _ var:xs) = args n (var:w) acc xs
    args n w acc (Other var:xs)   = args n (var:w) acc xs
    args _ _ _   _                = Nothing
    addone w acc = concat (reverse (dropWhile (all isSpace) w)): acc