Merged branch 'msg-passing' from http://gnuradio.org/git/eb.git
[debian/gnuradio] / gruel / src / lib / pmt / pmt_int.h
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 #ifndef INCLUDED_PMT_INT_H
23 #define INCLUDED_PMT_INT_H
24
25 #include <gruel/pmt.h>
26 #include <boost/utility.hpp>
27 #include <boost/detail/atomic_count.hpp>
28
29 /*
30  * EVERYTHING IN THIS FILE IS PRIVATE TO THE IMPLEMENTATION!
31  *
32  * See pmt.h for the public interface
33  */
34
35 #define PMT_LOCAL_ALLOCATOR 0           // define to 0 or 1
36 namespace pmt {
37
38 class pmt_base : boost::noncopyable {
39   mutable boost::detail::atomic_count count_;
40
41 protected:
42   pmt_base() : count_(0) {};
43   virtual ~pmt_base();
44
45 public:
46   virtual bool is_bool()    const { return false; }
47   virtual bool is_symbol()  const { return false; }
48   virtual bool is_number()  const { return false; }
49   virtual bool is_integer() const { return false; }
50   virtual bool is_real()    const { return false; }
51   virtual bool is_complex() const { return false; }
52   virtual bool is_null()    const { return false; }
53   virtual bool is_pair()    const { return false; }
54   virtual bool is_tuple()   const { return false; }
55   virtual bool is_vector()  const { return false; }
56   virtual bool is_dict()    const { return false; }
57   virtual bool is_any()     const { return false; }
58
59   virtual bool is_uniform_vector() const { return false; }
60   virtual bool is_u8vector()  const { return false; }
61   virtual bool is_s8vector()  const { return false; }
62   virtual bool is_u16vector() const { return false; }
63   virtual bool is_s16vector() const { return false; }
64   virtual bool is_u32vector() const { return false; }
65   virtual bool is_s32vector() const { return false; }
66   virtual bool is_u64vector() const { return false; }
67   virtual bool is_s64vector() const { return false; }
68   virtual bool is_f32vector() const { return false; }
69   virtual bool is_f64vector() const { return false; }
70   virtual bool is_c32vector() const { return false; }
71   virtual bool is_c64vector() const { return false; }
72
73   friend void intrusive_ptr_add_ref(pmt_base* p);
74   friend void intrusive_ptr_release(pmt_base* p);
75
76 # if (PMT_LOCAL_ALLOCATOR)
77   void *operator new(size_t);
78   void operator delete(void *, size_t);
79 #endif
80 };
81
82 class pmt_bool : public pmt_base
83 {
84 public:
85   pmt_bool();
86   //~pmt_bool(){}
87
88   bool is_bool() const { return true; }
89 };
90
91
92 class pmt_symbol : public pmt_base
93 {
94   std::string   d_name;
95   pmt_t         d_next;
96   
97 public:
98   pmt_symbol(const std::string &name);
99   //~pmt_symbol(){}
100
101   bool is_symbol() const { return true; }
102   const std::string name() { return d_name; }
103
104   pmt_t next() { return d_next; }               // symbol table link
105   void set_next(pmt_t next) { d_next = next; }
106 };
107
108 class pmt_integer : public pmt_base
109 {
110   long          d_value;
111
112 public:
113   pmt_integer(long value);
114   //~pmt_integer(){}
115
116   bool is_number()  const { return true; }
117   bool is_integer() const { return true; }
118   long value() const { return d_value; }
119 };
120
121 class pmt_real : public pmt_base
122 {
123   double        d_value;
124
125 public:
126   pmt_real(double value);
127   //~pmt_real(){}
128
129   bool is_number()  const { return true; }
130   bool is_real() const { return true; }
131   double value() const { return d_value; }
132 };
133
134 class pmt_complex : public pmt_base
135 {
136   std::complex<double>  d_value;
137
138 public:
139   pmt_complex(std::complex<double> value);
140   //~pmt_complex(){}
141
142   bool is_number()  const { return true; }
143   bool is_complex() const { return true; }
144   std::complex<double> value() const { return d_value; }
145 };
146
147 class pmt_null  : public pmt_base
148 {
149 public:
150   pmt_null();
151   //~pmt_null(){}
152
153   bool is_null() const { return true; }
154 };
155
156 class pmt_pair : public pmt_base
157 {
158   pmt_t         d_car;
159   pmt_t         d_cdr;
160
161 public:
162   pmt_pair(const pmt_t& car, const pmt_t& cdr);
163   //~pmt_pair(){};
164
165   bool is_pair() const { return true; }
166   pmt_t car() const { return d_car; }
167   pmt_t cdr() const { return d_cdr; }
168
169   void set_car(pmt_t car) { d_car = car; }
170   void set_cdr(pmt_t cdr) { d_cdr = cdr; }
171 };
172
173 class pmt_vector : public pmt_base
174 {
175   std::vector<pmt_t>    d_v;
176
177 public:
178   pmt_vector(size_t len, pmt_t fill);
179   //~pmt_vector();
180
181   bool is_vector() const { return true; }
182   pmt_t ref(size_t k) const;
183   void  set(size_t k, pmt_t obj);
184   void  fill(pmt_t fill);
185   size_t length() const { return d_v.size(); }
186
187   pmt_t _ref(size_t k) const { return d_v[k]; }
188 };
189
190 class pmt_tuple : public pmt_base
191 {
192   std::vector<pmt_t>    d_v;
193
194 public:
195   pmt_tuple(size_t len);
196   //~pmt_tuple();
197
198   bool is_tuple() const { return true; }
199   pmt_t ref(size_t k) const;
200   size_t length() const { return d_v.size(); }
201
202   pmt_t _ref(size_t k) const { return d_v[k]; }
203   void _set(size_t k, pmt_t v) { d_v[k] = v; }
204 };
205
206 class pmt_dict : public pmt_base
207 {
208   pmt_t         d_alist;        // list of (key . value) pairs
209
210 public:
211   pmt_dict();
212   //~pmt_dict();
213
214   bool  is_dict() const { return true; }
215   void  set(pmt_t key, pmt_t value);
216   pmt_t ref(pmt_t key, pmt_t default_value) const;
217   bool  has_key(pmt_t key) const;
218   pmt_t items() const;
219   pmt_t keys() const;
220   pmt_t values() const;
221 };
222
223 class pmt_any : public pmt_base
224 {
225   boost::any    d_any;
226
227 public:
228   pmt_any(const boost::any &any);
229   //~pmt_any();
230
231   bool is_any() const { return true; }
232   const boost::any &ref() const { return d_any; }
233   void  set(const boost::any &any) { d_any = any; }
234 };
235
236
237 class pmt_uniform_vector : public pmt_base
238 {
239 public:
240   bool is_uniform_vector() const { return true; }
241   virtual const void *uniform_elements(size_t &len) = 0;
242   virtual void *uniform_writable_elements(size_t &len) = 0;
243   virtual size_t length() const = 0;
244 };
245
246 #include "pmt_unv_int.h"
247
248 } /* namespace pmt */
249
250 #endif /* INCLUDED_PMT_INT_H */