Dictionary.h

Go to the documentation of this file.

/*
 * Objectively: Ultra-lightweight object oriented framework for GNU C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <Objectively/Array.h>
#include <Objectively/Object.h>
 
typedef struct Dictionary Dictionary;
typedef struct DictionaryInterface DictionaryInterface;
 
typedef void (*DictionaryEnumerator)(const Dictionary *dictionary, ident obj, ident key, ident data);
 
typedef bool (*DictionaryPredicate)(ident obj, ident key, ident data);
 
struct Dictionary {
 
  Object object;
 
  DictionaryInterface *interface;
 
  size_t capacity;
 
  size_t count;
 
  ident *elements;
};
 
 
struct DictionaryInterface {
 
  ObjectInterface objectInterface;
 
  void (*addEntriesFromDictionary)(Dictionary *self, const Dictionary *dictionary);
 
  Array *(*allKeys)(const Dictionary *self);
 
  Array *(*allObjects)(const Dictionary *self);
 
  bool (*containsKey)(const Dictionary *self, const ident key);
 
  bool (*containsKeyPath)(const Dictionary *self, const char *path);
 
  Dictionary *(*dictionary)(void);
 
  Dictionary *(*dictionaryWithCapacity)(size_t capacity);
 
  Dictionary *(*dictionaryWithDictionary)(const Dictionary *dictionary);
 
  Dictionary *(*dictionaryWithObjectsAndKeys)(ident obj, ...);
 
  void (*enumerateObjectsAndKeys)(const Dictionary *self, DictionaryEnumerator enumerator, ident data);
 
  Dictionary *(*filterObjectsAndKeys)(const Dictionary *self, DictionaryPredicate predicate, ident data);
 
  Dictionary *(*init)(Dictionary *self);
 
  Dictionary *(*initWithCapacity)(Dictionary *self, size_t capacity);
 
  Dictionary *(*initWithDictionary)(Dictionary *self, const Dictionary *dictionary);
 
  Dictionary *(*initWithObjectsAndKeys)(Dictionary *self, ...);
 
  ident (*objectForKey)(const Dictionary *self, const ident key);
 
  ident (*objectForKeyPath)(const Dictionary *self, const char *path);
 
  ident (*objectForKeyPathWithClass)(const Dictionary *self, const char *path, const Class *clazz);
 
  void (*removeAllObjects)(Dictionary *self);
 
  void (*removeAllObjectsWithEnumerator)(Dictionary *self, DictionaryEnumerator enumerator, ident data);
 
  void (*removeObjectForKey)(Dictionary *self, const ident key);
 
  void (*removeObjectForKeyPath)(Dictionary *self, const char *path);
 
  void (*setObjectForKey)(Dictionary *self, const ident obj, const ident key);
 
  void (*setObjectForKeyPath)(Dictionary *self, const ident obj, const char *path);
 
  void (*setObjectsForKeyPaths)(Dictionary *self, ...);
 
  void (*setObjectsForKeys)(Dictionary *self, ...);
 
};
 
OBJECTIVELY_EXPORT Class *_Dictionary(void);