aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/profiler/chart/HtmlCreator.java
blob: c9aca2cf496efc781f691be68fe51dbc3829c609 (plain)
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
// Copyright 2015 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.profiler.chart;

import com.google.common.base.Optional;
import com.google.devtools.build.lib.profiler.ProfileInfo;
import com.google.devtools.build.lib.profiler.ProfilePhaseStatistics;
import com.google.devtools.build.lib.vfs.Path;

import java.io.BufferedOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.util.List;

/**
 * Creates an HTML page displaying the various statistics and charts generated
 * from the profile file.
 */
public final class HtmlCreator {

  private final PrintStream out;
  private final Chart chart;
  private final HtmlChartVisitor chartVisitor;
  private final Optional<SkylarkStatistics> skylarkStats;

  private HtmlCreator(
      PrintStream out,
      Chart chart,
      Optional<SkylarkStatistics> skylarkStats,
      int htmlPixelsPerSecond) {
    this.out = out;
    this.chart = chart;
    chartVisitor = new HtmlChartVisitor(out, htmlPixelsPerSecond);
    this.skylarkStats = skylarkStats;
  }

  private void print() {
    htmlFrontMatter();
    chart.accept(chartVisitor);
    if (skylarkStats.isPresent()) {
      skylarkStats.get().printHtmlBody();
    }
    htmlBackMatter();
  }

  private void htmlFrontMatter() {
    out.println("<html><head>");
    out.printf("<title>%s</title>", chart.getTitle());

    chartVisitor.printCss(chart.getSortedTypes());

    if (skylarkStats.isPresent()) {
      skylarkStats.get().printHtmlHead();
    }

    out.println("</head>");
    out.println("<body>");
  }

  private void htmlBackMatter() {
    out.println("</body>");
    out.println("</html>");
  }

  /**
   * Writes the HTML profiling information.
   * @param info
   * @param htmlFile
   * @param statistics
   * @param detailed
   * @param htmlPixelsPerSecond
   * @throws IOException
   */
  public static void createHtml(
      ProfileInfo info,
      Path htmlFile,
      List<ProfilePhaseStatistics> statistics,
      boolean detailed,
      int htmlPixelsPerSecond)
      throws IOException {
    try (PrintStream out = new PrintStream(new BufferedOutputStream(htmlFile.getOutputStream()))) {
      ChartCreator chartCreator;
      Optional<SkylarkStatistics> skylarkStats;
      if (detailed) {
        chartCreator = new DetailedChartCreator(info, statistics);
        skylarkStats = Optional.of(new SkylarkStatistics(out, info));
      } else {
        chartCreator = new AggregatingChartCreator(info, statistics);
        skylarkStats = Optional.absent();
      }
      Chart chart = chartCreator.create();
      new HtmlCreator(out, chart, skylarkStats, htmlPixelsPerSecond).print();
    }
  }
}