michael@0: /*  
michael@0: *******************************************************************************
michael@0: *
michael@0: *   Copyright (C) 1999-2008, International Business Machines
michael@0: *   Corporation and others.  All Rights Reserved.
michael@0: *
michael@0: *******************************************************************************
michael@0: *   file name:  ucol_wgt.h
michael@0: *   encoding:   US-ASCII
michael@0: *   tab size:   8 (not used)
michael@0: *   indentation:4
michael@0: *
michael@0: *   created on: 2001mar08
michael@0: *   created by: Markus W. Scherer
michael@0: */
michael@0: 
michael@0: #ifndef UCOL_WGT_H
michael@0: #define UCOL_WGT_H
michael@0: 
michael@0: #include "unicode/utypes.h"
michael@0: 
michael@0: #if !UCONFIG_NO_COLLATION
michael@0: 
michael@0: /* definitions for CE weights */
michael@0: 
michael@0: typedef struct WeightRange {
michael@0:     uint32_t start, end;
michael@0:     int32_t length, count;
michael@0:     int32_t length2;
michael@0:     uint32_t count2;
michael@0: } WeightRange;
michael@0: 
michael@0: /**
michael@0:  * Determine heuristically
michael@0:  * what ranges to use for a given number of weights between (excluding)
michael@0:  * two limits.
michael@0:  *
michael@0:  * @param lowerLimit A collation element weight; the ranges will be filled to cover
michael@0:  *                   weights greater than this one.
michael@0:  * @param upperLimit A collation element weight; the ranges will be filled to cover
michael@0:  *                   weights less than this one.
michael@0:  * @param n          The number of collation element weights w necessary such that
michael@0:  *                   lowerLimit<w<upperLimit in lexical order.
michael@0:  * @param maxByte    The highest valid byte value.
michael@0:  * @param ranges     An array that is filled in with one or more ranges to cover
michael@0:  *                   n weights between the limits.
michael@0:  * @return number of ranges, 0 if it is not possible to fit n elements between the limits
michael@0:  */
michael@0: U_CFUNC int32_t
michael@0: ucol_allocWeights(uint32_t lowerLimit, uint32_t upperLimit,
michael@0:                   uint32_t n,
michael@0:                   uint32_t maxByte,
michael@0:                   WeightRange ranges[7]);
michael@0: 
michael@0: /**
michael@0:  * Given a set of ranges calculated by ucol_allocWeights(),
michael@0:  * iterate through the weights.
michael@0:  * The ranges are modified to keep the current iteration state.
michael@0:  *
michael@0:  * @param ranges The array of ranges that ucol_allocWeights() filled in.
michael@0:  *               The ranges are modified.
michael@0:  * @param pRangeCount The number of ranges. It will be decremented when necessary.
michael@0:  * @return The next weight in the ranges, or 0xffffffff if there is none left.
michael@0:  */
michael@0: U_CFUNC uint32_t
michael@0: ucol_nextWeight(WeightRange ranges[], int32_t *pRangeCount);
michael@0: 
michael@0: #endif /* #if !UCONFIG_NO_COLLATION */
michael@0: 
michael@0: #endif