{- This module was generated from data in the Kate syntax highlighting file javadoc.xml, version 1.04, by Alfredo Luiz Foltran Fialho (alfoltran@ig.com.br) -} module Text.Highlighting.Kate.Syntax.Javadoc ( highlight, parseExpression, syntaxName, syntaxExtensions ) where import Text.Highlighting.Kate.Definitions import Text.Highlighting.Kate.Common import qualified Text.Highlighting.Kate.Syntax.Html import Text.ParserCombinators.Parsec import Control.Monad (when) import Data.Map (fromList) import Data.Maybe (fromMaybe, maybeToList) -- | Full name of language. syntaxName :: String syntaxName = "Javadoc" -- | Filename extensions for this language. syntaxExtensions :: String syntaxExtensions = "" -- | Highlight source code using this syntax definition. highlight :: String -> Either String [SourceLine] highlight input = case runParser parseSource startingState "source" input of Left err -> Left $ show err Right result -> Right result -- | Parse an expression using appropriate local context. parseExpression :: GenParser Char SyntaxState LabeledSource parseExpression = do st <- getState let oldLang = synStLanguage st setState $ st { synStLanguage = "Javadoc" } context <- currentContext <|> (pushContext "Start" >> currentContext) result <- parseRules context updateState $ \st -> st { synStLanguage = oldLang } return result parseSource = do lineContents <- lookAhead wholeLine updateState $ \st -> st { synStCurrentLine = lineContents } result <- manyTill parseSourceLine eof return $ map normalizeHighlighting result startingState = SyntaxState {synStContexts = fromList [("Javadoc",["Start"])], synStLanguage = "Javadoc", synStCurrentLine = "", synStCharsParsedInLine = 0, synStPrevChar = '\n', synStCaseSensitive = True, synStKeywordCaseSensitive = True, synStCaptures = []} parseSourceLine = manyTill parseExpressionInternal pEndLine pEndLine = do lookAhead $ newline <|> (eof >> return '\n') context <- currentContext case context of "Start" -> return () >> pHandleEndLine "FindJavadoc" -> return () >> pHandleEndLine "JavadocFSar" -> return () >> pHandleEndLine "Javadocar" -> return () >> pHandleEndLine "JavadocParam" -> (popContext) >> pEndLine "InlineTagar" -> return () >> pHandleEndLine "LiteralTagar" -> return () >> pHandleEndLine "SeeTag" -> (popContext) >> pEndLine _ -> pHandleEndLine withAttribute attr txt = do when (null txt) $ fail "Parser matched no text" let labs = attr : maybeToList (lookup attr styles) st <- getState let oldCharsParsed = synStCharsParsedInLine st let prevchar = if null txt then '\n' else last txt updateState $ \st -> st { synStCharsParsedInLine = oldCharsParsed + length txt, synStPrevChar = prevchar } return (labs, txt) styles = [("BlockTag","kw"),("InlineTag","kw"),("JavadocParam","kw"),("SeeTag","kw"),("JavadocFS","co"),("Javadoc","co")] parseExpressionInternal = do context <- currentContext parseRules context <|> (pDefault >>= withAttribute (fromMaybe "" $ lookup context defaultAttributes)) regex_'28'21'7c'5c'3f'29 = compileRegex "(!|\\?)" regex_'28'5c'2e'5cs'2a'24'29 = compileRegex "(\\.\\s*$)" regex_'28'5c'2e'5cs'29'28'3f'21'5b'5cda'2dz'5d'29 = compileRegex "(\\.\\s)(?![\\da-z])" regex_'5c'2a'2a'5cs'2a'28'3f'3d'40'28author'7cdeprecated'7cexception'7cparam'7creturn'7csee'7cserial'7cserialData'7cserialField'7csince'7cthrows'7cversion'29'28'5cs'7c'24'29'29 = compileRegex "\\**\\s*(?=@(author|deprecated|exception|param|return|see|serial|serialData|serialField|since|throws|version)(\\s|$))" regex_'5c'2a'2b'28'3f'21'2f'29 = compileRegex "\\*+(?!/)" regex_'5cS'2a'28'3f'3d'5c'2a'2f'29 = compileRegex "\\S*(?=\\*/)" regex_'5cS'2a'28'5cs'7c'24'29 = compileRegex "\\S*(\\s|$)" defaultAttributes = [("Start","Normal Text"),("FindJavadoc","Normal Text"),("JavadocFSar","JavadocFS"),("Javadocar","Javadoc"),("JavadocParam","Javadoc"),("InlineTagar","InlineTag"),("LiteralTagar","InlineTag"),("SeeTag","SeeTag")] parseRules "Start" = do (attr, result) <- ((parseRules "FindJavadoc")) return (attr, result) parseRules "FindJavadoc" = do (attr, result) <- (((pString False "/**/" >>= withAttribute "JavadocFS")) <|> ((pString False "/**" >>= withAttribute "JavadocFS") >>~ pushContext "JavadocFSar")) return (attr, result) parseRules "JavadocFSar" = do (attr, result) <- (((pDetect2Chars False '*' '/' >>= withAttribute "JavadocFS") >>~ (popContext)) <|> ((pRegExpr regex_'28'21'7c'5c'3f'29 >>= withAttribute "JavadocFS") >>~ pushContext "Javadocar") <|> ((pRegExpr regex_'28'5c'2e'5cs'2a'24'29 >>= withAttribute "JavadocFS") >>~ pushContext "Javadocar") <|> ((pRegExpr regex_'28'5c'2e'5cs'29'28'3f'21'5b'5cda'2dz'5d'29 >>= withAttribute "JavadocFS") >>~ pushContext "Javadocar") <|> ((pFirstNonSpace >> pRegExpr regex_'5c'2a'2a'5cs'2a'28'3f'3d'40'28author'7cdeprecated'7cexception'7cparam'7creturn'7csee'7cserial'7cserialData'7cserialField'7csince'7cthrows'7cversion'29'28'5cs'7c'24'29'29 >>= withAttribute "JavadocFS") >>~ pushContext "Javadocar") <|> ((pString False "{@code " >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@code\t" >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@docRoot}" >>= withAttribute "InlineTag")) <|> ((pString False "{@inheritDoc}" >>= withAttribute "InlineTag")) <|> ((pString False "{@link " >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@link\t" >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@linkplain " >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@linkplain\t" >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@literal " >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@literal\t" >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@value}" >>= withAttribute "InlineTag")) <|> ((pString False "{@value " >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@value\t" >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((Text.Highlighting.Kate.Syntax.Html.parseExpression))) return (attr, result) parseRules "Javadocar" = do (attr, result) <- (((pDetect2Chars False '*' '/' >>= withAttribute "JavadocFS") >>~ (popContext >> popContext)) <|> ((pFirstNonSpace >> pRegExpr regex_'5c'2a'2b'28'3f'21'2f'29 >>= withAttribute "JavadocFS")) <|> ((pString False "@author " >>= withAttribute "BlockTag")) <|> ((pString False "@deprecated " >>= withAttribute "BlockTag")) <|> ((pString False "@exception " >>= withAttribute "BlockTag") >>~ pushContext "JavadocParam") <|> ((pString False "@param " >>= withAttribute "BlockTag") >>~ pushContext "JavadocParam") <|> ((pString False "@return " >>= withAttribute "BlockTag")) <|> ((pString False "@see " >>= withAttribute "BlockTag") >>~ pushContext "SeeTag") <|> ((pString False "@serial " >>= withAttribute "BlockTag")) <|> ((pString False "@serialData " >>= withAttribute "BlockTag")) <|> ((pString False "@serialField " >>= withAttribute "BlockTag")) <|> ((pString False "@since " >>= withAttribute "BlockTag")) <|> ((pString False "@throws " >>= withAttribute "BlockTag") >>~ pushContext "JavadocParam") <|> ((pString False "@version " >>= withAttribute "BlockTag")) <|> ((pString False "@author\t" >>= withAttribute "BlockTag")) <|> ((pString False "@deprecated\t" >>= withAttribute "BlockTag")) <|> ((pString False "@exception\t" >>= withAttribute "BlockTag") >>~ pushContext "JavadocParam") <|> ((pString False "@param\t" >>= withAttribute "BlockTag") >>~ pushContext "JavadocParam") <|> ((pString False "@return\t" >>= withAttribute "BlockTag")) <|> ((pString False "@see\t" >>= withAttribute "BlockTag") >>~ pushContext "SeeTag") <|> ((pString False "@serial\t" >>= withAttribute "BlockTag")) <|> ((pString False "@serialData\t" >>= withAttribute "BlockTag")) <|> ((pString False "@serialField\t" >>= withAttribute "BlockTag")) <|> ((pString False "@since\t" >>= withAttribute "BlockTag")) <|> ((pString False "@throws\t" >>= withAttribute "BlockTag") >>~ pushContext "JavadocParam") <|> ((pString False "@version\t" >>= withAttribute "BlockTag")) <|> ((pString False "{@code " >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@code\t" >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@docRoot}" >>= withAttribute "InlineTag")) <|> ((pString False "{@inheritDoc}" >>= withAttribute "InlineTag")) <|> ((pString False "{@link " >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@link\t" >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@linkplain " >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@linkplain\t" >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@literal " >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@literal\t" >>= withAttribute "InlineTag") >>~ pushContext "LiteralTagar") <|> ((pString False "{@value}" >>= withAttribute "InlineTag")) <|> ((pString False "{@value " >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((pString False "{@value\t" >>= withAttribute "InlineTag") >>~ pushContext "InlineTagar") <|> ((Text.Highlighting.Kate.Syntax.Html.parseExpression))) return (attr, result) parseRules "JavadocParam" = do (attr, result) <- (((pDetectSpaces >>= withAttribute "Javadoc")) <|> ((pRegExpr regex_'5cS'2a'28'3f'3d'5c'2a'2f'29 >>= withAttribute "JavadocParam") >>~ (popContext >> popContext)) <|> ((pRegExpr regex_'5cS'2a'28'5cs'7c'24'29 >>= withAttribute "JavadocParam") >>~ (popContext))) return (attr, result) parseRules "InlineTagar" = do (attr, result) <- (((pDetectChar False '}' >>= withAttribute "InlineTag") >>~ (popContext)) <|> ((pDetect2Chars False '*' '/' >>= withAttribute "JavadocFS") >>~ (popContext >> popContext >> popContext)) <|> ((Text.Highlighting.Kate.Syntax.Html.parseExpression))) return (attr, result) parseRules "LiteralTagar" = do (attr, result) <- (((pDetectChar False '}' >>= withAttribute "InlineTag") >>~ (popContext)) <|> ((pDetect2Chars False '*' '/' >>= withAttribute "JavadocFS") >>~ (popContext >> popContext >> popContext))) return (attr, result) parseRules "SeeTag" = do (attr, result) <- (((pDetect2Chars False '*' '/' >>= withAttribute "JavadocFS") >>~ (popContext >> popContext >> popContext)) <|> ((Text.Highlighting.Kate.Syntax.Html.parseExpression))) return (attr, result) parseRules x = fail $ "Unknown context" ++ x