1579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/* 2579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Copyright (C) 2007 The Android Open Source Project 3579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 4579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Licensed under the Apache License, Version 2.0 (the "License"); 5579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * you may not use this file except in compliance with the License. 6579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * You may obtain a copy of the License at 7579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 8579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 9579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 10579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Unless required by applicable law or agreed to in writing, software 11579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 12579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * See the License for the specific language governing permissions and 14579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * limitations under the License. 15579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 16579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 17579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpackage com.android.dx.dex.file; 18579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 19579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.cst.Constant; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.cst.CstNat; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.cst.CstString; 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.AnnotatedOutput; 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.Hex; 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport java.util.Collection; 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport java.util.TreeMap; 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Strings list section of a {@code .dex} file. 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class StringIdsSection 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson extends UniformItemSection { 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code non-null;} map from string constants to {@link 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * StringIdItem} instances 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final TreeMap<CstString, StringIdItem> strings; 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. The file offset is initially unknown. 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param file {@code non-null;} file that this instance is part of 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public StringIdsSection(DexFile file) { 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson super("string_ids", file, 4); 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson strings = new TreeMap<CstString, StringIdItem>(); 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public Collection<? extends Item> items() { 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return strings.values(); 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public IndexedItem get(Constant cst) { 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (cst == null) { 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new NullPointerException("cst == null"); 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throwIfNotPrepared(); 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson IndexedItem result = strings.get((CstString) cst); 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (result == null) { 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new IllegalArgumentException("not found"); 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return result; 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Writes the portion of the file header that refers to this instance. 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param out {@code non-null;} where to write 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void writeHeaderPart(AnnotatedOutput out) { 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throwIfNotPrepared(); 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int sz = strings.size(); 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int offset = (sz == 0) ? 0 : getFileOffset(); 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (out.annotates()) { 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.annotate(4, "string_ids_size: " + Hex.u4(sz)); 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.annotate(4, "string_ids_off: " + Hex.u4(offset)); 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.writeInt(sz); 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.writeInt(offset); 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Interns an element into this instance. 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param string {@code non-null;} the string to intern, as a regular Java 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code String} 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the interned string 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public StringIdItem intern(String string) { 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return intern(new StringIdItem(new CstString(string))); 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Interns an element into this instance. 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param string {@code non-null;} the string to intern, as a constant 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the interned string 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public StringIdItem intern(CstString string) { 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return intern(new StringIdItem(string)); 113579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 114579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 115579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 116579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Interns an element into this instance. 117579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 118579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param string {@code non-null;} the string to intern 119579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the interned string 120579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 121579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public StringIdItem intern(StringIdItem string) { 122579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (string == null) { 123579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new NullPointerException("string == null"); 124579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 125579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 126579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throwIfPrepared(); 127579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 128579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson CstString value = string.getValue(); 129579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson StringIdItem already = strings.get(value); 130579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 131579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (already != null) { 132579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return already; 133579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 134579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 135579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson strings.put(value, string); 136579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return string; 137579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 138579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 139579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 140579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Interns the components of a name-and-type into this instance. 141579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 142579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param nat {@code non-null;} the name-and-type 143579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 144579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void intern(CstNat nat) { 145579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson intern(nat.getName()); 146579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson intern(nat.getDescriptor()); 147579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 148579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 149579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 150579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the index of the given string, which must have been added 151579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * to this instance. 152579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 153579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param string {@code non-null;} the string to look up 154579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code >= 0;} the string's index 155579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 156579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int indexOf(CstString string) { 157579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (string == null) { 158579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new NullPointerException("string == null"); 159579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 160579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 161579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throwIfNotPrepared(); 162579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 163579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson StringIdItem s = strings.get(string); 164579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 165579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (s == null) { 166579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new IllegalArgumentException("not found"); 167579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 168579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 169579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return s.getIndex(); 170579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 171579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 172579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 173579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 174579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected void orderItems() { 175579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int idx = 0; 176579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 177579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson for (StringIdItem s : strings.values()) { 178579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson s.setIndex(idx); 179579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson idx++; 180579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 181579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 182579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 183