Skip to content

Commit

Permalink
Add skylighting-format-typst.
Browse files Browse the repository at this point in the history 
Export its functions from Skylighting [API change].

Closes #201.
  • Loading branch information
@jgm
jgm committed Jan 7, 2025
1 parent b5105ed commit 7a1a6d0
Show file tree
Hide file tree
Showing 6 changed files with 100 additions and 115 deletions.
188 changes: 74 additions & 114 deletions skylighting-format-typst/src/Skylighting/Format/Typst.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,145 +8,105 @@ module Skylighting.Format.Typst (
) where

import Control.Monad (mplus)
import Data.Char (isSpace)
import Data.List (sort)
import qualified Data.Map as Map
import Data.Text (Text)
import qualified Data.Text as Text
import Skylighting.Types
import Text.Printf
import qualified Data.Map as M
import Data.Maybe (fromMaybe)
#if !MIN_VERSION_base(4,11,0)
import Data.Semigroup
#endif

formatTypst :: Bool -> [SourceLine] -> Text
formatTypst inline = Text.intercalate (Text.singleton '\n')
. map (sourceLineToTypst inline)

-- | Formats tokens as Typst using custom commands inside
-- @|@ characters. Assumes that @|@ is defined as a short verbatim
-- command by the macros produced by 'styleToTypst'.
-- A @KeywordTok@ is rendered using @\\KeywordTok{..}@, and so on.
formatTypstInline :: FormatOptions -> [SourceLine] -> Text
formatTypstInline _opts ls = "\\VERB|" <> formatTypst True ls <> "|"
formatTypstInline _opts = Text.intercalate newline . map sourceLineToTypst

newline :: Text
newline = "#EndLine()\n"

sourceLineToTypst :: Bool -> SourceLine -> Text
sourceLineToTypst inline = mconcat . map (tokenToTypst inline)
sourceLineToTypst :: SourceLine -> Text
sourceLineToTypst = mconcat . map tokenToTypst

tokenToTypst :: Bool -> Token -> Text
tokenToTypst inline (NormalTok, txt)
| Text.all isSpace txt = escapeTypst inline txt
tokenToTypst inline (toktype, txt) = Text.cons '\\'
(Text.pack (show toktype) <> "{" <> escapeTypst inline txt <> "}")
tokenToTypst :: Token -> Text
tokenToTypst (toktype, txt) =
"#" <> Text.pack (show toktype) <> "(" <> doubleQuoted txt <> ");"

escapeTypst :: Bool -> Text -> Text
escapeTypst inline = Text.concatMap escapeTypstChar
where escapeTypstChar c =
case c of
'\\' -> "\\textbackslash{}"
'{' -> "\\{"
'}' -> "\\}"
'|' | inline -> "\\VerbBar{}" -- used in inline verbatim
'_' -> "\\_"
'&' -> "\\&"
'%' -> "\\%"
'#' -> "\\#"
'`' -> "\\textasciigrave{}"
'\'' -> "\\textquotesingle{}"
'-' -> "{-}" -- prevent ligatures
'~' -> "\\textasciitilde{}"
'^' -> "\\^{}"
'>' -> "\\textgreater{}"
'<' -> "\\textless{}"
_ -> Text.singleton c
doubleQuoted :: Text -> Text
doubleQuoted t = "\"" <> escape t <> "\""
where
escape = Text.concatMap escapeChar
escapeChar '\\' = "\\\\"
escapeChar '"' = "\\\""
escapeChar c = Text.singleton c

-- Typst

