01: /* Soot - a J*va Optimization Framework
02: * Copyright (C) 1997-1999 Patrick Lam
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2.1 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the
16: * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17: * Boston, MA 02111-1307, USA.
18: */
19:
20: /*
21: * Modified by the Sable Research Group and others 1997-1999.
22: * See the 'credits' file distributed with Soot for the complete list of
23: * contributors. (Soot is distributed at http://www.sable.mcgill.ca/soot)
24: */
25:
26: package soot;
27:
28: import java.util.*;
29:
30: /**
31: * An abstract class which acts on a Body. This class provides a harness and acts as an
32: * interface for classes that wish to transform a Body. Subclasses
33: * provide the actual Body transformation implementation.
34: */
35:
36: public abstract class BodyTransformer extends Transformer {
37: /**
38: * Called by clients of the transformation. Acts as a generic interface
39: * for BodyTransformers.
40: * Calls internalTransform with the optionsString properly set up.
41: * That is, the options in optionsString override those in the Scene.
42: * @param b the body on which to apply the transformation
43: * @param phaseName phaseName for the transform. Used to retrieve options from the Scene.
44: */
45: public final void transform(Body b, String phaseName, Map options) {
46: if (!PhaseOptions.getBoolean(options, "enabled"))
47: return;
48:
49: internalTransform(b, phaseName, options);
50: }
51:
52: public final void transform(Body b, String phaseName) {
53: HashMap dummyOptions = new HashMap();
54: dummyOptions.put("enabled", "true");
55: transform(b, phaseName, dummyOptions);
56: }
57:
58: public final void transform(Body b) {
59: transform(b, "");
60: }
61:
62: /**
63: * This method is called to perform the transformation itself. It is declared
64: * abstract; subclasses must implement this method by making it the entry point
65: * to their actual Body transformation.
66: * @param b the body on which to apply the transformation
67: * @param phaseName the phasename for this transform; not typically used by implementations.
68: * @param options the actual computed options; a combination of default options and Scene specified options.
69: */
70: protected abstract void internalTransform(Body b, String phaseName,
71: Map options);
72:
73: }
|