1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2025.
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
42 import java.text.MessageFormat;
43 import java.util.logging.Level;
44 import java.util.logging.LogRecord;
45 import java.util.logging.SimpleFormatter;
46
47 /**
48 * A minor extension to the SimpleFormatter to reduce verbosity if debugging is not turned on.
49 *
50 * @author Michael J. Schnieders
51 * @since 1.0
52 */
53 public class LogFormatter extends SimpleFormatter {
54
55 private static final int warningLevel = Level.WARNING.intValue();
56 private final int size;
57 private final int rank;
58
59 /**
60 * Constructor for the LogFormatter.
61 *
62 * @since 1.0
63 */
64 LogFormatter() {
65 this(true);
66 }
67
68 /**
69 * Constructor for the LogFormatter.
70 *
71 * @since 1.0
72 */
73 LogFormatter(boolean prependRank) {
74 if (prependRank) {
75 Comm comm = Comm.world();
76 size = comm.size();
77 rank = comm.rank();
78 } else {
79 // Set the MPI size to 1 and rank to 0 to turn off prepending of the process rank.
80 size = 1;
81 rank = 0;
82 }
83 }
84
85 /**
86 * {@inheritDoc}
87 *
88 * <p>Unless debugging is turned on or the LogRecord is of level WARNING or greater, just return
89 * the message.
90 *
91 * <p>If more than one process is active, prepend the rank of the process to each line of the
92 * message.
93 *
94 * @since 1.0
95 */
96 @Override
97 public String format(LogRecord record) {
98 String message;
99 if (record.getLevel().intValue() >= warningLevel) {
100 message = super.format(record);
101 } else {
102 message = record.getMessage();
103 Object[] objects = record.getParameters();
104 message = MessageFormat.format(message, objects);
105 }
106
107 if (size > 1) {
108 String[] lines = message.split("\n");
109 message = mpiFormat(size, rank, lines);
110 }
111
112 return message;
113 }
114
115 /**
116 * Prepend the MPI rank to a line of text to give: " [Rank]line"
117 *
118 * @param size Number of MPI processes.
119 * @param rank Rank of this MPI processs.
120 * @param lines The String to format split by new line characters.
121 * @return " [Rank]line"
122 */
123 private String mpiFormat(int size, int rank, String[] lines) {
124 int rankLen = Integer.toString(size - 1).length();
125 String formatString = " [%0" + rankLen + "d]%s";
126 if (lines.length > 0) {
127 StringBuilder sb = new StringBuilder(String.format(formatString, rank, lines[0]));
128 for (int i = 1; i < lines.length; i++) {
129 sb.append("\n");
130 sb.append(String.format(formatString, rank, lines[i]));
131 }
132 return sb.toString();
133 } else {
134 StringBuilder sb = new StringBuilder(String.format(formatString, rank, ""));
135 return sb.toString();
136 }
137 }
138 }