Skip to content

Commit

Permalink
Move to pretty printer
Browse files Browse the repository at this point in the history
  • Loading branch information
HuwCampbell committed May 23, 2023
1 parent 2b3b129 commit 856046e
Show file tree
Hide file tree
Showing 8 changed files with 56 additions and 54 deletions.
10 changes: 0 additions & 10 deletions .github/workflows/haskell-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,16 +98,6 @@ jobs:
compilerVersion: 7.4.2
setup-method: hvr-ppa
allow-failure: false
- compiler: ghc-7.2.2
compilerKind: ghc
compilerVersion: 7.2.2
setup-method: hvr-ppa
allow-failure: false
- compiler: ghc-7.0.4
compilerKind: ghc
compilerVersion: 7.0.4
setup-method: hvr-ppa
allow-failure: false
fail-fast: false
steps:
- name: apt
Expand Down
5 changes: 3 additions & 2 deletions optparse-applicative.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,11 @@ library
, Options.Applicative.Types
, Options.Applicative.Internal

build-depends: base == 4.*
build-depends: base >= 4.5 && < 5
, transformers >= 0.2 && < 0.7
, transformers-compat >= 0.3 && < 0.8
, ansi-wl-pprint >= 0.6.8 && < 1.1
, prettyprinter >= 1.7 && < 1.8
, prettyprinter-ansi-terminal >= 1.1 && < 1.2

