ICU-461.12.tar.gz

[apple/icu.git] / icuSources / test / intltest / fldset.h

diff --git a/icuSources/test/intltest/fldset.h b/icuSources/test/intltest/fldset.h
index d471b026c196c19d5568cf9872275544118c4c2c..0c9747b44c608cce1fd5d523b88deac326e4a849 100644 (file)
--- a/icuSources/test/intltest/fldset.h
+++ b/icuSources/test/intltest/fldset.h
@@ -1,6 +1,6 @@
 /*
 ************************************************************************
 /*
 ************************************************************************

-* Copyright (c) 2007, International Business Machines
+* Copyright (c) 2007-2010, International Business Machines

 * Corporation and others.  All Rights Reserved.
 ************************************************************************
 */
 * Corporation and others.  All Rights Reserved.
 ************************************************************************
 */


@@ -13,48 +13,86 @@
 #include "unicode/calendar.h"
 #include "unicode/ucal.h"
 #include "unicode/udat.h"
 #include "unicode/calendar.h"
 #include "unicode/ucal.h"
 #include "unicode/udat.h"

-#include "unicode/udbgutil.h"
-#include "unicode/dbgutil.h"
+#include "udbgutil.h"
+#include "dbgutil.h"

 #include "unicode/unistr.h"
 
 #define U_FIELDS_SET_MAX  64
 
 #include "unicode/unistr.h"
 
 #define U_FIELDS_SET_MAX  64
 

