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
28 package jalview.util;
\r
37 * @version $Revision$
\r
42 private int precision;
\r
44 private String post;
\r
45 private boolean leading_zeroes;
\r
46 private boolean show_plus;
\r
47 private boolean alternate;
\r
48 private boolean show_space;
\r
49 private boolean left_align;
\r
50 private char fmt; // one of cdeEfgGiosxXos
\r
53 * Creates a new Format object.
\r
55 * @param s DOCUMENT ME!
\r
57 public Format(String s)
\r
63 leading_zeroes = false;
\r
71 int length = s.length();
\r
72 int parse_state = 0;
\r
74 // 0 = prefix, 1 = flags, 2 = width, 3 = precision,
\r
75 // 4 = format, 5 = end
\r
78 while (parse_state == 0)
\r
84 else if (s.charAt(i) == '%')
\r
86 if (i < (length - 1))
\r
88 if (s.charAt(i + 1) == '%')
\r
100 throw new java.lang.IllegalArgumentException();
\r
105 pre = pre + s.charAt(i);
\r
111 while (parse_state == 1)
\r
117 else if (s.charAt(i) == ' ')
\r
121 else if (s.charAt(i) == '-')
\r
125 else if (s.charAt(i) == '+')
\r
129 else if (s.charAt(i) == '0')
\r
131 leading_zeroes = true;
\r
133 else if (s.charAt(i) == '#')
\r
146 while (parse_state == 2)
\r
152 else if (('0' <= s.charAt(i)) && (s.charAt(i) <= '9'))
\r
154 width = ((width * 10) + s.charAt(i)) - '0';
\r
157 else if (s.charAt(i) == '.')
\r
169 while (parse_state == 3)
\r
175 else if (('0' <= s.charAt(i)) && (s.charAt(i) <= '9'))
\r
177 precision = ((precision * 10) + s.charAt(i)) - '0';
\r
186 if (parse_state == 4)
\r
202 post = s.substring(i, length);
\r
207 * Formats the number following printf conventions.
\r
208 * Main limitation: Can only handle one format parameter at a time
\r
209 * Use multiple Format objects to format more than one number
\r
210 * @param s the format string following printf conventions
\r
211 * The string has a prefix, a format code and a suffix. The prefix and suffix
\r
212 * become part of the formatted output. The format code directs the
\r
213 * formatting of the (single) parameter to be formatted. The code has the
\r
214 * following structure
\r
216 * <li> a % (required)
\r
217 * <li> a modifier (optional)
\r
219 * <dt> + <dd> forces display of + for positive numbers
\r
220 * <dt> 0 <dd> show leading zeroes
\r
221 * <dt> - <dd> align left in the field
\r
222 * <dt> space <dd> prepend a space in front of positive numbers
\r
223 * <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
225 * <li> an integer denoting field width (optional)
\r
226 * <li> a period followed by an integer denoting precision (optional)
\r
227 * <li> a format descriptor (required)
\r
229 * <dt>f <dd> floating point number in fixed format
\r
230 * <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
231 * <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
232 * <dt>d, i <dd> integer in decimal
\r
233 * <dt>x <dd> integer in hexadecimal
\r
234 * <dt>o <dd> integer in octal
\r
235 * <dt>s <dd> string
\r
236 * <dt>c <dd> character
\r
239 * @exception IllegalArgumentException if bad format
\r
242 public static String getHexString(java.awt.Color color)
\r
247 r = Integer.toHexString(color.getRed());
\r
249 if (r.length() < 2)
\r
254 g = Integer.toHexString(color.getGreen());
\r
256 if (g.length() < 2)
\r
261 b = Integer.toHexString(color.getBlue());
\r
263 if (b.length() < 2)
\r
272 * prints a formatted number following printf conventions
\r
273 * @param s a PrintStream
\r
274 * @param fmt the format string
\r
275 * @param x the double to print
\r
277 public static void print(java.io.PrintStream s, String fmt, double x)
\r
279 s.print(new Format(fmt).form(x));
\r
283 * prints a formatted number following printf conventions
\r
284 * @param s a PrintStream
\r
285 * @param fmt the format string
\r
286 * @param x the long to print
\r
288 public static void print(java.io.PrintStream s, String fmt, long x)
\r
290 s.print(new Format(fmt).form(x));
\r
294 * prints a formatted number following printf conventions
\r
295 * @param s a PrintStream
\r
296 * @param fmt the format string
\r
297 * @param x the character to
\r
299 public static void print(java.io.PrintStream s, String fmt, char x)
\r
301 s.print(new Format(fmt).form(x));
\r
305 * prints a formatted number following printf conventions
\r
306 * @param s a PrintStream, fmt the format string
\r
307 * @param x a string that represents the digits to print
\r
309 public static void print(java.io.PrintStream s, String fmt, String x)
\r
311 s.print(new Format(fmt).form(x));
\r
315 * Converts a string of digits (decimal, octal or hex) to an integer
\r
316 * @param s a string
\r
317 * @return the numeric value of the prefix of s representing a base 10 integer
\r
319 public static int atoi(String s)
\r
321 return (int) atol(s);
\r
325 * Converts a string of digits (decimal, octal or hex) to a long integer
\r
326 * @param s a string
\r
327 * @return the numeric value of the prefix of s representing a base 10 integer
\r
329 public static long atol(String s)
\r
333 while ((i < s.length()) && Character.isWhitespace(s.charAt(i)))
\r
336 if ((i < s.length()) && (s.charAt(i) == '0'))
\r
338 if (((i + 1) < s.length()) &&
\r
339 ((s.charAt(i + 1) == 'x') || (s.charAt(i + 1) == 'X')))
\r
341 return parseLong(s.substring(i + 2), 16);
\r
345 return parseLong(s, 8);
\r
350 return parseLong(s, 10);
\r
357 * @param s DOCUMENT ME!
\r
358 * @param base DOCUMENT ME!
\r
360 * @return DOCUMENT ME!
\r
362 private static long parseLong(String s, int base)
\r
368 while ((i < s.length()) && Character.isWhitespace(s.charAt(i)))
\r
371 if ((i < s.length()) && (s.charAt(i) == '-'))
\r
376 else if ((i < s.length()) && (s.charAt(i) == '+'))
\r
381 while (i < s.length())
\r
383 char ch = s.charAt(i);
\r
385 if (('0' <= ch) && (ch < ('0' + base)))
\r
387 r = ((r * base) + ch) - '0';
\r
389 else if (('A' <= ch) && (ch < (('A' + base) - 10)))
\r
391 r = ((r * base) + ch) - 'A' + 10;
\r
393 else if (('a' <= ch) && (ch < (('a' + base) - 10)))
\r
395 r = ((r * base) + ch) - 'a' + 10;
\r
409 * Converts a string of digits to an double
\r
410 * @param s a string
\r
412 public static double atof(String s)
\r
416 double r = 0; // integer part
\r
417 double f = 0; // fractional part
\r
418 double p = 1; // exponent of fractional part
\r
419 int state = 0; // 0 = int part, 1 = frac part
\r
421 while ((i < s.length()) && Character.isWhitespace(s.charAt(i)))
\r
424 if ((i < s.length()) && (s.charAt(i) == '-'))
\r
429 else if ((i < s.length()) && (s.charAt(i) == '+'))
\r
434 while (i < s.length())
\r
436 char ch = s.charAt(i);
\r
438 if (('0' <= ch) && (ch <= '9'))
\r
442 r = ((r * 10) + ch) - '0';
\r
444 else if (state == 1)
\r
447 r = r + (p * (ch - '0'));
\r
450 else if (ch == '.')
\r
461 else if ((ch == 'e') || (ch == 'E'))
\r
463 long e = (int) parseLong(s.substring(i + 1), 10);
\r
465 return sign * r * Math.pow(10, e);
\r
479 * Formats a double into a string (like sprintf in C)
\r
480 * @param x the number to format
\r
481 * @return the formatted string
\r
482 * @exception IllegalArgumentException if bad argument
\r
484 public String form(double x)
\r
503 r = fixed_format(x);
\r
505 else if ((fmt == 'e') || (fmt == 'E') || (fmt == 'g') || (fmt == 'G'))
\r
511 throw new java.lang.IllegalArgumentException();
\r
514 return pad(sign(s, r));
\r
518 * Formats a long integer into a string (like sprintf in C)
\r
519 * @param x the number to format
\r
520 * @return the formatted string
\r
522 public String form(long x)
\r
527 if ((fmt == 'd') || (fmt == 'i'))
\r
531 r = ("" + x).substring(1);
\r
540 else if (fmt == 'o')
\r
542 r = convert(x, 3, 7, "01234567");
\r
544 else if (fmt == 'x')
\r
546 r = convert(x, 4, 15, "0123456789abcdef");
\r
548 else if (fmt == 'X')
\r
550 r = convert(x, 4, 15, "0123456789ABCDEF");
\r
554 throw new java.lang.IllegalArgumentException();
\r
557 return pad(sign(s, r));
\r
561 * Formats a character into a string (like sprintf in C)
\r
562 * @param x the value to format
\r
563 * @return the formatted string
\r
565 public String form(char c)
\r
569 throw new java.lang.IllegalArgumentException();
\r
578 * Formats a string into a larger string (like sprintf in C)
\r
579 * @param x the value to format
\r
580 * @return the formatted string
\r
582 public String form(String s)
\r
586 throw new java.lang.IllegalArgumentException();
\r
589 if (precision >= 0)
\r
591 s = s.substring(0, precision);
\r
598 * a test stub for the format class
\r
600 public static void main(String[] a)
\r
602 double x = 1.23456789012;
\r
604 double z = 1.2345e30;
\r
606 double u = 1.234e-5;
\r
608 Format.print(System.out, "x = |%f|\n", x);
\r
609 Format.print(System.out, "u = |%20f|\n", u);
\r
610 Format.print(System.out, "x = |% .5f|\n", x);
\r
611 Format.print(System.out, "w = |%20.5f|\n", w);
\r
612 Format.print(System.out, "x = |%020.5f|\n", x);
\r
613 Format.print(System.out, "x = |%+20.5f|\n", x);
\r
614 Format.print(System.out, "x = |%+020.5f|\n", x);
\r
615 Format.print(System.out, "x = |% 020.5f|\n", x);
\r
616 Format.print(System.out, "y = |%#+20.5f|\n", y);
\r
617 Format.print(System.out, "y = |%-+20.5f|\n", y);
\r
618 Format.print(System.out, "z = |%20.5f|\n", z);
\r
620 Format.print(System.out, "x = |%e|\n", x);
\r
621 Format.print(System.out, "u = |%20e|\n", u);
\r
622 Format.print(System.out, "x = |% .5e|\n", x);
\r
623 Format.print(System.out, "w = |%20.5e|\n", w);
\r
624 Format.print(System.out, "x = |%020.5e|\n", x);
\r
625 Format.print(System.out, "x = |%+20.5e|\n", x);
\r
626 Format.print(System.out, "x = |%+020.5e|\n", x);
\r
627 Format.print(System.out, "x = |% 020.5e|\n", x);
\r
628 Format.print(System.out, "y = |%#+20.5e|\n", y);
\r
629 Format.print(System.out, "y = |%-+20.5e|\n", y);
\r
631 Format.print(System.out, "x = |%g|\n", x);
\r
632 Format.print(System.out, "z = |%g|\n", z);
\r
633 Format.print(System.out, "w = |%g|\n", w);
\r
634 Format.print(System.out, "u = |%g|\n", u);
\r
635 Format.print(System.out, "y = |%.2g|\n", y);
\r
636 Format.print(System.out, "y = |%#.2g|\n", y);
\r
638 Format.print(System.out, "d = |%d|\n", d);
\r
639 Format.print(System.out, "d = |%20d|\n", d);
\r
640 Format.print(System.out, "d = |%020d|\n", d);
\r
641 Format.print(System.out, "d = |%+20d|\n", d);
\r
642 Format.print(System.out, "d = |% 020d|\n", d);
\r
643 Format.print(System.out, "d = |%-20d|\n", d);
\r
644 Format.print(System.out, "d = |%20.8d|\n", d);
\r
645 Format.print(System.out, "d = |%x|\n", d);
\r
646 Format.print(System.out, "d = |%20X|\n", d);
\r
647 Format.print(System.out, "d = |%#20x|\n", d);
\r
648 Format.print(System.out, "d = |%020X|\n", d);
\r
649 Format.print(System.out, "d = |%20.8x|\n", d);
\r
650 Format.print(System.out, "d = |%o|\n", d);
\r
651 Format.print(System.out, "d = |%020o|\n", d);
\r
652 Format.print(System.out, "d = |%#20o|\n", d);
\r
653 Format.print(System.out, "d = |%#020o|\n", d);
\r
654 Format.print(System.out, "d = |%20.12o|\n", d);
\r
656 Format.print(System.out, "s = |%-20s|\n", "Hello");
\r
657 Format.print(System.out, "s = |%-20c|\n", '!');
\r
659 // regression test to confirm fix of reported bugs
\r
660 Format.print(System.out, "|%i|\n", Long.MIN_VALUE);
\r
662 Format.print(System.out, "|%6.2e|\n", 0.0);
\r
663 Format.print(System.out, "|%6.2g|\n", 0.0);
\r
665 Format.print(System.out, "|%6.2f|\n", 9.99);
\r
666 Format.print(System.out, "|%6.2f|\n", 9.999);
\r
668 Format.print(System.out, "|%6.0f|\n", 9.999);
\r
674 * @param c DOCUMENT ME!
\r
675 * @param n DOCUMENT ME!
\r
677 * @return DOCUMENT ME!
\r
679 private static String repeat(char c, int n)
\r
686 StringBuffer s = new StringBuffer(n);
\r
688 for (int i = 0; i < n; i++)
\r
691 return s.toString();
\r
697 * @param x DOCUMENT ME!
\r
698 * @param n DOCUMENT ME!
\r
699 * @param m DOCUMENT ME!
\r
700 * @param d DOCUMENT ME!
\r
702 * @return DOCUMENT ME!
\r
704 private static String convert(long x, int n, int m, String d)
\r
715 r = d.charAt((int) (x & m)) + r;
\r
725 * @param r DOCUMENT ME!
\r
727 * @return DOCUMENT ME!
\r
729 private String pad(String r)
\r
731 String p = repeat(' ', width - r.length());
\r
735 return pre + r + p + post;
\r
739 return pre + p + r + post;
\r
746 * @param s DOCUMENT ME!
\r
747 * @param r DOCUMENT ME!
\r
749 * @return DOCUMENT ME!
\r
751 private String sign(int s, String r)
\r
765 else if (show_space)
\r
772 if ((fmt == 'o') && alternate && (r.length() > 0) &&
\r
773 (r.charAt(0) != '0'))
\r
777 else if ((fmt == 'x') && alternate)
\r
781 else if ((fmt == 'X') && alternate)
\r
789 if (leading_zeroes)
\r
793 else if (((fmt == 'd') || (fmt == 'i') || (fmt == 'x') || (fmt == 'X') ||
\r
794 (fmt == 'o')) && (precision > 0))
\r
799 return p + repeat('0', w - p.length() - r.length()) + r;
\r
805 * @param d DOCUMENT ME!
\r
807 * @return DOCUMENT ME!
\r
809 private String fixed_format(double d)
\r
811 boolean removeTrailing = ((fmt == 'G') || (fmt == 'g')) && !alternate;
\r
813 // remove trailing zeroes and decimal point
\r
814 if (d > 0x7FFFFFFFFFFFFFFFL)
\r
816 return exp_format(d);
\r
819 if (precision == 0)
\r
821 return (long) (d + 0.5) + (removeTrailing ? "" : ".");
\r
824 long whole = (long) d;
\r
825 double fr = d - whole; // fractional part
\r
827 if ((fr >= 1) || (fr < 0))
\r
829 return exp_format(d);
\r
833 String leading_zeroes = "";
\r
835 for (int i = 1; (i <= precision) && (factor <= 0x7FFFFFFFFFFFFFFFL);
\r
839 leading_zeroes = leading_zeroes + "0";
\r
842 long l = (long) ((factor * fr) + 0.5);
\r
851 String z = leading_zeroes + l;
\r
852 z = "." + z.substring(z.length() - precision, z.length());
\r
854 if (removeTrailing)
\r
856 int t = z.length() - 1;
\r
858 while ((t >= 0) && (z.charAt(t) == '0'))
\r
861 if ((t >= 0) && (z.charAt(t) == '.'))
\r
866 z = z.substring(0, t + 1);
\r
875 * @param d DOCUMENT ME!
\r
877 * @return DOCUMENT ME!
\r
879 private String exp_format(double d)
\r
903 if (((fmt == 'g') || (fmt == 'G')) && (e >= -4) && (e < precision))
\r
905 return fixed_format(d);
\r
909 f = f + fixed_format(d);
\r
911 if ((fmt == 'e') || (fmt == 'g'))
\r
933 return f + p.substring(p.length() - 3, p.length());
\r