Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
texmath (unreleased)

* StarMath writer: avoid duplicate grouping braces in script arguments,
roots, accents, and brace labels. Reuse complete groups while preserving
grouping around inline fraction commands and compound expressions.

* StarMath writer: separate upright letters from following identifiers
so `\mathrm d n` keeps only the differential upright, without extra braces.

* StarMath writer: supply the missing operand for trailing plus/minus
signs demoted to ordinary symbols by TeX, as in `r_{j,+}` and `r_{j,-}`.
Use compact empty operands on both sides of plus/minus signs, and
handle standalone operators in fraction numerators and denominators.

* StarMath writer: group annotated underbraces and overbraces so adjacent
terms do not become part of an earlier brace in LibreOffice.
Supply empty labels for bare braces and preserve centered scripts on
the opposite side of a brace, including `\underbrace{x}_{a}^2`.

* TeX reader: consume a single token for unbraced script arguments.
For example, `x^12` and `x_12` now mean `x^{1}2` and `x_{1}2`,
while braced multi-digit and decimal arguments remain intact.
Expand Down
126 changes: 85 additions & 41 deletions src/Text/TeXMath/Writers/StarMath.hs
Original file line number Diff line number Diff line change
Expand Up @@ -213,13 +213,14 @@ renderExpsIn dt ctx exps = do
rendered <- mapM (renderExpIn dt ctx) exps
let pieces = zip exps rendered
let merged = mergePieces pieces
let withLhs =
if startsWithInfixNeedingLhs exps
then "{} " <> T.stripStart merged
else merged
pure $ if endsWithInfixNeedingRhs exps
then T.stripEnd withLhs <> " {}"
else withLhs
let withLhs = case exps of
e : _ | needsNeutralLhs e ->
(if isPlusMinusSign e then "{}" else "{} ") <> T.stripStart merged
_ -> merged
pure $ case reverse exps of
e : _ | needsNeutralRhs e ->
T.stripEnd withLhs <> (if isPlusMinusSign e then "{}" else " {}")
_ -> withLhs

mergePieces :: [(Exp, T.Text)] -> T.Text
mergePieces [] = ""
Expand Down Expand Up @@ -288,6 +289,8 @@ needsSeparator prevE curE
| isCloseLike prevE && isAccentCommandExp curE = True
| isCloseLike prevE && isArrayLike curE = True
| isIdentifierLike prevE && isWordStyledExp curE = True
-- Keep an upright letter from merging with the following identifier token.
| isUprightMathTextExp prevE && isIdentifierLike curE = True
| isIdentifierLike prevE && isUprightMathTextExp curE = True
| isIdentifierLike prevE && isAccentCommandExp curE = True
| isIdentifierLike prevE && isWideSpace curE = True
Expand Down Expand Up @@ -488,23 +491,19 @@ isLargeOpScriptedExp e =
ESubsup base _ _ -> largeOpName base /= Nothing
_ -> False

startsWithInfixNeedingLhs :: [Exp] -> Bool
startsWithInfixNeedingLhs exps =
case exps of
(e : _) -> needsNeutralLhs e
_ -> False

endsWithInfixNeedingRhs :: [Exp] -> Bool
endsWithInfixNeedingRhs exps =
case reverse exps of
(e : _) -> needsNeutralRhs e
_ -> False

needsNeutralLhs :: Exp -> Bool
needsNeutralLhs = isInfixLikeExp

needsNeutralRhs :: Exp -> Bool
needsNeutralRhs = isInfixLikeExp
-- TeX demotes a trailing binary sign to Ord (for example in r_{j,+}).
-- StarMath still parses it as an operator and requires a right operand.
needsNeutralRhs e = isInfixLikeExp e || isPlusMinusSign e

isPlusMinusSign :: Exp -> Bool
isPlusMinusSign e =
case e of
ESymbol _ s -> s == "+" || s == "-" || s == "−"
_ -> False

needsNeutralScriptOperands :: Exp -> Bool
needsNeutralScriptOperands e =
Expand Down Expand Up @@ -547,8 +546,8 @@ renderExpIn dt ctx e =
EStyled sty xs -> renderStyled dt ctx sty xs

