blob: 3b799e5e1cec4a068e59c8524a9ce99ef32d967d [file] [log] [blame]
Guido van Rossum037b9401996-07-30 16:55:54 +00001static char operator_doc[] = "\
2Operator interface.\n\
3\n\
4This module exports a set of functions implemented in C corresponding\n\
5to the intrinsic operators of Python. For example, operator.add(x, y)\n\
6is equivalent to the expression x+y. The function names are those\n\
7used for special class methods; variants without leading and trailing\n\
8'__' are also provided for convenience.\n\
9";
10
11/*
12
13 Copyright
14
15 Copyright 1996 Digital Creations, L.C., 910 Princess Anne
16 Street, Suite 300, Fredericksburg, Virginia 22401 U.S.A. All
17 rights reserved. Copyright in this software is owned by DCLC,
18 unless otherwise indicated. Permission to use, copy and
19 distribute this software is hereby granted, provided that the
20 above copyright notice appear in all copies and that both that
21 copyright notice and this permission notice appear. Note that
22 any product, process or technology described in this software
23 may be the subject of other Intellectual Property rights
24 reserved by Digital Creations, L.C. and are not licensed
25 hereunder.
26
27 Trademarks
28
29 Digital Creations & DCLC, are trademarks of Digital Creations, L.C..
30 All other trademarks are owned by their respective companies.
31
32 No Warranty
33
34 The software is provided "as is" without warranty of any kind,
35 either express or implied, including, but not limited to, the
36 implied warranties of merchantability, fitness for a particular
37 purpose, or non-infringement. This software could include
38 technical inaccuracies or typographical errors. Changes are
39 periodically made to the software; these changes will be
40 incorporated in new editions of the software. DCLC may make
41 improvements and/or changes in this software at any time
42 without notice.
43
44 Limitation Of Liability
45
46 In no event will DCLC be liable for direct, indirect, special,
47 incidental, economic, cover, or consequential damages arising
48 out of the use of or inability to use this software even if
49 advised of the possibility of such damages. Some states do not
50 allow the exclusion or limitation of implied warranties or
51 limitation of liability for incidental or consequential
52 damages, so the above limitation or exclusion may not apply to
53 you.
54
55
56 If you have questions regarding this software,
57 contact:
58
59 Jim Fulton, jim@digicool.com
60 Digital Creations L.C.
61
62 (540) 371-6909
63
64 Modifications
65
66 Renamed and slightly rearranged by Guido van Rossum
67
68*/
69
70#include "Python.h"
71
72#define spam1(OP,AOP) static PyObject *OP(s,a) PyObject *s, *a; { \
73 PyObject *a1; \
74 if(! PyArg_ParseTuple(a,"O",&a1)) return NULL; \
75 return AOP(a1); }
76
77#define spam2(OP,AOP) static PyObject *OP(s,a) PyObject *s, *a; { \
78 PyObject *a1, *a2; \
79 if(! PyArg_ParseTuple(a,"OO",&a1,&a2)) return NULL; \
80 return AOP(a1,a2); }
81
82#define spamoi(OP,AOP) static PyObject *OP(s,a) PyObject *s, *a; { \
83 PyObject *a1; int a2; \
84 if(! PyArg_ParseTuple(a,"Oi",&a1,&a2)) return NULL; \
85 return AOP(a1,a2); }
86
87#define spam2n(OP,AOP) static PyObject *OP(s,a) PyObject *s, *a; { \
88 PyObject *a1, *a2; \
89 if(! PyArg_ParseTuple(a,"OO",&a1,&a2)) return NULL; \
90 if(-1 == AOP(a1,a2)) return NULL; \
91 Py_INCREF(Py_None); \
92 return Py_None; }
93
94#define spam3n(OP,AOP) static PyObject *OP(s,a) PyObject *s, *a; { \
95 PyObject *a1, *a2, *a3; \
96 if(! PyArg_ParseTuple(a,"OOO",&a1,&a2,&a3)) return NULL; \
97 if(-1 == AOP(a1,a2,a3)) return NULL; \
98 Py_INCREF(Py_None); \
99 return Py_None; }
100
101#define spami(OP,AOP) static PyObject *OP(s,a) PyObject *s, *a; { \
102 PyObject *a1; long r; \
103 if(! PyArg_ParseTuple(a,"O",&a1)) return NULL; \
104 if(-1 == (r=AOP(a1))) return NULL; \
105 return PyInt_FromLong(r); }
106
107#define spami2(OP,AOP) static PyObject *OP(s,a) PyObject *s, *a; { \
108 PyObject *a1, *a2; long r; \
109 if(! PyArg_ParseTuple(a,"OO",&a1,&a2)) return NULL; \
110 if(-1 == (r=AOP(a1,a2))) return NULL; \
111 return PyInt_FromLong(r); }
112
Guido van Rossum037b9401996-07-30 16:55:54 +0000113spami(isCallable , PyCallable_Check)
114spami(isNumberType , PyNumber_Check)
115spami(truth , PyObject_IsTrue)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000116spam2(op_add , PyNumber_Add)
117spam2(op_sub , PyNumber_Subtract)
118spam2(op_mul , PyNumber_Multiply)
119spam2(op_div , PyNumber_Divide)
120spam2(op_mod , PyNumber_Remainder)
121spam1(op_neg , PyNumber_Negative)
122spam1(op_pos , PyNumber_Positive)
123spam1(op_abs , PyNumber_Absolute)
124spam1(op_inv , PyNumber_Invert)
125spam2(op_lshift , PyNumber_Lshift)
126spam2(op_rshift , PyNumber_Rshift)
127spam2(op_and_ , PyNumber_And)
128spam2(op_xor , PyNumber_Xor)
129spam2(op_or_ , PyNumber_Or)
Guido van Rossum037b9401996-07-30 16:55:54 +0000130spami(isSequenceType , PySequence_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000131spam2(op_concat , PySequence_Concat)
132spamoi(op_repeat , PySequence_Repeat)
Guido van Rossum037b9401996-07-30 16:55:54 +0000133spami2(sequenceIncludes, PySequence_In)
134spami2(indexOf , PySequence_Index)
135spami2(countOf , PySequence_Count)
136spami(isMappingType , PyMapping_Check)
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000137spam2(op_getitem , PyObject_GetItem)
138spam2n(op_delitem , PyObject_DelItem)
139spam3n(op_setitem , PyObject_SetItem)
Guido van Rossum037b9401996-07-30 16:55:54 +0000140
141static PyObject*
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000142op_getslice(s,a)
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000143 PyObject *s, *a;
Guido van Rossum037b9401996-07-30 16:55:54 +0000144{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000145 PyObject *a1;
146 long a2,a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000147
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000148 if (!PyArg_ParseTuple(a,"Oii",&a1,&a2,&a3))
149 return NULL;
150 return PySequence_GetSlice(a1,a2,a3);
Guido van Rossum037b9401996-07-30 16:55:54 +0000151}
152
153static PyObject*
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000154op_setslice(s,a)
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000155 PyObject *s, *a;
Guido van Rossum037b9401996-07-30 16:55:54 +0000156{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000157 PyObject *a1, *a4;
158 long a2,a3;
Guido van Rossum037b9401996-07-30 16:55:54 +0000159
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000160 if (!PyArg_ParseTuple(a,"OiiO",&a1,&a2,&a3,&a4))
161 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000162
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000163 if (-1 == PySequence_SetSlice(a1,a2,a3,a4))
164 return NULL;
Guido van Rossum037b9401996-07-30 16:55:54 +0000165
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000166 Py_INCREF(Py_None);
167 return Py_None;
Guido van Rossum037b9401996-07-30 16:55:54 +0000168}
169
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000170static PyObject*
171op_delslice(s,a)
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000172 PyObject *s, *a;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000173{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000174 PyObject *a1;
175 long a2,a3;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000176
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000177 if(! PyArg_ParseTuple(a,"Oii",&a1,&a2,&a3))
178 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000179
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000180 if (-1 == PySequence_DelSlice(a1,a2,a3))
181 return NULL;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000182
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000183 Py_INCREF(Py_None);
184 return Py_None;
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000185}
186
Guido van Rossum037b9401996-07-30 16:55:54 +0000187#undef spam1
188#undef spam2
Guido van Rossum17202301996-08-19 22:01:39 +0000189#ifdef HAVE_OLD_CPP
190#define spam1(OP,DOC) {"OP", OP, 1, DOC},
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000191#define spam2(OP,ALTOP,DOC) {"OP", op_/**/OP, 1, DOC}, \
192 {"ALTOP", op_/**/OP, 1, DOC},
Guido van Rossum17202301996-08-19 22:01:39 +0000193#else
194#define spam1(OP,DOC) {#OP, OP, 1, DOC},
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000195#define spam2(OP,ALTOP,DOC) {#OP, op_##OP, 1, DOC}, \
196 {#ALTOP, op_##OP, 1, DOC},
Guido van Rossum17202301996-08-19 22:01:39 +0000197#endif
Guido van Rossum037b9401996-07-30 16:55:54 +0000198
199static struct PyMethodDef operator_methods[] = {
Guido van Rossum037b9401996-07-30 16:55:54 +0000200
Guido van Rossum17202301996-08-19 22:01:39 +0000201spam1(isCallable,
202 "isCallable(o) -- Return 1 if o is callable, and zero otherwise.")
203spam1(isNumberType,
204 "isNumberType(o) -- Return 1 if o has a numeric type, and zero otherwise.")
205spam1(isSequenceType,
206 "isSequenceType(o) -- Return 1 if o has a sequence type, and zero otherwise.")
207spam1(truth,
208 "truth(o) -- Return 1 if o is true, and 0 otherwise.")
209spam1(sequenceIncludes,
210 "sequenceIncludes(a, b) -- Return 1 is a includes b, and 0 otherwise.")
211spam1(indexOf,
212 "indexOf(a, b) -- Return the index of b in a.")
213spam1(countOf,
214 "countOf(a, b) -- Return the number of times b occurs in a.")
215spam1(isMappingType,
216 "isMappingType(o) -- Return 1 if o has a mapping type, and zero otherwise.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000217
Guido van Rossum17202301996-08-19 22:01:39 +0000218spam2(add,__add__, "add(a, b) -- Return a + b, for a and b numbers.")
219spam2(sub,__sub__, "sub(a, b) -- Return a - b.")
220spam2(mul,__mul__, "mul(a, b) -- Return a * b, for a and b numbers.")
221spam2(div,__div__, "div(a, b) -- Return a / b.")
222spam2(mod,__mod__, "mod(a, b) -- Return a % b.")
223spam2(neg,__neg__, "neg(o) -- Return o negated.")
224spam2(pos,__pos__, "pos(o) -- Return o positive.")
225spam2(abs,__abs__, "abs(o) -- Return the absolute value of o.")
226spam2(inv,__inv__, "inv(o) -- Return the inverse of o.")
227spam2(lshift,__lshift__, "lshift(a, b) -- Return a shifted left by b.")
228spam2(rshift,__rshift__, "rshift(a, b) -- Return a shifted right by b.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000229spam2(and_,__and__, "and_(a, b) -- Return the bitwise and of a and b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000230spam2(xor,__xor__, "xor(a, b) -- Return the bitwise exclusive-or of a and b.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000231spam2(or_,__or__, "or_(a, b) -- Return the bitwise or of a and b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000232spam2(concat,__concat__,
233 "concat(a, b) -- Return a + b, for a and b sequences.")
234spam2(repeat,__repeat__,
Guido van Rossum36a484f1996-12-05 19:01:16 +0000235 "repeat(a, b) -- Return a * b, where a is a sequence, and b is an integer.")
Guido van Rossum17202301996-08-19 22:01:39 +0000236spam2(getitem,__getitem__,
237 "getitem(a, b) -- Return the value of a at index b.")
238spam2(setitem,__setitem__,
239 "setitem(a, b, c) -- Set the value of a at b to c.")
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000240spam2(delitem,__delitem__,
241 "delitem(a, b) -- Delete the value of a at b.")
Guido van Rossum17202301996-08-19 22:01:39 +0000242spam2(getslice,__getslice__,
243 "getslice(a, b, c) -- Return the slice of a from b to c-1.")
244spam2(setslice,__setslice__,
Guido van Rossumc9fb47e1996-08-21 17:40:51 +0000245"setslice(a, b, c, v) -- Set the slice of a from b to c-1 to the sequence v.")
246spam2(delslice,__delslice__,
247"delslice(a, b, c) -- Delete the slice of a from b to c-1.")
Guido van Rossum037b9401996-07-30 16:55:54 +0000248
Guido van Rossum037b9401996-07-30 16:55:54 +0000249 {NULL, NULL} /* sentinel */
250
Guido van Rossum037b9401996-07-30 16:55:54 +0000251};
252
253
254/* Initialization function for the module (*must* be called initoperator) */
255
256void
257initoperator()
258{
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000259 PyObject *m, *d;
Guido van Rossum037b9401996-07-30 16:55:54 +0000260
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000261 /* Create the module and add the functions */
262 m = Py_InitModule4("operator", operator_methods,
263 operator_doc,
264 (PyObject*)NULL,PYTHON_API_VERSION);
Guido van Rossum037b9401996-07-30 16:55:54 +0000265
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000266 /* Add some symbolic constants to the module */
267 d = PyModule_GetDict(m);
268 PyDict_SetItemString(d, "__version__",
269 PyString_FromString("$Rev$"));
Guido van Rossum037b9401996-07-30 16:55:54 +0000270
Barry Warsaw19f61ae1996-12-18 19:50:00 +0000271 /* Check for errors */
272 if (PyErr_Occurred())
273 Py_FatalError("can't initialize module operator");
Guido van Rossum037b9401996-07-30 16:55:54 +0000274}