Safe Haskell	None
Language	Haskell2010

Simplex.Chat.Markdown

Contents

page name: lowercase latin in snake-case or hyphen-case, allowing for sinlge leading or trailing hyphen or underscore.

Synopsis

data Markdown
- = Markdown (Maybe Format) Text
- | Markdown :|: Markdown
data Format
- = Bold
- | Italic
- | StrikeThrough
- | Snippet
- | Secret
- | Colored {
  - color :: FormatColor
  }
- | Uri
- | HyperLink {
  - showText :: Maybe Text
  - linkUri :: Text
  }
- | SimplexLink {
  - showText :: Maybe Text
  - linkType :: SimplexLinkType
  - simplexUri :: AConnectionLink
  - smpHosts :: NonEmpty Text
  }
- | Command {
  - commandStr :: Text
  }
- | Mention {
  - memberName :: Text
  }
- | Email
- | Phone
- | Unknown {
  - json :: Value
  }
mentionedNames :: MarkdownList -> [Text]
data SimplexLinkType
- = XLContact
- | XLInvitation
- | XLGroup
- | XLChannel
- | XLRelay
colored :: Color -> Format
markdown :: Format -> Text -> Markdown
newtype FormatColor = FormatColor Color
data FormattedText = FormattedText {
- format :: Maybe Format
- text :: Text
}
type MarkdownList = [FormattedText]
data ParsedMarkdown = ParsedMarkdown {
- formattedText :: Maybe MarkdownList
}
unmarked :: Text -> Markdown
parseMaybeMarkdownList :: Text -> Maybe MarkdownList
parseMarkdownList :: Text -> MarkdownList
markdownToList :: Markdown -> MarkdownList
parseMarkdown :: Text -> Markdown
isSimplexLink :: Format -> Bool
markdownP :: Parser Markdown
parseUri :: ByteString -> Either Text URI
sanitizeUri :: Bool -> URI -> Maybe URI
markdownText :: FormattedText -> Text
displayNameTextP :: Parser Text
displayNameTextP_ :: Parser (Text, Text)
commandTextP :: Parser (Text, Text)
viewName :: Text -> Text

Documentation

data Markdown Source #

Constructors

Markdown (Maybe Format) Text
Markdown :\|: Markdown

Instances

Instances details

IsString Markdown Source #
Instance details Defined in Simplex.Chat.Markdown Methods fromString :: String -> Markdown
Monoid Markdown Source #
Instance details Defined in Simplex.Chat.Markdown Methods mempty :: Markdown mappend :: Markdown -> Markdown -> Markdown mconcat :: [Markdown] -> Markdown
Semigroup Markdown Source #
Instance details Defined in Simplex.Chat.Markdown Methods (<>) :: Markdown -> Markdown -> Markdown sconcat :: NonEmpty Markdown -> Markdown stimes :: Integral b => b -> Markdown -> Markdown
Show Markdown Source #
Instance details Defined in Simplex.Chat.Markdown Methods showsPrec :: Int -> Markdown -> ShowS show :: Markdown -> String showList :: [Markdown] -> ShowS
Eq Markdown Source #
Instance details Defined in Simplex.Chat.Markdown Methods (==) :: Markdown -> Markdown -> Bool (/=) :: Markdown -> Markdown -> Bool

data Format Source #

Constructors

Bold
Italic
StrikeThrough
Snippet
Secret
Colored
Fields color :: FormatColor
Uri
HyperLink
Fields showText :: Maybe Text linkUri :: Text
SimplexLink
Fields showText :: Maybe Text linkType :: SimplexLinkType simplexUri :: AConnectionLink smpHosts :: NonEmpty Text
Command
Fields commandStr :: Text
Mention
Fields memberName :: Text
Email
Phone
Unknown
Fields json :: Value

Instances

Instances details

FromJSON Format Source #
Instance details Defined in Simplex.Chat.Markdown Methods parseJSON :: Value -> Parser Format parseJSONList :: Value -> Parser [Format] omittedField :: Maybe Format
ToJSON Format Source #
Instance details Defined in Simplex.Chat.Markdown Methods toJSON :: Format -> Value toEncoding :: Format -> Encoding toJSONList :: [Format] -> Value toEncodingList :: [Format] -> Encoding omitField :: Format -> Bool
Show Format Source #
Instance details Defined in Simplex.Chat.Markdown Methods showsPrec :: Int -> Format -> ShowS show :: Format -> String showList :: [Format] -> ShowS
Eq Format Source #
Instance details Defined in Simplex.Chat.Markdown Methods (==) :: Format -> Format -> Bool (/=) :: Format -> Format -> Bool

mentionedNames :: MarkdownList -> [Text] Source #

data SimplexLinkType Source #

Constructors

XLContact
XLInvitation
XLGroup
XLChannel
XLRelay

Instances

Instances details

