octcontainer.swg 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623
  1. /* -----------------------------------------------------------------------------
  2. * octcontainer.swg
  3. *
  4. * Octave cell <-> C++ container wrapper
  5. *
  6. * This wrapper, and its iterator, allows a general use (and reuse) of
  7. * the mapping between C++ and Octave, thanks to the C++ templates.
  8. *
  9. * Of course, it needs the C++ compiler to support templates, but
  10. * since we will use this wrapper with the STL containers, that should
  11. * be the case.
  12. * ----------------------------------------------------------------------------- */
  13. %{
  14. #include <climits>
  15. #include <iostream>
  16. %}
  17. #if !defined(SWIG_NO_EXPORT_ITERATOR_METHODS)
  18. # if !defined(SWIG_EXPORT_ITERATOR_METHODS)
  19. # define SWIG_EXPORT_ITERATOR_METHODS SWIG_EXPORT_ITERATOR_METHODS
  20. # endif
  21. #endif
  22. %include <octiterators.swg>
  23. // The Octave C++ Wrap
  24. %fragment("<stdexcept>");
  25. %include <std_except.i>
  26. %fragment(SWIG_Traits_frag(octave_value),"header",fragment="StdTraits") {
  27. namespace swig {
  28. template <> struct traits<octave_value > {
  29. typedef value_category category;
  30. static const char* type_name() { return "octave_value"; }
  31. };
  32. template <> struct traits_from<octave_value> {
  33. typedef octave_value value_type;
  34. static octave_value from(const value_type& val) {
  35. return val;
  36. }
  37. };
  38. template <>
  39. struct traits_check<octave_value, value_category> {
  40. static bool check(const octave_value&) {
  41. return true;
  42. }
  43. };
  44. template <> struct traits_asval<octave_value > {
  45. typedef octave_value value_type;
  46. static int asval(const octave_value& obj, value_type *val) {
  47. if (val) *val = obj;
  48. return SWIG_OK;
  49. }
  50. };
  51. }
  52. }
  53. %fragment("OctSequence_Base","header",fragment="<stddef.h>")
  54. {
  55. %#include <functional>
  56. namespace std {
  57. template <>
  58. struct less <octave_value>: public binary_function<octave_value, octave_value, bool>
  59. {
  60. bool
  61. operator()(const octave_value& v, const octave_value& w) const
  62. {
  63. octave_value res = do_binary_op(octave_value::op_le,v,w);
  64. return res.is_true();
  65. }
  66. };
  67. }
  68. namespace swig {
  69. inline size_t
  70. check_index(ptrdiff_t i, size_t size, bool insert = false) {
  71. if ( i < 0 ) {
  72. if ((size_t) (-i) <= size)
  73. return (size_t) (i + size);
  74. } else if ( (size_t) i < size ) {
  75. return (size_t) i;
  76. } else if (insert && ((size_t) i == size)) {
  77. return size;
  78. }
  79. throw std::out_of_range("index out of range");
  80. }
  81. inline size_t
  82. slice_index(ptrdiff_t i, size_t size) {
  83. if ( i < 0 ) {
  84. if ((size_t) (-i) <= size) {
  85. return (size_t) (i + size);
  86. } else {
  87. throw std::out_of_range("index out of range");
  88. }
  89. } else {
  90. return ( (size_t) i < size ) ? ((size_t) i) : size;
  91. }
  92. }
  93. template <class Sequence, class Difference>
  94. inline typename Sequence::iterator
  95. getpos(Sequence* self, Difference i) {
  96. typename Sequence::iterator pos = self->begin();
  97. std::advance(pos, check_index(i,self->size()));
  98. return pos;
  99. }
  100. template <class Sequence, class Difference>
  101. inline typename Sequence::const_iterator
  102. cgetpos(const Sequence* self, Difference i) {
  103. typename Sequence::const_iterator pos = self->begin();
  104. std::advance(pos, check_index(i,self->size()));
  105. return pos;
  106. }
  107. template <class Sequence, class Difference>
  108. inline Sequence*
  109. getslice(const Sequence* self, Difference i, Difference j) {
  110. typename Sequence::size_type size = self->size();
  111. typename Sequence::size_type ii = swig::check_index(i, size);
  112. typename Sequence::size_type jj = swig::slice_index(j, size);
  113. if (jj > ii) {
  114. typename Sequence::const_iterator vb = self->begin();
  115. typename Sequence::const_iterator ve = self->begin();
  116. std::advance(vb,ii);
  117. std::advance(ve,jj);
  118. return new Sequence(vb, ve);
  119. } else {
  120. return new Sequence();
  121. }
  122. }
  123. template <class Sequence, class Difference, class InputSeq>
  124. inline void
  125. setslice(Sequence* self, Difference i, Difference j, const InputSeq& v) {
  126. typename Sequence::size_type size = self->size();
  127. typename Sequence::size_type ii = swig::check_index(i, size, true);
  128. typename Sequence::size_type jj = swig::slice_index(j, size);
  129. if (jj < ii) jj = ii;
  130. size_t ssize = jj - ii;
  131. if (ssize <= v.size()) {
  132. typename Sequence::iterator sb = self->begin();
  133. typename InputSeq::const_iterator vmid = v.begin();
  134. std::advance(sb,ii);
  135. std::advance(vmid, jj - ii);
  136. self->insert(std::copy(v.begin(), vmid, sb), vmid, v.end());
  137. } else {
  138. typename Sequence::iterator sb = self->begin();
  139. typename Sequence::iterator se = self->begin();
  140. std::advance(sb,ii);
  141. std::advance(se,jj);
  142. self->erase(sb,se);
  143. self->insert(sb, v.begin(), v.end());
  144. }
  145. }
  146. template <class Sequence, class Difference>
  147. inline void
  148. delslice(Sequence* self, Difference i, Difference j) {
  149. typename Sequence::size_type size = self->size();
  150. typename Sequence::size_type ii = swig::check_index(i, size, true);
  151. typename Sequence::size_type jj = swig::slice_index(j, size);
  152. if (jj > ii) {
  153. typename Sequence::iterator sb = self->begin();
  154. typename Sequence::iterator se = self->begin();
  155. std::advance(sb,ii);
  156. std::advance(se,jj);
  157. self->erase(sb,se);
  158. }
  159. }
  160. }
  161. }
  162. %fragment("OctSequence_Cont","header",
  163. fragment="StdTraits",
  164. fragment="OctSequence_Base",
  165. fragment="OctSwigIterator_T")
  166. {
  167. namespace swig
  168. {
  169. template <class T>
  170. struct OctSequence_Ref // * octave can't support these, because of how assignment works
  171. {
  172. OctSequence_Ref(const octave_value& seq, int index)
  173. : _seq(seq), _index(index)
  174. {
  175. }
  176. operator T () const
  177. {
  178. // swig::SwigVar_PyObject item = OctSequence_GetItem(_seq, _index);
  179. octave_value item; // * todo
  180. try {
  181. return swig::as<T>(item, true);
  182. } catch (std::exception& e) {
  183. char msg[1024];
  184. sprintf(msg, "in sequence element %d ", _index);
  185. if (!Octave_Error_Occurred()) {
  186. %type_error(swig::type_name<T>());
  187. }
  188. SWIG_Octave_AddErrorMsg(msg);
  189. SWIG_Octave_AddErrorMsg(e.what());
  190. throw;
  191. }
  192. }
  193. OctSequence_Ref& operator=(const T& v)
  194. {
  195. // OctSequence_SetItem(_seq, _index, swig::from<T>(v));
  196. // * todo
  197. return *this;
  198. }
  199. private:
  200. octave_value _seq;
  201. int _index;
  202. };
  203. template <class T>
  204. struct OctSequence_ArrowProxy
  205. {
  206. OctSequence_ArrowProxy(const T& x): m_value(x) {}
  207. const T* operator->() const { return &m_value; }
  208. operator const T*() const { return &m_value; }
  209. T m_value;
  210. };
  211. template <class T, class Reference >
  212. struct OctSequence_InputIterator
  213. {
  214. typedef OctSequence_InputIterator<T, Reference > self;
  215. typedef std::random_access_iterator_tag iterator_category;
  216. typedef Reference reference;
  217. typedef T value_type;
  218. typedef T* pointer;
  219. typedef int difference_type;
  220. OctSequence_InputIterator()
  221. {
  222. }
  223. OctSequence_InputIterator(const octave_value& seq, int index)
  224. : _seq(seq), _index(index)
  225. {
  226. }
  227. reference operator*() const
  228. {
  229. return reference(_seq, _index);
  230. }
  231. OctSequence_ArrowProxy<T>
  232. operator->() const {
  233. return OctSequence_ArrowProxy<T>(operator*());
  234. }
  235. bool operator==(const self& ri) const
  236. {
  237. return (_index == ri._index);
  238. }
  239. bool operator!=(const self& ri) const
  240. {
  241. return !(operator==(ri));
  242. }
  243. self& operator ++ ()
  244. {
  245. ++_index;
  246. return *this;
  247. }
  248. self& operator -- ()
  249. {
  250. --_index;
  251. return *this;
  252. }
  253. self& operator += (difference_type n)
  254. {
  255. _index += n;
  256. return *this;
  257. }
  258. self operator +(difference_type n) const
  259. {
  260. return self(_seq, _index + n);
  261. }
  262. self& operator -= (difference_type n)
  263. {
  264. _index -= n;
  265. return *this;
  266. }
  267. self operator -(difference_type n) const
  268. {
  269. return self(_seq, _index - n);
  270. }
  271. difference_type operator - (const self& ri) const
  272. {
  273. return _index - ri._index;
  274. }
  275. bool operator < (const self& ri) const
  276. {
  277. return _index < ri._index;
  278. }
  279. reference
  280. operator[](difference_type n) const
  281. {
  282. return reference(_seq, _index + n);
  283. }
  284. private:
  285. octave_value _seq;
  286. difference_type _index;
  287. };
  288. template <class T>
  289. struct OctSequence_Cont
  290. {
  291. typedef OctSequence_Ref<T> reference;
  292. typedef const OctSequence_Ref<T> const_reference;
  293. typedef T value_type;
  294. typedef T* pointer;
  295. typedef int difference_type;
  296. typedef int size_type;
  297. typedef const pointer const_pointer;
  298. typedef OctSequence_InputIterator<T, reference> iterator;
  299. typedef OctSequence_InputIterator<T, const_reference> const_iterator;
  300. OctSequence_Cont(const octave_value& seq) : _seq(seq)
  301. {
  302. // * assert that we have map type etc.
  303. /*
  304. if (!OctSequence_Check(seq)) {
  305. throw std::invalid_argument("a sequence is expected");
  306. }
  307. _seq = seq;
  308. Py_INCREF(_seq);
  309. */
  310. }
  311. ~OctSequence_Cont()
  312. {
  313. }
  314. size_type size() const
  315. {
  316. // return static_cast<size_type>(OctSequence_Size(_seq));
  317. return 0; // * todo
  318. }
  319. bool empty() const
  320. {
  321. return size() == 0;
  322. }
  323. iterator begin()
  324. {
  325. return iterator(_seq, 0);
  326. }
  327. const_iterator begin() const
  328. {
  329. return const_iterator(_seq, 0);
  330. }
  331. iterator end()
  332. {
  333. return iterator(_seq, size());
  334. }
  335. const_iterator end() const
  336. {
  337. return const_iterator(_seq, size());
  338. }
  339. reference operator[](difference_type n)
  340. {
  341. return reference(_seq, n);
  342. }
  343. const_reference operator[](difference_type n) const
  344. {
  345. return const_reference(_seq, n);
  346. }
  347. bool check(bool set_err = true) const
  348. {
  349. int s = size();
  350. for (int i = 0; i < s; ++i) {
  351. // swig::SwigVar_PyObject item = OctSequence_GetItem(_seq, i);
  352. octave_value item; // * todo
  353. if (!swig::check<value_type>(item)) {
  354. if (set_err) {
  355. char msg[1024];
  356. sprintf(msg, "in sequence element %d", i);
  357. SWIG_Error(SWIG_RuntimeError, msg);
  358. }
  359. return false;
  360. }
  361. }
  362. return true;
  363. }
  364. private:
  365. octave_value _seq;
  366. };
  367. }
  368. }
  369. %define %swig_sequence_iterator(Sequence...)
  370. #if defined(SWIG_EXPORT_ITERATOR_METHODS)
  371. class iterator;
  372. class reverse_iterator;
  373. class const_iterator;
  374. class const_reverse_iterator;
  375. %typemap(out,noblock=1,fragment="OctSequence_Cont")
  376. iterator, reverse_iterator, const_iterator, const_reverse_iterator {
  377. $result = SWIG_NewPointerObj(swig::make_output_iterator(%static_cast($1,const $type &)),
  378. swig::OctSwigIterator::descriptor(),SWIG_POINTER_OWN);
  379. }
  380. %typemap(out,fragment="OctSequence_Cont")
  381. std::pair<iterator, iterator>, std::pair<const_iterator, const_iterator> {
  382. octave_value_list tmpc;
  383. tmpc.append(SWIG_NewPointerObj(swig::make_output_iterator(%static_cast($1,const $type &).first),
  384. swig::OctSwigIterator::descriptor(),SWIG_POINTER_OWN));
  385. tmpc.append(SWIG_NewPointerObj(swig::make_output_iterator(%static_cast($1,const $type &).second),
  386. swig::OctSwigIterator::descriptor(),SWIG_POINTER_OWN));
  387. $result = Cell(tmpc);
  388. }
  389. %fragment("SwigPyPairBoolOutputIterator","header",fragment=SWIG_From_frag(bool),fragment="OctSequence_Cont") {}
  390. %typemap(out,fragment="OctPairBoolOutputIterator")
  391. std::pair<iterator, bool>, std::pair<const_iterator, bool> {
  392. octave_value_list tmpc;
  393. tmpc.append(SWIG_NewPointerObj(swig::make_output_iterator(%static_cast($1,const $type &).first),
  394. swig::OctSwigIterator::descriptor(),SWIG_POINTER_OWN));
  395. tmpc.append(SWIG_From(bool)(%static_cast($1,const $type &).second));
  396. $result = Cell(tmpc);
  397. }
  398. %typemap(in,noblock=1,fragment="OctSequence_Cont")
  399. iterator(swig::OctSwigIterator *iter = 0, int res),
  400. reverse_iterator(swig::OctSwigIterator *iter = 0, int res),
  401. const_iterator(swig::OctSwigIterator *iter = 0, int res),
  402. const_reverse_iterator(swig::OctSwigIterator *iter = 0, int res) {
  403. res = SWIG_ConvertPtr($input, %as_voidptrptr(&iter), swig::OctSwigIterator::descriptor(), 0);
  404. if (!SWIG_IsOK(res) || !iter) {
  405. %argument_fail(SWIG_TypeError, "$type", $symname, $argnum);
  406. } else {
  407. swig::OctSwigIterator_T<$type > *iter_t = dynamic_cast<swig::OctSwigIterator_T<$type > *>(iter);
  408. if (iter_t) {
  409. $1 = iter_t->get_current();
  410. } else {
  411. %argument_fail(SWIG_TypeError, "$type", $symname, $argnum);
  412. }
  413. }
  414. }
  415. %typecheck(%checkcode(ITERATOR),noblock=1,fragment="OctSequence_Cont")
  416. iterator, reverse_iterator, const_iterator, const_reverse_iterator {
  417. swig::OctSwigIterator *iter = 0;
  418. int res = SWIG_ConvertPtr($input, %as_voidptrptr(&iter), swig::OctSwigIterator::descriptor(), 0);
  419. $1 = (SWIG_IsOK(res) && iter && (dynamic_cast<swig::OctSwigIterator_T<$type > *>(iter) != 0));
  420. }
  421. %fragment("OctSequence_Cont");
  422. #endif //SWIG_EXPORT_ITERATOR_METHODS
  423. %enddef
  424. // The octave container methods
  425. %define %swig_container_methods(Container...)
  426. %enddef
  427. %define %swig_sequence_methods_common(Sequence...)
  428. %swig_sequence_iterator(%arg(Sequence))
  429. %swig_container_methods(%arg(Sequence))
  430. %fragment("OctSequence_Base");
  431. %extend {
  432. value_type pop() throw (std::out_of_range) {
  433. if (self->size() == 0)
  434. throw std::out_of_range("pop from empty container");
  435. Sequence::value_type x = self->back();
  436. self->pop_back();
  437. return x;
  438. }
  439. value_type __paren__(difference_type i) throw (std::out_of_range) {
  440. return *(swig::cgetpos(self, i));
  441. }
  442. void __paren_asgn__(difference_type i, value_type x) throw (std::out_of_range) {
  443. *(swig::getpos(self,i)) = x;
  444. }
  445. void append(value_type x) {
  446. self->push_back(x);
  447. }
  448. }
  449. %enddef
  450. %define %swig_sequence_methods(Sequence...)
  451. %swig_sequence_methods_common(%arg(Sequence))
  452. %enddef
  453. %define %swig_sequence_methods_val(Sequence...)
  454. %swig_sequence_methods_common(%arg(Sequence))
  455. %enddef
  456. //
  457. // Common fragments
  458. //
  459. %fragment("StdSequenceTraits","header",
  460. fragment="StdTraits",
  461. fragment="OctSequence_Cont")
  462. {
  463. namespace swig {
  464. template <class OctSeq, class Seq>
  465. inline void
  466. assign(const OctSeq& octseq, Seq* seq) {
  467. %#ifdef SWIG_STD_NOASSIGN_STL
  468. typedef typename OctSeq::value_type value_type;
  469. typename OctSeq::const_iterator it = octseq.begin();
  470. for (;it != octseq.end(); ++it) {
  471. seq->insert(seq->end(),(value_type)(*it));
  472. }
  473. %#else
  474. seq->assign(octseq.begin(), octseq.end());
  475. %#endif
  476. }
  477. template <class Seq, class T = typename Seq::value_type >
  478. struct traits_asptr_stdseq {
  479. typedef Seq sequence;
  480. typedef T value_type;
  481. static int asptr(const octave_value& obj, sequence **seq) {
  482. if (!obj.is_defined() || Swig::swig_value_deref(obj)) {
  483. sequence *p;
  484. if (SWIG_ConvertPtr(obj,(void**)&p,
  485. swig::type_info<sequence>(),0) == SWIG_OK) {
  486. if (seq) *seq = p;
  487. return SWIG_OLDOBJ;
  488. }
  489. } else if (obj.is_cell()) {
  490. try {
  491. OctSequence_Cont<value_type> octseq(obj);
  492. if (seq) {
  493. sequence *pseq = new sequence();
  494. assign(octseq, pseq);
  495. *seq = pseq;
  496. return SWIG_NEWOBJ;
  497. } else {
  498. return octseq.check() ? SWIG_OK : SWIG_ERROR;
  499. }
  500. } catch (std::exception& e) {
  501. if (seq&&!error_state)
  502. error("swig type error: %s",e.what());
  503. return SWIG_ERROR;
  504. }
  505. }
  506. return SWIG_ERROR;
  507. }
  508. };
  509. template <class Seq, class T = typename Seq::value_type >
  510. struct traits_from_stdseq {
  511. typedef Seq sequence;
  512. typedef T value_type;
  513. typedef typename Seq::size_type size_type;
  514. typedef typename sequence::const_iterator const_iterator;
  515. static octave_value from(const sequence& seq) {
  516. #ifdef SWIG_OCTAVE_EXTRA_NATIVE_CONTAINERS
  517. swig_type_info *desc = swig::type_info<sequence>();
  518. if (desc && desc->clientdata) {
  519. return SWIG_NewPointerObj(new sequence(seq), desc, SWIG_POINTER_OWN);
  520. }
  521. #endif
  522. size_type size = seq.size();
  523. if (size <= (size_type)INT_MAX) {
  524. Cell c(size,1);
  525. int i = 0;
  526. for (const_iterator it = seq.begin();
  527. it != seq.end(); ++it, ++i) {
  528. c(i) = swig::from<value_type>(*it);
  529. }
  530. return c;
  531. } else {
  532. error("swig overflow error: sequence size not valid in octave");
  533. return octave_value();
  534. }
  535. return octave_value();
  536. }
  537. };
  538. }
  539. }