summaryrefslogtreecommitdiff
path: root/src/main/java/io/devnulllabs/openjava/syntax/IterationRule.java
blob: 5c7f75f2b5ab31898f185501666ee4b8dfff981b (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
 * IterationRule.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.ObjectList;
import io.devnulllabs.openjava.ptree.ParseTree;


/**
 * The class <code>IterationRule</code> represents iterative syntax
 * rule.
 * <p>
 * Suppose there's a syntax rule A.  This class can represents
 * the syntax ( A )* or ( A )+
 *
 * @author   Michiaki Tatsubori
 * @version  1.0
 * @since    $Id: IterationRule.java,v 1.2 2003/02/19 02:54:31 tatsubori Exp $
 * @see java.lang.Object
 */
public class IterationRule extends AbstractSyntaxRule
{
    private SyntaxRule elementRule;
    private boolean allowsEmpty;

    /**
     * Allocates a new rule representing iterations of a given rule.
     *
     * @param elementRule  a rule to iterate
     * @param allowsEmpty  a flag to allow 0 iteration if it is true.
     */
    public IterationRule( SyntaxRule elementRule, boolean allowsEmpty ) {
    this.elementRule = elementRule;
    this.allowsEmpty = allowsEmpty;
    }

    /**
     * Allocates a new rule representing iterations of a given rule
     * not allowing 0 iteration.
     *
     * @param elementRule  a rule to iterate
     */
    public IterationRule( SyntaxRule elementRule ) {
    this( elementRule, false );
    }

    /**
     * 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 ParseTree consume( TokenSource token_src )
    throws SyntaxException
    {
    ObjectList result = new ObjectList();
    if (! allowsEmpty) {
        result.add( elementRule.consume( token_src ) );
    }
    while (elementRule.lookahead( token_src )) {
        ParseTree elem = elementRule.consume( token_src );
        result.add( elem );
    }
    return result;
    }

}