lib/base/error.c

   1 /*
   2  * Copyright (c) 2010 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Portions Copyright (c) 2010 Apple Inc. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * 3. Neither the name of the Institute nor the names of its contributors
  20  *    may be used to endorse or promote products derived from this software
  21  *    without specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  */
  35
  36 #include "baselocl.h"
  37
  38 struct heim_error {
  39     int error_code;
  40     heim_string_t msg;
  41     struct heim_error *next;
  42 };
  43
  44 static void
  45 error_dealloc(void *ptr)
  46 {
  47     struct heim_error *p = ptr;
  48     heim_release(p->msg);
  49     heim_release(p->next);
  50 }
  51
  52 static int
  53 error_cmp(void *a, void *b)
  54 {
  55     struct heim_error *ap = a, *bp = b;
  56     if (ap->error_code == ap->error_code)
  57         return ap->error_code - ap->error_code;
  58     return heim_cmp(ap->msg, bp->msg);
  59 }
  60
  61 static unsigned long
  62 error_hash(void *ptr)
  63 {
  64     struct heim_error *p = ptr;
  65     return p->error_code;
  66 }
  67
  68 struct heim_type_data _heim_error_object = {
  69     HEIM_TID_ERROR,
  70     "error-object",
  71     NULL,
  72     error_dealloc,
  73     NULL,
  74     error_cmp,
  75     error_hash,
  76     NULL
  77 };
  78
  79 heim_error_t
  80 heim_error_create_enomem(void)
  81 {
  82     /* This is an immediate object; see heim_number_create() */
  83     return (heim_error_t)heim_number_create(ENOMEM);
  84 }
  85
  86
  87 void
  88 heim_error_create_opt(heim_error_t *error, int error_code, const char *fmt, ...)
  89 {
  90     if (error) {
  91         va_list ap;
  92         va_start(ap, fmt);
  93         *error = heim_error_createv(error_code, fmt, ap);
  94         va_end(ap);
  95     }
  96 }
  97
  98 heim_error_t
  99 heim_error_create(int error_code, const char *fmt, ...)
 100 {
 101     heim_error_t e;
 102     va_list ap;
 103
 104     va_start(ap, fmt);
 105     e = heim_error_createv(error_code, fmt, ap);
 106     va_end(ap);
 107
 108     return e;
 109 }
 110
 111 heim_error_t
 112 heim_error_createv(int error_code, const char *fmt, va_list ap)
 113 {
 114     heim_error_t e;
 115     char *str;
 116     int len;
 117     int save_errno = errno;
 118
 119     str = malloc(1024);
 120     errno = save_errno;
 121     if (str == NULL)
 122         return heim_error_create_enomem();
 123     len = vsnprintf(str, 1024, fmt, ap);
 124     errno = save_errno;
 125     if (len < 0) {
 126         free(str);
 127         return NULL; /* XXX We should have a special heim_error_t for this */
 128     }
 129
 130     e = _heim_alloc_object(&_heim_error_object, sizeof(struct heim_error));
 131     if (e) {
 132         e->msg = heim_string_create(str);
 133         e->error_code = error_code;
 134     }
 135     free(str);
 136
 137     errno = save_errno;
 138     return e;
 139 }
 140
 141 heim_string_t
 142 heim_error_copy_string(heim_error_t error)
 143 {
 144     if (heim_get_tid(error) != HEIM_TID_ERROR) {
 145         if (heim_get_tid(error) == heim_number_get_type_id())
 146             return __heim_string_constant(strerror(heim_number_get_int((heim_number_t)error)));
 147         heim_abort("invalid heim_error_t");
 148     }
 149     /* XXX concat all strings */
 150     return heim_retain(error->msg);
 151 }
 152
 153 int
 154 heim_error_get_code(heim_error_t error)
 155 {
 156     if (error == NULL)
 157         return -1;
 158     if (heim_get_tid(error) != HEIM_TID_ERROR) {
 159         if (heim_get_tid(error) == heim_number_get_type_id())
 160             return heim_number_get_int((heim_number_t)error);
 161         heim_abort("invalid heim_error_t");
 162     }
 163     return error->error_code;
 164 }
 165
 166 heim_error_t
 167 heim_error_append(heim_error_t top, heim_error_t append)
 168 {
 169     if (heim_get_tid(top) != HEIM_TID_ERROR) {
 170         if (heim_get_tid(top) == heim_number_get_type_id())
 171             return top;
 172         heim_abort("invalid heim_error_t");
 173     }
 174     if (top->next)
 175         heim_release(top->next);
 176     top->next = heim_retain(append);
 177     return top;
 178 }