output.h

Go to the documentation of this file.

//  ==================================================================== //
//                                                                       //
//    File      : output.h                                               //
//    Purpose   : class for indented output to FILE                      //
//                                                                       //
//                                                                       //
//  Coded by Ralf Westram (coder@reallysoft.de) in September 2003        //
//  Copyright Department of Microbiology (Technical University Munich)   //
//                                                                       //
//  Visit our web site at: http://www.arb-home.de/                       //
//                                                                       //
//                                                                       //
//  ==================================================================== //

#ifndef OUTPUT_H
#define OUTPUT_H

#ifndef _GLIBCXX_CSTDARG
#include <cstdarg>
#endif
#ifndef ATTRIBUTES_H
#include <attributes.h>
#endif

//  ---------------------
//      class output

class output {
private:
    int   indentation;
    bool  printing_points;
    int   max_points;
    int   points_printed;
    int   points_per_line;
    FILE *out;

    inline void cr() const { fputc('\n', stdout); }

    inline void  print_indent() {
        for (int i = 0; i<indentation; ++i) fputc(' ', stdout);
    }

    void goto_indentation() {
        if (printing_points) {
            new_point_line();
            // here we stop printing points
            points_printed  = 0;
            max_points      = 0;
            printing_points = false;
        }
        else print_indent();
    }

    void new_point_line() {
        if (max_points) {   // do we know max_points ?
            fprintf(stdout, " %3i%%", int(double(points_printed)/max_points*100+.5));
        }
        cr();
        print_indent();
    }

public:
    output(FILE *out_ = stdout, int breakPointsAt = 60) :
        indentation(0),
        printing_points(false),
        max_points(0),
        points_printed(0),
        points_per_line(breakPointsAt),
        out(out_)
    {}

    void indent(int howMuch) { indentation   += howMuch; }
    void unindent(int howMuch) { indentation -= howMuch; }

    void vput(const char *s, va_list argPtr) __ATTR__VFORMAT_MEMBER(1);
    void put(const char *s, ...) __ATTR__FORMAT_MEMBER(1);

    void put() {
        goto_indentation();
        cr();
    }

    void setMaxPoints(int maxP) {
        max_points = maxP;
    }

    void point() { // for use as simple progress indicator
        if (!printing_points) {
            goto_indentation();
            printing_points = true;
        }
        else if ((points_printed%points_per_line) == 0 && points_printed) {
            new_point_line();
        }

        fputc('.', stdout);
        ++points_printed;
        fflush(stdout);
    }
};

inline void output::vput(const char *s, va_list argPtr) {
    goto_indentation();
    vfprintf(stdout, s, argPtr);
    cr();
}

inline void output::put(const char *s, ...) {
    va_list parg;
    va_start(parg, s);
    vput(s, parg);
}



//  ---------------------
//      class indent

// create an instance of indent to increase indentation
// indentation automatically resets when that instance leaves the scope

class indent {
private:
    int     indentation;
    output& out;

public:
    indent(output& out_, int ind = 2) : indentation(ind), out(out_) {
        out.indent(indentation);
    }
    ~indent() {
        out.unindent(indentation);
    }
};



#else
#error output.h included twice
#endif // OUTPUT_H