X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Fparser%2FHaddockUtils.hs;h=70a5da25fe44a2df83156c4934c8dc013c46c718;hp=0275e799003f7dd0ff0760d647f5ee6d86ea5fde;hb=83adb5d625b3821ff3bd29596437a780db8fa98f;hpb=91c489b865e64bcdc48e024f675fe2bb1412889f diff --git a/compiler/parser/HaddockUtils.hs b/compiler/parser/HaddockUtils.hs index 0275e79..70a5da2 100644 --- a/compiler/parser/HaddockUtils.hs +++ b/compiler/parser/HaddockUtils.hs @@ -1,9 +1,3 @@ -{-# OPTIONS -w #-} --- The above warning supression flag is a temporary kludge. --- While working on this module you are encouraged to remove it and fix --- any warnings in the module. See --- http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings --- for details module HaddockUtils where @@ -25,45 +19,45 @@ import Data.Either -- NB. The headers must be given in the order Module, Description, -- Copyright, License, Maintainer, Stability, Portability, except that -- any or all may be omitted. -parseModuleHeader :: String -> Either String (String, HaddockModInfo RdrName) -parseModuleHeader str0 = - let - getKey :: String -> String -> (Maybe String,String) - getKey key str = case parseKey key str of - Nothing -> (Nothing,str) - Just (value,rest) -> (Just value,rest) - - (moduleOpt,str1) = getKey "Module" str0 - (descriptionOpt,str2) = getKey "Description" str1 - (copyrightOpt,str3) = getKey "Copyright" str2 - (licenseOpt,str4) = getKey "License" str3 - (licenceOpt,str5) = getKey "Licence" str4 - (maintainerOpt,str6) = getKey "Maintainer" str5 - (stabilityOpt,str7) = getKey "Stability" str6 - (portabilityOpt,str8) = getKey "Portability" str7 - - description1 :: Either String (Maybe (HsDoc RdrName)) - description1 = case descriptionOpt of - Nothing -> Right Nothing - Just description -> case parseHaddockString . tokenise $ description of - - MyLeft mess -> Left ("Cannot parse Description: " ++ mess) - MyRight doc -> Right (Just doc) - in - case description1 of - Left mess -> Left mess - Right docOpt -> Right (str8,HaddockModInfo { - hmi_description = docOpt, - hmi_portability = portabilityOpt, - hmi_stability = stabilityOpt, - hmi_maintainer = maintainerOpt +parseModuleHeader :: String -> Either String (String, HaddockModInfo RdrName) +parseModuleHeader str0 = + let + getKey :: String -> String -> (Maybe String,String) + getKey key str = case parseKey key str of + Nothing -> (Nothing,str) + Just (value,rest) -> (Just value,rest) + + (_moduleOpt,str1) = getKey "Module" str0 + (descriptionOpt,str2) = getKey "Description" str1 + (_copyrightOpt,str3) = getKey "Copyright" str2 + (_licenseOpt,str4) = getKey "License" str3 + (_licenceOpt,str5) = getKey "Licence" str4 + (maintainerOpt,str6) = getKey "Maintainer" str5 + (stabilityOpt,str7) = getKey "Stability" str6 + (portabilityOpt,str8) = getKey "Portability" str7 + + description1 :: Either String (Maybe (HsDoc RdrName)) + description1 = case descriptionOpt of + Nothing -> Right Nothing + Just description -> case parseHaddockString . tokenise $ description of + + MyLeft mess -> Left ("Cannot parse Description: " ++ mess) + MyRight doc -> Right (Just doc) + in + case description1 of + Left mess -> Left mess + Right docOpt -> Right (str8,HaddockModInfo { + hmi_description = docOpt, + hmi_portability = portabilityOpt, + hmi_stability = stabilityOpt, + hmi_maintainer = maintainerOpt }) -- | This function is how we read keys. -- -- all fields in the header are optional and have the form -- --- [spaces1][field name][spaces] ":" +-- [spaces1][field name][spaces] ":" -- [text]"\n" ([spaces2][space][text]"\n" | [spaces]"\n")* -- where each [spaces2] should have [spaces1] as a prefix. -- @@ -75,7 +69,7 @@ parseModuleHeader str0 = -- > description -- > -- > The module comment starts here --- +-- -- the value will be "this is a .. description" and the rest will begin -- at "The module comment". parseKey :: String -> String -> Maybe (String,String) @@ -97,7 +91,7 @@ parseKey key toParse0 = return (scanKey True indentation afterColon1) where scanKey :: Bool -> String -> String -> (String,String) - scanKey isFirst indentation [] = ([],[]) + scanKey _ _ [] = ([],[]) scanKey isFirst indentation str = let (nextLine,rest1) = extractNextLine str @@ -112,12 +106,12 @@ parseKey key toParse0 = (_,[]) -> True _ -> False in - if accept + if accept then let (scanned1,rest2) = scanKey False indentation rest1 - scanned2 = case scanned1 of + scanned2 = case scanned1 of "" -> if allSpaces then "" else nextLine _ -> nextLine ++ "\n" ++ scanned1 in @@ -127,8 +121,8 @@ parseKey key toParse0 = extractLeadingSpaces :: String -> (String,String) extractLeadingSpaces [] = ([],[]) - extractLeadingSpaces (s@(c:cs)) - | isSpace c = + extractLeadingSpaces (s@(c:cs)) + | isSpace c = let (spaces1,cs1) = extractLeadingSpaces cs in @@ -137,7 +131,7 @@ parseKey key toParse0 = extractNextLine :: String -> (String,String) extractNextLine [] = ([],[]) - extractNextLine (c:cs) + extractNextLine (c:cs) | c == '\n' = ([],cs) | True = @@ -145,11 +139,11 @@ parseKey key toParse0 = (line,rest) = extractNextLine cs in (c:line,rest) - + -- comparison is case-insensitive. extractPrefix :: String -> String -> Maybe String extractPrefix [] s = Just s - extractPrefix s [] = Nothing + extractPrefix _ [] = Nothing extractPrefix (c1:cs1) (c2:cs2) | toUpper c1 == toUpper c2 = extractPrefix cs1 cs2 | True = Nothing