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

import jetbrains.mps.generator.impl.GenerationFailureException;
import jetbrains.mps.generator.template.WeavingMappingRuleContext;
import org.jetbrains.mps.openapi.model.SNode;

/**
 * Queries associated with a weaving rule
 * @author Artem Tikhomirov
 */
public interface WeaveRuleQuery extends Query {
  /**
   * Mandatory query of a rule that gives node in output model that would serve as parent for weaved nodes
   * @param ctx environment for the query, never <code>null</code>
   * @return parent node in output model for nodes being weaved into
   */
  SNode contextNode(WeavingMappingRuleContext ctx) throws GenerationFailureException;
}
