ICU-491.11.1.tar.gz

[apple/icu.git] / icuSources / common / patternprops.h

diff --git a/icuSources/common/patternprops.h b/icuSources/common/patternprops.h
new file mode 100644 (file)
index 0000000..0ceab51
--- /dev/null
+++ b/icuSources/common/patternprops.h
@@ -0,0 +1,89 @@
+/*
+*******************************************************************************
+*   Copyright (C) 2011, International Business Machines
+*   Corporation and others.  All Rights Reserved.
+*******************************************************************************
+*   file name:  patternprops.h
+*   encoding:   US-ASCII
+*   tab size:   8 (not used)
+*   indentation:4
+*
+*   created on: 2011mar13
+*   created by: Markus W. Scherer
+*/
+
+#ifndef __PATTERNPROPS_H__
+#define __PATTERNPROPS_H__
+
+#include "unicode/utypes.h"
+
+U_NAMESPACE_BEGIN
+
+/**
+ * Implements the immutable Unicode properties Pattern_Syntax and Pattern_White_Space.
+ * Hardcodes these properties, does not load data, does not depend on other ICU classes.
+ * <p>
+ * Note: Both properties include ASCII as well as non-ASCII, non-Latin-1 code points,
+ * and both properties only include BMP code points (no supplementary ones).
+ * Pattern_Syntax includes some unassigned code points.
+ * <p>
+ * [:Pattern_White_Space:] =
+ *   [\u0009-\u000D\ \u0085\u200E\u200F\u2028\u2029]
+ * <p>
+ * [:Pattern_Syntax:] =
+ *   [!-/\:-@\[-\^`\{-~\u00A1-\u00A7\u00A9\u00AB\u00AC\u00AE
+ *    \u00B0\u00B1\u00B6\u00BB\u00BF\u00D7\u00F7
+ *    \u2010-\u2027\u2030-\u203E\u2041-\u2053\u2055-\u205E
+ *    \u2190-\u245F\u2500-\u2775\u2794-\u2BFF\u2E00-\u2E7F
+ *    \u3001-\u3003\u3008-\u3020\u3030\uFD3E\uFD3F\uFE45\uFE46]
+ * @author mscherer
+ */
+class U_COMMON_API PatternProps {
+public:
+    /**
+     * @return TRUE if c is a Pattern_Syntax code point.
+     */
+    static UBool isSyntax(UChar32 c);
+
+    /**
+     * @return TRUE if c is a Pattern_Syntax or Pattern_White_Space code point.
+     */
+    static UBool isSyntaxOrWhiteSpace(UChar32 c);
+
+    /**
+     * @return TRUE if c is a Pattern_White_Space character.
+     */
+    static UBool isWhiteSpace(UChar32 c);
+
+    /**
+     * Skips over Pattern_White_Space starting at s.
+     * @return The smallest pointer at or after s with a non-white space character.
+     */
+    static const UChar *skipWhiteSpace(const UChar *s, int32_t length);
+
+    /**
+     * @return s except with leading and trailing Pattern_White_Space removed and length adjusted.
+     */
+    static const UChar *trimWhiteSpace(const UChar *s, int32_t &length);
+
+    /**
+     * Tests whether the string contains a "pattern identifier", that is,
+     * whether it contains only non-Pattern_White_Space, non-Pattern_Syntax characters.
+     * @return TRUE if there are no Pattern_White_Space or Pattern_Syntax characters in s.
+     */
+    static UBool isIdentifier(const UChar *s, int32_t length);
+
+    /**
+     * Skips over a "pattern identifier" starting at index s.
+     * @return The smallest pointer at or after s with
+     *         a Pattern_White_Space or Pattern_Syntax character.
+     */
+    static const UChar *skipIdentifier(const UChar *s, int32_t length);
+
+private:
+    PatternProps();  // no constructor: all static methods
+};
+
+U_NAMESPACE_END
+
+#endif  // __PATTERNPROPS_H__