BlockDelimitersBoundary.java

/*
 * Copyright (C) 2011 Laurent Caillette
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.novelang.parser.antlr.delimited;

import org.antlr.runtime.MismatchedTokenException;
import org.antlr.runtime.Token;

import org.novelang.common.Problem;

/**
 * Defines the block-related notifications emitted by the grammar.
 *
 * @author Laurent Caillette
 */
public interface BlockDelimitersBoundary {
  
  void startDelimitedText( BlockDelimiter blockDelimiter, Token startToken ) ;

  void reachEndDelimiter( BlockDelimiter blockDelimiter ) ;

  void endDelimitedText( BlockDelimiter blockDelimiter ) ;

  void reportMissingDelimiter(
      BlockDelimiter blockDelimiter,
      MismatchedTokenException mismatchedTokenException
  ) throws MismatchedTokenException ;

  Iterable<Problem> getProblems() ;

}