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.Constant; 20917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.rop.cst.CstNat; 21917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.rop.cst.CstString; 22917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.rop.cst.CstUtf8; 23917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.AnnotatedOutput; 24917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.Hex; 25917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 26917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport java.util.Collection; 27917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport java.util.TreeMap; 28917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 29917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/** 30917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Strings list section of a {@code .dex} file. 31917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 32917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpublic final class StringIdsSection 33917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul extends UniformItemSection { 34917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 35917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * {@code non-null;} map from string constants to {@link 36917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * StringIdItem} instances 37917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 38917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul private final TreeMap<CstUtf8, StringIdItem> strings; 39917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 40917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 41917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Constructs an instance. The file offset is initially unknown. 42917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 43917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param file {@code non-null;} file that this instance is part of 44917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 45917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public StringIdsSection(DexFile file) { 46917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul super("string_ids", file, 4); 47917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 48917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul strings = new TreeMap<CstUtf8, StringIdItem>(); 49917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 50917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 51917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 52917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 53917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public Collection<? extends Item> items() { 54917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return strings.values(); 55917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 56917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 57917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 58917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 59917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public IndexedItem get(Constant cst) { 60917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (cst == null) { 61917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new NullPointerException("cst == null"); 62917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 63917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 64917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throwIfNotPrepared(); 65917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 66917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (cst instanceof CstString) { 67917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul cst = ((CstString) cst).getString(); 68917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 69917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 70917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul IndexedItem result = strings.get((CstUtf8) cst); 71917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 72917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (result == null) { 73917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new IllegalArgumentException("not found"); 74917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 75917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 76917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return result; 77917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 78917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 79917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 80917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Writes the portion of the file header that refers to this instance. 81917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 82917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param out {@code non-null;} where to write 83917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 84917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void writeHeaderPart(AnnotatedOutput out) { 85917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throwIfNotPrepared(); 86917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 87917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul int sz = strings.size(); 88917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul int offset = (sz == 0) ? 0 : getFileOffset(); 89917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 90917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (out.annotates()) { 91917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.annotate(4, "string_ids_size: " + Hex.u4(sz)); 92917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.annotate(4, "string_ids_off: " + Hex.u4(offset)); 93917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 94917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 95917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.writeInt(sz); 96917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.writeInt(offset); 97917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 98917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 99917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 100917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Interns an element into this instance. 101917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 102917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param string {@code non-null;} the string to intern, as a regular Java 103917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * {@code String} 104917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the interned string 105917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 106917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public StringIdItem intern(String string) { 107917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul CstUtf8 utf8 = new CstUtf8(string); 108917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return intern(new StringIdItem(utf8)); 109917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 110917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 111917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 112917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Interns an element into this instance. 113917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 114917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param string {@code non-null;} the string to intern, as a {@link CstString} 115917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the interned string 116917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 117917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public StringIdItem intern(CstString string) { 118917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul CstUtf8 utf8 = string.getString(); 119917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return intern(new StringIdItem(utf8)); 120917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 121917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 122917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 123917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Interns an element into this instance. 124917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 125917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param string {@code non-null;} the string to intern, as a constant 126917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the interned string 127917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 128917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public StringIdItem intern(CstUtf8 string) { 129917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return intern(new StringIdItem(string)); 130917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 131917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 132917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 133917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Interns an element into this instance. 134917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 135917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param string {@code non-null;} the string to intern 136917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the interned string 137917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 138917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public StringIdItem intern(StringIdItem string) { 139917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (string == null) { 140917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new NullPointerException("string == null"); 141917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 142917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 143917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throwIfPrepared(); 144917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 145917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul CstUtf8 value = string.getValue(); 146917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul StringIdItem already = strings.get(value); 147917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 148917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (already != null) { 149917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return already; 150917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 151917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 152917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul strings.put(value, string); 153917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return string; 154917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 155917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 156917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 157917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Interns the components of a name-and-type into this instance. 158917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 159917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param nat {@code non-null;} the name-and-type 160917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 161917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void intern(CstNat nat) { 162917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul intern(nat.getName()); 163917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul intern(nat.getDescriptor()); 164917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 165917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 166917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 167917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the index of the given string, which must have been added 168917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * to this instance. 169917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 170917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param string {@code non-null;} the string to look up 171917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code >= 0;} the string's index 172917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 173917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int indexOf(CstUtf8 string) { 174917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (string == null) { 175917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new NullPointerException("string == null"); 176917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 177917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 178917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throwIfNotPrepared(); 179917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 180917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul StringIdItem s = strings.get(string); 181917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 182917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (s == null) { 183917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new IllegalArgumentException("not found"); 184917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 185917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 186917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return s.getIndex(); 187917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 188917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 189917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 190917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the index of the given string, which must have been added 191917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * to this instance. 192917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 193917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param string {@code non-null;} the string to look up 194917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code >= 0;} the string's index 195917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 196917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int indexOf(CstString string) { 197917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return indexOf(string.getString()); 198917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 199917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 200917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 201917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul @Override 202917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul protected void orderItems() { 203917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul int idx = 0; 204917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 205917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul for (StringIdItem s : strings.values()) { 206917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul s.setIndex(idx); 207917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul idx++; 208917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 209917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 210917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul} 211