if flag(process)
build-depends: process >= 1.0 && < 1.7
Expand Down
3 changes: 1 addition & 2 deletions src/Options/Applicative/BashCompletion.hs
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
-- | You don't need to import this module to enable bash completion.
--
-- See
Expand Down Expand Up @@ -150,7 +149,7 @@ bashCompletionQuery pinfo pprefs richness ws i _ = case runCompletion compl ppre
-- If there was a line break, it would come across as a different completion
-- possibility.
render_line :: Int -> Doc -> String
render_line len doc = case lines (displayS (renderPretty 1 len doc) "") of
render_line len doc = case lines (prettyString 1 len doc) of
[] -> ""
[x] -> x
x : _ -> x ++ "..."
Expand Down
3 changes: 1 addition & 2 deletions src/Options/Applicative/Help/Chunk.hs
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
module Options.Applicative.Help.Chunk
( Chunk(..)
, chunked
Expand Down Expand Up @@ -116,7 +115,7 @@ isEmpty = isNothing . unChunk
-- > extractChunk . stringChunk = string
stringChunk :: String -> Chunk Doc
stringChunk "" = mempty
stringChunk s = pure (string s)
stringChunk s = pure (pretty s)

-- | Convert a paragraph into a 'Chunk'. The resulting chunk is composed by the
-- words of the original paragraph separated by softlines, so it will be
Expand Down
17 changes: 8 additions & 9 deletions src/Options/Applicative/Help/Core.hs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{-# LANGUAGE CPP #-}
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
module Options.Applicative.Help.Core (
cmdDesc,
briefDesc,
Expand Down Expand Up @@ -58,7 +57,7 @@ optDesc pprefs style _reachability opt =
meta =
stringChunk $ optMetaVar opt
descs =
map (string . showOption) names
map (pretty . showOption) names
descriptions =
listToChunk (intersperse (descSep style) descs)
desc
Expand Down Expand Up @@ -98,7 +97,7 @@ cmdDesc pprefs = mapParser desc
CmdReader gn cmds ->
(,) gn $
tabulate (prefTabulateFill pprefs)
[ (string nm, align (extractChunk (infoProgDesc cmd)))
[ (pretty nm, align (extractChunk (infoProgDesc cmd)))
| (nm, cmd) <- reverse cmds
]
_ -> mempty
Expand Down Expand Up @@ -127,7 +126,7 @@ briefDesc' showOptional pprefs =
| otherwise =
filterOptional
style = OptDescStyle
{ descSep = string "|",
{ descSep = pretty '|',
descHidden = False,
descGlobal = False
}
Expand Down Expand Up @@ -204,9 +203,9 @@ optionsDesc global pprefs = tabulate (prefTabulateFill pprefs) . catMaybes . map
n = fst $ optDesc pprefs style info opt
h = optHelp opt
hdef = Chunk . fmap show_def . optShowDefault $ opt
show_def s = parens (string "default:" <+> string s)
show_def s = parens (pretty "default:" <+> pretty s)
style = OptDescStyle
{ descSep = string ",",
{ descSep = pretty ',',
descHidden = True,
descGlobal = global
}
Expand Down Expand Up @@ -251,7 +250,7 @@ parserHelp pprefs p =
group_title _ = mempty

with_title :: String -> Chunk Doc -> Chunk Doc
with_title title = fmap (string title .$.)
with_title title = fmap (pretty title .$.)


parserGlobals :: ParserPrefs -> Parser a -> ParserHelp
Expand All @@ -267,8 +266,8 @@ parserUsage :: ParserPrefs -> Parser a -> String -> Doc
parserUsage pprefs p progn =
group $
hsep
[ string "Usage:",
string progn,
[ pretty "Usage:",
pretty progn,
hangAtIfOver 9 35 (extractChunk (briefDesc pprefs p))
]

Expand Down
57 changes: 36 additions & 21 deletions src/Options/Applicative/Help/Pretty.hs
Original file line number Diff line number Diff line change
@@ -1,40 +1,41 @@
{-# LANGUAGE CPP #-}
{-# OPTIONS_GHC -fno-warn-warnings-deprecations #-}
module Options.Applicative.Help.Pretty
( module Text.PrettyPrint.ANSI.Leijen
( module Prettyprinter
, module Prettyprinter.Render.Terminal
, Doc
, indent
, renderPretty
, displayS
, SimpleDoc

, (.$.)
, (</>)

, groupOrNestLine
, altSep
, hangAtIfOver

, prettyString
) where

#if !MIN_VERSION_base(4,11,0)
import Data.Semigroup ((<>))
import Data.Semigroup ((<>), mempty)
#endif

import Text.PrettyPrint.ANSI.Leijen hiding (Doc, (<$>), (<>), columns, indent, renderPretty, displayS)
import qualified Text.PrettyPrint.ANSI.Leijen as PP
import Prettyprinter hiding (Doc)
import qualified Prettyprinter as PP
import qualified Prettyprinter.Render.String as PP
import Prettyprinter.Render.Terminal

import Prelude

type Doc = PP.Doc
type Doc = PP.Doc Prettyprinter.Render.Terminal.AnsiStyle
type SimpleDoc = SimpleDocStream AnsiStyle

indent :: Int -> PP.Doc -> PP.Doc
indent = PP.indent

renderPretty :: Float -> Int -> PP.Doc -> SimpleDoc
renderPretty = PP.renderPretty

displayS :: SimpleDoc -> ShowS
displayS = PP.displayS
linebreak :: Doc
linebreak = flatAlt line mempty

(.$.) :: Doc -> Doc -> Doc
(.$.) = (PP.<$>)

x .$. y = x <> line <> y
(</>) :: Doc -> Doc -> Doc
x </> y = x <> softline <> y

-- | Apply the function if we're not at the
-- start of our nesting level.
Expand All @@ -58,7 +59,6 @@ ifElseAtRoot f g doc =
then f doc
else g doc


-- | Render flattened text on this line, or start
-- a new line before rendering any text.
--
Expand All @@ -81,7 +81,7 @@ groupOrNestLine =
-- next line.
altSep :: Doc -> Doc -> Doc
altSep x y =
group (x <+> char '|' <> line) <//> y
group (x <+> pretty '|' <> line) <> group linebreak <> y


-- | Printer hacks to get nice indentation for long commands
Expand All @@ -102,3 +102,18 @@ hangAtIfOver i j d =
align d
else
linebreak <> ifAtRoot (indent i) d


renderPretty :: Double -> Int -> Doc -> SimpleDocStream AnsiStyle
renderPretty ribbonFraction lineWidth
= layoutSmart LayoutOptions
{ layoutPageWidth = AvailablePerLine lineWidth ribbonFraction }

prettyString :: Double -> Int -> Doc -> String
prettyString ribbonFraction lineWidth
= streamToString
. renderPretty ribbonFraction lineWidth

streamToString :: SimpleDocStream AnsiStyle -> String
streamToString stream =
PP.renderShowS stream ""
3 changes: 1 addition & 2 deletions src/Options/Applicative/Help/Types.hs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,5 @@ helpText (ParserHelp e s h u d b g f) =
-- | Convert a help text to 'String'.
renderHelp :: Int -> ParserHelp -> String
renderHelp cols
= (`displayS` "")
. renderPretty 1.0 cols
= prettyString 1.0 cols
. helpText
12 changes: 6 additions & 6 deletions tests/test.hs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import qualified Options.Applicative.NonEmpty


import qualified Options.Applicative.Help as H
import Options.Applicative.Help.Pretty (Doc, SimpleDoc(..))
import Options.Applicative.Help.Pretty (Doc)
import qualified Options.Applicative.Help.Pretty as Doc
import Options.Applicative.Help.Chunk
import Options.Applicative.Help.Levenshtein
Expand Down Expand Up @@ -951,9 +951,9 @@ prop_long_command_line_flow = once $
deriving instance Arbitrary a => Arbitrary (Chunk a)


equalDocs :: Float -> Int -> Doc -> Doc -> Property
equalDocs f w d1 d2 = Doc.displayS (Doc.renderPretty f w d1) ""
=== Doc.displayS (Doc.renderPretty f w d2) ""
equalDocs :: Double -> Int -> Doc -> Doc -> Property
equalDocs f w d1 d2 = Doc.prettyString f w d1
=== Doc.prettyString f w d2

prop_listToChunk_1 :: [String] -> Property
prop_listToChunk_1 xs = isEmpty (listToChunk xs) === null xs
Expand All @@ -967,10 +967,10 @@ prop_extractChunk_1 x = extractChunk (pure x) === x
prop_extractChunk_2 :: Chunk String -> Property
prop_extractChunk_2 x = extractChunk (fmap pure x) === x

prop_stringChunk_1 :: Positive Float -> Positive Int -> String -> Property
prop_stringChunk_1 :: Positive Double -> Positive Int -> String -> Property
prop_stringChunk_1 (Positive f) (Positive w) s =
equalDocs f w (extractChunk (stringChunk s))
(Doc.string s)
(Doc.pretty s)

prop_stringChunk_2 :: String -> Property
prop_stringChunk_2 s = isEmpty (stringChunk s) === null s
Expand Down

0 comments on commit 856046e

Please sign in to comment.