libexplain/output.h

Go to the documentation of this file.

/*
 * libexplain - Explain errno values returned by libc functions
 * Copyright (C) 2010-2013 Peter Miller
 * Written by Peter Miller <pmiller@opensource.org.au>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LIBEXPLAIN_OUTPUT_H
#define LIBEXPLAIN_OUTPUT_H

#include <libexplain/gcc_attributes.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct explain_output_t explain_output_t;

struct explain_output_t
{
    const struct explain_output_vtable_t *vtable;

    int exit_has_been_used;
};

typedef struct explain_output_vtable_t explain_output_vtable_t;

struct explain_output_vtable_t
{
    void (*destructor)(explain_output_t *op);

    void (*message)(explain_output_t *op, const char *text);

    void (*exit)(explain_output_t *op, int status);

    unsigned int size;
};

explain_output_t *explain_output_new(const explain_output_vtable_t *vtable);

explain_output_t *explain_output_stderr_new(void);

explain_output_t *explain_output_syslog_new(void);

explain_output_t *explain_output_syslog_new1(int level);

explain_output_t *explain_output_syslog_new3(int option, int facility,
    int level);

explain_output_t *explain_output_file_new(const char *filename, int append);

explain_output_t *explain_output_tee_new(explain_output_t *first,
    explain_output_t *second);

void explain_output_message(const char *text);

void explain_output_error(const char *fmt, ...)
                                                 LIBEXPLAIN_FORMAT_PRINTF(1, 2);

void explain_output_error_and_die(const char *fmt, ...)
                                                  LIBEXPLAIN_FORMAT_PRINTF(1, 2)
                                                            LIBEXPLAIN_NORETURN;

void explain_output_warning(const char *fmt, ...)
                                                 LIBEXPLAIN_FORMAT_PRINTF(1, 2);

void explain_output_method_message(explain_output_t *op, const char *text);

void explain_output_exit(int status)                        LIBEXPLAIN_NORETURN;

void explain_output_exit_failure(void)                      LIBEXPLAIN_NORETURN;

void explain_output_method_exit(explain_output_t *op, int status)
                                                            LIBEXPLAIN_NORETURN;

void explain_output_register(explain_output_t *op);

void explain_output_method_destructor(explain_output_t *op);

void explain_program_name_assemble(int yesno);

void explain_option_hanging_indent_set(int columns);

#ifdef __cplusplus
}
#endif

#endif /* LIBEXPLAIN_OUTPUT_H */
/* vim: set ts=8 sw=4 et : */