PageRenderTime 119ms CodeModel.GetById 114ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/jEdit/tags/jedit-4-5-pre1/org/gjt/sp/jedit/indent/IndentRule.java

#
Java | 49 lines | 9 code | 3 blank | 37 comment | 0 complexity | 7f63bf0be06012e2d80e1e1f38cb34e9 MD5 | raw file
 1/*
 2 * IndentRule.java
 3 * :tabSize=8:indentSize=8:noTabs=false:
 4 * :folding=explicit:collapseFolds=1:
 5 *
 6 * Copyright (C) 2005 Slava Pestov
 7 *
 8 * This program is free software; you can redistribute it and/or
 9 * 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
23package org.gjt.sp.jedit.indent;
24
25import java.util.List;
26import org.gjt.sp.jedit.buffer.JEditBuffer;
27
28/**
29 * @author Slava Pestov
30 * @version $Id: IndentRule.java 12504 2008-04-22 23:12:43Z ezust $
31 */
32public interface IndentRule
33{
34	/**
35	 * Apply the indent rule to this line, and return an indent action.
36	 *
37	 * @param buffer the buffer
38	 * @param thisLineIndex the line index
39	 * @param prevLineIndex the prior non empty line index
40	 * (or -1 if there is no prior non empty line)
41	 * @param prevPrevLineIndex the prior non empty line index before the prevLineIndex
42	 * (or -1 if there is no prior non empty line)
43	 * @param indentActions the indent actions list. The rule can add an action in it if
44	 * it is necessary
45	 */
46	void apply(JEditBuffer buffer, int thisLineIndex,
47		int prevLineIndex, int prevPrevLineIndex,
48		List<IndentAction> indentActions);
49}