blob: d89564d5064954ad71e3e7d72fbc287112965ca6 [file] [log] [blame]
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001
2#include "Python.h"
3
4PyDoc_STRVAR(operator_doc,
5"Operator interface.\n\
Guido van Rossum037b9401996-07-30 16:55:54 +00006\n\
7This module exports a set of functions implemented in C corresponding\n\
8to the intrinsic operators of Python. For example, operator.add(x, y)\n\
9is equivalent to the expression x+y. The function names are those\n\
10used for special class methods; variants without leading and trailing\n\
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000011'__' are also provided for convenience.");
Guido van Rossum037b9401996-07-30 16:55:54 +000012
Fred Drake5639ba42000-07-08 04:12:08 +000013#define spam1(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000014 PyObject *a1; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000015 if(! PyArg_UnpackTuple(a,#OP,1,1,&a1)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000016 return AOP(a1); }
17
Fred Drake5639ba42000-07-08 04:12:08 +000018#define spam2(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000019 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000020 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000021 return AOP(a1,a2); }
22
Fred Drake5639ba42000-07-08 04:12:08 +000023#define spamoi(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000024 PyObject *a1; int a2; \
Fred Drakeea4d3f02000-09-17 16:09:27 +000025 if(! PyArg_ParseTuple(a,"Oi:" #OP,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000026 return AOP(a1,a2); }
27
Fred Drake5639ba42000-07-08 04:12:08 +000028#define spam2n(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000029 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000030 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000031 if(-1 == AOP(a1,a2)) return NULL; \
32 Py_INCREF(Py_None); \
33 return Py_None; }
34
Fred Drake5639ba42000-07-08 04:12:08 +000035#define spam3n(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000036 PyObject *a1, *a2, *a3; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000037 if(! PyArg_UnpackTuple(a,#OP,3,3,&a1,&a2,&a3)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000038 if(-1 == AOP(a1,a2,a3)) return NULL; \
39 Py_INCREF(Py_None); \
40 return Py_None; }
41
Fred Drake5639ba42000-07-08 04:12:08 +000042#define spami(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000043 PyObject *a1; long r; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000044 if(! PyArg_UnpackTuple(a,#OP,1,1,&a1)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000045 if(-1 == (r=AOP(a1))) return NULL; \
Guido van Rossum77f6a652002-04-03 22:41:51 +000046 return PyBool_FromLong(r); }
Guido van Rossum037b9401996-07-30 16:55:54 +000047
Fred Drake5639ba42000-07-08 04:12:08 +000048#define spami2(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000049 PyObject *a1, *a2; long r; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000050 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000051 if(-1 == (r=AOP(a1,a2))) return NULL; \
52 return PyInt_FromLong(r); }
53
Guido van Rossum77f6a652002-04-03 22:41:51 +000054#define spami2b(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
55 PyObject *a1, *a2; long r; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000056 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum77f6a652002-04-03 22:41:51 +000057 if(-1 == (r=AOP(a1,a2))) return NULL; \
58 return PyBool_FromLong(r); }
59
Fred Drake428e75f2001-08-09 20:14:34 +000060#define spamrc(OP,A) static PyObject *OP(PyObject *s, PyObject *a) { \
61 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000062 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Fred Drake428e75f2001-08-09 20:14:34 +000063 return PyObject_RichCompare(a1,a2,A); }
64
Guido van Rossum037b9401996-07-30 16:55:54 +000065spami(isCallable , PyCallable_Check)
66spami(isNumberType , PyNumber_Check)
67spami(truth , PyObject_IsTrue)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000068spam2(op_add , PyNumber_Add)
69spam2(op_sub , PyNumber_Subtract)
70spam2(op_mul , PyNumber_Multiply)
71spam2(op_div , PyNumber_Divide)
Fred Drake428e75f2001-08-09 20:14:34 +000072spam2(op_floordiv , PyNumber_FloorDivide)
73spam2(op_truediv , PyNumber_TrueDivide)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000074spam2(op_mod , PyNumber_Remainder)
75spam1(op_neg , PyNumber_Negative)
76spam1(op_pos , PyNumber_Positive)
77spam1(op_abs , PyNumber_Absolute)
78spam1(op_inv , PyNumber_Invert)
Fred Drakeea4d3f02000-09-17 16:09:27 +000079spam1(op_invert , PyNumber_Invert)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000080spam2(op_lshift , PyNumber_Lshift)
81spam2(op_rshift , PyNumber_Rshift)
Guido van Rossum99c185e1998-04-09 17:54:26 +000082spami(op_not_ , PyObject_Not)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000083spam2(op_and_ , PyNumber_And)
84spam2(op_xor , PyNumber_Xor)
85spam2(op_or_ , PyNumber_Or)
Guido van Rossum037b9401996-07-30 16:55:54 +000086spami(isSequenceType , PySequence_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000087spam2(op_concat , PySequence_Concat)
88spamoi(op_repeat , PySequence_Repeat)
Guido van Rossum77f6a652002-04-03 22:41:51 +000089spami2b(op_contains , PySequence_Contains)
90spami2b(sequenceIncludes, PySequence_Contains)
Guido van Rossum037b9401996-07-30 16:55:54 +000091spami2(indexOf , PySequence_Index)
92spami2(countOf , PySequence_Count)
93spami(isMappingType , PyMapping_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000094spam2(op_getitem , PyObject_GetItem)
95spam2n(op_delitem , PyObject_DelItem)
96spam3n(op_setitem , PyObject_SetItem)
Fred Drake428e75f2001-08-09 20:14:34 +000097spamrc(op_lt , Py_LT)
98spamrc(op_le , Py_LE)
99spamrc(op_eq , Py_EQ)
100spamrc(op_ne , Py_NE)
101spamrc(op_gt , Py_GT)
102spamrc(op_ge , Py_GE)
Guido van Rossum037b9401996-07-30 16:55:54 +0000103
104static PyObject*
Raymond Hettinger5959c552002-08-19 03:19:09 +0000105op_pow(PyObject *s, PyObject *a)
106{
107 PyObject *a1, *a2;
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000108 if (PyArg_UnpackTuple(a,"pow", 2, 2, &a1, &a2))
Raymond Hettinger5959c552002-08-19 03:19:09 +0000109 return PyNumber_Power(a1, a2, Py_None);
110 return NULL;
111}
112
113static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000114op_getslice(PyObject *s, PyObject *a)
Guido van Rossum037b9401996-07-30 16:55:54 +0000115{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000116 PyObject *a1;
Guido van Rossum24a49941997-08-28 18:11:05 +0000117 int a2,a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000118
Fred Drakeea4d3f02000-09-17 16:09:27 +0000119 if (!PyArg_ParseTuple(a,"Oii:getslice",&a1,&a2,&a3))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000120 return NULL;
121 return PySequence_GetSlice(a1,a2,a3);
Guido van Rossum037b9401996-07-30 16:55:54 +0000122}
123
124static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000125op_setslice(PyObject *s, PyObject *a)
Guido van Rossum037b9401996-07-30 16:55:54 +0000126{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000127 PyObject *a1, *a4;
Guido van Rossum24a49941997-08-28 18:11:05 +0000128 int a2,a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000129
Fred Drakeea4d3f02000-09-17 16:09:27 +0000130 if (!PyArg_ParseTuple(a,"OiiO:setslice",&a1,&a2,&a3,&a4))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000131 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000132
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000133 if (-1 == PySequence_SetSlice(a1,a2,a3,a4))
134 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000135
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000136 Py_INCREF(Py_None);
137 return Py_None;
Guido van Rossum037b9401996-07-30 16:55:54 +0000138}
139
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000140static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000141op_delslice(PyObject *s, PyObject *a)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000142{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000143 PyObject *a1;
Guido van Rossum24a49941997-08-28 18:11:05 +0000144 int a2,a3;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000145
Fred Drakeea4d3f02000-09-17 16:09:27 +0000146 if(! PyArg_ParseTuple(a,"Oii:delslice",&a1,&a2,&a3))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000147 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000148
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000149 if (-1 == PySequence_DelSlice(a1,a2,a3))
150 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000151
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000152 Py_INCREF(Py_None);
153 return Py_None;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000154}
155
Guido van Rossum037b9401996-07-30 16:55:54 +0000156#undef spam1
157#undef spam2
Neal Norwitz200788c2002-08-13 22:20:41 +0000158#define spam1(OP,DOC) {#OP, OP, METH_VARARGS, PyDoc_STR(DOC)},
Fred Drake5639ba42000-07-08 04:12:08 +0000159#define spam2(OP,ALTOP,DOC) {#OP, op_##OP, METH_VARARGS, DOC}, \
Neal Norwitz200788c2002-08-13 22:20:41 +0000160 {#ALTOP, op_##OP, METH_VARARGS, PyDoc_STR(DOC)},
Guido van Rossum037b9401996-07-30 16:55:54 +0000161
162static struct PyMethodDef operator_methods[] = {
Guido van Rossum037b9401996-07-30 16:55:54 +0000163
Guido van Rossum17202301996-08-19 22:01:39 +0000164spam1(isCallable,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000165 "isCallable(a) -- Same as callable(a).")
Guido van Rossum17202301996-08-19 22:01:39 +0000166spam1(isNumberType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000167 "isNumberType(a) -- Return True if a has a numeric type, False otherwise.")
Guido van Rossum17202301996-08-19 22:01:39 +0000168spam1(isSequenceType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000169 "isSequenceType(a) -- Return True if a has a sequence type, False otherwise.")
Guido van Rossum17202301996-08-19 22:01:39 +0000170spam1(truth,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000171 "truth(a) -- Return True if a is true, False otherwise.")
Fred Drakeea4d3f02000-09-17 16:09:27 +0000172spam2(contains,__contains__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000173 "contains(a, b) -- Same as b in a (note reversed operands).")
Fred Drakeea4d3f02000-09-17 16:09:27 +0000174spam1(sequenceIncludes,
175 "sequenceIncludes(a, b) -- Same as b in a (note reversed operands; deprecated).")
Guido van Rossum17202301996-08-19 22:01:39 +0000176spam1(indexOf,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000177 "indexOf(a, b) -- Return the first index of b in a.")
Guido van Rossum17202301996-08-19 22:01:39 +0000178spam1(countOf,
179 "countOf(a, b) -- Return the number of times b occurs in a.")
180spam1(isMappingType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000181 "isMappingType(a) -- Return True if a has a mapping type, False otherwise.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000182
Guido van Rossum832f6d21998-05-22 18:12:59 +0000183spam2(add,__add__, "add(a, b) -- Same as a + b.")
184spam2(sub,__sub__, "sub(a, b) -- Same as a - b.")
185spam2(mul,__mul__, "mul(a, b) -- Same as a * b.")
Fred Drake428e75f2001-08-09 20:14:34 +0000186spam2(div,__div__, "div(a, b) -- Same as a / b when __future__.division is not in effect.")
187spam2(floordiv,__floordiv__, "floordiv(a, b) -- Same as a // b.")
188spam2(truediv,__truediv__, "truediv(a, b) -- Same as a / b when __future__.division is in effect.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000189spam2(mod,__mod__, "mod(a, b) -- Same as a % b.")
190spam2(neg,__neg__, "neg(a) -- Same as -a.")
191spam2(pos,__pos__, "pos(a) -- Same as +a.")
192spam2(abs,__abs__, "abs(a) -- Same as abs(a).")
193spam2(inv,__inv__, "inv(a) -- Same as ~a.")
Fred Drakeea4d3f02000-09-17 16:09:27 +0000194spam2(invert,__invert__, "invert(a) -- Same as ~a.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000195spam2(lshift,__lshift__, "lshift(a, b) -- Same as a << b.")
196spam2(rshift,__rshift__, "rshift(a, b) -- Same as a >> b.")
197spam2(not_,__not__, "not_(a) -- Same as not a.")
198spam2(and_,__and__, "and_(a, b) -- Same as a & b.")
199spam2(xor,__xor__, "xor(a, b) -- Same as a ^ b.")
200spam2(or_,__or__, "or_(a, b) -- Same as a | b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000201spam2(concat,__concat__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000202 "concat(a, b) -- Same as a + b, for a and b sequences.")
Guido van Rossum17202301996-08-19 22:01:39 +0000203spam2(repeat,__repeat__,
Guido van Rossum36a484f1996-12-05 19:01:16 +0000204 "repeat(a, b) -- Return a * b, where a is a sequence, and b is an integer.")
Guido van Rossum17202301996-08-19 22:01:39 +0000205spam2(getitem,__getitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000206 "getitem(a, b) -- Same as a[b].")
Guido van Rossum17202301996-08-19 22:01:39 +0000207spam2(setitem,__setitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000208 "setitem(a, b, c) -- Same as a[b] = c.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000209spam2(delitem,__delitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000210 "delitem(a, b) -- Same as del a[b].")
Raymond Hettinger5959c552002-08-19 03:19:09 +0000211spam2(pow,__pow__, "pow(a, b) -- Same as a**b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000212spam2(getslice,__getslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000213 "getslice(a, b, c) -- Same as a[b:c].")
Guido van Rossum17202301996-08-19 22:01:39 +0000214spam2(setslice,__setslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000215"setslice(a, b, c, d) -- Same as a[b:c] = d.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000216spam2(delslice,__delslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000217"delslice(a, b, c) -- Same as del a[b:c].")
Fred Drake428e75f2001-08-09 20:14:34 +0000218spam2(lt,__lt__, "lt(a, b) -- Same as a<b.")
219spam2(le,__le__, "le(a, b) -- Same as a<=b.")
220spam2(eq,__eq__, "eq(a, b) -- Same as a==b.")
221spam2(ne,__ne__, "ne(a, b) -- Same as a!=b.")
222spam2(gt,__gt__, "gt(a, b) -- Same as a>b.")
223spam2(ge,__ge__, "ge(a, b) -- Same as a>=b.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000224
Guido van Rossum037b9401996-07-30 16:55:54 +0000225 {NULL, NULL} /* sentinel */
226
Guido van Rossum037b9401996-07-30 16:55:54 +0000227};
228
229
230/* Initialization function for the module (*must* be called initoperator) */
231
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000232PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000233initoperator(void)
Guido van Rossum037b9401996-07-30 16:55:54 +0000234{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000235 /* Create the module and add the functions */
Guido van Rossum832f6d21998-05-22 18:12:59 +0000236 Py_InitModule4("operator", operator_methods, operator_doc,
237 (PyObject*)NULL, PYTHON_API_VERSION);
Guido van Rossum037b9401996-07-30 16:55:54 +0000238}