Add support for padding and char replication #14

wismill · 2023-09-04T09:25:29Z

Add Char replication functions prependChars and appendChars
Add padding functions justifyLeft, justifyRight and center.
Move low-level MArray manipulation to their own module Data.Text.Builder.Linear.Array.
Add corresponding tests and benchmarks.

See also #13, which propose a similar interface for padding.

Note that it adds a dependency on linear-base to use move and Ur.

wismill · 2023-09-05T10:40:26Z

Rebased.

Bodigrim · 2023-09-04T21:29:57Z

src/Data/Text/Builder/Linear/Char.hs

+-- "xxxxAAAxxx"
+-- >>> runBuffer (\b -> center 5 'x' (appendChars 6 'A' b))
+-- "AAAAAA"
+center ∷ Word → Char → Buffer ⊸ Buffer


Just curious, do you have a use case for such functions?

You mean the padding functions specifically? Mainly pretty-printing. For example, I generate some C files with lots of arrays, but I want them to be well presented to facilitate review, so padding with 0 for hex values and spaces for general text comes quite handy.

This also bring the API closer to the text one.

Could you possibly share a snippet using the proposed API? What happens when you already have some data in a Buffer and want to append a padded hexadecimal?

After try using the API with non-trivial examples, I see what you mean 😄

The immediate solution I came with is to add the following function to the API:

