2 * Copyright 2007 ZXing authors
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package com.google.zxing.client.result;
19 import com.google.zxing.Result;
21 import java.util.Hashtable;
22 import java.util.Vector;
25 * <p>Abstract class representing the result of decoding a barcode, as more than
26 * a String -- as some type of structured data. This might be a subclass which represents
27 * a URL, or an e-mail address. {@link #parseResult(com.google.zxing.Result)} will turn a raw
28 * decoded string into the most appropriate type of structured representation.</p>
30 * <p>Thanks to Jeff Griffin for proposing rewrite of these classes that relies less
31 * on exception-based mechanisms during parsing.</p>
35 public abstract class ResultParser {
37 public static ParsedResult parseResult(Result theResult) {
38 // This is a bit messy, but given limited options in MIDP / CLDC, this may well be the simplest
39 // way to go about this. For example, we have no reflection available, really.
40 // Order is important here.
42 if ((result = BookmarkDoCoMoResultParser.parse(theResult)) != null) {
44 } else if ((result = AddressBookDoCoMoResultParser.parse(theResult)) != null) {
46 } else if ((result = EmailDoCoMoResultParser.parse(theResult)) != null) {
48 } else if ((result = AddressBookAUResultParser.parse(theResult)) != null) {
50 } else if ((result = VCardResultParser.parse(theResult)) != null) {
52 } else if ((result = BizcardResultParser.parse(theResult)) != null) {
54 } else if ((result = VEventResultParser.parse(theResult)) != null) {
56 } else if ((result = TelResultParser.parse(theResult)) != null) {
58 } else if ((result = SMSMMSResultParser.parse(theResult)) != null) {
60 } else if ((result = GeoResultParser.parse(theResult)) != null) {
62 } else if ((result = URLTOResultParser.parse(theResult)) != null) {
64 } else if ((result = URIResultParser.parse(theResult)) != null) {
66 } else if ((result = EmailAddressResultParser.parse(theResult)) != null) {
68 } else if ((result = ISBNResultParser.parse(theResult)) != null) {
69 // We depend on ISBN parsing coming before UPC, as it is a subset.
71 } else if ((result = ProductResultParser.parse(theResult)) != null) {
74 return new TextParsedResult(theResult.getText(), null);
77 protected static void maybeAppend(String value, StringBuffer result) {
84 protected static void maybeAppend(String[] value, StringBuffer result) {
86 for (int i = 0; i < value.length; i++) {
88 result.append(value[i]);
93 protected static String[] maybeWrap(String value) {
94 return value == null ? null : new String[] { value };
97 protected static String unescapeBackslash(String escaped) {
98 if (escaped != null) {
99 int backslash = escaped.indexOf((int) '\\');
100 if (backslash >= 0) {
101 int max = escaped.length();
102 StringBuffer unescaped = new StringBuffer(max - 1);
103 unescaped.append(escaped.toCharArray(), 0, backslash);
104 boolean nextIsEscaped = false;
105 for (int i = backslash; i < max; i++) {
106 char c = escaped.charAt(i);
107 if (nextIsEscaped || c != '\\') {
109 nextIsEscaped = false;
111 nextIsEscaped = true;
114 return unescaped.toString();
120 static String urlDecode(String escaped) {
122 // No we can't use java.net.URLDecoder here. JavaME doesn't have it.
123 if (escaped == null) {
126 char[] escapedArray = escaped.toCharArray();
128 int first = findFirstEscape(escapedArray);
133 int max = escapedArray.length;
134 // final length is at most 2 less than original due to at least 1 unescaping
135 StringBuffer unescaped = new StringBuffer(max - 2);
136 // Can append everything up to first escape character
137 unescaped.append(escapedArray, 0, first);
139 for (int i = first; i < max; i++) {
140 char c = escapedArray[i];
142 // + is translated directly into a space
143 unescaped.append(' ');
144 } else if (c == '%') {
145 // Are there even two more chars? if not we will just copy the escaped sequence and be done
147 unescaped.append('%'); // append that % and move on
149 int firstDigitValue = parseHexDigit(escapedArray[++i]);
150 int secondDigitValue = parseHexDigit(escapedArray[++i]);
151 if (firstDigitValue < 0 || secondDigitValue < 0) {
152 // bad digit, just move on
153 unescaped.append('%');
154 unescaped.append(escapedArray[i-1]);
155 unescaped.append(escapedArray[i]);
157 unescaped.append((char) ((firstDigitValue << 4) + secondDigitValue));
163 return unescaped.toString();
166 private static int findFirstEscape(char[] escapedArray) {
167 int max = escapedArray.length;
168 for (int i = 0; i < max; i++) {
169 char c = escapedArray[i];
170 if (c == '+' || c == '%') {
177 private static int parseHexDigit(char c) {
180 return 10 + (c - 'a');
182 } else if (c >= 'A') {
184 return 10 + (c - 'A');
186 } else if (c >= '0') {
194 protected static boolean isStringOfDigits(String value, int length) {
198 int stringLength = value.length();
199 if (length != stringLength) {
202 for (int i = 0; i < length; i++) {
203 char c = value.charAt(i);
204 if (c < '0' || c > '9') {
211 static Hashtable parseNameValuePairs(String uri) {
212 int paramStart = uri.indexOf('?');
213 if (paramStart < 0) {
216 Hashtable result = new Hashtable(3);
219 while ((paramEnd = uri.indexOf('&', paramStart)) >= 0) {
220 appendKeyValue(uri, paramStart, paramEnd, result);
221 paramStart = paramEnd + 1;
223 appendKeyValue(uri, paramStart, uri.length(), result);
227 private static void appendKeyValue(String uri, int paramStart, int paramEnd, Hashtable result) {
228 int separator = uri.indexOf('=', paramStart);
229 if (separator >= 0) {
231 String key = uri.substring(paramStart, separator);
232 String value = uri.substring(separator + 1, paramEnd);
233 value = urlDecode(value);
234 result.put(key, value);
236 // Can't put key, null into a hashtable
239 static String[] matchPrefixedField(String prefix, String rawText, char endChar, boolean trim) {
240 Vector matches = null;
242 int max = rawText.length();
244 i = rawText.indexOf(prefix, i);
248 i += prefix.length(); // Skip past this prefix we found to start
249 int start = i; // Found the start of a match here
250 boolean done = false;
252 i = rawText.indexOf((int) endChar, i);
254 // No terminating end character? uh, done. Set i such that loop terminates and break
255 i = rawText.length();
257 } else if (rawText.charAt(i - 1) == '\\') {
258 // semicolon was escaped so continue
262 if (matches == null) {
263 matches = new Vector(3); // lazy init
265 String element = unescapeBackslash(rawText.substring(start, i));
267 element = element.trim();
269 matches.addElement(element);
275 if (matches == null || matches.isEmpty()) {
278 return toStringArray(matches);
281 static String matchSinglePrefixedField(String prefix, String rawText, char endChar, boolean trim) {
282 String[] matches = matchPrefixedField(prefix, rawText, endChar, trim);
283 return matches == null ? null : matches[0];
286 static String[] toStringArray(Vector strings) {
287 int size = strings.size();
288 String[] result = new String[size];
289 for (int j = 0; j < size; j++) {
290 result[j] = (String) strings.elementAt(j);