1 package org.apache.bcel.verifier.structurals;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache BCEL" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache BCEL", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 import org.apache.bcel.generic.*;
58
59 /***
60 * This interface defines properties of JVM bytecode subroutines.
61 * Note that it is 'abused' to maintain the top-level code in a
62 * consistent fashion, too.
63 *
64 * @version $Id: Subroutine.java,v 1.1.1.1 2001/10/29 20:00:42 jvanzyl Exp $
65 * @author <A HREF="http://www.inf.fu-berlin.de/~ehaase"/>Enver Haase</A>
66 */
67 public interface Subroutine{
68 /***
69 * Returns all the JsrInstructions that have the
70 * first instruction of this subroutine as their target.
71 * <B>Must not be invoked on the 'top-level subroutine'.</B>
72 */
73 public InstructionHandle[] getEnteringJsrInstructions();
74
75 /***
76 * Returns the one and only RET that leaves the subroutine.
77 * Note that JustIce has a pretty rigid notion of a subroutine.
78 * <B>Must not be invoked on the 'top-level subroutine'.</B>
79 *
80 * @see org.apache.bcel.verifier.structurals.Subroutines
81 */
82 public InstructionHandle getLeavingRET();
83
84 /***
85 * Returns all instructions that together form this subroutine.
86 * Note that an instruction is part of exactly one subroutine
87 * (the top-level code is considered to be a special subroutine) -
88 * else it is not reachable at all (dead code).
89 */
90 public InstructionHandle[] getInstructions();
91
92 /***
93 * Returns if the given InstructionHandle refers to an instruction
94 * that is part of this subroutine. This is a convenience method
95 * that saves iteration over the InstructionHandle objects returned
96 * by getInstructions().
97 *
98 * @see #getInstructions()
99 */
100 public boolean contains(InstructionHandle inst);
101
102 /***
103 * Returns an int[] containing the indices of the local variable slots
104 * accessed by this Subroutine (read-accessed, write-accessed or both);
105 * local variables referenced by subroutines of this subroutine are
106 * not included.
107 *
108 * @see #getRecursivelyAccessedLocalsIndices()
109 */
110 public int[] getAccessedLocalsIndices();
111
112 /***
113 * Returns an int[] containing the indices of the local variable slots
114 * accessed by this Subroutine (read-accessed, write-accessed or both);
115 * local variables referenced by subroutines of this subroutine are
116 * included.
117 *
118 * @see #getAccessedLocalsIndices()
119 */
120 public int[] getRecursivelyAccessedLocalsIndices();
121
122 /***
123 * Returns the subroutines that are directly called from this subroutine.
124 */
125 public Subroutine[] subSubs();
126 }
This page was automatically generated by Maven