blob: 7638fb80a13cc691a931eb8bc6f20873c317753b [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
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +000013#define spam1(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a1) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000014 return AOP(a1); }
15
Fred Drake5639ba42000-07-08 04:12:08 +000016#define spam2(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000017 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000018 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000019 return AOP(a1,a2); }
20
Fred Drake5639ba42000-07-08 04:12:08 +000021#define spamoi(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000022 PyObject *a1; int a2; \
Fred Drakeea4d3f02000-09-17 16:09:27 +000023 if(! PyArg_ParseTuple(a,"Oi:" #OP,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000024 return AOP(a1,a2); }
25
Fred Drake5639ba42000-07-08 04:12:08 +000026#define spam2n(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000027 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000028 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000029 if(-1 == AOP(a1,a2)) return NULL; \
30 Py_INCREF(Py_None); \
31 return Py_None; }
32
Fred Drake5639ba42000-07-08 04:12:08 +000033#define spam3n(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000034 PyObject *a1, *a2, *a3; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000035 if(! PyArg_UnpackTuple(a,#OP,3,3,&a1,&a2,&a3)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000036 if(-1 == AOP(a1,a2,a3)) return NULL; \
37 Py_INCREF(Py_None); \
38 return Py_None; }
39
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +000040#define spami(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a1) { \
41 long r; \
Guido van Rossum037b9401996-07-30 16:55:54 +000042 if(-1 == (r=AOP(a1))) return NULL; \
Guido van Rossum77f6a652002-04-03 22:41:51 +000043 return PyBool_FromLong(r); }
Guido van Rossum037b9401996-07-30 16:55:54 +000044
Fred Drake5639ba42000-07-08 04:12:08 +000045#define spami2(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
Guido van Rossum037b9401996-07-30 16:55:54 +000046 PyObject *a1, *a2; long r; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000047 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum037b9401996-07-30 16:55:54 +000048 if(-1 == (r=AOP(a1,a2))) return NULL; \
49 return PyInt_FromLong(r); }
50
Guido van Rossum77f6a652002-04-03 22:41:51 +000051#define spami2b(OP,AOP) static PyObject *OP(PyObject *s, PyObject *a) { \
52 PyObject *a1, *a2; long r; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000053 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Guido van Rossum77f6a652002-04-03 22:41:51 +000054 if(-1 == (r=AOP(a1,a2))) return NULL; \
55 return PyBool_FromLong(r); }
56
Fred Drake428e75f2001-08-09 20:14:34 +000057#define spamrc(OP,A) static PyObject *OP(PyObject *s, PyObject *a) { \
58 PyObject *a1, *a2; \
Raymond Hettingerea3fdf42002-12-29 16:33:45 +000059 if(! PyArg_UnpackTuple(a,#OP,2,2,&a1,&a2)) return NULL; \
Fred Drake428e75f2001-08-09 20:14:34 +000060 return PyObject_RichCompare(a1,a2,A); }
61
Guido van Rossum037b9401996-07-30 16:55:54 +000062spami(isCallable , PyCallable_Check)
63spami(isNumberType , PyNumber_Check)
64spami(truth , PyObject_IsTrue)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000065spam2(op_add , PyNumber_Add)
66spam2(op_sub , PyNumber_Subtract)
67spam2(op_mul , PyNumber_Multiply)
68spam2(op_div , PyNumber_Divide)
Fred Drake428e75f2001-08-09 20:14:34 +000069spam2(op_floordiv , PyNumber_FloorDivide)
70spam2(op_truediv , PyNumber_TrueDivide)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000071spam2(op_mod , PyNumber_Remainder)
72spam1(op_neg , PyNumber_Negative)
73spam1(op_pos , PyNumber_Positive)
74spam1(op_abs , PyNumber_Absolute)
75spam1(op_inv , PyNumber_Invert)
Fred Drakeea4d3f02000-09-17 16:09:27 +000076spam1(op_invert , PyNumber_Invert)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000077spam2(op_lshift , PyNumber_Lshift)
78spam2(op_rshift , PyNumber_Rshift)
Guido van Rossum99c185e1998-04-09 17:54:26 +000079spami(op_not_ , PyObject_Not)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000080spam2(op_and_ , PyNumber_And)
81spam2(op_xor , PyNumber_Xor)
82spam2(op_or_ , PyNumber_Or)
Guido van Rossum037b9401996-07-30 16:55:54 +000083spami(isSequenceType , PySequence_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000084spam2(op_concat , PySequence_Concat)
85spamoi(op_repeat , PySequence_Repeat)
Guido van Rossum77f6a652002-04-03 22:41:51 +000086spami2b(op_contains , PySequence_Contains)
87spami2b(sequenceIncludes, PySequence_Contains)
Guido van Rossum037b9401996-07-30 16:55:54 +000088spami2(indexOf , PySequence_Index)
89spami2(countOf , PySequence_Count)
90spami(isMappingType , PyMapping_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +000091spam2(op_getitem , PyObject_GetItem)
92spam2n(op_delitem , PyObject_DelItem)
93spam3n(op_setitem , PyObject_SetItem)
Fred Drake428e75f2001-08-09 20:14:34 +000094spamrc(op_lt , Py_LT)
95spamrc(op_le , Py_LE)
96spamrc(op_eq , Py_EQ)
97spamrc(op_ne , Py_NE)
98spamrc(op_gt , Py_GT)
99spamrc(op_ge , Py_GE)
Guido van Rossum037b9401996-07-30 16:55:54 +0000100
101static PyObject*
Raymond Hettinger5959c552002-08-19 03:19:09 +0000102op_pow(PyObject *s, PyObject *a)
103{
104 PyObject *a1, *a2;
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000105 if (PyArg_UnpackTuple(a,"pow", 2, 2, &a1, &a2))
Raymond Hettinger5959c552002-08-19 03:19:09 +0000106 return PyNumber_Power(a1, a2, Py_None);
107 return NULL;
108}
109
110static PyObject*
Raymond Hettinger9543b342003-01-18 23:22:20 +0000111is_(PyObject *s, PyObject *a)
112{
113 PyObject *a1, *a2, *result = NULL;
114 if (PyArg_UnpackTuple(a,"is_", 2, 2, &a1, &a2)) {
115 result = (a1 == a2) ? Py_True : Py_False;
116 Py_INCREF(result);
117 }
118 return result;
119}
120
121static PyObject*
122is_not(PyObject *s, PyObject *a)
123{
124 PyObject *a1, *a2, *result = NULL;
125 if (PyArg_UnpackTuple(a,"is_not", 2, 2, &a1, &a2)) {
126 result = (a1 != a2) ? Py_True : Py_False;
127 Py_INCREF(result);
128 }
129 return result;
130}
131
132static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000133op_getslice(PyObject *s, PyObject *a)
Guido van Rossum037b9401996-07-30 16:55:54 +0000134{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000135 PyObject *a1;
Guido van Rossum24a49941997-08-28 18:11:05 +0000136 int a2,a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000137
Fred Drakeea4d3f02000-09-17 16:09:27 +0000138 if (!PyArg_ParseTuple(a,"Oii:getslice",&a1,&a2,&a3))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000139 return NULL;
140 return PySequence_GetSlice(a1,a2,a3);
Guido van Rossum037b9401996-07-30 16:55:54 +0000141}
142
143static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000144op_setslice(PyObject *s, PyObject *a)
Guido van Rossum037b9401996-07-30 16:55:54 +0000145{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000146 PyObject *a1, *a4;
Guido van Rossum24a49941997-08-28 18:11:05 +0000147 int a2,a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000148
Fred Drakeea4d3f02000-09-17 16:09:27 +0000149 if (!PyArg_ParseTuple(a,"OiiO:setslice",&a1,&a2,&a3,&a4))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000150 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000151
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000152 if (-1 == PySequence_SetSlice(a1,a2,a3,a4))
153 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000154
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000155 Py_INCREF(Py_None);
156 return Py_None;
Guido van Rossum037b9401996-07-30 16:55:54 +0000157}
158
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000159static PyObject*
Fred Drake5639ba42000-07-08 04:12:08 +0000160op_delslice(PyObject *s, PyObject *a)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000161{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000162 PyObject *a1;
Guido van Rossum24a49941997-08-28 18:11:05 +0000163 int a2,a3;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000164
Fred Drakeea4d3f02000-09-17 16:09:27 +0000165 if(! PyArg_ParseTuple(a,"Oii:delslice",&a1,&a2,&a3))
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000166 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000167
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000168 if (-1 == PySequence_DelSlice(a1,a2,a3))
169 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000170
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000171 Py_INCREF(Py_None);
172 return Py_None;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000173}
174
Guido van Rossum037b9401996-07-30 16:55:54 +0000175#undef spam1
176#undef spam2
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000177#undef spam1o
178#undef spam1o
Neal Norwitz200788c2002-08-13 22:20:41 +0000179#define spam1(OP,DOC) {#OP, OP, METH_VARARGS, PyDoc_STR(DOC)},
Fred Drake5639ba42000-07-08 04:12:08 +0000180#define spam2(OP,ALTOP,DOC) {#OP, op_##OP, METH_VARARGS, DOC}, \
Neal Norwitz200788c2002-08-13 22:20:41 +0000181 {#ALTOP, op_##OP, METH_VARARGS, PyDoc_STR(DOC)},
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000182#define spam1o(OP,DOC) {#OP, OP, METH_O, PyDoc_STR(DOC)},
183#define spam2o(OP,ALTOP,DOC) {#OP, op_##OP, METH_O, DOC}, \
184 {#ALTOP, op_##OP, METH_O, PyDoc_STR(DOC)},
Guido van Rossum037b9401996-07-30 16:55:54 +0000185
186static struct PyMethodDef operator_methods[] = {
Guido van Rossum037b9401996-07-30 16:55:54 +0000187
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000188spam1o(isCallable,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000189 "isCallable(a) -- Same as callable(a).")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000190spam1o(isNumberType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000191 "isNumberType(a) -- Return True if a has a numeric type, False otherwise.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000192spam1o(isSequenceType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000193 "isSequenceType(a) -- Return True if a has a sequence type, False otherwise.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000194spam1o(truth,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000195 "truth(a) -- Return True if a is true, False otherwise.")
Fred Drakeea4d3f02000-09-17 16:09:27 +0000196spam2(contains,__contains__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000197 "contains(a, b) -- Same as b in a (note reversed operands).")
Fred Drakeea4d3f02000-09-17 16:09:27 +0000198spam1(sequenceIncludes,
199 "sequenceIncludes(a, b) -- Same as b in a (note reversed operands; deprecated).")
Guido van Rossum17202301996-08-19 22:01:39 +0000200spam1(indexOf,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000201 "indexOf(a, b) -- Return the first index of b in a.")
Guido van Rossum17202301996-08-19 22:01:39 +0000202spam1(countOf,
203 "countOf(a, b) -- Return the number of times b occurs in a.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000204spam1o(isMappingType,
Guido van Rossum77f6a652002-04-03 22:41:51 +0000205 "isMappingType(a) -- Return True if a has a mapping type, False otherwise.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000206
Raymond Hettinger9543b342003-01-18 23:22:20 +0000207spam1(is_, "is_(a, b) -- Same as a is b.")
208spam1(is_not, "is_not(a, b) -- Same as a is not b.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000209spam2(add,__add__, "add(a, b) -- Same as a + b.")
210spam2(sub,__sub__, "sub(a, b) -- Same as a - b.")
211spam2(mul,__mul__, "mul(a, b) -- Same as a * b.")
Fred Drake428e75f2001-08-09 20:14:34 +0000212spam2(div,__div__, "div(a, b) -- Same as a / b when __future__.division is not in effect.")
213spam2(floordiv,__floordiv__, "floordiv(a, b) -- Same as a // b.")
214spam2(truediv,__truediv__, "truediv(a, b) -- Same as a / b when __future__.division is in effect.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000215spam2(mod,__mod__, "mod(a, b) -- Same as a % b.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000216spam2o(neg,__neg__, "neg(a) -- Same as -a.")
217spam2o(pos,__pos__, "pos(a) -- Same as +a.")
218spam2o(abs,__abs__, "abs(a) -- Same as abs(a).")
219spam2o(inv,__inv__, "inv(a) -- Same as ~a.")
220spam2o(invert,__invert__, "invert(a) -- Same as ~a.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000221spam2(lshift,__lshift__, "lshift(a, b) -- Same as a << b.")
222spam2(rshift,__rshift__, "rshift(a, b) -- Same as a >> b.")
Raymond Hettinger36cd2bf2003-01-03 08:24:58 +0000223spam2o(not_,__not__, "not_(a) -- Same as not a.")
Guido van Rossum832f6d21998-05-22 18:12:59 +0000224spam2(and_,__and__, "and_(a, b) -- Same as a & b.")
225spam2(xor,__xor__, "xor(a, b) -- Same as a ^ b.")
226spam2(or_,__or__, "or_(a, b) -- Same as a | b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000227spam2(concat,__concat__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000228 "concat(a, b) -- Same as a + b, for a and b sequences.")
Guido van Rossum17202301996-08-19 22:01:39 +0000229spam2(repeat,__repeat__,
Guido van Rossum36a484f1996-12-05 19:01:16 +0000230 "repeat(a, b) -- Return a * b, where a is a sequence, and b is an integer.")
Guido van Rossum17202301996-08-19 22:01:39 +0000231spam2(getitem,__getitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000232 "getitem(a, b) -- Same as a[b].")
Guido van Rossum17202301996-08-19 22:01:39 +0000233spam2(setitem,__setitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000234 "setitem(a, b, c) -- Same as a[b] = c.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000235spam2(delitem,__delitem__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000236 "delitem(a, b) -- Same as del a[b].")
Raymond Hettinger5959c552002-08-19 03:19:09 +0000237spam2(pow,__pow__, "pow(a, b) -- Same as a**b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000238spam2(getslice,__getslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000239 "getslice(a, b, c) -- Same as a[b:c].")
Guido van Rossum17202301996-08-19 22:01:39 +0000240spam2(setslice,__setslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000241"setslice(a, b, c, d) -- Same as a[b:c] = d.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000242spam2(delslice,__delslice__,
Guido van Rossum832f6d21998-05-22 18:12:59 +0000243"delslice(a, b, c) -- Same as del a[b:c].")
Fred Drake428e75f2001-08-09 20:14:34 +0000244spam2(lt,__lt__, "lt(a, b) -- Same as a<b.")
245spam2(le,__le__, "le(a, b) -- Same as a<=b.")
246spam2(eq,__eq__, "eq(a, b) -- Same as a==b.")
247spam2(ne,__ne__, "ne(a, b) -- Same as a!=b.")
248spam2(gt,__gt__, "gt(a, b) -- Same as a>b.")
249spam2(ge,__ge__, "ge(a, b) -- Same as a>=b.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000250
Guido van Rossum037b9401996-07-30 16:55:54 +0000251 {NULL, NULL} /* sentinel */
252
Guido van Rossum037b9401996-07-30 16:55:54 +0000253};
254
255
256/* Initialization function for the module (*must* be called initoperator) */
257
Mark Hammondfe51c6d2002-08-02 02:27:13 +0000258PyMODINIT_FUNC
Thomas Woutersf3f33dc2000-07-21 06:00:07 +0000259initoperator(void)
Guido van Rossum037b9401996-07-30 16:55:54 +0000260{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000261 /* Create the module and add the functions */
Guido van Rossum832f6d21998-05-22 18:12:59 +0000262 Py_InitModule4("operator", operator_methods, operator_doc,
263 (PyObject*)NULL, PYTHON_API_VERSION);
Guido van Rossum037b9401996-07-30 16:55:54 +0000264}