commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bay...@apache.org
Subject cvs commit: jakarta-commons/lang/src/java/org/apache/commons/lang WordWrapUtils.java
Date Tue, 15 Apr 2003 14:28:41 GMT
bayard      2003/04/15 07:28:41

  Added:       lang/src/test/org/apache/commons/lang WordWrapUtilsTest.java
               lang/src/java/org/apache/commons/lang WordWrapUtils.java
  Log:
  Return of WordWrapUtils, fresh with bugs fixed in StringTaglib. Part of the
  reason for dropping it originally was that I knew my methods [wordWrap rather than wrapText
or wrapLine] had nasty die-a-death bugs and hadn't had time to fix them. These got fixed as
a part of String Taglib so I'm now personally happy with the code. As happy as you can ever
be anyway without more tests to hurt it.
  
  Submitted by:	Henning Schmiedehausen
  
  Revision  Changes    Path
  1.1                  jakarta-commons/lang/src/test/org/apache/commons/lang/WordWrapUtilsTest.java
  
  Index: WordWrapUtilsTest.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002-2003 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", "Commons", 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 Software Foundation.
   *
   * 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.commons.lang;
  
  import junit.framework.Test;
  import junit.framework.TestCase;
  import junit.framework.TestSuite;
  
  /**
   * Unit tests for the wrap methods of WordWrapUtils.
   * 
   * @author <a href="mailto:ridesmet@users.sourceforge.net">Ringo De Smet</a>
   * @version $Id: WordWrapUtilsTest.java,v 1.1 2003/04/15 14:28:41 bayard Exp $
   */
  public class WordWrapUtilsTest extends TestCase {
  
      public WordWrapUtilsTest(String name) {
          super(name);
      }
  
      public static Test suite() {
          TestSuite suite = new TestSuite(WordWrapUtilsTest.class);
          suite.setName("WordWrapperTests");
          return suite;
      }
  
      /**
       * Wrap text. This is the most general use.
       */
      public void testWrapText1() {
          String input =
                  "Here is one line of text that is going to be wrapped after 20 columns.";
          String expected =
                  "Here is one line of\ntext that is going\nto be wrapped after\n20 columns.";
          assertEquals("Text didn't wrap correctly, ", expected, WordWrapUtils.wrapText(input,
"\n", 20));
      }
  
      /**
       * Wrap text with a tab character in the middle of a string.
       */
      public void testWrapText2() {
          String input =
                  "Here is\tone line of text that is going to be wrapped after 20 columns.";
          String expected =
                  "Here is\tone line of\ntext that is going\nto be wrapped after\n20 columns.";
          assertEquals("Text with tab didn't wrap correctly, ", expected, WordWrapUtils.wrapText(input,
"\n", 20));
      }
  
      /**
       * Wrap text with a tab character located at the wrapping column index.
       */
      public void testWrapText3() {
          String input =
                  "Here is one line of\ttext that is going to be wrapped after 20 columns.";
          String expected =
                  "Here is one line\nof\ttext that is\ngoing to be wrapped\nafter 20 columns.";
          assertEquals("Text with tab at wrapping index didn't wrap correctly, ", expected,
WordWrapUtils.wrapText(input, "\n", 20));
      }
  }
  
  
  
  1.1                  jakarta-commons/lang/src/java/org/apache/commons/lang/WordWrapUtils.java
  
  Index: WordWrapUtils.java
  ===================================================================
  /* ====================================================================
   * The Apache Software License, Version 1.1
   *
   * Copyright (c) 2002-2003 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", "Commons", 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 Software Foundation.
   *
   * 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.commons.lang;
  
  import java.util.NoSuchElementException;
  import java.util.StringTokenizer;
  
  /**
   * <code>WordWrapUtils</code> is a utility class to assist with word wrapping.
   * 
   * @author Henri Yandell
   * @author Stephen Colebourne
   * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
   * @version $Id: WordWrapUtils.java,v 1.1 2003/04/15 14:28:41 bayard Exp $
   */
  public class WordWrapUtils {
  
      // Wrapping
      //--------------------------------------------------------------------------
  
      /**
       * Wraps a block of text to a specified line length.
       * <p>
       * This method takes a block of text, which might have long lines in it
       * and wraps the long lines based on the supplied wrapColumn parameter. 
       * It was initially implemented for use by VelocityEmail. If there are tabs
       * in inString, you are going to get results that are a bit strange,
       * since tabs are a single character but are displayed as 4 or 8
       * spaces. Remove the tabs.
       *
       * @param str  text which is in need of word-wrapping
       * @param newline  the characters that define a newline
       * @param wrapColumn  the column to wrap the words at
       * @return the text with all the long lines word-wrapped
       */
      public static String wrapText(String str, String newline, int wrapColumn) {
          StringTokenizer lineTokenizer = new StringTokenizer(str, newline, true);
          StringBuffer stringBuffer = new StringBuffer();
  
          while (lineTokenizer.hasMoreTokens()) {
              try {
                  String nextLine = lineTokenizer.nextToken();
  
                  if (nextLine.length() > wrapColumn) {
                      // This line is long enough to be wrapped.
                      nextLine = wrapLine(nextLine, newline, wrapColumn);
                  }
  
                  stringBuffer.append(nextLine);
  
              } catch (NoSuchElementException nsee) {
                  // thrown by nextToken(), but I don't know why it would
                  break;
              }
          }
  
          return (stringBuffer.toString());
      }
  
      /**
       * Wraps a single line of text. 
       * Called by wrapText() to do the real work of wrapping.
       *
       * @param line  a line which is in need of word-wrapping
       * @param newline  the characters that define a newline
       * @param wrapColumn  the column to wrap the words at
       * @return a line with newlines inserted
       */
      private static String wrapLine(String line, String newline, int wrapColumn) {
          StringBuffer wrappedLine = new StringBuffer();
  
          while (line.length() > wrapColumn) {
              int spaceToWrapAt = line.lastIndexOf(' ', wrapColumn);
  
              if (spaceToWrapAt >= 0) {
                  wrappedLine.append(line.substring(0, spaceToWrapAt));
                  wrappedLine.append(newline);
                  line = line.substring(spaceToWrapAt + 1);
              }
  
              // This must be a really long word or URL. Pass it
              // through unchanged even though it's longer than the
              // wrapColumn would allow. This behavior could be
              // dependent on a parameter for those situations when
              // someone wants long words broken at line length.
              else {
                  spaceToWrapAt = line.indexOf(' ', wrapColumn);
  
                  if (spaceToWrapAt >= 0) {
                      wrappedLine.append(line.substring(0, spaceToWrapAt));
                      wrappedLine.append(newline);
                      line = line.substring(spaceToWrapAt + 1);
                  } else {
                      wrappedLine.append(line);
                      line = "";
                  }
              }
          }
  
          // Whatever is left in line is short enough to just pass through
          wrappedLine.append(line);
  
          return (wrappedLine.toString());
      }
  
      // Word wrapping
      //--------------------------------------------------------------------------
  
      /**
       * Create a word-wrapped version of a String. Wrap at 80 characters and 
       * use newlines as the delimiter. If a word is over 80 characters long 
       * use a - sign to split it.
       */
      public static String wordWrap(String str) {
          return wordWrap(str, 80, "\n", "-");
      }
      /**
       * Create a word-wrapped version of a String. Wrap at a specified width and 
       * use newlines as the delimiter. If a word is over the width in lenght 
       * use a - sign to split it.
       */
      public static String wordWrap(String str, int width) {
          return wordWrap(str, width, "\n", "-");
      }
      /**
       * Word-wrap a string.
       *
       * @param str   String to word-wrap
       * @param width int to wrap at
       * @param delim String to use to separate lines
       * @param split String to use to split a word greater than width long
       *
       * @return String that has been word wrapped
       */
      public static String wordWrap(String str, int width, String delim, String split) {
          int sz = str.length();
  
          /// shift width up one. mainly as it makes the logic easier
          width++;
  
          // our best guess as to an initial size
          StringBuffer buffer = new StringBuffer(sz / width * delim.length() + sz);
  
          // every line will include a delim on the end
          width = width - delim.length();
  
          int idx = -1;
          String substr = null;
  
          // beware: i is rolled-back inside the loop
          for (int i = 0; i < sz; i += width) {
  
              // on the last line
              if (i > sz - width) {
                  buffer.append(str.substring(i));
                  break;
              }
  
              // the current line
              substr = str.substring(i, i + width);
  
              // is the delim already on the line
              idx = substr.indexOf(delim);
              if (idx != -1) {
                  buffer.append(substr.substring(0, idx));
                  buffer.append(delim);
                  i -= width - idx - delim.length();
  
                  // Erase a space after a delim. Is this too obscure?
                  if(substr.length() > idx + 1) {
                      if (substr.charAt(idx + 1) != '\n') {
                          if (Character.isWhitespace(substr.charAt(idx + 1))) {
                              i++;
                          }
                      }
                  }
                  continue;
              }
  
              idx = -1;
  
              // figure out where the last space is
              char[] chrs = substr.toCharArray();
              for (int j = width; j > 0; j--) {
                  if (Character.isWhitespace(chrs[j - 1])) {
                      idx = j;
                      break;
                  }
              }
  
              // idx is the last whitespace on the line.
              if (idx == -1) {
                  for (int j = width; j > 0; j--) {
                      if (chrs[j - 1] == '-') {
                          idx = j;
                          break;
                      }
                  }
                  if (idx == -1) {
                      buffer.append(substr);
                      buffer.append(delim);
                  } else {
                      if (idx != width) {
                          idx++;
                      }
                      buffer.append(substr.substring(0, idx));
                      buffer.append(delim);
                      i -= width - idx;
                  }
              } else {
                      buffer.append(substr.substring(0, idx));
                      buffer.append(StringUtils.repeat(" ", width - idx));
                      buffer.append(delim);
                      i -= width - idx;
              }
          }
          return buffer.toString();
      }
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message