This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update to Scalar-List-Utils-1.14
[perl5.git] / ext / List / Util / Util.xs
CommitLineData
f4a2945e
JH
1/* Copyright (c) 1997-2000 Graham Barr <gbarr@pobox.com>. All rights reserved.
2 * This program is free software; you can redistribute it and/or
3 * modify it under the same terms as Perl itself.
4 */
5
6#include <EXTERN.h>
7#include <perl.h>
8#include <XSUB.h>
f4a2945e 9
92731555 10#ifndef PERL_VERSION
97605c51
GB
11# include <patchlevel.h>
12# if !(defined(PERL_VERSION) || (SUBVERSION > 0 && defined(PATCHLEVEL)))
13# include <could_not_find_Perl_patchlevel.h>
14# endif
92731555
DM
15# define PERL_REVISION 5
16# define PERL_VERSION PATCHLEVEL
17# define PERL_SUBVERSION SUBVERSION
18#endif
19
1bfb5477
GB
20#ifndef aTHX
21# define aTHX
9c3c560b
JH
22# define pTHX
23#endif
24
25/* Some platforms have strict exports. And before 5.7.3 cxinc (or Perl_cxinc)
26 was not exported. Therefore platforms like win32, VMS etc have problems
27 so we redefine it here -- GMB
28*/
29#if PERL_VERSION < 7
30/* Not in 5.6.1. */
31# define SvUOK(sv) SvIOK_UV(sv)
32# ifdef cxinc
33# undef cxinc
34# endif
35# define cxinc() my_cxinc(aTHX)
36static I32
37my_cxinc(pTHX)
38{
39 cxstack_max = cxstack_max * 3 / 2;
40 Renew(cxstack, cxstack_max + 1, struct context); /* XXX should fix CXINC macro */
41 return cxstack_ix + 1;
42}
1bfb5477
GB
43#endif
44
45#if PERL_VERSION < 6
46# define NV double
47#endif
48
60f3865b 49#ifdef SVf_IVisUV
b9ae0a2d 50# define slu_sv_value(sv) (SvIOK(sv)) ? (SvIOK_UV(sv)) ? (NV)(SvUVX(sv)) : (NV)(SvIVX(sv)) : (SvNV(sv))
60f3865b 51#else
aaaf1885 52# define slu_sv_value(sv) (SvIOK(sv)) ? (NV)(SvIVX(sv)) : (SvNV(sv))
60f3865b
GB
53#endif
54
1bfb5477
GB
55#ifndef Drand01
56# define Drand01() ((rand() & 0x7FFF) / (double) ((unsigned long)1 << 15))
57#endif
58
92731555 59#if PERL_VERSION < 5
f4a2945e
JH
60# ifndef gv_stashpvn
61# define gv_stashpvn(n,l,c) gv_stashpv(n,c)
62# endif
63# ifndef SvTAINTED
64
65static bool
66sv_tainted(SV *sv)
67{
68 if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv)) {
69 MAGIC *mg = mg_find(sv, 't');
70 if (mg && ((mg->mg_len & 1) || (mg->mg_len & 2) && mg->mg_obj == sv))
71 return TRUE;
72 }
73 return FALSE;
74}
75
76# define SvTAINTED_on(sv) sv_magic((sv), Nullsv, 't', Nullch, 0)
77# define SvTAINTED(sv) (SvMAGICAL(sv) && sv_tainted(sv))
78# endif
79# define PL_defgv defgv
80# define PL_op op
81# define PL_curpad curpad
82# define CALLRUNOPS runops
83# define PL_curpm curpm
84# define PL_sv_undef sv_undef
85# define PERL_CONTEXT struct context
86#endif
92731555 87#if (PERL_VERSION < 5) || (PERL_VERSION == 5 && PERL_SUBVERSION <50)
f4a2945e
JH
88# ifndef PL_tainting
89# define PL_tainting tainting
90# endif
91# ifndef PL_stack_base
92# define PL_stack_base stack_base
93# endif
94# ifndef PL_stack_sp
95# define PL_stack_sp stack_sp
96# endif
97# ifndef PL_ppaddr
98# define PL_ppaddr ppaddr
99# endif
100#endif
101
9e7deb6c
GB
102#ifndef PTR2UV
103# define PTR2UV(ptr) (UV)(ptr)
60f3865b
GB
104#endif
105
f4a2945e
JH
106MODULE=List::Util PACKAGE=List::Util
107
108void
109min(...)
110PROTOTYPE: @
111ALIAS:
112 min = 0
113 max = 1
114CODE:
115{
116 int index;
117 NV retval;
118 SV *retsv;
119 if(!items) {
120 XSRETURN_UNDEF;
121 }
122 retsv = ST(0);
60f3865b 123 retval = slu_sv_value(retsv);
f4a2945e
JH
124 for(index = 1 ; index < items ; index++) {
125 SV *stacksv = ST(index);
60f3865b 126 NV val = slu_sv_value(stacksv);
f4a2945e
JH
127 if(val < retval ? !ix : ix) {
128 retsv = stacksv;
129 retval = val;
130 }
131 }
132 ST(0) = retsv;
133 XSRETURN(1);
134}
135
136
137
138NV
139sum(...)
140PROTOTYPE: @
141CODE:
142{
60f3865b 143 SV *sv;
f4a2945e 144 int index;
f4a2945e
JH
145 if(!items) {
146 XSRETURN_UNDEF;
147 }
60f3865b
GB
148 sv = ST(0);
149 RETVAL = slu_sv_value(sv);
f4a2945e 150 for(index = 1 ; index < items ; index++) {
60f3865b
GB
151 sv = ST(index);
152 RETVAL += slu_sv_value(sv);
f4a2945e
JH
153 }
154}
155OUTPUT:
156 RETVAL
157
158
159void
160minstr(...)
161PROTOTYPE: @
162ALIAS:
163 minstr = 2
164 maxstr = 0
165CODE:
166{
167 SV *left;
168 int index;
169 if(!items) {
170 XSRETURN_UNDEF;
171 }
172 /*
173 sv_cmp & sv_cmp_locale return 1,0,-1 for gt,eq,lt
174 so we set ix to the value we are looking for
175 xsubpp does not allow -ve values, so we start with 0,2 and subtract 1
176 */
177 ix -= 1;
178 left = ST(0);
179#ifdef OPpLOCALE
180 if(MAXARG & OPpLOCALE) {
181 for(index = 1 ; index < items ; index++) {
182 SV *right = ST(index);
183 if(sv_cmp_locale(left, right) == ix)
184 left = right;
185 }
186 }
187 else {
188#endif
189 for(index = 1 ; index < items ; index++) {
190 SV *right = ST(index);
191 if(sv_cmp(left, right) == ix)
192 left = right;
193 }
194#ifdef OPpLOCALE
195 }
196#endif
197 ST(0) = left;
198 XSRETURN(1);
199}
200
201
202
203void
204reduce(block,...)
205 SV * block
206PROTOTYPE: &@
207CODE:
208{
09c2a9b8 209 SV *ret = sv_newmortal();
f4a2945e 210 int index;
f4a2945e
JH
211 GV *agv,*bgv,*gv;
212 HV *stash;
213 CV *cv;
214 OP *reducecop;
1bfb5477
GB
215 PERL_CONTEXT *cx;
216 SV** newsp;
217 I32 gimme = G_SCALAR;
c5661c80 218 U8 hasargs = 0;
1bfb5477
GB
219 bool oldcatch = CATCH_GET;
220
f4a2945e
JH
221 if(items <= 1) {
222 XSRETURN_UNDEF;
223 }
224 agv = gv_fetchpv("a", TRUE, SVt_PV);
225 bgv = gv_fetchpv("b", TRUE, SVt_PV);
226 SAVESPTR(GvSV(agv));
227 SAVESPTR(GvSV(bgv));
09c2a9b8 228 GvSV(agv) = ret;
f4a2945e
JH
229 cv = sv_2cv(block, &stash, &gv, 0);
230 reducecop = CvSTART(cv);
231 SAVESPTR(CvROOT(cv)->op_ppaddr);
232 CvROOT(cv)->op_ppaddr = PL_ppaddr[OP_NULL];
f3548bdc
DM
233#ifdef PAD_SET_CUR
234 PAD_SET_CUR(CvPADLIST(cv),1);
235#else
f4a2945e
JH
236 SAVESPTR(PL_curpad);
237 PL_curpad = AvARRAY((AV*)AvARRAY(CvPADLIST(cv))[1]);
f3548bdc 238#endif
f4a2945e
JH
239 SAVETMPS;
240 SAVESPTR(PL_op);
09c2a9b8 241 SvSetSV(ret, ST(1));
1bfb5477 242 CATCH_SET(TRUE);
60f3865b
GB
243 PUSHBLOCK(cx, CXt_SUB, SP);
244 PUSHSUB(cx);
f4a2945e 245 for(index = 2 ; index < items ; index++) {
f4a2945e
JH
246 GvSV(bgv) = ST(index);
247 PL_op = reducecop;
da53b6b0 248 CALLRUNOPS(aTHX);
09c2a9b8 249 SvSetSV(ret, *PL_stack_sp);
f4a2945e 250 }
09c2a9b8 251 ST(0) = ret;
1bfb5477
GB
252 POPBLOCK(cx,PL_curpm);
253 CATCH_SET(oldcatch);
f4a2945e
JH
254 XSRETURN(1);
255}
256
257void
258first(block,...)
259 SV * block
260PROTOTYPE: &@
261CODE:
262{
f4a2945e 263 int index;
f4a2945e
JH
264 GV *gv;
265 HV *stash;
266 CV *cv;
267 OP *reducecop;
1bfb5477
GB
268 PERL_CONTEXT *cx;
269 SV** newsp;
270 I32 gimme = G_SCALAR;
c5661c80 271 U8 hasargs = 0;
1bfb5477
GB
272 bool oldcatch = CATCH_GET;
273
f4a2945e
JH
274 if(items <= 1) {
275 XSRETURN_UNDEF;
276 }
277 SAVESPTR(GvSV(PL_defgv));
278 cv = sv_2cv(block, &stash, &gv, 0);
279 reducecop = CvSTART(cv);
280 SAVESPTR(CvROOT(cv)->op_ppaddr);
281 CvROOT(cv)->op_ppaddr = PL_ppaddr[OP_NULL];
f3548bdc
DM
282#ifdef PAD_SET_CUR
283 PAD_SET_CUR(CvPADLIST(cv),1);
284#else
f4a2945e
JH
285 SAVESPTR(PL_curpad);
286 PL_curpad = AvARRAY((AV*)AvARRAY(CvPADLIST(cv))[1]);
f3548bdc 287#endif
f4a2945e
JH
288 SAVETMPS;
289 SAVESPTR(PL_op);
1bfb5477 290 CATCH_SET(TRUE);
60f3865b
GB
291 PUSHBLOCK(cx, CXt_SUB, SP);
292 PUSHSUB(cx);
293 if (!CvDEPTH(cv))
294 (void)SvREFCNT_inc(cv);
295
f4a2945e
JH
296 for(index = 1 ; index < items ; index++) {
297 GvSV(PL_defgv) = ST(index);
298 PL_op = reducecop;
da53b6b0 299 CALLRUNOPS(aTHX);
f4a2945e
JH
300 if (SvTRUE(*PL_stack_sp)) {
301 ST(0) = ST(index);
1bfb5477
GB
302 POPBLOCK(cx,PL_curpm);
303 CATCH_SET(oldcatch);
f4a2945e
JH
304 XSRETURN(1);
305 }
306 }
1bfb5477
GB
307 POPBLOCK(cx,PL_curpm);
308 CATCH_SET(oldcatch);
f4a2945e
JH
309 XSRETURN_UNDEF;
310}
311
1bfb5477
GB
312void
313shuffle(...)
314PROTOTYPE: @
315CODE:
316{
317 int index;
318 struct op dmy_op;
319 struct op *old_op = PL_op;
1bfb5477 320
c29e891d
GB
321 /* We call pp_rand here so that Drand01 get initialized if rand()
322 or srand() has not already been called
323 */
1bfb5477 324 memzero((char*)(&dmy_op), sizeof(struct op));
f3548bdc
DM
325 /* we let pp_rand() borrow the TARG allocated for this XS sub */
326 dmy_op.op_targ = PL_op->op_targ;
1bfb5477 327 PL_op = &dmy_op;
20d72259 328 (void)*(PL_ppaddr[OP_RAND])(aTHX);
1bfb5477 329 PL_op = old_op;
1bfb5477
GB
330 for (index = items ; index > 1 ; ) {
331 int swap = (int)(Drand01() * (double)(index--));
332 SV *tmp = ST(swap);
333 ST(swap) = ST(index);
334 ST(index) = tmp;
335 }
336 XSRETURN(items);
337}
338
339
f4a2945e
JH
340MODULE=List::Util PACKAGE=Scalar::Util
341
342void
343dualvar(num,str)
344 SV * num
345 SV * str
346PROTOTYPE: $$
347CODE:
348{
349 STRLEN len;
350 char *ptr = SvPV(str,len);
351 ST(0) = sv_newmortal();
9c5ffd7c 352 (void)SvUPGRADE(ST(0),SVt_PVNV);
f4a2945e 353 sv_setpvn(ST(0),ptr,len);
1bfb5477 354 if(SvNOK(num) || SvPOK(num) || SvMAGICAL(num)) {
f4a2945e
JH
355 SvNVX(ST(0)) = SvNV(num);
356 SvNOK_on(ST(0));
357 }
1bfb5477
GB
358#ifdef SVf_IVisUV
359 else if (SvUOK(num)) {
360 SvUVX(ST(0)) = SvUV(num);
361 SvIOK_on(ST(0));
362 SvIsUV_on(ST(0));
363 }
364#endif
f4a2945e
JH
365 else {
366 SvIVX(ST(0)) = SvIV(num);
367 SvIOK_on(ST(0));
368 }
369 if(PL_tainting && (SvTAINTED(num) || SvTAINTED(str)))
370 SvTAINTED_on(ST(0));
371 XSRETURN(1);
372}
373
374char *
375blessed(sv)
376 SV * sv
377PROTOTYPE: $
378CODE:
379{
380 if (SvMAGICAL(sv))
381 mg_get(sv);
382 if(!sv_isobject(sv)) {
383 XSRETURN_UNDEF;
384 }
385 RETVAL = sv_reftype(SvRV(sv),TRUE);
386}
387OUTPUT:
388 RETVAL
389
390char *
391reftype(sv)
392 SV * sv
393PROTOTYPE: $
394CODE:
395{
396 if (SvMAGICAL(sv))
397 mg_get(sv);
398 if(!SvROK(sv)) {
399 XSRETURN_UNDEF;
400 }
401 RETVAL = sv_reftype(SvRV(sv),FALSE);
402}
403OUTPUT:
404 RETVAL
405
bd1e762a 406UV
60f3865b
GB
407refaddr(sv)
408 SV * sv
409PROTOTYPE: $
410CODE:
411{
4579700c
MHM
412 if (SvMAGICAL(sv))
413 mg_get(sv);
60f3865b
GB
414 if(!SvROK(sv)) {
415 XSRETURN_UNDEF;
416 }
bd1e762a 417 RETVAL = PTR2UV(SvRV(sv));
60f3865b
GB
418}
419OUTPUT:
420 RETVAL
421
f4a2945e
JH
422void
423weaken(sv)
424 SV *sv
425PROTOTYPE: $
426CODE:
427#ifdef SvWEAKREF
428 sv_rvweaken(sv);
429#else
430 croak("weak references are not implemented in this release of perl");
431#endif
432
c6c619a9 433void
f4a2945e
JH
434isweak(sv)
435 SV *sv
436PROTOTYPE: $
437CODE:
438#ifdef SvWEAKREF
439 ST(0) = boolSV(SvROK(sv) && SvWEAKREF(sv));
440 XSRETURN(1);
441#else
442 croak("weak references are not implemented in this release of perl");
443#endif
444
445int
446readonly(sv)
447 SV *sv
448PROTOTYPE: $
449CODE:
450 RETVAL = SvREADONLY(sv);
451OUTPUT:
452 RETVAL
453
454int
455tainted(sv)
456 SV *sv
457PROTOTYPE: $
458CODE:
459 RETVAL = SvTAINTED(sv);
460OUTPUT:
461 RETVAL
462
60f3865b
GB
463void
464isvstring(sv)
465 SV *sv
466PROTOTYPE: $
467CODE:
468#ifdef SvVOK
469 ST(0) = boolSV(SvVOK(sv));
470 XSRETURN(1);
471#else
472 croak("vstrings are not implemented in this release of perl");
473#endif
474
9e7deb6c
GB
475int
476looks_like_number(sv)
477 SV *sv
478PROTOTYPE: $
479CODE:
480 RETVAL = looks_like_number(sv);
481OUTPUT:
482 RETVAL
483
c5661c80 484void
97605c51
GB
485set_prototype(subref, proto)
486 SV *subref
487 SV *proto
488PROTOTYPE: &$
489CODE:
490{
491 if (SvROK(subref)) {
492 SV *sv = SvRV(subref);
493 if (SvTYPE(sv) != SVt_PVCV) {
494 /* not a subroutine reference */
495 croak("set_prototype: not a subroutine reference");
496 }
497 if (SvPOK(proto)) {
498 /* set the prototype */
499 STRLEN len;
500 char *ptr = SvPV(proto, len);
501 sv_setpvn(sv, ptr, len);
502 }
503 else {
504 /* delete the prototype */
505 SvPOK_off(sv);
506 }
507 }
508 else {
509 croak("set_prototype: not a reference");
510 }
511 XSRETURN(1);
512}
60f3865b 513
f4a2945e
JH
514BOOT:
515{
60f3865b 516#if !defined(SvWEAKREF) || !defined(SvVOK)
f4a2945e
JH
517 HV *stash = gv_stashpvn("Scalar::Util", 12, TRUE);
518 GV *vargv = *(GV**)hv_fetch(stash, "EXPORT_FAIL", 11, TRUE);
519 AV *varav;
520 if (SvTYPE(vargv) != SVt_PVGV)
521 gv_init(vargv, stash, "Scalar::Util", 12, TRUE);
522 varav = GvAVn(vargv);
60f3865b
GB
523#endif
524#ifndef SvWEAKREF
f4a2945e
JH
525 av_push(varav, newSVpv("weaken",6));
526 av_push(varav, newSVpv("isweak",6));
527#endif
60f3865b
GB
528#ifndef SvVOK
529 av_push(varav, newSVpv("isvstring",9));
530#endif
f4a2945e 531}