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