pd_stack.h

Go to the documentation of this file.

//
// pd_stack.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_pd_stack_h
#define INCLUDED_pd_stack_h

#include <sys/types.h>
#include "PDDefines.h"

extern void pd_stack_set_global_preserve_flag(PDBool preserve);


extern void pd_stack_push_key(pd_stack *stack, char *key);

extern void pd_stack_push_identifier(pd_stack *stack, PDID identifier);

extern void pd_stack_push_freeable(pd_stack *stack, void *info);

extern void pd_stack_push_stack(pd_stack *stack, pd_stack pstack);

extern void pd_stack_push_object(pd_stack *stack, void *ob);

extern void pd_stack_unshift_stack(pd_stack *stack, pd_stack sstack);

extern pd_stack pd_stack_copy(pd_stack stack);


extern void pd_stack_destroy(pd_stack *stack);

extern char *pd_stack_pop_key(pd_stack *stack);

extern PDID pd_stack_pop_identifier(pd_stack *stack);

extern pd_stack pd_stack_pop_stack(pd_stack *stack);

extern void *pd_stack_pop_object(pd_stack *stack);

extern void *pd_stack_pop_freeable(pd_stack *stack);

extern PDSize pd_stack_pop_size(pd_stack *stack);

extern PDInteger pd_stack_pop_int(pd_stack *stack);

extern void   pd_stack_assert_expected_key(pd_stack *stack, const char *key);

extern void   pd_stack_assert_expected_int(pd_stack *stack, PDInteger i);

extern PDInteger pd_stack_peek_int(pd_stack stack);


extern PDInteger pd_stack_get_count(pd_stack stack);

extern void pd_stack_pop_into(pd_stack *dest, pd_stack *source);

#define pd_stack_for_each(stack, iter) for (iter = stack; iter; iter = iter->prev)

extern pd_stack pd_stack_get_dict_key(pd_stack dictStack, const char *key, PDBool remove);

extern PDBool pd_stack_get_next_dict_key(pd_stack *iterStack, char **key, char **value);

extern pd_stack pd_stack_get_arr(pd_stack arrStack);

extern void pd_stack_replace_info_object(pd_stack stack, char type, void *info);

extern pd_stack pd_stack_create_from_definition(const void **defs);


extern void pd_stack_print(pd_stack stack);
extern void pd_stack_show(pd_stack stack);

extern PDDeallocator pd_stack_dealloc;

#define PDDeallocateViaStackDealloc(ob) pd_stack_dealloc(ob)

#endif