Moved comment so it doesn't break jalopy (this is not good!)
[jalview.git] / src / jalview / util / 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 jalview.util;\r
30 \r
31 import java.io.*;\r
32 \r
33 public class Format {\r
34     /**\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
43      * <ul>\r
44      * <li> a % (required)\r
45      * <li> a modifier (optional)\r
46      * <dl>\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
52      * </dl>\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
56      * <dl>\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
63      * <dt>s <dd> string\r
64      * <dt>c <dd> character\r
65      * </dl>\r
66      * </ul>\r
67      * @exception IllegalArgumentException if bad format\r
68      *\r
69      */\r
70 \r
71   public static String getHexString(java.awt.Color color)\r
72   {\r
73     String r, g, b;\r
74     r = Integer.toHexString(color.getRed());\r
75     if (r.length() < 2)\r
76       r = "0" + r;\r
77     g = Integer.toHexString(color.getGreen());\r
78     if (g.length() < 2)\r
79       g = "0" + g;\r
80     b = Integer.toHexString(color.getBlue());\r
81     if (b.length() < 2)\r
82       b = "0" + b;\r
83 \r
84     return r+g+b;\r
85   }\r
86 \r
87 \r
88   public Format(String s) {\r
89     width = 0;\r
90     precision = -1;\r
91     pre = "";\r
92     post = "";\r
93     leading_zeroes = false;\r
94     show_plus = false;\r
95     alternate = false;\r
96     show_space = false;\r
97     left_align = false;\r
98     fmt = ' ';\r
99 \r
100     int state = 0;\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
105     int i = 0;\r
106 \r
107     while (parse_state == 0) {\r
108       if (i >= length)\r
109         parse_state = 5;\r
110       else if (s.charAt(i) == '%') {\r
111         if (i < length - 1) {\r
112           if (s.charAt(i + 1) == '%') {\r
113             pre = pre + '%';\r
114             i++;\r
115           } else\r
116             parse_state = 1;\r
117         } else\r
118           throw new java.lang.IllegalArgumentException();\r
119       } else\r
120         pre = pre + s.charAt(i);\r
121       i++;\r
122     }\r
123     while (parse_state == 1) {\r
124       if (i >= length)\r
125         parse_state = 5;\r
126       else if (s.charAt(i) == ' ')\r
127         show_space = true;\r
128       else if (s.charAt(i) == '-')\r
129         left_align = true;\r
130       else if (s.charAt(i) == '+')\r
131         show_plus = true;\r
132       else if (s.charAt(i) == '0')\r
133         leading_zeroes = true;\r
134       else if (s.charAt(i) == '#')\r
135         alternate = true;\r
136       else {\r
137         parse_state = 2;\r
138         i--;\r
139       }\r
140       i++;\r
141     }\r
142     while (parse_state == 2) {\r
143       if (i >= length)\r
144         parse_state = 5;\r
145       else if ('0' <= s.charAt(i) && s.charAt(i) <= '9') {\r
146         width = width * 10 + s.charAt(i) - '0';\r
147         i++;\r
148       } else if (s.charAt(i) == '.') {\r
149         parse_state = 3;\r
150         precision = 0;\r
151         i++;\r
152       } else\r
153         parse_state = 4;\r
154     }\r
155     while (parse_state == 3) {\r
156       if (i >= length)\r
157         parse_state = 5;\r
158       else if ('0' <= s.charAt(i) && s.charAt(i) <= '9') {\r
159         precision = precision * 10 + s.charAt(i) - '0';\r
160         i++;\r
161       } else\r
162         parse_state = 4;\r
163     }\r
164     if (parse_state == 4) {\r
165       if (i >= length)\r
166         parse_state = 5;\r
167       else\r
168         fmt = s.charAt(i);\r
169       i++;\r
170     }\r
171     if (i < length)\r
172       post = s.substring(i, length);\r
173   }\r
174 \r
175   /**\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
180   */\r
181 \r
182   public static void print(java.io.PrintStream s, String fmt, double x) {\r
183     s.print(new Format(fmt).form(x));\r
184   }\r
185 \r
186   /**\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
191   */\r
192   public static void print(java.io.PrintStream s, String fmt, long x) {\r
193     s.print(new Format(fmt).form(x));\r
194   }\r
195 \r
196   /**\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
201   */\r
202 \r
203   public static void print(java.io.PrintStream s, String fmt, char x) {\r
204     s.print(new Format(fmt).form(x));\r
205   }\r
206 \r
207   /**\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
211   */\r
212 \r
213   public static void print(java.io.PrintStream s, String fmt, String x) {\r
214     s.print(new Format(fmt).form(x));\r
215   }\r
216 \r
217   /**\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
221   */\r
222 \r
223   public static int atoi(String s) {\r
224     return (int)atol(s);\r
225   }\r
226 \r
227   /**\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
231   */\r
232 \r
233   public static long atol(String s) {\r
234     int i = 0;\r
235 \r
236     while (i < s.length() && Character.isWhitespace(s.charAt(i)))\r
237       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
241       else\r
242         return parseLong(s, 8);\r
243     } else\r
244       return parseLong(s, 10);\r
245   }\r
246 \r
247   private static long parseLong(String s, int base) {\r
248     int i = 0;\r
249     int sign = 1;\r
250     long r = 0;\r
251 \r
252     while (i < s.length() && Character.isWhitespace(s.charAt(i)))\r
253       i++;\r
254     if (i < s.length() && s.charAt(i) == '-') {\r
255       sign = -1;\r
256       i++;\r
257     } else if (i < s.length() && s.charAt(i) == '+') {\r
258       i++;\r
259     }\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
268       else\r
269         return r * sign;\r
270       i++;\r
271     }\r
272     return r * sign;\r
273   }\r
274 \r
275   /**\r
276   * Converts a string of digits to an double\r
277   * @param s a string\r
278   */\r
279 \r
280   public static double atof(String s) {\r
281     int i = 0;\r
282     int sign = 1;\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
287 \r
288     while (i < s.length() && Character.isWhitespace(s.charAt(i)))\r
289       i++;\r
290     if (i < s.length() && s.charAt(i) == '-') {\r
291       sign = -1;\r
292       i++;\r
293     } else if (i < s.length() && s.charAt(i) == '+') {\r
294       i++;\r
295     }\r
296     while (i < s.length()) {\r
297       char ch = s.charAt(i);\r
298       if ('0' <= ch && ch <= '9') {\r
299         if (state == 0)\r
300           r = r * 10 + ch - '0';\r
301         else if (state == 1) {\r
302           p = p / 10;\r
303           r = r + p * (ch - '0');\r
304         }\r
305       } else if (ch == '.') {\r
306         if (state == 0)\r
307           state = 1;\r
308         else\r
309           return sign * r;\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
313       } else\r
314         return sign * r;\r
315       i++;\r
316     }\r
317     return sign * r;\r
318   }\r
319 \r
320   /**\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
325   */\r
326 \r
327   public String form(double x) {\r
328     String r;\r
329     if (precision < 0)\r
330       precision = 6;\r
331     int s = 1;\r
332     if (x < 0) {\r
333       x = -x;\r
334       s = -1;\r
335     }\r
336     if (fmt == 'f')\r
337       r = fixed_format(x);\r
338     else if (fmt == 'e' || fmt == 'E' || fmt == 'g' || fmt == 'G')\r
339       r = exp_format(x);\r
340     else\r
341       throw new java.lang.IllegalArgumentException();\r
342 \r
343     return pad(sign(s, r));\r
344   }\r
345 \r
346   /**\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
350   */\r
351 \r
352   public String form(long x) {\r
353     String r;\r
354     int s = 0;\r
355     if (fmt == 'd' || fmt == 'i') {\r
356       if (x < 0) {\r
357         r = ("" + x).substring(1);\r
358         s = -1;\r
359       } else {\r
360         r = "" + x;\r
361         s = 1;\r
362       }\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
369     else\r
370       throw new java.lang.IllegalArgumentException();\r
371 \r
372     return pad(sign(s, r));\r
373   }\r
374 \r
375   /**\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
379   */\r
380 \r
381   public String form(char c) {\r
382     if (fmt != 'c')\r
383       throw new java.lang.IllegalArgumentException();\r
384 \r
385     String r = "" + c;\r
386     return pad(r);\r
387   }\r
388 \r
389   /**\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
393   */\r
394 \r
395   public String form(String s) {\r
396     if (fmt != 's')\r
397       throw new java.lang.IllegalArgumentException();\r
398     if (precision >= 0)\r
399       s = s.substring(0, precision);\r
400     return pad(s);\r
401   }\r
402 \r
403 \r
404   /**\r
405   * a test stub for the format class\r
406   */\r
407 \r
408   public static void main(String[] a) {\r
409     double x = 1.23456789012;\r
410     double y = 123;\r
411     double z = 1.2345e30;\r
412     double w = 1.02;\r
413     double u = 1.234e-5;\r
414     int d = 0xCAFE;\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
426 \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
437 \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
444 \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
462 \r
463     Format.print(System.out, "s = |%-20s|\n", "Hello");\r
464     Format.print(System.out, "s = |%-20c|\n", '!');\r
465 \r
466     // regression test to confirm fix of reported bugs\r
467 \r
468     Format.print(System.out, "|%i|\n", Long.MIN_VALUE);\r
469 \r
470     Format.print(System.out, "|%6.2e|\n", 0.0);\r
471     Format.print(System.out, "|%6.2g|\n", 0.0);\r
472 \r
473     Format.print(System.out, "|%6.2f|\n", 9.99);\r
474     Format.print(System.out, "|%6.2f|\n", 9.999);\r
475 \r
476     Format.print(System.out, "|%6.0f|\n", 9.999);\r
477   }\r
478 \r
479   private static String repeat(char c, int n) {\r
480     if (n <= 0)\r
481       return "";\r
482     StringBuffer s = new StringBuffer(n);\r
483     for (int i = 0; i < n; i++)\r
484       s.append(c);\r
485     return s.toString();\r
486   }\r
487 \r
488   private static String convert(long x, int n, int m, String d) {\r
489     if (x == 0)\r
490       return "0";\r
491     String r = "";\r
492     while (x != 0) {\r
493       r = d.charAt((int)(x & m)) + r;\r
494       x = x >>> n;\r
495     }\r
496     return r;\r
497   }\r
498 \r
499   private String pad(String r) {\r
500     String p = repeat(' ', width - r.length());\r
501     if (left_align)\r
502       return pre + r + p + post;\r
503     else\r
504       return pre + p + r + post;\r
505   }\r
506 \r
507   private String sign(int s, String r) {\r
508     String p = "";\r
509     if (s < 0)\r
510       p = "-";\r
511     else if (s > 0) {\r
512       if (show_plus)\r
513         p = "+";\r
514       else if (show_space)\r
515         p = " ";\r
516     } else {\r
517       if (fmt == 'o' && alternate && r.length() > 0 && r.charAt(0) != '0')\r
518         p = "0";\r
519       else if (fmt == 'x' && alternate)\r
520         p = "0x";\r
521       else if (fmt == 'X' && alternate)\r
522         p = "0X";\r
523     }\r
524     int w = 0;\r
525     if (leading_zeroes)\r
526       w = width;\r
527     else if ((fmt == 'd' || fmt == 'i' || fmt == 'x' || fmt == 'X' || fmt == 'o')\r
528              && precision > 0)\r
529       w = precision;\r
530 \r
531     return p + repeat('0', w - p.length() - r.length()) + r;\r
532   }\r
533 \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
538 \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
543 \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
548 \r
549     double factor = 1;\r
550     String leading_zeroes = "";\r
551     for (int i = 1; i <= precision && factor <= 0x7FFFFFFFFFFFFFFFL; i++) {\r
552       factor *= 10;\r
553       leading_zeroes = leading_zeroes + "0";\r
554     }\r
555     long l = (long) (factor * fr + 0.5);\r
556     if (l >= factor) {\r
557       l = 0;\r
558       whole++;\r
559     } // CSH 10-25-97\r
560 \r
561     String z = leading_zeroes + l;\r
562     z = "." + z.substring(z.length() - precision, z.length());\r
563 \r
564     if (removeTrailing) {\r
565       int t = z.length() - 1;\r
566       while (t >= 0 && z.charAt(t) == '0')\r
567         t--;\r
568       if (t >= 0 && z.charAt(t) == '.')\r
569         t--;\r
570       z = z.substring(0, t + 1);\r
571     }\r
572 \r
573     return whole + z;\r
574   }\r
575 \r
576   private String exp_format(double d) {\r
577     String f = "";\r
578     int e = 0;\r
579     double dd = d;\r
580     double factor = 1;\r
581     if (d != 0) {\r
582       while (dd > 10) {\r
583         e++;\r
584         factor /= 10;\r
585         dd = dd / 10;\r
586       }\r
587       while (dd < 1) {\r
588         e--;\r
589         factor *= 10;\r
590         dd = dd * 10;\r
591       }\r
592     }\r
593     if ((fmt == 'g' || fmt == 'G') && e >= -4 && e < precision)\r
594       return fixed_format(d);\r
595 \r
596     d = d * factor;\r
597     f = f + fixed_format(d);\r
598 \r
599     if (fmt == 'e' || fmt == 'g')\r
600       f = f + "e";\r
601     else\r
602       f = f + "E";\r
603 \r
604     String p = "000";\r
605     if (e >= 0) {\r
606       f = f + "+";\r
607       p = p + e;\r
608     } else {\r
609       f = f + "-";\r
610       p = p + (-e);\r
611     }\r
612 \r
613     return f + p.substring(p.length() - 3, p.length());\r
614   }\r
615 \r
616   private int width;\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
626 }\r
627 \r
628 \r
629 \r
630 \r
631 \r