femtolisp/femtolisp/print.c

static ptrhash_t printconses;
static u_int32_t printlabel;
static int print_pretty;

static int HPOS, VPOS;
static void outc(char c, FILE *f)
{
    fputc(c, f);
    HPOS++;
}
static void outs(char *s, FILE *f)
{
    fputs(s, f);
    HPOS += u8_strwidth(s);
}
static void outindent(int n, FILE *f)
{
    fputc('\n', f);
    VPOS++;
    HPOS = n;
    while (n >= 8) {
        fputc('\t', f);
        n -= 8;
    }
    while (n) {
        fputc(' ', f);
        n--;
    }
}

static void print_traverse(value_t v)
{
    value_t *bp;
    while (iscons(v)) {
        if (ismarked(v)) {
            bp = (value_t*)ptrhash_bp(&printconses, (void*)v);
            if (*bp == (value_t)PH_NOTFOUND)
                *bp = fixnum(printlabel++);
            return;
        }
        mark_cons(v);
        print_traverse(car_(v));
        v = cdr_(v);
    }
    if (!ismanaged(v) || issymbol(v))
        return;
    if (ismarked(v)) {
        bp = (value_t*)ptrhash_bp(&printconses, (void*)v);
        if (*bp == (value_t)PH_NOTFOUND)
            *bp = fixnum(printlabel++);
        return;
    }
    if (isvector(v)) {
        mark_cons(v);
        unsigned int i;
        for(i=0; i < vector_size(v); i++)
            print_traverse(vector_elt(v,i));
    }
    else {
        assert(iscvalue(v));
        cvalue_t *cv = (cvalue_t*)ptr(v);
        // don't consider shared references to ""
        if (!cv->flags.cstring || cv_len(cv)!=0)
            mark_cons(v);
    }
}

static void print_symbol_name(FILE *f, char *name)
{
    int i, escape=0, charescape=0;

    if ((name[0] == '\0') ||
        (name[0] == '.' && name[1] == '\0') ||
        (name[0] == '#') ||
        isnumtok(name, NULL))
        escape = 1;
    i=0;
    while (name[i]) {
        if (!symchar(name[i])) {
            escape = 1;
            if (name[i]=='|' || name[i]=='\\') {
                charescape = 1;
                break;
            }
        }
        i++;
    }
    if (escape) {
        if (charescape) {
            outc('|', f);
            i=0;
            while (name[i]) {
                if (name[i]=='|' || name[i]=='\\')
                    outc('\\', f);
                outc(name[i], f);
                i++;
            }
            outc('|', f);
        }
        else {
            outc('|', f);
            outs(name, f);
            outc('|', f);
        }
    }
    else {
        outs(name, f);
    }
}

/*
  The following implements a simple pretty-printing algorithm. This is
  an unlimited-width approach that doesn't require an extra pass.
  It uses some heuristics to guess whether an expression is "small",
  and avoids wrapping symbols across lines. The result is high
  performance and nice output for typical code. Quality is poor for
  pathological or deeply-nested expressions, but those are difficult
  to print anyway.
*/
static inline int tinyp(value_t v)
{
    return (issymbol(v) || isfixnum(v) || isbuiltinish(v));
}

static int smallp(value_t v)
{
    if (tinyp(v)) return 1;
    if (isnumber(v)) return 1;
    if (iscons(v)) {
        if (tinyp(car_(v)) && (tinyp(cdr_(v)) ||
                               (iscons(cdr_(v)) && tinyp(car_(cdr_(v))) &&
                                cdr_(cdr_(v))==NIL)))
            return 1;
        return 0;
    }
    if (isvector(v)) {
        size_t s = vector_size(v);
        return (s == 0 || (tinyp(vector_elt(v,0)) &&
                           (s == 1 || (s == 2 &&
                                       tinyp(vector_elt(v,1))))));
    }
    return 0;
}

static int specialindent(value_t head)
{
    // indent these forms 2 spaces, not lined up with the first argument
    if (head == LAMBDA || head == TRYCATCH || head == defunsym ||
        head == defmacrosym || head == forsym || head == labelsym)
        return 2;
    return -1;
}

static int lengthestimate(value_t v)
{
    // get the width of an expression if we can do so cheaply
    if (issymbol(v))
        return u8_strwidth(symbol_name(v));
    return -1;
}

