avis/errors.h

Go to the documentation of this file.

/*
 *  Avis Elvin client library for C.
 *
 *  Copyright (C) 2008 Matthew Phillips <avis@mattp.name>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of version 3 of the GNU Lesser General
 *  Public License as published by the Free Software Foundation.
 *
 *  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 AVIS_ERRORS_H_
#define AVIS_ERRORS_H_

#include <stdlib.h>

#include <avis/stdtypes.h>
#include <avis/defs.h>

typedef struct
{
  int    code;
  char * message;
} ElvinError;

#define ELVIN_ERROR_BASE       0
#define ELVIN_ERRNO_BASE       10000
#define ELVIN_HOST_ERROR_BASE  20000

#define ELVIN_ERROR_NONE                0
#define ELVIN_ERROR_INTERNAL            (ELVIN_ERROR_BASE + 1)
#define ELVIN_ERROR_PROTOCOL            (ELVIN_ERROR_BASE + 2)
#define ELVIN_ERROR_CONNECTION_CLOSED   (ELVIN_ERROR_BASE + 3)
#define ELVIN_ERROR_INVALID_URI         (ELVIN_ERROR_BASE + 4)
#define ELVIN_ERROR_SYNTAX              (ELVIN_ERROR_BASE + 5)
#define ELVIN_ERROR_TRIVIAL_EXPRESSION  (ELVIN_ERROR_BASE + 6)
#define ELVIN_ERROR_NACK                (ELVIN_ERROR_BASE + 7)
#define ELVIN_ERROR_USAGE               (ELVIN_ERROR_BASE + 8)
#define ELVIN_ERROR_TIMEOUT             (ELVIN_ERROR_BASE + 9)
#define ELVIN_ERROR_ROUTER_FAILURE      (ELVIN_ERROR_BASE + 10)

AVIS_PUBLIC
void *do_avis_emalloc (size_t size, const char *file, int line);

AVIS_PUBLIC
char *do_avis_estrdup (const char *str, const char *file, int line);

#define avis_emalloc(size) do_avis_emalloc ((size), __FILE__, __LINE__)

#define avis_estrdup(str) do_avis_estrdup ((str), __FILE__, __LINE__)

#define ELVIN_EMPTY_ERROR {ELVIN_ERROR_NONE, NULL}

AVIS_PUBLIC
void elvin_error_free (ElvinError *error);

AVIS_PUBLIC
void elvin_error_init (ElvinError *error);

#define elvin_error_reset(error) (elvin_error_free (error))

#define on_error_return_false(stat) on_error_return (stat, false)

#define on_error_return(stat, retval) \
  {stat; if (elvin_error_occurred (error)) return (retval);}

#define host_to_elvin_error(code) (ELVIN_HOST_ERROR_BASE + (code))

#define errno_to_elvin_error(code) (ELVIN_ERRNO_BASE + (code))

AVIS_PUBLIC
void elvin_perror (const char *tag, ElvinError *error);

AVIS_PUBLIC
bool elvin_error_from_errno (ElvinError *error);

AVIS_PUBLIC
bool elvin_error_set (ElvinError *error, int code, const char *message, ...);

#define elvin_error_ok(error) ((error)->code == ELVIN_ERROR_NONE)

#define elvin_error_occurred(error) (!elvin_error_ok (error))

#endif /*AVIS_ERRORS_H_*/

---