EFraction frac num den -> do
num' <- renderExpIn dt AlignDefault num
den' <- renderExpIn dt AlignDefault den
num' <- renderFractionArg dt num
den' <- renderFractionArg dt den
let num'' = maybeCenterFractionArg ctx num'
let den'' = maybeCenterFractionArg ctx den'
pure $ case frac of
Expand All @@ -558,11 +557,11 @@ renderExpIn dt ctx e =
| dt == DisplayInline -> renderInlineFraction num'' den''
_ -> "{" <> num'' <> " over " <> den'' <> "}"

ESqrt x -> ("sqrt {" <>) . (<> "}") <$> renderExpIn dt ctx x
ESqrt x -> ("sqrt " <>) . groupArg dt x <$> renderExpIn dt ctx x
ERoot idx rad -> do
idx' <- renderExpIn dt ctx idx
rad' <- renderExpIn dt ctx rad
pure $ "nroot {" <> idx' <> "} {" <> rad' <> "}"
pure $ "nroot " <> groupArg dt idx idx' <> " " <> groupArg dt rad rad'

EScaled _ (ESymbol Open "|") ->
Just "mline"
Expand Down Expand Up @@ -601,6 +600,10 @@ renderExpIn dt ctx e =
supRendered <- renderScriptArg dt ctx sup
pure $ renderScriptBase base baseRendered <> "_" <> subRendered <> "^" <> supRendered

EOver _ (EOver _ base marker) over
| Nothing <- braceAnnotationName over
, Just brace <- braceAnnotationName marker ->
renderBrace dt ctx base brace over
EOver _ base over
| Just arrow <- arrowScriptOpName base -> do
if isEmptyScriptArg over
Expand All @@ -611,21 +614,24 @@ renderExpIn dt ctx e =
| Just op <- centeredScriptOpName base -> do
over' <- renderScriptArg dt ctx over
pure $ "{" <> op <> "} csup " <> centerScriptArg over'
| Just brace <- braceAnnotationName over -> do
base' <- renderExpIn dt ctx base
pure $ renderScriptBase base base' <> " " <> brace
| Just brace <- braceAnnotationName over ->
renderBrace dt ctx base brace (EGrouped [])
| isBraceAnnotatedExp base -> do
base' <- renderExpIn dt ctx base
over' <- renderBraceLabel dt ctx over
pure $ base' <> " " <> over'
over' <- renderScriptArg dt ctx over
pure $ base' <> " csup " <> centerScriptArg over'
| Just accent <- accentName over -> do
base' <- renderExpIn dt ctx base
pure $ accent <> " " <> renderAccentArg base base'
pure $ accent <> " " <> renderAccentArg dt base base'
| Just op <- limitOpName base -> do
over' <- renderLimitArg dt ctx over
pure $ op <> " to " <> over' <> " "
| otherwise -> Nothing

EUnder _ (EUnder _ base marker) under
| Nothing <- braceAnnotationName under
, Just brace <- braceAnnotationName marker ->
renderBrace dt ctx base brace under
EUnder _ base under ->
case arrowScriptOpName base of
Just arrow ->
Expand All @@ -638,18 +644,17 @@ renderExpIn dt ctx e =
case underlineMarkerName under of
Just marker -> do
base' <- renderExpIn dt ctx base
pure $ marker <> " " <> renderAccentArg base base'
pure $ marker <> " " <> renderAccentArg dt base base'
Nothing ->
case braceAnnotationName under of
Just brace -> do
base' <- renderExpIn dt ctx base
pure $ renderScriptBase base base' <> " " <> brace
Just brace ->
renderBrace dt ctx base brace (EGrouped [])
Nothing ->
if isBraceAnnotatedExp base
then do
base' <- renderExpIn dt ctx base
under' <- renderBraceLabel dt ctx under
pure $ base' <> " " <> under'
under' <- renderScriptArg dt ctx under
pure $ base' <> " csub " <> centerScriptArg under'
else
case centeredScriptOpName base of
Just op -> do
Expand All @@ -664,6 +669,16 @@ renderExpIn dt ctx e =
base' <- renderExpIn dt ctx base
under' <- renderScriptArg dt ctx under
pure $ renderScriptBase base base' <> "_" <> under'
EUnderover _ (EUnder _ base marker) under over
| Just brace <- braceAnnotationName marker -> do
base' <- renderBrace dt ctx base brace under
over' <- renderScriptArg dt ctx over
pure $ base' <> " csup " <> centerScriptArg over'
EUnderover _ (EOver _ base marker) under over
| Just brace <- braceAnnotationName marker -> do
base' <- renderBrace dt ctx base brace over
under' <- renderScriptArg dt ctx under
pure $ base' <> " csub " <> centerScriptArg under'
EUnderover _ base under over ->
case arrowScriptOpName base of
Just arrow ->
Expand Down Expand Up @@ -1054,6 +1069,14 @@ asDelimitedArg t =
then s
else "{" <> s <> "}"

