avis/attributes.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_ATTRIBUTES_H
#define AVIS_ATTRIBUTES_H

#include <avis/stdtypes.h>
#include <avis/errors.h>
#include <avis/values.h>

struct hashtable;

typedef struct
{
  struct hashtable *table;
} Attributes;

typedef struct
{
  /* below is a copy of hashtable_iter from hashtable_iter.h */
  struct
  {
    void *h;
    void *e;
    void *parent;
    unsigned int index;
  } hash_iter;
  
  bool has_next;
} AttributesIter;

AVIS_PUBLIC_DATA 
Attributes _empty_attributes;

#define EMPTY_ATTRIBUTES (&_empty_attributes)

#define attributes_create() \
  (attributes_init ((Attributes *)avis_emalloc (sizeof (Attributes))))

AVIS_PUBLIC
Attributes *attributes_init (Attributes *);

#define attributes_destroy(attributes) \
  if ((attributes) && (attributes) != EMPTY_ATTRIBUTES) \
  { \
    attributes_free (attributes), free (attributes), attributes = NULL; \
  }

AVIS_PUBLIC
void attributes_free (Attributes *attributes);

AVIS_PUBLIC
void attributes_clear (Attributes *attributes);

AVIS_PUBLIC
Attributes *attributes_copy (Attributes *target, const Attributes *source);

#define attributes_clone(source) attributes_copy (attributes_create (), source)

AVIS_PUBLIC
unsigned int attributes_size (Attributes *attributes);

#define attributes_iter_create(attributes) \
  attributes_iter_init \
    ((AttributesIter *)avis_emalloc (sizeof (AttributesIter)), (attributes))

#define attributes_iter_destroy(iter) (free (iter), (iter) = NULL)

AVIS_PUBLIC
AttributesIter *attributes_iter_init (AttributesIter *iter, 
                                      const Attributes *attributes);

AVIS_PUBLIC
const char *attributes_iter_name (const AttributesIter *iter);

AVIS_PUBLIC
const Value *attributes_iter_value (const AttributesIter *iter);

#define attributes_iter_has_next(iter) ((iter)->has_next)

AVIS_PUBLIC
bool attributes_iter_next (AttributesIter *iter);

AVIS_PUBLIC
void attributes_set (Attributes *attributes, const char *name, Value *value);

AVIS_PUBLIC
void attributes_set_nocopy (Attributes *attributes, char *name, Value *value);

AVIS_PUBLIC
Value *attributes_get (Attributes *attributes, const char *name);

AVIS_PUBLIC
bool attributes_contains (Attributes *attributes, const char *name);

AVIS_PUBLIC
Value *attributes_remove (Attributes *attributes, const char *name);

#define attributes_set_int32(attributes, name, value) \
  (attributes_set (attributes, name, value_create_int32 (value)))

AVIS_PUBLIC
int32_t attributes_get_int32 (Attributes *attributes, const char *name);

#define attributes_set_int64(attributes, name, value) \
  (attributes_set (attributes, name, value_create_int64 (value)))

AVIS_PUBLIC
int64_t attributes_get_int64 (Attributes *attributes, const char *name);

#define attributes_set_real64(attributes, name, value) \
  (attributes_set (attributes, name, value_create_real64 (value)))

AVIS_PUBLIC
real64_t attributes_get_real64 (Attributes *attributes, const char *name);

#define attributes_set_string(attributes, name, value) \
  (attributes_set (attributes, name, value_create_string (value)))

AVIS_PUBLIC
const char *attributes_get_string (Attributes *attributes, const char *name);

#define attributes_set_opaque(attributes, name, value) \
  (attributes_set (attributes, name, value_create_opaque (value)))

AVIS_PUBLIC
Array *attributes_get_opaque (Attributes *attributes, const char *name);

#endif /* AVIS_ATTRIBUTES_H */

---