/*
* Copyright 2003-2015 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jetbrains.mps.generator;
import jetbrains.mps.generator.impl.DefaultNonIncrementalStrategy;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.mps.openapi.model.SModel;
import java.util.HashMap;
import java.util.Map;
/**
* Evgeny Gryaznov, Apr 26, 2010
*/
public class GenerationOptions {
public static final int TRACE_OFF = 0;
public static final int TRACE_STEPS = 1;
public static final int TRACE_LANGS = 2;
public static final int TRACE_TYPES = 3;
private final boolean mySaveTransientModels;
private final boolean myActiveInplaceTransform;
private final boolean myStrictMode;
private final boolean myRebuildAll;
private final boolean myUseDynamicRefs;
private final IncrementalGenerationStrategy myIncrementalStrategy;
private final GenerationParametersProvider myParametersProvider;
private final Map<SModel, ModelGenerationPlan> myCustomPlans;
private boolean myKeepOutputModel;
private final boolean myGenerateInParallel;
private final int myNumberOfThreads;
private final int myTracingMode;
private final boolean myShowInfo;
private final boolean myShowWarnings;
private final boolean myKeepModelsWithWarnings;
private final boolean myShowBadChildWarning;
private final int myNumberOfModelsToKeep;
private final boolean myDebugIncrementalDependencies;
private GenerationOptions(boolean strictMode, boolean saveTransientModels, boolean rebuildAll, boolean useInplaceTransformations,
boolean generateInParallel, int numberOfThreads, int tracingMode, boolean showInfo,
boolean showWarnings, boolean keepModelsWithWarnings, int numberOfModelsToKeep,
boolean useDynamicRefs, IncrementalGenerationStrategy incrementalStrategy,
GenerationParametersProvider parametersProvider, boolean keepOutputModel, boolean showBadChildWarning,
Map<SModel, ModelGenerationPlan> customPlans,
boolean debugIncrementalDependencies) {
mySaveTransientModels = saveTransientModels;
myActiveInplaceTransform = useInplaceTransformations;
myGenerateInParallel = generateInParallel;
myStrictMode = strictMode;
myRebuildAll = rebuildAll;
myNumberOfThreads = numberOfThreads;
myTracingMode = tracingMode;
myNumberOfModelsToKeep = numberOfModelsToKeep;
myShowInfo = showInfo;
myShowWarnings = showWarnings;
myKeepModelsWithWarnings = keepModelsWithWarnings;
myIncrementalStrategy = incrementalStrategy;
myParametersProvider = parametersProvider;
myKeepOutputModel = keepOutputModel;
myShowBadChildWarning = showBadChildWarning;
myCustomPlans = customPlans;
myDebugIncrementalDependencies = debugIncrementalDependencies;
myUseDynamicRefs = useDynamicRefs;
}
public boolean isSaveTransientModels() {
return mySaveTransientModels;
}
public boolean isGenerateInParallel() {
return myGenerateInParallel && myStrictMode;
}
public boolean isStrictMode() {
return myStrictMode;
}
public boolean isRebuildAll() {
return myRebuildAll;
}
@NotNull
public IncrementalGenerationStrategy getIncrementalStrategy() {
return myIncrementalStrategy;
}
public int getNumberOfThreads() {
return myNumberOfThreads;
}
public boolean applyTransformationsInplace() {
return myActiveInplaceTransform;
}
public int getTracingMode() {
if (isGenerateInParallel() && myTracingMode > TRACE_STEPS) {
return TRACE_STEPS;
}
return myTracingMode;
}
public boolean isShowInfo() {
return myShowInfo;
}
public boolean isShowWarnings() {
return myShowWarnings;
}
public boolean isKeepModelsWithWarnings() {
return myKeepModelsWithWarnings;
}
public boolean isShowBadChildWarning() {
return myShowBadChildWarning;
}
public int getNumberOfModelsToKeep() {
return myNumberOfModelsToKeep;
}
@Nullable
public GenerationParametersProvider getParametersProvider() {
return myParametersProvider;
}
public ModelGenerationPlan getCustomPlan(@NotNull SModel model) {
return myCustomPlans.get(model);
}
public static OptionsBuilder getDefaults() {
return new OptionsBuilder();
}
public static OptionsBuilder fromSettings(IGenerationSettings settings) {
return new OptionsBuilder().
strictMode(settings.isStrictMode()).saveTransientModels(settings.isSaveTransientModels()).
useInplaceTransformations(settings.useInplaceTransformations()).
generateInParallel(settings.isParallelGenerator(), settings.getNumberOfParallelThreads()).
reporting(settings.isShowInfo(), settings.isShowWarnings(), settings.isKeepModelsWithWarnings(), settings.getNumberOfModelsToKeep()).
showBadChildWarning(settings.isShowBadChildWarning()).debugIncrementalDependencies(settings.isDebugIncrementalDependencies()).
useDynamicReferences(!settings.createStaticReferences());
}
public boolean isKeepOutputModel() {
return myKeepOutputModel;
}
public boolean isDebugIncrementalDependencies() {
return myDebugIncrementalDependencies;
}
/**
* @see jetbrains.mps.generator.IGenerationSettings#createStaticReferences()
*/
public boolean useDynamicReferences() {
return myUseDynamicRefs;
}
/**
* Options builder
* Usage:
* GenerationOptions.getDefaults().saveTransientModels(true).reporting(true, true, true, 4);
*/
public static class OptionsBuilder {
private boolean mySaveTransientModels = false;
private boolean myStrictMode = false;
private boolean myRebuildAll = true;
private IncrementalGenerationStrategy myIncrementalStrategy = new DefaultNonIncrementalStrategy();
private Map<SModel, ModelGenerationPlan> myCustomPlans = new HashMap<SModel, ModelGenerationPlan>();
private boolean myGenerateInParallel = false;
private int myNumberOfThreads = 4;
private int myTracingMode = TRACE_OFF;
private boolean myShowInfo = false;
private boolean myShowWarnings = true;
private boolean myKeepModelsWithWarnings = true;
private boolean myShowBadChildWarning = true;
private int myNumberOfModelsToKeep = 16;
private GenerationParametersProvider myParametersProvider = null;
private boolean myKeepOutputModel;
private boolean myDebugIncrementalDependencies = false;
private boolean myUseInplace;
private boolean myUseDynamicRefs = false;
private OptionsBuilder() {
}
public GenerationOptions create() {
if(myIncrementalStrategy == null) {
throw new IllegalArgumentException("incremental strategy is not set");
}
return new GenerationOptions(myStrictMode, mySaveTransientModels, myRebuildAll, myUseInplace,
myGenerateInParallel, myNumberOfThreads, myTracingMode, myShowInfo, myShowWarnings,
myKeepModelsWithWarnings, myNumberOfModelsToKeep, myUseDynamicRefs,
myIncrementalStrategy, myParametersProvider, myKeepOutputModel, myShowBadChildWarning,
myCustomPlans, myDebugIncrementalDependencies);
}
public OptionsBuilder saveTransientModels(boolean saveTransientModels) {
mySaveTransientModels = saveTransientModels;
return this;
}
public OptionsBuilder parameters(@Nullable GenerationParametersProvider parametersProvider) {
myParametersProvider = parametersProvider;
return this;
}
public OptionsBuilder strictMode(boolean strictMode) {
myStrictMode = strictMode;
return this;
}
public OptionsBuilder showBadChildWarning(boolean value) {
myShowBadChildWarning = value;
return this;
}
public OptionsBuilder debugIncrementalDependencies(boolean value) {
myDebugIncrementalDependencies = value;
return this;
}
public OptionsBuilder useInplaceTransformations(boolean use) {
myUseInplace = use;
return this;
}
public OptionsBuilder rebuildAll(boolean rebuildAll) {
myRebuildAll = rebuildAll;
return this;
}
public OptionsBuilder incremental(@NotNull IncrementalGenerationStrategy incrementalStrategy) {
myIncrementalStrategy = incrementalStrategy;
return this;
}
public OptionsBuilder generateInParallel(boolean generateInParallel, int numberOfThreads) {
myGenerateInParallel = generateInParallel;
myNumberOfThreads = numberOfThreads;
return this;
}
public OptionsBuilder reporting(boolean showInfo, boolean showWarnings, boolean keepModelsWithWarnings, int numberOfModelsToKeep) {
myShowInfo = showInfo;
myShowWarnings = showWarnings;
myKeepModelsWithWarnings = keepModelsWithWarnings;
myNumberOfModelsToKeep = numberOfModelsToKeep;
return this;
}
public OptionsBuilder tracing(int tracingMode) {
myTracingMode = tracingMode;
return this;
}
public OptionsBuilder keepOutputModel(boolean keepOutputModel) {
myKeepOutputModel = keepOutputModel;
return this;
}
public OptionsBuilder useDynamicReferences(boolean useDynamicRefs) {
myUseDynamicRefs = useDynamicRefs;
return this;
}
public OptionsBuilder customPlan(@NotNull SModel model, @NotNull ModelGenerationPlan modelGenerationPlan) {
myCustomPlans.put(model, modelGenerationPlan);
return this;
}
}
}