+/**
+ * This class represents a collection of integer values (fields), each designated by
+ * one of a particular set of enum values.  Each integer value (int32_t) is optional and
+ * may or may not be set. 
+ * 
+ * @internal ICU 3.8
+ */

 class FieldsSet {
     protected:
         /**
 class FieldsSet {
     protected:
         /**

-         * subclass interface
-         * @param whichEnum which enumaration value goes with this set. Will be used to calculate str values and also enum size.
+         * subclass interface - construct the FieldsSet to reference one of the standard
+         * enumerations.
+         * @param whichEnum which enumaration value goes with this set. Will be used to calculate string
+         * values and also enum size.
+         * @see UDebugEnumType

          */
         FieldsSet(UDebugEnumType whichEnum);
         
         /**
          */
         FieldsSet(UDebugEnumType whichEnum);
         
         /**

-         * subclass interface - no enum tie-in
-         * @param fieldCount how many fields this can hold.
+         * subclass interface - construct the FieldsSet without using a standard enum type.
+         * @param fieldCount how many fields this object can hold.

          */
         FieldsSet(int32_t fieldsCount);
 
     public:
          */
         FieldsSet(int32_t fieldsCount);
 
     public:

+    

       /**
       /**

-       * @param other "expected" set to match against
-       * @param status - will return invalid argument if sets are not the same size
+       * Compare two sets. In typical test usage, 'this' is the resul of 
+       * a tested operation, and 'other' is the predefined expected value.
+       * 
+       * @param other the set to compare against.
+       * @param status will return U_ILLEGAL_ARGUMENT_ERROR if sets are not the same size

        * @return a formatted string listing which fields are set in 
        *   this, with the comparison made agaainst those fields in other.
        */
        * @return a formatted string listing which fields are set in 
        *   this, with the comparison made agaainst those fields in other.
        */

-      UnicodeString diffFrom(const FieldsSet& other, UErrorCode &status) const;
-      
+      U_NAMESPACE_QUALIFIER UnicodeString diffFrom(const FieldsSet& other, UErrorCode &status) const;
+

     public:
       /**
     public:
       /**

+       * Fill-in fields from a specified string, such as "NAME1=VALUE1,NAME2=VALUE2", etc. 

        * @param str string to parse
        * @param str string to parse

-       * @param status formatted string for status
+       * @param status status of parse
+       * @return the number of valid parsed fields on success, or a negative number on failure.

        */
        */

-      int32_t parseFrom(const UnicodeString& str, UErrorCode& status) { return parseFrom(str,NULL,status); }
-      
-    public:
-      int32_t parseFrom(const UnicodeString& str, const FieldsSet& inheritFrom, UErrorCode& status) { return parseFrom(str, &inheritFrom, status); }
-      
-      int32_t parseFrom(const UnicodeString& str, const 
-              FieldsSet* inheritFrom, UErrorCode& status);
-      
+      int32_t parseFrom(const U_NAMESPACE_QUALIFIER UnicodeString& str, UErrorCode& status) {
+          return parseFrom(str,NULL,status);
+      }
+
+      /**
+       * Fill-in fields from a specified string, such as "NAME1=VALUE1,NAME2=VALUE2", etc. 
+       * @param inheritFrom if a field's value is given as 0-length, such as NAME1 in "NAME1=,NAME2=VALUE2", 
+       * the specified FieldsSet's value for NAME1 will be copied into this.
+       * @param str string to parse
+       * @param status status of parse
+       * @return the number of valid parsed fields on success, or a negative number on failure.
+       */
+      int32_t parseFrom(const U_NAMESPACE_QUALIFIER UnicodeString& str,
+                        const FieldsSet& inheritFrom,
+                        UErrorCode& status) {
+          return parseFrom(str, &inheritFrom, status);
+      }
+
+      /**
+       * Fill-in fields from a specified string, such as "NAME1=VALUE1,NAME2=VALUE2", etc. 
+       * @param inheritFrom if a field's value is given as 0-length, such as NAME1 in "NAME1=,NAME2=VALUE2", 
+       * the specified FieldsSet's value for NAME1 will be copied into this.
+       * @param str string to parse
+       * @param status status of parse
+       * @return the number of valid parsed fields on success, or a negative number on failure.
+       */
+      int32_t parseFrom(const U_NAMESPACE_QUALIFIER UnicodeString& str,
+                        const FieldsSet* inheritFrom,
+                        UErrorCode& status);
+

     protected:
       /**
        * Callback interface for subclass.
     protected:
       /**
        * Callback interface for subclass.


@@ -70,7 +108,10 @@ class FieldsSet {
        * @param status error status - set to error for failure.
        * @return field number, or negative if field should be skipped.
        */
        * @param status error status - set to error for failure.
        * @return field number, or negative if field should be skipped.
        */

-      virtual int32_t handleParseName(const FieldsSet* inheritFrom, const UnicodeString& name, const UnicodeString& substr, UErrorCode& status);
+      virtual int32_t handleParseName(const FieldsSet* inheritFrom,
+                                      const U_NAMESPACE_QUALIFIER UnicodeString& name,
+                                      const U_NAMESPACE_QUALIFIER UnicodeString& substr,
+                                      UErrorCode& status);

 
       /**
        * Callback interface for subclass.
 
       /**
        * Callback interface for subclass.


@@ -81,15 +122,21 @@ class FieldsSet {
        * @param status error status - set to error for failure.
        * @see parseValueDefault
        */
        * @param status error status - set to error for failure.
        * @see parseValueDefault
        */

-      virtual void handleParseValue(const FieldsSet* inheritFrom, int32_t field, const UnicodeString& substr, UErrorCode& status);
-                
+      virtual void handleParseValue(const FieldsSet* inheritFrom,
+                                    int32_t field,
+                                    const U_NAMESPACE_QUALIFIER UnicodeString& substr,
+                                    UErrorCode& status);
+

       /**
        * the default implementation for handleParseValue.
        * Base implementation is to parse a decimal integer value, or inherit from inheritFrom if the string is 0-length.
        * Implementations of this function should call set(field,...) on successful parse.
        * @see handleParseValue
        */
       /**
        * the default implementation for handleParseValue.
        * Base implementation is to parse a decimal integer value, or inherit from inheritFrom if the string is 0-length.
        * Implementations of this function should call set(field,...) on successful parse.
        * @see handleParseValue
        */

-      void parseValueDefault(const FieldsSet* inheritFrom, int32_t field, const UnicodeString& substr, UErrorCode& status);      
+      void parseValueDefault(const FieldsSet* inheritFrom,
+                             int32_t field,
+                             const U_NAMESPACE_QUALIFIER UnicodeString& substr,
+                             UErrorCode& status);      

 
 
       /**
 
 
       /**


@@ -98,26 +145,68 @@ class FieldsSet {
        * if fails, will call parseValueDefault()
        * @see handleParseValue
        */
        * if fails, will call parseValueDefault()
        * @see handleParseValue
        */

-      void parseValueEnum(UDebugEnumType type, const FieldsSet* inheritFrom, int32_t field, const UnicodeString& substr, UErrorCode& status);
+      void parseValueEnum(UDebugEnumType type,
+                          const FieldsSet* inheritFrom,
+                          int32_t field,
+                          const U_NAMESPACE_QUALIFIER UnicodeString& substr,
+                          UErrorCode& status);

 
     private:
 
     private:

+      /** 
+       * Not callable - construct a default FieldsSet
+       * @internal
+       */

       FieldsSet();
       
       FieldsSet();
       

+      /**
+       * construct the object.
+       * @internal
+       */

       void construct(UDebugEnumType whichEnum, int32_t fieldCount);
 
     public:
       void construct(UDebugEnumType whichEnum, int32_t fieldCount);
 
     public:

+    /**
+     * destructor
+     */

      virtual ~FieldsSet();
      virtual ~FieldsSet();

-    
+
+    /**
+     * Mark all fields as unset
+     */

     void clear();
     void clear();

+    
+    /**
+     * Mark a specific field as unset
+     * @param field the field to unset
+     */

     void clear(int32_t field);
     void clear(int32_t field);

-    void set(int32_t field, int32_t amount);
+    
+    /**
+     * Set a specific field
+     * @param field the field to set (i.e. enum value)
+     * @param value the field's value
+     */
+    void set(int32_t field, int32_t value);
+    

     UBool isSet(int32_t field) const;
     UBool isSet(int32_t field) const;

+
+    /**
+     * Return the field's value
+     * @param field which field
+     * @return field's value, or -1 if unset.
+     */

     int32_t get(int32_t field) const;
     
     int32_t get(int32_t field) const;
     

+    /**
+     * Return true if both FieldsSet objects either are based on the same enum, or have the same number of fields.
+     */

     UBool isSameType(const FieldsSet& other) const;
     UBool isSameType(const FieldsSet& other) const;

+
+    /**
+     * @return the number of fields 
+     */

     int32_t fieldCount() const;
     
     int32_t fieldCount() const;
     

-    

     protected:
        int32_t fValue[U_FIELDS_SET_MAX];
        UBool fIsSet[U_FIELDS_SET_MAX];
     protected:
        int32_t fValue[U_FIELDS_SET_MAX];
        UBool fIsSet[U_FIELDS_SET_MAX];


@@ -126,11 +215,14 @@ class FieldsSet {
        UDebugEnumType fEnum;
 };
 
        UDebugEnumType fEnum;
 };
 

