From 4599e77844ed6a2269c8cf8f41e690f0bd2d2c3c Mon Sep 17 00:00:00 2001
From: Dave Beazley <dave-swig@dabeaz.com>
Date: Thu, 13 Nov 2003 04:19:40 +0000
Subject: [PATCH] Added %aggregate_check macro.

git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@5314 626c5289-ae23-0410-ae9c-e8d60b6d4f22
---
 SWIG/Lib/swig.swg | 50 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/SWIG/Lib/swig.swg b/SWIG/Lib/swig.swg
index 29ab59e3e..4b7ce96a1 100644
--- a/SWIG/Lib/swig.swg
+++ b/SWIG/Lib/swig.swg
@@ -335,4 +335,54 @@ private:
 %}
 %enddef
 
+/*
+
+   This macro performs constant aggregation.  Basically the idea of
+   constant aggregation is that you can group a collection of constants 
+   together.  For example, suppose you have some code like this:
+
+       #define UP  1
+       #define DOWN 2
+       #define LEFT 3
+       #define RIGHT 4
+
+   Now, suppose you had a function like this:
+
+       int move(int direction)
+
+   In this case, you might want to restrict the direction argument to one of the supplied
+   constant names. To do this, you could write some typemap code by hand.  Alternatively,
+   you can use the %aggregate_check macro defined here to create a simple check function
+   for you.  Here is an example:
+
+      %aggregate_check(int, check_direction, UP, DOWN, LEFT, RIGHT);
+
+   Now, using a typemap
+
+       %typemap(check) int direction {
+            if (!check_direction($1)) SWIG_exception(SWIG_ValueError,"Bad direction.");
+       }
+
+   or a contract (better)
+
+       %contract move(int x) {
+       require:
+           check_direction(x);
+       }
+*/
+   
+%define %aggregate_check(TYPE, NAME, FIRST, ...)
+%wrapper %{
+static int NAME(TYPE x) {
+    static  TYPE values[] = { FIRST, ##__VA_ARGS__ };
+    static  int size = sizeof(values);
+    int     i,j;
+    for (i = 0, j = 0; i < size; i+=sizeof(TYPE),j++) {
+        if (x == values[j]) return 1; 
+    }
+    return 0;
+}
+%}
+%enddef
+