py/mpprint: Fix length calculation for strings with precision-modifier.

jeepee · dpgeorge · commit 5020b14d5419 · 2020-12-07T23:32:06.000+11:00
Two issues are tackled:

1. The calculation of the correct length to print is fixed to treat the
   precision as a maximum length instead as the exact length.
   This is done for both qstr (%q) and for regular str (%s).

2. Fix the incorrect use of mp_printf("%.*s") to mp_print_strn().

   Because of the fix of above issue, some testcases that would print
   an embedded null-byte (^@ in test-output) would now fail.
   The bug here is that "%s" was used to print null-bytes. Instead,
   mp_print_strn is used to make sure all bytes are outputted and the
   exact length is respected.

Test-cases are added for both %s and %q with a combination of precision
and padding specifiers.
diff --git a/ports/unix/coverage.c b/ports/unix/coverage.c
@@ -186,7 +186,7 @@ STATIC mp_obj_t extra_coverage(void) {
         mp_printf(&mp_plat_print, "%ld\n", 123); // long
         mp_printf(&mp_plat_print, "%lx\n", 0x123); // long hex
         mp_printf(&mp_plat_print, "%X\n", 0x1abcdef); // capital hex
-        mp_printf(&mp_plat_print, "%.2s %.3s\n", "abc", "abc"); // fixed string precision
+        mp_printf(&mp_plat_print, "%.2s %.3s '%4.4s' '%5.5q' '%.3q'\n", "abc", "abc", "abc", MP_QSTR_True, MP_QSTR_True); // fixed string precision
         mp_printf(&mp_plat_print, "%.*s\n", -1, "abc"); // negative string precision
         mp_printf(&mp_plat_print, "%b %b\n", 0, 1); // bools
         #ifndef NDEBUG
diff --git a/py/mpprint.c b/py/mpprint.c
@@ -484,10 +484,10 @@ int mp_vprintf(const mp_print_t *print, const char *fmt, va_list args) {
                 qstr qst = va_arg(args, qstr);
                 size_t len;
                 const char *str = (const char *)qstr_data(qst, &len);
-                if (prec < 0) {
-                    prec = len;
+                if (prec >= 0 && (size_t)prec < len) {
+                    len = prec;
                 }
-                chrs += mp_print_strn(print, str, prec, flags, fill, width);
+                chrs += mp_print_strn(print, str, len, flags, fill, width);
                 break;
             }
             case 's': {
@@ -499,10 +499,11 @@ int mp_vprintf(const mp_print_t *print, const char *fmt, va_list args) {
                     break;
                 }
                 #endif
-                if (prec < 0) {
-                    prec = strlen(str);
+                size_t len = strlen(str);
+                if (prec >= 0 && (size_t)prec < len) {
+                    len = prec;
                 }
-                chrs += mp_print_strn(print, str, prec, flags, fill, width);
+                chrs += mp_print_strn(print, str, len, flags, fill, width);
                 break;
             }
             case 'd': {
diff --git a/py/objstr.c b/py/objstr.c
@@ -123,10 +123,10 @@ STATIC void str_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t
     bool is_bytes = true;
     #endif
     if (kind == PRINT_RAW || (!MICROPY_PY_BUILTINS_STR_UNICODE && kind == PRINT_STR && !is_bytes)) {
-        mp_printf(print, "%.*s", str_len, str_data);
+        print->print_strn(print->data, (const char *)str_data, str_len);
     } else {
         if (is_bytes) {
-            mp_print_str(print, "b");
+            print->print_strn(print->data, "b", 1);
         }
         mp_str_print_quoted(print, str_data, str_len, is_bytes);
     }
diff --git a/py/objstrunicode.c b/py/objstrunicode.c
@@ -92,7 +92,7 @@ STATIC void uni_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t
     }
     #endif
     if (kind == PRINT_STR) {
-        mp_printf(print, "%.*s", str_len, str_data);
+        print->print_strn(print->data, (const char *)str_data, str_len);
     } else {
         uni_print_quoted(print, str_data, str_len);
     }
diff --git a/tests/unix/extra_coverage.py.exp b/tests/unix/extra_coverage.py.exp
@@ -4,7 +4,7 @@
 123
 123
 1ABCDEF
-ab abc
+ab abc ' abc' ' True' 'Tru'
 
 false true
 (null)

Original file line number	Diff line number	Diff line change
`@@ -484,10 +484,10 @@ int mp_vprintf(const mp_print_t print, const char fmt, va_list args) {`
`484`	`484`	`qstr qst = va_arg(args, qstr);`
`485`	`485`	`size_t len;`
`486`	`486`	`const char str = (const char )qstr_data(qst, &len);`
`487`		`- if (prec < 0) {`
`488`		`- prec = len;`
	`487`	`+ if (prec >= 0 && (size_t)prec < len) {`
	`488`	`+ len = prec;`
`489`	`489`	`}`
`490`		`- chrs += mp_print_strn(print, str, prec, flags, fill, width);`
	`490`	`+ chrs += mp_print_strn(print, str, len, flags, fill, width);`
`491`	`491`	`break;`
`492`	`492`	`}`
`493`	`493`	`case 's': {`
`@@ -499,10 +499,11 @@ int mp_vprintf(const mp_print_t print, const char fmt, va_list args) {`
`499`	`499`	`break;`
`500`	`500`	`}`
`501`	`501`	`#endif`
`502`		`- if (prec < 0) {`
`503`		`- prec = strlen(str);`
	`502`	`+ size_t len = strlen(str);`
	`503`	`+ if (prec >= 0 && (size_t)prec < len) {`
	`504`	`+ len = prec;`
`504`	`505`	`}`
`505`		`- chrs += mp_print_strn(print, str, prec, flags, fill, width);`
	`506`	`+ chrs += mp_print_strn(print, str, len, flags, fill, width);`
`506`	`507`	`break;`
`507`	`508`	`}`
`508`	`509`	`case 'd': {`
Original file line number	Diff line number	Diff line change
`@@ -123,10 +123,10 @@ STATIC void str_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t`
`123`	`123`	`bool is_bytes = true;`
`124`	`124`	`#endif`
`125`	`125`	`if (kind == PRINT_RAW \|\| (!MICROPY_PY_BUILTINS_STR_UNICODE && kind == PRINT_STR && !is_bytes)) {`
`126`		`- mp_printf(print, "%.*s", str_len, str_data);`
	`126`	`+ print->print_strn(print->data, (const char *)str_data, str_len);`
`127`	`127`	`} else {`
`128`	`128`	`if (is_bytes) {`
`129`		`- mp_print_str(print, "b");`
	`129`	`+ print->print_strn(print->data, "b", 1);`
`130`	`130`	`}`
`131`	`131`	`mp_str_print_quoted(print, str_data, str_len, is_bytes);`
`132`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ STATIC void uni_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t`
`92`	`92`	`}`
`93`	`93`	`#endif`
`94`	`94`	`if (kind == PRINT_STR) {`
`95`		`- mp_printf(print, "%.*s", str_len, str_data);`
	`95`	`+ print->print_strn(print->data, (const char *)str_data, str_len);`
`96`	`96`	`} else {`
`97`	`97`	`uni_print_quoted(print, str_data, str_len);`
`98`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`123`
`5`	`5`	`123`
`6`	`6`	`1ABCDEF`
`7`		`-ab abc`
	`7`	`+ab abc ' abc' ' True' 'Tru'`
`8`	`8`
`9`	`9`	`false true`
`10`	`10`	`(null)`