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