FromJSON SimplexLinkType Source #
Instance details Defined in Simplex.Chat.Markdown Methods parseJSON :: Value -> Parser SimplexLinkType parseJSONList :: Value -> Parser [SimplexLinkType] omittedField :: Maybe SimplexLinkType
ToJSON SimplexLinkType Source #
Instance details Defined in Simplex.Chat.Markdown Methods toJSON :: SimplexLinkType -> Value toEncoding :: SimplexLinkType -> Encoding toJSONList :: [SimplexLinkType] -> Value toEncodingList :: [SimplexLinkType] -> Encoding omitField :: SimplexLinkType -> Bool
Show SimplexLinkType Source #
Instance details Defined in Simplex.Chat.Markdown Methods showsPrec :: Int -> SimplexLinkType -> ShowS show :: SimplexLinkType -> String showList :: [SimplexLinkType] -> ShowS
Eq SimplexLinkType Source #
Instance details Defined in Simplex.Chat.Markdown Methods (==) :: SimplexLinkType -> SimplexLinkType -> Bool (/=) :: SimplexLinkType -> SimplexLinkType -> Bool

colored :: Color -> Format Source #

markdown :: Format -> Text -> Markdown Source #

newtype FormatColor Source #

Constructors

FormatColor Color

Instances

Instances details

FromJSON FormatColor Source #
Instance details Defined in Simplex.Chat.Markdown Methods parseJSON :: Value -> Parser FormatColor parseJSONList :: Value -> Parser [FormatColor] omittedField :: Maybe FormatColor
ToJSON FormatColor Source #
Instance details Defined in Simplex.Chat.Markdown Methods toJSON :: FormatColor -> Value toEncoding :: FormatColor -> Encoding toJSONList :: [FormatColor] -> Value toEncodingList :: [FormatColor] -> Encoding omitField :: FormatColor -> Bool
Show FormatColor Source #
Instance details Defined in Simplex.Chat.Markdown Methods showsPrec :: Int -> FormatColor -> ShowS show :: FormatColor -> String showList :: [FormatColor] -> ShowS
Eq FormatColor Source #
Instance details Defined in Simplex.Chat.Markdown Methods (==) :: FormatColor -> FormatColor -> Bool (/=) :: FormatColor -> FormatColor -> Bool

data FormattedText Source #

Constructors

FormattedText
Fields format :: Maybe Format text :: Text

Instances

Instances details

FromJSON FormattedText Source #
Instance details Defined in Simplex.Chat.Markdown Methods parseJSON :: Value -> Parser FormattedText parseJSONList :: Value -> Parser [FormattedText] omittedField :: Maybe FormattedText
ToJSON FormattedText Source #
Instance details Defined in Simplex.Chat.Markdown Methods toJSON :: FormattedText -> Value toEncoding :: FormattedText -> Encoding toJSONList :: [FormattedText] -> Value toEncodingList :: [FormattedText] -> Encoding omitField :: FormattedText -> Bool
IsString FormattedText Source #
Instance details Defined in Simplex.Chat.Markdown Methods fromString :: String -> FormattedText
Show FormattedText Source #
Instance details Defined in Simplex.Chat.Markdown Methods showsPrec :: Int -> FormattedText -> ShowS show :: FormattedText -> String showList :: [FormattedText] -> ShowS
Eq FormattedText Source #
Instance details Defined in Simplex.Chat.Markdown Methods (==) :: FormattedText -> FormattedText -> Bool (/=) :: FormattedText -> FormattedText -> Bool

type MarkdownList = [FormattedText] Source #

data ParsedMarkdown Source #

Constructors

ParsedMarkdown
Fields formattedText :: Maybe MarkdownList

Instances

Instances details

ToJSON ParsedMarkdown Source #
Instance details Defined in Simplex.Chat.Markdown Methods toJSON :: ParsedMarkdown -> Value toEncoding :: ParsedMarkdown -> Encoding toJSONList :: [ParsedMarkdown] -> Value toEncodingList :: [ParsedMarkdown] -> Encoding omitField :: ParsedMarkdown -> Bool

unmarked :: Text -> Markdown Source #

parseMaybeMarkdownList :: Text -> Maybe MarkdownList Source #

parseMarkdownList :: Text -> MarkdownList Source #

markdownToList :: Markdown -> MarkdownList Source #

parseMarkdown :: Text -> Markdown Source #

isSimplexLink :: Format -> Bool Source #

markdownP :: Parser Markdown Source #

parseUri :: ByteString -> Either Text URI Source #

page name: lowercase latin in snake-case or hyphen-case, allowing for sinlge leading or trailing hyphen or underscore.

sanitizeUri :: Bool -> URI -> Maybe URI Source #

markdownText :: FormattedText -> Text Source #

displayNameTextP :: Parser Text Source #

displayNameTextP_ :: Parser (Text, Text) Source #

commandTextP :: Parser (Text, Text) Source #

viewName :: Text -> Text Source #