1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.ui;
39
40 import edu.rit.pj.Comm;
41 import java.text.MessageFormat;
42 import java.util.logging.Level;
43 import java.util.logging.LogRecord;
44 import java.util.logging.SimpleFormatter;
45
46 /**
47 * A minor extension to the SimpleFormatter to reduce verbosity if debugging is not turned on.
48 *
49 * @author Michael J. Schnieders
50 * @since 1.0
51 */
52 public class LogFormatter extends SimpleFormatter {
53
54 private static final int warningLevel = Level.WARNING.intValue();
55 private final int size;
56 private final int rank;
57
58 /**
59 * Constructor for the LogFormatter.
60 *
61 * @since 1.0
62 */
63 LogFormatter() {
64 this(true);
65 }
66
67 /**
68 * Constructor for the LogFormatter.
69 *
70 * @since 1.0
71 */
72 LogFormatter(boolean prependRank) {
73 if (prependRank) {
74 Comm comm = Comm.world();
75 size = comm.size();
76 rank = comm.rank();
77 } else {
78 // Set the MPI size to 1 and rank to 0 to turn off prepending of the process rank.
79 size = 1;
80 rank = 0;
81 }
82 }
83
84 /**
85 * {@inheritDoc}
86 *
87 * <p>Unless debugging is turned on or the LogRecord is of level WARNING or greater, just return
88 * the message.
89 *
90 * <p>If more than one process is active, prepend the rank of the process to each line of the
91 * message.
92 *
93 * @since 1.0
94 */
95 @Override
96 public String format(LogRecord record) {
97 String message;
98 if (record.getLevel().intValue() >= warningLevel) {
99 message = super.format(record);
100 } else {
101 message = record.getMessage();
102 Object[] objects = record.getParameters();
103 message = MessageFormat.format(message, objects);
104 }
105
106 if (size > 1) {
107 String[] lines = message.split("\n");
108 message = mpiFormat(size, rank, lines);
109 }
110
111 return message;
112 }
113
114 /**
115 * Prepend the MPI rank to a line of text to give: " [Rank]line"
116 *
117 * @param size Number of MPI processes.
118 * @param rank Rank of this MPI processs.
119 * @param lines The String to format split by new line characters.
120 * @return " [Rank]line"
121 */
122 private String mpiFormat(int size, int rank, String[] lines) {
123 int rankLen = Integer.toString(size - 1).length();
124 String formatString = " [%0" + rankLen + "d]%s";
125 StringBuilder sb = new StringBuilder(String.format(formatString, rank, lines[0]));
126 for (int i = 1; i < lines.length; i++) {
127 sb.append("\n");
128 sb.append(String.format(formatString, rank, lines[i]));
129 }
130 return sb.toString();
131 }
132 }