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
33 public class Format {
\r
35 private int precision;
\r
37 private String post;
\r
38 private boolean leading_zeroes;
\r
39 private boolean show_plus;
\r
40 private boolean alternate;
\r
41 private boolean show_space;
\r
42 private boolean left_align;
\r
43 private char fmt; // one of cdeEfgGiosxXos
\r
45 public Format(String s) {
\r
50 leading_zeroes = false;
\r
58 int length = s.length();
\r
59 int parse_state = 0;
\r
61 // 0 = prefix, 1 = flags, 2 = width, 3 = precision,
\r
62 // 4 = format, 5 = end
\r
65 while (parse_state == 0) {
\r
68 } else if (s.charAt(i) == '%') {
\r
69 if (i < (length - 1)) {
\r
70 if (s.charAt(i + 1) == '%') {
\r
77 throw new java.lang.IllegalArgumentException();
\r
80 pre = pre + s.charAt(i);
\r
86 while (parse_state == 1) {
\r
89 } else if (s.charAt(i) == ' ') {
\r
91 } else if (s.charAt(i) == '-') {
\r
93 } else if (s.charAt(i) == '+') {
\r
95 } else if (s.charAt(i) == '0') {
\r
96 leading_zeroes = true;
\r
97 } else if (s.charAt(i) == '#') {
\r
107 while (parse_state == 2) {
\r
110 } else if (('0' <= s.charAt(i)) && (s.charAt(i) <= '9')) {
\r
111 width = ((width * 10) + s.charAt(i)) - '0';
\r
113 } else if (s.charAt(i) == '.') {
\r
122 while (parse_state == 3) {
\r
125 } else if (('0' <= s.charAt(i)) && (s.charAt(i) <= '9')) {
\r
126 precision = ((precision * 10) + s.charAt(i)) - '0';
\r
133 if (parse_state == 4) {
\r
144 post = s.substring(i, length);
\r
149 * Formats the number following printf conventions.
\r
150 * Main limitation: Can only handle one format parameter at a time
\r
151 * Use multiple Format objects to format more than one number
\r
152 * @param s the format string following printf conventions
\r
153 * The string has a prefix, a format code and a suffix. The prefix and suffix
\r
154 * become part of the formatted output. The format code directs the
\r
155 * formatting of the (single) parameter to be formatted. The code has the
\r
156 * following structure
\r
158 * <li> a % (required)
\r
159 * <li> a modifier (optional)
\r
161 * <dt> + <dd> forces display of + for positive numbers
\r
162 * <dt> 0 <dd> show leading zeroes
\r
163 * <dt> - <dd> align left in the field
\r
164 * <dt> space <dd> prepend a space in front of positive numbers
\r
165 * <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
167 * <li> an integer denoting field width (optional)
\r
168 * <li> a period followed by an integer denoting precision (optional)
\r
169 * <li> a format descriptor (required)
\r
171 * <dt>f <dd> floating point number in fixed format
\r
172 * <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
173 * <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
174 * <dt>d, i <dd> integer in decimal
\r
175 * <dt>x <dd> integer in hexadecimal
\r
176 * <dt>o <dd> integer in octal
\r
177 * <dt>s <dd> string
\r
178 * <dt>c <dd> character
\r
181 * @exception IllegalArgumentException if bad format
\r
184 public static String getHexString(java.awt.Color color) {
\r
188 r = Integer.toHexString(color.getRed());
\r
190 if (r.length() < 2) {
\r
194 g = Integer.toHexString(color.getGreen());
\r
196 if (g.length() < 2) {
\r
200 b = Integer.toHexString(color.getBlue());
\r
202 if (b.length() < 2) {
\r
210 * prints a formatted number following printf conventions
\r
211 * @param s a PrintStream
\r
212 * @param fmt the format string
\r
213 * @param x the double to print
\r
215 public static void print(java.io.PrintStream s, String fmt, double x) {
\r
216 s.print(new Format(fmt).form(x));
\r
220 * prints a formatted number following printf conventions
\r
221 * @param s a PrintStream
\r
222 * @param fmt the format string
\r
223 * @param x the long to print
\r
225 public static void print(java.io.PrintStream s, String fmt, long x) {
\r
226 s.print(new Format(fmt).form(x));
\r
230 * prints a formatted number following printf conventions
\r
231 * @param s a PrintStream
\r
232 * @param fmt the format string
\r
233 * @param x the character to
\r
235 public static void print(java.io.PrintStream s, String fmt, char x) {
\r
236 s.print(new Format(fmt).form(x));
\r
240 * prints a formatted number following printf conventions
\r
241 * @param s a PrintStream, fmt the format string
\r
242 * @param x a string that represents the digits to print
\r
244 public static void print(java.io.PrintStream s, String fmt, String x) {
\r
245 s.print(new Format(fmt).form(x));
\r
249 * Converts a string of digits (decimal, octal or hex) to an integer
\r
250 * @param s a string
\r
251 * @return the numeric value of the prefix of s representing a base 10 integer
\r
253 public static int atoi(String s) {
\r
254 return (int) atol(s);
\r
258 * Converts a string of digits (decimal, octal or hex) to a long integer
\r
259 * @param s a string
\r
260 * @return the numeric value of the prefix of s representing a base 10 integer
\r
262 public static long atol(String s) {
\r
265 while ((i < s.length()) && Character.isWhitespace(s.charAt(i)))
\r
268 if ((i < s.length()) && (s.charAt(i) == '0')) {
\r
269 if (((i + 1) < s.length()) &&
\r
270 ((s.charAt(i + 1) == 'x') || (s.charAt(i + 1) == 'X'))) {
\r
271 return parseLong(s.substring(i + 2), 16);
\r
273 return parseLong(s, 8);
\r
276 return parseLong(s, 10);
\r
280 private static long parseLong(String s, int base) {
\r
285 while ((i < s.length()) && Character.isWhitespace(s.charAt(i)))
\r
288 if ((i < s.length()) && (s.charAt(i) == '-')) {
\r
291 } else if ((i < s.length()) && (s.charAt(i) == '+')) {
\r
295 while (i < s.length()) {
\r
296 char ch = s.charAt(i);
\r
298 if (('0' <= ch) && (ch < ('0' + base))) {
\r
299 r = ((r * base) + ch) - '0';
\r
300 } else if (('A' <= ch) && (ch < (('A' + base) - 10))) {
\r
301 r = ((r * base) + ch) - 'A' + 10;
\r
302 } else if (('a' <= ch) && (ch < (('a' + base) - 10))) {
\r
303 r = ((r * base) + ch) - 'a' + 10;
\r
315 * Converts a string of digits to an double
\r
316 * @param s a string
\r
318 public static double atof(String s) {
\r
321 double r = 0; // integer part
\r
322 double f = 0; // fractional part
\r
323 double p = 1; // exponent of fractional part
\r
324 int state = 0; // 0 = int part, 1 = frac part
\r
326 while ((i < s.length()) && Character.isWhitespace(s.charAt(i)))
\r
329 if ((i < s.length()) && (s.charAt(i) == '-')) {
\r
332 } else if ((i < s.length()) && (s.charAt(i) == '+')) {
\r
336 while (i < s.length()) {
\r
337 char ch = s.charAt(i);
\r
339 if (('0' <= ch) && (ch <= '9')) {
\r
341 r = ((r * 10) + ch) - '0';
\r
342 } else if (state == 1) {
\r
344 r = r + (p * (ch - '0'));
\r
346 } else if (ch == '.') {
\r
352 } else if ((ch == 'e') || (ch == 'E')) {
\r
353 long e = (int) parseLong(s.substring(i + 1), 10);
\r
355 return sign * r * Math.pow(10, e);
\r
367 * Formats a double into a string (like sprintf in C)
\r
368 * @param x the number to format
\r
369 * @return the formatted string
\r
370 * @exception IllegalArgumentException if bad argument
\r
372 public String form(double x) {
\r
375 if (precision < 0) {
\r
387 r = fixed_format(x);
\r
388 } else if ((fmt == 'e') || (fmt == 'E') || (fmt == 'g') ||
\r
392 throw new java.lang.IllegalArgumentException();
\r
395 return pad(sign(s, r));
\r
399 * Formats a long integer into a string (like sprintf in C)
\r
400 * @param x the number to format
\r
401 * @return the formatted string
\r
403 public String form(long x) {
\r
407 if ((fmt == 'd') || (fmt == 'i')) {
\r
409 r = ("" + x).substring(1);
\r
415 } else if (fmt == 'o') {
\r
416 r = convert(x, 3, 7, "01234567");
\r
417 } else if (fmt == 'x') {
\r
418 r = convert(x, 4, 15, "0123456789abcdef");
\r
419 } else if (fmt == 'X') {
\r
420 r = convert(x, 4, 15, "0123456789ABCDEF");
\r
422 throw new java.lang.IllegalArgumentException();
\r
425 return pad(sign(s, r));
\r
429 * Formats a character into a string (like sprintf in C)
\r
430 * @param x the value to format
\r
431 * @return the formatted string
\r
433 public String form(char c) {
\r
435 throw new java.lang.IllegalArgumentException();
\r
444 * Formats a string into a larger string (like sprintf in C)
\r
445 * @param x the value to format
\r
446 * @return the formatted string
\r
448 public String form(String s) {
\r
450 throw new java.lang.IllegalArgumentException();
\r
453 if (precision >= 0) {
\r
454 s = s.substring(0, precision);
\r
461 * a test stub for the format class
\r
463 public static void main(String[] a) {
\r
464 double x = 1.23456789012;
\r
466 double z = 1.2345e30;
\r
468 double u = 1.234e-5;
\r
470 Format.print(System.out, "x = |%f|\n", x);
\r
471 Format.print(System.out, "u = |%20f|\n", u);
\r
472 Format.print(System.out, "x = |% .5f|\n", x);
\r
473 Format.print(System.out, "w = |%20.5f|\n", w);
\r
474 Format.print(System.out, "x = |%020.5f|\n", x);
\r
475 Format.print(System.out, "x = |%+20.5f|\n", x);
\r
476 Format.print(System.out, "x = |%+020.5f|\n", x);
\r
477 Format.print(System.out, "x = |% 020.5f|\n", x);
\r
478 Format.print(System.out, "y = |%#+20.5f|\n", y);
\r
479 Format.print(System.out, "y = |%-+20.5f|\n", y);
\r
480 Format.print(System.out, "z = |%20.5f|\n", z);
\r
482 Format.print(System.out, "x = |%e|\n", x);
\r
483 Format.print(System.out, "u = |%20e|\n", u);
\r
484 Format.print(System.out, "x = |% .5e|\n", x);
\r
485 Format.print(System.out, "w = |%20.5e|\n", w);
\r
486 Format.print(System.out, "x = |%020.5e|\n", x);
\r
487 Format.print(System.out, "x = |%+20.5e|\n", x);
\r
488 Format.print(System.out, "x = |%+020.5e|\n", x);
\r
489 Format.print(System.out, "x = |% 020.5e|\n", x);
\r
490 Format.print(System.out, "y = |%#+20.5e|\n", y);
\r
491 Format.print(System.out, "y = |%-+20.5e|\n", y);
\r
493 Format.print(System.out, "x = |%g|\n", x);
\r
494 Format.print(System.out, "z = |%g|\n", z);
\r
495 Format.print(System.out, "w = |%g|\n", w);
\r
496 Format.print(System.out, "u = |%g|\n", u);
\r
497 Format.print(System.out, "y = |%.2g|\n", y);
\r
498 Format.print(System.out, "y = |%#.2g|\n", y);
\r
500 Format.print(System.out, "d = |%d|\n", d);
\r
501 Format.print(System.out, "d = |%20d|\n", d);
\r
502 Format.print(System.out, "d = |%020d|\n", d);
\r
503 Format.print(System.out, "d = |%+20d|\n", d);
\r
504 Format.print(System.out, "d = |% 020d|\n", d);
\r
505 Format.print(System.out, "d = |%-20d|\n", d);
\r
506 Format.print(System.out, "d = |%20.8d|\n", d);
\r
507 Format.print(System.out, "d = |%x|\n", d);
\r
508 Format.print(System.out, "d = |%20X|\n", d);
\r
509 Format.print(System.out, "d = |%#20x|\n", d);
\r
510 Format.print(System.out, "d = |%020X|\n", d);
\r
511 Format.print(System.out, "d = |%20.8x|\n", d);
\r
512 Format.print(System.out, "d = |%o|\n", d);
\r
513 Format.print(System.out, "d = |%020o|\n", d);
\r
514 Format.print(System.out, "d = |%#20o|\n", d);
\r
515 Format.print(System.out, "d = |%#020o|\n", d);
\r
516 Format.print(System.out, "d = |%20.12o|\n", d);
\r
518 Format.print(System.out, "s = |%-20s|\n", "Hello");
\r
519 Format.print(System.out, "s = |%-20c|\n", '!');
\r
521 // regression test to confirm fix of reported bugs
\r
522 Format.print(System.out, "|%i|\n", Long.MIN_VALUE);
\r
524 Format.print(System.out, "|%6.2e|\n", 0.0);
\r
525 Format.print(System.out, "|%6.2g|\n", 0.0);
\r
527 Format.print(System.out, "|%6.2f|\n", 9.99);
\r
528 Format.print(System.out, "|%6.2f|\n", 9.999);
\r
530 Format.print(System.out, "|%6.0f|\n", 9.999);
\r
533 private static String repeat(char c, int n) {
\r
538 StringBuffer s = new StringBuffer(n);
\r
540 for (int i = 0; i < n; i++)
\r
543 return s.toString();
\r
546 private static String convert(long x, int n, int m, String d) {
\r
554 r = d.charAt((int) (x & m)) + r;
\r
561 private String pad(String r) {
\r
562 String p = repeat(' ', width - r.length());
\r
565 return pre + r + p + post;
\r
567 return pre + p + r + post;
\r
571 private String sign(int s, String r) {
\r
576 } else if (s > 0) {
\r
579 } else if (show_space) {
\r
583 if ((fmt == 'o') && alternate && (r.length() > 0) &&
\r
584 (r.charAt(0) != '0')) {
\r
586 } else if ((fmt == 'x') && alternate) {
\r
588 } else if ((fmt == 'X') && alternate) {
\r
595 if (leading_zeroes) {
\r
597 } else if (((fmt == 'd') || (fmt == 'i') || (fmt == 'x') ||
\r
598 (fmt == 'X') || (fmt == 'o')) && (precision > 0)) {
\r
602 return p + repeat('0', w - p.length() - r.length()) + r;
\r
605 private String fixed_format(double d) {
\r
606 boolean removeTrailing = ((fmt == 'G') || (fmt == 'g')) && !alternate;
\r
608 // remove trailing zeroes and decimal point
\r
609 if (d > 0x7FFFFFFFFFFFFFFFL) {
\r
610 return exp_format(d);
\r
613 if (precision == 0) {
\r
614 return (long) (d + 0.5) + (removeTrailing ? "" : ".");
\r
617 long whole = (long) d;
\r
618 double fr = d - whole; // fractional part
\r
620 if ((fr >= 1) || (fr < 0)) {
\r
621 return exp_format(d);
\r
625 String leading_zeroes = "";
\r
627 for (int i = 1; (i <= precision) && (factor <= 0x7FFFFFFFFFFFFFFFL);
\r
630 leading_zeroes = leading_zeroes + "0";
\r
633 long l = (long) ((factor * fr) + 0.5);
\r
641 String z = leading_zeroes + l;
\r
642 z = "." + z.substring(z.length() - precision, z.length());
\r
644 if (removeTrailing) {
\r
645 int t = z.length() - 1;
\r
647 while ((t >= 0) && (z.charAt(t) == '0'))
\r
650 if ((t >= 0) && (z.charAt(t) == '.')) {
\r
654 z = z.substring(0, t + 1);
\r
660 private String exp_format(double d) {
\r
680 if (((fmt == 'g') || (fmt == 'G')) && (e >= -4) && (e < precision)) {
\r
681 return fixed_format(d);
\r
685 f = f + fixed_format(d);
\r
687 if ((fmt == 'e') || (fmt == 'g')) {
\r
703 return f + p.substring(p.length() - 3, p.length());
\r