ICU 55.1 55.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
messagepattern.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2011-2013, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 *******************************************************************************
6 * file name: messagepattern.h
7 * encoding: US-ASCII
8 * tab size: 8 (not used)
9 * indentation:4
10 *
11 * created on: 2011mar14
12 * created by: Markus W. Scherer
13 */
14
15 #ifndef __MESSAGEPATTERN_H__
16 #define __MESSAGEPATTERN_H__
17
23 #include "unicode/utypes.h"
24
25 #if !UCONFIG_NO_FORMATTING
26
27 #include "unicode/parseerr.h"
28 #include "unicode/unistr.h"
29
66 enum UMessagePatternApostropheMode {
78 UMSGPAT_APOS_DOUBLE_OPTIONAL,
87 UMSGPAT_APOS_DOUBLE_REQUIRED
88 };
92 typedef enum UMessagePatternApostropheMode UMessagePatternApostropheMode;
93
98 enum UMessagePatternPartType {
108 UMSGPAT_PART_TYPE_MSG_START,
117 UMSGPAT_PART_TYPE_MSG_LIMIT,
125 UMSGPAT_PART_TYPE_SKIP_SYNTAX,
132 UMSGPAT_PART_TYPE_INSERT_CHAR,
140 UMSGPAT_PART_TYPE_REPLACE_NUMBER,
151 UMSGPAT_PART_TYPE_ARG_START,
158 UMSGPAT_PART_TYPE_ARG_LIMIT,
163 UMSGPAT_PART_TYPE_ARG_NUMBER,
169 UMSGPAT_PART_TYPE_ARG_NAME,
175 UMSGPAT_PART_TYPE_ARG_TYPE,
181 UMSGPAT_PART_TYPE_ARG_STYLE,
187 UMSGPAT_PART_TYPE_ARG_SELECTOR,
194 UMSGPAT_PART_TYPE_ARG_INT,
202 UMSGPAT_PART_TYPE_ARG_DOUBLE
203 };
207 typedef enum UMessagePatternPartType UMessagePatternPartType;
208
217 enum UMessagePatternArgType {
222 UMSGPAT_ARG_TYPE_NONE,
228 UMSGPAT_ARG_TYPE_SIMPLE,
234 UMSGPAT_ARG_TYPE_CHOICE,
244 UMSGPAT_ARG_TYPE_PLURAL,
249 UMSGPAT_ARG_TYPE_SELECT,
255 UMSGPAT_ARG_TYPE_SELECTORDINAL
256 };
260 typedef enum UMessagePatternArgType UMessagePatternArgType;
261
268 #define UMSGPAT_ARG_TYPE_HAS_PLURAL_STYLE(argType) \
269 ((argType)==UMSGPAT_ARG_TYPE_PLURAL || (argType)==UMSGPAT_ARG_TYPE_SELECTORDINAL)
270
271 enum {
277 UMSGPAT_ARG_NAME_NOT_NUMBER=-1,
278
286 UMSGPAT_ARG_NAME_NOT_VALID=-2
287 };
288
295 #define UMSGPAT_NO_NUMERIC_VALUE ((double)(-123456789))
296
297 U_NAMESPACE_BEGIN
298
299 class MessagePatternDoubleList;
300 class MessagePatternPartsList;
301
358 class U_COMMON_API MessagePattern : public UObject {
359 public:
368 MessagePattern(UErrorCode &errorCode);
369
379 MessagePattern(UMessagePatternApostropheMode mode, UErrorCode &errorCode);
380
399 MessagePattern(const UnicodeString &pattern, UParseError *parseError, UErrorCode &errorCode);
400
406 MessagePattern(const MessagePattern &other);
407
414 MessagePattern &operator=(const MessagePattern &other);
415
420 virtual ~MessagePattern();
421
439 MessagePattern &parse(const UnicodeString &pattern,
440 UParseError *parseError, UErrorCode &errorCode);
441
459 MessagePattern &parseChoiceStyle(const UnicodeString &pattern,
460 UParseError *parseError, UErrorCode &errorCode);
461
479 MessagePattern &parsePluralStyle(const UnicodeString &pattern,
480 UParseError *parseError, UErrorCode &errorCode);
481
499 MessagePattern &parseSelectStyle(const UnicodeString &pattern,
500 UParseError *parseError, UErrorCode &errorCode);
501
507 void clear();
508
515 void clearPatternAndSetApostropheMode(UMessagePatternApostropheMode mode) {
516 clear();
517 aposMode=mode;
518 }
519
525 UBool operator==(const MessagePattern &other) const;
526
532 inline UBool operator!=(const MessagePattern &other) const {
533 return !operator==(other);
534 }
535
540 int32_t hashCode() const;
541
546 UMessagePatternApostropheMode getApostropheMode() const {
547 return aposMode;
548 }
549
550 // Java has package-private jdkAposMode() here.
551 // In C++, this is declared in the MessageImpl class.
552
557 const UnicodeString &getPatternString() const {
558 return msg;
559 }
560
566 UBool hasNamedArguments() const {
567 return hasArgNames;
568 }
569
575 UBool hasNumberedArguments() const {
576 return hasArgNumbers;
577 }
578
590 static int32_t validateArgumentName(const UnicodeString &name);
591
602 UnicodeString autoQuoteApostropheDeep() const;
603
604 class Part;
605
612 int32_t countParts() const {
613 return partsLength;
614 }
615
622 const Part &getPart(int32_t i) const {
623 return parts[i];
624 }
625
633 UMessagePatternPartType getPartType(int32_t i) const {
634 return getPart(i).type;
635 }
636
644 int32_t getPatternIndex(int32_t partIndex) const {
645 return getPart(partIndex).index;
646 }
647
655 UnicodeString getSubstring(const Part &part) const {
656 return msg.tempSubString(part.index, part.length);
657 }
658
666 UBool partSubstringMatches(const Part &part, const UnicodeString &s) const {
667 return 0==msg.compare(part.index, part.length, s);
668 }
669
676 double getNumericValue(const Part &part) const;
677
684 double getPluralOffset(int32_t pluralStart) const;
685
694 int32_t getLimitPartIndex(int32_t start) const {
695 int32_t limit=getPart(start).limitPartIndex;
696 if(limit<start) {
697 return start;
698 }
699 return limit;
700 }
701
709 class Part : public UMemory {
710 public:
715 Part() {}
716
722 UMessagePatternPartType getType() const {
723 return type;
724 }
725
731 int32_t getIndex() const {
732 return index;
733 }
734
741 int32_t getLength() const {
742 return length;
743 }
744
751 int32_t getLimit() const {
752 return index+length;
753 }
754
761 int32_t getValue() const {
762 return value;
763 }
764
771 UMessagePatternArgType getArgType() const {
772 UMessagePatternPartType type=getType();
773 if(type==UMSGPAT_PART_TYPE_ARG_START || type==UMSGPAT_PART_TYPE_ARG_LIMIT) {
774 return (UMessagePatternArgType)value;
775 } else {
776 return UMSGPAT_ARG_TYPE_NONE;
777 }
778 }
779
787 static UBool hasNumericValue(UMessagePatternPartType type) {
788 return type==UMSGPAT_PART_TYPE_ARG_INT || type==UMSGPAT_PART_TYPE_ARG_DOUBLE;
789 }
790
796 UBool operator==(const Part &other) const;
797
803 inline UBool operator!=(const Part &other) const {
804 return !operator==(other);
805 }
806
811 int32_t hashCode() const {
812 return ((type*37+index)*37+length)*37+value;
813 }
814
815 private:
816 friend class MessagePattern;
817
818 static const int32_t MAX_LENGTH=0xffff;
819 static const int32_t MAX_VALUE=0x7fff;
820
821 // Some fields are not final because they are modified during pattern parsing.
822 // After pattern parsing, the parts are effectively immutable.
823 UMessagePatternPartType type;
824 int32_t index;
825 uint16_t length;
826 int16_t value;
827 int32_t limitPartIndex;
828 };
829
830 private:
831 void preParse(const UnicodeString &pattern, UParseError *parseError, UErrorCode &errorCode);
832
833 void postParse();
834
835 int32_t parseMessage(int32_t index, int32_t msgStartLength,
836 int32_t nestingLevel, UMessagePatternArgType parentType,
837 UParseError *parseError, UErrorCode &errorCode);
838
839 int32_t parseArg(int32_t index, int32_t argStartLength, int32_t nestingLevel,
840 UParseError *parseError, UErrorCode &errorCode);
841
842 int32_t parseSimpleStyle(int32_t index, UParseError *parseError, UErrorCode &errorCode);
843
844 int32_t parseChoiceStyle(int32_t index, int32_t nestingLevel,
845 UParseError *parseError, UErrorCode &errorCode);
846
847 int32_t parsePluralOrSelectStyle(UMessagePatternArgType argType, int32_t index, int32_t nestingLevel,
848 UParseError *parseError, UErrorCode &errorCode);
849
858 static int32_t parseArgNumber(const UnicodeString &s, int32_t start, int32_t limit);
859
860 int32_t parseArgNumber(int32_t start, int32_t limit) {
861 return parseArgNumber(msg, start, limit);
862 }
863
872 void parseDouble(int32_t start, int32_t limit, UBool allowInfinity,
873 UParseError *parseError, UErrorCode &errorCode);
874
875 // Java has package-private appendReducedApostrophes() here.
876 // In C++, this is declared in the MessageImpl class.
877
878 int32_t skipWhiteSpace(int32_t index);
879
880 int32_t skipIdentifier(int32_t index);
881
886 int32_t skipDouble(int32_t index);
887
888 static UBool isArgTypeChar(UChar32 c);
889
890 UBool isChoice(int32_t index);
891
892 UBool isPlural(int32_t index);
893
894 UBool isSelect(int32_t index);
895
896 UBool isOrdinal(int32_t index);
897
902 UBool inMessageFormatPattern(int32_t nestingLevel);
903
908 UBool inTopLevelChoiceMessage(int32_t nestingLevel, UMessagePatternArgType parentType);
909
910 void addPart(UMessagePatternPartType type, int32_t index, int32_t length,
911 int32_t value, UErrorCode &errorCode);
912
913 void addLimitPart(int32_t start,
914 UMessagePatternPartType type, int32_t index, int32_t length,
915 int32_t value, UErrorCode &errorCode);
916
917 void addArgDoublePart(double numericValue, int32_t start, int32_t length, UErrorCode &errorCode);
918
919 void setParseError(UParseError *parseError, int32_t index);
920
921 UBool init(UErrorCode &errorCode);
922 UBool copyStorage(const MessagePattern &other, UErrorCode &errorCode);
923
924 UMessagePatternApostropheMode aposMode;
925 UnicodeString msg;
926 // ArrayList<Part> parts=new ArrayList<Part>();
927 MessagePatternPartsList *partsList;
928 Part *parts;
929 int32_t partsLength;
930 // ArrayList<Double> numericValues;
931 MessagePatternDoubleList *numericValuesList;
932 double *numericValues;
933 int32_t numericValuesLength;
934 UBool hasArgNames;
935 UBool hasArgNumbers;
936 UBool needsAutoQuoting;
937 };
938
939 U_NAMESPACE_END
940
941 #endif // !UCONFIG_NO_FORMATTING
942
943 #endif // __MESSAGEPATTERN_H__