static int allsmallp(value_t v)
{
    int n = 1;
    while (iscons(v)) {
        if (!smallp(car_(v)))
            return 0;
        v = cdr_(v);
        n++;
        if (n > 25)
            return n;
    }
    return n;
}

static int indentafter3(value_t head, value_t v)
{
    // for certain X always indent (X a b c) after b
    return ((head == defunsym || head == defmacrosym || head == forsym) &&
            !allsmallp(cdr_(v)));
}

static int indentevery(value_t v)
{
    // indent before every subform of a special form, unless every
    // subform is "small"
    value_t c = car_(v);
    if (c == LAMBDA || c == labelsym)
        return 0;
    value_t f;
    if (issymbol(c) && (f=((symbol_t*)ptr(c))->syntax) && isspecial(f))
        return !allsmallp(cdr_(v));
    return 0;
}

static int blockindent(value_t v)
{
    // in this case we switch to block indent mode, where the head
    // is no longer considered special:
    // (a b c d e
    //  f g h i j)
    return (allsmallp(v) > 9);
}

static void print_pair(FILE *f, value_t v, int princ)
{
    value_t cd;
    char *op = NULL;
    if (iscons(cdr_(v)) && cdr_(cdr_(v)) == NIL &&
        !ptrhash_has(&printconses, (void*)cdr_(v)) &&
        (((car_(v) == QUOTE)     && (op = "'"))  ||
         ((car_(v) == BACKQUOTE) && (op = "`"))  ||
         ((car_(v) == COMMA)     && (op = ","))  ||
         ((car_(v) == COMMAAT)   && (op = ",@")) ||
         ((car_(v) == COMMADOT)  && (op = ",.")))) {
        // special prefix syntax
        unmark_cons(v);
        unmark_cons(cdr_(v));
        outs(op, f);
        do_print(f, car_(cdr_(v)), princ);
        return;
    }
    int startpos = HPOS;
    outc('(', f);
    int newindent=HPOS, blk=blockindent(v);
    int lastv, n=0, si, ind=0, est, always=0, nextsmall;
    if (!blk) always = indentevery(v);
    value_t head = car_(v);
    int after3 = indentafter3(head, v);
    while (1) {
        lastv = VPOS;
        unmark_cons(v);
        do_print(f, car_(v), princ);
        cd = cdr_(v);
        if (!iscons(cd) || ptrhash_has(&printconses, (void*)cd)) {
            if (cd != NIL) {
                outs(" . ", f);
                do_print(f, cd, princ);
            }
            outc(')', f);
            break;
        }

        if (princ || !print_pretty ||
            ((head == LAMBDA || head == labelsym) && n == 0)) {
            // never break line before lambda-list or in princ
            ind = 0;
        }
        else {
            est = lengthestimate(car_(cd));
            nextsmall = smallp(car_(cd));
            ind = (((n > 0) &&
                    ((!nextsmall && HPOS>28) || (VPOS > lastv))) ||
                   
                   ((VPOS > lastv) && (!nextsmall || n==0)) ||
                   
                   (HPOS > 50 && !nextsmall) ||
                   
                   (HPOS > 74) ||
                   
                   (est!=-1 && (HPOS+est > 78)) ||
                   
                   ((head == LAMBDA || head == labelsym) && !nextsmall) ||
                   
                   (n > 0 && always) ||
                   
                   (n == 2 && after3));
        }

        if (ind) {
            outindent(newindent, f);
        }
        else {
            outc(' ', f);
            if (n==0) {
                // set indent level after printing head
                si = specialindent(head);
                if (si != -1)
                    newindent = startpos + si;
                else if (!blk)
                    newindent = HPOS;
            }
        }
        n++;
        v = cd;
    }
}

void cvalue_print(FILE *f, value_t v, int princ);

