From b4a73bd563cbc572bdfd749a764e0989aa7fbe71 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Sun, 28 Oct 2018 14:00:47 +0100
Subject: Add SerdNodes class for storing a cache of nodes

---
 serd/serd.h | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)

(limited to 'serd')

diff --git a/serd/serd.h b/serd/serd.h
index 5242d51a..ad131e2d 100644
--- a/serd/serd.h
+++ b/serd/serd.h
@@ -61,6 +61,14 @@ extern "C" {
 */
 typedef struct SerdWorldImpl SerdWorld;
 
+/**
+   Nodes.
+
+   A hashing container for nodes that can be used for interning and simplified
+   memory management.
+*/
+typedef struct SerdNodesImpl SerdNodes;
+
 /**
    Statement.
 
@@ -1297,6 +1305,63 @@ SERD_API
 SerdStatus
 serd_writer_finish(SerdWriter* writer);
 
+/**
+   @}
+   @name Nodes
+   @{
+*/
+
+/**
+   Create a new node set.
+*/
+SERD_API
+SerdNodes*
+serd_nodes_new(void);
+
+/**
+   Free `nodes` and all nodes that are stored in it.
+
+   Note that this invalidates any pointers previously returned from
+   `serd_nodes_intern()` or `serd_nodes_manage()` calls on `nodes`.
+*/
+SERD_API
+void
+serd_nodes_free(SerdNodes* nodes);
+
+/**
+   Intern `node`.
+
+   Multiple calls with equivalent nodes will return the same pointer.
+
+   @return A node that is different than, but equivalent to, `node`.
+*/
+SERD_API
+const SerdNode*
+serd_nodes_intern(SerdNodes* nodes, const SerdNode* node);
+
+/**
+   Manage `node`.
+
+   Like `serd_nodes_intern`, but takes ownership of `node`, freeing it and
+   returning a previously interned/managed equivalent node if necessary.
+
+   @return A node that is equivalent to `node`.
+*/
+SERD_API
+const SerdNode*
+serd_nodes_manage(SerdNodes* nodes, SerdNode* node);
+
+/**
+   Dereference `node`.
+
+   Decrements the reference count of `node`, and frees the internally stored
+   equivalent node if this was the last reference.  Does nothing if no node
+   equivalent to `node` is stored in `nodes`.
+*/
+SERD_API
+void
+serd_nodes_deref(SerdNodes* nodes, const SerdNode* node);
+
 /**
    @}
    @name Statement
-- 
cgit v1.2.1