-/** ------- Calendar Fields Set -------- **/
+/**
+ * A subclass of FieldsSet representing the fields in a Calendar
+ * @see Calendar
+ */

 class CalendarFieldsSet : public FieldsSet {
 class CalendarFieldsSet : public FieldsSet {

-    public:
-        CalendarFieldsSet();
-        virtual ~CalendarFieldsSet();
+public:
+    CalendarFieldsSet();
+    virtual ~CalendarFieldsSet();

 
 //        void clear(UCalendarDateFields field) { clear((int32_t)field); }
 //        void set(UCalendarDateFields field, int32_t amount) { set ((int32_t)field, amount); }
 
 //        void clear(UCalendarDateFields field) { clear((int32_t)field); }
 //        void set(UCalendarDateFields field, int32_t amount) { set ((int32_t)field, amount); }


@@ -138,33 +230,43 @@ class CalendarFieldsSet : public FieldsSet {
 //        UBool isSet(UCalendarDateFields field) const { return isSet((int32_t)field); }
 //        int32_t get(UCalendarDateFields field) const { return get((int32_t)field); }
 
 //        UBool isSet(UCalendarDateFields field) const { return isSet((int32_t)field); }
 //        int32_t get(UCalendarDateFields field) const { return get((int32_t)field); }
 

-        /**
-         * @param matches fillin to hold any fields different. Will have the calendar's value set on them.
-         * @return true if the calendar matches in these fields.
-         */
-        UBool matches(Calendar *cal, CalendarFieldsSet &diffSet,
-                UErrorCode& status) const;
-
-        /**
-         * set the specified fields on this calendar. Doesn't clear first. Returns any errors the cale 
-         */
-        void setOnCalendar(Calendar *cal, UErrorCode& status) const;
+    /**
+     * @param matches fillin to hold any fields different. Will have the calendar's value set on them.
+     * @return true if the calendar matches in these fields.
+     */
+    UBool matches(U_NAMESPACE_QUALIFIER Calendar *cal,
+                  CalendarFieldsSet &diffSet,
+                  UErrorCode& status) const;

 
 

+    /**
+     * For each set field, set the same field on this Calendar.
+     * Doesn't clear the Calendar first.
+     * @param cal Calendar to modify
+     * @param status Contains any errors propagated by the Calendar.
+     */
+    void setOnCalendar(U_NAMESPACE_QUALIFIER Calendar *cal, UErrorCode& status) const;

         
         

-    protected:
-        void handleParseValue(const FieldsSet* inheritFrom, int32_t field, const UnicodeString& substr, UErrorCode& status);
+protected:
+    /**
+     * subclass override 
+     */
+    void handleParseValue(const FieldsSet* inheritFrom,
+                          int32_t field,
+                          const U_NAMESPACE_QUALIFIER UnicodeString& substr,
+                          UErrorCode& status);

 };
 
 /**
  * This class simply implements a set of date and time styles
 };
 
 /**
  * This class simply implements a set of date and time styles

- * such as DATE=SHORT  or TIME=SHORT,DATE=LONG
+ * such as DATE=SHORT  or TIME=SHORT,DATE=LONG, such as would be passed
+ * to DateFormat::createInstance()
+ * @see DateFormat

  */
 class DateTimeStyleSet : public FieldsSet {
     public:
         DateTimeStyleSet();
         virtual ~DateTimeStyleSet();
 
  */
 class DateTimeStyleSet : public FieldsSet {
     public:
         DateTimeStyleSet();
         virtual ~DateTimeStyleSet();
 

-        

         /** 
          * @return the date style, or UDAT_NONE if not set
          */
         /** 
          * @return the date style, or UDAT_NONE if not set
          */


@@ -174,11 +276,15 @@ class DateTimeStyleSet : public FieldsSet {
          * @return the time style, or UDAT_NONE if not set
          */
         UDateFormatStyle getTimeStyle() const;
          * @return the time style, or UDAT_NONE if not set
          */
         UDateFormatStyle getTimeStyle() const;

-
-        

     protected:
     protected:

-        void handleParseValue(const FieldsSet* inheritFrom, int32_t field, const UnicodeString& substr, UErrorCode& status);
-        int32_t handleParseName(const FieldsSet* inheritFrom, const UnicodeString& name, const UnicodeString& substr, UErrorCode& status);
+        void handleParseValue(const FieldsSet* inheritFrom,
+                              int32_t field,
+                              const U_NAMESPACE_QUALIFIER UnicodeString& substr,
+                              UErrorCode& status);
+        int32_t handleParseName(const FieldsSet* inheritFrom,
+                                const U_NAMESPACE_QUALIFIER UnicodeString& name,
+                                const U_NAMESPACE_QUALIFIER UnicodeString& substr,
+                                UErrorCode& status);

 };
 
 
 };