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

Contents of /eclass/versionator.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.10 - (show annotations) (download)
Tue Mar 21 00:49:54 2006 UTC (8 years, 3 months ago) by kugelfang
Branch: MAIN
Changes since 1.9: +31 -11 lines
Committing this patch on behalf of ciaranm.

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

  ViewVC Help
Powered by ViewVC 1.1.20