dict.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <limits.h>
#include <string.h>
#include "pforth.h"

Functions
dict_t *	dict_create (uint32_t size)
void	dict_free (dict_t *dict, uint32_t size)
int	hash (dict_t *hashtable, const char *key)
dict_entry *	dict_newkv (const char *key, const pforth_word_ptr value)
pforth_word_ptr	dict_set (dict_t *dict, const char *key, const pforth_word_ptr value)
pforth_word_ptr	dict_get (dict_t *dict, const char *key)

Function Documentation

dict_t* dict_create

(

uint32_t

size

)

Create a new hash table dictionary.

Parameters

size	number of elements

Returns

pointer to created dictionary

void dict_free	(	dict_t *	dict,
		uint32_t	size
	)

pforth_word_ptr dict_get	(	dict_t *	dict,
		const char *	key
	)

Retrieve the word from the dictionary.

Parameters

dict	dictionary to use
key	FORTH word in ASCII form

Returns

pointer to word inside the dictionary. Do not harm it.

dict_entry* dict_newkv	(	const char *	key,
		const pforth_word_ptr	value
	)

Create a key-value pair for dictionary.

Internal function to be used only inside dictionary.

Parameters

key	the FORTH word in ASCII
value	pointer to the actual pforth_word structure

Returns

newly allocated key-value pair

pforth_word_ptr dict_set	(	dict_t *	dict,
		const char *	key,
		const pforth_word_ptr	value
	)

Insert word into dictionary.

The word will be copied into the dictionary. The value must be freed in caller afterwards.

Parameters

dict	dictionary to use
key	FORTH word in ASCII form
value	pointer to pforth_word struct with the word.

Returns

pointer to the newly created word

int hash	(	dict_t *	hashtable,
		const char *	key
	)

djb2 hash function

Hope it'll be more or less unique to create hash table for FORTH words

Parameters

hashtable	pointer to hash table
key	null-terminated key string

Returns

index in hash table