1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/*******************************************************************************
* Copyright (c) 2009, 2011 Mountainminds GmbH & Co. KG and Contributors
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Marc R. Hoffmann - initial API and implementation
*
*******************************************************************************/
package org.jacoco.report.html;
import static org.jacoco.core.analysis.ICoverageNode.CounterEntity.BRANCH;
import static org.jacoco.core.analysis.ICoverageNode.CounterEntity.CLASS;
import static org.jacoco.core.analysis.ICoverageNode.CounterEntity.INSTRUCTION;
import static org.jacoco.core.analysis.ICoverageNode.CounterEntity.LINE;
import static org.jacoco.core.analysis.ICoverageNode.CounterEntity.METHOD;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import java.util.Locale;
import org.jacoco.core.analysis.ICoverageNode;
import org.jacoco.core.analysis.ICoverageNode.CounterEntity;
import org.jacoco.core.data.ExecutionData;
import org.jacoco.core.data.SessionInfo;
import org.jacoco.report.ILanguageNames;
import org.jacoco.report.IMultiReportOutput;
import org.jacoco.report.IReportFormatter;
import org.jacoco.report.IReportVisitor;
import org.jacoco.report.ISourceFileLocator;
import org.jacoco.report.JavaNames;
import org.jacoco.report.ReportOutputFolder;
import org.jacoco.report.internal.html.GroupPage;
import org.jacoco.report.internal.html.IHTMLReportContext;
import org.jacoco.report.internal.html.ILinkable;
import org.jacoco.report.internal.html.SessionsPage;
import org.jacoco.report.internal.html.index.ElementIndex;
import org.jacoco.report.internal.html.index.IIndexUpdate;
import org.jacoco.report.internal.html.resources.Resources;
import org.jacoco.report.internal.html.resources.Styles;
import org.jacoco.report.internal.html.table.BarColumn;
import org.jacoco.report.internal.html.table.CounterColumn;
import org.jacoco.report.internal.html.table.LabelColumn;
import org.jacoco.report.internal.html.table.PercentageColumn;
import org.jacoco.report.internal.html.table.Table;
/**
* Formatter for coverage reports in multiple HTML pages.
*
* @author Marc R. Hoffmann
* @version $qualified.bundle.version$
*/
public class HTMLFormatter implements IReportFormatter, IHTMLReportContext {
private IMultiReportOutput output;
private ILanguageNames languageNames = new JavaNames();
private Locale locale = Locale.getDefault();
private String footerText = "";
private String outputEncoding = "UTF-8";
private Resources resources;
private ElementIndex index;
private SessionsPage sessionsPage;
private Table table;
/**
* New instance with default settings.
*/
public HTMLFormatter() {
}
/**
* Defines the output for files created by the formatter. This is a
* mandatory property.
*
* @param output
* file output
*/
public void setReportOutput(final IMultiReportOutput output) {
this.output = output;
}
/**
* Sets the implementation for language name display. Java language names
* are defined by default.
*
* @param languageNames
* converter for language specific names
*/
public void setLanguageNames(final ILanguageNames languageNames) {
this.languageNames = languageNames;
}
/**
* Sets the locale used for report rendering. The current default locale is
* used by default.
*
* @param locale
* locale used for report rendering
*/
public void setLocale(final Locale locale) {
this.locale = locale;
}
/**
* Sets the optional text that should be included in every footer page.
*
* @param footerText
* footer text
*/
public void setFooterText(final String footerText) {
this.footerText = footerText;
}
/**
* Sets the encoding used for generated HTML pages. Default is UTF-8.
*
* @param outputEncoding
* HTML output encoding
*/
public void setOutputEncoding(final String outputEncoding) {
this.outputEncoding = outputEncoding;
}
// === IHTMLReportContext ===
public ILanguageNames getLanguageNames() {
return languageNames;
}
public Resources getResources() {
return resources;
}
public Table getTable() {
if (table == null) {
table = createTable();
}
return table;
}
private Table createTable() {
final Table table = new Table();
table.add("Element", null, new LabelColumn(), false);
table.add("Missed Instructions", Styles.BAR, new BarColumn(INSTRUCTION,
locale), true);
table.add("Cov.", Styles.CTR2,
new PercentageColumn(INSTRUCTION, locale), false);
table.add("Missed Branches", Styles.BAR, new BarColumn(BRANCH, locale),
false);
table.add("Cov.", Styles.CTR2, new PercentageColumn(BRANCH, locale),
false);
addMissedTotalColumns(table, "Lines", LINE);
addMissedTotalColumns(table, "Methods", METHOD);
addMissedTotalColumns(table, "Classes", CLASS);
return table;
}
private void addMissedTotalColumns(final Table table, final String label,
final CounterEntity entity) {
table.add("Missed", Styles.CTR1,
CounterColumn.newMissed(entity, locale), false);
table.add(label, Styles.CTR2, CounterColumn.newTotal(entity, locale),
false);
}
public String getFooterText() {
return footerText;
}
public ILinkable getSessionsPage() {
return sessionsPage;
}
public String getOutputEncoding() {
return outputEncoding;
}
public IIndexUpdate getIndexUpdate() {
return index;
}
public Locale getLocale() {
return locale;
}
// === IReportFormatter ===
public IReportVisitor createReportVisitor(final ICoverageNode rootNode,
final List<SessionInfo> sessionInfos,
final Collection<ExecutionData> executionData) throws IOException {
if (output == null) {
throw new IllegalStateException("No report output set.");
}
final ReportOutputFolder root = new ReportOutputFolder(output);
resources = new Resources(root);
resources.copyResources();
index = new ElementIndex(root);
final GroupPage rootpage = new GroupPage(rootNode, null, root, this) {
@Override
public String getLinkStyle() {
return Styles.EL_REPORT;
}
@Override
public void visitEnd(final ISourceFileLocator sourceFileLocator)
throws IOException {
super.visitEnd(sourceFileLocator);
sessionsPage.renderDocument();
}
};
sessionsPage = new SessionsPage(sessionInfos, executionData, index,
rootpage, root, this);
return rootpage;
}
}
|
