include/unicode/ugender.h

0001 // © 2016 and later: Unicode, Inc. and others.
0002 // License & terms of use: http://www.unicode.org/copyright.html
0003 /*
0004 *****************************************************************************************
0005 * Copyright (C) 2010-2013, International Business Machines
0006 * Corporation and others. All Rights Reserved.
0007 *****************************************************************************************
0008 */
0009
0010 #ifndef UGENDER_H
0011 #define UGENDER_H
0012
0013 #include "unicode/utypes.h"
0014
0015 #if !UCONFIG_NO_FORMATTING
0016
0017 #if U_SHOW_CPLUSPLUS_API
0018 #include "unicode/localpointer.h"
0019 #endif   // U_SHOW_CPLUSPLUS_API
0020
0021 /**
0022  * \file
0023  * \brief C API: The purpose of this API is to compute the gender of a list as a
0024  * whole given the gender of each element.
0025  *
0026  */
0027
0028 /**
0029  * Genders
0030  * @stable ICU 50
0031  */
0032 enum UGender {
0033     /**
0034      * Male gender.
0035      * @stable ICU 50
0036      */
0037     UGENDER_MALE,
0038     /**
0039      * Female gender.
0040      * @stable ICU 50
0041      */
0042     UGENDER_FEMALE,
0043     /**
0044      * Neutral gender.
0045      * @stable ICU 50
0046      */
0047     UGENDER_OTHER
0048 };
0049 /**
0050  * @stable ICU 50
0051  */
0052 typedef enum UGender UGender;
0053
0054 struct UGenderInfo;
0055 /**
0056  * Opaque UGenderInfo object for use in C programs.
0057  * @stable ICU 50
0058  */
0059 typedef struct UGenderInfo UGenderInfo;
0060
0061 /**
0062  * Opens a new UGenderInfo object given locale.
0063  * @param locale The locale for which the rules are desired.
0064  * @param status UErrorCode pointer
0065  * @return A UGenderInfo for the specified locale, or NULL if an error occurred.
0066  * @stable ICU 50
0067  */
0068 U_CAPI const UGenderInfo* U_EXPORT2
0069 ugender_getInstance(const char *locale, UErrorCode *status);
0070
0071
0072 /**
0073  * Given a list, returns the gender of the list as a whole.
0074  * @param genderInfo pointer that ugender_getInstance returns.
0075  * @param genders the gender of each element in the list.
0076  * @param size the size of the list.
0077  * @param status A pointer to a UErrorCode to receive any errors.
0078  * @return The gender of the list.
0079  * @stable ICU 50
0080  */
0081 U_CAPI UGender U_EXPORT2
0082 ugender_getListGender(const UGenderInfo* genderInfo, const UGender *genders, int32_t size, UErrorCode *status);
0083
0084 #endif /* #if !UCONFIG_NO_FORMATTING */
0085
0086 #endif