libexplain/time.h

Go to the documentation of this file.

/*
 * libexplain - Explain errno values returned by libc functions
 * Copyright (C) 2009, 2012, 2013 Peter Miller
 *
 * 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_TIME_H
#define LIBEXPLAIN_TIME_H

#include <libexplain/gcc_attributes.h>

/*
 * We include <libexplain/large_file_support.h> because <time.h>, on
 * _some_ systems, winds up including <sys/types.h> and that may,
 * in turn, define off_t and other file-size related types.  So the
 * necessary preparation has to be done or things will break.
 */
#include <libexplain/large_file_support.h>

#include <time.h>

#ifdef __cplusplus
extern "C" {
#endif

time_t explain_time_or_die(time_t *t);

time_t explain_time_on_error(time_t *t)
                                                  LIBEXPLAIN_WARN_UNUSED_RESULT;

const char *explain_time(time_t *t)
                                                  LIBEXPLAIN_WARN_UNUSED_RESULT;

const char *explain_errno_time(int errnum, time_t *t)
                                                  LIBEXPLAIN_WARN_UNUSED_RESULT;

void explain_message_time(char *message, int message_size, time_t *t);

void explain_message_errno_time(char *message, int message_size, int errnum,
    time_t *t);

#ifdef __cplusplus
}
#endif

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