1 /* 2 * Copyright 2012, 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.iface; 33 34 import org.jf.dexlib2.iface.debug.DebugItem; 35 import org.jf.dexlib2.iface.instruction.Instruction; 36 37 import javax.annotation.Nonnull; 38 import java.util.List; 39 40 /** 41 * This class represents the implementation details of a method. 42 */ 43 public interface MethodImplementation { 44 /** 45 * Gets the number of registers in this method. 46 * 47 * @return The number of register in this method. 48 */ 49 int getRegisterCount(); 50 51 /** 52 * Gets the instructions in this method. 53 * 54 * @return An Iterable of the instructions in this method 55 */ 56 @Nonnull Iterable<? extends Instruction> getInstructions(); 57 58 /** 59 * Gets a list of the try blocks defined for this method. 60 * 61 * Try blocks may overlap freely, and do not need to be strictly nested, as in java. This is a more relaxed 62 * requirement than specified by the dex format, where try blocks may not overlap, and must be specified in 63 * ascending order. When writing to a dex file, the try blocks will be massaged into the appropriate format. 64 * 65 * In any region where there are overlapping try blocks, set of exception handlers for the overlapping region will 66 * consist of the union of all handlers in any try block that covers that region. 67 * 68 * If multiple overlapping try blocks define a handler for the same exception type, or define a catch-all 69 * handler, then those duplicate handlers must use the same handler offset. 70 * 71 * @return A list of the TryBlock items 72 */ 73 @Nonnull List<? extends TryBlock<? extends ExceptionHandler>> getTryBlocks(); 74 75 /** 76 * Get a list of debug items for this method. 77 * 78 * This generally matches the semantics of the debug_info_item in the dex specification, although in an easier to 79 * digest form. 80 * 81 * The addresses of the DebugItems in the returned list will be in non-descending order. 82 * 83 * @return A list of DebugInfo items 84 */ 85 @Nonnull Iterable<? extends DebugItem> getDebugItems(); 86 } 87
