/*
* Copyright 2003-2016 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.fileGenerator;
import jetbrains.mps.util.annotation.ToRemove;
import jetbrains.mps.vfs.IFile;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.mps.openapi.model.SModel;
import org.jetbrains.mps.openapi.model.SModelReference;
import java.io.File;
/**
* @deprecated This class doesn't respect overridden output location ({@link jetbrains.mps.extapi.model.GeneratableSModel#isGenerateIntoModelFolder()} nor
* does it tell anything about where to take <code>outputRootDir</code> from (assumes it comes
* from {@link jetbrains.mps.project.SModuleOperations#getOutputRoot(SModel)} while it's common to see invocations of
* {@link #getDefaultOutputDir(SModel, IFile)} with <code>((AbstractModule) module).getOutputPath()</code>
*
* TODO remove once 3.5 is out as replacement API, {@link jetbrains.mps.project.facets.GenerationTargetFacet}, has been introduced in 3.5 and there's no
* legitimate way to get rid of used of the class prior to that. Uses of the class in MPS code are implementation dependencies and shall get refactored
* one the class is gone (either copy implementation or drop transitional uses).
*/
@Deprecated
@ToRemove(version = 3.4)
public class FileGenerationUtil {
private static final String CACHES_SUFFIX = ".caches";
public static String getCachesPath(String outputRoot) {
return outputRoot + CACHES_SUFFIX;
}
public static IFile getCachesDir(IFile outputRoot) {
return outputRoot.getFileSystem().getFile(outputRoot.toPath() + CACHES_SUFFIX);
}
public static IFile getDefaultOutputDir(org.jetbrains.mps.openapi.model.SModel model, @NotNull IFile outputRootDir) {
return getDefaultOutputDir(model.getReference(), outputRootDir);
}
/**
* Returns a (sub-)subdirectory of outputRootDir matching the reference model package.
*/
public static IFile getDefaultOutputDir(SModelReference reference, @NotNull IFile outputRootDir) {
String packageName = reference.getName().getLongName();
String packagePath;
if (outputRootDir.isInArchive()) {
// in fact, we shall not care about *output* dir in archives. However, the same code is likely used for any source path, e.g. to access
// generated source files from deployed modules.
packagePath = packageName.replace('.', '/');
} else {
packagePath = packageName.replace('.', File.separatorChar);
}
return outputRootDir.getDescendant(packagePath);
}
}