ICU-2429 initial implementation of catopen/catgets wrappers

X-SVN-Rev: 11371

icu4c/source/common/Makefile.in

@@ -69,7 +69,7 @@ rbbi.o rbbidata.o rbbinode.o rbbirb.o rbbiscan.o rbbisetb.o rbbistbl.o rbbitblb.
 utrie.o uset.o cmemory.o caniter.o \
 unifilt.o unifunct.o uniset.o usetiter.o util.o uenum.o \
 icuserv.o iculserv.o icunotif.o ustrenum.o \
-uidna.o strprep.o nameprep.o punycode.o 
+uidna.o strprep.o nameprep.o punycode.o ucat.o
 
 STATIC_OBJECTS = $(OBJECTS:.o=.$(STATIC_O))
 

icu4c/source/common/common.dsp

@@ -1813,6 +1813,57 @@ InputPath=.\unicode\resbund.h
 # End Source File
 # Begin Source File
 
+SOURCE=.\ucat.c
+# End Source File
+# Begin Source File
+
+SOURCE=.\unicode\ucat.h
+
+!IF  "$(CFG)" == "common - Win32 Release"
+
+# Begin Custom Build
+InputPath=.\unicode\ucat.h
+
+"..\..\include\unicode\ucat.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)"
+	copy    $(InputPath)    ..\..\include\unicode
+
+# End Custom Build
+
+!ELSEIF  "$(CFG)" == "common - Win32 Debug"
+
+# Begin Custom Build
+InputPath=.\unicode\ucat.h
+
+"..\..\include\unicode\ucat.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)"
+	copy    $(InputPath)    ..\..\include\unicode
+
+# End Custom Build
+
+!ELSEIF  "$(CFG)" == "common - Win64 Release"
+
+# Begin Custom Build
+InputPath=.\unicode\ucat.h
+
+"..\..\include\unicode\ucat.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)"
+	copy    $(InputPath)    ..\..\include\unicode
+
+# End Custom Build
+
+!ELSEIF  "$(CFG)" == "common - Win64 Debug"
+
+# Begin Custom Build
+InputPath=.\unicode\ucat.h
+
+"..\..\include\unicode\ucat.h" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)"
+	copy    $(InputPath)    ..\..\include\unicode
+
+# End Custom Build
+
+!ENDIF 
+
+# End Source File
+# Begin Source File
+
 SOURCE=.\uloc.c
 # End Source File
 # Begin Source File

icu4c/source/common/ucat.c

@@ -0,0 +1,92 @@
+/*
+**********************************************************************
+* Copyright (c) 2003, International Business Machines
+* Corporation and others.  All Rights Reserved.
+**********************************************************************
+* Author: Alan Liu
+* Created: March 19 2003
+* Since: ICU 2.6
+**********************************************************************
+*/
+#include "unicode/ucat.h"
+#include "unicode/ustring.h"
+#include "cstring.h"
+#include "uassert.h"
+
+/* set_num key prefix string. msg_num key is simply a number. */
+static const char* SET_KEY_PREFIX = "%cat%";
+
+/* length of SET_KEY_PREFIX */
+#define SET_KEY_PREFIX_LEN 5
+
+/* Maximum length of a set_num/msg_num key, incl. terminating zero */
+#define MAX_KEY_LEN (SET_KEY_PREFIX_LEN+11)
+
+/**
+ * Fill in buffer with a set_num/msg_num key string, given the numeric
+ * value. Numeric value must be >= 0. Buffer must be of length
+ * MAX_KEY_LEN or more. If isSet is true, then a set_num key is
+ * created; otherwise a msg_num key is created.
+ */
+static char*
+_catkey(char* buffer, int32_t num, UBool isSet) {
+    int32_t i = 0;
+    U_ASSERT(num>=0);
+    if (isSet) {
+        uprv_strcpy(buffer, SET_KEY_PREFIX);
+        i = SET_KEY_PREFIX_LEN;
+    }
+    T_CString_integerToString(buffer + i, num, 10);
+    return buffer;
+}
+
+U_CAPI u_nl_catd U_EXPORT2
+u_catopen(const char* name, const char* locale, UErrorCode* ec) {
+    return (u_nl_catd) ures_open(name, locale, ec);
+}
+
+U_CAPI void U_EXPORT2
+u_catclose(u_nl_catd catd) {
+    ures_close((UResourceBundle*) catd); /* may be NULL */
+}
+
+U_CAPI const UChar* U_EXPORT2
+u_catgets(u_nl_catd catd, int32_t set_num, int32_t msg_num,
+          const UChar* s,
+          int32_t* len, UErrorCode* ec) {
+
+    UResourceBundle* res;
+    char key[MAX_KEY_LEN];
+    const UChar* result;
+
+    if (ec == NULL || U_FAILURE(*ec)) {
+        goto ERROR;
+    }
+
+    res = ures_getByKey((const UResourceBundle*) catd,
+                        _catkey(key, set_num, TRUE),
+                        NULL, ec);
+    if (U_FAILURE(*ec)) {
+        goto ERROR;
+    }
+
+    result = ures_getStringByKey(res,
+                                 _catkey(key, msg_num, FALSE),
+                                 len, ec);
+    ures_close(res);
+
+    if (U_FAILURE(*ec)) {
+        goto ERROR;
+    }
+
+    return result;
+
+ ERROR:
+    /* In case of any failure, return s */
+    if (len != NULL) {
+        *len = u_strlen(s);
+    }
+    return s;
+}
+
+/*eof*/

