01: /*
02: * IndentRule.java
03: * :tabSize=8:indentSize=8:noTabs=false:
04: * :folding=explicit:collapseFolds=1:
05: *
06: * Copyright (C) 2005 Slava Pestov
07: *
08: * This program is free software; you can redistribute it and/or
09: * modify it under the terms of the GNU General Public License
10: * as published by the Free Software Foundation; either version 2
11: * of the License, or any later version.
12: *
13: * This program is distributed in the hope that it will be useful,
14: * but WITHOUT ANY WARRANTY; without even the implied warranty of
15: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16: * GNU General Public License for more details.
17: *
18: * You should have received a copy of the GNU General Public License
19: * along with this program; if not, write to the Free Software
20: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21: */
22:
23: package org.gjt.sp.jedit.indent;
24:
25: import java.util.List;
26: import org.gjt.sp.jedit.buffer.JEditBuffer;
27:
28: /**
29: * @author Slava Pestov
30: * @version $Id: IndentRule.java 10801 2007-10-04 09:13:00Z kpouer $
31: */
32: public interface IndentRule {
33: /**
34: * Apply the indent rule to this line, and return an indent action.
35: *
36: * @param buffer the buffer
37: * @param thisLineIndex the line index
38: * @param prevLineIndex the prior non empty line index
39: * (or -1 if there is no prior non empty line)
40: * @param prevPrevLineIndex the prior non empty line index before the prevLineIndex
41: * (or -1 if there is no prior non empty line)
42: * @param indentActions the indent actions list. The rule can add an action in it if
43: * it is necessary
44: */
45: void apply(JEditBuffer buffer, int this LineIndex,
46: int prevLineIndex, int prevPrevLineIndex,
47: List<IndentAction> indentActions);
48: }
|