BlockDelimiterTools.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 java.util.List;

import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;

import org.novelang.common.LocationFactory;
import org.novelang.common.Problem;

/**
 * @author Laurent Caillette
 */
public class BlockDelimiterTools {

  private BlockDelimiterTools() {
    throw new Error() ;
  }

  public static Iterable< Problem > createProblems(
      final LocationFactory locationFactory,
      final DefaultBlockDelimitersBoundary blockDelimitersBoundary
  ) {
    return createProblems(
        locationFactory,
        blockDelimitersBoundary.getFaultyDelimitedBlocks()
    ) ;
  }


  public static Iterable< Problem > createProblems(
      final LocationFactory locationFactory,
      final Iterable< DelimitedBlockStatus > statuses
  ) {
    final List< Problem > problems = Lists.newArrayList() ;
    for( final DelimitedBlockStatus status : statuses ) {
      final Problem problem = Problem.createProblem(
          "Missing delimiter. " +
              "For '" + status.getBlockDelimiter().getStart() + "' there should be a matching " +
              createDelimiterEndMessage( status.getBlockDelimiter().getEnd() )
          ,
          locationFactory,
          status.getLine(),
          status.getColumn()
      ) ;
      problems.add( problem ) ;
    }

    return ImmutableList.copyOf( problems ) ;
  }

  private static String createDelimiterEndMessage( final String[] ends) {
    return "'" + Joiner.on( "' or '" ).join( ends ) + "'" ;
  }

}