src/gn/compile_commands_writer.h

// Copyright 2018 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef TOOLS_GN_COMPILE_COMMANDS_WRITER_H_
#define TOOLS_GN_COMPILE_COMMANDS_WRITER_H_

#include <vector>

#include "gn/err.h"
#include "gn/label_pattern.h"
#include "gn/target.h"

class Builder;
class BuildSettings;

class CompileCommandsWriter {
 public:
  // Writes a compilation database to the given file name consisting of the
  // recursive dependencies of all targets that match or are dependencies of
  // targets that match any given pattern.
  static bool RunAndWriteFiles(const BuildSettings* build_setting,
                               const Builder& builder,
                               const base::FilePath& output_path,
                               const std::vector<LabelPattern>& patterns,
                               Err* err);

  // Writes a compilation database using the legacy way of specifying which
  // targets to output. This format uses a comma-separated list of target names
  // ("target_name1,target_name2...") which are matched against targets in any
  // directory. Then the recursive dependencies of these deps are collected.
  //
  // TODO: Remove this legacy target_name behavior and use vector<LabelPattern>
  // version consistently.
  static bool RunAndWriteFilesLegacyFilters(const BuildSettings* build_setting,
                                            const Builder& builder,
                                            const base::FilePath& output_path,
                                            const std::string& target_filters,
                                            Err* err);

  static std::string RenderJSON(const BuildSettings* build_settings,
                                std::vector<const Target*>& all_targets);

  // Does a depth-first search of the graph starting at each target that matches
  // the given pattern, and collects all recursive dependencies of those
  // targets.
  static std::vector<const Target*> CollectDepsOfMatches(
      const std::vector<const Target*>& all_targets,
      const std::vector<LabelPattern>& patterns);

  // Performs the legacy target_name filtering.
  static std::vector<const Target*> FilterTargets(
      const std::vector<const Target*>& all_targets,
      const std::set<std::string>& target_filters_set);

 private:
  // This function visits the deps graph of a target in a DFS fashion.
  static void VisitDeps(const Target* target, TargetSet* visited);
};

#endif  // TOOLS_GN_COMPILE_COMMANDS_WRITER_H_