Arduinoの開発＆デバッグでよく困るのがprintf()がなかったり浮動小数点型など特定のデータ型に対応していないことだったりする。
printf()の完全実装は複雑かつ巨大すぎるので普段使いそうな機能に限定して作成してみたがコンパイル後のバイナリーに浮動小数点ライブラリがリンクされるとATmega32U4で約4Kほど。もう少し小さくしたいところではあるが．．．まぁ、こんなもんかな。
組み込み系では数値を文字列に変換する関数が実装されていないことも多いため効率は良くないが標準ライブラリを使わずに変換している。なのでほぼ全てのCPUで動作すると思う。
なお、書式のエラーチェックはしてないので間違った書式を指定してもエラーにはならないことに注意すること。
変換指定は次の形式をとる。（[ ]内は省略可能）
%[フラグ][0][最小フィールド幅][.精度][長さ修飾子]変換指定子
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
[フラグ] -: 左詰め +: +符号付き数値 [0] 0: ゼロ詰め数値 [最小フィールド幅] *: 引数で桁数を指定 [.精度] *: 引数で桁数を指定 [長さ修飾子][変換指定子] d : 符号付き10進数 (int) ld : 符号付き10進数 (long int) lld : 符号付き10進数 (long long int) zd : 符号付き10進数 (ssize_t) hhd : 符号付き10進数 (int8_t, char) hd : 符号付き10進数 (int16_t, short) I8d : 符号付き10進数 (int8_t) I16d: 符号付き10進数 (int16_t) I32d: 符号付き10進数 (int32_t) I64d: 符号付き10進数 (int64_t) jd : 符号付き10進数 (intmax_t) i : 符号付き10進数 (int) li : 符号付き10進数 (long int) lli : 符号付き10進数 (long long int) zi : 符号付き10進数 (ssize_t) hhi : 符号付き10進数 (int8_t, char) hi : 符号付き10進数 (int16_t, short) I8i : 符号付き10進数 (int8_t) I16i: 符号付き10進数 (int16_t) I32i: 符号付き10進数 (int32_t) I64i: 符号付き10進数 (int64_t) ji : 符号付き10進数 (intmax_t) u : 符号無し10進数 (unsigned int) lu : 符号無し10進数 (unsigned long int) llu : 符号無し10進数 (unsigned long long int) zu : 符号無し10進数 (size_t) hhu : 符号無し10進数 (uint8_t, unsigned char) hu : 符号無し10進数 (uint16_t, unsigned short) I8u : 符号無し10進数 (uint8_t) I16u: 符号無し10進数 (uint16_t) I32u: 符号無し10進数 (uint32_t) I64u: 符号無し10進数 (uint64_t) ju : 符号無し10進数 (uintmax_t) X : 大文字16進数 (unsigned int) lX : 大文字16進数 (unsigned long int) llX : 大文字16進数 (unsigned long long int) zX : 大文字16進数 (size_t) hhX : 大文字16進数 (uint8_t, unsigned char) hX : 大文字16進数 (uint16_t, unsigned short) I8X : 大文字16進数 (uint8_t) I16X: 大文字16進数 (uint16_t) I32X: 大文字16進数 (uint32_t) I64X: 大文字16進数 (uint64_t) jX : 大文字16進数 (uintmax_t) x : 小文字16進数 (unsigned int) lx : 小文字16進数 (unsigned long int) llx : 小文字16進数 (unsigned long long int) zx : 小文字16進数 (size_t) hhx : 小文字16進数 (uint8_t, unsigned char) hx : 小文字16進数 (uint16_t, unsigned short) I8x : 小文字16進数 (uint8_t) I16x: 小文字16進数 (uint16_t) I32x: 小文字16進数 (uint32_t) I64x: 小文字16進数 (uint64_t) jx : 小文字16進数 (uintmax_t) o : 8進数 (unsigned int) lo : 8進数 (unsigned long int) llo : 8進数 (unsigned long long int) zo : 8進数 (size_t) hho : 8進数 (uint8_t, unsigned char) ho : 8進数 (uint16_t, unsigned short) I8o : 8進数 (uint8_t) I16o: 8進数 (uint16_t) I32o: 8進数 (uint32_t) I64o: 8進数 (uint64_t) jo : 8進数 (uintmax_t) b : 2進数 (unsigned int) lb : 2進数 (unsigned long int) llb : 2進数 (unsigned long long int) zb : 2進数 (size_t) hhb : 2進数 (uint8_t, unsigned char) hb : 2進数 (uint16_t, unsigned short) I8b : 2進数 (uint8_t) I16b: 2進数 (uint16_t) I32b: 2進数 (uint32_t) I64b: 2進数 (uint64_t) jb : 2進数 (uintmax_t) f : 浮動小数点型10進数 (double) lf : 浮動小数点型10進数 (long double) Lf : 浮動小数点型10進数 (long double) F : 浮動小数点型10進数 (double) lF : 浮動小数点型10進数 (long double) LF : 浮動小数点型10進数 (long double) s : 文字列 c : 文字 % : '%'文字 |
【修正記録】
2024-09-23
int8_t/uint8_t, int16_t/uint16_tの対応を行ったのに伴い[長さ修飾子]’h’と’hh’も対応してみた。しかし、いろいろ追加してるうちにずいぶん大きくなった気がする．．．(-_-;)
2024-09-22
int32_t/uint32_t, int64_t/uint64_t, intmax_t/uintmax_tの対応を行った。それと浮動小数点の精度指定の不具合修正と浮動小数点の小数点以下桁数を最大16桁に変更。但し、AVRは最大7桁となる。
2024-09-21
性能とサイズの改善のためpow()関数をやめてテーブル参照方式に変更。小数点以下は最大9桁まで。この変更によりmath.hのインクルードが必要なくなった。あと数値文字変換がバグってたので修正。
【スケッチ】
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
#include "format.h" DECLARE_PRINTF(Serial) serfmt; StringFormat strfmt; void setup(void) { Serial.begin(115200); } void loop(void) { /* snprintf */ char buf[64]; strfmt.snprintf(buf, sizeof(buf), "%f\n", -123.001); Serial.print(buf); /* printf */ serfmt.printf("%f\n", -123.001); delay(1000); } |
【ダウンロード】
Formatライブラリ(zip形式)
【ライブラリ】
Arduino用に作ったのはPrintFormatクラスのみでArduino開発環境への明確な依存性はないため他の環境にも対応可能。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 |
/* format.h - String Format Library for ARDUINO Copyright (c) 2024 Sasapea's Lab. All right reserved. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. */ #pragma once #include <stdarg.h> #include <stdlib.h> #include <stdint.h> #if defined(ARDUINO_ARCH_AVR) #if !defined(FORMAT_SUPPORT_FLOAT_PRECISON) #define FORMAT_SUPPORT_FLOAT_PRECISON 0 #endif typedef int ssize_t; #endif #if !defined(FORMAT_SUPPORT_SSIZE_T) #define FORMAT_SUPPORT_SSIZE_T 1 #endif #if !defined(FORMAT_SUPPORT_FLOAT) #define FORMAT_SUPPORT_FLOAT 1 #endif #if !defined(FORMAT_SUPPORT_FLOAT_PRECISON) #define FORMAT_SUPPORT_FLOAT_PRECISON 1 #endif class Format { public: int printf(const char *format, ...) { va_list ap; va_start(ap, format); int nbytes = vprintf(format, ap); va_end(ap); return nbytes; } int vprintf(const char *format, va_list ap) { const char *p = format; char c; _count = 0; do { c = *p++; if (c == '%') { format_t option = {}; option.alignchar = (*p == '-' ? *p++ : 0); option.signchar = (*p == '+' ? *p++ : 0); option.fillchar = (*p == '0' ? *p++ : ' '); option.precision = -1; if ((*p >= '0') && (*p <= '9')) option.width = strtoul(p, (char **)&p, 10); else if (*p == '*') { ++p; option.width = va_arg(ap, int); } if (*p == '.') { ++p; if ((*p >= '0') && (*p <= '9')) option.precision = strtoul(p, (char **)&p, 10); else if (*p == '*') { ++p; option.precision = va_arg(ap, int); } } switch (*p) { case 'L': case 'l': do { ++p; if (option.type < TYPE_LONG_LONG_INT) ++option.type; } while ((*p == 'l') || (*p == 'L')); break; case 'z': ++p; option.type = TYPE_SIZE_T; break; case 'h': do { ++p; if (option.type < TYPE_LONG_LONG_INT) ++option.type; } while (*p == 'h'); option.type = TYPE_I16 - (option.type - 1); break; case 'I': switch (strtoul(++p, (char **)&p, 10)) { case 8: option.type = TYPE_I8; break; case 16: option.type = TYPE_I16; break; default: case 32: option.type = TYPE_I32; break; case 64: option.type = TYPE_I64; break; } break; case 'j': ++p; option.type = TYPE_IMAX; break; } switch (*p) { case 'd': case 'i': case 'u': case 'X': case 'x': case 'o': case 'b': switch (option.type) { default: option.type = TYPE_INT; /* fall through */ case TYPE_INT : option.value.i = va_arg(ap, int); break; case TYPE_LONG_INT : option.value.li = va_arg(ap, long int); break; case TYPE_LONG_LONG_INT: option.value.lli = va_arg(ap, long long int); break; case TYPE_SIZE_T : option.value.isize = va_arg(ap, size_t); break; case TYPE_I8 : option.value.i8 = va_arg(ap, int); break; case TYPE_I16 : option.value.i16 = va_arg(ap, int); break; case TYPE_I32 : option.value.i32 = va_arg(ap, int32_t); break; case TYPE_I64 : option.value.i64 = va_arg(ap, int64_t); break; case TYPE_IMAX : option.value.imax = va_arg(ap, intmax_t); break; } break; case 'f': case 'F': switch (option.type) { #if FORMAT_SUPPORT_FLOAT default: option.type = TYPE_INT; /* fall through */ case TYPE_INT : option.value.f = va_arg(ap, double); break; case TYPE_LONG_INT: option.value.lf = va_arg(ap, long double); break; #else default: option.type = TYPE_INT; /* fall through */ case TYPE_INT : va_arg(ap, double); break; case TYPE_LONG_INT: va_arg(ap, long double); break; #endif } option.type += TYPE_DOUBLE; break; default: option.type = TYPE_INT; break; } switch (*p++) { case 'd': /* %d - integer */ case 'i': /* %i - integer */ case 'f': /* %f - floating */ case 'F': /* %F - floating */ switch (option.type) { default: /* fall through */ case TYPE_INT: if ((int)option.value.i < 0) { option.value.i = 0 - option.value.i; option.signchar = '-'; } break; case TYPE_LONG_INT: if ((long int)option.value.li < 0) { option.value.li = 0 - option.value.li; option.signchar = '-'; } break; case TYPE_LONG_LONG_INT: if ((long long int)option.value.lli < 0) { option.value.lli = 0 - option.value.lli; option.signchar = '-'; } break; #if FORMAT_SUPPORT_SSIZE_T case TYPE_SIZE_T: if ((ssize_t)option.value.isize < 0) { option.value.isize = 0 - option.value.isize; option.signchar = '-'; } break; #endif case TYPE_I8: if ((int8_t)option.value.i8 < 0) { option.value.i8 = 0 - option.value.i8; option.signchar = '-'; } break; case TYPE_I16: if ((int16_t)option.value.i16 < 0) { option.value.i16 = 0 - option.value.i16; option.signchar = '-'; } break; case TYPE_I32: if ((int32_t)option.value.i32 < 0) { option.value.i32 = 0 - option.value.i32; option.signchar = '-'; } break; case TYPE_I64: if ((int64_t)option.value.i64 < 0) { option.value.i64 = 0 - option.value.i64; option.signchar = '-'; } break; case TYPE_IMAX: if ((intmax_t)option.value.imax < 0) { option.value.imax = 0 - option.value.imax; option.signchar = '-'; } break; #if FORMAT_SUPPORT_FLOAT case TYPE_DOUBLE: if (option.value.f < 0) { option.value.f = 0 - option.value.f; option.signchar = '-'; } break; case TYPE_LONG_DOUBLE: if (option.value.lf < 0) { option.value.lf = 0 - option.value.lf; option.signchar = '-'; } break; #endif } option.base = 10; nformat(option); break; case 'u': /* %u - unsigned integer */ option.base = 10; nformat(option); break; case 'X': /* %X - hex */ option.hexchar = 'A'; option.base = 16; nformat(option); break; case 'x': /* %x - hex */ option.hexchar = 'a'; option.base = 16; nformat(option); break; case 'o': /* %o - octal */ option.base = 8; nformat(option); break; case 'b': /* %b - binary */ option.base = 2; nformat(option); break; case 'c': /* %c - character */ putch_(va_arg(ap, int)); break; case 's': /* %s - string */ option.fillchar = ' '; putstr(option, va_arg(ap, char *)); break; case '%': /* %% - '%' character */ putch_('%'); break; default: putch_('?'); break; } } else if (c) putch_(c); } while (c); return _count; } protected: size_t _count; virtual int putch(char c) = 0; private: enum { TYPE_INT, TYPE_LONG_INT, TYPE_LONG_LONG_INT, TYPE_SIZE_T, TYPE_I8, TYPE_I16, TYPE_I32, TYPE_I64, TYPE_IMAX, TYPE_DOUBLE, TYPE_LONG_DOUBLE }; typedef struct { char alignchar; char signchar; char fillchar; char hexchar; size_t width; int precision; unsigned char type; unsigned char base; union { unsigned int i; unsigned long int li; unsigned long long int lli; size_t isize; uint8_t i8; uint16_t i16; uint32_t i32; uint64_t i64; uintmax_t imax; #if FORMAT_SUPPORT_FLOAT double f; long double lf; #endif } value; } format_t; void putch_(char c) { _count += putch(c); } void putstr(format_t& option, const char *str) { if (!str) str = "(null)"; size_t i, len = strlen(str); if ((option.precision >= 0) && (len > (size_t)option.precision)) len = option.precision; if (option.alignchar == '-') { for (i = 0; i < len; ++i) putch_(*str++); for (i = len; i < option.width; ++i) putch_(option.fillchar); } else { for (i = len; i < option.width; ++i) putch_(option.fillchar); for (i = 0; i < len; ++i) putch_(*str++); } } void nformat(format_t& option) { char buf[128], c, z, *p = buf + sizeof(buf); unsigned char n; #if FORMAT_SUPPORT_FLOAT_PRECISON == 0 uint32_t d; static constexpr int DEFAULT_PRECISION = 3; static constexpr typeof(d) POW10[] = { 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000 /* 7 */ }; #else uint64_t d; static constexpr int DEFAULT_PRECISION = 6; static constexpr typeof(d) POW10[] = { 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000, 100000000, 1000000000, 10000000000, 100000000000, 1000000000000, 10000000000000, 100000000000000, 1000000000000000, 10000000000000000 /* 16 */ }; #endif static constexpr unsigned char POW10_LIMIT = sizeof(POW10) / sizeof(POW10[0]) - 1; *--p = 0; switch (option.type) { case TYPE_DOUBLE: z = option.precision <= 0; n = option.precision < 0 ? DEFAULT_PRECISION : (option.precision < POW10_LIMIT ? option.precision : POW10_LIMIT); #if FORMAT_SUPPORT_FLOAT d = POW10[n]; d = (typeof(d))((option.value.f += 0.5 / d) * d) % d; #else d = 0; #endif while (d) { c = d % option.base; d /= option.base; if (c || !z) { *--p = '0' + c; z = 0; } --n; } if (!z) { while (n--) *--p = '0'; *--p = '.'; } option.precision = -1; option.type = TYPE_I64; #if FORMAT_SUPPORT_FLOAT option.value.i64 = option.value.f; #else option.value.i64 = 0; #endif break; case TYPE_LONG_DOUBLE: z = option.precision <= 0; n = option.precision < 0 ? DEFAULT_PRECISION : (option.precision < POW10_LIMIT ? option.precision : POW10_LIMIT); #if FORMAT_SUPPORT_FLOAT d = POW10[n]; d = (typeof(d))((option.value.lf += 0.5 / d) * d) % d; #else d = 0; #endif while (d) { c = d % option.base; d /= option.base; if (c || !z) { *--p = '0' + c; z = 0; } --n; } if (!z) { while (n--) *--p = '0'; *--p = '.'; } option.precision = -1; option.type = TYPE_IMAX; #if FORMAT_SUPPORT_FLOAT option.value.imax = option.value.lf; #else option.value.imax = 0; #endif break; } do { switch (option.type) { default: /* fall through */ case TYPE_INT: c = option.value.i % option.base; z = (option.value.i /= option.base) != 0; break; case TYPE_LONG_INT: c = option.value.li % option.base; z = (option.value.li /= option.base) != 0; break; case TYPE_LONG_LONG_INT: c = option.value.lli % option.base; z = (option.value.lli /= option.base) != 0; break; case TYPE_SIZE_T: c = option.value.isize % option.base; z = (option.value.isize /= option.base) != 0; break; case TYPE_I8: c = option.value.i8 % option.base; z = (option.value.i8 /= option.base) != 0; break; case TYPE_I16: c = option.value.i16 % option.base; z = (option.value.i16 /= option.base) != 0; break; case TYPE_I32: c = option.value.i32 % option.base; z = (option.value.i32 /= option.base) != 0; break; case TYPE_I64: c = option.value.i64 % option.base; z = (option.value.i64 /= option.base) != 0; break; case TYPE_IMAX: c = option.value.imax % option.base; z = (option.value.imax /= option.base) != 0; break; } if (c < 10) *--p = '0' + c; else *--p = option.hexchar + (c - 10); } while (z); if (option.signchar) *--p = option.signchar; putstr(option, p); } }; class StringFormat : public Format { public: int snprintf(char *buf, size_t n, const char *format, ...) { va_list ap; va_start(ap, format); int nbytes = vsnprintf(buf, n, format, ap); va_end(ap); return nbytes; } int vsnprintf(char *buf, size_t n, const char *format, va_list ap) { _buffer = buf; _length = n; int nbytes = vprintf(format, ap); buf[nbytes] = 0; return nbytes; } protected: int putch(char c) override { if (_count + 1 < _length) { *_buffer++ = c; return 1; } return 0; } private: char *_buffer; size_t _length; }; #define DECLARE_PRINTF(instance) PrintFormat<typeof(instance), instance> template<typename T, T &UART> class PrintFormat : public Format { protected: int putch(char c) override { if (c == '\n') UART.println(); else UART.print(c); return 1; } }; |