b81354721dbad1b664fad64936991aecdf3ab14f
[debian/gnuradio] / gruel / src / lib / pmt / qa_pmt_prims.cc
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,2009 Free Software Foundation, Inc.
4  * 
5  * This file is part of GNU Radio
6  * 
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  * 
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include <qa_pmt_prims.h>
24 #include <cppunit/TestAssert.h>
25 #include <gruel/pmt.h>
26 #include <stdio.h>
27 #include <sstream>
28
29 using namespace pmt;
30
31 void
32 qa_pmt_prims::test_symbols()
33 {
34   CPPUNIT_ASSERT(!pmt_is_symbol(PMT_T));
35   CPPUNIT_ASSERT(!pmt_is_symbol(PMT_F));
36   CPPUNIT_ASSERT_THROW(pmt_symbol_to_string(PMT_F), pmt_wrong_type);
37
38   pmt_t sym1 = pmt_string_to_symbol("test");
39   CPPUNIT_ASSERT(pmt_is_symbol(sym1));
40   CPPUNIT_ASSERT_EQUAL(std::string("test"), pmt_symbol_to_string(sym1));
41   CPPUNIT_ASSERT(pmt_is_true(sym1));
42   CPPUNIT_ASSERT(!pmt_is_false(sym1));
43
44   pmt_t sym2 = pmt_string_to_symbol("foo");
45   pmt_t sym3 = pmt_string_to_symbol("test");
46   CPPUNIT_ASSERT_EQUAL(sym1, sym3);
47   CPPUNIT_ASSERT(sym1 != sym2);
48   CPPUNIT_ASSERT(sym1 == sym3);
49
50   static const int N = 2048;
51   std::vector<pmt_t> v1(N);
52   std::vector<pmt_t> v2(N);
53
54   // generate a bunch of symbols
55   for (int i = 0; i < N; i++){
56     char buf[100];
57     snprintf(buf, sizeof(buf), "test-%d", i);
58     v1[i] = pmt_string_to_symbol(buf);
59   }
60
61   // confirm that they are all unique
62   for (int i = 0; i < N; i++)
63     for (int j = i + 1; j < N; j++)
64       CPPUNIT_ASSERT(v1[i] != v1[j]);
65
66   // generate the same symbols again
67   for (int i = 0; i < N; i++){
68     char buf[100];
69     snprintf(buf, sizeof(buf), "test-%d", i);
70     v2[i] = pmt_string_to_symbol(buf);
71   }
72
73   // confirm that we get the same ones back
74   for (int i = 0; i < N; i++)
75     CPPUNIT_ASSERT(v1[i] == v2[i]);
76 }
77
78 void
79 qa_pmt_prims::test_booleans()
80 {
81   pmt_t sym = pmt_string_to_symbol("test");
82   CPPUNIT_ASSERT(pmt_is_bool(PMT_T));
83   CPPUNIT_ASSERT(pmt_is_bool(PMT_F));
84   CPPUNIT_ASSERT(!pmt_is_bool(sym));
85   CPPUNIT_ASSERT_EQUAL(pmt_from_bool(false), PMT_F);
86   CPPUNIT_ASSERT_EQUAL(pmt_from_bool(true), PMT_T);
87   CPPUNIT_ASSERT_EQUAL(false, pmt_to_bool(PMT_F));
88   CPPUNIT_ASSERT_EQUAL(true, pmt_to_bool(PMT_T));
89   CPPUNIT_ASSERT_THROW(pmt_to_bool(sym), pmt_wrong_type);
90 }
91
92 void
93 qa_pmt_prims::test_integers()
94 {
95   pmt_t p1 = pmt_from_long(1);
96   pmt_t m1 = pmt_from_long(-1);
97   CPPUNIT_ASSERT(!pmt_is_integer(PMT_T));
98   CPPUNIT_ASSERT(pmt_is_integer(p1));
99   CPPUNIT_ASSERT(pmt_is_integer(m1));
100   CPPUNIT_ASSERT_THROW(pmt_to_long(PMT_T), pmt_wrong_type);
101   CPPUNIT_ASSERT_EQUAL(-1L, pmt_to_long(m1));
102   CPPUNIT_ASSERT_EQUAL(1L, pmt_to_long(p1));
103 }
104
105 void
106 qa_pmt_prims::test_reals()
107 {
108   pmt_t p1 = pmt_from_double(1);
109   pmt_t m1 = pmt_from_double(-1);
110   CPPUNIT_ASSERT(!pmt_is_real(PMT_T));
111   CPPUNIT_ASSERT(pmt_is_real(p1));
112   CPPUNIT_ASSERT(pmt_is_real(m1));
113   CPPUNIT_ASSERT_THROW(pmt_to_double(PMT_T), pmt_wrong_type);
114   CPPUNIT_ASSERT_EQUAL(-1.0, pmt_to_double(m1));
115   CPPUNIT_ASSERT_EQUAL(1.0, pmt_to_double(p1));
116   CPPUNIT_ASSERT_EQUAL(1.0, pmt_to_double(pmt_from_long(1)));
117 }
118
119 void
120 qa_pmt_prims::test_complexes()
121 {
122   pmt_t p1 = pmt_make_rectangular(2, -3);
123   pmt_t m1 = pmt_make_rectangular(-3, 2);
124   CPPUNIT_ASSERT(!pmt_is_complex(PMT_T));
125   CPPUNIT_ASSERT(pmt_is_complex(p1));
126   CPPUNIT_ASSERT(pmt_is_complex(m1));
127   CPPUNIT_ASSERT_THROW(pmt_to_complex(PMT_T), pmt_wrong_type);
128   CPPUNIT_ASSERT_EQUAL(std::complex<double>(2, -3), pmt_to_complex(p1));
129   CPPUNIT_ASSERT_EQUAL(std::complex<double>(-3, 2), pmt_to_complex(m1));
130   CPPUNIT_ASSERT_EQUAL(std::complex<double>(1.0, 0), pmt_to_complex(pmt_from_long(1)));
131   CPPUNIT_ASSERT_EQUAL(std::complex<double>(1.0, 0), pmt_to_complex(pmt_from_double(1.0)));
132 }
133
134 void
135 qa_pmt_prims::test_pairs()
136 {
137   CPPUNIT_ASSERT(pmt_is_null(PMT_NIL));
138   CPPUNIT_ASSERT(!pmt_is_pair(PMT_NIL));
139   pmt_t s1 = pmt_string_to_symbol("s1");
140   pmt_t s2 = pmt_string_to_symbol("s2");
141   pmt_t s3 = pmt_string_to_symbol("s3");
142
143
144   CPPUNIT_ASSERT_EQUAL((size_t)0, pmt_length(PMT_NIL));
145   CPPUNIT_ASSERT_THROW(pmt_length(s1), pmt_wrong_type);
146   CPPUNIT_ASSERT_THROW(pmt_length(pmt_from_double(42)), pmt_wrong_type);
147
148   pmt_t c1 = pmt_cons(s1, PMT_NIL);
149   CPPUNIT_ASSERT(pmt_is_pair(c1));
150   CPPUNIT_ASSERT(!pmt_is_pair(s1));
151   CPPUNIT_ASSERT_EQUAL(s1, pmt_car(c1));
152   CPPUNIT_ASSERT_EQUAL(PMT_NIL, pmt_cdr(c1));
153   CPPUNIT_ASSERT_EQUAL((size_t) 1, pmt_length(c1));
154
155   pmt_t c3 = pmt_cons(s3, PMT_NIL);
156   pmt_t c2 = pmt_cons(s2, c3);
157   pmt_set_cdr(c1, c2);
158   CPPUNIT_ASSERT_EQUAL(c2, pmt_cdr(c1));
159   pmt_set_car(c1, s3);
160   CPPUNIT_ASSERT_EQUAL(s3, pmt_car(c1));
161   CPPUNIT_ASSERT_EQUAL((size_t)1, pmt_length(c3));
162   CPPUNIT_ASSERT_EQUAL((size_t)2, pmt_length(c2));
163   
164   CPPUNIT_ASSERT_THROW(pmt_cdr(PMT_NIL), pmt_wrong_type);
165   CPPUNIT_ASSERT_THROW(pmt_car(PMT_NIL), pmt_wrong_type);
166   CPPUNIT_ASSERT_THROW(pmt_set_car(s1, PMT_NIL), pmt_wrong_type);
167   CPPUNIT_ASSERT_THROW(pmt_set_cdr(s1, PMT_NIL), pmt_wrong_type);
168 }
169
170 void
171 qa_pmt_prims::test_vectors()
172 {
173   static const size_t N = 3;
174   pmt_t v1 = pmt_make_vector(N, PMT_NIL);
175   CPPUNIT_ASSERT_EQUAL(N, pmt_length(v1));
176   pmt_t s0 = pmt_string_to_symbol("s0");
177   pmt_t s1 = pmt_string_to_symbol("s1");
178   pmt_t s2 = pmt_string_to_symbol("s2");
179
180   pmt_vector_set(v1, 0, s0);
181   pmt_vector_set(v1, 1, s1);
182   pmt_vector_set(v1, 2, s2);
183
184   CPPUNIT_ASSERT_EQUAL(s0, pmt_vector_ref(v1, 0));
185   CPPUNIT_ASSERT_EQUAL(s1, pmt_vector_ref(v1, 1));
186   CPPUNIT_ASSERT_EQUAL(s2, pmt_vector_ref(v1, 2));
187
188   CPPUNIT_ASSERT_THROW(pmt_vector_ref(v1, N), pmt_out_of_range);
189   CPPUNIT_ASSERT_THROW(pmt_vector_set(v1, N, PMT_NIL), pmt_out_of_range);
190
191   pmt_vector_fill(v1, s0);
192   for (size_t i = 0; i < N; i++)
193     CPPUNIT_ASSERT_EQUAL(s0, pmt_vector_ref(v1, i));
194 }
195
196 void
197 qa_pmt_prims::test_equivalence()
198 {
199   pmt_t s0 = pmt_string_to_symbol("s0");
200   pmt_t s1 = pmt_string_to_symbol("s1");
201   pmt_t s2 = pmt_string_to_symbol("s2");
202   pmt_t list0 = pmt_cons(s0, pmt_cons(s1, pmt_cons(s2, PMT_NIL)));
203   pmt_t list1 = pmt_cons(s0, pmt_cons(s1, pmt_cons(s2, PMT_NIL)));
204   pmt_t i0 = pmt_from_long(42);
205   pmt_t i1 = pmt_from_long(42);
206   pmt_t r0 = pmt_from_double(42);
207   pmt_t r1 = pmt_from_double(42);
208   pmt_t r2 = pmt_from_double(43);
209
210   CPPUNIT_ASSERT(pmt_eq(s0, s0));
211   CPPUNIT_ASSERT(!pmt_eq(s0, s1));
212   CPPUNIT_ASSERT(pmt_eqv(s0, s0));
213   CPPUNIT_ASSERT(!pmt_eqv(s0, s1));
214
215   CPPUNIT_ASSERT(pmt_eqv(i0, i1));
216   CPPUNIT_ASSERT(pmt_eqv(r0, r1));
217   CPPUNIT_ASSERT(!pmt_eqv(r0, r2));
218   CPPUNIT_ASSERT(!pmt_eqv(i0, r0));
219
220   CPPUNIT_ASSERT(!pmt_eq(list0, list1));
221   CPPUNIT_ASSERT(!pmt_eqv(list0, list1));
222   CPPUNIT_ASSERT(pmt_equal(list0, list1));
223
224   pmt_t v0 = pmt_make_vector(3, s0);
225   pmt_t v1 = pmt_make_vector(3, s0);
226   pmt_t v2 = pmt_make_vector(4, s0);
227   CPPUNIT_ASSERT(!pmt_eqv(v0, v1));
228   CPPUNIT_ASSERT(pmt_equal(v0, v1));
229   CPPUNIT_ASSERT(!pmt_equal(v0, v2));
230
231   pmt_vector_set(v0, 0, list0);
232   pmt_vector_set(v0, 1, list0);
233   pmt_vector_set(v1, 0, list1);
234   pmt_vector_set(v1, 1, list1);
235   CPPUNIT_ASSERT(pmt_equal(v0, v1));
236 }
237
238 void
239 qa_pmt_prims::test_misc()
240 {
241   pmt_t k0 = pmt_string_to_symbol("k0");
242   pmt_t k1 = pmt_string_to_symbol("k1");
243   pmt_t k2 = pmt_string_to_symbol("k2");
244   pmt_t k3 = pmt_string_to_symbol("k3");
245   pmt_t v0 = pmt_string_to_symbol("v0");
246   pmt_t v1 = pmt_string_to_symbol("v1");
247   pmt_t v2 = pmt_string_to_symbol("v2");
248   pmt_t p0 = pmt_cons(k0, v0);
249   pmt_t p1 = pmt_cons(k1, v1);
250   pmt_t p2 = pmt_cons(k2, v2);
251   
252   pmt_t alist = pmt_cons(p0, pmt_cons(p1, pmt_cons(p2, PMT_NIL)));
253   CPPUNIT_ASSERT(pmt_eq(p1, pmt_assv(k1, alist)));
254   CPPUNIT_ASSERT(pmt_eq(PMT_F, pmt_assv(k3, alist)));
255   
256   pmt_t keys = pmt_cons(k0, pmt_cons(k1, pmt_cons(k2, PMT_NIL)));
257   pmt_t vals = pmt_cons(v0, pmt_cons(v1, pmt_cons(v2, PMT_NIL)));
258   CPPUNIT_ASSERT(pmt_equal(keys, pmt_map(pmt_car, alist)));
259   CPPUNIT_ASSERT(pmt_equal(vals, pmt_map(pmt_cdr, alist)));
260 }
261
262 void
263 qa_pmt_prims::test_dict()
264 {
265   pmt_t dict = pmt_make_dict();
266   CPPUNIT_ASSERT(pmt_is_dict(dict));
267
268   pmt_t k0 = pmt_string_to_symbol("k0");
269   pmt_t k1 = pmt_string_to_symbol("k1");
270   pmt_t k2 = pmt_string_to_symbol("k2");
271   pmt_t k3 = pmt_string_to_symbol("k3");
272   pmt_t v0 = pmt_string_to_symbol("v0");
273   pmt_t v1 = pmt_string_to_symbol("v1");
274   pmt_t v2 = pmt_string_to_symbol("v2");
275   pmt_t v3 = pmt_string_to_symbol("v3");
276   pmt_t not_found = pmt_cons(PMT_NIL, PMT_NIL);
277   
278   CPPUNIT_ASSERT(!pmt_dict_has_key(dict, k0));
279   pmt_dict_set(dict, k0, v0);
280   CPPUNIT_ASSERT(pmt_dict_has_key(dict, k0));
281   CPPUNIT_ASSERT(pmt_eqv(pmt_dict_ref(dict, k0, not_found), v0));
282   CPPUNIT_ASSERT(pmt_eqv(pmt_dict_ref(dict, k1, not_found), not_found));
283   pmt_dict_set(dict, k1, v1);
284   pmt_dict_set(dict, k2, v2);
285   CPPUNIT_ASSERT(pmt_eqv(pmt_dict_ref(dict, k1, not_found), v1));
286   pmt_dict_set(dict, k1, v3);
287   CPPUNIT_ASSERT(pmt_eqv(pmt_dict_ref(dict, k1, not_found), v3));
288
289   pmt_t keys = pmt_cons(k2, pmt_cons(k1, pmt_cons(k0, PMT_NIL)));
290   pmt_t vals = pmt_cons(v2, pmt_cons(v3, pmt_cons(v0, PMT_NIL)));
291   CPPUNIT_ASSERT(pmt_equal(keys, pmt_dict_keys(dict)));
292   CPPUNIT_ASSERT(pmt_equal(vals, pmt_dict_values(dict)));
293 }
294
295 void
296 qa_pmt_prims::test_io()
297 {
298   pmt_t k0 = pmt_string_to_symbol("k0");
299   pmt_t k1 = pmt_string_to_symbol("k1");
300   pmt_t k2 = pmt_string_to_symbol("k2");
301   pmt_t k3 = pmt_string_to_symbol("k3");
302
303   CPPUNIT_ASSERT_EQUAL(std::string("k0"), pmt_write_string(k0));
304 }
305
306 void
307 qa_pmt_prims::test_lists()
308 {
309   pmt_t s0 = pmt_intern("s0");
310   pmt_t s1 = pmt_intern("s1");
311   pmt_t s2 = pmt_intern("s2");
312   pmt_t s3 = pmt_intern("s3");
313
314   pmt_t l1 = pmt_list4(s0, s1, s2, s3);
315   pmt_t l2 = pmt_list3(s0, s1, s2);
316   pmt_t l3 = pmt_list_add(l2, s3);
317   CPPUNIT_ASSERT(pmt_equal(l1, l3));
318 }
319
320 // ------------------------------------------------------------------------
321
322 // class foo is used in test_any below.
323 // It can't be declared in the scope of test_any because of template
324 // namespace problems.
325
326 class foo {
327 public:
328   double        d_double;
329   int           d_int;
330   foo(double d=0, int i=0) : d_double(d), d_int(i) {}
331 };
332
333 bool operator==(const foo &a, const foo &b)
334 {
335   return a.d_double == b.d_double && a.d_int == b.d_int;
336 }
337
338 std::ostream& operator<<(std::ostream &os, const foo obj)
339 {
340   os << "<foo: " << obj.d_double << ", " << obj.d_int << ">";
341   return os;
342 }
343
344 void
345 qa_pmt_prims::test_any()
346 {
347   boost::any a0;
348   boost::any a1;
349   boost::any a2;
350
351   a0 = std::string("Hello!");
352   a1 = 42;
353   a2 = foo(3.250, 21);
354
355   pmt_t p0 = pmt_make_any(a0);
356   pmt_t p1 = pmt_make_any(a1);
357   pmt_t p2 = pmt_make_any(a2);
358
359   CPPUNIT_ASSERT_EQUAL(std::string("Hello!"),
360                        boost::any_cast<std::string>(pmt_any_ref(p0)));
361
362   CPPUNIT_ASSERT_EQUAL(42,
363                        boost::any_cast<int>(pmt_any_ref(p1)));
364
365   CPPUNIT_ASSERT_EQUAL(foo(3.250, 21),
366                        boost::any_cast<foo>(pmt_any_ref(p2)));
367 }
368
369 // ------------------------------------------------------------------------
370
371 void
372 qa_pmt_prims::test_serialize()
373 {
374   std::stringbuf sb;            // fake channel
375   pmt_t a = pmt_intern("a");
376   pmt_t b = pmt_intern("b");
377   pmt_t c = pmt_intern("c");
378
379   sb.str("");                   // reset channel to empty
380
381   // write stuff to channel
382
383   pmt_serialize(PMT_NIL, sb);
384   pmt_serialize(pmt_intern("foobarvia"), sb);
385   pmt_serialize(pmt_from_long(123456789), sb);
386   pmt_serialize(pmt_from_long(-123456789), sb);
387   pmt_serialize(pmt_cons(PMT_NIL, PMT_NIL), sb);
388   pmt_serialize(pmt_cons(a, b), sb);
389   pmt_serialize(pmt_list1(a), sb);
390   pmt_serialize(pmt_list2(a, b), sb);
391   pmt_serialize(pmt_list3(a, b, c), sb);
392   pmt_serialize(pmt_list3(a, pmt_list3(c, b, a), c), sb);
393   pmt_serialize(PMT_T, sb);
394   pmt_serialize(PMT_F, sb);
395
396   // read it back
397
398   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), PMT_NIL));
399   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_intern("foobarvia")));
400   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_from_long(123456789)));
401   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_from_long(-123456789)));
402   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_cons(PMT_NIL, PMT_NIL)));
403   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_cons(a, b)));
404   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_list1(a)));
405   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_list2(a, b)));
406   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_list3(a, b, c)));
407   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), pmt_list3(a, pmt_list3(c, b, a), c)));
408   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), PMT_T));
409   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), PMT_F));
410
411   CPPUNIT_ASSERT(pmt_equal(pmt_deserialize(sb), PMT_EOF));      // last item
412
413
414   // FIXME add tests for real, complex, vector, uniform-vector, dict
415   // FIXME add tests for malformed input too.
416
417 }
418
419 void
420 qa_pmt_prims::test_sets()
421 {
422   pmt_t s1 = pmt_intern("s1");
423   pmt_t s2 = pmt_intern("s2");
424   pmt_t s3 = pmt_intern("s3");
425
426   pmt_t l1 = pmt_list1(s1);
427   pmt_t l2 = pmt_list2(s2,s3);
428   pmt_t l3 = pmt_list3(s1,s2,s3);
429
430   CPPUNIT_ASSERT(pmt_is_pair(pmt_memq(s1,l1)));
431   CPPUNIT_ASSERT(pmt_is_false(pmt_memq(s3,l1)));
432
433   CPPUNIT_ASSERT(pmt_subsetp(l1,l3));
434   CPPUNIT_ASSERT(pmt_subsetp(l2,l3));
435   CPPUNIT_ASSERT(!pmt_subsetp(l1,l2));
436   CPPUNIT_ASSERT(!pmt_subsetp(l2,l1));
437   CPPUNIT_ASSERT(!pmt_subsetp(l3,l2));
438 }