icu4c/source/common/unicode/ucat.h

@@ -0,0 +1,106 @@
+/*
+**********************************************************************
+* Copyright (c) 2003, International Business Machines
+* Corporation and others.  All Rights Reserved.
+**********************************************************************
+* Author: Alan Liu
+* Created: March 19 2003
+* Since: ICU 2.6
+**********************************************************************
+*/
+#ifndef UCAT_H
+#define UCAT_H
+
+#include "unicode/utypes.h"
+#include "unicode/ures.h"
+
+U_CDECL_BEGIN
+
+/**
+ * An ICU message catalog descriptor, analogous to nl_catd.
+ * 
+ * @draft ICU 2.6
+ */
+typedef UResourceBundle* u_nl_catd;
+
+/**
+ * Open and return an ICU message catalog descriptor. The descriptor
+ * may be passed to u_catgets() to retrieve localized strings.
+ *
+ * @param name string containing the full path pointing to the
+ * directory where the resources reside followed by the package name
+ * e.g. "/usr/resource/my_app/resources/guimessages" on a Unix system.
+ * If NULL, ICU default data files will be used.
+ *
+ * @param locale the locale for which we want to open the resource. If
+ * NULL, the default locale will be used. If strlen(locale) == 0, the
+ * root locale will be used.
+ *
+ * @param ec input/output error code. Upon output,
+ * U_USING_FALLBACK_WARNING indicates that a fallback locale was
+ * used. For example, 'de_CH' was requested, but nothing was found
+ * there, so 'de' was used. U_USING_DEFAULT_WARNING indicates that the
+ * default locale data or root locale data was used; neither the
+ * requested locale nor any of its fallback locales were found.
+ *
+ * @return a message catalog descriptor that may be passed to
+ * u_catgets(). If the ec parameter indicates success, then the caller
+ * is responsible for calling u_catclose() to close the message
+ * catalog. If the ec parameter indicates failure, then NULL will be
+ * returned.
+ * 
+ * @draft ICU 2.6
+ */
+U_CAPI u_nl_catd U_EXPORT2
+u_catopen(const char* name, const char* locale, UErrorCode* ec);
+
+/**
+ * Close an ICU message catalog, given its descriptor.
+ *
+ * @param catd a message catalog descriptor to be closed. May be NULL,
+ * in which case no action is taken.
+ * 
+ * @draft ICU 2.6
+ */
+U_CAPI void U_EXPORT2
+u_catclose(u_nl_catd catd);
+
+/**
+ * Retrieve a localized string from an ICU message catalog.
+ *
+ * @param catd a message catalog descriptor returned by u_catopen.
+ *
+ * @param set_num the message catalog set number. Sets need not be
+ * numbered consecutively.
+ *
+ * @param msg_num the message catalog message number within the
+ * set. Messages need not be numbered consecutively.
+ *
+ * @param s the default string. This is returned if the string
+ * specified by the set_num and msg_num is not found. It must be
+ * zero-terminated.
+ *
+ * @param len fill-in parameter to receive the length of the result.
+ * May be NULL, in which case it is ignored.
+ *
+ * @param ec input/output error code. May be U_USING_FALLBACK_WARNING
+ * or U_USING_DEFAULT_WARNING. U_MISSING_RESOURCE_ERROR indicates that
+ * the set_num/msg_num tuple does not specify a valid message string
+ * in this catalog.
+ *
+ * @return a pointer to a zero-terminated UChar array which lives in
+ * an internal buffer area, typically a memory mapped/DLL file. The
+ * caller must NOT delete this pointer. If the call is unsuccessful
+ * for any reason, then s is returned.
+ * 
+ * @draft ICU 2.6
+ */
+U_CAPI const UChar* U_EXPORT2
+u_catgets(u_nl_catd catd, int32_t set_num, int32_t msg_num,
+          const UChar* s,
+          int32_t* len, UErrorCode* ec);
+
+U_CDECL_END
+
+#endif /*UCAT_H*/
+/*eof*/

