src/uk/ac/vamsas/objects/utils/Format.java

   1 /*\r
   2  * Cay S. Horstmann & Gary Cornell, Core Java\r
   3  * Published By Sun Microsystems Press/Prentice-Hall\r
   4  * Copyright (C) 1997 Sun Microsystems Inc.\r
   5  * All Rights Reserved.\r
   6  *\r
   7  * Permission to use, copy, modify, and distribute this \r
   8  * software and its documentation for NON-COMMERCIAL purposes\r
   9  * and without fee is hereby granted provided that this \r
  10  * copyright notice appears in all copies. \r
  11  * \r
  12  * THE AUTHORS AND PUBLISHER MAKE NO REPRESENTATIONS OR \r
  13  * WARRANTIES ABOUT THE SUITABILITY OF THE SOFTWARE, EITHER \r
  14  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE \r
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A \r
  16  * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THE AUTHORS\r
  17  * AND PUBLISHER SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED \r
  18  * BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING \r
  19  * THIS SOFTWARE OR ITS DERIVATIVES.\r
  20  */\r
  21 \r
  22 /**\r
  23  * A class for formatting numbers that follows printf conventions.\r
  24  * Also implements C-like atoi and atof functions\r
  25  * @version 1.03 25 Oct 1997\r
  26  * @author Cay Horstmann\r
  27  */\r
  28 \r
  29 package uk.ac.vamsas.objects.utils;\r
  30 \r
  31 import java.io.*;\r
  32 \r
  33 public class Format { /**\r
  34      * Formats the number following printf conventions.\r
  35      * Main limitation: Can only handle one format parameter at a time\r
  36      * Use multiple Format objects to format more than one number\r
  37      * @param s the format string following printf conventions\r
  38      * The string has a prefix, a format code and a suffix. The prefix and suffix\r
  39      * become part of the formatted output. The format code directs the\r
  40      * formatting of the (single) parameter to be formatted. The code has the\r
  41      * following structure\r
  42      * <ul>\r
  43      * <li> a % (required)\r
  44      * <li> a modifier (optional)\r
  45      * <dl>\r
  46      * <dt> + <dd> forces display of + for positive numbers\r
  47      * <dt> 0 <dd> show leading zeroes\r
  48      * <dt> - <dd> align left in the field\r
  49      * <dt> space <dd> prepend a space in front of positive numbers\r
  50      * <dt> # <dd> use "alternate" format. Add 0 or 0x for octal or hexadecimal numbers. Don't suppress trailing zeroes in general floating point format.\r
  51      * </dl>\r
  52      * <li> an integer denoting field width (optional)\r
  53      * <li> a period followed by an integer denoting precision (optional)\r
  54      * <li> a format descriptor (required)\r
  55      * <dl>\r
  56      * <dt>f <dd> floating point number in fixed format\r
  57      * <dt>e, E <dd> floating point number in exponential notation (scientific format). The E format results in an uppercase E for the exponent (1.14130E+003), the e format in a lowercase e.\r
  58      * <dt>g, G <dd> floating point number in general format (fixed format for small numbers, exponential format for large numbers). Trailing zeroes are suppressed. The G format results in an uppercase E for the exponent (if any), the g format in a lowercase e.\r
  59      * <dt>d, i <dd> integer in decimal\r
  60      * <dt>x <dd> integer in hexadecimal\r
  61      * <dt>o <dd> integer in octal\r
  62      * <dt>s <dd> string\r
  63      * <dt>c <dd> character\r
  64      * </dl>\r
  65      * </ul>\r
  66      * @exception IllegalArgumentException if bad format\r
  67      */\r
  68 \r
  69   public Format(String s) {\r
  70     width = 0;\r
  71     precision = -1;\r
  72     pre = "";\r
  73     post = "";\r
  74     leading_zeroes = false;\r
  75     show_plus = false;\r
  76     alternate = false;\r
  77     show_space = false;\r
  78     left_align = false;\r
  79     fmt = ' ';\r
  80 \r
  81     int state = 0;\r
  82     int length = s.length();\r
  83     int parse_state = 0;\r
  84     // 0 = prefix, 1 = flags, 2 = width, 3 = precision,\r
  85     // 4 = format, 5 = end\r
  86     int i = 0;\r
  87 \r
  88     while (parse_state == 0) {\r
  89       if (i >= length)\r
  90         parse_state = 5;\r
  91       else if (s.charAt(i) == '%') {\r
  92         if (i < length - 1) {\r
  93           if (s.charAt(i + 1) == '%') {\r
  94             pre = pre + '%';\r
  95             i++;\r
  96           } else\r
  97             parse_state = 1;\r
  98         } else\r
  99           throw new java.lang.IllegalArgumentException();\r
 100       } else\r
 101         pre = pre + s.charAt(i);\r
 102       i++;\r
 103     }\r
 104     while (parse_state == 1) {\r
 105       if (i >= length)\r
 106         parse_state = 5;\r
 107       else if (s.charAt(i) == ' ')\r
 108         show_space = true;\r
 109       else if (s.charAt(i) == '-')\r
 110         left_align = true;\r
 111       else if (s.charAt(i) == '+')\r
 112         show_plus = true;\r
 113       else if (s.charAt(i) == '0')\r
 114         leading_zeroes = true;\r
 115       else if (s.charAt(i) == '#')\r
 116         alternate = true;\r
 117       else {\r
 118         parse_state = 2;\r
 119         i--;\r
 120       }\r
 121       i++;\r
 122     }\r
 123     while (parse_state == 2) {\r
 124       if (i >= length)\r
 125         parse_state = 5;\r
 126       else if ('0' <= s.charAt(i) && s.charAt(i) <= '9') {\r
 127         width = width * 10 + s.charAt(i) - '0';\r
 128         i++;\r
 129       } else if (s.charAt(i) == '.') {\r
 130         parse_state = 3;\r
 131         precision = 0;\r
 132         i++;\r
 133       } else\r
 134         parse_state = 4;\r
 135     }\r
 136     while (parse_state == 3) {\r
 137       if (i >= length)\r
 138         parse_state = 5;\r
 139       else if ('0' <= s.charAt(i) && s.charAt(i) <= '9') {\r
 140         precision = precision * 10 + s.charAt(i) - '0';\r
 141         i++;\r
 142       } else\r
 143         parse_state = 4;\r
 144     }\r
 145     if (parse_state == 4) {\r
 146       if (i >= length)\r
 147         parse_state = 5;\r
 148       else\r
 149         fmt = s.charAt(i);\r
 150       i++;\r
 151     }\r
 152     if (i < length)\r
 153       post = s.substring(i, length);\r
 154   }\r
 155 \r
 156   /**\r
 157   * prints a formatted number following printf conventions\r
 158   * @param s a PrintStream\r
 159   * @param fmt the format string\r
 160   * @param x the double to print\r
 161   */\r
 162 \r
 163   public static void print(java.io.PrintStream s, String fmt, double x) {\r
 164     s.print(new Format(fmt).form(x));\r
 165   }\r
 166 \r
 167   /**\r
 168   * prints a formatted number following printf conventions\r
 169   * @param s a PrintStream\r
 170   * @param fmt the format string\r
 171   * @param x the long to print\r
 172   */\r
 173   public static void print(java.io.PrintStream s, String fmt, long x) {\r
 174     s.print(new Format(fmt).form(x));\r
 175   }\r
 176 \r
 177   /**\r
 178   * prints a formatted number following printf conventions\r
 179   * @param s a PrintStream\r
 180   * @param fmt the format string\r
 181   * @param x the character to \r
 182   */\r
 183 \r
 184   public static void print(java.io.PrintStream s, String fmt, char x) {\r
 185     s.print(new Format(fmt).form(x));\r
 186   }\r
 187 \r
 188   /**\r
 189   * prints a formatted number following printf conventions\r
 190   * @param s a PrintStream, fmt the format string\r
 191   * @param x a string that represents the digits to print\r
 192   */\r
 193 \r
 194   public static void print(java.io.PrintStream s, String fmt, String x) {\r
 195     s.print(new Format(fmt).form(x));\r
 196   }\r
 197 \r
 198   /**\r
 199   * Converts a string of digits (decimal, octal or hex) to an integer\r
 200   * @param s a string\r
 201   * @return the numeric value of the prefix of s representing a base 10 integer\r
 202   */\r
 203 \r
 204   public static int atoi(String s) {\r
 205     return (int)atol(s);\r
 206   }\r
 207 \r
 208   /**\r
 209   * Converts a string of digits (decimal, octal or hex) to a long integer\r
 210   * @param s a string\r
 211   * @return the numeric value of the prefix of s representing a base 10 integer\r
 212   */\r
 213 \r
 214   public static long atol(String s) {\r
 215     int i = 0;\r
 216 \r
 217     while (i < s.length() && Character.isWhitespace(s.charAt(i)))\r
 218       i++;\r
 219     if (i < s.length() && s.charAt(i) == '0') {\r
 220       if (i + 1 < s.length() && (s.charAt(i + 1) == 'x' || s.charAt(i + 1) == 'X'))\r
 221         return parseLong(s.substring(i + 2), 16);\r
 222       else\r
 223         return parseLong(s, 8);\r
 224     } else\r
 225       return parseLong(s, 10);\r
 226   }\r
 227 \r
 228   private static long parseLong(String s, int base) {\r
 229     int i = 0;\r
 230     int sign = 1;\r
 231     long r = 0;\r
 232 \r
 233     while (i < s.length() && Character.isWhitespace(s.charAt(i)))\r
 234       i++;\r
 235     if (i < s.length() && s.charAt(i) == '-') {\r
 236       sign = -1;\r
 237       i++;\r
 238     } else if (i < s.length() && s.charAt(i) == '+') {\r
 239       i++;\r
 240     }\r
 241     while (i < s.length()) {\r
 242       char ch = s.charAt(i);\r
 243       if ('0' <= ch && ch < '0' + base)\r
 244         r = r * base + ch - '0';\r
 245       else if ('A' <= ch && ch < 'A' + base - 10)\r
 246         r = r * base + ch - 'A' + 10 ;\r
 247       else if ('a' <= ch && ch < 'a' + base - 10)\r
 248         r = r * base + ch - 'a' + 10 ;\r
 249       else\r
 250         return r * sign;\r
 251       i++;\r
 252     }\r
 253     return r * sign;\r
 254   }\r
 255 \r
 256   /**\r
 257   * Converts a string of digits to an double\r
 258   * @param s a string\r
 259   */\r
 260 \r
 261   public static double atof(String s) {\r
 262     int i = 0;\r
 263     int sign = 1;\r
 264     double r = 0; // integer part\r
 265     double f = 0; // fractional part\r
 266     double p = 1; // exponent of fractional part\r
 267     int state = 0; // 0 = int part, 1 = frac part\r
 268 \r
 269     while (i < s.length() && Character.isWhitespace(s.charAt(i)))\r
 270       i++;\r
 271     if (i < s.length() && s.charAt(i) == '-') {\r
 272       sign = -1;\r
 273       i++;\r
 274     } else if (i < s.length() && s.charAt(i) == '+') {\r
 275       i++;\r
 276     }\r
 277     while (i < s.length()) {\r
 278       char ch = s.charAt(i);\r
 279       if ('0' <= ch && ch <= '9') {\r
 280         if (state == 0)\r
 281           r = r * 10 + ch - '0';\r
 282         else if (state == 1) {\r
 283           p = p / 10;\r
 284           r = r + p * (ch - '0');\r
 285         }\r
 286       } else if (ch == '.') {\r
 287         if (state == 0)\r
 288           state = 1;\r
 289         else\r
 290           return sign * r;\r
 291       } else if (ch == 'e' || ch == 'E') {\r
 292         long e = (int)parseLong(s.substring(i + 1), 10);\r
 293         return sign * r * Math.pow(10, e);\r
 294       } else\r
 295         return sign * r;\r
 296       i++;\r
 297     }\r
 298     return sign * r;\r
 299   }\r
 300 \r
 301   /**\r
 302   * Formats a double into a string (like sprintf in C)\r
 303   * @param x the number to format\r
 304   * @return the formatted string \r
 305   * @exception IllegalArgumentException if bad argument\r
 306   */\r
 307 \r
 308   public String form(double x) {\r
 309     String r;\r
 310     if (precision < 0)\r
 311       precision = 6;\r
 312     int s = 1;\r
 313     if (x < 0) {\r
 314       x = -x;\r
 315       s = -1;\r
 316     }\r
 317     if (fmt == 'f')\r
 318       r = fixed_format(x);\r
 319     else if (fmt == 'e' || fmt == 'E' || fmt == 'g' || fmt == 'G')\r
 320       r = exp_format(x);\r
 321     else\r
 322       throw new java.lang.IllegalArgumentException();\r
 323 \r
 324     return pad(sign(s, r));\r
 325   }\r
 326 \r
 327   /**\r
 328   * Formats a long integer into a string (like sprintf in C)\r
 329   * @param x the number to format\r
 330   * @return the formatted string \r
 331   */\r
 332 \r
 333   public String form(long x) {\r
 334     String r;\r
 335     int s = 0;\r
 336     if (fmt == 'd' || fmt == 'i') {\r
 337       if (x < 0) {\r
 338         r = ("" + x).substring(1);\r
 339         s = -1;\r
 340       } else {\r
 341         r = "" + x;\r
 342         s = 1;\r
 343       }\r
 344     } else if (fmt == 'o')\r
 345       r = convert(x, 3, 7, "01234567");\r
 346     else if (fmt == 'x')\r
 347       r = convert(x, 4, 15, "0123456789abcdef");\r
 348     else if (fmt == 'X')\r
 349       r = convert(x, 4, 15, "0123456789ABCDEF");\r
 350     else\r
 351       throw new java.lang.IllegalArgumentException();\r
 352 \r
 353     return pad(sign(s, r));\r
 354   }\r
 355 \r
 356   /**\r
 357   * Formats a character into a string (like sprintf in C)\r
 358   * @param x the value to format\r
 359   * @return the formatted string \r
 360   */\r
 361 \r
 362   public String form(char c) {\r
 363     if (fmt != 'c')\r
 364       throw new java.lang.IllegalArgumentException();\r
 365 \r
 366     String r = "" + c;\r
 367     return pad(r);\r
 368   }\r
 369 \r
 370   /**\r
 371   * Formats a string into a larger string (like sprintf in C)\r
 372   * @param x the value to format\r
 373   * @return the formatted string \r
 374   */\r
 375 \r
 376   public String form(String s) {\r
 377     if (fmt != 's')\r
 378       throw new java.lang.IllegalArgumentException();\r
 379     if (precision >= 0)\r
 380       s = s.substring(0, precision);\r
 381     return pad(s);\r
 382   }\r
 383 \r
 384 \r
 385   /**\r
 386   * a test stub for the format class\r
 387   */\r
 388 \r
 389   public static void main(String[] a) {\r
 390     double x = 1.23456789012;\r
 391     double y = 123;\r
 392     double z = 1.2345e30;\r
 393     double w = 1.02;\r
 394     double u = 1.234e-5;\r
 395     int d = 0xCAFE;\r
 396     Format.print(System.out, "x = |%f|\n", x);\r
 397     Format.print(System.out, "u = |%20f|\n", u);\r
 398     Format.print(System.out, "x = |% .5f|\n", x);\r
 399     Format.print(System.out, "w = |%20.5f|\n", w);\r
 400     Format.print(System.out, "x = |%020.5f|\n", x);\r
 401     Format.print(System.out, "x = |%+20.5f|\n", x);\r
 402     Format.print(System.out, "x = |%+020.5f|\n", x);\r
 403     Format.print(System.out, "x = |% 020.5f|\n", x);\r
 404     Format.print(System.out, "y = |%#+20.5f|\n", y);\r
 405     Format.print(System.out, "y = |%-+20.5f|\n", y);\r
 406     Format.print(System.out, "z = |%20.5f|\n", z);\r
 407 \r
 408     Format.print(System.out, "x = |%e|\n", x);\r
 409     Format.print(System.out, "u = |%20e|\n", u);\r
 410     Format.print(System.out, "x = |% .5e|\n", x);\r
 411     Format.print(System.out, "w = |%20.5e|\n", w);\r
 412     Format.print(System.out, "x = |%020.5e|\n", x);\r
 413     Format.print(System.out, "x = |%+20.5e|\n", x);\r
 414     Format.print(System.out, "x = |%+020.5e|\n", x);\r
 415     Format.print(System.out, "x = |% 020.5e|\n", x);\r
 416     Format.print(System.out, "y = |%#+20.5e|\n", y);\r
 417     Format.print(System.out, "y = |%-+20.5e|\n", y);\r
 418 \r
 419     Format.print(System.out, "x = |%g|\n", x);\r
 420     Format.print(System.out, "z = |%g|\n", z);\r
 421     Format.print(System.out, "w = |%g|\n", w);\r
 422     Format.print(System.out, "u = |%g|\n", u);\r
 423     Format.print(System.out, "y = |%.2g|\n", y);\r
 424     Format.print(System.out, "y = |%#.2g|\n", y);\r
 425 \r
 426     Format.print(System.out, "d = |%d|\n", d);\r
 427     Format.print(System.out, "d = |%20d|\n", d);\r
 428     Format.print(System.out, "d = |%020d|\n", d);\r
 429     Format.print(System.out, "d = |%+20d|\n", d);\r
 430     Format.print(System.out, "d = |% 020d|\n", d);\r
 431     Format.print(System.out, "d = |%-20d|\n", d);\r
 432     Format.print(System.out, "d = |%20.8d|\n", d);\r
 433     Format.print(System.out, "d = |%x|\n", d);\r
 434     Format.print(System.out, "d = |%20X|\n", d);\r
 435     Format.print(System.out, "d = |%#20x|\n", d);\r
 436     Format.print(System.out, "d = |%020X|\n", d);\r
 437     Format.print(System.out, "d = |%20.8x|\n", d);\r
 438     Format.print(System.out, "d = |%o|\n", d);\r
 439     Format.print(System.out, "d = |%020o|\n", d);\r
 440     Format.print(System.out, "d = |%#20o|\n", d);\r
 441     Format.print(System.out, "d = |%#020o|\n", d);\r
 442     Format.print(System.out, "d = |%20.12o|\n", d);\r
 443 \r
 444     Format.print(System.out, "s = |%-20s|\n", "Hello");\r
 445     Format.print(System.out, "s = |%-20c|\n", '!');\r
 446 \r
 447     // regression test to confirm fix of reported bugs\r
 448 \r
 449     Format.print(System.out, "|%i|\n", Long.MIN_VALUE);\r
 450 \r
 451     Format.print(System.out, "|%6.2e|\n", 0.0);\r
 452     Format.print(System.out, "|%6.2g|\n", 0.0);\r
 453 \r
 454     Format.print(System.out, "|%6.2f|\n", 9.99);\r
 455     Format.print(System.out, "|%6.2f|\n", 9.999);\r
 456 \r
 457     Format.print(System.out, "|%6.0f|\n", 9.999);\r
 458   }\r
 459 \r
 460   private static String repeat(char c, int n) {\r
 461     if (n <= 0)\r
 462       return "";\r
 463     StringBuffer s = new StringBuffer(n);\r
 464     for (int i = 0; i < n; i++)\r
 465       s.append(c);\r
 466     return s.toString();\r
 467   }\r
 468 \r
 469   private static String convert(long x, int n, int m, String d) {\r
 470     if (x == 0)\r
 471       return "0";\r
 472     String r = "";\r
 473     while (x != 0) {\r
 474       r = d.charAt((int)(x & m)) + r;\r
 475       x = x >>> n;\r
 476     }\r
 477     return r;\r
 478   }\r
 479 \r
 480   private String pad(String r) {\r
 481     String p = repeat(' ', width - r.length());\r
 482     if (left_align)\r
 483       return pre + r + p + post;\r
 484     else\r
 485       return pre + p + r + post;\r
 486   }\r
 487 \r
 488   private String sign(int s, String r) {\r
 489     String p = "";\r
 490     if (s < 0)\r
 491       p = "-";\r
 492     else if (s > 0) {\r
 493       if (show_plus)\r
 494         p = "+";\r
 495       else if (show_space)\r
 496         p = " ";\r
 497     } else {\r
 498       if (fmt == 'o' && alternate && r.length() > 0 && r.charAt(0) != '0')\r
 499         p = "0";\r
 500       else if (fmt == 'x' && alternate)\r
 501         p = "0x";\r
 502       else if (fmt == 'X' && alternate)\r
 503         p = "0X";\r
 504     }\r
 505     int w = 0;\r
 506     if (leading_zeroes)\r
 507       w = width;\r
 508     else if ((fmt == 'd' || fmt == 'i' || fmt == 'x' || fmt == 'X' || fmt == 'o')\r
 509              && precision > 0)\r
 510       w = precision;\r
 511 \r
 512     return p + repeat('0', w - p.length() - r.length()) + r;\r
 513   }\r
 514 \r
 515   private String fixed_format(double d) {\r
 516     boolean removeTrailing\r
 517     = (fmt == 'G' || fmt == 'g') && !alternate;\r
 518     // remove trailing zeroes and decimal point\r
 519 \r
 520     if (d > 0x7FFFFFFFFFFFFFFFL)\r
 521       return exp_format(d);\r
 522     if (precision == 0)\r
 523       return (long)(d + 0.5) + (removeTrailing ? "" : ".");\r
 524 \r
 525     long whole = (long)d;\r
 526     double fr = d - whole; // fractional part\r
 527     if (fr >= 1 || fr < 0)\r
 528       return exp_format(d);\r
 529 \r
 530     double factor = 1;\r
 531     String leading_zeroes = "";\r
 532     for (int i = 1; i <= precision && factor <= 0x7FFFFFFFFFFFFFFFL; i++) {\r
 533       factor *= 10;\r
 534       leading_zeroes = leading_zeroes + "0";\r
 535     }\r
 536     long l = (long) (factor * fr + 0.5);\r
 537     if (l >= factor) {\r
 538       l = 0;\r
 539       whole++;\r
 540     } // CSH 10-25-97\r
 541 \r
 542     String z = leading_zeroes + l;\r
 543     z = "." + z.substring(z.length() - precision, z.length());\r
 544 \r
 545     if (removeTrailing) {\r
 546       int t = z.length() - 1;\r
 547       while (t >= 0 && z.charAt(t) == '0')\r
 548         t--;\r
 549       if (t >= 0 && z.charAt(t) == '.')\r
 550         t--;\r
 551       z = z.substring(0, t + 1);\r
 552     }\r
 553 \r
 554     return whole + z;\r
 555   }\r
 556 \r
 557   private String exp_format(double d) {\r
 558     String f = "";\r
 559     int e = 0;\r
 560     double dd = d;\r
 561     double factor = 1;\r
 562     if (d != 0) {\r
 563       while (dd > 10) {\r
 564         e++;\r
 565         factor /= 10;\r
 566         dd = dd / 10;\r
 567       }\r
 568       while (dd < 1) {\r
 569         e--;\r
 570         factor *= 10;\r
 571         dd = dd * 10;\r
 572       }\r
 573     }\r
 574     if ((fmt == 'g' || fmt == 'G') && e >= -4 && e < precision)\r
 575       return fixed_format(d);\r
 576 \r
 577     d = d * factor;\r
 578     f = f + fixed_format(d);\r
 579 \r
 580     if (fmt == 'e' || fmt == 'g')\r
 581       f = f + "e";\r
 582     else\r
 583       f = f + "E";\r
 584 \r
 585     String p = "000";\r
 586     if (e >= 0) {\r
 587       f = f + "+";\r
 588       p = p + e;\r
 589     } else {\r
 590       f = f + "-";\r
 591       p = p + (-e);\r
 592     }\r
 593 \r
 594     return f + p.substring(p.length() - 3, p.length());\r
 595   }\r
 596 \r
 597   private int width;\r
 598   private int precision;\r
 599   private String pre;\r
 600   private String post;\r
 601   private boolean leading_zeroes;\r
 602   private boolean show_plus;\r
 603   private boolean alternate;\r
 604   private boolean show_space;\r
 605   private boolean left_align;\r
 606   private char fmt; // one of cdeEfgGiosxXos\r
 607 }\r
 608 \r
 609 \r
 610 \r
 611 \r
 612 \r