2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Martin Ling <martin-sigrok@earth.li>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #pragma SWIG nowarn=325,401
23 #include "libsigrok/libsigrok.hpp"
28 %include "std_string.i"
29 %include "std_vector.i"
31 %include "std_shared_ptr.i"
32 %include "exception.i"
36 static int swig_exception_code(int sigrok_exception_code) {
37 switch (sigrok_exception_code) {
39 return SWIG_MemoryError;
41 return SWIG_ValueError;
43 return SWIG_RuntimeError;
52 } catch (sigrok::Error &e) {
53 SWIG_exception(swig_exception_code(e.result),
54 const_cast<char*>(e.what()));
58 template< class T > class enable_shared_from_this;
60 %template(ContextShared) enable_shared_from_this<Context>;
62 %shared_ptr(sigrok::Context);
63 %shared_ptr(sigrok::Driver);
64 %shared_ptr(sigrok::Device);
65 %shared_ptr(sigrok::Configurable);
66 %shared_ptr(sigrok::HardwareDevice);
67 %shared_ptr(sigrok::Channel);
68 %shared_ptr(sigrok::ChannelGroup);
69 %shared_ptr(sigrok::EventSource);
70 %shared_ptr(sigrok::Session);
71 %shared_ptr(sigrok::SessionDevice);
72 %shared_ptr(sigrok::Packet);
73 %shared_ptr(sigrok::PacketPayload);
74 %shared_ptr(sigrok::Header);
75 %shared_ptr(sigrok::Meta);
76 %shared_ptr(sigrok::Analog);
77 %shared_ptr(sigrok::Logic);
78 %shared_ptr(sigrok::InputFormat);
79 %shared_ptr(sigrok::Input);
80 %shared_ptr(sigrok::InputDevice);
81 %shared_ptr(sigrok::Option);
82 %shared_ptr(sigrok::OutputFormat);
83 %shared_ptr(sigrok::Output);
84 %shared_ptr(sigrok::Trigger);
85 %shared_ptr(sigrok::TriggerStage);
86 %shared_ptr(sigrok::TriggerMatch);
88 %template(StringMap) std::map<std::string, std::string>;
91 std::map<std::string, std::shared_ptr<sigrok::Driver> >;
92 %template(InputFormatMap)
93 std::map<std::string, std::shared_ptr<sigrok::InputFormat> >;
94 %template(OutputFormatMap)
95 std::map<std::string, std::shared_ptr<sigrok::OutputFormat> >;
97 %template(HardwareDeviceVector)
98 std::vector<std::shared_ptr<sigrok::HardwareDevice> >;
100 %template(DeviceVector)
101 std::vector<std::shared_ptr<sigrok::Device> >;
103 %template(ChannelVector)
104 std::vector<std::shared_ptr<sigrok::Channel> >;
106 %template(ChannelGroupMap)
107 std::map<std::string, std::shared_ptr<sigrok::ChannelGroup> >;
109 /* Workaround for SWIG bug. The vector template instantiation
110 isn't needed but somehow fixes a bug that stops the wrapper
111 for the map instantiation from compiling. */
112 %template(ConfigVector)
113 std::vector<const sigrok::ConfigKey *>;
115 std::map<const sigrok::ConfigKey *, Glib::VariantBase>;
117 %template(OptionVector)
118 std::vector<std::shared_ptr<sigrok::Option> >;
120 std::map<std::string, std::shared_ptr<sigrok::Option> >;
122 %template(VariantVector)
123 std::vector<Glib::VariantBase>;
124 %template(VariantMap)
125 std::map<std::string, Glib::VariantBase>;
127 %template(QuantityFlagVector)
128 std::vector<const sigrok::QuantityFlag *>;
130 %template(TriggerStageVector)
131 std::vector<std::shared_ptr<sigrok::TriggerStage> >;
133 %template(TriggerMatchVector)
134 std::vector<std::shared_ptr<sigrok::TriggerMatch> >;
139 %ignore sigrok::DatafeedCallbackData;
140 %ignore sigrok::SourceCallbackData;
142 #define SWIG_ATTRIBUTE_TEMPLATE
144 %include "attribute.i"
147 typedef std::map<std::string, std::shared_ptr<sigrok::Driver> >
149 typedef std::map<std::string, std::shared_ptr<sigrok::InputFormat> >
150 map_string_InputFormat;
151 typedef std::map<std::string, std::shared_ptr<sigrok::OutputFormat> >
152 map_string_OutputFormat;
153 typedef std::map<std::string, std::shared_ptr<sigrok::ChannelGroup> >
154 map_string_ChannelGroup;
155 typedef std::map<std::string, std::shared_ptr<sigrok::Option> >
157 typedef std::map<std::string, Glib::VariantBase>
159 typedef std::map<const sigrok::ConfigKey *, Glib::VariantBase>
160 map_ConfigKey_Variant;
163 %attributeval(sigrok::Context,
164 map_string_Driver, drivers, drivers);
165 %attributeval(sigrok::Context,
166 map_string_InputFormat, input_formats, input_formats);
167 %attributeval(sigrok::Context,
168 map_string_OutputFormat, output_formats, output_formats);
170 %attributestring(sigrok::Context,
171 std::string, package_version, package_version);
172 %attributestring(sigrok::Context,
173 std::string, lib_version, lib_version);
175 %attribute(sigrok::Context,
176 const sigrok::LogLevel *, log_level, log_level, set_log_level);
178 %attributestring(sigrok::Context,
179 std::string, log_domain, log_domain, set_log_domain);
181 %attributestring(sigrok::Driver, std::string, name, name);
182 %attributestring(sigrok::Driver, std::string, long_name, long_name);
184 %attributestring(sigrok::InputFormat,
185 std::string, name, name);
186 %attributestring(sigrok::InputFormat,
187 std::string, description, description);
189 %attributestring(sigrok::Input,
190 std::shared_ptr<sigrok::InputDevice>, device, device);
192 %attributestring(sigrok::Option,
193 std::string, id, id);
194 %attributestring(sigrok::Option,
195 std::string, name, name);
196 %attributestring(sigrok::Option,
197 std::string, description, description);
198 /* Currently broken on Python due to some issue with variant typemaps. */
199 /* %attributeval(sigrok::Option,
200 Glib::VariantBase, default_value, default_value); */
201 %attributeval(sigrok::Option,
202 std::vector<Glib::VariantBase>, values, values);
204 %attributestring(sigrok::OutputFormat,
205 std::string, name, name);
206 %attributestring(sigrok::OutputFormat,
207 std::string, description, description);
208 %attributeval(sigrok::OutputFormat,
209 map_string_Option, options, options);
211 %attributestring(sigrok::Device, std::string, description, description);
212 %attributestring(sigrok::Device, std::string, vendor, vendor);
213 %attributestring(sigrok::Device, std::string, model, model);
214 %attributestring(sigrok::Device, std::string, version, version);
216 %attributeval(sigrok::Device,
217 std::vector<std::shared_ptr<sigrok::Channel> >,
220 %attributeval(sigrok::Device, map_string_ChannelGroup,
221 channel_groups, channel_groups);
223 /* Using %attributestring for shared_ptr attribute. See
224 http://sourceforge.net/p/swig/mailman/message/31832070/ */
225 %attributestring(sigrok::HardwareDevice,
226 std::shared_ptr<sigrok::Driver>, driver, driver);
228 %attributestring(sigrok::Channel, std::string, name, name, set_name);
229 %attribute(sigrok::Channel, bool, enabled, enabled, set_enabled);
230 %attribute(sigrok::Channel, const sigrok::ChannelType *, type, type);
231 %attribute(sigrok::Channel, unsigned int, index, index);
233 %attributestring(sigrok::ChannelGroup, std::string, name, name);
234 %attributeval(sigrok::ChannelGroup,
235 std::vector<std::shared_ptr<sigrok::Channel> >,
238 %attributestring(sigrok::Trigger, std::string, name, name);
239 %attributeval(sigrok::Trigger,
240 std::vector<std::shared_ptr<sigrok::TriggerStage> >,
243 %attribute(sigrok::TriggerStage, int, number, number);
244 %attributeval(sigrok::TriggerStage,
245 std::vector<std::shared_ptr<sigrok::TriggerMatch> >,
248 %attributestring(sigrok::TriggerMatch,
249 std::shared_ptr<sigrok::Channel>, channel, channel);
250 %attribute(sigrok::TriggerMatch, const sigrok::TriggerMatchType *, type, type);
251 %attribute(sigrok::TriggerMatch, float, value, value);
253 %attributeval(sigrok::Session,
254 std::vector<std::shared_ptr<sigrok::Device> >,
257 %attributestring(sigrok::Session,
258 std::shared_ptr<sigrok::Trigger>, trigger, trigger, set_trigger);
260 %attributestring(sigrok::Session, std::string, filename, filename);
262 %attribute(sigrok::Packet,
263 const sigrok::PacketType *, type, type);
264 %attributestring(sigrok::Packet,
265 std::shared_ptr<sigrok::PacketPayload>, payload, payload);
267 %attributeval(sigrok::Meta, map_ConfigKey_Variant, config, config);
269 %attribute(sigrok::Analog, int, num_samples, num_samples);
270 %attribute(sigrok::Analog, const sigrok::Quantity *, mq, mq);
271 %attribute(sigrok::Analog, const sigrok::Unit *, unit, unit);
272 %attributeval(sigrok::Analog, std::vector<const sigrok::QuantityFlag *>, mq_flags, mq_flags);
274 %include "libsigrok/libsigrok.hpp"
277 %include "libsigrok/enums.hpp"