01: /*
02: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * 1. Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: * 2. Redistributions in binary form must reproduce the above copyright notice,
10: * this list of conditions and the following disclaimer in the documentation
11: * and/or other materials provided with the distribution.
12: * 3. The end-user documentation included with the redistribution, if any, must
13: * include the following acknowledgment:
14: *
15: * "This product includes software developed by Gargoyle Software Inc.
16: * (http://www.GargoyleSoftware.com/)."
17: *
18: * Alternately, this acknowledgment may appear in the software itself, if
19: * and wherever such third-party acknowledgments normally appear.
20: * 4. The name "Gargoyle Software" must not be used to endorse or promote
21: * products derived from this software without prior written permission.
22: * For written permission, please contact info@GargoyleSoftware.com.
23: * 5. Products derived from this software may not be called "HtmlUnit", nor may
24: * "HtmlUnit" appear in their name, without prior written permission of
25: * Gargoyle Software Inc.
26: *
27: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37: */
38: package com.gargoylesoftware.htmlunit;
39:
40: import com.gargoylesoftware.htmlunit.html.HtmlPage;
41: import com.gargoylesoftware.htmlunit.html.HtmlElement;
42:
43: /**
44: * A script pre processor call back. This interface is called when ScriptEngine.execute()
45: * is called. It gives developers the opportunity to modify the script to be executed.
46: *
47: * @version $Revision: 2132 $
48: * @author <a href="mailto:bcurren@esomnie.com">Ben Curren</a>
49: */
50: public interface ScriptPreProcessor {
51: /**
52: * Pre process the specified source code in the context of the given page.
53: * @param htmlPage The page
54: * @param sourceCode The code to execute.
55: * @param sourceName A name for the chunk of code that is going to be executed. This will be
56: * used in error messages.
57: * @param htmlElement The html element that will act as the context.
58: * @return The source code after pre processing
59: */
60: String preProcess(final HtmlPage htmlPage, final String sourceCode,
61: final String sourceName, final HtmlElement htmlElement);
62: }
|