-- | Format tokens as a Typst @Highlighting@ environment inside a
-- @Shaded@ environment. @Highlighting@ and @Shaded@ are
-- defined by the macros produced by 'styleToTypst'. @Highlighting@
-- is a verbatim environment using @fancyvrb@; @\\@, @{@, and @}@
-- have their normal meanings inside this environment, so that
-- formatting commands work. @Shaded@ is either nothing
-- (if the style's background color is default) or a @snugshade@
-- environment from @framed@, providing a background color
-- for the whole code block, even if it spans multiple pages.
-- Skylighting block that can be styled. @Skylighting@ is
-- defined by the macros produced by 'styleToTypst'.
formatTypstBlock :: FormatOptions -> [SourceLine] -> Text
formatTypstBlock opts ls = Text.unlines
["\\begin{Shaded}"
,"\\begin{Highlighting}[" <>
(if numberLines opts
then "numbers=left," <>
(if startNumber opts == 1
then ""
else ",firstnumber=" <>
Text.pack (show (startNumber opts))) <> ","
else Text.empty) <> "]"
,formatTypst False ls
,"\\end{Highlighting}"
,"\\end{Shaded}"]
formatTypstBlock opts ls =
"#Skylighting(" <>
(if numberLines opts
then "number: true, start: " <> Text.pack (show (startNumber opts)) <> ", "
else "") <>
"(" <> -- an array
Text.intercalate "\n" (map (\ln -> "[" <> formatTypstInline opts [ln] <> "],") ls)
<> "));"

-- | Converts a 'Style' to a set of Typst macro definitions,
-- which should be placed in the document's preamble.
-- Note: default Typst setup doesn't allow boldface typewriter font.
-- To make boldface work in styles, you need to use a different typewriter
-- font. This will work for computer modern:
--
-- > \DeclareFontShape{OT1}{cmtt}{bx}{n}{<5><6><7><8><9><10><10.95><12><14.4><17.28><20.74><24.88>cmttb10}{}
--
-- Or, with xelatex:
--
-- > \usepackage{fontspec}
-- > \setmainfont[SmallCapsFont={* Caps}]{Latin Modern Roman}
-- > \setsansfont{Latin Modern Sans}
-- > \setmonofont[SmallCapsFont={Latin Modern Mono Caps}]{Latin Modern Mono Light}
--
styleToTypst :: Style -> Text
styleToTypst f = Text.unlines $
[ "\\usepackage{color}"
, "\\usepackage{fancyvrb}"
, "\\newcommand{\\VerbBar}{|}"
, "\\newcommand{\\VERB}{\\Verb[commandchars=\\\\\\{\\}]}"
, "\\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\\\\{\\}}"
, "% Add ',fontsize=\\small' for more characters per line"
] ++
(case backgroundColor f of
Nothing -> ["\\newenvironment{Shaded}{}{}"]
Just (RGB r g b) -> ["\\usepackage{framed}"
,Text.pack
(printf "\\definecolor{shadecolor}{RGB}{%d,%d,%d}" r g b)
,"\\newenvironment{Shaded}{\\begin{snugshade}}{\\end{snugshade}}"])
++ sort (map (macrodef (defaultColor f) (Map.toList (tokenStyles f)))
(enumFromTo KeywordTok NormalTok))
styleToTypst f =
Text.unlines $
[ "/* Function definitions for syntax highlighting generated by skylighting: */"
, "#let EndLine() = raw(\"\\n\")"
, "#let Skylighting(fill: none, number: false, start: 1, sourcelines) = {"
, " let blocks = []"
, " let lnum = start - 1"
, " let bgcolor = " <> maybe "none" toTypstColor (backgroundColor f)
, " for ln in sourcelines {"
, " if number {"
, " lnum = lnum + 1"
, " blocks = blocks + box(width: if start + sourcelines.len() > 999 { 30pt } else { 24pt }, text(" <> lineNumberFill <> "[ #lnum ]))"
, " }"
, " blocks = blocks + ln + EndLine()"
, " }"
, " block(fill: bgcolor, blocks)"
, "}"
] <>
sort (map (macrodef (defaultColor f) (Map.toList (tokenStyles f)))
(enumFromTo KeywordTok NormalTok))
where
toTypstColor c = "rgb(" <> Text.pack (show (fromColor c :: String)) <> ")"
lineNumberFill = case lineNumberColor f of
Nothing -> ""
Just c -> "fill: " <> toTypstColor c <> ", "

macrodef :: Maybe Color -> [(TokenType, TokenStyle)] -> TokenType -> Text
macrodef defaultcol tokstyles tokt = "\\newcommand{\\"
<> Text.pack (show tokt)
<> "}[1]{"
<> Text.pack (co . ul . bf . it . bg $ "#1")
<> "}"
where tokf = case lookup tokt tokstyles of
Nothing -> defStyle
Just x -> x
ul x = if tokenUnderline tokf
then "\\underline{" <> x <> "}"
else x
it x = if tokenItalic tokf
then "\\textit{" <> x <> "}"
else x
bf x = if tokenBold tokf
then "\\textbf{" <> x <> "}"
else x
bcol = fromColor `fmap` tokenBackground tokf
:: Maybe (Double, Double, Double)
bg x = case bcol of
Nothing -> x
Just (r, g, b) ->
printf "\\colorbox[rgb]{%0.2f,%0.2f,%0.2f}{%s}" r g b x
col = fromColor `fmap` (tokenColor tokf `mplus` defaultcol)
:: Maybe (Double, Double, Double)
co x = case col of
Nothing -> x
Just (r, g, b) ->
printf "\\textcolor[rgb]{%0.2f,%0.2f,%0.2f}{%s}" r g b x

macrodef defaultcol tokstyles' tokt =
"#let " <> Text.pack (show tokt) <> "(s) = " <> (ul . bg . textstyle) ("raw(s)")
where tokstyles = M.fromList tokstyles'
tokf = fromMaybe defStyle $ M.lookup tokt tokstyles
ul x = if tokenUnderline tokf
then "underline(" <> x <> ")"
else x
bg x = case tokenBackground tokf of
Nothing -> x
Just _c -> x -- TODO?
textstyle x = "text(" <> bf x <> it x <> co x <> x <> ")"
it x = if tokenItalic tokf
then "style: \"italic\","
else ""
bf x = if tokenBold tokf
then "weight: \"bold\","
else ""
co x = case tokenColor tokf `mplus` defaultcol of
Just c -> "fill: rgb(" <>
Text.pack (show (fromColor c :: String)) <> "),"
Nothing -> ""
2 changes: 2 additions & 0 deletions skylighting/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ This project is divided up into five packages:
rendering skylighting tokens as ConTeXt.
* `skylighting-format-latex`: this provides formatters for
rendering skylighting tokens as LaTeX.
* `skylighting-format-typst`: this provides formatters for
rendering skylighting tokens as Typst.
* `skylighting`: this exposes the `skylighting-core` API and
ANSI, HTML, ConTeXt, and LaTeX formatters, and also
provides bundled Haskell parser modules derived from the XML
Expand Down
20 changes: 19 additions & 1 deletion skylighting/bin/main.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ data HighlightFormat = FormatANSI
| FormatConTeXt
| FormatHtml
| FormatLaTeX
| FormatTypst
| FormatNative
deriving (Eq, Show)

Expand All @@ -61,7 +62,7 @@ options =
,Option ['f']
["format"]
(ReqArg Format "FORMAT")
"output format (ansi|context|html|latex|native)"
"output format (ansi|context|html|latex|typst|native)"
,Option ['r']
["fragment"]
(NoArg Fragment)
Expand Down Expand Up @@ -147,6 +148,7 @@ formatOf (Format s : _) = case map toLower s of
"context"-> return FormatConTeXt
"html" -> return FormatHtml
"latex" -> return FormatLaTeX
"typst" -> return FormatTypst
"native" -> return FormatNative
_ -> err $ "Unknown format: " ++ s
formatOf (_ : xs) = formatOf xs
Expand Down Expand Up @@ -249,6 +251,7 @@ main = do
FormatConTeXt-> hlConTeXt fragment fname highlightOpts style sourceLines
FormatHtml -> hlHtml fragment fname highlightOpts style sourceLines
FormatLaTeX -> hlLaTeX fragment fname highlightOpts style sourceLines
FormatTypst -> hlTypst fragment fname highlightOpts style sourceLines
FormatNative -> putStrLn $ ppShow sourceLines

hlANSI :: FormatOptions
Expand Down Expand Up @@ -298,6 +301,21 @@ hlLaTeX frag fname opts sty sourceLines =
macros = styleToLaTeX sty
pageTitle = "\\title{" <> Text.pack fname <> "}\n"

hlTypst :: Bool -- ^ Fragment
-> FilePath -- ^ Filename
-> FormatOptions
-> Style
-> [SourceLine]
-> IO ()
hlTypst frag fname opts sty sourceLines =
if frag
then Text.putStrLn fragment
else Text.putStrLn $ macros <> "\n" <> pageTitle <> "\n" <> fragment
where fragment = formatTypstBlock opts sourceLines
macros = styleToTypst sty
pageTitle = "= " <> Text.pack fname <> "\n"


hlConTeXt :: Bool -- ^ Fragment
-> FilePath -- ^ Filename
-> FormatOptions
Expand Down
2 changes: 2 additions & 0 deletions skylighting/skylighting.cabal
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ library
, skylighting-format-blaze-html:Skylighting.Format.HTML
, skylighting-format-context:Skylighting.Format.ConTeXt
, skylighting-format-latex:Skylighting.Format.LaTeX
, skylighting-format-typst:Skylighting.Format.Typst
other-modules:
Skylighting.Syntax.Abc
Skylighting.Syntax.Actionscript
Expand Down Expand Up @@ -217,6 +218,7 @@ library
skylighting-format-context >= 0.1 && < 0.2,
skylighting-format-latex >= 0.1 && < 0.2,
skylighting-format-blaze-html >= 0.1 && < 0.2,
skylighting-format-typst >= 0.1 && < 0.2,
containers,
binary
hs-source-dirs: src
Expand Down
2 changes: 2 additions & 0 deletions skylighting/src/Skylighting.hs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ module Skylighting
, module Skylighting.Format.ConTeXt
, module Skylighting.Format.HTML
, module Skylighting.Format.LaTeX
, module Skylighting.Format.Typst
, module Skylighting.Loader

)
Expand All @@ -27,6 +28,7 @@ import Skylighting.Format.ANSI
import Skylighting.Format.ConTeXt
import Skylighting.Format.HTML
import Skylighting.Format.LaTeX
import Skylighting.Format.Typst
import Skylighting.Parser
import Skylighting.Regex
import Skylighting.Styles
Expand Down
1 change: 1 addition & 0 deletions stack.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ packages:
- skylighting-format-blaze-html
- skylighting-format-context
- skylighting-format-latex
- skylighitng-format-typst
extra-deps:
- xml-conduit-1.9.1.3
resolver: lts-21.0
Expand Down

0 comments on commit 7a1a6d0

Please sign in to comment.