blob: e87a410e1ef85e5c52186b0dc207cf3614299bbe (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.bcel.verifier.structurals;
import org.apache.bcel.generic.InstructionHandle;
/**
* This interface defines properties of JVM bytecode subroutines.
* Note that it is 'abused' to maintain the top-level code in a
* consistent fashion, too.
*
* @version $Id$
*/
public interface Subroutine{
/**
* Returns all the JsrInstructions that have the
* first instruction of this subroutine as their target.
* <B>Must not be invoked on the 'top-level subroutine'.</B>
*/
InstructionHandle[] getEnteringJsrInstructions();
/**
* Returns the one and only RET that leaves the subroutine.
* Note that JustIce has a pretty rigid notion of a subroutine.
* <B>Must not be invoked on the 'top-level subroutine'.</B>
*
* @see Subroutines
*/
InstructionHandle getLeavingRET();
/**
* Returns all instructions that together form this subroutine.
* Note that an instruction is part of exactly one subroutine
* (the top-level code is considered to be a special subroutine) -
* else it is not reachable at all (dead code).
*/
InstructionHandle[] getInstructions();
/**
* Returns if the given InstructionHandle refers to an instruction
* that is part of this subroutine. This is a convenience method
* that saves iteration over the InstructionHandle objects returned
* by getInstructions().
*
* @see #getInstructions()
*/
boolean contains(InstructionHandle inst);
/**
* Returns an int[] containing the indices of the local variable slots
* accessed by this Subroutine (read-accessed, write-accessed or both);
* local variables referenced by subroutines of this subroutine are
* not included.
*
* @see #getRecursivelyAccessedLocalsIndices()
*/
int[] getAccessedLocalsIndices();
/**
* Returns an int[] containing the indices of the local variable slots
* accessed by this Subroutine (read-accessed, write-accessed or both);
* local variables referenced by subroutines of this subroutine are
* included.
*
* @see #getAccessedLocalsIndices()
*/
int[] getRecursivelyAccessedLocalsIndices();
/**
* Returns the subroutines that are directly called from this subroutine.
*/
Subroutine[] subSubs();
}
|
