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
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
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
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
29 package jalview.util;
\r
33 public class Format {
\r
35 * Formats the number following printf conventions.
\r
36 * Main limitation: Can only handle one format parameter at a time
\r
37 * Use multiple Format objects to format more than one number
\r
38 * @param s the format string following printf conventions
\r
39 * The string has a prefix, a format code and a suffix. The prefix and suffix
\r
40 * become part of the formatted output. The format code directs the
\r
41 * formatting of the (single) parameter to be formatted. The code has the
\r
42 * following structure
\r
44 * <li> a % (required)
\r
45 * <li> a modifier (optional)
\r
47 * <dt> + <dd> forces display of + for positive numbers
\r
48 * <dt> 0 <dd> show leading zeroes
\r
49 * <dt> - <dd> align left in the field
\r
50 * <dt> space <dd> prepend a space in front of positive numbers
\r
51 * <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
53 * <li> an integer denoting field width (optional)
\r
54 * <li> a period followed by an integer denoting precision (optional)
\r
55 * <li> a format descriptor (required)
\r
57 * <dt>f <dd> floating point number in fixed format
\r
58 * <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
59 * <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
60 * <dt>d, i <dd> integer in decimal
\r
61 * <dt>x <dd> integer in hexadecimal
\r
62 * <dt>o <dd> integer in octal
\r
64 * <dt>c <dd> character
\r
67 * @exception IllegalArgumentException if bad format
\r
71 public static String getHexString(java.awt.Color color)
\r
74 r = Integer.toHexString(color.getRed());
\r
77 g = Integer.toHexString(color.getGreen());
\r
80 b = Integer.toHexString(color.getBlue());
\r
88 public Format(String s) {
\r
93 leading_zeroes = false;
\r
101 int length = s.length();
\r
102 int parse_state = 0;
\r
103 // 0 = prefix, 1 = flags, 2 = width, 3 = precision,
\r
104 // 4 = format, 5 = end
\r
107 while (parse_state == 0) {
\r
110 else if (s.charAt(i) == '%') {
\r
111 if (i < length - 1) {
\r
112 if (s.charAt(i + 1) == '%') {
\r
118 throw new java.lang.IllegalArgumentException();
\r
120 pre = pre + s.charAt(i);
\r
123 while (parse_state == 1) {
\r
126 else if (s.charAt(i) == ' ')
\r
128 else if (s.charAt(i) == '-')
\r
130 else if (s.charAt(i) == '+')
\r
132 else if (s.charAt(i) == '0')
\r
133 leading_zeroes = true;
\r
134 else if (s.charAt(i) == '#')
\r
142 while (parse_state == 2) {
\r
145 else if ('0' <= s.charAt(i) && s.charAt(i) <= '9') {
\r
146 width = width * 10 + s.charAt(i) - '0';
\r
148 } else if (s.charAt(i) == '.') {
\r
155 while (parse_state == 3) {
\r
158 else if ('0' <= s.charAt(i) && s.charAt(i) <= '9') {
\r
159 precision = precision * 10 + s.charAt(i) - '0';
\r
164 if (parse_state == 4) {
\r
172 post = s.substring(i, length);
\r
176 * prints a formatted number following printf conventions
\r
177 * @param s a PrintStream
\r
178 * @param fmt the format string
\r
179 * @param x the double to print
\r
182 public static void print(java.io.PrintStream s, String fmt, double x) {
\r
183 s.print(new Format(fmt).form(x));
\r
187 * prints a formatted number following printf conventions
\r
188 * @param s a PrintStream
\r
189 * @param fmt the format string
\r
190 * @param x the long to print
\r
192 public static void print(java.io.PrintStream s, String fmt, long x) {
\r
193 s.print(new Format(fmt).form(x));
\r
197 * prints a formatted number following printf conventions
\r
198 * @param s a PrintStream
\r
199 * @param fmt the format string
\r
200 * @param x the character to
\r
203 public static void print(java.io.PrintStream s, String fmt, char x) {
\r
204 s.print(new Format(fmt).form(x));
\r
208 * prints a formatted number following printf conventions
\r
209 * @param s a PrintStream, fmt the format string
\r
210 * @param x a string that represents the digits to print
\r
213 public static void print(java.io.PrintStream s, String fmt, String x) {
\r
214 s.print(new Format(fmt).form(x));
\r
218 * Converts a string of digits (decimal, octal or hex) to an integer
\r
219 * @param s a string
\r
220 * @return the numeric value of the prefix of s representing a base 10 integer
\r
223 public static int atoi(String s) {
\r
224 return (int)atol(s);
\r
228 * Converts a string of digits (decimal, octal or hex) to a long integer
\r
229 * @param s a string
\r
230 * @return the numeric value of the prefix of s representing a base 10 integer
\r
233 public static long atol(String s) {
\r
236 while (i < s.length() && Character.isWhitespace(s.charAt(i)))
\r
238 if (i < s.length() && s.charAt(i) == '0') {
\r
239 if (i + 1 < s.length() && (s.charAt(i + 1) == 'x' || s.charAt(i + 1) == 'X'))
\r
240 return parseLong(s.substring(i + 2), 16);
\r
242 return parseLong(s, 8);
\r
244 return parseLong(s, 10);
\r
247 private static long parseLong(String s, int base) {
\r
252 while (i < s.length() && Character.isWhitespace(s.charAt(i)))
\r
254 if (i < s.length() && s.charAt(i) == '-') {
\r
257 } else if (i < s.length() && s.charAt(i) == '+') {
\r
260 while (i < s.length()) {
\r
261 char ch = s.charAt(i);
\r
262 if ('0' <= ch && ch < '0' + base)
\r
263 r = r * base + ch - '0';
\r
264 else if ('A' <= ch && ch < 'A' + base - 10)
\r
265 r = r * base + ch - 'A' + 10 ;
\r
266 else if ('a' <= ch && ch < 'a' + base - 10)
\r
267 r = r * base + ch - 'a' + 10 ;
\r
276 * Converts a string of digits to an double
\r
277 * @param s a string
\r
280 public static double atof(String s) {
\r
283 double r = 0; // integer part
\r
284 double f = 0; // fractional part
\r
285 double p = 1; // exponent of fractional part
\r
286 int state = 0; // 0 = int part, 1 = frac part
\r
288 while (i < s.length() && Character.isWhitespace(s.charAt(i)))
\r
290 if (i < s.length() && s.charAt(i) == '-') {
\r
293 } else if (i < s.length() && s.charAt(i) == '+') {
\r
296 while (i < s.length()) {
\r
297 char ch = s.charAt(i);
\r
298 if ('0' <= ch && ch <= '9') {
\r
300 r = r * 10 + ch - '0';
\r
301 else if (state == 1) {
\r
303 r = r + p * (ch - '0');
\r
305 } else if (ch == '.') {
\r
310 } else if (ch == 'e' || ch == 'E') {
\r
311 long e = (int)parseLong(s.substring(i + 1), 10);
\r
312 return sign * r * Math.pow(10, e);
\r
321 * Formats a double into a string (like sprintf in C)
\r
322 * @param x the number to format
\r
323 * @return the formatted string
\r
324 * @exception IllegalArgumentException if bad argument
\r
327 public String form(double x) {
\r
337 r = fixed_format(x);
\r
338 else if (fmt == 'e' || fmt == 'E' || fmt == 'g' || fmt == 'G')
\r
341 throw new java.lang.IllegalArgumentException();
\r
343 return pad(sign(s, r));
\r
347 * Formats a long integer into a string (like sprintf in C)
\r
348 * @param x the number to format
\r
349 * @return the formatted string
\r
352 public String form(long x) {
\r
355 if (fmt == 'd' || fmt == 'i') {
\r
357 r = ("" + x).substring(1);
\r
363 } else if (fmt == 'o')
\r
364 r = convert(x, 3, 7, "01234567");
\r
365 else if (fmt == 'x')
\r
366 r = convert(x, 4, 15, "0123456789abcdef");
\r
367 else if (fmt == 'X')
\r
368 r = convert(x, 4, 15, "0123456789ABCDEF");
\r
370 throw new java.lang.IllegalArgumentException();
\r
372 return pad(sign(s, r));
\r
376 * Formats a character into a string (like sprintf in C)
\r
377 * @param x the value to format
\r
378 * @return the formatted string
\r
381 public String form(char c) {
\r
383 throw new java.lang.IllegalArgumentException();
\r
390 * Formats a string into a larger string (like sprintf in C)
\r
391 * @param x the value to format
\r
392 * @return the formatted string
\r
395 public String form(String s) {
\r
397 throw new java.lang.IllegalArgumentException();
\r
398 if (precision >= 0)
\r
399 s = s.substring(0, precision);
\r
405 * a test stub for the format class
\r
408 public static void main(String[] a) {
\r
409 double x = 1.23456789012;
\r
411 double z = 1.2345e30;
\r
413 double u = 1.234e-5;
\r
415 Format.print(System.out, "x = |%f|\n", x);
\r
416 Format.print(System.out, "u = |%20f|\n", u);
\r
417 Format.print(System.out, "x = |% .5f|\n", x);
\r
418 Format.print(System.out, "w = |%20.5f|\n", w);
\r
419 Format.print(System.out, "x = |%020.5f|\n", x);
\r
420 Format.print(System.out, "x = |%+20.5f|\n", x);
\r
421 Format.print(System.out, "x = |%+020.5f|\n", x);
\r
422 Format.print(System.out, "x = |% 020.5f|\n", x);
\r
423 Format.print(System.out, "y = |%#+20.5f|\n", y);
\r
424 Format.print(System.out, "y = |%-+20.5f|\n", y);
\r
425 Format.print(System.out, "z = |%20.5f|\n", z);
\r
427 Format.print(System.out, "x = |%e|\n", x);
\r
428 Format.print(System.out, "u = |%20e|\n", u);
\r
429 Format.print(System.out, "x = |% .5e|\n", x);
\r
430 Format.print(System.out, "w = |%20.5e|\n", w);
\r
431 Format.print(System.out, "x = |%020.5e|\n", x);
\r
432 Format.print(System.out, "x = |%+20.5e|\n", x);
\r
433 Format.print(System.out, "x = |%+020.5e|\n", x);
\r
434 Format.print(System.out, "x = |% 020.5e|\n", x);
\r
435 Format.print(System.out, "y = |%#+20.5e|\n", y);
\r
436 Format.print(System.out, "y = |%-+20.5e|\n", y);
\r
438 Format.print(System.out, "x = |%g|\n", x);
\r
439 Format.print(System.out, "z = |%g|\n", z);
\r
440 Format.print(System.out, "w = |%g|\n", w);
\r
441 Format.print(System.out, "u = |%g|\n", u);
\r
442 Format.print(System.out, "y = |%.2g|\n", y);
\r
443 Format.print(System.out, "y = |%#.2g|\n", y);
\r
445 Format.print(System.out, "d = |%d|\n", d);
\r
446 Format.print(System.out, "d = |%20d|\n", d);
\r
447 Format.print(System.out, "d = |%020d|\n", d);
\r
448 Format.print(System.out, "d = |%+20d|\n", d);
\r
449 Format.print(System.out, "d = |% 020d|\n", d);
\r
450 Format.print(System.out, "d = |%-20d|\n", d);
\r
451 Format.print(System.out, "d = |%20.8d|\n", d);
\r
452 Format.print(System.out, "d = |%x|\n", d);
\r
453 Format.print(System.out, "d = |%20X|\n", d);
\r
454 Format.print(System.out, "d = |%#20x|\n", d);
\r
455 Format.print(System.out, "d = |%020X|\n", d);
\r
456 Format.print(System.out, "d = |%20.8x|\n", d);
\r
457 Format.print(System.out, "d = |%o|\n", d);
\r
458 Format.print(System.out, "d = |%020o|\n", d);
\r
459 Format.print(System.out, "d = |%#20o|\n", d);
\r
460 Format.print(System.out, "d = |%#020o|\n", d);
\r
461 Format.print(System.out, "d = |%20.12o|\n", d);
\r
463 Format.print(System.out, "s = |%-20s|\n", "Hello");
\r
464 Format.print(System.out, "s = |%-20c|\n", '!');
\r
466 // regression test to confirm fix of reported bugs
\r
468 Format.print(System.out, "|%i|\n", Long.MIN_VALUE);
\r
470 Format.print(System.out, "|%6.2e|\n", 0.0);
\r
471 Format.print(System.out, "|%6.2g|\n", 0.0);
\r
473 Format.print(System.out, "|%6.2f|\n", 9.99);
\r
474 Format.print(System.out, "|%6.2f|\n", 9.999);
\r
476 Format.print(System.out, "|%6.0f|\n", 9.999);
\r
479 private static String repeat(char c, int n) {
\r
482 StringBuffer s = new StringBuffer(n);
\r
483 for (int i = 0; i < n; i++)
\r
485 return s.toString();
\r
488 private static String convert(long x, int n, int m, String d) {
\r
493 r = d.charAt((int)(x & m)) + r;
\r
499 private String pad(String r) {
\r
500 String p = repeat(' ', width - r.length());
\r
502 return pre + r + p + post;
\r
504 return pre + p + r + post;
\r
507 private String sign(int s, String r) {
\r
514 else if (show_space)
\r
517 if (fmt == 'o' && alternate && r.length() > 0 && r.charAt(0) != '0')
\r
519 else if (fmt == 'x' && alternate)
\r
521 else if (fmt == 'X' && alternate)
\r
525 if (leading_zeroes)
\r
527 else if ((fmt == 'd' || fmt == 'i' || fmt == 'x' || fmt == 'X' || fmt == 'o')
\r
531 return p + repeat('0', w - p.length() - r.length()) + r;
\r
534 private String fixed_format(double d) {
\r
535 boolean removeTrailing
\r
536 = (fmt == 'G' || fmt == 'g') && !alternate;
\r
537 // remove trailing zeroes and decimal point
\r
539 if (d > 0x7FFFFFFFFFFFFFFFL)
\r
540 return exp_format(d);
\r
541 if (precision == 0)
\r
542 return (long)(d + 0.5) + (removeTrailing ? "" : ".");
\r
544 long whole = (long)d;
\r
545 double fr = d - whole; // fractional part
\r
546 if (fr >= 1 || fr < 0)
\r
547 return exp_format(d);
\r
550 String leading_zeroes = "";
\r
551 for (int i = 1; i <= precision && factor <= 0x7FFFFFFFFFFFFFFFL; i++) {
\r
553 leading_zeroes = leading_zeroes + "0";
\r
555 long l = (long) (factor * fr + 0.5);
\r
561 String z = leading_zeroes + l;
\r
562 z = "." + z.substring(z.length() - precision, z.length());
\r
564 if (removeTrailing) {
\r
565 int t = z.length() - 1;
\r
566 while (t >= 0 && z.charAt(t) == '0')
\r
568 if (t >= 0 && z.charAt(t) == '.')
\r
570 z = z.substring(0, t + 1);
\r
576 private String exp_format(double d) {
\r
593 if ((fmt == 'g' || fmt == 'G') && e >= -4 && e < precision)
\r
594 return fixed_format(d);
\r
597 f = f + fixed_format(d);
\r
599 if (fmt == 'e' || fmt == 'g')
\r
613 return f + p.substring(p.length() - 3, p.length());
\r
617 private int precision;
\r
618 private String pre;
\r
619 private String post;
\r
620 private boolean leading_zeroes;
\r
621 private boolean show_plus;
\r
622 private boolean alternate;
\r
623 private boolean show_space;
\r
624 private boolean left_align;
\r
625 private char fmt; // one of cdeEfgGiosxXos
\r