ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From meta...@locus.apache.org
Subject cvs commit: jakarta-ant/src/antidote/org/apache/tools/ant/gui/ide EmacsNotifier.java FileErrorNotifier.java
Date Thu, 16 Nov 2000 18:32:29 GMT
metasim     00/11/16 10:32:29

  Added:       src/antidote/org/apache/tools/ant/gui/ide EmacsNotifier.java
                        FileErrorNotifier.java
  Log:
  Added option to turn on notification of emacs on a build error so that emacs
  goes to the file and location of the error. Also added the ability to provide a
  build file to load at startup from the command line.
  
  Revision  Changes    Path
  1.1                  jakarta-ant/src/antidote/org/apache/tools/ant/gui/ide/EmacsNotifier.java
  
  Index: EmacsNotifier.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999, 2000 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package org.apache.tools.ant.gui.ide;
  
  import org.apache.tools.ant.taskdefs.ExecTask;
  import org.apache.tools.ant.Project;
  import java.util.StringTokenizer;
  import java.io.File;
  
  /**
   * FileErrorNotifier specialization for sending file error
   * messages to emacs via the emacsclient command. This
   * command <i>must</i> be in the runtime path of the JVM for
   * it to be found.  
   * <p> Install the notifier by running Ant as follows:<br> 
   * <code> 
   * &nbsp;&nbsp;ant -listener net.noemis.ant.EmacsNotifier 
   * </code>
   * 
   * @version $Revision: 1.1 $ 
   * @author <a href="mailto:simeon@fitch.net">Simeon H.K. Fitch</a> */
  public class EmacsNotifier extends FileErrorNotifier {
      /** Command to run to communicate with emacs. */
  	// XXX This should only be a default. A property should be checked
  	// for the actual version. Should Project.getProperty() or 
  	// Project.getUserProperty() be used???
      private static final String EMACS = "emacsclient";
  
  	/** 
  	 * Called when a message has been logged indicating that
  	 * there is an error of some sort at the given file and
  	 * line number.  Sends a message bto emacs to make emacs
  	 * visit the file and place the mark at the source of
  	 * the error.
  	 * 
  	 * @param file File containing the error.
  	 * @param lineNum Line number of error.  
  	 */
  	protected void fireFileErrorNotification(
  		Project project, File file, int lineNum) {
  		// Launch our command using the built in exec support.
  		ExecTask exec = (ExecTask) project.createTask("exec");
  		// Construct the command to communicate with emacs.
  		// Command has the form:
  		//     emacsclient [-n] [--no-wait] [+LINENUMBER] FILENAME
  		exec.setExecutable(EMACS);
  		exec.createArg().setValue("-n");
  		exec.createArg().setValue("--no-wait");
  		exec.createArg().setValue("+" + lineNum);
  		exec.createArg().setValue(file.toString());
  		exec.setFailonerror(false);
  		exec.execute();
  	}
  }
  
  
  
  1.1                  jakarta-ant/src/antidote/org/apache/tools/ant/gui/ide/FileErrorNotifier.java
  
  Index: FileErrorNotifier.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999, 2000 The Apache Software Foundation.  All rights
   * reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions
   * are met:
   *
   * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution, if
   *    any, must include the following acknowlegement:
   *       "This product includes software developed by the
   *        Apache Software Foundation (http://www.apache.org/)."
   *    Alternately, this acknowlegement may appear in the software itself,
   *    if and wherever such third-party acknowlegements normally appear.
   *
   * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
   *    Foundation" must not be used to endorse or promote products derived
   *    from this software without prior written permission. For written
   *    permission, please contact apache@apache.org.
   *
   * 5. Products derived from this software may not be called "Apache"
   *    nor may "Apache" appear in their names without prior written
   *    permission of the Apache Group.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package org.apache.tools.ant.gui.ide;
  
  import org.apache.tools.ant.BuildListener;
  import org.apache.tools.ant.BuildEvent;
  import org.apache.tools.ant.Project;
  import java.util.StringTokenizer;
  import java.io.File;
  
  /**
   * Abstract base class for BuildListener specializations interested
   * in notification of build errors in source files.
   *
   * @version $Revision: 1.1 $ 
   * @author <a href="mailto:simeon@fitch.net">Simeon H.K. Fitch</a>
   */
  abstract class FileErrorNotifier implements BuildListener {
      /** Command to run to communicate with emacs. */
      private static final String EMACS = "emacsclient";
  
      /**
       * Fired whenever a message is logged. Parses error messages looking
       * for a filename and line number specification, which when found
  	 * is then sent to the method <code>fireFileErrorNotification()</code>
       * source of the error. Only the first error is processed.
       *
  	 * @param event Incoming event that is filtered for error messages.
       */
      public void messageLogged(BuildEvent event) {
          if(event.getPriority() == Project.MSG_ERR ||
             event.getPriority() == Project.MSG_WARN) {
              StringTokenizer tok = new StringTokenizer(event.getMessage(), ":");
              File file = null;
              int line = -1;
              
              if(tok.hasMoreTokens()) {
                  file = new File(tok.nextToken());
                  if(tok.hasMoreTokens()) {
                      try {
                          line = Integer.parseInt(tok.nextToken());
                      }
                      catch(NumberFormatException ex) {
                          // Allow execption to fall through as we test
                          // success by the value of 'line' below.
                      }
                  }
              }
  
              // Test for successful filename and line number detection.
              if(file != null && line > 0 && file.exists()) {
                  // Since we only want to trigger on the first error, 
                  // remove ourself from being notified of others.
  				// XXX are there any reasons this should occur after
  				// notification?
                  event.getProject().removeBuildListener(this);
  
  				// Send notification.
  				fireFileErrorNotification(event.getProject(), file, line);
              }
          }
      }
  
  	/** 
  	 * Called when a message has been logged indicating that there
  	 * is an error of some sort at the given file and line number.
  	 * 
  	 * @param file File containing the error.
  	 * @param lineNum Line number of error.
  	 */
  	protected abstract void fireFileErrorNotification(
  		Project project, File file, int lineNum);
  
      // Event types that are ignored. Looks like we really need a
      //  BuildAdapter class...
      /** Ignored */
      public void buildStarted(BuildEvent event) {
      }
      /** Ignored */
      public void buildFinished(BuildEvent event) {
      }
      /** Ignored */
      public void targetStarted(BuildEvent event) {
      }
      /** Ignored */
      public void targetFinished(BuildEvent event) {
      }
      /** Ignored */
      public void taskStarted(BuildEvent event) {
      }
      /** Ignored */
      public void taskFinished(BuildEvent event) {
      }
  }
  
  
  

Mime
View raw message