aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/icu/include/unicode/ugender.h
blob: d8d03e9a6b2290ba6bc3a6bad71e5e4f3310c5fd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html 
/* 
***************************************************************************************** 
* Copyright (C) 2010-2013, International Business Machines 
* Corporation and others. All Rights Reserved. 
***************************************************************************************** 
*/ 
 
#ifndef UGENDER_H 
#define UGENDER_H 
 
#include "unicode/utypes.h" 
 
#if !UCONFIG_NO_FORMATTING 
 
#include "unicode/localpointer.h" 
 
/** 
 * \file 
 * \brief C API: The purpose of this API is to compute the gender of a list as a 
 * whole given the gender of each element. 
 * 
 */ 
 
/** 
 * Genders 
 * @stable ICU 50 
 */ 
enum UGender { 
    /** 
     * Male gender. 
     * @stable ICU 50 
     */ 
    UGENDER_MALE, 
    /** 
     * Female gender. 
     * @stable ICU 50 
     */ 
    UGENDER_FEMALE, 
    /** 
     * Neutral gender. 
     * @stable ICU 50 
     */ 
    UGENDER_OTHER 
}; 
/** 
 * @stable ICU 50 
 */ 
typedef enum UGender UGender; 
 
struct UGenderInfo;
/** 
 * Opaque UGenderInfo object for use in C programs. 
 * @stable ICU 50 
 */ 
typedef struct UGenderInfo UGenderInfo; 
 
/** 
 * Opens a new UGenderInfo object given locale. 
 * @param locale The locale for which the rules are desired. 
 * @param status UErrorCode pointer 
 * @return A UGenderInfo for the specified locale, or NULL if an error occurred. 
 * @stable ICU 50 
 */ 
U_STABLE const UGenderInfo* U_EXPORT2 
ugender_getInstance(const char *locale, UErrorCode *status); 
 
 
/** 
 * Given a list, returns the gender of the list as a whole. 
 * @param genderInfo pointer that ugender_getInstance returns. 
 * @param genders the gender of each element in the list. 
 * @param size the size of the list. 
 * @param status A pointer to a UErrorCode to receive any errors. 
 * @return The gender of the list. 
 * @stable ICU 50 
 */ 
U_STABLE UGender U_EXPORT2 
ugender_getListGender(const UGenderInfo* genderInfo, const UGender *genders, int32_t size, UErrorCode *status);
 
#endif /* #if !UCONFIG_NO_FORMATTING */ 
 
#endif