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-2006 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.gsf.api;
42:
43: import javax.swing.text.Document;
44:
45: /**
46: * Implementations of this interface can be registered such that the formatter
47: * helps indent or reformat source code, or even determine where the caret should
48: * be placed on a newly created line.
49: *
50: * @author Tor Norbye
51: */
52: public interface Formatter {
53: /**
54: * Reformat the given portion of source code from startOffset to endOffset in the document.
55: * You may use the provided parse tree information, if available, to guide formatting decisions.
56: * The caret (if any) should be updated to the corresponding position that it was at before formatting. *
57: */
58: void reformat(Document doc, int startOffset, int endOffset,
59: CompilationInfo compilationInfo);
60:
61: /**
62: * Reindent the source code. Adjusts indentation and strips trailing whitespace but
63: * does not otherwise change the code. The caret (if any) should be updated to the corresponding
64: * position that it was at before formatting.
65: */
66: void reindent(Document doc, int startOffset, int endOffset);
67:
68: /**
69: * Return true if the reformat() task in this implementation utilizes the parse information.
70: * If it doesn't, the infrastructure can skip producing a parse tree before calling reformat() which
71: * has some performance benefits when the info isn't needed.
72: */
73: boolean needsParserResult();
74:
75: /**
76: * Return the preferred size in characters of each indentation level for this language.
77: * This is not necessarily going to mean spaces since the IDE may use tabs to perform
78: * part of the indentation, but the number should reflect the number of spaces it would
79: * visually correspond to. For example, the Sun JDK Java style guidelines would return
80: * "4" here, and Ruby would return "2".
81: *
82: * @return The size in characters of each indentation level.
83: */
84: int indentSize();
85:
86: /**
87: * Return the preferred "hanging indent" size, the amount of space to indent a continued
88: * line such as the second line here:
89: * <pre>
90: * foo = bar +
91: * baz
92: * </pre>
93: * The hanging indent is the indentation level difference between "baz" and "foo".
94: */
95: int hangingIndentSize();
96: }
|