1 2/*--------------------------------------------------------------------*/ 3/*--- An sparse array (of words) implementation. ---*/ 4/*--- pub_tool_sparsewa.h ---*/ 5/*--------------------------------------------------------------------*/ 6 7/* 8 This file is part of Valgrind, a dynamic binary instrumentation 9 framework. 10 11 Copyright (C) 2008-2013 OpenWorks Ltd 12 info@open-works.co.uk 13 14 This program is free software; you can redistribute it and/or 15 modify it under the terms of the GNU General Public License as 16 published by the Free Software Foundation; either version 2 of the 17 License, or (at your option) any later version. 18 19 This program is distributed in the hope that it will be useful, but 20 WITHOUT ANY WARRANTY; without even the implied warranty of 21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 22 General Public License for more details. 23 24 You should have received a copy of the GNU General Public License 25 along with this program; if not, write to the Free Software 26 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 27 02111-1307, USA. 28 29 The GNU General Public License is contained in the file COPYING. 30*/ 31 32#ifndef __PUB_TOOL_SPARSEWA_H 33#define __PUB_TOOL_SPARSEWA_H 34 35#include "pub_tool_basics.h" // UWord 36 37//-------------------------------------------------------------------- 38// PURPOSE: (see coregrind/pub_core_sparsewa.h for details) 39//-------------------------------------------------------------------- 40 41///////////////////////////////////////////////////////// 42// // 43// SparseWA: Interface // 44// // 45///////////////////////////////////////////////////////// 46 47// This interface is a very cut-down version of WordFM. 48// If you understand how to use WordFM then it should be 49// trivial to use SparseWA. 50 51typedef struct _SparseWA SparseWA; /* opaque */ 52 53// Create a new one, using the specified allocator/deallocator 54SparseWA* VG_(newSWA) ( void*(*alloc_nofail)(const HChar* cc, SizeT), 55 const HChar* cc, 56 void(*dealloc)(void*) ); 57 58// Delete one, and free all associated storage 59void VG_(deleteSWA) ( SparseWA* swa ); 60 61// Add the binding key -> val to this swa. Any existing binding is 62// overwritten. Returned Bool is True iff a previous binding existed. 63Bool VG_(addToSWA) ( SparseWA* swa, UWord key, UWord val ); 64 65// Delete key from swa, returning associated key and val if found. 66// Note: returning associated key is stupid (it can only be the 67// key you just specified). This behaviour is retained to make it 68// easier to migrate from WordFM. Returned Bool is True iff 69// the key was actually bound in the mapping. 70Bool VG_(delFromSWA) ( SparseWA* swa, 71 /*OUT*/UWord* oldK, /*OUT*/UWord* oldV, 72 UWord key ); 73 74// Indexes swa at 'key' (or, if you like, looks up 'key' in the 75// mapping), and returns the associated value, if any, in *valP. For 76// compatibility with WordFM, 'key' is also returned in *keyP. Returned 77// Bool is True iff a binding for 'key' actually existed. 78Bool VG_(lookupSWA) ( SparseWA* swa, 79 /*OUT*/UWord* keyP, /*OUT*/UWord* valP, 80 UWord key ); 81 82// Set up 'swa' for iteration. 83void VG_(initIterSWA) ( SparseWA* swa ); 84 85// Get the next key/val pair. Behaviour undefined (highly likely 86// to segfault) if 'swa' has been modified since initIterSWA was 87// called. Returned Bool is False iff there are no more pairs 88// that can be extracted. 89Bool VG_(nextIterSWA)( SparseWA* swa, 90 /*OUT*/UWord* keyP, /*OUT*/UWord* valP ); 91 92// How many elements are there in 'swa'? NOTE: dangerous in the 93// sense that this is not an O(1) operation but rather O(N), 94// since it involves walking the whole tree. 95UWord VG_(sizeSWA) ( SparseWA* swa ); 96 97#endif // __PUB_TOOL_SPARSEWA_H 98 99/*--------------------------------------------------------------------*/ 100/*--- end pub_tool_sparsewa.h ---*/ 101/*--------------------------------------------------------------------*/ 102