ParseUtils.hs 23.5 KB
Newer Older
simonmar's avatar
simonmar committed
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
-----------------------------------------------------------------------------
-- |
-- Module      :  Distribution.ParseUtils
-- Copyright   :  (c) The University of Glasgow 2004
-- 
-- Maintainer  :  libraries@haskell.org
-- Stability   :  alpha
-- Portability :  portable
--
-- Utilities for parsing PackageDescription and InstalledPackageInfo.


{- All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.

    * Neither the name of the University nor the names of other
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -}

-- This module is meant to be local-only to Distribution...

-- #hide
module Distribution.ParseUtils (
Simon Marlow's avatar
Simon Marlow committed
47
        LineNo, PError(..), PWarning, locatedErrorMsg, syntaxError, warning,
48
	runP, ParseResult(..), catchParseError, parseFail,
49 50
	Field(..), fName, lineNo, 
	FieldDescr(..), ppField, ppFields, readFields, 
ijones's avatar
ijones committed
51
	parseFilePathQ, parseTokenQ,
52
	parseModuleNameQ, parseBuildTool, parsePkgconfigDependency,
53
        parseOptVersion, parsePackageNameQ, parseVersionRangeQ,
Simon Marlow's avatar
Simon Marlow committed
54 55
	parseTestedWithQ, parseLicenseQ, parseExtensionQ, 
	parseSepList, parseCommaList, parseOptCommaList,
56
	showFilePath, showToken, showTestedWith, showFreeText,
Simon Marlow's avatar
Simon Marlow committed
57
	field, simpleField, listField, commaListField, optsField, liftField,
58 59 60
	parseReadS, parseReadSQ, parseQuoted, parseBool,

        UnrecFieldParser, warnUnrec, ignoreUnrec,
simonmar's avatar
simonmar committed
61 62
  ) where

ijones's avatar
ijones committed
63
import Distribution.Compiler (CompilerFlavor)
simonmar's avatar
simonmar committed
64 65
import Distribution.License
import Distribution.Version
66
import Distribution.Package	( parsePackageName, Dependency(..) )
simonmar's avatar
simonmar committed
67
import Distribution.Compat.ReadP as ReadP hiding (get)
68
import Distribution.Simple.Utils (intercalate)
Simon Marlow's avatar
Simon Marlow committed
69 70
import Language.Haskell.Extension (Extension)

71
import Text.PrettyPrint.HughesPJ hiding (braces)
72
import Data.Char (isSpace, isUpper, toLower, isAlphaNum, isSymbol, isDigit)
73
import Data.Maybe	(fromMaybe)
74
import Data.Tree as Tree (Tree(..), flatten)
75

simonmar's avatar
simonmar committed
76 77 78 79 80 81
-- -----------------------------------------------------------------------------

type LineNo = Int

data PError = AmbigousParse String LineNo
            | NoParse String LineNo
82
            | TabsError LineNo
83
            | UTFError LineNo
simonmar's avatar
simonmar committed
84 85 86
            | FromString String (Maybe LineNo)
        deriving Show

87 88 89
type PWarning = String

data ParseResult a = ParseFailed PError | ParseOk [PWarning] a
90 91 92
        deriving Show

instance Monad ParseResult where
93
	return x = ParseOk [] x
94
	ParseFailed err >>= _ = ParseFailed err
