Home | History | Annotate | Download | only in antlr3 
      1 /**
      2  [The "BSD licence"]
      3 
      4  ANTLR        - Copyright (c) 2005-2008 Terence Parr
      5  Maven Plugin - Copyright (c) 2009      Jim Idle
      6 
      7  All rights reserved.
      8 
      9  Redistribution and use in source and binary forms, with or without
     10  modification, are permitted provided that the following conditions
     11  are met:
     12  1. Redistributions of source code must retain the above copyright
     13     notice, this list of conditions and the following disclaimer.
     14  2. Redistributions in binary form must reproduce the above copyright
     15     notice, this list of conditions and the following disclaimer in the
     16     documentation and/or other materials provided with the distribution.
     17  3. The name of the author may not be used to endorse or promote products
     18     derived from this software without specific prior written permission.
     19 
     20  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     21  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     22  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     23  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     24  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     25  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     29  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30 */
     31 package org.antlr.mojo.antlr3;
     32 
     33 import org.antlr.tool.ANTLRErrorListener;
     34 import org.antlr.tool.Message;
     35 import org.antlr.tool.ToolMessage;
     36 import org.apache.maven.plugin.logging.Log;
     37 
     38 /**
     39  * The Maven plexus container gives us a Log logging provider
     40  * which we can use to install an error listener for the ANTLR
     41  * tool to report errors by.
     42  */
     43 public class Antlr3ErrorLog implements ANTLRErrorListener {
     44 
     45     private Log log;
     46 
     47     /**
     48      * Instantiate an ANTLR ErrorListner that communicates any messages
     49      * it receives to the Maven error sink.
     50      *
     51      * @param log The Maven Error Log
     52      */
     53     public Antlr3ErrorLog(Log log) {
     54         this.log = log;
     55     }
     56 
     57     /**
     58      * Sends an informational message to the Maven log sink.
     59      * @param s The message to send to Maven
     60      */
     61     public void info(String message) {
     62         log.info(message);
     63     }
     64 
     65     /**
     66      * Sends an error message from ANTLR analysis to the Maven Log sink.
     67      *
     68      * @param message The message to send to Maven.
     69      */
     70     public void error(Message message) {
     71         log.error(message.toString());
     72     }
     73 
     74     /**
     75      * Sends a warning message to the Maven log sink.
     76      *
     77      * @param message
     78      */
     79     public void warning(Message message) {
     80         log.warn(message.toString());
     81     }
     82 
     83     /**
     84      * Sends an error message from the ANTLR tool to the Maven Log sink.
     85      * @param toolMessage
     86      */
     87     public void error(ToolMessage toolMessage) {
     88         log.error(toolMessage.toString());
     89     }
     90 }
     91