libaegis/output.h

Go to the documentation of this file.

//
//      aegis - project change supervisor
//      Copyright (C) 1999, 2002-2006, 2008 Peter Miller
//
//      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
//      <http://www.gnu.org/licenses/>.
//

#ifndef LIBAEGIS_OUTPUT_H
#define LIBAEGIS_OUTPUT_H

#include <common/ac/stdarg.h>
#include <common/ac/stddef.h>
#include <common/main.h> // for gcc attributes
#include <common/nstring.h>
#include <common/ac/shared_ptr.h>

#include <libaegis/functor/stack.h>

struct string_ty; // forward


class output
{
public:
    typedef aegis_shared_ptr<output> pointer;

    typedef void (*delete_callback_ty)(output *, void *);

    virtual ~output();

protected:
    output();

public:
    virtual nstring filename() const = 0;

    long ftell() const;

    void write(const void *data, size_t nbytes);

    void flush();

    virtual int page_width() const;

    virtual int page_length() const;

    void end_of_line();

    virtual const char *type_name() const = 0;

    void
    fputc(char c)
    {
        if (buffer_position < buffer_end)
            *buffer_position++ = c;
        else
            overflow(c);
    }

    void fputs(const char *str);

    void fputs_xml(const char *str, bool paragraphs = false);

    void fputs(string_ty *str);

    void fputs_xml(string_ty *str, bool paragraphs = false);

    void fputs(const nstring &str);

    void fputs_xml(const nstring &str, bool paragraphs = false);

    void fprintf(const char *fmt, ...)                        ATTR_PRINTF(2, 3);

    void vfprintf(const char *fmt, va_list)                   ATTR_PRINTF(2, 0);

    void register_delete_callback(functor::pointer fp);

    void unregister_delete_callback(functor::pointer fp);

private:
    virtual long ftell_inner() const = 0;

    virtual void write_inner(const void *data, size_t length) = 0;

    virtual void end_of_line_inner() = 0;

    virtual void flush_inner();

    void overflow(char c);

    functor_stack callback;

    unsigned char *buffer;

    size_t buffer_size;

    unsigned char *buffer_position;

    unsigned char *buffer_end;

    output(const output &);

    output &operator=(const output &);
};


inline output::pointer &
operator<<(output::pointer &os, char c)
{
    os->fputc(c);
    return os;
}


inline output::pointer &
operator<<(output::pointer &os, const char *s)
{
    os->fputs(s);
    return os;
}


inline output::pointer &
operator<<(output::pointer &os, const nstring &s)
{
    os->fputs(s);
    return os;
}


class input; // forward

output::pointer &operator<<(output::pointer &os, input &is);

#endif // LIBAEGIS_OUTPUT_H

---