LanguageAspectDescriptor.java

/*
 * 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.OrderParticipant;
import jetbrains.mps.smodel.runtime.IconResource;
import jetbrains.mps.util.Icon2IconResourceAdapter_Deprecated;
import jetbrains.mps.util.annotation.ToRemove;
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.model.SNode;
import org.jetbrains.mps.openapi.module.SModule;

import javax.swing.Icon;
import javax.swing.ImageIcon;
import java.util.Collection;
import java.util.Collections;

//todo: make identifiers instead of names-as-identifiers
public abstract class LanguageAspectDescriptor implements OrderParticipant<String> {
  private static final IconResource MODEL_ICON = new IconResource("/jetbrains/mps/smodel/language/model.png", LanguageAspectDescriptor.class);

  public abstract String getPresentableAspectName();

  @NotNull
  public abstract Collection<SModel> getAspectModels(SModule language);

  public boolean hasAspect(SModule language) {
    return !getAspectModels(language).isEmpty();
  }

  public boolean canCreate(SModule language) {
    return false;
  }

  public void create(SModule language) {

  }

  @NotNull
  public abstract Collection<SLanguage> getMainLanguages();

  @NotNull
  public Collection<SLanguage> getAdditionalLanguages() {
    return Collections.emptyList();
  }

  @Nullable
  public LanguageAspectGenerator getGenerator() {
    return null;
  }

  @Deprecated
  @ToRemove(version = 3.4)
  @Nullable
  public Icon getIcon() {
    return null;
  }

  @Nullable
  public IconResource getIconResource() {
    Icon icn = getIcon();
    if (icn == null) {
      return MODEL_ICON;
    }
    return new Icon2IconResourceAdapter_Deprecated(icn);
  }

  @Override
  public String getId() {
    return getPresentableAspectName();
  }

  @Override
  public int compareTo(OrderParticipant<String> d) {
    //todo remove body after 3.5, needed for compilation compatibility
    return 0;
  }

  @Nullable
  public String getHelpUrl() {
    return null;
  }

  @Override
  public String toString() {
    return getId();
  }
}