1 /* 2 * Copyright (c) 2014, 2018, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 */ 23 24 25 package org.graalvm.compiler.core.match; 26 27 import java.lang.annotation.ElementType; 28 import java.lang.annotation.Repeatable; 29 import java.lang.annotation.Retention; 30 import java.lang.annotation.RetentionPolicy; 31 import java.lang.annotation.Target; 32 33 import org.graalvm.compiler.nodes.ValueNode; 34 35 /** 36 * Describes the properties of a node for use when building a {@link MatchPattern}. These 37 * declarations are required when parsing a {@link MatchRule}. They are expected to be found on a 38 * super type of the holder of the method declaring the {@link MatchRule}. 39 */ 40 @Retention(RetentionPolicy.RUNTIME) 41 @Target(ElementType.TYPE) 42 @Repeatable(value = MatchableNodes.class) 43 public @interface MatchableNode { 44 45 /** 46 * The {@link ValueNode} subclass this annotation describes. These annotations might work better 47 * if they were directly on the node being described but that may complicate the annotation 48 * processing. 49 */ 50 Class<? extends ValueNode> nodeClass(); 51 52 /** 53 * The names of the inputs in the order they should appear in the match. 54 */ 55 String[] inputs() default {}; 56 57 /** 58 * Can a pattern be matched with the operands swapped. This will cause swapped versions of 59 * patterns to be automatically generated. 60 */ 61 boolean commutative() default false; 62 63 /** 64 * Can a node with multiple uses be safely matched by a rule. 65 */ 66 boolean shareable() default false; 67 }