/[gentoo-x86]/eclass/versionator.eclass
Gentoo

Contents of /eclass/versionator.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.17 - (show annotations) (download)
Mon Jul 19 20:17:35 2010 UTC (4 years, 9 months ago) by vapier
Branch: MAIN
Changes since 1.16: +46 -66 lines
switch to eshopts_{push,pop} from eutils

1 # Copyright 1999-2008 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/versionator.eclass,v 1.16 2010/07/18 21:24:33 vapier Exp $
4
5 # @ECLASS: versionator.eclass
6 # @MAINTAINER:
7 # base-system@gentoo.org
8 # @BLURB: functions which simplify manipulation of ${PV} and similar version strings
9 # @DESCRIPTION:
10 # This eclass provides functions which simplify manipulating $PV and similar
11 # variables. Most functions default to working with $PV, although other
12 # values can be used.
13 # @EXAMPLE:
14 # Simple Example 1: $PV is 1.2.3b, we want 1_2.3b:
15 # MY_PV=$(replace_version_separator 1 '_' )
16 #
17 # Simple Example 2: $PV is 1.4.5, we want 1:
18 # MY_MAJORV=$(get_major_version )
19 #
20 # Rather than being a number, the index parameter can be a separator character
21 # such as '-', '.' or '_'. In this case, the first separator of this kind is
22 # selected.
23 #
24 # There's also:
25 # version_is_at_least want have
26 # which may be buggy, so use with caution.
27
28 inherit eutils
29
30 # @FUNCTION: get_all_version_components
31 # @USAGE: [version]
32 # @DESCRIPTION:
33 # Split up a version string into its component parts. If no parameter is
34 # supplied, defaults to $PV.
35 # 0.8.3 -> 0 . 8 . 3
36 # 7c -> 7 c
37 # 3.0_p2 -> 3 . 0 _ p2
38 # 20040905 -> 20040905
39 # 3.0c-r1 -> 3 . 0 c - r1
40 get_all_version_components() {
41 eshopts_push -s extglob
42 local ver_str=${1:-${PV}} result result_idx=0
43 result=( )
44
45 # sneaky cache trick cache to avoid having to parse the same thing several
46 # times.
47 if [[ "${VERSIONATOR_CACHE_VER_STR}" == "${ver_str}" ]] ; then
48 echo ${VERSIONATOR_CACHE_RESULT}
49 eshopts_pop
50 return
51 fi
52 export VERSIONATOR_CACHE_VER_STR="${ver_str}"
53
54 while [[ -n "$ver_str" ]] ; do
55 case "${ver_str:0:1}" in
56 # number: parse whilst we have a number
57 [[:digit:]])
58 result[$result_idx]="${ver_str%%[^[:digit:]]*}"
59 ver_str="${ver_str##+([[:digit:]])}"
60 result_idx=$(($result_idx + 1))
61 ;;
62
63 # separator: single character
64 [-_.])
65 result[$result_idx]="${ver_str:0:1}"
66 ver_str="${ver_str:1}"
67 result_idx=$(($result_idx + 1))
68 ;;
69
70 # letter: grab the letters plus any following numbers
71 [[:alpha:]])
72 local not_match="${ver_str##+([[:alpha:]])*([[:digit:]])}"
73 result[$result_idx]=${ver_str:0:$((${#ver_str} - ${#not_match}))}
74 ver_str="${not_match}"
75 result_idx=$(($result_idx + 1))
76 ;;
77
78 # huh?
79 *)
80 result[$result_idx]="${ver_str:0:1}"
81 ver_str="${ver_str:1}"
82 result_idx=$(($result_idx + 1))
83 ;;
84 esac
85 done
86
87 export VERSIONATOR_CACHE_RESULT="${result[@]}"
88 echo ${result[@]}
89 eshopts_pop
90 }
91
92 # @FUNCTION: get_version_components
93 # @USAGE: [version]
94 # @DESCRIPTION:
95 # Get the important version components, excluding '.', '-' and '_'. Defaults to
96 # $PV if no parameter is supplied.
97 # 0.8.3 -> 0 8 3
98 # 7c -> 7 c
99 # 3.0_p2 -> 3 0 p2
100 # 20040905 -> 20040905
101 # 3.0c-r1 -> 3 0 c r1
102 get_version_components() {
103 eshopts_push -s extglob
104 local c="$(get_all_version_components "${1:-${PV}}")"
105 c=( ${c[@]//[-._]/ } )
106 echo ${c[@]}
107 eshopts_pop
108 }
109
110 # @FUNCTION: get_major_version
111 # @USAGE: [version]
112 # @DESCRIPTION:
113 # Get the major version of a value. Defaults to $PV if no parameter is supplied.
114 # 0.8.3 -> 0
115 # 7c -> 7
116 # 3.0_p2 -> 3
117 # 20040905 -> 20040905
118 # 3.0c-r1 -> 3
119 get_major_version() {
120 eshopts_push -s extglob
121 local c
122 c=( $(get_all_version_components "${1:-${PV}}" ) )
123 echo ${c[0]}
124 eshopts_pop
125 }
126
127 # @FUNCTION: get_version_component_range
128 # @USAGE: [version]
129 # @DESCRIPTION:
130 # Get a particular component or range of components from the version. If no
131 # version parameter is supplied, defaults to $PV.
132 # 1 1.2.3 -> 1
133 # 1-2 1.2.3 -> 1.2
134 # 2- 1.2.3 -> 2.3
135 get_version_component_range() {
136 eshopts_push -s extglob
137 local c v="${2:-${PV}}" range="${1}" range_start range_end i=-1 j=0
138 c=( $(get_all_version_components ${v} ) )
139 range_start="${range%-*}" ; range_start="${range_start:-1}"
140 range_end="${range#*-}" ; range_end="${range_end:-${#c[@]}}"
141
142 while (( j < ${range_start} )) ; do
143 i=$(($i + 1))
144 [[ $i -gt ${#c[@]} ]] && eshopts_pop && return
145 [[ -n "${c[${i}]//[-._]}" ]] && j=$(($j + 1))
146 done
147
148 while (( j <= ${range_end} )) ; do
149 echo -n ${c[$i]}
150 [[ $i -gt ${#c[@]} ]] && eshopts_pop && return
151 [[ -n "${c[${i}]//[-._]}" ]] && j=$(($j + 1))
152 i=$(($i + 1))
153 done
154 eshopts_pop
155 }
156
157 # @FUNCTION: get_after_major_version
158 # @USAGE: [version]
159 # @DESCRIPTION:
160 # Get everything after the major version and its separator (if present) of a
161 # value. Defaults to $PV if no parameter is supplied.
162 # 0.8.3 -> 8.3
163 # 7c -> c
164 # 3.0_p2 -> 0_p2
165 # 20040905 -> (empty string)
166 # 3.0c-r1 -> 0c-r1
167 get_after_major_version() {
168 eshopts_push -s extglob
169 echo $(get_version_component_range 2- "${1:-${PV}}" )
170 eshopts_pop
171 }
172
173 # @FUNCTION: replace_version_separator
174 # @USAGE: <search> <replacement> [subject]
175 # @DESCRIPTION:
176 # Replace the $1th separator with $2 in $3 (defaults to $PV if $3 is not
177 # supplied). If there are fewer than $1 separators, don't change anything.
178 # 1 '_' 1.2.3 -> 1_2.3
179 # 2 '_' 1.2.3 -> 1.2_3
180 # 1 '_' 1b-2.3 -> 1b_2.3
181 # Rather than being a number, $1 can be a separator character such as '-', '.'
182 # or '_'. In this case, the first separator of this kind is selected.
183 replace_version_separator() {
184 eshopts_push -s extglob
185 local w i c found=0 v="${3:-${PV}}"
186 w=${1:-1}
187 c=( $(get_all_version_components ${v} ) )
188 if [[ "${w//[[:digit:]]/}" == "${w}" ]] ; then
189 # it's a character, not an index
190 for (( i = 0 ; i < ${#c[@]} ; i = $i + 1 )) ; do
191 if [[ "${c[${i}]}" == "${w}" ]] ; then
192 c[${i}]="${2}"
193 break
194 fi
195 done
196 else
197 for (( i = 0 ; i < ${#c[@]} ; i = $i + 1 )) ; do
198 if [[ -n "${c[${i}]//[^-._]}" ]] ; then
199 found=$(($found + 1))
200 if [[ "$found" == "${w}" ]] ; then
201 c[${i}]="${2}"
202 break
203 fi
204 fi
205 done
206 fi
207 c=${c[@]}
208 echo ${c// }
209 eshopts_pop
210 }
211
212 # @FUNCTION: replace_all_version_separators
213 # @USAGE: <replacement> [subject]
214 # @DESCRIPTION:
215 # Replace all version separators in $2 (defaults to $PV) with $1.
216 # '_' 1b.2.3 -> 1b_2_3
217 replace_all_version_separators() {
218 eshopts_push -s extglob
219 local c
220 c=( $(get_all_version_components "${2:-${PV}}" ) )
221 c="${c[@]//[-._]/$1}"
222 echo ${c// }
223 eshopts_pop
224 }
225
226 # @FUNCTION: delete_version_separator
227 # @USAGE: <search> [subject]
228 # @DESCRIPTION:
229 # Delete the $1th separator in $2 (defaults to $PV if $2 is not supplied). If
230 # there are fewer than $1 separators, don't change anything.
231 # 1 1.2.3 -> 12.3
232 # 2 1.2.3 -> 1.23
233 # 1 1b-2.3 -> 1b2.3
234 # Rather than being a number, $1 can be a separator character such as '-', '.'
235 # or '_'. In this case, the first separator of this kind is deleted.
236 delete_version_separator() {
237 eshopts_push -s extglob
238 replace_version_separator "${1}" "" "${2}"
239 eshopts_pop
240 }
241
242 # @FUNCTION: delete_all_version_separators
243 # @USAGE: [subject]
244 # @DESCRIPTION:
245 # Delete all version separators in $1 (defaults to $PV).
246 # 1b.2.3 -> 1b23
247 delete_all_version_separators() {
248 eshopts_push -s extglob
249 replace_all_version_separators "" "${1}"
250 eshopts_pop
251 }
252
253 # @FUNCTION: get_version_component_count
254 # @USAGE: [version]
255 # @DESCRIPTION:
256 # How many version components are there in $1 (defaults to $PV)?
257 # 1.0.1 -> 3
258 # 3.0c-r1 -> 4
259 get_version_component_count() {
260 eshopts_push -s extglob
261 local a
262 a=( $(get_version_components "${1:-${PV}}" ) )
263 echo ${#a[@]}
264 eshopts_pop
265 }
266
267 # @FUNCTION: get_last_version_component_index
268 # @USAGE: [version]
269 # @DESCRIPTION:
270 # What is the index of the last version component in $1 (defaults to $PV)?
271 # Equivalent to get_version_component_count - 1.
272 # 1.0.1 -> 3
273 # 3.0c-r1 -> 4
274 get_last_version_component_index() {
275 eshopts_push -s extglob
276 echo $(( $(get_version_component_count "${1:-${PV}}" ) - 1 ))
277 eshopts_pop
278 }
279
280 # @FUNCTION: version_is_at_least
281 # @USAGE: <want> [have]
282 # @DESCRIPTION:
283 # Is $2 (defaults to $PVR) at least version $1? Intended for use in eclasses
284 # only. May not be reliable, be sure to do very careful testing before actually
285 # using this.
286 version_is_at_least() {
287 eshopts_push -s extglob
288 local want_s="$1" have_s="${2:-${PVR}}" r
289 version_compare "${want_s}" "${have_s}"
290 r=$?
291 case $r in
292 1|2)
293 eshopts_pop
294 return 0
295 ;;
296 3)
297 eshopts_pop
298 return 1
299 ;;
300 *)
301 eshopts_pop
302 die "versionator compare bug [atleast, ${want_s}, ${have_s}, ${r}]"
303 ;;
304 esac
305 eshopts_pop
306 }
307
308 # @FUNCTION: version_compare
309 # @USAGE: <A> <B>
310 # @DESCRIPTION:
311 # Takes two parameters (A, B) which are versions. If A is an earlier version
312 # than B, returns 1. If A is identical to B, return 2. If A is later than B,
313 # return 3. You probably want version_is_at_least rather than this function.
314 # May not be very reliable. Test carefully before using this.
315 version_compare() {
316 eshopts_push -s extglob
317 local ver_a=${1} ver_b=${2} parts_a parts_b cur_idx_a=0 cur_idx_b=0
318 parts_a=( $(get_all_version_components "${ver_a}" ) )
319 parts_b=( $(get_all_version_components "${ver_b}" ) )
320
321 ### compare number parts.
322 local inf_loop=0
323 while true ; do
324 inf_loop=$(( ${inf_loop} + 1 ))
325 [[ ${inf_loop} -gt 20 ]] && \
326 die "versionator compare bug [numbers, ${ver_a}, ${ver_b}]"
327
328 # grab the current number components
329 local cur_tok_a=${parts_a[${cur_idx_a}]}
330 local cur_tok_b=${parts_b[${cur_idx_b}]}
331
332 # number?
333 if [[ -n ${cur_tok_a} ]] && [[ -z ${cur_tok_a//[[:digit:]]} ]] ; then
334 cur_idx_a=$(( ${cur_idx_a} + 1 ))
335 [[ ${parts_a[${cur_idx_a}]} == "." ]] \
336 && cur_idx_a=$(( ${cur_idx_a} + 1 ))
337 else
338 cur_tok_a=""
339 fi
340
341 if [[ -n ${cur_tok_b} ]] && [[ -z ${cur_tok_b//[[:digit:]]} ]] ; then
342 cur_idx_b=$(( ${cur_idx_b} + 1 ))
343 [[ ${parts_b[${cur_idx_b}]} == "." ]] \
344 && cur_idx_b=$(( ${cur_idx_b} + 1 ))
345 else
346 cur_tok_b=""
347 fi
348
349 # done with number components?
350 [[ -z ${cur_tok_a} ]] && [[ -z ${cur_tok_b} ]] && break
351
352 # to avoid going into octal mode, strip any leading zeros. otherwise
353 # bash will throw a hissy fit on versions like 6.3.068.
354 cur_tok_a=${cur_tok_a##+(0)}
355 cur_tok_b=${cur_tok_b##+(0)}
356
357 # if a component is blank, make it zero.
358 [[ -z ${cur_tok_a} ]] && cur_tok_a=0
359 [[ -z ${cur_tok_b} ]] && cur_tok_b=0
360
361 # compare
362 [[ ${cur_tok_a} -lt ${cur_tok_b} ]] && eshopts_pop && return 1
363 [[ ${cur_tok_a} -gt ${cur_tok_b} ]] && eshopts_pop && return 3
364 done
365
366 ### number parts equal. compare letter parts.
367 local letter_a=
368 letter_a=${parts_a[${cur_idx_a}]}
369 if [[ ${#letter_a} -eq 1 ]] && [[ -z ${letter_a/[a-z]} ]] ; then
370 cur_idx_a=$(( ${cur_idx_a} + 1 ))
371 else
372 letter_a="@"
373 fi
374
375 local letter_b=
376 letter_b=${parts_b[${cur_idx_b}]}
377 if [[ ${#letter_b} -eq 1 ]] && [[ -z ${letter_b/[a-z]} ]] ; then
378 cur_idx_b=$(( ${cur_idx_b} + 1 ))
379 else
380 letter_b="@"
381 fi
382
383 # compare
384 [[ ${letter_a} < ${letter_b} ]] && eshopts_pop && return 1
385 [[ ${letter_a} > ${letter_b} ]] && eshopts_pop && return 3
386
387 ### letter parts equal. compare suffixes in order.
388 local suffix rule part r_lt r_gt
389 for rule in "alpha=1" "beta=1" "pre=1" "rc=1" "p=3" "r=3" ; do
390 suffix=${rule%%=*}
391 r_lt=${rule##*=}
392 [[ ${r_lt} -eq 1 ]] && r_gt=3 || r_gt=1
393
394 local suffix_a=
395 for part in ${parts_a[@]} ; do
396 [[ ${part#${suffix}} != ${part} ]] && \
397 [[ -z ${part##${suffix}*([[:digit:]])} ]] && \
398 suffix_a=${part#${suffix}}0
399 done
400
401 local suffix_b=
402 for part in ${parts_b[@]} ; do
403 [[ ${part#${suffix}} != ${part} ]] && \
404 [[ -z ${part##${suffix}*([[:digit:]])} ]] && \
405 suffix_b=${part#${suffix}}0
406 done
407
408 [[ -z ${suffix_a} ]] && [[ -z ${suffix_b} ]] && continue
409
410 [[ -z ${suffix_a} ]] && eshopts_pop && return ${r_gt}
411 [[ -z ${suffix_b} ]] && eshopts_pop && return ${r_lt}
412
413 # avoid octal problems
414 suffix_a=${suffix_a##+(0)} ; suffix_a=${suffix_a:-0}
415 suffix_b=${suffix_b##+(0)} ; suffix_b=${suffix_b:-0}
416
417 [[ ${suffix_a} -lt ${suffix_b} ]] && eshopts_pop && return 1
418 [[ ${suffix_a} -gt ${suffix_b} ]] && eshopts_pop && return 3
419 done
420
421 ### no differences.
422 eshopts_pop
423 return 2
424 }
425
426 # @FUNCTION: version_sort
427 # @USAGE: <version> [more versions...]
428 # @DESCRIPTION:
429 # Returns its parameters sorted, highest version last. We're using a quadratic
430 # algorithm for simplicity, so don't call it with more than a few dozen items.
431 # Uses version_compare, so be careful.
432 version_sort() {
433 eshopts_push -s extglob
434 local items= left=0
435 items=( $@ )
436 while [[ ${left} -lt ${#items[@]} ]] ; do
437 local lowest_idx=${left}
438 local idx=$(( ${lowest_idx} + 1 ))
439 while [[ ${idx} -lt ${#items[@]} ]] ; do
440 version_compare "${items[${lowest_idx}]}" "${items[${idx}]}"
441 [[ $? -eq 3 ]] && lowest_idx=${idx}
442 idx=$(( ${idx} + 1 ))
443 done
444 local tmp=${items[${lowest_idx}]}
445 items[${lowest_idx}]=${items[${left}]}
446 items[${left}]=${tmp}
447 left=$(( ${left} + 1 ))
448 done
449 echo ${items[@]}
450 eshopts_pop
451 }
452
453 # @FUNCTION: version_format_string
454 # @USAGE: <format> [version]
455 # @DESCRIPTION:
456 # Reformat complicated version strings. The first argument is the string
457 # to reformat with while the rest of the args are passed on to the
458 # get_version_components function. You should make sure to single quote
459 # the first argument since it'll have variables that get delayed expansion.s
460 # @EXAMPLE:
461 # P="cow-hat-1.2.3_p4"
462 # MY_P=$(version_format_string '${PN}_source_$1_$2-$3_$4')
463 # Now MY_P will be: cow-hat_source_1_2-3_p4
464 version_format_string() {
465 local fstr=$1
466 shift
467 set -- $(get_version_components "$@")
468 eval echo "${fstr}"
469 }
470
471 __versionator__test_version_compare() {
472 eshopts_push -s extglob
473 local lt=1 eq=2 gt=3 p q
474
475 __versionator__test_version_compare_t() {
476 version_compare "${1}" "${3}"
477 local r=$?
478 [[ ${r} -eq ${2} ]] || echo "FAIL: ${@} (got ${r} exp ${2})"
479 }
480
481 echo "
482 0 $lt 1
483 1 $lt 2
484 2 $gt 1
485 2 $eq 2
486 0 $eq 0
487 10 $lt 20
488 68 $eq 068
489 068 $gt 67
490 068 $lt 69
491
492 1.0 $lt 2.0
493 2.0 $eq 2.0
494 2.0 $gt 1.0
495
496 1.0 $gt 0.0
497 0.0 $eq 0.0
498 0.0 $lt 1.0
499
500 0.1 $lt 0.2
501 0.2 $eq 0.2
502 0.3 $gt 0.2
503
504 1.2 $lt 2.1
505 2.1 $gt 1.2
506
507 1.2.3 $lt 1.2.4
508 1.2.4 $gt 1.2.3
509
510 1.2.0 $eq 1.2
511 1.2.1 $gt 1.2
512 1.2 $lt 1.2.1
513
514 1.2b $eq 1.2b
515 1.2b $lt 1.2c
516 1.2b $gt 1.2a
517 1.2b $gt 1.2
518 1.2 $lt 1.2a
519
520 1.3 $gt 1.2a
521 1.3 $lt 1.3a
522
523 1.0_alpha7 $lt 1.0_beta7
524 1.0_beta $lt 1.0_pre
525 1.0_pre5 $lt 1.0_rc2
526 1.0_rc2 $lt 1.0
527
528 1.0_p1 $gt 1.0
529 1.0_p1-r1 $gt 1.0_p1
530
531 1.0_alpha6-r1 $gt 1.0_alpha6
532 1.0_beta6-r1 $gt 1.0_alpha6-r2
533
534 1.0_pre1 $lt 1.0-p1
535
536 1.0p $gt 1.0_p1
537 1.0r $gt 1.0-r1
538 1.6.15 $gt 1.6.10-r2
539 1.6.10-r2 $lt 1.6.15
540
541 " | while read a b c ; do
542 [[ -z "${a}${b}${c}" ]] && continue;
543 __versionator__test_version_compare_t "${a}" "${b}" "${c}"
544 done
545
546
547 for q in "alpha beta pre rc=${lt};${gt}" "p r=${gt};${lt}" ; do
548 for p in ${q%%=*} ; do
549 local c=${q##*=}
550 local alt=${c%%;*} agt=${c##*;}
551 __versionator__test_version_compare_t "1.0" $agt "1.0_${p}"
552 __versionator__test_version_compare_t "1.0" $agt "1.0_${p}1"
553 __versionator__test_version_compare_t "1.0" $agt "1.0_${p}068"
554
555 __versionator__test_version_compare_t "2.0_${p}" $alt "2.0"
556 __versionator__test_version_compare_t "2.0_${p}1" $alt "2.0"
557 __versionator__test_version_compare_t "2.0_${p}068" $alt "2.0"
558
559 __versionator__test_version_compare_t "1.0_${p}" $eq "1.0_${p}"
560 __versionator__test_version_compare_t "0.0_${p}" $lt "0.0_${p}1"
561 __versionator__test_version_compare_t "666_${p}3" $gt "666_${p}"
562
563 __versionator__test_version_compare_t "1_${p}7" $lt "1_${p}8"
564 __versionator__test_version_compare_t "1_${p}7" $eq "1_${p}7"
565 __versionator__test_version_compare_t "1_${p}7" $gt "1_${p}6"
566 __versionator__test_version_compare_t "1_${p}09" $eq "1_${p}9"
567 done
568 done
569
570 for p in "-r" "_p" ; do
571 __versionator__test_version_compare_t "7.2${p}1" $lt "7.2${p}2"
572 __versionator__test_version_compare_t "7.2${p}2" $gt "7.2${p}1"
573 __versionator__test_version_compare_t "7.2${p}3" $gt "7.2${p}2"
574 __versionator__test_version_compare_t "7.2${p}2" $lt "7.2${p}3"
575 done
576 eshopts_pop
577 }

  ViewVC Help
Powered by ViewVC 1.1.20