layout.h

Go to the documentation of this file.

/* $Id: layout.h,v 1.8 2013/04/06 13:04:53 valtri Exp $
 *
 * layout.h
 * 
 * Copyright 2001-2003, Meiosys (www.meiosys.com). All rights reserved.
 *
 * See the COPYING file for the terms of usage and distribution.
 */

#ifndef log4c_layout_h
#define log4c_layout_h

#include <log4c/defs.h>
#include <log4c/logging_event.h>
#include <stdio.h>

__LOG4C_BEGIN_DECLS

struct __log4c_layout;

typedef struct __log4c_layout log4c_layout_t;

typedef struct log4c_layout_type {
    const char* name;
    const char* (*format) (const log4c_layout_t*, const log4c_logging_event_t*);
} log4c_layout_type_t;

LOG4C_API const log4c_layout_type_t* log4c_layout_type_get(const char* a_name);

LOG4C_API const log4c_layout_type_t* log4c_layout_type_set(
    const log4c_layout_type_t* a_type);

LOG4C_API log4c_layout_t* log4c_layout_get(const char* a_name);

LOG4C_API log4c_layout_t* log4c_layout_new(const char* a_name);

LOG4C_API void log4c_layout_delete(log4c_layout_t* a_layout);

LOG4C_API const char* log4c_layout_get_name(const log4c_layout_t* a_layout);

LOG4C_API const log4c_layout_type_t* log4c_layout_get_type(
    const log4c_layout_t* a_layout);

LOG4C_API const log4c_layout_type_t* log4c_layout_set_type(
    log4c_layout_t* a_layout,
    const log4c_layout_type_t* a_type);

LOG4C_API void* log4c_layout_get_udata(const log4c_layout_t* a_layout);

LOG4C_API void* log4c_layout_set_udata(log4c_layout_t*  a_layout, 
                                    void*               a_udata);
LOG4C_API const char* log4c_layout_format(
    const log4c_layout_t*               a_layout,
    const log4c_logging_event_t*        a_event);

LOG4C_API void log4c_layout_print(
    const log4c_layout_t* a_layout, FILE* a_stream);

LOG4C_API void log4c_layout_types_free(void);

LOG4C_API void log4c_layout_types_print(FILE *fp);

#ifdef __GNUC__
#   define log4c_layout_type_define(a_type) \
    typedef int log4c_layout_type_define_##a_type __attribute__((deprecated)); \
    static log4c_layout_type_define_##a_type __unsused_var __attribute__((unused));
#else
#   define log4c_layout_type_define(a_type)
#endif

struct __sd_factory;
LOG4C_API struct __sd_factory* log4c_layout_factory;

__LOG4C_END_DECLS

#endif