static void do_print(FILE *f, value_t v, int princ)
{
    value_t label;
    char *name;

    switch (tag(v)) {
    case TAG_NUM :
    case TAG_NUM1: HPOS+=fprintf(f, "%ld", numval(v)); break;
    case TAG_SYM:
        name = symbol_name(v);
        if (princ)
            outs(name, f);
        else if (v == NIL)
            outs("()", f);
        else if (ismanaged(v)) {
            outs("#:", f);
            outs(name, f);
        }
        else
            print_symbol_name(f, name);
        break;
    case TAG_BUILTIN:
        if (isbuiltin(v)) {
            outs("#.", f);
            outs(builtin_names[uintval(v)], f);
            break;
        }
        cvalue_print(f, v, princ);
        break;
    case TAG_CVALUE:
    case TAG_VECTOR:
    case TAG_CONS:
        if ((label=(value_t)ptrhash_get(&printconses, (void*)v)) !=
            (value_t)PH_NOTFOUND) {
            if (!ismarked(v)) {
                HPOS+=fprintf(f, "#%ld#", numval(label));
                return;
            }
            HPOS+=fprintf(f, "#%ld=", numval(label));
        }
        if (isvector(v)) {
            outc('[', f);
            int newindent = HPOS, est;
            unmark_cons(v);
            int i, sz = vector_size(v);
            for(i=0; i < sz; i++) {
                do_print(f, vector_elt(v,i), princ);
                if (i < sz-1) {
                    if (princ) {
                        outc(' ', f);
                    }
                    else {
                        est = lengthestimate(vector_elt(v,i+1));
                        if (HPOS > 74 || (est!=-1 && (HPOS+est > 78)) ||
                            (HPOS > 40 && !smallp(vector_elt(v,i+1))))
                            outindent(newindent, f);
                        else
                            outc(' ', f);
                    }
                }
            }
            outc(']', f);
            break;
        }
        if (iscvalue(v)) {
            unmark_cons(v);
            cvalue_print(f, v, princ);
            break;
        }
        print_pair(f, v, princ);
        break;
    }
}

void print_string(FILE *f, char *str, size_t sz)
{
    char buf[512];
    size_t i = 0;

    outc('"', f);
    while (i < sz) {
        u8_escape(buf, sizeof(buf), str, &i, sz, 1, 0);
        outs(buf, f);
    }
    outc('"', f);
}

static numerictype_t sym_to_numtype(value_t type);

