IGenerationFragment.java

/*******************************************************************************
 * Copyright (c) 2010-2012, Zoltan Ujhelyi, Istvan Rath and Daniel Varro
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Zoltan Ujhelyi - initial API and implementation
 *******************************************************************************/
package org.eclipse.incquery.tooling.core.generator.fragments;

import java.util.Collection;

import org.eclipse.core.runtime.IPath;
import org.eclipse.incquery.patternlanguage.patternLanguage.Pattern;
import org.eclipse.incquery.tooling.core.generator.ExtensionGenerator;
import org.eclipse.pde.core.plugin.IPluginExtension;
import org.eclipse.xtext.generator.IFileSystemAccess;
import org.eclipse.xtext.xbase.lib.Pair;

/**
 * A code generation fragment is used by annotation processors for code generation.
 * 
 * @author Zoltan Ujhelyi
 * 
 */
public interface IGenerationFragment {

    /**
     * Returns the postfix used to define the destination project. The generated contents are put into the
     * <code>model.project.name.postfix</code> project, or left in the <code>model.project.name</code> project if a null
     * postfix is returned.
     * 
     * @return A project postfix, or null
     */
    String getProjectPostfix();

    /**
     * Returns an array of bundle id's to add to the destination project as dependency. This array need not to contain
     * the model project, as it is added automatically to new generated projects.
     * 
     * @return A non-null (but possibly empty) array of dependencies to add.
     */
    String[] getProjectDependencies();

    /**
     * Executes code generation for a selected pattern. All resulting files should be placed using the file system
     * access component.
     * 
     * @param pattern
     * @param fsa
     */
    void generateFiles(Pattern pattern, IFileSystemAccess fsa);

    /**
     * Cleans up the previosly generated files for the selected pattern. Delete the files using the file system access
     * component.
     * 
     * @param pattern
     * @param fsa
     */
    void cleanUp(Pattern pattern, IFileSystemAccess fsa);

    // public Iterable<JvmGenericType> inferFiles(Pattern pattern);
    /**
     * Returns a collection of extension contributions for the selected pattern. The {@link ExtensionGeneration}
     * parameter provides a builder API for Xtend-based generators to have a readable generator.
     * 
     * @param pattern
     * @param exGen
     * @return a collection of plugin extensions
     */
    Iterable<IPluginExtension> extensionContribution(Pattern pattern, ExtensionGenerator exGen);

    /**
     * Returns a collections of extensions, that need to be removed from the plugin.xml.
     * 
     * @param pattern
     * @return
     */
    Iterable<Pair<String, String>> removeExtension(Pattern pattern);

    /**
     * Returns pairs of extension id prefix and point id. All extension with one of these ids and prefixes will be
     * removed from the fragments project's plugin.xml. This method only invoked during Clean Build.
     * 
     * @return
     */
    Collection<Pair<String, String>> getRemovableExtensions();

    IPath[] getAdditionalBinIncludes();

}