src/main/java/com/google/devtools/build/lib/syntax/DebugServerUtils.java


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

// Copyright 2018 The Bazel Authors. 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.syntax;

import java.util.concurrent.atomic.AtomicReference;

/**
 * A helper class for enabling/disabling skylark debugging.
 *
 * <p>{@code runWithDebuggingIfEnabled} must be called after {@code initializeDebugServer}, and
 * before {@code disableDebugging}.
 */
public final class DebugServerUtils {

  private DebugServerUtils() {}

  private static final AtomicReference<DebugServer> instance = new AtomicReference<>();

  /**
   * Called at the start of a debuggable skylark session to enable debugging. The custom {@link
   * Eval} supplier provided should intercept statement execution to check for breakpoints.
   */
  public static void initializeDebugServer(DebugServer server) {
    instance.set(server);
    Eval.setEvalSupplier(server.evalOverride());
  }

  /**
   * Called at the end of a debuggable skylark session to shut down the debug server and disable
   * debugging.
   */
  public static void disableDebugging() {
    DebugServer server = instance.getAndSet(null);
    if (server != null) {
      server.close();
    }
    Eval.removeCustomEval();
  }
}