icu4c/source/test/cintltst/Makefile.in

@@ -41,7 +41,7 @@ OBJECTS = callcoll.o calltest.o capitst.o cbiapts.o cbkittst.o \
 ccaltst.o ccapitst.o ccolltst.o cconvtst.o ccurrtst.o cdantst.o	\
 cdattst.o cdetst.o cdtdptst.o cdtrgtst.o cestst.o cfintst.o cformtst.o \
 cfrtst.o cg7coll.o chashtst.o cintltst.o citertst.o cjaptst.o cloctst.o \
-cmsccoll.o cmsgtst.o \
+cmsccoll.o cmsgtst.o cposxtst.o \
 cnmdptst.o cnormtst.o cnumtst.o cregrtst.o crestst.o creststn.o cturtst.o \
 cucdtst.o custrtst.o cstrcase.o cutiltst.o encoll.o nucnvtst.o nccbtst.o bocu1tst.o \
 cbiditst.o cbididat.o eurocreg.o udatatst.o utf16tst.o utransts.o \

icu4c/source/test/cintltst/cintltst.dsp

@@ -478,6 +478,10 @@ SOURCE=.\cloctst.h
 # End Source File
 # Begin Source File
 
+SOURCE=.\cposxtst.c
+# End Source File
+# Begin Source File
+
 SOURCE=.\crestst.c
 # End Source File
 # Begin Source File

icu4c/source/test/cintltst/cposxtst.c

@@ -0,0 +1,100 @@
+/*
+**********************************************************************
+* Copyright (c) 2003, International Business Machines
+* Corporation and others.  All Rights Reserved.
+**********************************************************************
+* Author: Alan Liu
+* Created: March 20 2003
+* Since: ICU 2.6
+**********************************************************************
+*/
+#include "cintltst.h"
+#include "cmemory.h"
+#include "cstring.h"
+#include "unicode/ucat.h"
+#include "unicode/ustring.h"
+
+/**********************************************************************/
+/* Prototypes */
+
+void TestMessageCatalog(void);
+
+/**********************************************************************/
+/* Add our tests into the hierarchy */
+
+void addPosixTest(TestNode** root)
+{
+    addTest(root, &TestMessageCatalog, "tsutil/cposxtst/TestMessageCatalog");
+}
+
+/**********************************************************************/
+/* Test basic ucat.h API */
+
+void TestMessageCatalog(void) {
+
+    UErrorCode ec = U_ZERO_ERROR;
+    u_nl_catd catd;
+    const char* DATA[] = {
+        /* set_num, msg_num, expected string result, expected error code */
+        "1", "1", "FAIL", "U_MISSING_RESOURCE_ERROR",
+        "19006", "4", "Miranda", "U_ZERO_ERROR",
+        "19006", "24", "Laura", "U_ZERO_ERROR",
+        "19006", "99", "FAIL", "U_MISSING_RESOURCE_ERROR",
+        "20014", "5", "Ava", "U_ZERO_ERROR",
+        "20014", "99", "FAIL", "U_MISSING_RESOURCE_ERROR",
+        NULL
+    };
+    const UChar FAIL[] = {0x46, 0x41, 0x49, 0x4C, 0x00}; /* "FAIL" */
+    int32_t i;
+    const char *path = loadTestData(&ec);
+ 
+    if (U_FAILURE(ec)) {
+        log_err("FAIL: loadTestData => %s\n", u_errorName(ec));
+        return;
+    }
+
+    catd = u_catopen(path, "mc", &ec);
+    if (U_FAILURE(ec)) {
+        log_err("FAIL: u_catopen => %s\n", u_errorName(ec));
+        return;
+    }
+
+    for (i=0; DATA[i]!=NULL; i+=4) {
+        int32_t set_num = T_CString_stringToInteger(DATA[i], 10);
+        int32_t msg_num = T_CString_stringToInteger(DATA[i+1], 10);
+        UChar exp[128];
+        int32_t len = -1;
+        const char* err;
+        char str[128];
+        const UChar* ustr;
+
+        u_uastrcpy(exp, DATA[i+2]);
+
+        ec = U_ZERO_ERROR;
+        ustr = u_catgets(catd, set_num, msg_num, FAIL, &len, &ec);
+        u_austrcpy(str, ustr);
+        err = u_errorName(ec);
+        
+        log_verbose("u_catgets(%d, %d) => %s, len=%d, %s\n",
+                    set_num, msg_num, str, len, err);
+
+        if (uprv_strcmp(err, DATA[i+3]) != 0) {
+            log_err("FAIL: u_catgets => %s, exp. %s\n",
+                    err, DATA[i+3]);
+        }
+
+        if (u_strcmp(ustr, exp) != 0) {
+            log_err("FAIL: u_catgets => %s, exp. %s\n",
+                    str, DATA[i+2]);
+        }
+
+        if (len != (int32_t) uprv_strlen(DATA[i+2])) {
+            log_err("FAIL: u_catgets => len=%s, exp. %s\n",
+                    len, uprv_strlen(DATA[i+2]));
+        }
+    }
+
+    u_catclose(catd);
+}
+
+/*eof*/

