From 93b04767510883a8b42582e8c16294f221a55372 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Sat, 5 Jan 2019 23:47:56 +0100 Subject: [PATCH] Fix text wrapping when colors cross message boundaries. --- src/ircutils.py | 30 +++++++++++++++++++++++++++++- test/test_ircutils.py | 5 +++++ 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/src/ircutils.py b/src/ircutils.py index 18ed806c7..1512c9a22 100644 --- a/src/ircutils.py +++ b/src/ircutils.py @@ -535,10 +535,21 @@ class FormatContext(object): s += '\x0f' return s + def size(self): + """Returns the number of bytes needed to reproduce this context in an + IRC string.""" + prefix_size = self.bold + self.reverse + self.underline + \ + bool(self.fg) + bool(self.bg) + if prefix_size: + return prefix_size + 1 # '\x0f' + else: + return 0 + class FormatParser(object): def __init__(self, s): self.fd = minisix.io.StringIO(s) self.last = None + self.max_context_size = 0 def getChar(self): if self.last is not None: @@ -557,14 +568,22 @@ class FormatParser(object): while c: if c == '\x02': context.bold = not context.bold + self.max_context_size = max( + self.max_context_size, context.size()) elif c == '\x16': context.reverse = not context.reverse + self.max_context_size = max( + self.max_context_size, context.size()) elif c == '\x1f': context.underline = not context.underline + self.max_context_size = max( + self.max_context_size, context.size()) elif c == '\x0f': context.reset() elif c == '\x03': self.getColor(context) + self.max_context_size = max( + self.max_context_size, context.size()) c = self.getChar() return context @@ -597,8 +616,17 @@ class FormatParser(object): self.ungetChar(c) def wrap(s, length, break_on_hyphens = False): + # Get the maximum number of bytes needed to format a chunk of the string + # at any point. + # This is an overapproximation of what each chunk will need, but it's + # either that or make the code of byteTextWrap aware of contexts, and its + # code is complicated enough as it is already. + parser = FormatParser(s) + parser.parse() + format_overhead = parser.max_context_size + processed = [] - chunks = utils.str.byteTextWrap(s, length) + chunks = utils.str.byteTextWrap(s, length - format_overhead) context = None for chunk in chunks: if context is not None: diff --git a/test/test_ircutils.py b/test/test_ircutils.py index 78cc5ab40..ec36ff87f 100644 --- a/test/test_ircutils.py +++ b/test/test_ircutils.py @@ -227,6 +227,11 @@ class FunctionsTestCase(SupyTestCase): r = ircutils.wrap(s, 139) self.assertTrue(max(map(pred, r)) <= 139) + s = '\x02\x16 barbazqux' + ('foobarbazqux ' * 20)[0:-1] + r = ircutils.wrap(s, 91) + print(list(map(pred, r))) + self.assertTrue(max(map(pred, r)) <= 91) + def testSafeArgument(self): s = 'I have been running for 9 seconds'