-- A single operator can be a fraction argument without an EGrouped wrapper.
-- Supply its missing operands within the argument, not around the fraction.
renderFractionArg :: DisplayType -> Exp -> Maybe T.Text
renderFractionArg dt e
| needsNeutralLhs e || needsNeutralRhs e =
("{" <>) . (<> "}") <$> renderExpsIn dt AlignDefault [e]
| otherwise = renderExpIn dt AlignDefault e

renderInlineFraction :: T.Text -> T.Text -> T.Text
renderInlineFraction num den =
"size*0.7 {" <> num <> " over " <> den <> "}"
Expand Down Expand Up @@ -1225,6 +1248,16 @@ renderScriptBase e rendered0 =
then rendered
else "{" <> rendered <> "}"

-- These constructors already render as one complete group. Other expressions
-- can start and end with braces without being grouped, e.g. {x} csub {a}.
groupArg :: DisplayType -> Exp -> T.Text -> T.Text
groupArg dt e rendered =
case e of
EGrouped{} -> rendered
EFraction DisplayFrac _ _ -> rendered
EFraction NormalFrac _ _ | dt == DisplayBlock -> rendered
_ -> "{" <> rendered <> "}"

renderScriptArg :: DisplayType -> AlignContext -> Exp -> Maybe T.Text
renderScriptArg dt ctx e = do
rendered0 <-
Expand All @@ -1234,7 +1267,7 @@ renderScriptArg dt ctx e = do
let rendered = T.strip rendered0
pure $ if (isAtomic e && not (needsNeutralScriptOperands e)) || isQuotedText rendered
then rendered
else "{" <> rendered <> "}"
else groupArg dt e rendered

renderPrimeSuffix :: Exp -> Maybe T.Text
renderPrimeSuffix e =
Expand Down Expand Up @@ -1271,12 +1304,12 @@ containsRelationLike = any isRelationLike
EGrouped ys -> containsRelationLike ys
_ -> False

renderAccentArg :: Exp -> T.Text -> T.Text
renderAccentArg e rendered0 =
renderAccentArg :: DisplayType -> Exp -> T.Text -> T.Text
renderAccentArg dt e rendered0 =
let rendered = T.strip rendered0
in if isAtomic e
then rendered
else "{" <> rendered <> "}"
else groupArg dt e rendered

renderPhantomArg :: Exp -> T.Text -> T.Text
renderPhantomArg e rendered0 =
Expand Down Expand Up @@ -1340,13 +1373,24 @@ underlineMarkerName e =
ESymbol TUnder "_" -> Just "underline"
_ -> Nothing

-- StarMath braces require a label operand, even for an unannotated TeX brace.
-- Group the complete term so neither operand absorbs adjacent expressions.
renderBrace :: DisplayType -> AlignContext -> Exp -> T.Text -> Exp
-> Maybe T.Text
renderBrace dt ctx base brace label = do
base' <- renderExpIn dt ctx base
label' <- if isEmptyScriptArg label
then pure "{}"
else renderBraceLabel dt ctx label
pure $ "{" <> renderScriptBase base base' <> " " <> brace <> " " <> label' <> "}"

