PDDictionary.h

Go to the documentation of this file.

//
// PDDictionary.h
//
// Copyright (c) 2012 - 2015 Karl-Johan Alm (http://github.com/kallewoof)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#ifndef INCLUDED_PDDICTIONARY_H
#define INCLUDED_PDDICTIONARY_H

#include "PDDefines.h"

extern PDDictionaryRef PDDictionaryCreate();

extern PDDictionaryRef PDDictionaryCreateWithBucketCount(PDSize bucketCount);

extern PDDictionaryRef PDDictionaryCreateWithComplex(pd_stack stack);

extern PDDictionaryRef PDDictionaryCreateWithKeyValueDefinition(const void **defs);

extern void PDDictionaryAddEntriesFromComplex(PDDictionaryRef hm, pd_stack stack);

extern void PDDictionarySet(PDDictionaryRef hm, const char *key, void *value);

extern void *PDDictionaryGet(PDDictionaryRef hm, const char *key);

extern void PDDictionaryDelete(PDDictionaryRef hm, const char *key);

extern PDSize PDDictionaryGetCount(PDDictionaryRef hm);

extern void PDDictionaryIterate(PDDictionaryRef hm, PDHashIterator it, void *ui);

extern void PDDictionaryPopulateKeys(PDDictionaryRef hm, char **keys);

extern void PDDictionaryClear(PDDictionaryRef hm);

extern void PDDictionaryPrint(PDDictionaryRef hm);

extern char *PDDictionaryToString(PDDictionaryRef hm);

extern PDInteger PDDictionaryPrinter(void *inst, char **buf, PDInteger offs, PDInteger *cap);

extern void *PDDictionaryGetTyped(PDDictionaryRef dictionary, const char *key, PDInstanceType type);

#define PDDictionaryGetString(d,k)      PDDictionaryGetTyped(d,k,PDInstanceTypeString)
#define PDDictionaryGetArray(d,k)       PDDictionaryGetTyped(d,k,PDInstanceTypeArray)
#define PDDictionaryGetDictionary(d,k)  PDDictionaryGetTyped(d,k,PDInstanceTypeDict)
#define PDDictionaryGetReference(d,k)   PDDictionaryGetTyped(d,k,PDInstanceTypeRef)
#define PDDictionaryGetObject(d,k)      PDDictionaryGetTyped(d,k,PDInstanceTypeObj)

#define PDDictionaryGetInteger(d,k)     PDNumberGetInteger(PDDictionaryGet(d,k))

#ifdef PD_SUPPORT_CRYPTO

extern void PDDictionaryAttachCrypto(PDDictionaryRef hm, pd_crypto crypto, PDInteger objectID, PDInteger genNumber);

#endif // PD_SUPPORT_CRYPTO

#endif // INCLUDED_PDDICTIONARY_H