/*
* 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.smodel.language;
import jetbrains.mps.aspects.InOrderSorter;
import jetbrains.mps.smodel.Language;
import jetbrains.mps.smodel.LanguageAspect;
import jetbrains.mps.smodel.structure.ExtensionPoint;
import jetbrains.mps.util.IterableUtil;
import jetbrains.mps.util.annotation.ToRemove;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.mps.openapi.language.SLanguage;
import org.jetbrains.mps.openapi.model.SModel;
import org.jetbrains.mps.openapi.module.SModule;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
/**
* All common work with language aspect should be done using this class.
* The aim is to simultaneously support LanguageAspects and new LanguageAspectDescriptor during migration from old one to new
* without making them inherit each other
* After completing the refactoring (3.3?), this class chould be cleaned up together with removal of LanguageAspect class
*/
public class LanguageAspectSupport {
private static final Logger LOG = LogManager.getLogger(LanguageAspectSupport.class);
public static boolean isAspectModel(SModel model) {
SModule module = model.getModule();
if (!(module instanceof Language)) return false;
if (getOldAspect(model) != null) return true;
if (getNewAspect(model) != null) return true;
return false;
}
public static Collection<SModel> getAspectModels(@NotNull SModule language) {
assert language instanceof Language;
//as soon as this class is API-like, it's not good to have Language parameter here as in API we work with SModule
LinkedHashSet<SModel> result = new LinkedHashSet<SModel>();
for (LanguageAspectDescriptor d : collectAspects()) {
result.addAll(d.getAspectModels(language));
}
//falling back to old aspects for case where getAspectModels() is called before new aspects are initialized
for (LanguageAspect la : LanguageAspect.values()) {
SModel aspectModel = la.get(((Language) language));
if (aspectModel == null) continue;
result.add(aspectModel);
}
return result;
}
public static Collection<LanguageAspectDescriptor> collectAspects() {
Collection<LanguageAspectDescriptor> newAspects =
IterableUtil.asCollection(new ExtensionPoint<LanguageAspectDescriptor>("jetbrains.mps.lang.aspect.LanguageAspectsEP").getObjects());
return new InOrderSorter<>(newAspects).sort();
}
@Nullable
public static String getHelpUrl(SModel model) {
if (!(model.getModule() instanceof Language)) return null;
for (LanguageAspectDescriptor d : collectAspects()) {
if (d.getAspectModels(model.getModule()).contains(model)) return d.getHelpUrl();
}
for (LanguageAspect la : LanguageAspect.values()) {
if (la.is(model)) return la.getHelpURL();
}
return null;
}
public static Collection<SLanguage> getMainLanguages(SModel model) {
LanguageAspectDescriptor newAspect = getNewAspect(model);
if (newAspect != null) return newAspect.getMainLanguages();
LanguageAspect oldAspect = getOldAspect(model);
if (oldAspect != null) return oldAspect.getMainLanguages();
return Collections.emptyList();
}
public static Collection<SLanguage> getAdditionalLanguages(SModel model) {
LanguageAspectDescriptor newAspect = getNewAspect(model);
if (newAspect != null) return newAspect.getAdditionalLanguages();
LanguageAspect oldAspect = getOldAspect(model);
if (oldAspect != null) return oldAspect.getMainLanguages();
return Collections.emptyList();
}
public static boolean isLanguageModelNameForbidden(String modelName) {
String shortName = modelName.substring(modelName.lastIndexOf(".") + 1);
for (LanguageAspect aspect : LanguageAspect.values()) {
if (shortName.equals(aspect.getName())) {
return true;
}
}
for (LanguageAspectDescriptor ad : collectAspects()) {
if (shortName.equals(ad.getPresentableAspectName())) {
return true;
}
}
return false;
}
@Nullable
public static String getIconPath(SModel model) {
//todo
return null;
}
@Nullable
@Deprecated
@ToRemove(version = 3.3)
//for internal use only
public static LanguageAspect getOldAspect(SModel model) {
for (LanguageAspect la : LanguageAspect.values()) {
if (la.is(model)) return la;
}
return null;
}
@Nullable
@Deprecated
@ToRemove(version = 3.3)
//for internal use only
public static LanguageAspectDescriptor getNewAspect(SModel model) {
for (LanguageAspectDescriptor d : collectAspects()) {
if (d.getAspectModels(model.getModule()).contains(model)) return d;
}
return null;
}
}