01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.modules.java.preprocessorbridge.spi;
42:
43: import org.openide.filesystems.FileObject;
44:
45: /**Allows creation of JavaSource instances for non-Java files.
46: * Is expected to produce "virtual" Java source, which is then parsed
47: * by the Java parser and used by selected Java features.
48: *
49: * @author Jan Lahoda, Dusan Balek
50: */
51: public interface JavaSourceProvider {
52:
53: /**Create {@link PositionTranslatingJavaFileFilterImplementation} for given file.
54: *
55: * @param fo file for which the implementation should be created
56: * @return PositionTranslatingJavaFileFilterImplementation or null if which provider
57: * cannot create one for this file
58: */
59: public PositionTranslatingJavaFileFilterImplementation forFileObject(
60: FileObject fo);
61:
62: /**"Virtual" Java source provider
63: *
64: * Currently, only {@link JavaFileFilterImplementation#filterCharSequence},
65: * {@link JavaFileFilterImplementation#getOriginalPosition},
66: * {@link JavaFileFilterImplementation#getJavaSourcePosition} are called.
67: */
68: public static interface PositionTranslatingJavaFileFilterImplementation
69: extends JavaFileFilterImplementation {
70: /**Compute position in the document for given position in the virtual
71: * Java source.
72: *
73: * @param javaSourcePosition position in the virtual Java Source
74: * @return position in the document
75: */
76: public int getOriginalPosition(int javaSourcePosition);
77:
78: /**Compute position in the virtual Java source for given position
79: * in the document.
80: *
81: * @param originalPosition position in the document
82: * @return position in the virtual Java source
83: */
84: public int getJavaSourcePosition(int originalPosition);
85: }
86: }
|