File: CMakeFileAPI.h

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (64 lines) | stat: -rw-r--r-- 2,021 bytes parent folder | download
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
//===-- CMakeFileAPI.h - CMake File API -------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// APIs to read information from CMake's file-based API. See
// https://cmake.org/cmake/help/latest/manual/cmake-file-api.7.html for details.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_TOOLS_CACHEBUILDSESSION_CMAKEFILEAPI_H
#define LLVM_TOOLS_CACHEBUILDSESSION_CMAKEFILEAPI_H

#include "llvm/Support/JSON.h"

namespace llvm {
namespace cmake_file_api {

class CodeModel {
  json::Object Obj;

public:
  explicit CodeModel(json::Object Obj) : Obj(std::move(Obj)) {}
  CodeModel() = default;

  /// The CMake build directory.
  Expected<StringRef> getBuildPath() const;

  /// The source directory of the top-level "CMakeLists.txt" file where
  /// configuration was initiated from.
  Expected<StringRef> getSourcePath() const;

  /// Returns an array of other top-level directories that are not contained in
  /// the directory of \p getSourcePath().
  ///
  /// For example, when configuring llvm with
  /// \p -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" the returned top-level
  /// paths will be "/path/to/clang", and "/path/to/clang-tools-extra", with
  /// \p getSourcePath() returning "/path/to/llvm".
  Error getExtraTopLevelSourcePaths(SmallVectorImpl<StringRef> &Paths) const;
};

class Index {
  json::Object Obj;
  std::string CMakeFileAPIPath;

  Index(json::Object Obj, std::string CMakeFileAPIPath)
      : Obj(std::move(Obj)), CMakeFileAPIPath(std::move(CMakeFileAPIPath)) {}

public:
  Index() = default;

  static Expected<Index> fromPath(StringRef CMakeBuildPath);

  Expected<CodeModel> getCodeModel() const;
};

} // namespace cmake_file_api
} // namespace llvm

#endif