David Beaumont
14 years ago
committed by
Mihaela Rosca
Mihaela Rosca
8 changed files with 673 additions and 268 deletions
Split View
Diff Options
-
+32 -27tools/java/common/src/com/google/i18n/phonenumbers/BuildMetadataFromXml.java
-
+23 -30tools/java/common/test/com/google/i18n/phonenumbers/BuildMetadataFromXmlTest.java
-
+157 -193tools/java/cpp-build/src/com/google/i18n/phonenumbers/BuildMetadataCppFromXml.java
-
+193 -0tools/java/cpp-build/src/com/google/i18n/phonenumbers/CppMetadataGenerator.java
-
BINtools/java/cpp-build/target/cpp-build-1.0-SNAPSHOT-jar-with-dependencies.jar
-
+146 -18tools/java/cpp-build/test/com/google/i18n/phonenumbers/BuildMetadataCppFromXmlTest.java
-
+122 -0tools/java/cpp-build/test/com/google/i18n/phonenumbers/CppMetadataGeneratorTest.java
-
BINtools/java/java-build/target/java-build-1.0-SNAPSHOT-jar-with-dependencies.jar
+ 32
- 27
tools/java/common/src/com/google/i18n/phonenumbers/BuildMetadataFromXml.java
View File
+ 23
- 30
tools/java/common/test/com/google/i18n/phonenumbers/BuildMetadataFromXmlTest.java
View File
+ 157
- 193
tools/java/cpp-build/src/com/google/i18n/phonenumbers/BuildMetadataCppFromXml.java
View File
+ 193
- 0
tools/java/cpp-build/src/com/google/i18n/phonenumbers/CppMetadataGenerator.java
View File
| @ -0,0 +1,193 @@ | |||
| /* | |||
| * Copyright (C) 2012 The Libphonenumber Authors | |||
| * | |||
| * Licensed under the Apache License, Version 2.0 (the "License"); | |||
| * you may not use this file except in compliance with the License. | |||
| * You may obtain a copy of the License at | |||
| * | |||
| * http://www.apache.org/licenses/LICENSE-2.0 | |||
| * | |||
| * Unless required by applicable law or agreed to in writing, software | |||
| * distributed under the License is distributed on an "AS IS" BASIS, | |||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| * See the License for the specific language governing permissions and | |||
| * limitations under the License. | |||
| */ | |||
| package com.google.i18n.phonenumbers; | |||
| import java.io.IOException; | |||
| import java.io.PrintWriter; | |||
| import java.io.Writer; | |||
| import java.util.Locale; | |||
| /** | |||
| * Encapsulation of binary metadata created from XML to be included as static data in C++ source | |||
| * files. | |||
| * | |||
| * @author David Beaumont | |||
| * @author Philippe Liard | |||
| */ | |||
| public final class CppMetadataGenerator { | |||
| /** | |||
| * The metadata type represents the known types of metadata and includes additional information | |||
| * such as the copyright year. It is expected that the generated files will be named after the | |||
| * {@link #toString} of their type. | |||
| */ | |||
| public enum Type { | |||
| /** The basic phone number metadata (expected to be written to metadata.[h/cc]). */ | |||
| METADATA("metadata", 2011), | |||
| /** The alternate format metadata (expected to be written to alternate_format.[h/cc]). */ | |||
| ALTERNATE_FORMAT("alternate_format", 2012); | |||
| private final String typeName; | |||
| private final int copyrightYear; | |||
| private Type(String typeName, int copyrightYear) { | |||
| this.typeName = typeName; | |||
| this.copyrightYear = copyrightYear; | |||
| } | |||
| /** Returns the year in which this metadata type was first introduced. */ | |||
| public int getCopyrightYear() { | |||
| return copyrightYear; | |||
| } | |||
| /** | |||
| * Returns the name of this type for use in C++ source/header files. Use this in preference to | |||
| * using {@link #name}. | |||
| */ | |||
| @Override public String toString() { | |||
| return typeName; | |||
| } | |||
| /** | |||
| * Parses the type from a string case-insensitively. | |||
| * | |||
| * @return the matching Type instance or null if not matched. | |||
| */ | |||
| public static Type parse(String typeName) { | |||
| if (Type.METADATA.toString().equalsIgnoreCase(typeName)) { | |||
| return Type.METADATA; | |||
| } else if (Type.ALTERNATE_FORMAT.toString().equalsIgnoreCase(typeName)) { | |||
| return Type.ALTERNATE_FORMAT; | |||
| } else { | |||
| return null; | |||
| } | |||
| } | |||
| } | |||
| /** | |||
| * Creates a metadata instance that can write C++ source and header files to represent this given | |||
| * byte array as a static unsigned char array. Note that a direct reference to the byte[] is | |||
| * retained by the newly created CppXmlMetadata instance, so the caller should treat the array as | |||
| * immutable after making this call. | |||
| */ | |||
| public static CppMetadataGenerator create(Type type, byte[] data) { | |||
| return new CppMetadataGenerator(type, data); | |||
| } | |||
| private final Type type; | |||
| private final byte[] data; | |||
| private final String guardName; // e.g. "I18N_PHONENUMBERS_<TYPE>_H_" | |||
| private final String headerInclude; // e.g. "phonenumbers/<type>.h" | |||
| private CppMetadataGenerator(Type type, byte[] data) { | |||
| this.type = type; | |||
| this.data = data; | |||
| this.guardName = createGuardName(type); | |||
| this.headerInclude = createHeaderInclude(type); | |||
| } | |||
| /** | |||
| * Writes the header file for the C++ representation of the metadata to the given writer. Note | |||
| * that this method does not close the given writer. | |||
| */ | |||
| public void outputHeaderFile(Writer out) throws IOException { | |||
| PrintWriter pw = new PrintWriter(out); | |||
| CopyrightNotice.writeTo(pw, type.getCopyrightYear()); | |||
| pw.println("#ifndef " + guardName); | |||
| pw.println("#define " + guardName); | |||
| pw.println(); | |||
| emitNamespaceStart(pw); | |||
| pw.println(); | |||
| pw.println("int " + type + "_size();"); | |||
| pw.println("const void* " + type + "_get();"); | |||
| pw.println(); | |||
| emitNamespaceEnd(pw); | |||
| pw.println(); | |||
| pw.println("#endif // " + guardName); | |||
| pw.flush(); | |||
| } | |||
| /** | |||
| * Writes the source file for the C++ representation of the metadata, including a static array | |||
| * containing the data itself, to the given writer. Note that this method does not close the given | |||
| * writer. | |||
| */ | |||
| public void outputSourceFile(Writer out) throws IOException { | |||
| // TODO: Consider outputting a load method to return the parsed proto directly. | |||
| PrintWriter pw = new PrintWriter(out); | |||
| CopyrightNotice.writeTo(pw, type.getCopyrightYear()); | |||
| pw.println("#include \"" + headerInclude + "\""); | |||
| pw.println(); | |||
| emitNamespaceStart(pw); | |||
| pw.println(); | |||
| pw.println("namespace {"); | |||
| pw.println("static const unsigned char data[] = {"); | |||
| emitStaticArrayData(pw, data); | |||
| pw.println("};"); | |||
| pw.println("} // namespace"); | |||
| pw.println(); | |||
| pw.println("int " + type + "_size() {"); | |||
| pw.println(" return sizeof(data) / sizeof(data[0]);"); | |||
| pw.println("}"); | |||
| pw.println(); | |||
| pw.println("const void* " + type + "_get() {"); | |||
| pw.println(" return data;"); | |||
| pw.println("}"); | |||
| pw.println(); | |||
| emitNamespaceEnd(pw); | |||
| pw.flush(); | |||
| } | |||
| private static String createGuardName(Type type) { | |||
| return String.format("I18N_PHONENUMBERS_%s_H_", type.toString().toUpperCase(Locale.ENGLISH)); | |||
| } | |||
| private static String createHeaderInclude(Type type) { | |||
| return String.format("phonenumbers/%s.h", type); | |||
| } | |||
| private static void emitNamespaceStart(PrintWriter pw) { | |||
| pw.println("namespace i18n {"); | |||
| pw.println("namespace phonenumbers {"); | |||
| } | |||
| private static void emitNamespaceEnd(PrintWriter pw) { | |||
| pw.println("} // namespace phonenumbers"); | |||
| pw.println("} // namespace i18n"); | |||
| } | |||
| /** Emits the C++ code corresponding to the binary metadata as a static byte array. */ | |||
| // @VisibleForTesting | |||
| static void emitStaticArrayData(PrintWriter pw, byte[] data) { | |||
| String separator = " "; | |||
| for (int i = 0; i < data.length; i++) { | |||
| pw.print(separator); | |||
| emitHexByte(pw, data[i]); | |||
| separator = ((i + 1) % 13 == 0) ? ",\n " : ", "; | |||
| } | |||
| pw.println(); | |||
| } | |||
| /** Emits a single byte in the form 0xHH, where H is an upper case hex digit in [0-9A-F]. */ | |||
| private static void emitHexByte(PrintWriter pw, byte v) { | |||
| pw.print("0x"); | |||
| pw.print(UPPER_HEX[(v & 0xF0) >>> 4]); | |||
| pw.print(UPPER_HEX[v & 0xF]); | |||
| } | |||
| private static final char[] UPPER_HEX = "0123456789ABCDEF".toCharArray(); | |||
| } | |||
BIN
tools/java/cpp-build/target/cpp-build-1.0-SNAPSHOT-jar-with-dependencies.jar
View File
+ 146
- 18
tools/java/cpp-build/test/com/google/i18n/phonenumbers/BuildMetadataCppFromXmlTest.java
View File
+ 122
- 0
tools/java/cpp-build/test/com/google/i18n/phonenumbers/CppMetadataGeneratorTest.java
View File
| @ -0,0 +1,122 @@ | |||
| /* | |||
| * Copyright (C) 2012 The Libphonenumber Authors | |||
| * | |||
| * Licensed under the Apache License, Version 2.0 (the "License"); | |||
| * you may not use this file except in compliance with the License. | |||
| * You may obtain a copy of the License at | |||
| * | |||
| * http://www.apache.org/licenses/LICENSE-2.0 | |||
| * | |||
| * Unless required by applicable law or agreed to in writing, software | |||
| * distributed under the License is distributed on an "AS IS" BASIS, | |||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| * See the License for the specific language governing permissions and | |||
| * limitations under the License. | |||
| */ | |||
| package com.google.i18n.phonenumbers; | |||
| import static org.junit.Assert.assertEquals; | |||
| import static org.junit.Assert.assertTrue; | |||
| import com.google.i18n.phonenumbers.CppMetadataGenerator.Type; | |||
| import org.junit.Test; | |||
| import java.io.BufferedReader; | |||
| import java.io.IOException; | |||
| import java.io.PrintWriter; | |||
| import java.io.StringReader; | |||
| import java.io.StringWriter; | |||
| import java.util.ArrayList; | |||
| import java.util.Iterator; | |||
| import java.util.List; | |||
| /** | |||
| * Tests that the CppXmlMetadata class emits the expected source and header files for metadata. | |||
| */ | |||
| public class CppMetadataGeneratorTest { | |||
| @Test | |||
| public void emitStaticArrayData() { | |||
| // 13 bytes per line, so have 16 bytes to test > 1 line (general case). | |||
| // Use all hex digits in both nibbles to test hex formatting. | |||
| byte[] data = new byte[] { | |||
| (byte) 0xF0, (byte) 0xE1, (byte) 0xD2, (byte) 0xC3, | |||
| (byte) 0xB4, (byte) 0xA5, (byte) 0x96, (byte) 0x87, | |||
| (byte) 0x78, (byte) 0x69, (byte) 0x5A, (byte) 0x4B, | |||
| (byte) 0x3C, (byte) 0x2D, (byte) 0x1E, (byte) 0x0F, | |||
| }; | |||
| StringWriter writer = new StringWriter(); | |||
| CppMetadataGenerator.emitStaticArrayData(new PrintWriter(writer), data); | |||
| assertEquals( | |||
| " 0xF0, 0xE1, 0xD2, 0xC3, 0xB4, 0xA5, 0x96, 0x87, 0x78, 0x69, 0x5A, 0x4B, 0x3C,\n" + | |||
| " 0x2D, 0x1E, 0x0F\n", | |||
| writer.toString()); | |||
| } | |||
| @Test | |||
| public void outputHeaderFile() throws IOException { | |||
| byte[] data = new byte[] { (byte) 0xCA, (byte) 0xFE, (byte) 0xBA, (byte) 0xBE }; | |||
| CppMetadataGenerator metadata = CppMetadataGenerator.create(Type.METADATA, data); | |||
| StringWriter writer = new StringWriter(); | |||
| metadata.outputHeaderFile(writer); | |||
| Iterator<String> lines = toLines(writer.toString()).iterator(); | |||
| // Sanity check that at least some of the expected lines are present. | |||
| assertTrue(consumeUntil(" * Copyright (C) 2011 The Libphonenumber Authors", lines)); | |||
| assertTrue(consumeUntil("#ifndef I18N_PHONENUMBERS_METADATA_H_", lines)); | |||
| assertTrue(consumeUntil("#define I18N_PHONENUMBERS_METADATA_H_", lines)); | |||
| assertTrue(consumeUntil("namespace i18n {", lines)); | |||
| assertTrue(consumeUntil("namespace phonenumbers {", lines)); | |||
| assertTrue(consumeUntil("int metadata_size();", lines)); | |||
| assertTrue(consumeUntil("const void* metadata_get();", lines)); | |||
| assertTrue(consumeUntil("#endif // I18N_PHONENUMBERS_METADATA_H_", lines)); | |||
| } | |||
| @Test | |||
| public void outputSourceFile() throws IOException { | |||
| byte[] data = new byte[] { (byte) 0xCA, (byte) 0xFE, (byte) 0xBA, (byte) 0xBE }; | |||
| CppMetadataGenerator metadata = CppMetadataGenerator.create(Type.ALTERNATE_FORMAT, data); | |||
| StringWriter writer = new StringWriter(); | |||
| metadata.outputSourceFile(writer); | |||
| Iterator<String> lines = toLines(writer.toString()).iterator(); | |||
| // Sanity check that at least some of the expected lines are present. | |||
| assertTrue(consumeUntil(" * Copyright (C) 2012 The Libphonenumber Authors", lines)); | |||
| assertTrue(consumeUntil("namespace i18n {", lines)); | |||
| assertTrue(consumeUntil("namespace phonenumbers {", lines)); | |||
| assertTrue(consumeUntil("namespace {", lines)); | |||
| assertTrue(consumeUntil("static const unsigned char data[] = {", lines)); | |||
| assertTrue(consumeUntil(" 0xCA, 0xFE, 0xBA, 0xBE", lines)); | |||
| assertTrue(consumeUntil("int alternate_format_size() {", lines)); | |||
| assertTrue(consumeUntil("const void* alternate_format_get() {", lines)); | |||
| } | |||
| /** Converts a string containing newlines into a list of lines. */ | |||
| private static List<String> toLines(String s) throws IOException { | |||
| BufferedReader reader = new BufferedReader(new StringReader(s)); | |||
| List<String> lines = new ArrayList<String>(); | |||
| for (String line = reader.readLine(); line != null; line = reader.readLine()) { | |||
| lines.add(line); | |||
| } | |||
| return lines; | |||
| } | |||
| /** | |||
| * Consumes strings from the given iterator until the expected string is reached (it is also | |||
| * consumed). If the expected string is not found, the iterator is exhausted and {@code false} is | |||
| * returned. | |||
| * | |||
| * @return true if the expected string was found while consuming the iterator. | |||
| */ | |||
| private static boolean consumeUntil(String expected, Iterator<String> it) { | |||
| while (it.hasNext()) { | |||
| if (it.next().equals(expected)) { | |||
| return true; | |||
| } | |||
| } | |||
| return false; | |||
| } | |||
| } | |||