95 96 97
	ParseOk ws x >>= f = case f x of
	                       ParseFailed err -> ParseFailed err
			       ParseOk ws' x' -> ParseOk (ws'++ws) x'
98
	fail s = ParseFailed (FromString s Nothing)
simonmar's avatar
simonmar committed
99

100 101 102 103 104 105 106 107
catchParseError :: ParseResult a -> (PError -> ParseResult a)
                -> ParseResult a
p@(ParseOk _ _) `catchParseError` _ = p
ParseFailed e `catchParseError` k   = k e

parseFail :: PError -> ParseResult a
parseFail = ParseFailed

108
runP :: LineNo -> String -> ReadP a a -> String -> ParseResult a
nominolo@gmail.com's avatar
nominolo@gmail.com committed
109
runP line fieldname p s =
simonmar's avatar
simonmar committed
110
  case [ x | (x,"") <- results ] of
111
    [a] -> ParseOk [] a
simonmar's avatar
simonmar committed
112
    []  -> case [ x | (x,ys) <- results, all isSpace ys ] of
113
             [a] -> ParseOk [] a
nominolo@gmail.com's avatar
nominolo@gmail.com committed
114 115 116
             []  -> ParseFailed (NoParse fieldname line)
             _   -> ParseFailed (AmbigousParse fieldname line)
    _   -> ParseFailed (AmbigousParse fieldname line)
simonmar's avatar
simonmar committed
117 118
  where results = readP_to_S p s

ijones's avatar
ijones committed
119
locatedErrorMsg :: PError -> (Maybe LineNo, String)
nominolo@gmail.com's avatar
nominolo@gmail.com committed
120
locatedErrorMsg (AmbigousParse f n) = (Just n, "Ambiguous parse in field '"++f++"'")
121
locatedErrorMsg (NoParse f n)       = (Just n, "Parse of field '"++f++"' failed: ")
122
locatedErrorMsg (TabsError n)       = (Just n, "Tab used as indentation.")
123
locatedErrorMsg (UTFError  n)       = (Just n, "Invalid UTF-8 text.")
ijones's avatar
ijones committed
124 125 126 127
locatedErrorMsg (FromString s n)    = (n, s)

syntaxError :: LineNo -> String -> ParseResult a
syntaxError n s = ParseFailed $ FromString s (Just n)
simonmar's avatar
simonmar committed
128

129 130 131
tabsError :: LineNo -> ParseResult a
tabsError ln = ParseFailed $ TabsError ln

132 133 134
utf8Error :: LineNo -> ParseResult a
utf8Error ln = ParseFailed $ UTFError ln

135 136 137
warning :: String -> ParseResult ()
warning s = ParseOk [s] ()

nominolo@gmail.com's avatar
nominolo@gmail.com committed
138 139
-- | Field descriptor.  The parameter @a@ parameterizes over where the field's
--   value is stored in.
Simon Marlow's avatar
Simon Marlow committed
140 141
data FieldDescr a 
  = FieldDescr 
simonmar's avatar
simonmar committed
142 143
      { fieldName     :: String
      , fieldGet      :: a -> Doc
144
      , fieldSet      :: LineNo -> String -> a -> ParseResult a
nominolo@gmail.com's avatar
nominolo@gmail.com committed
145 146 147
        -- ^ @fieldSet n str x@ Parses the field value from the given input
        -- string @str@ and stores the result in @x@ if the parse was
        -- successful.  Otherwise, reports an error on line number @n@.
simonmar's avatar
simonmar committed
148 149
      }

Simon Marlow's avatar
Simon Marlow committed
150 151
field :: String -> (a -> Doc) -> (ReadP a a) -> FieldDescr a
field name showF readF = 
nominolo@gmail.com's avatar
nominolo@gmail.com committed
152
  FieldDescr name showF (\line val _st -> runP line name readF val)
Simon Marlow's avatar
Simon Marlow committed
153

nominolo@gmail.com's avatar
nominolo@gmail.com committed
154 155
-- Lift a field descriptor storing into an 'a' to a field descriptor storing
-- into a 'b'.
Simon Marlow's avatar
Simon Marlow committed
156 157 158
liftField :: (b -> a) -> (a -> b -> b) -> FieldDescr a -> FieldDescr b
liftField get set (FieldDescr name showF parseF)
 = FieldDescr name (\b -> showF (get b))
nominolo@gmail.com's avatar
nominolo@gmail.com committed
159 160
	(\line str b -> do
	    a <- parseF line str (get b)
Simon Marlow's avatar
Simon Marlow committed
161 162
	    return (set a b))

nominolo@gmail.com's avatar
nominolo@gmail.com committed
163
-- Parser combinator for simple fields.  Takes a field name, a pretty printer,
nominolo@gmail.com's avatar
nominolo@gmail.com committed
164 165
-- a parser function, an accessor, and a setter, returns a FieldDescr over the
-- compoid structure.
Simon Marlow's avatar
Simon Marlow committed
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
simpleField :: String -> (a -> Doc) -> (ReadP a a)
            -> (b -> a) -> (a -> b -> b) -> FieldDescr b
simpleField name showF readF get set
  = liftField get set $ field name showF readF

commaListField :: String -> (a -> Doc) -> (ReadP [a] a)
		 -> (b -> [a]) -> ([a] -> b -> b) -> FieldDescr b
commaListField name showF readF get set = 
  liftField get set $ 
    field name (fsep . punctuate comma . map showF) (parseCommaList readF)

listField :: String -> (a -> Doc) -> (ReadP [a] a)
		 -> (b -> [a]) -> ([a] -> b -> b) -> FieldDescr b
listField name showF readF get set = 
  liftField get set $ 
    field name (fsep . map showF) (parseOptCommaList readF)

optsField :: String -> CompilerFlavor -> (b -> [(CompilerFlavor,[String])]) -> ([(CompilerFlavor,[String])] -> b -> b) -> FieldDescr b
optsField name flavor get set = 
   liftField (fromMaybe [] . lookup flavor . get) 
	     (\opts b -> set (update flavor opts (get b)) b) $
	field name (hsep . map text)
		   (sepBy parseTokenQ' (munch1 isSpace))
  where
        update f opts [] = [(f,opts)]
	update f opts ((f',opts'):rest)
           | f == f'   = (f, opts ++ opts') : rest
           | otherwise = (f',opts') : update f opts rest
simonmar's avatar
simonmar committed
194

195 196 197 198 199 200 201 202
ppFields :: a -> [FieldDescr a] -> Doc
ppFields _ [] = empty
ppFields pkg' ((FieldDescr name getter _):flds) =
     ppField name (getter pkg') $$ ppFields pkg' flds

ppField :: String -> Doc -> Doc
ppField name fielddoc = text name <> colon <+> fielddoc

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221

-- | The type of a function which, given a name-value pair of an
--   unrecognized field, and the current structure being built,
--   decides whether to incorporate the unrecognized field
--   (by returning  Just x, where x is a possibly modified version
--   of the structure being built), or not (by returning Nothing).
type UnrecFieldParser a = (String,String) -> a -> Maybe a

-- | A default unrecognized field parser which simply returns Nothing,
--   i.e. ignores all unrecognized fields, so warnings will be generated.
warnUnrec :: UnrecFieldParser a
warnUnrec _ _ = Nothing

-- | A default unrecognized field parser which silently (i.e. no
--   warnings will be generated) ignores unrecognized fields, by
--   returning the structure being built unmodified.
ignoreUnrec :: UnrecFieldParser a
ignoreUnrec _ x = Just x

222 223
------------------------------------------------------------------------------

nominolo@gmail.com's avatar
nominolo@gmail.com committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
-- The data type for our three syntactic categories 
data Field 
    = F LineNo String String
      -- ^ A regular @<property>: <value>@ field
    | Section LineNo String String [Field]
      -- ^ A section with a name and possible parameter.  The syntactic
      -- structure is:
      -- 
      -- @
      --   <sectionname> <arg> {
      --     <field>*
      --   }
      -- @
    | IfBlock LineNo String [Field] [Field]
      -- ^ A conditional block with an optional else branch:
      --
      -- @
      --  if <condition> {
      --    <field>*
      --  } else {
      --    <field>*
      --  }
Ian Lynagh's avatar
Ian Lynagh committed
246
      -- @
nominolo@gmail.com's avatar
nominolo@gmail.com committed
247 248
      deriving (Show
               ,Eq)   -- for testing
249 250 251 252 253 254

lineNo :: Field -> LineNo
lineNo (F n _ _) = n
lineNo (Section n _ _ _) = n
lineNo (IfBlock n _ _ _) = n

nominolo@gmail.com's avatar
nominolo@gmail.com committed
255
fName :: Field -> String
256
fName (F _ n _) = n
nominolo@gmail.com's avatar
nominolo@gmail.com committed
257
fName (Section _ n _ _) = n
258
fName _ = error "fname: not a field or section"
259

Simon Marlow's avatar
Simon Marlow committed
260
readFields :: String -> ParseResult [Field]
261 262 263 264 265 266 267 268 269 270 271 272
readFields input =
  case [ n | (n,l) <- zip [1..] ls
           , '\xfffd' `elem` l ] of

    (n:_) -> utf8Error n

    []    -> ifelse
         =<< mapM (mkField 0)
         =<< mkTree tokens

  where ls = (lines . normaliseLineEndings) input
        tokens = (concatMap tokeniseLine . trimLines) ls
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300

-- attach line number and determine indentation
trimLines :: [String] -> [(LineNo, Indent, HasTabs, String)]
trimLines ls = [ (lineno, indent, hastabs, (trimTrailing l'))
               | (lineno, l) <- zip [1..] ls
               , let (sps, l') = span isSpace l
                     indent    = length sps
                     hastabs   = '\t' `elem` sps
               , validLine l' ]
  where validLine ('-':'-':_) = False      -- Comment
        validLine []          = False      -- blank line
        validLine _           = True

-- | We parse generically based on indent level and braces '{' '}'. To do that
-- we split into lines and then '{' '}' tokens and other spans within a line.
data Token = 
       -- | The 'Line' token is for bits that /start/ a line, eg:
       --
       -- > "\n  blah blah { blah"
       --
       -- tokenises to:
       -- 
       -- > [Line n 2 False "blah blah", OpenBracket, Span n "blah"]
       --
       -- so lines are the only ones that can have nested layout, since they
       -- have a known indentation level.
       --
       -- eg: we can't have this:
Duncan Coutts's avatar
Duncan Coutts committed
301
       --
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
       -- > if ... {
       -- > } else
       -- >     other
       --
       -- because other cannot nest under else, since else doesn't start a line
       -- so cannot have nested layout. It'd have to be:
       --
       -- > if ... {
       -- > }
       -- >   else
       -- >     other
       --
       -- but that's not so common, people would normally use layout or
       -- brackets not both in a single @if else@ construct.
       -- 
       -- > if ... { foo : bar }
       -- > else
       -- >    other
       -- 
       -- this is ok
       Line LineNo Indent HasTabs String
     | Span LineNo                String  -- ^ span in a line, following brackets
     | OpenBracket LineNo | CloseBracket LineNo

type Indent = Int
type HasTabs = Bool

-- | Tokenise a single line, splitting on '{' '}' and the spans inbetween.
-- Also trims leading & trailing space on those spans within the line.
tokeniseLine :: (LineNo, Indent, HasTabs, String) -> [Token]
tokeniseLine (n0, i, t, l) = case split n0 l of
                            (Span _ l':ss) -> Line n0 i t l' :ss
                            cs              -> cs
  where split _ "" = []
        split n s  = case span (\c -> c /='}' && c /= '{') s of
          ("", '{' : s') ->             OpenBracket  n : split n s'
          (w , '{' : s') -> mkspan n w (OpenBracket  n : split n s')
          ("", '}' : s') ->             CloseBracket n : split n s'
          (w , '}' : s') -> mkspan n w (CloseBracket n : split n s') 
          (w ,        _) -> mkspan n w []

        mkspan n s ss | null s'   =             ss
                      | otherwise = Span n s' : ss
          where s' = trimTrailing (trimLeading s)

trimLeading, trimTrailing :: String -> String
trimLeading  = dropWhile isSpace
trimTrailing = reverse . dropWhile isSpace . reverse


-- | Fix different systems silly line ending conventions
normaliseLineEndings :: String -> String
normaliseLineEndings [] = []
normaliseLineEndings ('\r':'\n':s) = '\n' : normaliseLineEndings s -- windows
normaliseLineEndings ('\r':s)      = '\n' : normaliseLineEndings s -- old osx
normaliseLineEndings (  c :s)      =   c  : normaliseLineEndings s

type SyntaxTree = Tree (LineNo, HasTabs, String)

Duncan Coutts's avatar
Duncan Coutts committed
361
-- | Parse the stream of tokens into a tree of them, based on indent \/ layout
362 363 364 365 366 367 368 369 370 371 372 373 374 375
mkTree :: [Token] -> ParseResult [SyntaxTree]
mkTree toks =
  layout 0 [] toks >>= \(trees, trailing) -> case trailing of
    []               -> return trees
    OpenBracket  n:_ -> syntaxError n "mismatched backets, unexpected {"
    CloseBracket n:_ -> syntaxError n "mismatched backets, unexpected }"
    -- the following two should never happen:
    Span n     l  :_ -> syntaxError n $ "unexpected span: " ++ show l
    Line n _ _ l  :_ -> syntaxError n $ "unexpected line: " ++ show l


-- | Parse the stream of tokens into a tree of them, based on indent
-- This parse state expect to be in a layout context, though possibly
-- nested within a braces context so we may still encounter closing braces.
Duncan Coutts's avatar
Duncan Coutts committed
376
layout :: Indent       -- ^ indent level of the parent\/previous line
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
       -> [SyntaxTree] -- ^ accumulating param, trees in this level
       -> [Token]      -- ^ remaining tokens
       -> ParseResult ([SyntaxTree], [Token])
                       -- ^ collected trees on this level and trailing tokens
layout _ a []                               = return (reverse a, [])
layout i a (s@(Line _ i' _ _):ss) | i' < i  = return (reverse a, s:ss)
layout i a (Line n _ t l:OpenBracket n':ss) = do
    (sub, ss') <- braces n' [] ss
    layout i (Node (n,t,l) sub:a) ss'

layout i a (Span n     l:OpenBracket n':ss) = do
    (sub, ss') <- braces n' [] ss
    layout i (Node (n,False,l) sub:a) ss'

-- look ahead to see if following lines are more indented, giving a sub-tree
layout i a (Line n i' t l:ss) = do
    lookahead <- layout (i'+1) [] ss
    case lookahead of
        ([], _)   -> layout i (Node (n,t,l) [] :a) ss
        (ts, ss') -> layout i (Node (n,t,l) ts :a) ss'

layout _ _ (   OpenBracket  n :_)  = syntaxError n $ "unexpected '{'"
layout _ a (s@(CloseBracket _):ss) = return (reverse a, s:ss)
layout _ _ (   Span n l       : _) = syntaxError n $ "unexpected span: "
                                                  ++ show l

-- | Parse the stream of tokens into a tree of them, based on explicit braces
-- This parse state expects to find a closing bracket.
braces :: LineNo       -- ^ line of the '{', used for error messages
       -> [SyntaxTree] -- ^ accumulating param, trees in this level
       -> [Token]      -- ^ remaining tokens
       -> ParseResult ([SyntaxTree],[Token])
                       -- ^ collected trees on this level and trailing tokens
braces m a (Line n _ t l:OpenBracket n':ss) = do
    (sub, ss') <- braces n' [] ss
    braces m (Node (n,t,l) sub:a) ss'

braces m a (Span n     l:OpenBracket n':ss) = do 
    (sub, ss') <- braces n' [] ss
    braces m (Node (n,False,l) sub:a) ss'

braces m a (Line n i t l:ss) = do
    lookahead <- layout (i+1) [] ss
    case lookahead of
        ([], _)   -> braces m (Node (n,t,l) [] :a) ss
        (ts, ss') -> braces m (Node (n,t,l) ts :a) ss'

braces m a (Span n       l:ss) = braces m (Node (n,False,l) []:a) ss
braces _ a (CloseBracket _:ss) = return (reverse a, ss)
braces n _ []                  = syntaxError n $ "opening brace '{'"
                              ++ "has no matching closing brace '}'"
braces _ _ (OpenBracket  n:_)  = syntaxError n "unexpected '{'"

-- | Convert the parse tree into the Field AST
-- Also check for dodgy uses of tabs in indentation.
mkField :: Int -> SyntaxTree -> ParseResult Field
mkField d (Node (n,t,_) _) | d >= 1 && t = tabsError n
mkField d (Node (n,_,l) ts) = case span (\c -> isAlphaNum c || c == '-') l of
  ([], _)       -> syntaxError n $ "unrecognised field or section: " ++ show l
  (name, rest)  -> case trimLeading rest of
437
    (':':rest') -> do let followingLines = concatMap Tree.flatten ts
438 439 440 441 442 443 444 445 446 447 448 449
                          tabs = not (null [()| (_,True,_) <- followingLines ])
                      if tabs && d >= 1
                        then tabsError n
                        else return $ F n (map toLower name)
                                          (fieldValue rest' followingLines) 
    rest'       -> do ts' <- mapM (mkField (d+1)) ts
                      return (Section n (map toLower name) rest' ts')
    where fieldValue firstLine followingLines =
            let firstLine' = trimLeading firstLine
                followingLines' = map (\(_,_,s) -> stripDot s) followingLines
                allLines | null firstLine' =              followingLines'
                         | otherwise       = firstLine' : followingLines'
450
             in intercalate "\n" allLines
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
          stripDot "." = ""
          stripDot s   = s

-- | Convert if/then/else 'Section's to 'IfBlock's
ifelse :: [Field] -> ParseResult [Field]
ifelse [] = return []
ifelse (Section n "if"   cond thenpart
       :Section _ "else" as   elsepart:fs)
       | null cond     = syntaxError n "'if' with missing condition"
       | null thenpart = syntaxError n "'then' branch of 'if' is empty"
       | not (null as) = syntaxError n "'else' takes no arguments"
       | null elsepart = syntaxError n "'else' branch of 'if' is empty"
       | otherwise     = do tp  <- ifelse thenpart
                            ep  <- ifelse elsepart
                            fs' <- ifelse fs
                            return (IfBlock n cond tp ep:fs')
ifelse (Section n "if"   cond thenpart:fs)
       | null cond     = syntaxError n "'if' with missing condition"
       | null thenpart = syntaxError n "'then' branch of 'if' is empty"
       | otherwise     = do tp  <- ifelse thenpart
                            fs' <- ifelse fs
                            return (IfBlock n cond tp []:fs')
ifelse (Section n "else" _ _:_) = syntaxError n "stray 'else' with no preceding 'if'"
ifelse (Section n s a fs':fs) = do fs''  <- ifelse fs'
                                   fs''' <- ifelse fs
                                   return (Section n s a fs'' : fs''')
ifelse (f:fs) = do fs' <- ifelse fs 
                   return (f : fs')
479 480

------------------------------------------------------------------------------
simonmar's avatar
simonmar committed
481 482

-- |parse a module name
483
parseModuleNameQ :: ReadP r String
ijones's avatar
ijones committed
484 485
parseModuleNameQ = parseQuoted modu <++ modu
 where modu = do 
486 487 488
	  c <- satisfy isUpper
	  cs <- munch (\x -> isAlphaNum x || x `elem` "_'.")
	  return (c:cs)
simonmar's avatar
simonmar committed
489

490
parseFilePathQ :: ReadP r FilePath
491 492 493
parseFilePathQ = parseTokenQ 
  -- removed until normalise is no longer broken, was:
  --   liftM normalise parseTokenQ
simonmar's avatar
simonmar committed
494 495 496 497

parseReadS :: Read a => ReadP r a
parseReadS = readS_to_P reads

498 499 500 501
parseBool :: ReadP r Bool
parseBool = choice [ (string "true" <++ string "True") >> return True
                   , (string "false" <++ string "False") >> return False ]

502 503 504 505 506 507 508 509 510 511 512 513 514
parseBuildTool :: ReadP r Dependency
parseBuildTool = do name <- parseBuildToolNameQ
                    skipSpaces
                    ver <- parseVersionRangeQ <++ return AnyVersion
                    skipSpaces
                    return $ Dependency name ver

parseBuildToolNameQ :: ReadP r String
parseBuildToolNameQ = parseQuoted parseBuildToolName <++ parseBuildToolName

-- like parsePackageName but accepts symbols in components
parseBuildToolName :: ReadP r String
parseBuildToolName = do ns <- sepBy1 component (ReadP.char '-')
515
                        return (intercalate "-" ns)
516 517 518 519
  where component = do
          cs <- munch1 (\c -> isAlphaNum c || isSymbol c && c /= '-')
          if all isDigit cs then pfail else return cs

520 521 522 523 524 525 526 527 528 529
-- pkg-config allows versions and other letters in package names, 
-- eg "gtk+-2.0" is a valid pkg-config package _name_.
-- It then has a package version number like 2.10.13
parsePkgconfigDependency :: ReadP r Dependency
parsePkgconfigDependency = do name <- munch1 (\c -> isAlphaNum c || c `elem` "+-._")
                              skipSpaces
                              ver <- parseVersionRangeQ <++ return AnyVersion
                              skipSpaces
                              return $ Dependency name ver

ijones's avatar
ijones committed
530
parsePackageNameQ :: ReadP r String
531
parsePackageNameQ = parseQuoted parsePackageName <++ parsePackageName 
ijones's avatar
ijones committed
532 533

parseVersionRangeQ :: ReadP r VersionRange
534 535
parseVersionRangeQ = parseQuoted parseVersionRange <++ parseVersionRange

simonmar's avatar
simonmar committed
536
parseOptVersion :: ReadP r Version
537 538 539 540 541 542 543 544 545 546 547
parseOptVersion = parseQuoted ver <++ ver
  where ver = parseVersion <++ return noVersion
	noVersion = Version{ versionBranch=[], versionTags=[] }

parseTestedWithQ :: ReadP r (CompilerFlavor,VersionRange)
parseTestedWithQ = parseQuoted tw <++ tw
  where tw = do compiler <- parseReadS
		skipSpaces
		version <- parseVersionRange <++ return AnyVersion
		skipSpaces
		return (compiler,version)
simonmar's avatar
simonmar committed
548

549 550
parseLicenseQ :: ReadP r License
parseLicenseQ = parseQuoted parseReadS <++ parseReadS
simonmar's avatar
simonmar committed
551

552 553 554 555
-- urgh, we can't define optQuotes :: ReadP r a -> ReadP r a
-- because the "compat" version of ReadP isn't quite powerful enough.  In
-- particular, the type of <++ is ReadP r r -> ReadP r a -> ReadP r a
-- Hence the trick above to make 'lic' polymorphic.
simonmar's avatar
simonmar committed
556

557 558
parseExtensionQ :: ReadP r Extension
parseExtensionQ = parseQuoted parseReadS <++ parseReadS
simonmar's avatar
simonmar committed
559

560 561 562 563
-- | Parse something optionally wrapped in quotes.
parseReadSQ :: Read a => ReadP r a
parseReadSQ = parseQuoted parseReadS <++ parseReadS

ijones's avatar
ijones committed
564 565
parseTokenQ :: ReadP r String
parseTokenQ = parseReadS <++ munch1 (\x -> not (isSpace x) && x /= ',')
simonmar's avatar
simonmar committed
566

Simon Marlow's avatar
Simon Marlow committed
567 568 569 570 571 572 573 574 575
parseTokenQ' :: ReadP r String
parseTokenQ' = parseReadS <++ munch1 (\x -> not (isSpace x))

parseSepList :: ReadP r b
	     -> ReadP r a -- ^The parser for the stuff between commas
             -> ReadP r [a]
parseSepList sepr p = sepBy p separator
    where separator = skipSpaces >> sepr >> skipSpaces

simonmar's avatar
simonmar committed
576 577
parseCommaList :: ReadP r a -- ^The parser for the stuff between commas
               -> ReadP r [a]
Simon Marlow's avatar
Simon Marlow committed
578
parseCommaList = parseSepList (ReadP.char ',')
simonmar's avatar
simonmar committed
579

ijones's avatar
ijones committed
580
parseOptCommaList :: ReadP r a -- ^The parser for the stuff between commas
Simon Marlow's avatar
Simon Marlow committed
581 582
                  -> ReadP r [a]
parseOptCommaList = parseSepList (optional (ReadP.char ','))
ijones's avatar
ijones committed
583

584 585 586
parseQuoted :: ReadP r a -> ReadP r a
parseQuoted p = between (ReadP.char '"') (ReadP.char '"') p

simonmar's avatar
simonmar committed
587 588 589 590
-- --------------------------------------------
-- ** Pretty printing

showFilePath :: FilePath -> Doc
ijones's avatar
ijones committed
591 592 593 594
showFilePath = showToken

showToken :: String -> Doc
showToken str
595 596
 | not (any dodgy str) &&
   not (null str)       = text str
ijones's avatar
ijones committed
597 598
 | otherwise            = text (show str)
  where dodgy c = isSpace c || c == ','
simonmar's avatar
simonmar committed
599 600 601 602

showTestedWith :: (CompilerFlavor,VersionRange) -> Doc
showTestedWith (compiler,version) = text (show compiler ++ " " ++ showVersionRange version)

603 604 605 606
-- | Pretty-print free-format text, ensuring that it is vertically aligned,
-- and with blank lines replaced by dots for correct re-parsing.
showFreeText :: String -> Doc
showFreeText s = vcat [text (if null l then "." else l) | l <- lines s]