From bae6b59812ac972c9792605d521d6ada069288b2 Mon Sep 17 00:00:00 2001 From: Jeff Davidson Date: Thu, 2 Apr 2015 14:46:35 -0700 Subject: Generate a CREATOR for each Parcelable message. This is less ideal from a dex count perspective because it requires a new variable for each message, and because most apps have proguard rules that will ensure that CREATOR classes are retained. However, it is required to be able to use nano protos inside of AIDL files, as the autogenerated AIDL code fails to compile otherwise. This is a substantial benefit as it allows for backwards-compatible parameters and return types in AIDL methods along the lines of safeparcel. Bug: 19084705 Change-Id: I66a2c0424b96cf8ff6b631b186cc4f9407dfc1f4 --- .../android/ParcelableExtendableMessageNano.java | 17 +---- .../nano/android/ParcelableMessageNano.java | 17 +---- .../nano/android/ParcelableMessageNanoCreator.java | 89 ++++++++++++++++++++++ .../protobuf/nano/android/ParcelingUtil.java | 72 ----------------- .../protobuf/compiler/javanano/javanano_message.cc | 11 +++ 5 files changed, 102 insertions(+), 104 deletions(-) create mode 100644 java/src/device/main/java/com/google/protobuf/nano/android/ParcelableMessageNanoCreator.java delete mode 100644 java/src/device/main/java/com/google/protobuf/nano/android/ParcelingUtil.java diff --git a/java/src/device/main/java/com/google/protobuf/nano/android/ParcelableExtendableMessageNano.java b/java/src/device/main/java/com/google/protobuf/nano/android/ParcelableExtendableMessageNano.java index f3b82ed..739ff18 100644 --- a/java/src/device/main/java/com/google/protobuf/nano/android/ParcelableExtendableMessageNano.java +++ b/java/src/device/main/java/com/google/protobuf/nano/android/ParcelableExtendableMessageNano.java @@ -42,21 +42,6 @@ import com.google.protobuf.nano.ExtendableMessageNano; public abstract class ParcelableExtendableMessageNano> extends ExtendableMessageNano implements Parcelable { - // Used by Parcelable - @SuppressWarnings({"unused"}) - public static final Creator> CREATOR = - new Creator>() { - @Override - public ParcelableExtendableMessageNano createFromParcel(Parcel in) { - return ParcelingUtil.createFromParcel(in); - } - - @Override - public ParcelableExtendableMessageNano[] newArray(int size) { - return new ParcelableExtendableMessageNano[size]; - } - }; - @Override public int describeContents() { return 0; @@ -64,6 +49,6 @@ public abstract class ParcelableExtendableMessageNano CREATOR = - new Creator() { - @Override - public ParcelableMessageNano createFromParcel(Parcel in) { - return ParcelingUtil.createFromParcel(in); - } - - @Override - public ParcelableMessageNano[] newArray(int size) { - return new ParcelableMessageNano[size]; - } - }; - @Override public int describeContents() { return 0; @@ -62,6 +47,6 @@ public abstract class ParcelableMessageNano extends MessageNano implements Parce @Override public void writeToParcel(Parcel out, int flags) { - ParcelingUtil.writeToParcel(getClass(), this, out); + ParcelableMessageNanoCreator.writeToParcel(getClass(), this, out); } } diff --git a/java/src/device/main/java/com/google/protobuf/nano/android/ParcelableMessageNanoCreator.java b/java/src/device/main/java/com/google/protobuf/nano/android/ParcelableMessageNanoCreator.java new file mode 100644 index 0000000..5a4b70c --- /dev/null +++ b/java/src/device/main/java/com/google/protobuf/nano/android/ParcelableMessageNanoCreator.java @@ -0,0 +1,89 @@ +// Protocol Buffers - Google's data interchange format +// Copyright 2015 Google Inc. All rights reserved. +// http://code.google.com/p/protobuf/ +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +package com.google.protobuf.nano.android; + +import android.os.Parcel; +import android.os.Parcelable; +import android.util.Log; + +import com.google.protobuf.nano.InvalidProtocolBufferNanoException; +import com.google.protobuf.nano.MessageNano; + +import java.lang.reflect.Array; + +public final class ParcelableMessageNanoCreator + implements Parcelable.Creator { + private static final String TAG = "PMNCreator"; + + private final Class mClazz; + + public ParcelableMessageNanoCreator(Class clazz) { + mClazz = clazz; + } + + @SuppressWarnings("unchecked") + @Override + public T createFromParcel(Parcel in) { + String className = in.readString(); + byte[] data = in.createByteArray(); + + T proto = null; + + try { + Class clazz = Class.forName(className); + Object instance = clazz.newInstance(); + proto = (T) instance; + MessageNano.mergeFrom(proto, data); + } catch (ClassNotFoundException e) { + Log.e(TAG, "Exception trying to create proto from parcel", e); + } catch (IllegalAccessException e) { + Log.e(TAG, "Exception trying to create proto from parcel", e); + } catch (InstantiationException e) { + Log.e(TAG, "Exception trying to create proto from parcel", e); + } catch (InvalidProtocolBufferNanoException e) { + Log.e(TAG, "Exception trying to create proto from parcel", e); + } + + return proto; + } + + @SuppressWarnings("unchecked") + @Override + public T[] newArray(int i) { + return (T[]) Array.newInstance(mClazz, i); + } + + static void writeToParcel(Class clazz, MessageNano message, + Parcel out) { + out.writeString(clazz.getName()); + out.writeByteArray(MessageNano.toByteArray(message)); + } +} diff --git a/java/src/device/main/java/com/google/protobuf/nano/android/ParcelingUtil.java b/java/src/device/main/java/com/google/protobuf/nano/android/ParcelingUtil.java deleted file mode 100644 index 1eb84ee..0000000 --- a/java/src/device/main/java/com/google/protobuf/nano/android/ParcelingUtil.java +++ /dev/null @@ -1,72 +0,0 @@ -// Protocol Buffers - Google's data interchange format -// Copyright 2014 Google Inc. All rights reserved. -// http://code.google.com/p/protobuf/ -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are -// met: -// -// * Redistributions of source code must retain the above copyright -// notice, this list of conditions and the following disclaimer. -// * Redistributions in binary form must reproduce the above -// copyright notice, this list of conditions and the following disclaimer -// in the documentation and/or other materials provided with the -// distribution. -// * Neither the name of Google Inc. nor the names of its -// contributors may be used to endorse or promote products derived from -// this software without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -package com.google.protobuf.nano.android; - -import android.os.Parcel; -import android.util.Log; - -import com.google.protobuf.nano.InvalidProtocolBufferNanoException; -import com.google.protobuf.nano.MessageNano; - -final class ParcelingUtil { - private static final String TAG = "ParcelingUtil"; - - @SuppressWarnings("unchecked") - static T createFromParcel(Parcel in) { - String className = in.readString(); - byte[] data = in.createByteArray(); - - T proto = null; - - try { - Class clazz = Class.forName(className); - Object instance = clazz.newInstance(); - proto = (T) instance; - MessageNano.mergeFrom(proto, data); - } catch (ClassNotFoundException e) { - Log.e(TAG, "Exception trying to create proto from parcel", e); - } catch (IllegalAccessException e) { - Log.e(TAG, "Exception trying to create proto from parcel", e); - } catch (InstantiationException e) { - Log.e(TAG, "Exception trying to create proto from parcel", e); - } catch (InvalidProtocolBufferNanoException e) { - Log.e(TAG, "Exception trying to create proto from parcel", e); - } - - return proto; - } - - static void writeToParcel(Class clazz, MessageNano message, - Parcel out) { - out.writeString(clazz.getName()); - out.writeByteArray(MessageNano.toByteArray(message)); - } -} diff --git a/src/google/protobuf/compiler/javanano/javanano_message.cc b/src/google/protobuf/compiler/javanano/javanano_message.cc index 4026031..758c9e8 100644 --- a/src/google/protobuf/compiler/javanano/javanano_message.cc +++ b/src/google/protobuf/compiler/javanano/javanano_message.cc @@ -154,6 +154,17 @@ void MessageGenerator::Generate(io::Printer* printer) { } printer->Indent(); + if (params_.parcelable_messages()) { + printer->Print( + "\n" + "// Used by Parcelable\n" + "@SuppressWarnings({\"unused\"})\n" + "public static final android.os.Parcelable.Creator<$classname$> CREATOR =\n" + " new com.google.protobuf.nano.android.ParcelableMessageNanoCreator<\n" + " $classname$>($classname$.class);\n", + "classname", descriptor_->name()); + } + // Nested types and extensions for (int i = 0; i < descriptor_->extension_count(); i++) { ExtensionGenerator(descriptor_->extension(i), params_).Generate(printer); -- cgit v1.1