summaryrefslogtreecommitdiff
path: root/src/main/java/io/devnulllabs/openjava/syntax/TokenRule.java
blob: a55d3dcc09125cc989a3fc6a48d890e43f32e248 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
 * TokenRule.java
 *
 * comments here.
 *
 * @author   Michiaki Tatsubori
 * @version  %VERSION% %DATE%
 * @see      java.lang.Object
 *
 * COPYRIGHT 1998 by Michiaki Tatsubori, ALL RIGHTS RESERVED.
 */
package io.devnulllabs.openjava.syntax;

import io.devnulllabs.openjava.ptree.Leaf;
import io.devnulllabs.openjava.ptree.ParseTree;
import io.devnulllabs.openjava.tools.parser.Token;

/**
 * The class <code>TokenRule</code> represents the syntax
 * rule of a list separated by an separator.
 * <p>
 * Suppose there's a syntax rule A and token t.  This class can
 * represents the syntax A ( t A )*.
 * <p>
 *
 * @author   Michiaki Tatsubori
 * @version  1.0
 * @since    $Id: TokenRule.java,v 1.2 2003/02/19 02:54:31 tatsubori Exp $
 * @see java.lang.Object
 */
public final class TokenRule extends AbstractSyntaxRule {
    private int tokenID;

    /**
     * Allocates a new rule representing a specified token.
     *
     * @param separator_token  the id of a token.
     * @see io.devnulllabs.openjava.syntax.TokenID
     */
    public TokenRule(int token_id) {
        this.tokenID = token_id;
    }

    /**
     * Consumes token source.
     *
     * @param token_src  token source.
     * @return  null if this fails to consume a syntax tree represented
     * by this object.  Otherwise it returns <code>ObjectList</code> object.
     */
    public final ParseTree consume(TokenSource token_src)
        throws SyntaxException {
        Token t = token_src.getNextToken();
        if (t.kind != tokenID) {
            /***** to become specifed error report */
            throw new SyntaxException("un expected token");
        }
        return new Leaf(t.kind, t.image, t.beginLine, t.beginColumn);
    }

}