newEmptyBuffer ∷ Buffer ⊸ (# Buffer, Buffer #) newEmptyBuffer (Buffer t@(Text arr _ _)) = (# Buffer t, Buffer (if isPinned arr then memptyPinned else mempty) #)

then an example of the use of justifyRight is:

-- | Convenient function to append padded hex infixl 6 |>&& (|>&&) :: (Integral a, FiniteBits a) => Buffer ⊸ (Word, a) -> Buffer b |>&& (w, n) = case newEmptyBuffer b of (# b', empty #) -> (b' |># "0x"#) >< justifyRight w '0' (empty |>& n) -- Example runBuffer \b -> (b |># "Foo "#) |>&& (4, 0xf :: Word) |># "; "# |>&& (4, 0xabc :: Word) -- "Foo 0x000f; 0x0abc"

Yeah, let's add newEmptyBuffer than. Not sure about the name though...

Done. About naming: I did not named simply emptyBuffer because it requires an input. But I have not strong opinion about this. Other candidates: makeEmptyBuffer or the shorter mkEmptyBuffer.

wismill · 2023-09-08T16:53:41Z

@Bodigrim Rebased, with the dependency to linear-base removed by adapting the tiny part we need. I left their copyright, but the code is so tiny that I wonder if we could just apply our default copyright.

Bodigrim · 2023-09-09T19:45:44Z

@Bodigrim Rebased, with the dependency to linear-base removed by adapting the tiny part we need. I left their copyright, but the code is so tiny that I wonder if we could just apply our default copyright.

I think all we need is

fooInt :: (Int → a) → (Int ⊸ a)
fooInt = unsafeCoerce

fooWord :: (Word → a) → (Word ⊸ a)
fooWord = unsafeCoerce

There is nothing unsafe about them, so I'd suggest just define them in the module where they are used.

wismill · 2023-09-10T11:10:02Z

There is nothing unsafe about them, so I'd suggest just define them in the module where they are used.

@Bodigrim done.

Bodigrim · 2023-09-10T11:11:05Z

There is still a conflict in test/Main.hs?..

- Add `Char` replication functions `prependChars` and `appendChars` - Add padding functions `justifyLeft`, `justifyRight` and `center`. - Move low-level `MArray` manipulation to their own module `Data.Text.Builder.Linear.Array`. - Add corresponding tests and benchmarks.

Some situations may require a fresh empty buffer. For example, if one want to define a function that append padded hexadecimal numbers, the use of a mere `justifyRight` requires the input `Buffer` to be empty. We introduce `newEmptyBuffer` to solve this issue. It has the caveat to require an existing `Buffer`, because we need to to know if the array is pinned or not. Working example for padded hexadecimal numbers: -- | Convenient function to append padded hex infixl 6 |>&& (|>&&) ∷ (Integral a, FiniteBits a) ⇒ Buffer ⊸ (Word, a) → Buffer b |>&& (w, n) = case newEmptyBuffer b of (# b', empty #) → (b' |># "0x"#) >< justifyRight w '0' (empty |>& n) -- Example runBuffer \b → (b |># "Foo "#) |>&& (4, 0xf ∷ Word) |># "; "# |>&& (4, 0xabc ∷ Word) -- "Foo 0x000f; 0x0abc"

wismill · 2023-09-10T11:51:48Z

@Bodigrim Sorry for that, I did not see it. Fixed by rebasing.

Also, congrats for the release of tasty-1.5 ! I really like the progress info and the improvement of -p .

src/Data/Text/Builder/Linear/Array.hs

Bodigrim · 2023-09-10T20:16:04Z

src/Data/Text/Builder/Linear/Char.hs

+            prependExact
+              totalLen
+              (\dst dstOff → unsafeWrite dst dstOff ch *> unsafeTile dst dstOff totalLen cLen)
+              buff


Let's reduce code duplication here: in both cases you can run prependExact (utf8Length ch * fromIntegral count) fun buff, it's only fun which depends on isAscii ch.

utf8Length is a fast function, there is little to save by not calling it.

src/Data/Text/Builder/Linear/Char.hs

Bodigrim · 2023-09-10T20:17:13Z

src/Data/Text/Builder/Linear/Char.hs

+-- >>> runBuffer (\b -> justifyRight 10 'x' (appendChars 3 'A' b))
+-- "xxxxxxxAAA"
+-- >>> runBuffer (\b -> justifyRight 5 'x' (appendChars 6 'A' b))
+-- "AAAAAA"


Please add a usage example with newEmptyBuffer, it's untrivial to come up with for a new user.

Bodigrim · 2023-09-10T20:17:49Z

src/Data/Text/Builder/Linear/Core.hs

+-- The first 'Buffer' is the input and the second is a new empty 'Buffer'.
+--
+-- Note: a previous buffer is necessary in order to create an empty buffer with
+-- the same characteristics.


Please add a usage example.

Bodigrim · 2023-09-11T21:56:26Z

Thanks, great!

wismill mentioned this pull request Sep 4, 2023

Add support for ASCII chars #13

Closed

wismill marked this pull request as ready for review September 4, 2023 09:34

wismill force-pushed the buffer/char-padding branch from e7c1d4e to ad82069 Compare September 5, 2023 10:40

Bodigrim reviewed Sep 5, 2023

View reviewed changes

wismill force-pushed the buffer/char-padding branch from ad82069 to 2cba8f6 Compare September 8, 2023 16:51

wismill force-pushed the buffer/char-padding branch from 60a8b9b to b2d3c84 Compare September 10, 2023 11:08

wismill added 2 commits September 10, 2023 13:43

wismill force-pushed the buffer/char-padding branch from b2d3c84 to 2c4bb34 Compare September 10, 2023 11:46

Bodigrim reviewed Sep 10, 2023

View reviewed changes

Review fixes

9c3f237

Bodigrim merged commit db70163 into Bodigrim:master Sep 11, 2023
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for padding and char replication #14

Add support for padding and char replication #14

wismill commented Sep 4, 2023 •

edited

Loading

wismill commented Sep 5, 2023

Bodigrim Sep 4, 2023

wismill Sep 6, 2023

Bodigrim Sep 8, 2023

wismill Sep 9, 2023

Bodigrim Sep 9, 2023

wismill Sep 10, 2023

wismill commented Sep 8, 2023 •

edited

Loading

Bodigrim commented Sep 9, 2023

wismill commented Sep 10, 2023

Bodigrim commented Sep 10, 2023

wismill commented Sep 10, 2023 •

edited

Loading

Bodigrim Sep 10, 2023

wismill Sep 11, 2023

Bodigrim Sep 10, 2023

wismill Sep 11, 2023

Bodigrim Sep 10, 2023

wismill Sep 11, 2023

Bodigrim commented Sep 11, 2023

Add support for padding and char replication #14

Add support for padding and char replication #14

Conversation

wismill commented Sep 4, 2023 • edited Loading

wismill commented Sep 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wismill commented Sep 8, 2023 • edited Loading

Bodigrim commented Sep 9, 2023

wismill commented Sep 10, 2023

Bodigrim commented Sep 10, 2023

wismill commented Sep 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bodigrim commented Sep 11, 2023

wismill commented Sep 4, 2023 •

edited

Loading

wismill commented Sep 8, 2023 •

edited

Loading

wismill commented Sep 10, 2023 •

edited

Loading