1917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/* 2917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Copyright (C) 2007 The Android Open Source Project 3917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 4917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Licensed under the Apache License, Version 2.0 (the "License"); 5917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * you may not use this file except in compliance with the License. 6917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * You may obtain a copy of the License at 7917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 8917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * http://www.apache.org/licenses/LICENSE-2.0 9917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 10917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Unless required by applicable law or agreed to in writing, software 11917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * distributed under the License is distributed on an "AS IS" BASIS, 12917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * See the License for the specific language governing permissions and 14917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * limitations under the License. 15917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 16917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 17917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpackage com.android.dexgen.dex.file; 18917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 19917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.rop.cst.CstUtf8; 20917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.AnnotatedOutput; 21917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.Hex; 22917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 23917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/** 24917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Representation of a string inside a Dalvik file. 25917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 26917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpublic final class StringIdItem 27917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul extends IndexedItem implements Comparable { 28917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** size of instances when written out to a file, in bytes */ 29917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public static final int WRITE_SIZE = 4; 30917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 31917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@code non-null;} the string value */ 32917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul private final CstUtf8 value; 33917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 34917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@code null-ok;} associated string data object, if known */ 35917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul private StringDataItem data; 36917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 37917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 38917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Constructs an instance. 39917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 40917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param value {@code non-null;} the string value 41917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 42917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public StringIdItem(CstUtf8 value) { 43917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (value == null) { 44917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new NullPointerException("value == null"); 45917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 46917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 47917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul this.value = value; 48917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul this.data = null; 49917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 50917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 51917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 52917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 53917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public boolean equals(Object other) { 54917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (!(other instanceof StringIdItem)) { 55917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return false; 56917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 57917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 58917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul StringIdItem otherString = (StringIdItem) other; 59917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return value.equals(otherString.value); 60917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 61917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 62917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 63917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 64917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int hashCode() { 65917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return value.hashCode(); 66917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 67917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 68917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 69917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int compareTo(Object other) { 70917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul StringIdItem otherString = (StringIdItem) other; 71917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return value.compareTo(otherString.value); 72917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 73917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 74917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 75917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 76917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public ItemType itemType() { 77917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return ItemType.TYPE_STRING_ID_ITEM; 78917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 79917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 80917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 81917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 82917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int writeSize() { 83917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return WRITE_SIZE; 84917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 85917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 86917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 87917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 88917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void addContents(DexFile file) { 89917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (data == null) { 90917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul // The string data hasn't yet been added, so add it. 91917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul MixedItemSection stringData = file.getStringData(); 92917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul data = new StringDataItem(value); 93917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul stringData.add(data); 94917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 95917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 96917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 97917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 98917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 99917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void writeTo(DexFile file, AnnotatedOutput out) { 100917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul int dataOff = data.getAbsoluteOffset(); 101917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 102917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (out.annotates()) { 103917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.annotate(0, indexString() + ' ' + value.toQuoted(100)); 104917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.annotate(4, " string_data_off: " + Hex.u4(dataOff)); 105917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 106917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 107917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.writeInt(dataOff); 108917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 109917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 110917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 111917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the string value. 112917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 113917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the value 114917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 115917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public CstUtf8 getValue() { 116917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return value; 117917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 118917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 119917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 120917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the associated data object for this instance, if known. 121917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 122917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code null-ok;} the associated data object or {@code null} 123917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * if not yet known 124917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 125917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public StringDataItem getData() { 126917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return data; 127917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 128917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul} 129