/* Part of SWI-Prolog Author: Jan Wielemaker E-mail: J.Wielemaker@vu.nl WWW: http://www.swi-prolog.org Copyright (c) 2011-2022, University of Amsterdam VU University Amsterdam SWI-Prolog Solutions b.v. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Formatted output (Prolog predicates format/[1,2,3]). One day, the C source should also use format() to produce error messages, etc. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ #include "pl-fmt.h" #include "pl-ctype.h" #include "pl-utf8.h" #include "../pl-arith.h" #include "../pl-proc.h" #include "../pl-fli.h" #include "../pl-prims.h" #include "../pl-write.h" #include "../pl-pro.h" #include #include #include #include #ifdef __WINDOWS__ #include "../pl-nt.h" #endif typedef foreign_t (*Func1)(term_t a1); static char * formatInteger(PL_locale *locale, int div, int radix, bool smll, Number n, Buffer out); static char * formatFloat(PL_locale *locale, int how, int arg, Number f, Buffer out); #define MAXRUBBER 100 struct rubber { size_t where; /* where is rubber in output */ size_t size; /* how big should it be */ pl_wchar_t pad; /* padding character */ }; typedef struct { IOSTREAM *out; /* our output stream */ int column; /* current column */ tmp_buffer buffer; /* bin for characters with tabs */ size_t buffered; /* characters in buffer */ int pending_rubber; /* number of not-filled ~t's */ struct rubber rub[MAXRUBBER]; } format_state; #define BUFSIZE 1024 #define DEFAULT (-1) #define SHIFT { argc--; argv++; } #define NEED_ARG { if ( argc <= 0 ) \ { FMT_ERROR("not enough arguments"); \ } \ } #define FMT_ERROR(fmt) return PL_error(NULL, 0, NULL, ERR_FORMAT, fmt) #define FMT_ARG(c, a) return PL_error(NULL, 0, NULL, ERR_FORMAT_ARG, c, a) #define FMT_EXEPTION() return FALSE static PL_locale prolog_locale = { 0,0,LOCALE_MAGIC,1, L".", NULL }; static int update_column(int col, int c) { switch(c) { case '\n': return 0; case '\r': return 0; case '\t': return (col + 1) | 0x7; case '\b': return (col <= 0 ? 0 : col - 1); default: return col + 1; } } /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Low-level output. If there is pending rubber the output is stored in UTF-8 format in the state's `buffer'. The `buffered' field represents the number of UTF-8 characters in the buffer. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ static WUNUSED int outchr(format_state *state, int chr) { if ( state->pending_rubber ) { if ( chr > 0x7f ) { char buf[8]; char *s, *e; e = utf8_put_char(buf, chr); for(s=buf; sbuffer, *s, char); } else { char c = chr; addBuffer((Buffer)&state->buffer, c, char); } state->buffered++; } else { if ( Sputcode(chr, state->out) < 0 ) return FALSE; } state->column = update_column(state->column, chr); return TRUE; } /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Emit ASCII 0-terminated strings resulting from sprintf() on numeric arguments. No fuzz with wide characters here. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ static WUNUSED int outstring(format_state *state, const char *s, size_t len) { const char *q; const char *e = &s[len]; if ( state->pending_rubber ) { addMultipleBuffer(&state->buffer, s, len, char); state->buffered += len; } else { for(q=s; q < e; q++) { if ( Sputcode(*q&0xff, state->out) < 0 ) return FALSE; } } for(q=s; q < e; q++) state->column = update_column(state->column, *q&0xff); return TRUE; } static WUNUSED int oututf8(format_state *state, const char *s, size_t len) { const char *e = &s[len]; while(sencoding) { case ENC_ISO_LATIN_1: return outstring(state, txt->text.t, txt->length); case ENC_WCHAR: { const pl_wchar_t *s = txt->text.w; const pl_wchar_t *e = &s[txt->length]; while(sformat.predicates) static int update_column(int, Char); static bool do_format(IOSTREAM *fd, PL_chars_t *fmt, int ac, term_t av, Module m); static void distribute_rubber(struct rubber *, int, int); static WUNUSED int emit_rubber(format_state *state); /******************************** * PROLOG CONNECTION * ********************************/ word pl_format_predicate(term_t chr, term_t descr) { int c; predicate_t proc = NULL; size_t arity; if ( !PL_get_char_ex(chr, &c, FALSE) ) fail; if ( !get_procedure(descr, &proc, 0, GP_CREATE) ) fail; PL_predicate_info(proc, NULL, &arity, NULL); if ( arity == 0 ) return PL_error(NULL, 0, "arity must be > 0", ERR_DOMAIN, PL_new_atom("format_predicate"), descr); if ( !format_predicates ) format_predicates = newHTable(8); updateHTable(format_predicates, (void *)(intptr_t)c, proc); succeed; } word pl_current_format_predicate(term_t chr, term_t descr, control_t h) { GET_LD intptr_t name; predicate_t pred; TableEnum e; fid_t fid; switch( ForeignControl(h) ) { case FRG_FIRST_CALL: if ( !format_predicates ) fail; e = newTableEnum(format_predicates); break; case FRG_REDO: e = ForeignContextPtr(h); break; case FRG_CUTTED: e = ForeignContextPtr(h); freeTableEnum(e); default: succeed; } if ( !(fid = PL_open_foreign_frame()) ) { freeTableEnum(e); return FALSE; } while( advanceTableEnum(e, (void**)&name, (void**)&pred) ) { if ( PL_unify_integer(chr, name) && PL_unify_predicate(descr, pred, 0) ) { PL_close_foreign_frame(fid); ForeignRedoPtr(e); } PL_rewind_foreign_frame(fid); } PL_close_foreign_frame(fid); freeTableEnum(e); fail; } static word format_impl(IOSTREAM *out, term_t format, term_t Args, Module m) { GET_LD term_t argv; int argc = 0; term_t args = PL_copy_term_ref(Args); int rval; PL_chars_t fmt; if ( !PL_get_text(format, &fmt, CVT_ATOM|CVT_STRING|CVT_LIST|BUF_STACK) ) return PL_error("format", 3, NULL, ERR_TYPE, ATOM_text, format); if ( (argc = (int)lengthList(args, FALSE)) >= 0 ) { term_t head = PL_new_term_ref(); int n = 0; argv = PL_new_term_refs(argc); while( PL_get_list(args, head, args) ) PL_put_term(argv+n++, head); } else { argc = 1; argv = PL_new_term_refs(argc); PL_put_term(argv, args); } switch(fmt.storage) /* format can do call-back! */ { case PL_CHARS_RING: case PL_CHARS_STACK: PL_save_text(&fmt, BUF_MALLOC); break; default: break; } Slock(out); rval = do_format(out, &fmt, argc, argv, m); Sunlock(out); PL_free_text(&fmt); return rval; } word pl_format3(term_t out, term_t format, term_t args) { GET_LD redir_context ctx; word rc; Module m = NULL; term_t list = PL_new_term_ref(); if ( !PL_strip_module(args, &m, list) ) return FALSE; if ( (rc=setupOutputRedirect(out, &ctx, FALSE)) ) { if ( (rc = format_impl(ctx.stream, format, list, m)) ) rc = closeOutputRedirect(&ctx); else discardOutputRedirect(&ctx); } return rc; } word pl_format(term_t fmt, term_t args) { return pl_format3(0, fmt, args); } static inline int get_chr_from_text(const PL_chars_t *t, int index) { switch(t->encoding) { case ENC_ISO_LATIN_1: return t->text.t[index]&0xff; case ENC_WCHAR: return t->text.w[index]; default: assert(0); return 0; /* not reached */ } } typedef struct sub_state { char buf[BUFSIZE]; char *str; size_t bufsize; format_state *fstate; IOSTREAM *old_stream; } sub_state; static int prepare_sub_format(sub_state *state, format_state *fstate, IOSTREAM *fd) { state->fstate = fstate; if ( !fstate->pending_rubber && fd->position && fd->position->linepos == fstate->column ) { state->old_stream = Scurout; Scurout = fd; } else { state->old_stream = NULL; state->str = state->buf; state->bufsize = sizeof(state->buf); tellString(&state->str, &state->bufsize, ENC_UTF8); if ( true(fd, SIO_ISATTY) ) set(Scurout, SIO_ISATTY); } return TRUE; } static int end_sub_format(sub_state *state, int rc) { int lp = Scurout->position->linepos; if ( state->old_stream ) { Scurout = state->old_stream; if ( rc ) state->fstate->column = lp; } else { int lp = Scurout->position->linepos; toldString(); if ( rc ) { int c0 = state->fstate->column; rc = oututf8(state->fstate, state->str, state->bufsize); state->fstate->column = c0 + lp; } if ( state->str != state->buf ) free(state->str); } return rc; } /******************************** * ACTUAL FORMATTING * ********************************/ static bool do_format(IOSTREAM *fd, PL_chars_t *fmt, int argc, term_t argv, Module m) { GET_LD format_state state; /* complete state */ int tab_stop = 0; /* padded tab stop */ unsigned int here = 0; int rc = TRUE; state.out = fd; state.pending_rubber = 0; initBuffer(&state.buffer); state.buffered = 0; if ( fd->position ) state.column = fd->position->linepos; else state.column = 0; while(here < fmt->length) { int c = get_chr_from_text(fmt, here); switch(c) { case '~': { int arg = DEFAULT; /* Numeric argument */ int mod_colon = FALSE; /* Used colon modifier */ predicate_t proc; /* Get the numeric argument */ c = get_chr_from_text(fmt, ++here); if ( isDigitW(c) ) { arg = c - '0'; here++; while(here < fmt->length) { c = get_chr_from_text(fmt, here); if ( isDigitW(c) ) { int dw = c - '0'; int arg2 = arg*10 + dw; if ( (arg2 - dw)/10 != arg ) /* see mul64() in pl-arith.c */ { FMT_ERROR("argument overflow"); } arg = arg2; here++; } else break; } } else if ( c == '*' ) { NEED_ARG; if ( PL_get_integer(argv, &arg) && arg >= 0 ) { SHIFT; } else FMT_ERROR("no or negative integer for `*' argument"); c = get_chr_from_text(fmt, ++here); } else if ( c == '`' && here < fmt->length ) { arg = get_chr_from_text(fmt, ++here); c = get_chr_from_text(fmt, ++here); } if ( c == ':' ) { mod_colon = TRUE; c = get_chr_from_text(fmt, ++here); } /* Check for user defined format */ if ( format_predicates && (proc = lookupHTable(format_predicates, (void*)((intptr_t)c))) ) { size_t arity; term_t av; sub_state sstate; int i; PL_predicate_info(proc, NULL, &arity, NULL); av = PL_new_term_refs((int)arity); if ( arg == DEFAULT ) PL_put_atom(av+0, ATOM_default); else PL_put_integer(av+0, arg); for(i=1; i < arity; i++) { NEED_ARG; PL_put_term(av+i, argv); SHIFT; } if ( !(rc=prepare_sub_format(&sstate, &state, fd)) ) goto out; rc = PL_call_predicate(NULL, PL_Q_PASS_EXCEPTION, proc, av); rc = end_sub_format(&sstate, rc); if ( !rc ) goto out; here++; } else { switch(c) /* Build in formatting */ { case 'a': /* atomic */ { PL_chars_t txt; NEED_ARG; if ( !PL_get_text(argv, &txt, CVT_ATOMIC) ) FMT_ARG("a", argv); SHIFT; rc = outtext(&state, &txt); if ( !rc ) goto out; here++; break; } case 'c': /* ~c: character code */ { int chr; NEED_ARG; if ( PL_get_integer(argv, &chr) && chr >= 0 ) { int times = (arg == DEFAULT ? 1 : arg); SHIFT; while(times-- > 0) { rc = outchr(&state, chr); if ( !rc ) goto out; } } else FMT_ARG("c", argv); here++; break; } case 'e': /* exponential float */ case 'E': /* Exponential float */ case 'f': /* float */ case 'g': /* shortest of 'f' and 'e' */ case 'G': /* shortest of 'f' and 'E' */ { AR_CTX number n; union { tmp_buffer b; buffer b1; } u; PL_locale *l; NEED_ARG; AR_BEGIN(); if ( !valueExpression(argv, &n) ) { char f[2]; f[0] = c; f[1] = EOS; AR_CLEANUP(); FMT_ARG(f, argv); /* returns error */ } SHIFT; if ( c == 'f' && mod_colon ) l = fd->locale; else l = &prolog_locale; initBuffer(&u.b); rc = formatFloat(l, c, arg, &n, &u.b1) != NULL; clearNumber(&n); AR_END(); if ( rc ) rc = oututf80(&state, baseBuffer(&u.b, char)); discardBuffer(&u.b); if ( !rc ) goto out; here++; break; } case 'd': /* integer */ case 'D': /* grouped integer */ case 'r': /* radix number */ case 'R': /* Radix number */ case 'I': /* Prolog 1_000_000 */ { AR_CTX number i; tmp_buffer b; NEED_ARG; AR_BEGIN(); if ( !valueExpression(argv, &i) || !toIntegerNumber(&i, 0) ) { char f[2]; f[0] = c; f[1] = EOS; AR_CLEANUP(); FMT_ARG(f, argv); } SHIFT; initBuffer(&b); if ( c == 'd' || c == 'D' ) { PL_locale ltmp; PL_locale *l; static char grouping[] = {3,0}; if ( c == 'D' ) { ltmp.thousands_sep = L","; ltmp.decimal_point = L"."; ltmp.grouping = grouping; l = <mp; } else if ( mod_colon ) { l = fd->locale; } else { l = NULL; } if ( arg == DEFAULT ) arg = 0; if ( !formatInteger(l, arg, 10, TRUE, &i, (Buffer)&b) ) FMT_EXEPTION(); } else if ( c == 'I' ) { PL_locale ltmp; char grouping[2]; grouping[0] = (arg == DEFAULT ? 3 : arg); grouping[1] = '\0'; ltmp.thousands_sep = L"_"; ltmp.grouping = grouping; if ( !formatInteger(<mp, 0, 10, TRUE, &i, (Buffer)&b) ) FMT_EXEPTION(); } else /* r,R */ { if ( arg == DEFAULT ) arg = 8; if ( arg < 2 || arg > 36 ) { term_t r = PL_new_term_ref(); PL_put_integer(r, arg); return PL_error(NULL, 0, NULL, ERR_DOMAIN, ATOM_radix, r); } if ( !formatInteger(NULL, 0, arg, c == 'r', &i, (Buffer)&b) ) FMT_EXEPTION(); } clearNumber(&i); AR_END(); rc = oututf80(&state, baseBuffer(&b, char)); discardBuffer(&b); if ( !rc ) goto out; here++; break; } case 's': /* string */ { PL_chars_t txt; NEED_ARG; if ( !PL_get_text(argv, &txt, CVT_ATOM|CVT_LIST|CVT_STRING) ) FMT_ARG("s", argv); if ( arg != DEFAULT ) { if ( arg < 0 ) arg = 0; if ( arg < txt.length ) txt.length = arg; } rc = outtext(&state, &txt); PL_free_text(&txt); SHIFT; if ( !rc ) goto out; here++; break; } case 'i': /* ignore */ { NEED_ARG; SHIFT; here++; break; } { Func1 f; sub_state sstate; case 'k': /* write_canonical */ f = pl_write_canonical; goto pl_common; case 'p': /* print */ f = pl_print; goto pl_common; case 'q': /* writeq */ f = pl_writeq; goto pl_common; case 'w': /* write */ f = pl_write; pl_common: NEED_ARG; if ( !(rc=prepare_sub_format(&sstate, &state, fd)) ) goto out; rc = (int)(*f)(argv); rc = end_sub_format(&sstate, rc); if ( !rc ) goto out; SHIFT; here++; break; } case 'W': /* write_term(Value, Options) */ { sub_state sstate; if ( argc < 2 ) { FMT_ERROR("not enough arguments"); } if ( !(rc=prepare_sub_format(&sstate, &state, fd)) ) goto out; rc = (int)pl_write_term(argv, argv+1); rc = end_sub_format(&sstate, rc); if ( !rc ) goto out; SHIFT; SHIFT; here++; break; } case '@': { term_t ex = 0; sub_state sstate; fid_t fid; if ( argc < 1 ) { FMT_ERROR("not enough arguments"); } if ( !(rc=prepare_sub_format(&sstate, &state, fd)) ) goto out; rc = ( (fid=PL_open_foreign_frame()) && callProlog(m, argv, PL_Q_CATCH_EXCEPTION, &ex) ); if ( rc ) PL_rewind_foreign_frame(fid); rc = end_sub_format(&sstate, rc); if ( !rc ) { if ( ex && !PL_exception(0) ) rc = PL_raise_exception(ex); goto out; } SHIFT; here++; break; } case '~': /* ~ */ { rc = outchr(&state, '~'); if ( !rc ) goto out; here++; break; } case 'n': /* \n */ case 'N': /* \n if not on newline */ { if ( arg == DEFAULT ) arg = 1; if ( c == 'N' && state.column == 0 ) arg--; while( arg-- > 0 ) { rc = outchr(&state, '\n'); if ( !rc ) goto out; } here++; break; } case 't': /* insert tab */ { if ( state.pending_rubber >= MAXRUBBER ) FMT_ERROR("Too many tab stops"); state.rub[state.pending_rubber].where = state.buffered; state.rub[state.pending_rubber].pad = (arg == DEFAULT ? (pl_wchar_t)' ' : (pl_wchar_t)arg); state.rub[state.pending_rubber].size = 0; state.pending_rubber++; here++; break; } case '|': /* set tab */ { int stop; int nl_and_reindent; if ( arg == DEFAULT ) arg = state.column; /*FALLTHROUGH*/ case '+': /* tab relative */ if ( arg == DEFAULT ) arg = 8; stop = (c == '+' ? tab_stop + arg : arg); if ( stop < state.column && mod_colon ) nl_and_reindent = state.pending_rubber ? state.rub[state.pending_rubber-1].pad : ' '; else nl_and_reindent = 0; if ( state.pending_rubber == 0 ) /* nothing to distribute */ { state.rub[0].where = state.buffered; state.rub[0].pad = ' '; state.pending_rubber++; } distribute_rubber(state.rub, state.pending_rubber, stop - state.column); if ( !(rc=emit_rubber(&state)) ) goto out; if ( nl_and_reindent ) { if ( Sputcode('\n', state.out) < 0 ) { rc = FALSE; goto out; } state.column = update_column(state.column, '\n'); state.rub[0].where = state.buffered; state.rub[0].pad = nl_and_reindent; state.pending_rubber++; distribute_rubber(state.rub, state.pending_rubber, stop - state.column); if ( !(rc=emit_rubber(&state)) ) goto out; } state.column = tab_stop = stop; here++; break; } default: { term_t ex = PL_new_term_ref(); PL_put_atom(ex, codeToAtom(c)); return PL_error("format", 2, NULL, ERR_EXISTENCE, PL_new_atom("format_character"), ex); } } } break; /* the '~' switch */ } default: { rc = outchr(&state, c); if ( !rc ) goto out; here++; break; } } } if ( state.pending_rubber ) /* not closed ~t: flush out */ { if ( !(rc=emit_rubber(&state)) ) goto out; } if ( argc != 0 ) FMT_ERROR("too many arguments"); out: return rc; } static void distribute_rubber(struct rubber *r, int rn, int space) { if ( space > 0 ) { int s = space / rn; int n, m; for(n=0; n < rn; n++) /* give them equal size */ r[n].size = s; /* distribute from the center */ space -= s*rn; for(m = rn / 2, n = 0; space; n++, space--) { r[m + (n % 2 ? n : -n)].size++; } } else { int n; for(n=0; n < rn; n++) /* set all rubber to 0 */ r[n].size = 0; } } static WUNUSED int emit_rubber(format_state *state) { const char *s = baseBuffer(&state->buffer, char); const char *e = &s[entriesBuffer(&state->buffer, char)]; struct rubber *r = state->rub; int rn = state->pending_rubber; size_t j; for(j = 0; s <= e; j++) { int chr; while ( rn && r->where == j ) { size_t n; for(n=0; nsize; n++) { if ( Sputcode(r->pad, state->out) < 0 ) return FALSE; } r++; rn--; } if ( s < e ) { PL_utf8_code_point(&s, e, &chr); if ( Sputcode(chr, state->out) < 0 ) return FALSE; } else break; } discardBuffer(&state->buffer); initBuffer(&state->buffer); state->buffered = 0; state->pending_rubber = 0; return TRUE; } /* format an integer according to a number of modifiers at various radius. `split' is a boolean asking to put ',' between each group of three digits (e.g. 67,567,288). `div' askes to divide the number by radix^`div' before printing. `radix' is the radix used for conversion. `n' is the number to be converted. ** Fri Aug 19 22:26:41 1988 jan@swivax.UUCP (Jan Wielemaker) */ static void lappend(const wchar_t *l, int def, Buffer out) { if ( l ) { const wchar_t *e = l+wcslen(l); while (--e >= l) { int c = *e; if ( c < 128 ) { addBuffer(out, c, char); } else { char buf[6]; char *e8, *s; e8=utf8_put_char(buf, c); for(s=e8; --s>=buf; ) /* must be reversed as we reverse */ { addBuffer(out, *s, char); /* in the end */ } } } } else { addBuffer(out, def, char); } } static void revert_string(char *s, size_t len) { char *e = &s[len-1]; for(; e>s; s++,e--) { int c = *e; *e = *s; *s = c; } } static char * formatInteger(PL_locale *locale, int div, int radix, bool smll, Number i, Buffer out) { const char *grouping = NULL; if ( !locale ) { locale = &prolog_locale; } else { if ( locale->grouping && locale->grouping[0] && locale->thousands_sep && locale->thousands_sep[0] ) grouping = locale->grouping; } switch(i->type) { case V_INTEGER: { int64_t n = i->value.i; if ( n == 0 && div == 0 ) { addBuffer(out, '0', char); } else { int before = FALSE; /* before decimal point */ int negative = FALSE; int gsize = 0; int dweight; negative = (n < 0); while( n != 0 || div >= 0 ) { if ( div-- == 0 && !before ) { if ( !isEmptyBuffer(out) ) lappend(locale->decimal_point, '.', out); before = TRUE; if ( grouping ) gsize = grouping[0]; } if ( !negative ) dweight = (int)(n % radix); else dweight = -(int)(n % -radix); addBuffer(out, digitName(dweight, smll), char); n /= radix; if ( --gsize == 0 && n != 0 ) { lappend(locale->thousands_sep, ',', out); if ( grouping[1] == 0 ) gsize = grouping[0]; else if ( grouping[1] == CHAR_MAX ) gsize = 0; else gsize = *++grouping; } } if ( negative ) addBuffer(out, '-', char); } revert_string(baseBuffer(out, char), entriesBuffer(out, char)); addBuffer(out, EOS, char); return baseBuffer(out, char); } #ifdef O_BIGNUM case V_MPZ: { GET_LD size_t len = (double)mpz_sizeinbase(i->value.mpz, 2) * log(radix)/log(2) * 1.2; char tmp[256]; char *buf; int rc = TRUE; if ( len+2 > sizeof(tmp) ) buf = PL_malloc(len+2); else buf = tmp; EXCEPTION_GUARDED({ LD->gmp.persistent++; mpz_get_str(buf, radix, i->value.mpz); LD->gmp.persistent--; }, { LD->gmp.persistent--; rc = PL_rethrow(); }); if ( !rc ) return NULL; if ( !smll && radix > 10 ) { char *s; for(s=buf; *s; s++) *s = toupper(*s); } if ( grouping || div > 0 ) { int before = FALSE; /* before decimal point */ int gsize = 0; char *e = buf+strlen(buf)-1; while(e >= buf || div >= 0) { if ( div-- == 0 && !before ) { if ( !isEmptyBuffer(out) ) lappend(locale->decimal_point, '.', out); before = TRUE; if ( grouping ) gsize = grouping[0]; } addBuffer(out, *e, char); e--; if ( --gsize == 0 && e >= buf && *e != '-' ) { lappend(locale->thousands_sep, ',', out); if ( grouping[1] == 0 ) gsize = grouping[0]; else if ( grouping[1] == CHAR_MAX ) gsize = 0; else gsize = *++grouping; } } revert_string(baseBuffer(out, char), entriesBuffer(out, char)); } else { addMultipleBuffer(out, buf, strlen(buf), char); } if ( buf != tmp ) PL_free(buf); addBuffer(out, EOS, char); return baseBuffer(out, char); } #endif /*O_BIGNUM*/ default: assert(0); return NULL; } } static int countGroups(const char *grouping, int len) { int groups = 0; int gsize = grouping[0]; while(len>0) { len -= gsize; if ( len > 0 ) groups++; if ( grouping[1] == 0 ) { if ( len > 1 ) groups += (len-1)/grouping[0]; return groups; } else if ( grouping[1] == CHAR_MAX ) { return groups; } else { gsize = *++grouping; } } return groups; } static int ths_to_utf8(char *u8, const wchar_t *s, size_t len) { char *e = u8+len-7; for( ; u8decimal_point && l2->decimal_point && wcscmp(l1->decimal_point, l2->decimal_point) == 0 ) return TRUE; if ( !l1->decimal_point && !l2->decimal_point ) return TRUE; return FALSE; } static int utf8_dp(PL_locale *l, char *s, int *len) { if ( l->decimal_point ) { if ( !ths_to_utf8(s, l->decimal_point, 20) ) return FALSE; *len = (int)strlen(s); } else { *s++ = '.'; *s = EOS; *len = 1; } return TRUE; } /* localizeDecimalPoint() replaces the decimal point as entered by the local sensitive print functions by the one in the specified locale. This is overly complicated. Needs more testing, in particular for locales with (in UTF-8) multibyte decimal points. */ static int localizeDecimalPoint(PL_locale *locale, Buffer b) { if ( locale == GD->locale.default_locale || same_decimal_point(GD->locale.default_locale, locale) ) return TRUE; if ( locale->decimal_point && locale->decimal_point[0] ) { char *s = baseBuffer(b, char); char *e; char dp[20]; int dplen; char ddp[20]; int ddplen; if ( !utf8_dp(locale, dp, &dplen) || !utf8_dp(GD->locale.default_locale, ddp, &ddplen) ) return FALSE; if ( *s == '-' ) s++; for(e=s; *e && isDigit(*e); e++) ; if ( strncmp(e, ddp, ddplen) == 0 ) { if ( dplen == ddplen ) { memcpy(e, dp, dplen); } else { char *ob = baseBuffer(b, char); if ( dplen > ddplen && !growBuffer(b, dplen-ddplen) ) return PL_no_memory(); e += baseBuffer(b, char) - ob; memmove(&e[dplen-ddplen], e, strlen(e)+1); memcpy(e, dp, dplen); } } } return TRUE; } static int groupDigits(PL_locale *locale, Buffer b) { if ( locale->thousands_sep && locale->thousands_sep[0] && locale->grouping && locale->grouping[0] ) { char *s = baseBuffer(b, char); char *e; int groups; if ( *s == '-' ) s++; for(e=s; *e && isDigit(*e); e++) ; groups = countGroups(locale->grouping, (int)(e-s)); if ( groups > 0 ) { char *o; char *grouping = locale->grouping; int gsize = grouping[0]; char ths[20]; int thslen; if ( !ths_to_utf8(ths, locale->thousands_sep, sizeof(ths)) ) return FALSE; thslen = (int)strlen(ths); if ( !growBuffer(b, thslen*groups) ) return PL_no_memory(); memmove(&e[groups*thslen], e, strlen(e)+1); e--; for(o=e+groups*thslen; e>=s; ) { *o-- = *e--; if ( --gsize == 0 && e>=s ) { o -= thslen-1; memcpy(o, ths, thslen); o--; if ( grouping[1] == 0 ) gsize = grouping[0]; else if ( grouping[1] == CHAR_MAX ) gsize = 0; else gsize = *++grouping; } } } } return TRUE; } /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - formatFloat(PL_locale *locale, int how, int arg, Number f, Buffer out) formats a floating point number to a buffer. `How' is the format specifier ([eEfgG]), `arg' the argument. MPZ/MPQ numbers printed using the format specifier `f' are written using the following algorithm, courtesy of Jan Burse: Given: A rational n/m Seeked: The ration rounded to d fractional digits. Algorithm: Compute (n*10^d+m//2)//m, and place period at d. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ static char * formatFloat(PL_locale *locale, int how, int arg, Number f, Buffer out) { if ( arg == DEFAULT ) { arg = 6; } else if ( arg < 0 ) { GET_LD term_t a = PL_new_term_ref(); PL_put_integer(a, arg); PL_error(NULL, 0, NULL, ERR_DOMAIN, ATOM_not_less_than_zero, a); return NULL; } switch(f->type) { #ifdef O_GMP mpf_t mpf; mpz_t t1, t2; int neg; int exp; case V_MPZ: { switch(how) { case 'f': { mpz_init(t1); mpz_init(t2); mpz_ui_pow_ui(t1, 10, arg); mpz_mul(t1, f->value.mpz, t1); neg = mpz_sgn(t1) < 0; mpz_abs(t1, t1); goto print_mpz_f; } case 'e': case 'E': { mpz_init(t1); mpz_init(t2); mpz_set(t1, f->value.mpz); neg = mpz_sgn(t1) < 0; mpz_abs(t1, t1); if ( mpz_sgn(t1) == 0 ) { exp = 0; } else { exp = mpz_sizeinbase(t1, 10)-1; /* guess exponent */ mpz_ui_pow_ui(t2, 10, exp); if (mpz_cmp(t2, t1) > 0) exp--; /* correct exponent */ if (exp > arg) { mpz_ui_pow_ui(t2, 10, (exp-arg-1)); mpz_tdiv_q(t1, t1, t2); mpz_add_ui(t1, t1, 5); mpz_tdiv_q_ui(t1, t1, 10); } else { mpz_ui_pow_ui(t2, 10, arg-exp); mpz_mul(t1, t1, t2); } } mpz_set_ui(t2, exp); goto print_mpz_e; } case 'g': case 'G': { mpf_init2(mpf, arg*4); mpf_set_z(mpf, f->value.mpz); goto print_mpf; } } } case V_MPQ: { char tmp[12]; int size; int written; int fbits; int digits; int padding; switch(how) { case 'f': { mpz_init(t1); mpz_init(t2); mpz_ui_pow_ui(t1, 10, arg); mpz_mul(t1, mpq_numref(f->value.mpq), t1); mpz_tdiv_q_ui(t2, mpq_denref(f->value.mpq), 2); if (mpq_cmp_ui(f->value.mpq, 0, 1) < 0) { mpz_sub(t1, t1, t2); neg=1; } else { mpz_add(t1, t1, t2); neg=0; } mpz_tdiv_q(t1, t1, mpq_denref(f->value.mpq)); mpz_abs(t1, t1); print_mpz_f: if ( mpz_sgn(t1) != 0 ) { size = mpz_sizeinbase(t1, 2) * log(10)/log(2) * 1.2 + 1; if ( !growBuffer(out, size) ) { PL_no_memory(); return NULL; } mpz_get_str(baseBuffer(out, char), 10, t1); digits = written = strlen(baseBuffer(out, char)); } else { written = digits = 0; } if ( digits <= arg ) padding = (arg-digits+1); else padding = 0; size = digits; if (neg) size++; /* leading - */ if (arg) size++; /* decimal point */ if (padding) size += padding; /* leading '0's */ size++; /* NULL terminator */ if ( !growBuffer(out, size) ) { PL_no_memory(); return NULL; } if (!digits) { memset(out->base, '\0', 1); } if (padding) { memmove(out->base+padding, out->base, written+1); memset(out->base, '0', padding); written += padding; } if (arg) { memmove(out->base+written-(arg-1), out->base+written-arg, arg+1); if ( locale->decimal_point && locale->decimal_point[0] ) *(out->base+written-arg) = locale->decimal_point[0]; else *(out->base+written-arg) = '.'; written++; } if (neg) { memmove(out->base+1, out->base, written+1); memset(out->base, '-', 1); written++; } out->top = out->base + written; mpz_clear(t1); mpz_clear(t2); break; } case 'e': case 'E': { mpz_init(t1); mpz_init(t2); if (mpz_cmpabs(mpq_numref(f->value.mpq), mpq_denref(f->value.mpq)) >= 0) { mpz_tdiv_q(t1, mpq_numref(f->value.mpq), mpq_denref(f->value.mpq)); exp = mpz_sizeinbase(t1, 10)-1; /* guess exponent */ mpz_ui_pow_ui(t2, 10, exp); if (mpz_cmpabs(t2, t1) > 0) exp--; /* correct exponent */ } else { mpq_t tq1, tq2; mpq_init(tq1); mpq_init(tq2); mpz_set(t1, mpq_numref(f->value.mpq)); mpz_abs(t1, t1); mpz_tdiv_q(t1, mpq_denref(f->value.mpq), t1); exp = 0-mpz_sizeinbase(t1, 10); /* guess exponent */ mpz_ui_pow_ui(t2, 10, abs(exp)-1); mpq_set_z(tq1, t1); mpq_inv(tq2, f->value.mpq); if (mpz_cmpabs(t2, t1) == 0 && mpq_cmp(tq1, tq2)==0) exp++; if (mpz_cmpabs(t2, t1) > 0) exp++; /* correct exponent */ mpq_clear(tq1); mpq_clear(tq2); } mpz_ui_pow_ui(t1, 10, abs(arg-exp)); if (mpz_cmpabs(mpq_numref(f->value.mpq), mpq_denref(f->value.mpq)) >= 0 && exp > arg) { mpz_tdiv_q(t1, mpq_numref(f->value.mpq), t1); } else { mpz_mul(t1, mpq_numref(f->value.mpq), t1); } mpz_tdiv_q_ui(t2, mpq_denref(f->value.mpq), 2); if ( mpq_sgn(f->value.mpq) < 0) { mpz_sub(t1, t1, t2); neg=1; } else { mpz_add(t1, t1, t2); neg=0; } mpz_tdiv_q(t1, t1, mpq_denref(f->value.mpq)); mpz_abs(t1, t1); mpz_ui_pow_ui(t2, 10, arg+1); if (mpz_cmpabs(t2, t1) == 0) { mpz_tdiv_q_ui(t1, t1, 10); exp++; } mpz_set_ui(t2, abs(exp)); print_mpz_e: if ( mpz_sgn(t1) == 0 ) size = arg+7; /* reserve for 0.+e00 */ else size = mpz_sizeinbase(t1, 10) + mpz_sizeinbase(t2, 10) + 6; /* reserve for -.e+0 */ if ( !growBuffer(out, size) ) { PL_no_memory(); return NULL; } written = gmp_snprintf(baseBuffer(out, char), size, "%Zd%c%+03d", t1, how, exp); if ( mpz_sgn(t1) == 0 ) { memmove(out->base+arg, out->base, written+1); memset(out->base, '0', arg); written += arg; } if (arg) { memmove(out->base+2, out->base+1, written+1); if ( locale->decimal_point && locale->decimal_point[0] ) *(out->base+1) = locale->decimal_point[0]; else *(out->base+1) = '.'; written++; } if (neg) { memmove(out->base+1, out->base, written+1); memset(out->base, '-', 1); written++; } out->top = out->base + written; mpz_clear(t1); mpz_clear(t2); return baseBuffer(out, char); } case 'g': case 'G': { switch(how) { case 'g': case 'G': { mpz_t iv; mpz_init(iv); mpz_set_q(iv, f->value.mpq); fbits = (int)mpz_sizeinbase(iv, 2) + 4*arg; mpz_clear(iv); break; } default: fbits = 4*arg; } mpf_init2(mpf, fbits); mpf_set_q(mpf, f->value.mpq); print_mpf: Ssprintf(tmp, "%%.%dF%c", arg, how); size = 0; written = arg+4; while(written >= size) { size = written+1; if ( !growBuffer(out, size) ) /* reserve for -.e */ { PL_no_memory(); return NULL; } written = gmp_snprintf(baseBuffer(out, char), size, tmp, mpf); } mpf_clear(mpf); out->top = out->base + written; break; } } break; } #elif O_BF { mpz_t n; case V_MPZ: mpz_init(n); mpz_set(n, f->value.mpz); goto bf_print; case V_MPQ: { bf_flags_t flags; int upcase; limb_t prec = ((double)(arg+2) * log(10)/log(2)); if ( how == 'f' ) /* we must compensate for the integer */ { mpz_t i; mpz_init(i); mpz_set_q(i, f->value.mpq); prec += mpz_sizeinbase(i, 2); mpz_clear(i); } mpz_init(n); bf_div(n, mpq_numref(f->value.mpq), mpq_denref(f->value.mpq), prec, BF_RNDN); bf_print: upcase = FALSE; switch(how) { case 'f': flags = BF_FTOA_FORMAT_FRAC; break; case 'E': upcase = TRUE; case 'e': arg++; /* LibBF counts total, we after . */ flags = BF_FTOA_FORCE_EXP|BF_FTOA_FORMAT_FIXED; break; case 'G': upcase = TRUE; case 'g': flags = BF_FTOA_FORMAT_FREE; break; default: flags = 0; assert(0); } size_t size; char *s = bf_ftoa(&size, n, 10, arg, BF_RNDN|BF_FTOA_PL_QUIRKS|flags); if ( !growBuffer(out, size+1) ) { PL_no_memory(); return NULL; } strcpy(baseBuffer(out, char), s); bf_free(n->ctx, s); if ( upcase ) { char *exp = strchr(baseBuffer(out, char), 'e'); if ( exp ) *exp = 'E'; } mpz_clear(n); break; } } #endif /* O_GMP OR O_BF */ case V_INTEGER: promoteToFloatNumber(f); /*FALLTHROUGH*/ case V_FLOAT: { char tmp[12]; int written = arg+20; int size = 0; Ssprintf(tmp, "%%.%d%c", arg, how); while(written >= size) { size = written+1; if ( !growBuffer(out, size) ) { PL_no_memory(); return NULL; } written = snprintf(baseBuffer(out, char), size, tmp, f->value.f); #ifdef __WINDOWS__ if ( written < 0 ) /* pre-C99 Windows snprintf() returns -1 */ written = size*2; #endif } #ifdef __WINDOWS__ /* Write all ~e formatted floats in POSIX notation: * exponent must contain at least 2 digits * only as many digits as necessary to represent the exponent */ switch(how) { case 'e': case 'E': case 'g': case 'G': { if (written >= 7 && ( *(out->base + written - 5) == 'e' || *(out->base + written - 5) == 'E' ) && ( *(out->base + written - 3) == '0' )) { memmove(out->base + written-3, out->base + written-2, 3); written--; } } } #endif out->top = out->base + written; break; } default: assert(0); return NULL; } if ( locale ) { if ( !localizeDecimalPoint(locale, out) || !groupDigits(locale, out) ) return NULL; } return baseBuffer(out, char); }