1 /*
2  * Copyright (c) 2021, 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 package compiler.lib.ir_framework.driver;
25 
26 import compiler.lib.ir_framework.IR;
27 import compiler.lib.ir_framework.Test;
28 
29 /**
30  * Exception that is thrown if an {@link IR} rule/constraint failed. The exception message contains a detailed list of
31  * all failures, including failing method(s), {@code @IR} rule(s) (the first {@code @IR} constraint is rule 1) and the
32  * specific regex(es) that could not be matched.
33  *
34  * @see IR
35  * @see Test
36  */
37 public class IRViolationException extends RuntimeException {
38     private final String compilations;
39     private String exceptionInfo;
40 
IRViolationException(String message, String compilations)41     IRViolationException(String message, String compilations) {
42         super("There were one or multiple IR rule failures. Please check stderr for more information.");
43         this.exceptionInfo = message;
44         this.compilations = compilations;
45     }
46 
47     /**
48      * Get some more detailed information about the violated IR rule(s) and how to reproduce it.
49      *
50      * @return a formatted string containing information about the violated IR rule(s) and how to reproduce it.
51      */
getExceptionInfo()52     public String getExceptionInfo() {
53         return exceptionInfo;
54     }
55 
getCompilations()56     public String getCompilations() {
57         return compilations;
58     }
59 
addCommandLine(String commandLine)60     public void addCommandLine(String commandLine) {
61         this.exceptionInfo = commandLine + System.lineSeparator() + exceptionInfo;
62     }
63 }
64