1/*
2 * Copyright 2013, Google Inc.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 *     * Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *     * Redistributions in binary form must reproduce the above
12 * copyright notice, this list of conditions and the following disclaimer
13 * in the documentation and/or other materials provided with the
14 * distribution.
15 *     * Neither the name of Google Inc. nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32package org.jf.dexlib2.dexbacked.raw;
33
34import org.jf.dexlib2.dexbacked.DexBackedDexFile;
35import org.jf.dexlib2.dexbacked.raw.util.DexAnnotator;
36import org.jf.dexlib2.util.AnnotatedBytes;
37import org.jf.util.StringUtils;
38
39import javax.annotation.Nonnull;
40import javax.annotation.Nullable;
41
42public class StringIdItem {
43    public static final int ITEM_SIZE = 4;
44
45    @Nonnull
46    public static SectionAnnotator makeAnnotator(@Nonnull DexAnnotator annotator, @Nonnull MapItem mapItem) {
47        return new SectionAnnotator(annotator, mapItem) {
48            @Nonnull @Override public String getItemName() {
49                return "string_id_item";
50            }
51
52            @Override
53            public void annotateItem(@Nonnull AnnotatedBytes out, int itemIndex, @Nullable String itemIdentity) {
54                int stringDataOffset = dexFile.readSmallUint(out.getCursor());
55                try {
56                    String stringValue = dexFile.getString(itemIndex);
57                    out.annotate(4, "string_data_item[0x%x]: \"%s\"", stringDataOffset,
58                            StringUtils.escapeString(stringValue));
59                    return;
60                } catch (Exception ex) {
61                    System.err.print("Error while resolving string value at index: ");
62                    System.err.print(itemIndex);
63                    ex.printStackTrace(System.err);
64                }
65
66                out.annotate(4, "string_id_item[0x%x]", stringDataOffset);
67            }
68        };
69    }
70
71    @Nonnull
72    public static String getReferenceAnnotation(@Nonnull DexBackedDexFile dexFile, int stringIndex) {
73        return getReferenceAnnotation(dexFile, stringIndex, false);
74
75    }
76
77    public static String getReferenceAnnotation(@Nonnull DexBackedDexFile dexFile, int stringIndex, boolean quote) {
78        try {
79            String string = dexFile.getString(stringIndex);
80            if (quote) {
81                string = String.format("\"%s\"", StringUtils.escapeString(string));
82            }
83            return String.format("string_id_item[%d]: %s", stringIndex, string);
84        } catch (Exception ex) {
85            ex.printStackTrace(System.err);
86        }
87        return String.format("string_id_item[%d]", stringIndex);
88    }
89
90
91    @Nonnull
92    public static String getOptionalReferenceAnnotation(@Nonnull DexBackedDexFile dexFile, int stringIndex) {
93        return getOptionalReferenceAnnotation(dexFile, stringIndex, false);
94
95    }
96
97    public static String getOptionalReferenceAnnotation(@Nonnull DexBackedDexFile dexFile, int stringIndex,
98                                                        boolean quote) {
99        if (stringIndex == -1) {
100            return "string_id_item[NO_INDEX]";
101        }
102        return getReferenceAnnotation(dexFile, stringIndex, quote);
103    }
104
105    public static String[] getStrings(@Nonnull RawDexFile dexFile) {
106        MapItem mapItem = dexFile.getMapItemForSection(ItemType.STRING_ID_ITEM);
107        if (mapItem == null) {
108            return new String[0];
109        }
110
111        int stringCount = mapItem.getItemCount();
112        String[] ret = new String[stringCount];
113        for (int i=0; i<stringCount; i++) {
114            ret[i] = dexFile.getString(i);
115        }
116        return ret;
117    }
118}
119