de.flashpixx.rrd_antlr4.generator.IBaseGenerator.java Source code

Introduction

Here is the source code for de.flashpixx.rrd_antlr4.generator.IBaseGenerator.java

Source

/**
 * @cond LICENSE
 * ######################################################################################
 * # LGPL License                                                                       #
 * #                                                                                    #
 * # This file is part of the RRD-AntLR4                                                #
 * # Copyright (c) 2016, Philipp Kraus (philipp.kraus@tu-clausthal.de)                  #
 * # 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 Lesser General Public License for more details.                                #
 * #                                                                                    #
 * # You should have received a copy of the GNU Lesser General Public License           #
 * # along with this program. If not, see http://www.gnu.org/licenses/                  #
 * ######################################################################################
 * @endcond
 */

package de.flashpixx.rrd_antlr4.generator;

import de.flashpixx.rrd_antlr4.engine.CEngine;
import de.flashpixx.rrd_antlr4.engine.template.ETemplate;
import org.apache.commons.io.FilenameUtils;

import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * base generator class with default definitions
 */
public abstract class IBaseGenerator implements IGenerator {
    /**
     * engine instance
     */
    private static final CEngine ENGINE = new CEngine();
    /**
     * result generator error
     */
    protected boolean m_error;
    /**
     * set of generator templates
     */
    protected final Set<ETemplate> m_templates;
    /**
     * base output directory
     */
    protected final File m_baseoutput;
    /**
     * map with imported grammar files
     */
    private final Map<String, File> m_imports;
    /**
     * set with regex string for documentation cleaning
     */
    private final Set<String> m_docuclean;

    /**
     * ctor
     *
     * @param p_baseoutputdirectory base output directory
     * @param p_templates array with exporting templates
     * @param p_imports set with imported grammar files
     * @param p_docuclean set with documentation strings
     */
    protected IBaseGenerator(final File p_baseoutputdirectory, final Set<File> p_imports,
            final Set<String> p_docuclean, final Set<ETemplate> p_templates) {
        m_docuclean = p_docuclean;
        m_templates = p_templates;
        m_baseoutput = p_baseoutputdirectory;
        m_imports = Collections.unmodifiableMap(p_imports.parallelStream()
                .collect(Collectors.toMap(i -> FilenameUtils.removeExtension(i.getName()), i -> i)));
    }

    @Override
    public final IGenerator generate(final File p_grammar) {
        final File l_outputdirectory = this.processoutputdirectory(p_grammar);
        try {
            return this.processmessages(p_grammar, l_outputdirectory, ENGINE.generate(m_baseoutput,
                    l_outputdirectory, p_grammar, m_docuclean, m_imports, m_templates));
        } catch (final IOException l_exception) {
            return this.processmessages(p_grammar, l_outputdirectory,
                    Collections.unmodifiableSet(Stream.of(l_exception.getMessage()).collect(Collectors.toSet())));
        }

    }

    @Override
    public final boolean hasError() {
        return m_error;
    }

    @Override
    public IGenerator finish() {
        return this;
    }

    /**
     * processes the output directory
     *
     * @param p_grammar input grammar file
     * @return new output directory
     */
    protected abstract File processoutputdirectory(final File p_grammar);

    /**
     * processes the error messages
     *
     * @param p_grammar input grammar file
     * @param p_outputdirectory output directory
     * @param p_messages error messages
     * @return generator self reference
     */
    protected abstract IGenerator processmessages(final File p_grammar, final File p_outputdirectory,
            final Collection<String> p_messages);

}