// 'weak' means we don't need to accurately reproduce the type, so
// for example #int32(0) can be printed as just 0. this is used
// printing in a context where a type is already implied, e.g. inside
// an array.
static void cvalue_printdata(FILE *f, void *data, size_t len, value_t type,
                             int princ, int weak)
{
    int64_t tmp=0;

    if (type == charsym) {
        // print chars as characters when possible
        unsigned char ch = *(unsigned char*)data;
        if (princ)
            outc(ch, f);
        else if (weak)
            HPOS+=fprintf(f, "%hhu", ch);
        else if (isprint(ch))
            HPOS+=fprintf(f, "#\\%c", ch);
        else
            HPOS+=fprintf(f, "#char(%hhu)", ch);
    }
    /*
    else if (type == ucharsym) {
        uchar ch = *(uchar*)data;
        if (princ)
            outc(ch, f);
        else {
            if (!weak)
                fprintf(f, "#uchar(");
            fprintf(f, "%hhu", ch);
            if (!weak)
                outs(")", f);
        }
    }
    */
    else if (type == wcharsym) {
        uint32_t wc = *(uint32_t*)data;
        char seq[8];
        if (weak)
            HPOS+=fprintf(f, "%d", (int)wc);
        else if (princ || (iswprint(wc) && wc>0x7f)) {
            // reader only reads #\c syntax as wchar if the code is >0x7f
            size_t nb = u8_toutf8(seq, sizeof(seq), &wc, 1);
            seq[nb] = '\0';
            // TODO: better multibyte handling
            if (!princ) outs("#\\", f);
            outs(seq, f);
        }
        else {
            HPOS+=fprintf(f, "#%s(%d)", symbol_name(type), (int)wc);
        }
    }
    else if (type == int64sym
#ifdef BITS64
             || type == longsym
#endif
             ) {
        int64_t i64 = *(int64_t*)data;
        if (fits_fixnum(i64) || princ) {
            if (weak || princ)
                HPOS+=fprintf(f, "%lld", i64);
            else
                HPOS+=fprintf(f, "#%s(%lld)", symbol_name(type), i64);
        }
        else
            HPOS+=fprintf(f, "#%s(0x%08x%08x)", symbol_name(type),
                          (uint32_t)(i64>>32),
                          (uint32_t)(i64));
    }
    else if (type == uint64sym
#ifdef BITS64
             || type == ulongsym
#endif
             ) {
        uint64_t ui64 = *(uint64_t*)data;
        if (fits_fixnum(ui64) || princ) {
            if (weak || princ)
                HPOS+=fprintf(f, "%llu", ui64);
            else
                HPOS+=fprintf(f, "#%s(%llu)", symbol_name(type), ui64);
        }
        else
            HPOS+=fprintf(f, "#%s(0x%08x%08x)", symbol_name(type),
                          (uint32_t)(ui64>>32),
                          (uint32_t)(ui64));
    }
    else if (type == lispvaluesym) {
        // TODO
    }
    else if (type == floatsym || type == doublesym) {
        char buf[64];
        double d;
        int ndec;
        if (type == floatsym) { d = (double)*(float*)data; ndec = 8; }
        else { d = *(double*)data; ndec = 16; }
        snprint_real(buf, sizeof(buf), d, 0, ndec, 3, 10);
        if (weak || princ || strpbrk(buf, ".eE")) {
            outs(buf, f);
            if (type == floatsym) outc('f', f);
        }
        else {
            if (!DFINITE(d))
                HPOS+=fprintf(f, "#%s(\"%s\")", symbol_name(type), buf);
            else
                HPOS+=fprintf(f, "#%s(%s)", symbol_name(type), buf);
        }
    }
    else if (issymbol(type)) {
        // handle other integer prims. we know it's smaller than 64 bits
        // at this point, so int64 is big enough to capture everything.
        tmp = conv_to_int64(data, sym_to_numtype(type));
        if (fits_fixnum(tmp) || princ) {
            if (weak || princ)
                HPOS+=fprintf(f, "%lld", tmp);
            else
                HPOS+=fprintf(f, "#%s(%lld)", symbol_name(type), tmp);
        }
        else
            HPOS+=fprintf(f, "#%s(0x%08x)", symbol_name(type),
                          (uint32_t)(tmp&0xffffffff));
    }
    else if (iscons(type)) {
        if (car_(type) == arraysym) {
            value_t eltype = car(cdr_(type));
            size_t cnt, elsize;
            if (iscons(cdr_(cdr_(type)))) {
                cnt = toulong(car_(cdr_(cdr_(type))), "length");
                elsize = cnt ? len/cnt : 0;
            }
            else {
                // incomplete array type
                int junk;
                elsize = ctype_sizeof(eltype, &junk);
                cnt = elsize ? len/elsize : 0;
            }
            if (eltype == charsym) {
                if (princ) {
                    fwrite(data, 1, len, f);
                }
                else {
                    print_string(f, (char*)data, len);
                }
                return;
            }
            else if (eltype == wcharsym) {
                // TODO wchar
            }
            else {
            }
            size_t i;
            if (!weak) {
                outs("#array(", f);
                do_print(f, eltype, princ);
                outc(' ', f);
            }
            outc('[', f);
            for(i=0; i < cnt; i++) {
                cvalue_printdata(f, data, elsize, eltype, princ, 1);
                if (i < cnt-1)
                    outc(' ', f);
                data += elsize;
            }
            outc(']', f);
            if (!weak)
                outc(')', f);
        }
        else if (car_(type) == enumsym) {
            value_t sym = list_nth(car(cdr_(type)), *(size_t*)data);
            if (!weak) {
                outs("#enum(", f);
                do_print(f, car(cdr_(type)), princ);
                outc(' ', f);
            }
            if (sym == NIL) {
                cvalue_printdata(f, data, len, int32sym, princ, 1);
            }
            else {
                do_print(f, sym, princ);
            }
            if (!weak)
                outc(')', f);
        }
    }
}

void cvalue_print(FILE *f, value_t v, int princ)
{
    cvalue_t *cv = (cvalue_t*)ptr(v);
    void *data = cv_data(cv);

    if (cv->flags.islispfunction) {
        HPOS+=fprintf(f, "#<guestfunction @0x%08lx>",
                      (unsigned long)*(guestfunc_t*)data);
        return;
    }

    cvalue_printdata(f, data, cv_len(cv), cv_type(cv), princ, 0);
}

void print(FILE *f, value_t v, int princ)
{
    print_pretty = (symbol_value(printprettysym) != NIL);
    ptrhash_reset(&printconses, 32);
    printlabel = 0;
    print_traverse(v);
    HPOS = VPOS = 0;
    do_print(f, v, princ);
}