You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by jo...@hyperreal.org on 1999/11/24 21:04:02 UTC

cvs commit: jakarta-tools/ant/src/main/org/apache/tools/ant/taskdefs KeySubst.java defaults.properties

jons        99/11/24 12:04:01

  Modified:    ant/src/main/org/apache/tools/ant/taskdefs
                        defaults.properties
  Added:       ant/src/main/org/apache/tools/ant/taskdefs KeySubst.java
  Log:
  added keyword substitution feature. ;-)
  
  Revision  Changes    Path
  1.6       +2 -1      jakarta-tools/ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties
  
  Index: defaults.properties
  ===================================================================
  RCS file: /home/cvs/jakarta-tools/ant/src/main/org/apache/tools/ant/taskdefs/defaults.properties,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- defaults.properties	1999/11/24 01:38:50	1.5
  +++ defaults.properties	1999/11/24 20:03:58	1.6
  @@ -10,4 +10,5 @@
   get=org.apache.tools.ant.taskdefs.Get
   expand=org.apache.tools.ant.taskdefs.Expand
   echo=org.apache.tools.ant.taskdefs.Echo
  -javadoc2=org.apache.tools.ant.taskdefs.Javadoc2
  \ No newline at end of file
  +javadoc2=org.apache.tools.ant.taskdefs.Javadoc2
  +keysubst=org.apache.tools.ant.taskdefs.KeySubst
  \ No newline at end of file
  
  
  
  1.1                  jakarta-tools/ant/src/main/org/apache/tools/ant/taskdefs/KeySubst.java
  
  Index: KeySubst.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 1999 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.taskdefs;
  
  import org.apache.tools.ant.*;
  import java.io.*;
  import java.util.*;
  
  /**
   * Keyword substitution. Input file is written to output file.
   * Do not make input file same as output file.
   * Keywords in input files look like this: @foo@. See the docs for the 
   * setKeys method to understand how to do the substitutions.
   *
   * @author Jon S. Stevens <a href="mailto:jon@clearink.com">jon@clearink.com</a>
   */
  public class KeySubst extends Task {
      private File source; // required
      private File dest; // required
      private String sep = "*";
      private static String delim = "@";
      private Hashtable replacements = new Hashtable();
      
      /**
          Do the execution.
      */
      public void execute() throws BuildException {
          project.log("Performing Substitions");
          if ( source == null || dest == null ) {
              project.log("Source and destinations must not be null");
              return;            
          }
          BufferedReader br = null;
          BufferedWriter bw = null;
          try {
              br = new BufferedReader(new FileReader(source));
              bw = new BufferedWriter(new FileWriter(dest));
  
              String line = null;
              String newline = null;
              int length;
              line = br.readLine();
              while (line != null) {
                  newline = replace ( line, replacements );
                  bw.write ( newline );
                  bw.newLine();
                  line = br.readLine();
              }
              bw.flush();
              bw.close();
              br.close();
          } catch (IOException ioe) {
              ioe.printStackTrace();
          }       
      }
      /**
          Set the source file.
      */
      public void setSrc(String s) {
          this.source=project.resolveFile(s);
      }
  
      /**
          Set the destination file.
      */
      public void setDest(String dest) {
          this.dest = project.resolveFile(dest);
      }
  
      /**
          Sets the seperator between name=value arguments
          in setKeys(). By default it is "*".
      */
      public void setSep(String sep) {
          this.sep = sep;
      }
      /**
          Sets the deliminator characters that go around the 
          keywords. Ie: @foo@. The "@" in this case is the 
          deliminator. It is also the default.
      */
      public void setDelim(String delim) {
          this.delim = delim;
      }
      /**
          Format string is like this:
          <p>
          name=value*name2=value
          <p>
          Names are case sensitive.
          <p>
          Use the setSep() method to change the * to something else
          if you need to use * as a name or value.
      */
      public void setKeys(String keys) {
          if (keys != null && keys.length() > 0) {
              StringTokenizer tok =
              new StringTokenizer(keys, this.sep, false);
              while (tok.hasMoreTokens()) {
                  String token = tok.nextToken().trim();
                  StringTokenizer itok =
                  new StringTokenizer(token, "=", false);
                  
                  String name = itok.nextToken();
                  String value = itok.nextToken();
  //                System.out.println ( "KeySubst Name: " + name );
  //                System.out.println ( "KeySubst Value: " + value );
                  replacements.put ( name, value );
              }
          }
      }
          
  /*
      public static void main(String[] args)
      {
          try{
          Hashtable hash = new Hashtable();
          hash.put ( "w", "yoaaaau" );
          hash.put ( "a", "ffff" );
          System.out.println ( KeySubst.replace ( "f @w@ - @a@ are", hash ) );
          }catch ( Exception e)
          {
              e.printStackTrace();
          }
      }
  */
      /**
          Does replacement on text using the hashtable of keys.
          This could probably be done a lot better, but for now 
          it does the job and this isn't a time criticial application.
          
          @returns the string with the replacements in it.
      */
      public static String replace ( String text, Hashtable keys )
          throws BuildException
      {
          StringBuffer sb=new StringBuffer();
          int i=0;
          int prev=0;
          int pos=0;
          while( (pos=text.indexOf( delim, prev )) >= 0 ) {
              if(pos>0)
                  sb.append( text.substring( prev, pos ) );
  
              pos++;
              int endName=text.indexOf( delim, pos );
  
              String n=text.substring( pos, endName );
              if ( keys.containsKey( n ) )
              {
                  sb.append ( (String) keys.get(n) );
                  sb.append ( text.charAt( pos + n.length() + 1 ) );
                  prev=pos + n.length() + 2;
              }
              else
              {
                  sb.append ( delim + n + delim);
                  prev=endName + 1;
              }
          }
          if( prev < text.length() ) sb.append( text.substring( prev ) );
          return sb.toString();
      }
  }
  
  

Re: cvs commit: jakarta-tools/ant/src/main/org/apache/tools/ant/taskdefs KeySubst.java defaults.properties

Posted by jon * <jo...@clearink.com>.
on 11/24/99 3:50 PM, James Duncan Davidson <ja...@eng.sun.com>
wrote:

> jons@hyperreal.org wrote:
>> * Keywords in input files look like this: @foo@. See the docs for the
> 
> In general +1. However, in the xml files themselves, we use ${foo} to
> mark key words. Having two different substitution tokens isn't good
> imho.

Ok...I'm actually re-doing this class...the replace() method in it has a
boat load of bugs (i'm horrible at doing string replacement code). I will
change it to use ${foo} instead and re-use your methods that you already
wrote. The reason why I used @aa@ was for backwards compatibility with the
autoconf stuff.

-jon


Re: cvs commit: jakarta-tools/ant/src/main/org/apache/tools/ant/taskdefs KeySubst.java defaults.properties

Posted by James Duncan Davidson <ja...@eng.sun.com>.
jons@hyperreal.org wrote:
>    * Keywords in input files look like this: @foo@. See the docs for the

In general +1. However, in the xml files themselves, we use ${foo} to
mark key words. Having two different substitution tokens isn't good
imho.

.duncan


-- 
James Davidson                                     duncan@eng.sun.com 
Java + XML / Portable Code + Portable Data                 !try; do()