SourceSubstituteMacroNodesContext.java

/*
 * 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.template;

import jetbrains.mps.generator.runtime.TemplateContext;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.mps.openapi.model.SNodeReference;

/**
 * Despite the name, the context serves not only to 'sourceNodesQuery' in macros but also to similar queries in
 * rules (any sourceNodesQuery) in fact.
 * For transition period (I don't like the idea of templates instantiating these context classes directly) I leave this
 * class and its usages as is (i.e. both from rules and macros), although have changed superclass to fulfil genContext.templateNode
 * contract.
 */
public class SourceSubstituteMacroNodesContext extends TemplateQueryContextWithMacro {
  private final SNodeReference myRulePointer;

  /**
   * @since 3.1
   */
  public SourceSubstituteMacroNodesContext(@NotNull TemplateContext context, @NotNull SNodeReference templateNode) {
    super(context, templateNode);
    myRulePointer = null;
  }

  @Override
  protected SNodeReference getTemplateNodeRef() {
    SNodeReference tn = super.getTemplateNodeRef();
    if (tn != null) {
      return tn;
    }
    return getRuleNode();
  }

  @Override
  protected SNodeReference getRuleNode() {
    return myRulePointer;
  }
}