icu4c/source/test/cintltst/cutiltst.c

@@ -24,6 +24,7 @@ void addCStringTest(TestNode** root);
 void addMemoryStreamTest(TestNode** root);
 void addTrieTest(TestNode** root);
 void addEnumerationTest(TestNode** root);
+void addPosixTest(TestNode** root);
 
 void addUtility(TestNode** root);
 
@@ -39,4 +40,5 @@ void addUtility(TestNode** root)
     addCStringTest(root);
     addMemoryStreamTest(root);
     addEnumerationTest(root);
+    addPosixTest(root);
 }

icu4c/source/test/testdata/mc.txt

@@ -0,0 +1,27 @@
+//--------------------------------------------------------------------
+// Copyright (c) 2003, International Business Machines
+// Corporation and others.  All Rights Reserved.
+//--------------------------------------------------------------------
+// Author: Alan Liu
+// Created: March 20 2003
+// Since: ICU 2.6
+//--------------------------------------------------------------------
+
+// Test locale file for the fake locale 'mc', used to test the
+// ucat.h message catalog API.
+
+mc
+{
+    "%cat%19006"
+    {
+        "4" { "Miranda" }
+        "24" { "Laura" }
+    }
+
+    "%cat%20014"
+    {
+        "5" { "Ava" }
+    }
+}
+
+//eof

icu4c/source/test/testdata/testdata.mk

@@ -14,11 +14,12 @@ TESTDT=$(TESTPKG)_
 ALL : "$(TESTDATAOUT)\testdata.dat" 
 	@echo Test data is built.
 
-"$(TESTDATAOUT)\testdata.dat" : "$(TESTDATABLD)\casing.res" "$(TESTDATABLD)\root.res" "$(TESTDATABLD)\te.res" "$(TESTDATABLD)\te_IN.res" "$(TESTDATABLD)\testaliases.res" "$(TESTDATABLD)\testtypes.res" "$(TESTDATABLD)\testempty.res" "$(TESTDATABLD)\iscii.res" "$(TESTDATABLD)\idna_rules.res" "$(TESTDATABLD)\DataDrivenCollationTest.res" $(TESTDATABLD)\testdata_test.icu "$(TESTDATABLD)\testdata_test1.cnv" "$(TESTDATABLD)\testdata_test3.cnv" "$(TESTDATABLD)\testdata_test4.cnv"
+"$(TESTDATAOUT)\testdata.dat" : "$(TESTDATABLD)\casing.res" "$(TESTDATABLD)\mc.res" "$(TESTDATABLD)\root.res" "$(TESTDATABLD)\te.res" "$(TESTDATABLD)\te_IN.res" "$(TESTDATABLD)\testaliases.res" "$(TESTDATABLD)\testtypes.res" "$(TESTDATABLD)\testempty.res" "$(TESTDATABLD)\iscii.res" "$(TESTDATABLD)\idna_rules.res" "$(TESTDATABLD)\DataDrivenCollationTest.res" $(TESTDATABLD)\testdata_test.icu "$(TESTDATABLD)\testdata_test1.cnv" "$(TESTDATABLD)\testdata_test3.cnv" "$(TESTDATABLD)\testdata_test4.cnv"
 	@echo Building test data
 	@copy "$(TESTDATABLD)\testdata_te.res" "$(TESTDATAOUT)\testdata_nam.typ"
 	@"$(ICUTOOLS)\pkgdata\$(CFG)\pkgdata" -f -v -m common -c -p"$(TESTPKG)"  -O "$(PKGOPT)" -d "$(TESTDATAOUT)" -T "$(TESTDATABLD)" -s "$(TESTDATABLD)" <<
 testdata_casing.res
+testdata_mc.res
 testdata_root.res
 testdata_te.res
 testdata_te_IN.res