handy.h: Add some comments
[perl.git] / vutil.c
1 /* This file is part of the "version" CPAN distribution.  Please avoid
2    editing it in the perl core. */
3
4 #ifdef PERL_CORE
5 #  include "vutil.h"
6 #endif
7
8 #define VERSION_MAX 0x7FFFFFFF
9
10 /*
11 =for apidoc prescan_version
12
13 Validate that a given string can be parsed as a version object, but doesn't
14 actually perform the parsing.  Can use either strict or lax validation rules.
15 Can optionally set a number of hint variables to save the parsing code
16 some time when tokenizing.
17
18 =cut
19 */
20 const char *
21 #ifdef VUTIL_REPLACE_CORE
22 Perl_prescan_version2(pTHX_ const char *s, bool strict,
23 #else
24 Perl_prescan_version(pTHX_ const char *s, bool strict,
25 #endif
26                      const char **errstr,
27                      bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) {
28     bool qv = (sqv ? *sqv : FALSE);
29     int width = 3;
30     int saw_decimal = 0;
31     bool alpha = FALSE;
32     const char *d = s;
33
34     PERL_ARGS_ASSERT_PRESCAN_VERSION;
35     PERL_UNUSED_CONTEXT;
36
37     if (qv && isDIGIT(*d))
38         goto dotted_decimal_version;
39
40     if (*d == 'v') { /* explicit v-string */
41         d++;
42         if (isDIGIT(*d)) {
43             qv = TRUE;
44         }
45         else { /* degenerate v-string */
46             /* requires v1.2.3 */
47             BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
48         }
49
50 dotted_decimal_version:
51         if (strict && d[0] == '0' && isDIGIT(d[1])) {
52             /* no leading zeros allowed */
53             BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
54         }
55
56         while (isDIGIT(*d))     /* integer part */
57             d++;
58
59         if (*d == '.')
60         {
61             saw_decimal++;
62             d++;                /* decimal point */
63         }
64         else
65         {
66             if (strict) {
67                 /* require v1.2.3 */
68                 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
69             }
70             else {
71                 goto version_prescan_finish;
72             }
73         }
74
75         {
76             int i = 0;
77             int j = 0;
78             while (isDIGIT(*d)) {       /* just keep reading */
79                 i++;
80                 while (isDIGIT(*d)) {
81                     d++; j++;
82                     /* maximum 3 digits between decimal */
83                     if (strict && j > 3) {
84                         BADVERSION(s,errstr,"Invalid version format (maximum 3 digits between decimals)");
85                     }
86                 }
87                 if (*d == '_') {
88                     if (strict) {
89                         BADVERSION(s,errstr,"Invalid version format (no underscores)");
90                     }
91                     if ( alpha ) {
92                         BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
93                     }
94                     d++;
95                     alpha = TRUE;
96                 }
97                 else if (*d == '.') {
98                     if (alpha) {
99                         BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
100                     }
101                     saw_decimal++;
102                     d++;
103                 }
104                 else if (!isDIGIT(*d)) {
105                     break;
106                 }
107                 j = 0;
108             }
109
110             if (strict && i < 2) {
111                 /* requires v1.2.3 */
112                 BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions require at least three parts)");
113             }
114         }
115     }                                   /* end if dotted-decimal */
116     else
117     {                                   /* decimal versions */
118         int j = 0;                      /* may need this later */
119         /* special strict case for leading '.' or '0' */
120         if (strict) {
121             if (*d == '.') {
122                 BADVERSION(s,errstr,"Invalid version format (0 before decimal required)");
123             }
124             if (*d == '0' && isDIGIT(d[1])) {
125                 BADVERSION(s,errstr,"Invalid version format (no leading zeros)");
126             }
127         }
128
129         /* and we never support negative versions */
130         if ( *d == '-') {
131             BADVERSION(s,errstr,"Invalid version format (negative version number)");
132         }
133
134         /* consume all of the integer part */
135         while (isDIGIT(*d))
136             d++;
137
138         /* look for a fractional part */
139         if (*d == '.') {
140             /* we found it, so consume it */
141             saw_decimal++;
142             d++;
143         }
144         else if (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') {
145             if ( d == s ) {
146                 /* found nothing */
147                 BADVERSION(s,errstr,"Invalid version format (version required)");
148             }
149             /* found just an integer */
150             goto version_prescan_finish;
151         }
152         else if ( d == s ) {
153             /* didn't find either integer or period */
154             BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
155         }
156         else if (*d == '_') {
157             /* underscore can't come after integer part */
158             if (strict) {
159                 BADVERSION(s,errstr,"Invalid version format (no underscores)");
160             }
161             else if (isDIGIT(d[1])) {
162                 BADVERSION(s,errstr,"Invalid version format (alpha without decimal)");
163             }
164             else {
165                 BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
166             }
167         }
168         else {
169             /* anything else after integer part is just invalid data */
170             BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
171         }
172
173         /* scan the fractional part after the decimal point*/
174
175         if (!isDIGIT(*d) && (strict || ! (!*d || *d == ';' || isSPACE(*d) || *d == '{' || *d == '}') )) {
176                 /* strict or lax-but-not-the-end */
177                 BADVERSION(s,errstr,"Invalid version format (fractional part required)");
178         }
179
180         while (isDIGIT(*d)) {
181             d++; j++;
182             if (*d == '.' && isDIGIT(d[-1])) {
183                 if (alpha) {
184                     BADVERSION(s,errstr,"Invalid version format (underscores before decimal)");
185                 }
186                 if (strict) {
187                     BADVERSION(s,errstr,"Invalid version format (dotted-decimal versions must begin with 'v')");
188                 }
189                 d = (char *)s;          /* start all over again */
190                 qv = TRUE;
191                 goto dotted_decimal_version;
192             }
193             if (*d == '_') {
194                 if (strict) {
195                     BADVERSION(s,errstr,"Invalid version format (no underscores)");
196                 }
197                 if ( alpha ) {
198                     BADVERSION(s,errstr,"Invalid version format (multiple underscores)");
199                 }
200                 if ( ! isDIGIT(d[1]) ) {
201                     BADVERSION(s,errstr,"Invalid version format (misplaced underscore)");
202                 }
203                 width = j;
204                 d++;
205                 alpha = TRUE;
206             }
207         }
208     }
209
210 version_prescan_finish:
211     while (isSPACE(*d))
212         d++;
213
214     if (!isDIGIT(*d) && (! (!*d || *d == ';' || *d == '{' || *d == '}') )) {
215         /* trailing non-numeric data */
216         BADVERSION(s,errstr,"Invalid version format (non-numeric data)");
217     }
218     if (saw_decimal > 1 && d[-1] == '.') {
219         /* no trailing period allowed */
220         BADVERSION(s,errstr,"Invalid version format (trailing decimal)");
221     }
222
223
224     if (sqv)
225         *sqv = qv;
226     if (swidth)
227         *swidth = width;
228     if (ssaw_decimal)
229         *ssaw_decimal = saw_decimal;
230     if (salpha)
231         *salpha = alpha;
232     return d;
233 }
234
235 /*
236 =for apidoc scan_version
237
238 Returns a pointer to the next character after the parsed
239 version string, as well as upgrading the passed in SV to
240 an RV.
241
242 Function must be called with an already existing SV like
243
244     sv = newSV(0);
245     s = scan_version(s, SV *sv, bool qv);
246
247 Performs some preprocessing to the string to ensure that
248 it has the correct characteristics of a version.  Flags the
249 object if it contains an underscore (which denotes this
250 is an alpha version).  The boolean qv denotes that the version
251 should be interpreted as if it had multiple decimals, even if
252 it doesn't.
253
254 =cut
255 */
256
257 const char *
258 #ifdef VUTIL_REPLACE_CORE
259 Perl_scan_version2(pTHX_ const char *s, SV *rv, bool qv)
260 #else
261 Perl_scan_version(pTHX_ const char *s, SV *rv, bool qv)
262 #endif
263 {
264     const char *start = s;
265     const char *pos;
266     const char *last;
267     const char *errstr = NULL;
268     int saw_decimal = 0;
269     int width = 3;
270     bool alpha = FALSE;
271     bool vinf = FALSE;
272     AV * av;
273     SV * hv;
274
275     PERL_ARGS_ASSERT_SCAN_VERSION;
276
277     while (isSPACE(*s)) /* leading whitespace is OK */
278         s++;
279
280     last = PRESCAN_VERSION(s, FALSE, &errstr, &qv, &saw_decimal, &width, &alpha);
281     if (errstr) {
282         /* "undef" is a special case and not an error */
283         if ( ! ( *s == 'u' && strEQ(s+1,"ndef")) ) {
284             Perl_croak(aTHX_ "%s", errstr);
285         }
286     }
287
288     start = s;
289     if (*s == 'v')
290         s++;
291     pos = s;
292
293     /* Now that we are through the prescan, start creating the object */
294     av = newAV();
295     hv = newSVrv(rv, "version"); /* create an SV and upgrade the RV */
296     (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
297
298 #ifndef NODEFAULT_SHAREKEYS
299     HvSHAREKEYS_on(hv);         /* key-sharing on by default */
300 #endif
301
302     if ( qv )
303         (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(qv));
304     if ( alpha )
305         (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(alpha));
306     if ( !qv && width < 3 )
307         (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
308
309     while (isDIGIT(*pos) || *pos == '_')
310         pos++;
311     if (!isALPHA(*pos)) {
312         I32 rev;
313
314         for (;;) {
315             rev = 0;
316             {
317                 /* this is atoi() that delimits on underscores */
318                 const char *end = pos;
319                 I32 mult = 1;
320                 I32 orev;
321
322                 /* the following if() will only be true after the decimal
323                  * point of a version originally created with a bare
324                  * floating point number, i.e. not quoted in any way
325                  */
326                 if ( !qv && s > start && saw_decimal == 1 ) {
327                     mult *= 100;
328                     while ( s < end ) {
329                         if (*s == '_')
330                             continue;
331                         orev = rev;
332                         rev += (*s - '0') * mult;
333                         mult /= 10;
334                         if (   (PERL_ABS(orev) > PERL_ABS(rev)) 
335                             || (PERL_ABS(rev) > VERSION_MAX )) {
336                             Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW), 
337                                            "Integer overflow in version %d",VERSION_MAX);
338                             s = end - 1;
339                             rev = VERSION_MAX;
340                             vinf = 1;
341                         }
342                         s++;
343                         if ( *s == '_' )
344                             s++;
345                     }
346                 }
347                 else {
348                     while (--end >= s) {
349                         int i;
350                         if (*end == '_')
351                             continue;
352                         i = (*end - '0');
353                         if (   (mult == VERSION_MAX)
354                             || (i > VERSION_MAX / mult)
355                             || (i * mult > VERSION_MAX - rev))
356                         {
357                             Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW), 
358                                            "Integer overflow in version");
359                             end = s - 1;
360                             rev = VERSION_MAX;
361                             vinf = 1;
362                         }
363                         else
364                             rev += i * mult;
365
366                         if (mult > VERSION_MAX / 10)
367                             mult = VERSION_MAX;
368                         else
369                             mult *= 10;
370                     }
371                 } 
372             }
373
374             /* Append revision */
375             av_push(av, newSViv(rev));
376             if ( vinf ) {
377                 s = last;
378                 break;
379             }
380             else if ( *pos == '.' ) {
381                 pos++;
382                 if (qv) {
383                     while (*pos == '0')
384                         ++pos;
385                 }
386                 s = pos;
387             }
388             else if ( *pos == '_' && isDIGIT(pos[1]) )
389                 s = ++pos;
390             else if ( *pos == ',' && isDIGIT(pos[1]) )
391                 s = ++pos;
392             else if ( isDIGIT(*pos) )
393                 s = pos;
394             else {
395                 s = pos;
396                 break;
397             }
398             if ( qv ) {
399                 while ( isDIGIT(*pos) || *pos == '_')
400                     pos++;
401             }
402             else {
403                 int digits = 0;
404                 while ( ( isDIGIT(*pos) || *pos == '_' ) && digits < 3 ) {
405                     if ( *pos != '_' )
406                         digits++;
407                     pos++;
408                 }
409             }
410         }
411     }
412     if ( qv ) { /* quoted versions always get at least three terms*/
413         SSize_t len = AvFILLp(av);
414         /* This for loop appears to trigger a compiler bug on OS X, as it
415            loops infinitely. Yes, len is negative. No, it makes no sense.
416            Compiler in question is:
417            gcc version 3.3 20030304 (Apple Computer, Inc. build 1640)
418            for ( len = 2 - len; len > 0; len-- )
419            av_push(MUTABLE_AV(sv), newSViv(0));
420         */
421         len = 2 - len;
422         while (len-- > 0)
423             av_push(av, newSViv(0));
424     }
425
426     /* need to save off the current version string for later */
427     if ( vinf ) {
428         SV * orig = newSVpvn("v.Inf", sizeof("v.Inf")-1);
429         (void)hv_stores(MUTABLE_HV(hv), "original", orig);
430         (void)hv_stores(MUTABLE_HV(hv), "vinf", newSViv(1));
431     }
432     else if ( s > start ) {
433         SV * orig = newSVpvn(start,s-start);
434         if ( qv && saw_decimal == 1 && *start != 'v' ) {
435             /* need to insert a v to be consistent */
436             sv_insert(orig, 0, 0, "v", 1);
437         }
438         (void)hv_stores(MUTABLE_HV(hv), "original", orig);
439     }
440     else {
441         (void)hv_stores(MUTABLE_HV(hv), "original", newSVpvs("0"));
442         av_push(av, newSViv(0));
443     }
444
445     /* And finally, store the AV in the hash */
446     (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
447
448     /* fix RT#19517 - special case 'undef' as string */
449     if ( *s == 'u' && strEQ(s+1,"ndef") ) {
450         s += 5;
451     }
452
453     return s;
454 }
455
456 /*
457 =for apidoc new_version
458
459 Returns a new version object based on the passed in SV:
460
461     SV *sv = new_version(SV *ver);
462
463 Does not alter the passed in ver SV.  See "upg_version" if you
464 want to upgrade the SV.
465
466 =cut
467 */
468
469 SV *
470 #ifdef VUTIL_REPLACE_CORE
471 Perl_new_version2(pTHX_ SV *ver)
472 #else
473 Perl_new_version(pTHX_ SV *ver)
474 #endif
475 {
476     SV * const rv = newSV(0);
477     PERL_ARGS_ASSERT_NEW_VERSION;
478     if ( ISA_VERSION_OBJ(ver) ) /* can just copy directly */
479     {
480         SSize_t key;
481         AV * const av = newAV();
482         AV *sav;
483         /* This will get reblessed later if a derived class*/
484         SV * const hv = newSVrv(rv, "version"); 
485         (void)sv_upgrade(hv, SVt_PVHV); /* needs to be an HV type */
486 #ifndef NODEFAULT_SHAREKEYS
487         HvSHAREKEYS_on(hv);         /* key-sharing on by default */
488 #endif
489
490         if ( SvROK(ver) )
491             ver = SvRV(ver);
492
493         /* Begin copying all of the elements */
494         if ( hv_exists(MUTABLE_HV(ver), "qv", 2) )
495             (void)hv_stores(MUTABLE_HV(hv), "qv", newSViv(1));
496
497         if ( hv_exists(MUTABLE_HV(ver), "alpha", 5) )
498             (void)hv_stores(MUTABLE_HV(hv), "alpha", newSViv(1));
499         {
500             SV ** svp = hv_fetchs(MUTABLE_HV(ver), "width", FALSE);
501             if(svp) {
502                 const I32 width = SvIV(*svp);
503                 (void)hv_stores(MUTABLE_HV(hv), "width", newSViv(width));
504             }
505         }
506         {
507             SV ** svp = hv_fetchs(MUTABLE_HV(ver), "original", FALSE);
508             if(svp)
509                 (void)hv_stores(MUTABLE_HV(hv), "original", newSVsv(*svp));
510         }
511         sav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(ver), "version", FALSE)));
512         /* This will get reblessed later if a derived class*/
513         for ( key = 0; key <= av_len(sav); key++ )
514         {
515             SV * const sv = *av_fetch(sav, key, FALSE);
516             const I32 rev = SvIV(sv);
517             av_push(av, newSViv(rev));
518         }
519
520         (void)hv_stores(MUTABLE_HV(hv), "version", newRV_noinc(MUTABLE_SV(av)));
521         return rv;
522     }
523 #ifdef SvVOK
524     {
525         const MAGIC* const mg = SvVSTRING_mg(ver);
526         if ( mg ) { /* already a v-string */
527             const STRLEN len = mg->mg_len;
528             const char * const version = (const char*)mg->mg_ptr;
529             char *raw, *under;
530             static const char underscore[] = "_";
531             sv_setpvn(rv,version,len);
532             raw = SvPV_nolen(rv);
533             under = ninstr(raw, raw+len, underscore, underscore + 1);
534             if (under) {
535                 Move(under + 1, under, raw + len - under - 1, char);
536                 SvCUR(rv)--;
537                 *SvEND(rv) = '\0';
538             }
539             /* this is for consistency with the pure Perl class */
540             if ( isDIGIT(*version) )
541                 sv_insert(rv, 0, 0, "v", 1);
542         }
543         else {
544 #endif
545         SvSetSV_nosteal(rv, ver); /* make a duplicate */
546 #ifdef SvVOK
547         }
548     }
549 #endif
550     sv_2mortal(rv); /* in case upg_version croaks before it returns */
551     return SvREFCNT_inc_NN(UPG_VERSION(rv, FALSE));
552 }
553
554 /*
555 =for apidoc upg_version
556
557 In-place upgrade of the supplied SV to a version object.
558
559     SV *sv = upg_version(SV *sv, bool qv);
560
561 Returns a pointer to the upgraded SV.  Set the boolean qv if you want
562 to force this SV to be interpreted as an "extended" version.
563
564 =cut
565 */
566
567 SV *
568 #ifdef VUTIL_REPLACE_CORE
569 Perl_upg_version2(pTHX_ SV *ver, bool qv)
570 #else
571 Perl_upg_version(pTHX_ SV *ver, bool qv)
572 #endif
573 {
574     const char *version, *s;
575 #ifdef SvVOK
576     const MAGIC *mg;
577 #endif
578
579 #if PERL_VERSION_LT(5,19,8) && defined(USE_ITHREADS)
580     ENTER;
581 #endif
582     PERL_ARGS_ASSERT_UPG_VERSION;
583
584     if ( (SvUOK(ver) && SvUVX(ver) > VERSION_MAX)
585            || (SvIOK(ver) && SvIVX(ver) > VERSION_MAX) ) {
586         /* out of bounds [unsigned] integer */
587         STRLEN len;
588         char tbuf[64];
589         len = my_snprintf(tbuf, sizeof(tbuf), "%d", VERSION_MAX);
590         version = savepvn(tbuf, len);
591         SAVEFREEPV(version);
592         Perl_ck_warner(aTHX_ packWARN(WARN_OVERFLOW),
593                        "Integer overflow in version %d",VERSION_MAX);
594     }
595     else if ( SvUOK(ver) || SvIOK(ver))
596 #if PERL_VERSION_LT(5,17,2)
597 VER_IV:
598 #endif
599     {
600         version = savesvpv(ver);
601         SAVEFREEPV(version);
602     }
603     else if (SvNOK(ver) && !( SvPOK(ver) && SvCUR(ver) == 3 ) )
604 #if PERL_VERSION_LT(5,17,2)
605 VER_NV:
606 #endif
607     {
608         STRLEN len;
609
610         /* may get too much accuracy */ 
611         char tbuf[64];
612         SV *sv = SvNVX(ver) > 10e50 ? newSV(64) : 0;
613         char *buf;
614
615 #if PERL_VERSION_GE(5,19,0)
616         if (SvPOK(ver)) {
617             /* dualvar? */
618             goto VER_PV;
619         }
620 #endif
621 #ifdef USE_LOCALE_NUMERIC
622
623         {
624             /* This may or may not be called from code that has switched
625              * locales without letting perl know, therefore we have to find it
626              * from first principals.  See [perl #121930]. */
627
628             /* In windows, or not threaded, or not thread-safe, if it isn't C,
629              * set it to C. */
630
631 #  ifndef USE_POSIX_2008_LOCALE
632
633             const char * locale_name_on_entry;
634
635             LC_NUMERIC_LOCK(0);    /* Start critical section */
636
637             locale_name_on_entry = setlocale(LC_NUMERIC, NULL);
638             if (   strNE(locale_name_on_entry, "C")
639                 && strNE(locale_name_on_entry, "POSIX"))
640             {
641                 setlocale(LC_NUMERIC, "C");
642             }
643             else {  /* This value indicates to the restore code that we didn't
644                        change the locale */
645                 locale_name_on_entry = NULL;
646             }
647
648 # else
649
650             const locale_t locale_obj_on_entry = uselocale((locale_t) 0);
651             const char * locale_name_on_entry = NULL;
652             DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
653
654             if (locale_obj_on_entry == LC_GLOBAL_LOCALE) {
655
656                 /* in the global locale, we can call system setlocale and if it
657                  * isn't C, set it to C. */
658                 LC_NUMERIC_LOCK(0);
659
660                 locale_name_on_entry = setlocale(LC_NUMERIC, NULL);
661                 if (   strNE(locale_name_on_entry, "C")
662                     && strNE(locale_name_on_entry, "POSIX"))
663                 {
664                     setlocale(LC_NUMERIC, "C");
665                 }
666                 else {  /* This value indicates to the restore code that we
667                            didn't change the locale */
668                     locale_name_on_entry = NULL;
669             }
670         }
671             else if (locale_obj_on_entry == PL_underlying_numeric_obj) {
672                 /* Here, the locale appears to have been changed to use the
673                  * program's underlying locale.  Just use our mechanisms to
674                  * switch back to C.   It might be possible for this pointer to
675                  * actually refer to something else if it got released and
676                  * reused somehow.  But it doesn't matter, our mechanisms will
677                  * work even so */
678                 STORE_LC_NUMERIC_SET_STANDARD();
679             }
680             else if (locale_obj_on_entry != PL_C_locale_obj) {
681                 /* The C object should be unchanged during a program's
682                  * execution, so it should be safe to assume it means what it
683                  * says, so if we are in it, no locale change is required.
684                  * Otherwise, simply use the thread-safe operation. */
685                 uselocale(PL_C_locale_obj);
686             }
687
688 # endif
689
690             /* Prevent recursed calls from trying to change back */
691             LOCK_LC_NUMERIC_STANDARD();
692
693 #endif
694
695         if (sv) {
696                 Perl_sv_catpvf(aTHX_ sv, "%.9" NVff, SvNVX(ver));
697             len = SvCUR(sv);
698             buf = SvPVX(sv);
699         }
700         else {
701                 len = my_snprintf(tbuf, sizeof(tbuf), "%.9" NVff, SvNVX(ver));
702             buf = tbuf;
703         }
704
705 #ifdef USE_LOCALE_NUMERIC
706
707             UNLOCK_LC_NUMERIC_STANDARD();
708
709 #  ifndef USE_POSIX_2008_LOCALE
710
711             if (locale_name_on_entry) {
712                 setlocale(LC_NUMERIC, locale_name_on_entry);
713             }
714
715             LC_NUMERIC_UNLOCK;  /* End critical section */
716
717 #  else
718
719             if (locale_name_on_entry) {
720                 setlocale(LC_NUMERIC, locale_name_on_entry);
721                 LC_NUMERIC_UNLOCK;
722             }
723             else if (locale_obj_on_entry == PL_underlying_numeric_obj) {
724                 RESTORE_LC_NUMERIC();
725             }
726             else if (locale_obj_on_entry != PL_C_locale_obj) {
727                 uselocale(locale_obj_on_entry);
728         }
729
730 #  endif
731
732         }
733
734 #endif  /* USE_LOCALE_NUMERIC */
735
736         while (buf[len-1] == '0' && len > 0) len--;
737         if ( buf[len-1] == '.' ) len--; /* eat the trailing decimal */
738         version = savepvn(buf, len);
739         SAVEFREEPV(version);
740         SvREFCNT_dec(sv);
741     }
742 #ifdef SvVOK
743     else if ( (mg = SvVSTRING_mg(ver)) ) { /* already a v-string */
744         version = savepvn( (const char*)mg->mg_ptr,mg->mg_len );
745         SAVEFREEPV(version);
746         qv = TRUE;
747     }
748 #endif
749     else if ( SvPOK(ver))/* must be a string or something like a string */
750 VER_PV:
751     {
752         STRLEN len;
753         version = savepvn(SvPV(ver,len), SvCUR(ver));
754         SAVEFREEPV(version);
755 #ifndef SvVOK
756 #  if PERL_VERSION > 5
757         /* This will only be executed for 5.6.0 - 5.8.0 inclusive */
758         if ( len >= 3 && !instr(version,".") && !instr(version,"_")) {
759             /* may be a v-string */
760             char *testv = (char *)version;
761             STRLEN tlen = len;
762             for (tlen=0; tlen < len; tlen++, testv++) {
763                 /* if one of the characters is non-text assume v-string */
764                 if (testv[0] < ' ') {
765                     SV * const nsv = sv_newmortal();
766                     const char *nver;
767                     const char *pos;
768                     int saw_decimal = 0;
769                     sv_setpvf(nsv,"v%vd",ver);
770                     pos = nver = savepv(SvPV_nolen(nsv));
771                     SAVEFREEPV(pos);
772
773                     /* scan the resulting formatted string */
774                     pos++; /* skip the leading 'v' */
775                     while ( *pos == '.' || isDIGIT(*pos) ) {
776                         if ( *pos == '.' )
777                             saw_decimal++ ;
778                         pos++;
779                     }
780
781                     /* is definitely a v-string */
782                     if ( saw_decimal >= 2 ) {
783                         version = nver;
784                     }
785                     break;
786                 }
787             }
788         }
789 #  endif
790 #endif
791     }
792 #if PERL_VERSION_LT(5,17,2)
793     else if (SvIOKp(ver)) {
794         goto VER_IV;
795     }
796     else if (SvNOKp(ver)) {
797         goto VER_NV;
798     }
799     else if (SvPOKp(ver)) {
800         goto VER_PV;
801     }
802 #endif
803     else
804     {
805         /* no idea what this is */
806         Perl_croak(aTHX_ "Invalid version format (non-numeric data)");
807     }
808
809     s = SCAN_VERSION(version, ver, qv);
810     if ( *s != '\0' ) 
811         Perl_ck_warner(aTHX_ packWARN(WARN_MISC), 
812                        "Version string '%s' contains invalid data; "
813                        "ignoring: '%s'", version, s);
814
815 #if PERL_VERSION_LT(5,19,8) && defined(USE_ITHREADS)
816     LEAVE;
817 #endif
818
819     return ver;
820 }
821
822 /*
823 =for apidoc vverify
824
825 Validates that the SV contains valid internal structure for a version object.
826 It may be passed either the version object (RV) or the hash itself (HV).  If
827 the structure is valid, it returns the HV.  If the structure is invalid,
828 it returns NULL.
829
830     SV *hv = vverify(sv);
831
832 Note that it only confirms the bare minimum structure (so as not to get
833 confused by derived classes which may contain additional hash entries):
834
835 =over 4
836
837 =item * The SV is an HV or a reference to an HV
838
839 =item * The hash contains a "version" key
840
841 =item * The "version" key has a reference to an AV as its value
842
843 =back
844
845 =cut
846 */
847
848 SV *
849 #ifdef VUTIL_REPLACE_CORE
850 Perl_vverify2(pTHX_ SV *vs)
851 #else
852 Perl_vverify(pTHX_ SV *vs)
853 #endif
854 {
855     SV *sv;
856     SV **svp;
857
858     PERL_ARGS_ASSERT_VVERIFY;
859
860     if ( SvROK(vs) )
861         vs = SvRV(vs);
862
863     /* see if the appropriate elements exist */
864     if ( SvTYPE(vs) == SVt_PVHV
865          && (svp = hv_fetchs(MUTABLE_HV(vs), "version", FALSE))
866          && (sv = SvRV(*svp))
867          && SvTYPE(sv) == SVt_PVAV )
868         return vs;
869     else
870         return NULL;
871 }
872
873 /*
874 =for apidoc vnumify
875
876 Accepts a version object and returns the normalized floating
877 point representation.  Call like:
878
879     sv = vnumify(rv);
880
881 NOTE: you can pass either the object directly or the SV
882 contained within the RV.
883
884 The SV returned has a refcount of 1.
885
886 =cut
887 */
888
889 SV *
890 #ifdef VUTIL_REPLACE_CORE
891 Perl_vnumify2(pTHX_ SV *vs)
892 #else
893 Perl_vnumify(pTHX_ SV *vs)
894 #endif
895 {
896     SSize_t i, len;
897     I32 digit;
898     bool alpha = FALSE;
899     SV *sv;
900     AV *av;
901
902     PERL_ARGS_ASSERT_VNUMIFY;
903
904     /* extract the HV from the object */
905     vs = VVERIFY(vs);
906     if ( ! vs )
907         Perl_croak(aTHX_ "Invalid version object");
908
909     /* see if various flags exist */
910     if ( hv_exists(MUTABLE_HV(vs), "alpha", 5 ) )
911         alpha = TRUE;
912
913     if (alpha) {
914         Perl_ck_warner(aTHX_ packWARN(WARN_NUMERIC),
915                        "alpha->numify() is lossy");
916     }
917
918     /* attempt to retrieve the version array */
919     if ( !(av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE))) ) ) {
920         return newSVpvs("0");
921     }
922
923     len = av_len(av);
924     if ( len == -1 )
925     {
926         return newSVpvs("0");
927     }
928
929     {
930         SV * tsv = *av_fetch(av, 0, 0);
931         digit = SvIV(tsv);
932     }
933     sv = Perl_newSVpvf(aTHX_ "%d.", (int)PERL_ABS(digit));
934     for ( i = 1 ; i <= len ; i++ )
935     {
936         SV * tsv = *av_fetch(av, i, 0);
937         digit = SvIV(tsv);
938         Perl_sv_catpvf(aTHX_ sv, "%03d", (int)digit);
939     }
940
941     if ( len == 0 ) {
942         sv_catpvs(sv, "000");
943     }
944     return sv;
945 }
946
947 /*
948 =for apidoc vnormal
949
950 Accepts a version object and returns the normalized string
951 representation.  Call like:
952
953     sv = vnormal(rv);
954
955 NOTE: you can pass either the object directly or the SV
956 contained within the RV.
957
958 The SV returned has a refcount of 1.
959
960 =cut
961 */
962
963 SV *
964 #ifdef VUTIL_REPLACE_CORE
965 Perl_vnormal2(pTHX_ SV *vs)
966 #else
967 Perl_vnormal(pTHX_ SV *vs)
968 #endif
969 {
970     I32 i, len, digit;
971     SV *sv;
972     AV *av;
973
974     PERL_ARGS_ASSERT_VNORMAL;
975
976     /* extract the HV from the object */
977     vs = VVERIFY(vs);
978     if ( ! vs )
979         Perl_croak(aTHX_ "Invalid version object");
980
981     av = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(vs), "version", FALSE)));
982
983     len = av_len(av);
984     if ( len == -1 )
985     {
986         return newSVpvs("");
987     }
988     {
989         SV * tsv = *av_fetch(av, 0, 0);
990         digit = SvIV(tsv);
991     }
992     sv = Perl_newSVpvf(aTHX_ "v%" IVdf, (IV)digit);
993     for ( i = 1 ; i <= len ; i++ ) {
994         SV * tsv = *av_fetch(av, i, 0);
995         digit = SvIV(tsv);
996         Perl_sv_catpvf(aTHX_ sv, ".%" IVdf, (IV)digit);
997     }
998
999     if ( len <= 2 ) { /* short version, must be at least three */
1000         for ( len = 2 - len; len != 0; len-- )
1001             sv_catpvs(sv,".0");
1002     }
1003     return sv;
1004 }
1005
1006 /*
1007 =for apidoc vstringify
1008
1009 In order to maintain maximum compatibility with earlier versions
1010 of Perl, this function will return either the floating point
1011 notation or the multiple dotted notation, depending on whether
1012 the original version contained 1 or more dots, respectively.
1013
1014 The SV returned has a refcount of 1.
1015
1016 =cut
1017 */
1018
1019 SV *
1020 #ifdef VUTIL_REPLACE_CORE
1021 Perl_vstringify2(pTHX_ SV *vs)
1022 #else
1023 Perl_vstringify(pTHX_ SV *vs)
1024 #endif
1025 {
1026     SV ** svp;
1027     PERL_ARGS_ASSERT_VSTRINGIFY;
1028
1029     /* extract the HV from the object */
1030     vs = VVERIFY(vs);
1031     if ( ! vs )
1032         Perl_croak(aTHX_ "Invalid version object");
1033
1034     svp = hv_fetchs(MUTABLE_HV(vs), "original", FALSE);
1035     if (svp) {
1036         SV *pv;
1037         pv = *svp;
1038         if ( SvPOK(pv)
1039 #if PERL_VERSION_LT(5,17,2)
1040             || SvPOKp(pv)
1041 #endif
1042         )
1043             return newSVsv(pv);
1044         else
1045             return &PL_sv_undef;
1046     }
1047     else {
1048         if ( hv_exists(MUTABLE_HV(vs), "qv", 2) )
1049             return VNORMAL(vs);
1050         else
1051             return VNUMIFY(vs);
1052     }
1053 }
1054
1055 /*
1056 =for apidoc vcmp
1057
1058 Version object aware cmp.  Both operands must already have been 
1059 converted into version objects.
1060
1061 =cut
1062 */
1063
1064 int
1065 #ifdef VUTIL_REPLACE_CORE
1066 Perl_vcmp2(pTHX_ SV *lhv, SV *rhv)
1067 #else
1068 Perl_vcmp(pTHX_ SV *lhv, SV *rhv)
1069 #endif
1070 {
1071     SSize_t i,l,m,r;
1072     I32 retval;
1073     I32 left = 0;
1074     I32 right = 0;
1075     AV *lav, *rav;
1076
1077     PERL_ARGS_ASSERT_VCMP;
1078
1079     /* extract the HVs from the objects */
1080     lhv = VVERIFY(lhv);
1081     rhv = VVERIFY(rhv);
1082     if ( ! ( lhv && rhv ) )
1083         Perl_croak(aTHX_ "Invalid version object");
1084
1085     /* get the left hand term */
1086     lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(lhv), "version", FALSE)));
1087
1088     /* and the right hand term */
1089     rav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(rhv), "version", FALSE)));
1090
1091     l = av_len(lav);
1092     r = av_len(rav);
1093     m = l < r ? l : r;
1094     retval = 0;
1095     i = 0;
1096     while ( i <= m && retval == 0 )
1097     {
1098         SV * const lsv = *av_fetch(lav,i,0);
1099         SV * rsv;
1100         left = SvIV(lsv);
1101         rsv = *av_fetch(rav,i,0);
1102         right = SvIV(rsv);
1103         if ( left < right  )
1104             retval = -1;
1105         if ( left > right )
1106             retval = +1;
1107         i++;
1108     }
1109
1110     if ( l != r && retval == 0 ) /* possible match except for trailing 0's */
1111     {
1112         if ( l < r )
1113         {
1114             while ( i <= r && retval == 0 )
1115             {
1116                 SV * const rsv = *av_fetch(rav,i,0);
1117                 if ( SvIV(rsv) != 0 )
1118                     retval = -1; /* not a match after all */
1119                 i++;
1120             }
1121         }
1122         else
1123         {
1124             while ( i <= l && retval == 0 )
1125             {
1126                 SV * const lsv = *av_fetch(lav,i,0);
1127                 if ( SvIV(lsv) != 0 )
1128                     retval = +1; /* not a match after all */
1129                 i++;
1130             }
1131         }
1132     }
1133     return retval;
1134 }
1135
1136 /* ex: set ro: */