Rakka/Wiki/Parser.hs

   1 module Rakka.Wiki.Parser
   2     ( CommandTypeOf
   3     , wikiPage
   4     )
   5     where
   6
   7 import           Data.Maybe
   8 import           Network.URI
   9 import           Rakka.Wiki
  10 import           Text.ParserCombinators.Parsec
  11
  12
  13 type CommandTypeOf = String -> Maybe CommandType
  14
  15
  16 wikiPage :: CommandTypeOf -> Parser WikiPage
  17 wikiPage cmdTypeOf
  18     = do xs <- many (blockElement cmdTypeOf)
  19          skipMany ( comment
  20                     <|>
  21                     (newline >> return ())
  22                   )
  23          eof
  24          return xs
  25
  26
  27 blockElement :: CommandTypeOf -> Parser BlockElement
  28 blockElement cmdTypeOf
  29     = try $ do skipMany ( comment
  30                           <|>
  31                           (newline >> return ())
  32                         )
  33                foldr (<|>) pzero [ heading
  34                                  , horizontalLine
  35                                  , listElement cmdTypeOf
  36                                  , definitionList cmdTypeOf
  37                                  , pdata
  38                                  , leadingSpaced cmdTypeOf
  39                                  , paragraph cmdTypeOf
  40                                  , blockCmd cmdTypeOf
  41                                  ]
  42
  43
  44 heading :: Parser BlockElement
  45 heading = foldr (<|>) pzero (map heading' [1..5])
  46           <?>
  47           "heading"
  48     where
  49       heading' :: Int -> Parser BlockElement
  50       heading' n = do try $ do count n (char '=')
  51                                notFollowedBy (char '=')
  52                       ws
  53                       x  <- notFollowedBy (char '=') >> anyChar
  54                       xs <- manyTill anyChar (try $ ws >> ( count n (char '=')
  55                                                             <?>
  56                                                             ("trailing " ++ take n (repeat '='))
  57                                                           )
  58                                              )
  59                       ws
  60                       eol
  61                       return (Heading n (x:xs))
  62
  63
  64 horizontalLine :: Parser BlockElement
  65 horizontalLine = try ( do count 4 (char '-')
  66                           many (char '-')
  67                           ws
  68                           eol
  69                           return HorizontalLine
  70                      )
  71                  <?>
  72                  "horizontal line"
  73
  74
  75 listElement :: CommandTypeOf -> Parser BlockElement
  76 listElement cmdTypeOf = listElement' [] >>= return . List
  77     where
  78       listElement' :: [Char] -> Parser ListElement
  79       listElement' stack
  80           = do t  <- oneOf "*#"
  81                ws
  82                xs <- items (stack ++ [t])
  83                return (ListElement (toType t) xs)
  84
  85       -- ListItem の終了條件は、
  86       items :: [Char] -> Parser [ListItem]
  87       items stack = do xs     <- many1 $ inlineElement cmdTypeOf
  88                        nested <- option Nothing
  89                                  $ try $ do skipMany comment
  90                                             newline
  91                                             string stack
  92                                             listElement' stack >>= return . Just
  93                        rest <- items stack
  94                        return $ (map Right xs ++ map Left (catMaybes [nested])) : rest
  95                     <|>
  96                     (try $ do skipMany comment
  97                               newline
  98                               string stack
  99                               ws
 100                               items stack
 101                     )
 102                     <|>
 103                     return []
 104
 105       toType :: Char -> ListType
 106       toType '*' = Bullet
 107       toType '#' = Numbered
 108
 109
 110 definitionList :: CommandTypeOf -> Parser BlockElement
 111 definitionList cmdTypeOf = many1 definition >>= return . DefinitionList
 112     where
 113       definition :: Parser Definition
 114       definition = do char ';'
 115                       ws
 116                       tHead <- inlineElement cmdTypeOf
 117                       tRest <- term
 118                       d     <- description
 119                       return (Definition (tHead:tRest) d)
 120                    <?>
 121                    "definition list"
 122
 123       term :: Parser [InlineElement]
 124       term = (char ':' >> ws >> return [])
 125              <|>
 126              (newline >> char ':' >> ws >> return [])
 127              <|>
 128              do x  <- inlineElement cmdTypeOf
 129                 xs <- term
 130                 return (x:xs)
 131              <?>
 132              "term to be defined"
 133
 134       description :: Parser [InlineElement]
 135       description = do x  <- inlineElement cmdTypeOf
 136                        xs <- description
 137                        return (x:xs)
 138                     <|>
 139                     try ( do newline
 140                              char ':'
 141                              ws
 142                              xs <- description
 143                              return (Text "\n" : xs)
 144                         )
 145                     <|>
 146                     (newline >> return [])
 147                     <|>
 148                     (eof >> return [])
 149                     <?>
 150                     "description of term"
 151
 152
 153 pdata :: Parser BlockElement
 154 pdata = do try (string "<![PDATA[")
 155            many (oneOf " \t\n")
 156            x <- pdata'
 157            return (Preformatted [Text x])
 158     where
 159       pdata' :: Parser String
 160       pdata' = do try (many (oneOf " \t\n") >> string "]]>")
 161                   return []
 162                <|>
 163                do x  <- anyChar
 164                   xs <- pdata'
 165                   return (x:xs)
 166
 167
 168 leadingSpaced :: CommandTypeOf -> Parser BlockElement
 169 leadingSpaced cmdTypeOf = (char ' ' >> leadingSpaced' >>= return . Preformatted)
 170                           <?>
 171                           "leading space"
 172     where
 173       leadingSpaced' :: Parser [InlineElement]
 174       leadingSpaced' = do x  <- inlineElement cmdTypeOf
 175                           xs <- leadingSpaced'
 176                           return (x:xs)
 177                        <|>
 178                        try ( newline
 179                              >>
 180                              char ' '
 181                              >>
 182                              leadingSpaced'
 183                              >>=
 184                              return . (Text "\n" :)
 185                            )
 186                        <|>
 187                        return []
 188
 189
 190 blockCommand :: Parser BlockElement
 191 blockCommand = pzero -- not implemented
 192
 193
 194 paragraph :: CommandTypeOf -> Parser BlockElement
 195 paragraph cmdTypeOf = paragraph' >>= return . Paragraph
 196     where
 197       paragraph' :: Parser [InlineElement]
 198       paragraph' = do x  <- inlineElement cmdTypeOf
 199                       xs <- try ( do newline
 200                                      eof
 201                                      return []
 202                                   -- \n で文字列が終はってゐたら、ここ
 203                                   -- で終了。
 204                                 )
 205                             <|>
 206                             try ( do newline
 207                                      ((oneOf ('\n':blockSymbols) >> pzero) <|> return ())
 208                                      ys <- (paragraph' <|> return [])
 209                                      return (Text "\n" : ys)
 210                                   -- \n があり、その次に \n または
 211                                   -- blockSymbols があれば、fail して
 212                                   -- 最初の newline を讀んだ所まで卷き
 213                                   -- 戻す。
 214                                 )
 215                             <|>
 216                             paragraph'
 217                             -- それ以外の場合は次の inlineElement から
 218                             -- を讀んで見る。但し一つも無くても良い。
 219                             <|>
 220                             return [] -- 全部失敗したらここで終了。
 221                       return (x:xs)
 222
 223
 224 blockCmd :: CommandTypeOf -> Parser BlockElement
 225 blockCmd cmdTypeOf
 226     = (try $ do (tagName, tagAttrs) <- openTag
 227                 case cmdTypeOf tagName of
 228                   Just BlockCommandType
 229                       -> do xs <- contents
 230                             closeTag tagName
 231                             return $ BlockCmd $ BlockCommand {
 232                                          bCmdName       = tagName
 233                                        , bCmdAttributes = tagAttrs
 234                                        , bCmdContents   = xs
 235                                        }
 236
 237                   Just InlineCommandType
 238                       -> pzero
 239
 240                   _   -> return $ undefinedCmdErr tagName
 241       )
 242       <|>
 243       (try $ do (tagName, tagAttrs) <- emptyTag
 244                 case cmdTypeOf tagName of
 245                   Just BlockCommandType
 246                       -> return $ BlockCmd $ BlockCommand {
 247                                          bCmdName       = tagName
 248                                        , bCmdAttributes = tagAttrs
 249                                        , bCmdContents   = []
 250                                        }
 251
 252                   Just InlineCommandType
 253                       -> pzero
 254
 255                   _   -> return $ undefinedCmdErr tagName
 256       )
 257       <?>
 258       "block command"
 259     where
 260       contents :: Parser [BlockElement]
 261       contents = do x  <- blockElement cmdTypeOf
 262                     xs <- contents
 263                     return (x:xs)
 264                  <|>
 265                  (newline >> contents)
 266                  <|>
 267                  (comment >> contents)
 268                  <|>
 269                  return []
 270
 271       undefinedCmdErr :: String -> BlockElement
 272       undefinedCmdErr name
 273           = Div [("class", "error")]
 274             [ Paragraph [Text ("The command `" ++ name ++ "' is not defined. " ++
 275                                "Ensure that you haven't mistyped and the module " ++
 276                                "providing the command is actually loaded.")
 277                         ]
 278             ]
 279
 280
 281 inlineElement :: CommandTypeOf -> Parser InlineElement
 282 inlineElement cmdTypeOf
 283     = try $ do skipMany comment
 284                foldr (<|>) pzero [ cdata
 285                                  , apostrophes cmdTypeOf
 286                                  , text
 287                                  , pageLink
 288                                  , extLink
 289                                  , inlineCmd cmdTypeOf
 290                                  ]
 291
 292
 293 cdata :: Parser InlineElement
 294 cdata = try (string "<![CDATA[") >> cdata' >>= return . Text
 295     where
 296       cdata' :: Parser String
 297       cdata' = do try (string "]]>")
 298                   return []
 299                <|>
 300                do x  <- anyChar
 301                   xs <- cdata'
 302                   return (x:xs)
 303
 304
 305 text :: Parser InlineElement
 306 text = ( char ':'
 307          >>
 308          many (noneOf ('\n':inlineSymbols))
 309          >>=
 310          return . Text . (':' :)
 311          -- 定義リストとの關係上、コロンは先頭にしか來れない。
 312        )
 313        <|>
 314        ( many1 (noneOf ('\n':inlineSymbols))
 315          >>=
 316          return . Text
 317        )
 318        <?>
 319        "text"
 320
 321
 322 apostrophes :: CommandTypeOf -> Parser InlineElement
 323 apostrophes cmdTypeOf = foldr (<|>) pzero (map try [apos1, apos2, apos3, apos4, apos5])
 324     where
 325       apos1 = apos 1 >> return (Text "'")
 326
 327       apos2 = do apos 2
 328                  xs <- many1 $ inlineElement cmdTypeOf
 329                  apos 2
 330                  return (Italic xs)
 331
 332       apos3 = do apos 3
 333                  xs <- many1 $ inlineElement cmdTypeOf
 334                  apos 3
 335                  return (Bold xs)
 336
 337       apos4 = apos 4 >> return (Text "'")
 338
 339       apos5 = do apos 5
 340                  xs <- many1 $ inlineElement cmdTypeOf
 341                  apos 5
 342                  return (Italic [Bold xs])
 343
 344       apos :: Int -> Parser ()
 345       apos n = count n (char '\'') >> notFollowedBy (char '\'')
 346
 347
 348 pageLink :: Parser InlineElement
 349 pageLink = do try (string "[[")
 350               page     <- option Nothing
 351                           (many1 (noneOf "#|]") >>= return . Just)
 352               fragment <- option Nothing
 353                           (char '#' >> many1 (noneOf "|]") >>= return . Just)
 354               text     <- option Nothing
 355                           (char '|' >> many1 (satisfy (/= ']')) >>= return . Just)
 356
 357               case (page, fragment) of
 358                 (Nothing, Nothing) -> pzero
 359                 (_, _)             -> return ()
 360
 361               string "]]"
 362               return $ PageLink page fragment text
 363            <?>
 364            "page link"
 365
 366
 367 extLink :: Parser InlineElement
 368 extLink = do char '['
 369              uriStr <- many1 (noneOf " \t]")
 370              skipMany (oneOf " \t")
 371              text <- option Nothing
 372                      (many1 (noneOf "]") >>= return . Just)
 373
 374              case parseURI uriStr of
 375                Just uri -> char ']' >> return (ExternalLink uri text)
 376                Nothing  -> pzero <?> "absolute URI"
 377           <?>
 378           "external link"
 379
 380
 381 inlineCmd :: CommandTypeOf -> Parser InlineElement
 382 inlineCmd cmdTypeOf
 383     = (try $ do (tagName, tagAttrs) <- openTag
 384                 case cmdTypeOf tagName of
 385                   Just InlineCommandType
 386                       -> do xs <- contents
 387                             closeTag tagName
 388                             return $ InlineCmd $ InlineCommand {
 389                                          iCmdName       = tagName
 390                                        , iCmdAttributes = tagAttrs
 391                                        , iCmdContents   = xs
 392                                        }
 393                   _   -> pzero
 394       )
 395       <|>
 396       (try $ do (tagName, tagAttrs) <- emptyTag
 397                 case cmdTypeOf tagName of
 398                   Just InlineCommandType
 399                       -> return $ InlineCmd $ InlineCommand {
 400                                          iCmdName       = tagName
 401                                        , iCmdAttributes = tagAttrs
 402                                        , iCmdContents   = []
 403                                        }
 404                   _   -> pzero
 405       )
 406       <?>
 407       "inline command"
 408     where
 409       contents :: Parser [InlineElement]
 410       contents = do x  <- inlineElement cmdTypeOf
 411                     xs <- contents
 412                     return (x:xs)
 413                  <|>
 414                  (comment >> contents)
 415                  <|>
 416                  (newline >> contents >>= return . (Text "\n" :))
 417                  <|>
 418                  return []
 419
 420
 421 openTag :: Parser (String, [Attribute])
 422 openTag = try $ do char '<'
 423                    many space
 424                    name  <- many1 letter
 425                    many space
 426                    attrs <- many $ do attr <- tagAttr
 427                                       many space
 428                                       return attr
 429                    char '>'
 430                    return (name, attrs)
 431
 432
 433 emptyTag :: Parser (String, [Attribute])
 434 emptyTag = try $ do char '<'
 435                     many space
 436                     name  <- many1 letter
 437                     many space
 438                     attrs <- many $ do attr <- tagAttr
 439                                        many space
 440                                        return attr
 441                     char '/'
 442                     many space
 443                     char '>'
 444                     return (name, attrs)
 445
 446
 447 closeTag :: String -> Parser ()
 448 closeTag name = try $ do char '<'
 449                          many space
 450                          char '/'
 451                          many space
 452                          string name
 453                          many space
 454                          char '>'
 455                          return ()
 456
 457
 458 tagAttr :: Parser (String, String)
 459 tagAttr = do name  <- many1 letter
 460              char '='
 461              char '"'
 462              value <- many (satisfy (/= '"'))
 463              char '"'
 464              return (name, value)
 465
 466
 467 comment :: Parser ()
 468 comment = (try (string "<!--") >> skipTillEnd 1)
 469           <?>
 470           "comment"
 471     where
 472       skipTillEnd :: Int -> Parser ()
 473       skipTillEnd level = ( (try (string "<!--") >> skipTillEnd (level + 1))
 474                             <|>
 475                             (try (string "-->") >> case level of
 476                                                      1 -> return ()
 477                                                      n -> skipTillEnd (n - 1))
 478                             <|>
 479                             (anyChar >> skipTillEnd level)
 480                           )
 481
 482
 483 blockSymbols :: [Char]
 484 blockSymbols = " =-*#;<"
 485
 486
 487 inlineSymbols :: [Char]
 488 inlineSymbols = "<[:'"
 489
 490 -- white space
 491 ws :: Parser ()
 492 ws = skipMany ( (oneOf " \t" >> return ())
 493                 <|>
 494                 comment
 495               )
 496
 497 -- end of line
 498 eol :: Parser ()
 499 eol = ( (newline >> return ())
 500         <|>
 501         eof
 502       )