renderBraceLabel :: DisplayType -> AlignContext -> Exp -> Maybe T.Text
renderBraceLabel dt ctx e = do
rendered0 <- renderExpIn dt ctx e
let rendered = T.strip rendered0
pure $ if isQuotedText rendered || isAtomic e
then rendered
else "{" <> rendered <> "}"
else groupArg dt e rendered

arrowScriptOpName :: Exp -> Maybe T.Text
arrowScriptOpName e =
Expand Down
2 changes: 1 addition & 1 deletion test/writer/starmath/004_square_root.test
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
\sqrt{x+1}
>>> starmath
sqrt {{x + 1}}
sqrt {x + 1}
2 changes: 1 addition & 1 deletion test/writer/starmath/01.test
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@
(EGrouped [ ENumber "2" , EIdentifier "a" ])
]
>>> starmath
x = {{- b plusminus sqrt {{b^2 - 4ac}}} over {2a}}
x = {{- b plusminus sqrt {b^2 - 4ac}} over {2a}}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
\int_{0}^{\infty} e^{-x}\,dx
>>> starmath
int_0^infinity e^{{- x}} dx
int_0^infinity e^{- x} dx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
E_{k+1}=E_{k+\frac12}-\frac{\dot{Q}_{\text{dis},k}\Delta t}{\eta_{\text{dis}}},
>>> starmath
E_{{k + 1}} = E_{{k + {1 over 2}}} - {{{dot Q}_{{"dis", k}} %DELTA t} over %ieta_"dis"},
E_{k + 1} = E_{k + {1 over 2}} - {{{dot Q}_{"dis", k} %DELTA t} over %ieta_"dis"},
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
E_{k+1}\leftarrow\min\!\left(E^{\text{cap}}_{\text{s}},\max(0,E_{k+1})\right).
>>> starmath
E_{{k + 1}} leftarrow func min left ( E_"s"^"cap", func max(0, E_{{k + 1}}) right ).
E_{k + 1} leftarrow func min left ( E_"s"^"cap", func max(0, E_{k + 1}) right ).
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
P_{\text{ch}, k}=\max\!\left(0,\min\!\left(P'_{\text{pv}, k},\,P^{\text{cap}}_{\text{ch}},\,P_{\text{ch,head}, k}\right)\right).
>>> starmath
P_{{"ch", k}} = func max left ( 0, func min left ( P_{{"pv", k}}', P_"ch"^"cap", P_{{"ch,head", k}} right ) right ).
P_{"ch", k} = func max left ( 0, func min left ( P_{"pv", k}', P_"ch"^"cap", P_{"ch,head", k} right ) right ).
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
\Delta\log_{10}K_j = \log_{10}K_{j,\mathrm{FPROPS}} - \log_{10}K_{j,\mathrm{ref}},\qquad j=1,\dots,r.
>>> starmath
%DELTA log_10 K_j = log_10 K_{{j, "FPROPS"}} - log_10 K_{{j, "ref"}}, ~~ j = 1, dotslow , r.
%DELTA log_10 K_j = log_10 K_{j, "FPROPS"} - log_10 K_{j, "ref"}, ~~ j = 1, dotslow , r.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
^+
>>> starmath
{}^{{} + {}}
{}^{{}+{}}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
_{j,\mathrm{ref}}
>>> starmath
{}_{{j, "ref"}}
{}_{j, "ref"}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
\underbrace{x+y}_{z}+\overbrace{x+y}^{z}
>>> starmath
{x + y} underbrace z + {x + y} overbrace z
{{x + y} underbrace z} + {{x + y} overbrace z}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<<< tex
r_{r,e}=r_{r,e}^{+}-r_{r,e}^{-}
>>> starmath
r_{{r, e}} = r_{{r, e}}^{{} + {}} - r_{{r, e}}^{{} - {}}
r_{r, e} = r_{r, e}^{{}+{}} - r_{r, e}^{{}-{}}
2 changes: 1 addition & 1 deletion test/writer/starmath/11.test
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@
NormalFrac (ENumber "1") (ESub (EIdentifier "l") (ENumber "0"))
]
>>> starmath
%iphi_n(%ikappa) = 0.033C_n^2 %ikappa^{{- 11 / 3}}, ~ {1 over L_0} ll %ikappa ll {1 over l_0}
%iphi_n(%ikappa) = 0.033C_n^2 %ikappa^{- 11 / 3}, ~ {1 over L_0} ll %ikappa ll {1 over l_0}
10 changes: 10 additions & 0 deletions test/writer/starmath/aligned_rate_contributions.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<<< tex
\begin{aligned}
r_{j,\pm}^{0}
&=\underbrace{A_j\exp\!\left(-\frac{E_j}{R_{\mathrm u}T}\right)}_{k_j(T):\ \text{Arrhenius coefficient}}
\times\underbrace{(\text{gas factor})_{j,\pm}}_{\text{local hydrogen/steam}}
\times\underbrace{(\text{solid factor})_{j,\pm}}_{\text{inventory, presence and access}},\\
r_j^0&=r_{j,+}^{0}-r_{j,-}^{0}.
\end{aligned}
>>> starmath
matrix { alignr r_{j, plusminus {}}^0 # alignl {} = {{A_j exp left ( -{{alignc {E_j}} over {alignc {R_{nitalic u} T}}} right )} underbrace {k_j(T) : "Arrhenius coefficient"}} times {{("gas factor")_{j, plusminus {}}} underbrace "local hydrogen/steam"} times {{("solid factor")_{j, plusminus {}}} underbrace "inventory, presence and access"}, ## alignr r_j^0 # alignl {} = r_{j, +{}}^0 - r_{j, -{}}^0. }
7 changes: 7 additions & 0 deletions test/writer/starmath/annotated_brace_product.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<<< tex
\text{rate contribution}
=\underbrace{A_j\exp\!\left(-\frac{E_j}{R_{\mathrm u}T}\right)}_{k_j(T):\ \text{Arrhenius coefficient}}
\times\underbrace{\text{gas factor}}_{\text{local hydrogen/steam}}
\times\underbrace{\text{solid factor}}_{\text{inventory, presence and access}}.
>>> starmath
"rate contribution" = {{A_j exp left ( -{E_j over {R_{nitalic u} T}} right )} underbrace {k_j(T) : "Arrhenius coefficient"}} times {"gas factor" underbrace "local hydrogen/steam"} times {"solid factor" underbrace "inventory, presence and access"}.
4 changes: 4 additions & 0 deletions test/writer/starmath/annotated_brace_sum.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<<< tex
1+\underbrace{x}_{a}+\underbrace{y}_{b}=\overbrace{x}^{c}+\overbrace{y}^{d}.
>>> starmath
1 + {x underbrace a} + {y underbrace b} = {x overbrace c} + {y overbrace d}.
4 changes: 4 additions & 0 deletions test/writer/starmath/bare_braces.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<<< tex
\overbrace{a}+b=\underbrace{x}+y
>>> starmath
{a overbrace {}} + b = {x underbrace {}} + y
4 changes: 4 additions & 0 deletions test/writer/starmath/bare_braces_inline.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<<< tex
\overbrace{a}+b=\underbrace{x}+y
>>> starmath-inline
{a overbrace {}} + b = {x underbrace {}} + y
4 changes: 4 additions & 0 deletions test/writer/starmath/brace_both_scripts.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<<< tex
\underbrace{x}_{a}^2+\overbrace{y}_{b}^{c}
>>> starmath
{x underbrace a} csup {2} + {y overbrace c} csub {b}
4 changes: 4 additions & 0 deletions test/writer/starmath/brace_both_scripts_inline.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<<< tex
\underbrace{x}_{a}^2+\overbrace{y}_{b}^{c}
>>> starmath-inline
{x underbrace a} csup {2} + {y overbrace c} csub {b}
4 changes: 4 additions & 0 deletions test/writer/starmath/brace_opposite_scripts.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<<< tex
\underbrace{x}^{2}+\overbrace{y}_{b}
>>> starmath
{x underbrace {}} csup {2} + {y overbrace {}} csub {b}
Loading
Loading