PDArray.h

Go to the documentation of this file.

//
// PDArray.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_PDARRAY_H
#define INCLUDED_PDARRAY_H

#include "PDDefines.h"

extern PDArrayRef PDArrayCreateWithCapacity(PDInteger capacity);

extern PDArrayRef PDArrayCreateWithStackList(pd_stack stack);

extern PDArrayRef PDArrayCreateWithComplex(pd_stack stack);

// *  Create a copy of the given array.
// *
// *  @param array The array to copy
// *
// *  @return A new array, identical to array
// */
//extern PDArrayRef PDArrayCopy(PDArrayRef array);

extern void PDArrayClear(PDArrayRef array);

extern PDInteger PDArrayGetCount(PDArrayRef array);

extern void *PDArrayGetElement(PDArrayRef array, PDInteger index);

extern void *PDArrayGetTypedElement(PDArrayRef array, PDInteger index, PDInstanceType type);

//#define PDArrayGetNumber(a,i)      PDArrayGetTypedElement(a,i,PDInstanceTypeNumber)
#define PDArrayGetString(a,i)      PDArrayGetTypedElement(a,i,PDInstanceTypeString)
#define PDArrayGetArray(a,i)       PDArrayGetTypedElement(a,i,PDInstanceTypeArray)
#define PDArrayGetDictionary(a,i)  PDArrayGetTypedElement(a,i,PDInstanceTypeDict)
#define PDArrayGetReference(a,i)   PDArrayGetTypedElement(a,i,PDInstanceTypeRef)
#define PDArrayGetObject(a,i)      PDArrayGetTypedElement(a,i,PDInstanceTypeObj)

#define PDArrayGetInteger(a,i)     PDNumberGetInteger(PDArrayGetElement(a,i))

extern void PDArrayAppend(PDArrayRef array, void *value);

extern void PDArrayInsertAtIndex(PDArrayRef array, PDInteger index, void *value);

extern PDInteger PDArrayGetIndex(PDArrayRef array, void *value);

extern void PDArrayDeleteAtIndex(PDArrayRef array, PDInteger index);

extern void PDArrayReplaceAtIndex(PDArrayRef array, PDInteger index, void *value);

extern char *PDArrayToString(PDArrayRef array);

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

extern void PDArrayPrint(PDArrayRef array);

#define encryptable(str) (strlen(str) > 0 && str[0] == '(' && str[strlen(str)-1] == ')')

#ifdef PD_SUPPORT_CRYPTO

extern void PDArrayAttachCrypto(PDArrayRef array, pd_crypto crypto, PDInteger objectID, PDInteger genNumber);

#endif // PD_SUPPORT_CRYPTO

#endif // INCLUDED_PDARRAY_H