1 /*
2 * Copyright (c) 2002-2025 Gargoyle Software Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 * https://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15 package org.htmlunit;
16
17 import org.htmlunit.html.HtmlElement;
18 import org.htmlunit.html.HtmlPage;
19
20 /**
21 * A script pre processor call back. This interface is called when ScriptEngine.execute()
22 * is called. It gives developers the opportunity to modify the script to be executed.
23 *
24 * @author <a href="mailto:bcurren@esomnie.com">Ben Curren</a>
25 */
26 public interface ScriptPreProcessor {
27
28 /**
29 * Pre process the specified source code in the context of the given page.
30 * @param htmlPage the page
31 * @param sourceCode the code to execute
32 * @param sourceName a name for the chunk of code that is going to be executed (used in error messages)
33 * @param lineNumber the line number of the source code
34 * @param htmlElement the HTML element that will act as the context
35 * @return the source code after pre processing
36 */
37 String preProcess(HtmlPage htmlPage, String sourceCode, String sourceName, int lineNumber, HtmlElement htmlElement);
38 }