source-engine/devtools/swigwin-1.3.34/Lib/std/std_queue.i
FluorescentCIAAfricanAmerican 3bf9df6b27 1
2020-04-22 12:56:21 -04:00

130 lines
3.4 KiB
OpenEdge ABL

/**
* @file std_queue.i
* @date Sun May 6 01:48:07 2007
*
* @brief A wrapping of std::queue for Ruby.
*
*
*/
%include <std_container.i>
// Queue
%define %std_queue_methods(queue...)
queue();
queue( const _Sequence& );
bool empty() const;
size_type size() const;
const value_type& front() const;
const value_type& back() const;
void pop();
void push( const value_type& );
%enddef
%define %std_queue_methods_val(queue...)
%std_queue_methods(queue)
%enddef
// ------------------------------------------------------------------------
// std::queue
//
// const declarations are used to guess the intent of the function being
// exported; therefore, the following rationale is applied:
//
// -- f(std::queue<T>), f(const std::queue<T>&):
// the parameter being read-only, either a sequence or a
// previously wrapped std::queue<T> can be passed.
// -- f(std::queue<T>&), f(std::queue<T>*):
// the parameter may be modified; therefore, only a wrapped std::queue
// can be passed.
// -- std::queue<T> f(), const std::queue<T>& f():
// the queue is returned by copy; therefore, a sequence of T:s
// is returned which is most easily used in other functions
// -- std::queue<T>& f(), std::queue<T>* f():
// the queue is returned by reference; therefore, a wrapped std::queue
// is returned
// -- const std::queue<T>* f(), f(const std::queue<T>*):
// for consistency, they expect and return a plain queue pointer.
// ------------------------------------------------------------------------
%{
#include <queue>
%}
// exported classes
namespace std {
template<class _Tp, class _Sequence = std::deque<_Tp> >
class queue {
public:
typedef size_t size_type;
typedef _Tp value_type;
typedef value_type& reference;
typedef const value_type& const_reference;
typedef _Sequence container_type;
%traits_swigtype(_Tp);
%fragment(SWIG_Traits_frag(std::queue<_Tp, _Sequence >), "header",
fragment=SWIG_Traits_frag(_Tp),
fragment="StdQueueTraits") {
namespace swig {
template <> struct traits<std::queue<_Tp, _Sequence > > {
typedef pointer_category category;
static const char* type_name() {
return "std::queue<" #_Tp "," #_Sequence " >";
}
};
}
}
%typemap_traits_ptr(SWIG_TYPECHECK_QUEUE, std::queue<_Tp, _Sequence >);
#ifdef %swig_queue_methods
// Add swig/language extra methods
%swig_queue_methods(std::queue<_Tp, _Sequence >);
#endif
%std_queue_methods(queue);
};
template<class _Tp, class _Sequence >
class queue<_Tp*, _Sequence > {
public:
typedef size_t size_type;
typedef _Tp value_type;
typedef value_type& reference;
typedef const value_type& const_reference;
typedef _Sequence container_type;
%traits_swigtype(_Tp);
%fragment(SWIG_Traits_frag(std::queue<_Tp*, _Sequence >), "header",
fragment=SWIG_Traits_frag(_Tp),
fragment="StdQueueTraits") {
namespace swig {
template <> struct traits<std::queue<_Tp*, _Sequence > > {
typedef value_category category;
static const char* type_name() {
return "std::queue<" #_Tp "," #_Sequence " * >";
}
};
}
}
%typemap_traits_ptr(SWIG_TYPECHECK_QUEUE, std::queue<_Tp*, _Sequence >);
#ifdef %swig_queue_methods_val
// Add swig/language extra methods
%swig_queue_methods_val(std::queue<_Tp*, _Sequence >);
#endif
%std_queue_methods_val(std::queue<_Tp*, _Sequence >);
};
}