KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jruby > lexer > yacc > ISourcePosition


1 /***** BEGIN LICENSE BLOCK *****
2  * Version: CPL 1.0/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Common Public
5  * License Version 1.0 (the "License"); you may not use this file
6  * except in compliance with the License. You may obtain a copy of
7  * the License at http://www.eclipse.org/legal/cpl-v10.html
8  *
9  * Software distributed under the License is distributed on an "AS
10  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
11  * implied. See the License for the specific language governing
12  * rights and limitations under the License.
13  *
14  * Copyright (C) 2005 Thomas E Enebo <enebo@acm.org>
15  *
16  * Alternatively, the contents of this file may be used under the terms of
17  * either of the GNU General Public License Version 2 or later (the "GPL"),
18  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
19  * in which case the provisions of the GPL or the LGPL are applicable instead
20  * of those above. If you wish to allow use of your version of this file only
21  * under the terms of either the GPL or the LGPL, and not to allow others to
22  * use your version of this file under the terms of the CPL, indicate your
23  * decision by deleting the provisions above and replace them with the notice
24  * and other provisions required by the GPL or the LGPL. If you do not delete
25  * the provisions above, a recipient may use your version of this file under
26  * the terms of any one of the CPL, the GPL or the LGPL.
27  ***** END LICENSE BLOCK *****/
28 package org.jruby.lexer.yacc;
29
30 /**
31  * This interface is the combination of two needs: 1) A Ruby interpreter position (for warnings
32  * and errors). The interpreter only cares about filename and endLine. 2) A IDE position (offsets
33  * for showing ranges of grammatical elements).
34  *
35  * The offsets represent positions 'between' characters. So a variable 'abc' has a startOffset
36  * of 0 and an endOffset of 3 ( 0a1b2c3 ).
37  *
38  */
39 public interface ISourcePosition {
40     /**
41      * Which file does this source position live in?
42      *
43      * @return name of the source file.
44      */
45     public String JavaDoc getFile();
46     
47     /**
48      * Which is the first(start) line that this source position occurs on (zero-based)
49      * @return
50      */
51     public int getStartLine();
52     
53     /**
54      * Which is the last(end) line that this source position occurs on (zero-based)
55      *
56      * @return the line
57      */
58     public int getEndLine();
59     
60     /**
61      * Modify startOffset by a relativeValue. At times our grammar and lexer do not give us
62      * the exact positions we need so we need to manually tweak position. The bummer of this
63      * is this requires ISourcePosition implementations are mutable.
64      *
65      * @param relativeValue to nudge startOffset up or down
66      */
67     public void adjustStartOffset(int relativeValue);
68     
69     /**
70      * Get offset (relative to beginning of source file) immediately before first character
71      * represented by this source position.
72      *
73      * @return the offset
74      */
75     public int getStartOffset();
76     
77     /**
78      * Get offset (relative to beginning of source file) immediately after the last character
79      * represented by this source position
80      *
81      * @return the offset
82      */
83     public int getEndOffset();
84     
85     /**
86      * Calculates the logical union of the two positions and creates a new resulting position
87      *
88      * @param position to be unioned against this position
89      * @return a new position
90      */
91     public ISourcePosition union(ISourcePosition position);
92 }
93
Popular Tags