summaryrefslogtreecommitdiffstats
path: root/Help/manual/file_api/schema_cmakeFiles.json
blob: 36118257ef5a32aba5fda671910369c3e0d29376 (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
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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Schema for the CMake cmakeFiles object kind",
  "type": "object",
  "required": [
    "kind",
    "version",
    "paths",
    "inputs"
  ],
  "oneOf": [
    {
      "$ref": "#/definitions/cmakeFilesV1_0"
    },
    {
      "$ref": "#/definitions/cmakeFilesV1_1"
    }
  ],
  "definitions": {
    "kind": {
      "type": "string",
      "const": "cmakeFiles",
      "description": "Specifies the object kind"
    },
    "versionV1_0": {
      "type": "object",
      "required": [
        "major",
        "minor"
      ],
      "properties": {
        "major": {
          "type": "integer",
          "const": 1
        },
        "minor": {
          "type": "integer",
          "const": 0
        }
      },
      "additionalProperties": false
    },
    "versionV1_1": {
      "type": "object",
      "required": [
        "major",
        "minor"
      ],
      "properties": {
        "major": {
          "type": "integer",
          "const": 1
        },
        "minor": {
          "type": "integer",
          "const": 1
        }
      },
      "additionalProperties": false
    },
    "paths": {
      "type": "object",
      "required": [
        "build",
        "source"
      ],
      "properties": {
        "build": {
          "type": "string",
          "description": "Absolute path to the top-level build directory"
        },
        "source": {
          "type": "string",
          "description": "Absolute path to the top-level source directory"
        }
      },
      "additionalProperties": false
    },
    "inputs": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "path"
        ],
        "properties": {
          "path": {
            "type": "string",
            "description": "Path to an input file to CMake"
          },
          "isGenerated": {
            "type": "boolean",
            "description": "Indicates if the file is under the build directory in out-of-source builds"
          },
          "isExternal": {
            "type": "boolean",
            "description": "Indicates if the file is not under source or build directories"
          },
          "isCMake": {
            "type": "boolean",
            "description": "Indicates if the file is in the CMake installation"
          }
        },
        "additionalProperties": false
      }
    },
    "globsDependentV1_1": {
      "type": "array",
      "description": "Optional member present only when the project calls file(GLOB) or file(GLOB_RECURSE) with the CONFIGURE_DEPENDS option",
      "items": {
        "type": "object",
        "required": [
          "expression",
          "paths"
        ],
        "properties": {
          "expression": {
            "type": "string",
            "description": "The globbing expression. If the result of the expression no longer matches the same list of paths, the build system is considered out of date and the build tool will re-run cmake."
          },
          "recurse": {
            "type": "boolean",
            "description": "This will be true if the glob expression was from a file(GLOB_RECURSE) call"
          },
          "listDirectories": {
            "type": "boolean",
            "description": "This will be true if the expression is from a file(GLOB) that does not specify LIST_DIRECTORIES false, or from a file(GLOB_RECURSE) with LIST_DIRECTORIES set to true"
          },
          "followSymlinks": {
            "type": "boolean",
            "description": "This will be true if the FOLLOW_SYMLINKS option was given"
          },
          "relative": {
            "type": "string",
            "description": "This will be present if the RELATIVE option was given. The value is the path given after the RELATIVE keyword."
          },
          "paths": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Paths matched by the globbing expression"
          }
        },
        "additionalProperties": false
      }
    },
    "cmakeFilesV1_0": {
      "properties": {
        "kind": {
          "$ref": "#/definitions/kind"
        },
        "version": {
          "$ref": "#/definitions/versionV1_0"
        },
        "paths": {
          "$ref": "#/definitions/paths"
        },
        "inputs": {
          "$ref": "#/definitions/inputs"
        }
      },
      "additionalProperties": false
    },
    "cmakeFilesV1_1": {
      "properties": {
        "kind": {
          "$ref": "#/definitions/kind"
        },
        "version": {
          "$ref": "#/definitions/versionV1_1"
        },
        "paths": {
          "$ref": "#/definitions/paths"
        },
        "inputs": {
          "$ref": "#/definitions/inputs"
        },
        "globsDependent": {
          "$ref": "#/definitions/globsDependentV1_1"
        }
      },
      "additionalProperties": false
    }
  }
}