Updated FSF address in all files. Fixes ticket:51
[debian/gnuradio] / pmt / src / lib / pmt_int.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006 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 2, 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 <pmt.h>
26
27 /*
28  * EVERYTHING IN THIS FILE IS PRIVATE TO THE IMPLEMENTATION!
29  *
30  * See pmt.h for the public interface
31  */
32
33 class pmt_base {
34 protected:
35   pmt_base(){};
36   virtual ~pmt_base();
37
38 private:
39   pmt_base(const pmt_base& rhs);                // NOT IMPLEMENTED
40   pmt_base& operator=(const pmt_base& rhs);     // NOT IMPLEMENTED
41   
42
43 public:
44   virtual bool is_bool()    const { return false; }
45   virtual bool is_symbol()  const { return false; }
46   virtual bool is_number()  const { return false; }
47   virtual bool is_integer() const { return false; }
48   virtual bool is_real()    const { return false; }
49   virtual bool is_complex() const { return false; }
50   virtual bool is_null()    const { return false; }
51   virtual bool is_pair()    const { return false; }
52   virtual bool is_vector()  const { return false; }
53   virtual bool is_dict()    const { return false; }
54
55   virtual bool is_uniform_vector() const { return false; }
56   virtual bool is_u8vector()  const { return false; }
57   virtual bool is_s8vector()  const { return false; }
58   virtual bool is_u16vector() const { return false; }
59   virtual bool is_s16vector() const { return false; }
60   virtual bool is_u32vector() const { return false; }
61   virtual bool is_s32vector() const { return false; }
62   virtual bool is_u64vector() const { return false; }
63   virtual bool is_s64vector() const { return false; }
64   virtual bool is_f32vector() const { return false; }
65   virtual bool is_f64vector() const { return false; }
66   virtual bool is_c32vector() const { return false; }
67   virtual bool is_c64vector() const { return false; }
68
69 };
70
71 class pmt_bool : public pmt_base
72 {
73 public:
74   pmt_bool();
75   //~pmt_bool(){}
76
77   bool is_bool() const { return true; }
78 };
79
80
81 class pmt_symbol : public pmt_base
82 {
83   std::string   d_name;
84   pmt_t         d_next;
85   
86 public:
87   pmt_symbol(const std::string &name);
88   //~pmt_symbol(){}
89
90   bool is_symbol() const { return true; }
91   const std::string name() { return d_name; }
92
93   pmt_t next() { return d_next; }               // symbol table link
94   void set_next(pmt_t next) { d_next = next; }
95 };
96
97 class pmt_integer : public pmt_base
98 {
99   long          d_value;
100
101 public:
102   pmt_integer(long value);
103   //~pmt_integer(){}
104
105   bool is_integer() const { return true; }
106   long value() const { return d_value; }
107 };
108
109 class pmt_real : public pmt_base
110 {
111   double        d_value;
112
113 public:
114   pmt_real(double value);
115   //~pmt_real(){}
116
117   bool is_real() const { return true; }
118   double value() const { return d_value; }
119 };
120
121 class pmt_complex : public pmt_base
122 {
123   std::complex<double>  d_value;
124
125 public:
126   pmt_complex(std::complex<double> value);
127   //~pmt_complex(){}
128
129   bool is_complex() const { return true; }
130   std::complex<double> value() const { return d_value; }
131 };
132
133 class pmt_null  : public pmt_base
134 {
135 public:
136   pmt_null();
137   //~pmt_null(){}
138
139   bool is_null() const { return true; }
140 };
141
142 class pmt_pair : public pmt_base
143 {
144   pmt_t         d_car;
145   pmt_t         d_cdr;
146
147 public:
148   pmt_pair(pmt_t car, pmt_t cdr);
149   //~pmt_pair(){};
150
151   bool is_pair() const { return true; }
152   pmt_t car() const { return d_car; }
153   pmt_t cdr() const { return d_cdr; }
154
155   void set_car(pmt_t car) { d_car = car; }
156   void set_cdr(pmt_t cdr) { d_cdr = cdr; }
157 };
158
159 class pmt_vector : public pmt_base
160 {
161   std::vector<pmt_t>    d_v;
162
163 public:
164   pmt_vector(size_t len, pmt_t fill);
165   //~pmt_vector();
166
167   bool is_vector() const { return true; }
168   pmt_t ref(size_t k) const;
169   void  set(size_t k, pmt_t obj);
170   void  fill(pmt_t fill);
171   size_t length() const { return d_v.size(); }
172
173   pmt_t _ref(size_t k) const { return d_v[k]; }
174 };
175
176 class pmt_dict : public pmt_base
177 {
178   pmt_t         d_alist;        // list of (key . value) pairs
179
180 public:
181   pmt_dict();
182   //~pmt_dict();
183
184   bool  is_dict() const { return true; }
185   void  set(pmt_t key, pmt_t value);
186   pmt_t ref(pmt_t key, pmt_t default_value) const;
187   bool  has_key(pmt_t key) const;
188   pmt_t items() const;
189   pmt_t keys() const;
190   pmt_t values() const;
191 };
192
193 class pmt_uniform_vector : public pmt_base
194 {
195 public:
196   bool is_uniform_vector() const { return true; }
197   virtual const void *uniform_elements(size_t &len) = 0;
198   virtual void *uniform_writeable_elements(size_t &len) = 0;
199   virtual size_t length() const = 0;
200 };
201
202 #include "pmt_unv_int.h"
203
204 #endif /* INCLUDED_PMT_INT_H */