Home | History | Annotate | Download | only in raw 
      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 
     32 package org.jf.dexlib2.dexbacked.raw;
     33 
     34 import com.google.common.collect.Maps;
     35 import org.jf.dexlib2.dexbacked.raw.util.DexAnnotator;
     36 import org.jf.dexlib2.util.AnnotatedBytes;
     37 import org.jf.util.AlignmentUtils;
     38 
     39 import javax.annotation.Nonnull;
     40 import javax.annotation.Nullable;
     41 import java.util.Map;
     42 
     43 public abstract class SectionAnnotator {
     44     @Nonnull public final DexAnnotator annotator;
     45     @Nonnull public final RawDexFile dexFile;
     46     public final int itemType;
     47     public final int sectionOffset;
     48     public final int itemCount;
     49 
     50     private Map<Integer, String> itemIdentities = Maps.newHashMap();
     51 
     52     public SectionAnnotator(@Nonnull DexAnnotator annotator, @Nonnull MapItem mapItem) {
     53         this.annotator = annotator;
     54         this.dexFile = annotator.dexFile;
     55         this.itemType = mapItem.getType();
     56 
     57         this.sectionOffset = mapItem.getOffset();
     58         this.itemCount = mapItem.getItemCount();
     59     }
     60 
     61     @Nonnull public abstract String getItemName();
     62     protected abstract void annotateItem(@Nonnull AnnotatedBytes out, int itemIndex, @Nullable String itemIdentity);
     63 
     64     /**
     65      * Write out annotations for this section
     66      *
     67      * @param out The AnnotatedBytes object to annotate to
     68      */
     69     public void annotateSection(@Nonnull AnnotatedBytes out) {
     70         out.moveTo(sectionOffset);
     71         annotateSectionInner(out, itemCount);
     72     }
     73 
     74     protected void annotateSectionInner(@Nonnull AnnotatedBytes out, int itemCount) {
     75         String itemName = getItemName();
     76         int itemAlignment = getItemAlignment();
     77         if (itemCount > 0) {
     78             out.annotate(0, "");
     79             out.annotate(0, "-----------------------------");
     80             out.annotate(0, "%s section", itemName);
     81             out.annotate(0, "-----------------------------");
     82             out.annotate(0, "");
     83 
     84             for (int i=0; i<itemCount; i++) {
     85                 out.moveTo(AlignmentUtils.alignOffset(out.getCursor(), itemAlignment));
     86 
     87                 String itemIdentity = getItemIdentity(out.getCursor());
     88                 if (itemIdentity != null) {
     89                     out.annotate(0, "[%d] %s: %s", i, itemName, itemIdentity);
     90                 } else {
     91                     out.annotate(0, "[%d] %s", i, itemName);
     92                 }
     93                 out.indent();
     94                 annotateItem(out, i, itemIdentity);
     95                 out.deindent();
     96             }
     97         }
     98     }
     99 
    100     @Nullable private String getItemIdentity(int itemOffset) {
    101         return itemIdentities.get(itemOffset);
    102     }
    103 
    104     public void setItemIdentity(int itemOffset, String identity) {
    105         itemIdentities.put(itemOffset, identity);
    106     }
    107 
    108     public int getItemAlignment() {
    109         return 1;
    110     }
    111 }
    112