Newer
Older
dub_jkp / source / dub / recipe / json.d
  1. /**
  2. JSON format support for PackageRecipe
  3.  
  4. Copyright: © 2012-2014 rejectedsoftware e.K.
  5. License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file.
  6. Authors: Sönke Ludwig, Matthias Dondorff
  7. */
  8. module dub.recipe.json;
  9.  
  10. import dub.compilers.compiler;
  11. import dub.dependency;
  12. import dub.recipe.packagerecipe;
  13.  
  14. import dub.internal.vibecompat.data.json;
  15.  
  16. import std.algorithm : canFind, startsWith;
  17. import std.conv : to;
  18. import std.exception : enforce;
  19. import std.range;
  20. import std.string : format, indexOf;
  21. import std.traits : EnumMembers;
  22.  
  23.  
  24. void parseJson(ref PackageRecipe recipe, Json json, string parent_name)
  25. {
  26. foreach (string field, value; json) {
  27. switch (field) {
  28. default: break;
  29. case "name": recipe.name = value.get!string; break;
  30. case "version": recipe.version_ = value.get!string; break;
  31. case "description": recipe.description = value.get!string; break;
  32. case "homepage": recipe.homepage = value.get!string; break;
  33. case "authors": recipe.authors = deserializeJson!(string[])(value); break;
  34. case "copyright": recipe.copyright = value.get!string; break;
  35. case "license": recipe.license = value.get!string; break;
  36. case "configurations": break; // handled below, after the global settings have been parsed
  37. case "buildTypes":
  38. foreach (string name, settings; value) {
  39. BuildSettingsTemplate bs;
  40. bs.parseJson(settings, null);
  41. recipe.buildTypes[name] = bs;
  42. }
  43. break;
  44. case "toolchainRequirements":
  45. recipe.toolchainRequirements.parseJson(value);
  46. break;
  47. case "-ddoxFilterArgs": recipe.ddoxFilterArgs = deserializeJson!(string[])(value); break;
  48. case "-ddoxTool": recipe.ddoxTool = value.get!string; break;
  49. }
  50. }
  51.  
  52. enforce(recipe.name.length > 0, "The package \"name\" field is missing or empty.");
  53.  
  54. auto fullname = parent_name.length ? parent_name ~ ":" ~ recipe.name : recipe.name;
  55.  
  56. // parse build settings
  57. recipe.buildSettings.parseJson(json, fullname);
  58.  
  59. if (auto pv = "configurations" in json) {
  60. foreach (settings; *pv) {
  61. ConfigurationInfo ci;
  62. ci.parseJson(settings, recipe.name);
  63. recipe.configurations ~= ci;
  64. }
  65. }
  66.  
  67. // parse any sub packages after the main package has been fully parsed
  68. if (auto ps = "subPackages" in json)
  69. recipe.parseSubPackages(fullname, ps.opt!(Json[]));
  70. }
  71.  
  72. Json toJson(const scope ref PackageRecipe recipe)
  73. {
  74. auto ret = recipe.buildSettings.toJson();
  75. ret["name"] = recipe.name;
  76. if (!recipe.version_.empty) ret["version"] = recipe.version_;
  77. if (!recipe.description.empty) ret["description"] = recipe.description;
  78. if (!recipe.homepage.empty) ret["homepage"] = recipe.homepage;
  79. if (!recipe.authors.empty) ret["authors"] = serializeToJson(recipe.authors);
  80. if (!recipe.copyright.empty) ret["copyright"] = recipe.copyright;
  81. if (!recipe.license.empty) ret["license"] = recipe.license;
  82. if (!recipe.subPackages.empty) {
  83. Json[] jsonSubPackages = new Json[recipe.subPackages.length];
  84. foreach (i, subPackage; recipe.subPackages) {
  85. if (subPackage.path !is null) {
  86. jsonSubPackages[i] = Json(subPackage.path);
  87. } else {
  88. jsonSubPackages[i] = subPackage.recipe.toJson();
  89. }
  90. }
  91. ret["subPackages"] = jsonSubPackages;
  92. }
  93. if (recipe.configurations.length) {
  94. Json[] configs;
  95. foreach(config; recipe.configurations)
  96. configs ~= config.toJson();
  97. ret["configurations"] = configs;
  98. }
  99. if (recipe.buildTypes.length) {
  100. Json[string] types;
  101. foreach (name, settings; recipe.buildTypes)
  102. types[name] = settings.toJson();
  103. ret["buildTypes"] = types;
  104. }
  105. if (!recipe.toolchainRequirements.empty) {
  106. ret["toolchainRequirements"] = recipe.toolchainRequirements.toJson();
  107. }
  108. if (!recipe.ddoxFilterArgs.empty) ret["-ddoxFilterArgs"] = recipe.ddoxFilterArgs.serializeToJson();
  109. if (!recipe.ddoxTool.empty) ret["-ddoxTool"] = recipe.ddoxTool;
  110. return ret;
  111. }
  112.  
  113. private void parseSubPackages(ref PackageRecipe recipe, string parent_package_name, Json[] subPackagesJson)
  114. {
  115. enforce(!parent_package_name.canFind(":"), format("'subPackages' found in '%s'. This is only supported in the main package file for '%s'.",
  116. parent_package_name, getBasePackageName(parent_package_name)));
  117.  
  118. recipe.subPackages = new SubPackage[subPackagesJson.length];
  119. foreach (i, subPackageJson; subPackagesJson) {
  120. // Handle referenced Packages
  121. if(subPackageJson.type == Json.Type.string) {
  122. string subpath = subPackageJson.get!string;
  123. recipe.subPackages[i] = SubPackage(subpath, PackageRecipe.init);
  124. } else {
  125. PackageRecipe subinfo;
  126. subinfo.parseJson(subPackageJson, parent_package_name);
  127. recipe.subPackages[i] = SubPackage(null, subinfo);
  128. }
  129. }
  130. }
  131.  
  132. private void parseJson(ref ConfigurationInfo config, Json json, string package_name)
  133. {
  134. foreach (string name, value; json) {
  135. switch (name) {
  136. default: break;
  137. case "name":
  138. config.name = value.get!string;
  139. enforce(!config.name.empty, "Configurations must have a non-empty name.");
  140. break;
  141. case "platforms": config.platforms = deserializeJson!(string[])(value); break;
  142. }
  143. }
  144.  
  145. enforce(!config.name.empty, "Configuration is missing a name.");
  146. config.buildSettings.parseJson(json, package_name);
  147. }
  148.  
  149. private Json toJson(const scope ref ConfigurationInfo config)
  150. {
  151. auto ret = config.buildSettings.toJson();
  152. ret["name"] = config.name;
  153. if (config.platforms.length) ret["platforms"] = serializeToJson(config.platforms);
  154. return ret;
  155. }
  156.  
  157. private void parseJson(ref BuildSettingsTemplate bs, Json json, string package_name)
  158. {
  159. foreach(string name, value; json)
  160. {
  161. auto idx = indexOf(name, "-");
  162. string basename, suffix;
  163. if( idx >= 0 ) { basename = name[0 .. idx]; suffix = name[idx + 1 .. $]; }
  164. else basename = name;
  165. switch(basename){
  166. default: break;
  167. case "dependencies":
  168. foreach (string pkg, verspec; value) {
  169. if (pkg.startsWith(":")) {
  170. enforce(!package_name.canFind(':'), format("Short-hand packages syntax not allowed within sub packages: %s -> %s", package_name, pkg));
  171. pkg = package_name ~ pkg;
  172. }
  173. enforce(pkg !in bs.dependencies, "The dependency '"~pkg~"' is specified more than once." );
  174. bs.dependencies[pkg] = Dependency.fromJson(verspec);
  175. if (verspec.type == Json.Type.object)
  176. bs.dependencies[pkg].settings.parseJson(verspec, package_name);
  177. }
  178. break;
  179. case "systemDependencies":
  180. bs.systemDependencies = value.get!string;
  181. break;
  182. case "targetType":
  183. enforce(suffix.empty, "targetType does not support platform customization.");
  184. bs.targetType = value.get!string.to!TargetType;
  185. break;
  186. case "targetPath":
  187. enforce(suffix.empty, "targetPath does not support platform customization.");
  188. bs.targetPath = value.get!string;
  189. break;
  190. case "targetName":
  191. enforce(suffix.empty, "targetName does not support platform customization.");
  192. bs.targetName = value.get!string;
  193. break;
  194. case "workingDirectory":
  195. enforce(suffix.empty, "workingDirectory does not support platform customization.");
  196. bs.workingDirectory = value.get!string;
  197. break;
  198. case "mainSourceFile":
  199. enforce(suffix.empty, "mainSourceFile does not support platform customization.");
  200. bs.mainSourceFile = value.get!string;
  201. break;
  202. case "subConfigurations":
  203. enforce(suffix.empty, "subConfigurations does not support platform customization.");
  204. bs.subConfigurations = deserializeJson!(string[string])(value);
  205. break;
  206. case "dflags": bs.dflags[suffix] = deserializeJson!(string[])(value); break;
  207. case "lflags": bs.lflags[suffix] = deserializeJson!(string[])(value); break;
  208. case "libs": bs.libs[suffix] = deserializeJson!(string[])(value); break;
  209. case "files":
  210. case "sourceFiles": bs.sourceFiles[suffix] = deserializeJson!(string[])(value); break;
  211. case "sourcePaths": bs.sourcePaths[suffix] = deserializeJson!(string[])(value); break;
  212. case "cSourcePaths": bs.cSourcePaths[suffix] = deserializeJson!(string[])(value); break;
  213. case "sourcePath": bs.sourcePaths[suffix] ~= [value.get!string]; break; // deprecated
  214. case "excludedSourceFiles": bs.excludedSourceFiles[suffix] = deserializeJson!(string[])(value); break;
  215. case "injectSourceFiles": bs.injectSourceFiles[suffix] = deserializeJson!(string[])(value); break;
  216. case "copyFiles": bs.copyFiles[suffix] = deserializeJson!(string[])(value); break;
  217. case "extraDependencyFiles": bs.extraDependencyFiles[suffix] = deserializeJson!(string[])(value); break;
  218. case "versions": bs.versions[suffix] = deserializeJson!(string[])(value); break;
  219. case "debugVersions": bs.debugVersions[suffix] = deserializeJson!(string[])(value); break;
  220. case "-versionFilters": bs.versionFilters[suffix] = deserializeJson!(string[])(value); break;
  221. case "-debugVersionFilters": bs.debugVersionFilters[suffix] = deserializeJson!(string[])(value); break;
  222. case "importPaths": bs.importPaths[suffix] = deserializeJson!(string[])(value); break;
  223. case "cImportPaths": bs.cImportPaths[suffix] = deserializeJson!(string[])(value); break;
  224. case "stringImportPaths": bs.stringImportPaths[suffix] = deserializeJson!(string[])(value); break;
  225. case "preGenerateCommands": bs.preGenerateCommands[suffix] = deserializeJson!(string[])(value); break;
  226. case "postGenerateCommands": bs.postGenerateCommands[suffix] = deserializeJson!(string[])(value); break;
  227. case "preBuildCommands": bs.preBuildCommands[suffix] = deserializeJson!(string[])(value); break;
  228. case "postBuildCommands": bs.postBuildCommands[suffix] = deserializeJson!(string[])(value); break;
  229. case "preRunCommands": bs.preRunCommands[suffix] = deserializeJson!(string[])(value); break;
  230. case "postRunCommands": bs.postRunCommands[suffix] = deserializeJson!(string[])(value); break;
  231. case "environments": bs.environments[suffix] = deserializeJson!(string[string])(value); break;
  232. case "buildEnvironments": bs.buildEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  233. case "runEnvironments": bs.runEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  234. case "preGenerateEnvironments": bs.preGenerateEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  235. case "postGenerateEnvironments": bs.postGenerateEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  236. case "preBuildEnvironments": bs.preBuildEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  237. case "postBuildEnvironments": bs.postBuildEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  238. case "preRunEnvironments": bs.preRunEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  239. case "postRunEnvironments": bs.postRunEnvironments[suffix] = deserializeJson!(string[string])(value); break;
  240. case "buildRequirements":
  241. Flags!BuildRequirement reqs;
  242. foreach (req; deserializeJson!(string[])(value))
  243. reqs |= to!BuildRequirement(req);
  244. bs.buildRequirements[suffix] = reqs;
  245. break;
  246. case "buildOptions":
  247. Flags!BuildOption options;
  248. foreach (opt; deserializeJson!(string[])(value))
  249. options |= to!BuildOption(opt);
  250. bs.buildOptions[suffix] = options;
  251. break;
  252. }
  253. }
  254. }
  255.  
  256. private Json toJson(const scope ref BuildSettingsTemplate bs)
  257. {
  258. static string withSuffix (string pre, string post)
  259. {
  260. if (!post.length)
  261. return pre;
  262. return pre ~ "-" ~ post;
  263. }
  264.  
  265. auto ret = Json.emptyObject;
  266. if( bs.dependencies !is null ){
  267. auto deps = Json.emptyObject;
  268. foreach( pack, d; bs.dependencies )
  269. deps[pack] = d.toJson();
  270. ret["dependencies"] = deps;
  271. }
  272. if (bs.systemDependencies !is null) ret["systemDependencies"] = bs.systemDependencies;
  273. if (bs.targetType != TargetType.autodetect) ret["targetType"] = bs.targetType.to!string();
  274. if (!bs.targetPath.empty) ret["targetPath"] = bs.targetPath;
  275. if (!bs.targetName.empty) ret["targetName"] = bs.targetName;
  276. if (!bs.workingDirectory.empty) ret["workingDirectory"] = bs.workingDirectory;
  277. if (!bs.mainSourceFile.empty) ret["mainSourceFile"] = bs.mainSourceFile;
  278. if (bs.subConfigurations.length > 0) ret["subConfigurations"] = serializeToJson(bs.subConfigurations);
  279. foreach (suffix, arr; bs.dflags) ret[withSuffix("dflags", suffix)] = serializeToJson(arr);
  280. foreach (suffix, arr; bs.lflags) ret[withSuffix("lflags", suffix)] = serializeToJson(arr);
  281. foreach (suffix, arr; bs.libs) ret[withSuffix("libs", suffix)] = serializeToJson(arr);
  282. foreach (suffix, arr; bs.sourceFiles) ret[withSuffix("sourceFiles", suffix)] = serializeToJson(arr);
  283. foreach (suffix, arr; bs.sourcePaths) ret[withSuffix("sourcePaths", suffix)] = serializeToJson(arr);
  284. foreach (suffix, arr; bs.cSourcePaths) ret[withSuffix("cSourcePaths", suffix)] = serializeToJson(arr);
  285. foreach (suffix, arr; bs.excludedSourceFiles) ret[withSuffix("excludedSourceFiles", suffix)] = serializeToJson(arr);
  286. foreach (suffix, arr; bs.injectSourceFiles) ret[withSuffix("injectSourceFiles", suffix)] = serializeToJson(arr);
  287. foreach (suffix, arr; bs.copyFiles) ret[withSuffix("copyFiles", suffix)] = serializeToJson(arr);
  288. foreach (suffix, arr; bs.extraDependencyFiles) ret[withSuffix("extraDependencyFiles", suffix)] = serializeToJson(arr);
  289. foreach (suffix, arr; bs.versions) ret[withSuffix("versions", suffix)] = serializeToJson(arr);
  290. foreach (suffix, arr; bs.debugVersions) ret[withSuffix("debugVersions", suffix)] = serializeToJson(arr);
  291. foreach (suffix, arr; bs.versionFilters) ret[withSuffix("-versionFilters", suffix)] = serializeToJson(arr);
  292. foreach (suffix, arr; bs.debugVersionFilters) ret[withSuffix("-debugVersionFilters", suffix)] = serializeToJson(arr);
  293. foreach (suffix, arr; bs.importPaths) ret[withSuffix("importPaths", suffix)] = serializeToJson(arr);
  294. foreach (suffix, arr; bs.cImportPaths) ret[withSuffix("cImportPaths", suffix)] = serializeToJson(arr);
  295. foreach (suffix, arr; bs.stringImportPaths) ret[withSuffix("stringImportPaths", suffix)] = serializeToJson(arr);
  296. foreach (suffix, arr; bs.preGenerateCommands) ret[withSuffix("preGenerateCommands", suffix)] = serializeToJson(arr);
  297. foreach (suffix, arr; bs.postGenerateCommands) ret[withSuffix("postGenerateCommands", suffix)] = serializeToJson(arr);
  298. foreach (suffix, arr; bs.preBuildCommands) ret[withSuffix("preBuildCommands", suffix)] = serializeToJson(arr);
  299. foreach (suffix, arr; bs.postBuildCommands) ret[withSuffix("postBuildCommands", suffix)] = serializeToJson(arr);
  300. foreach (suffix, arr; bs.preRunCommands) ret[withSuffix("preRunCommands", suffix)] = serializeToJson(arr);
  301. foreach (suffix, arr; bs.postRunCommands) ret[withSuffix("postRunCommands", suffix)] = serializeToJson(arr);
  302. foreach (suffix, aa; bs.environments) ret[withSuffix("environments", suffix)] = serializeToJson(aa);
  303. foreach (suffix, aa; bs.buildEnvironments) ret[withSuffix("buildEnvironments", suffix)] = serializeToJson(aa);
  304. foreach (suffix, aa; bs.runEnvironments) ret[withSuffix("runEnvironments", suffix)] = serializeToJson(aa);
  305. foreach (suffix, aa; bs.preGenerateEnvironments) ret[withSuffix("preGenerateEnvironments", suffix)] = serializeToJson(aa);
  306. foreach (suffix, aa; bs.postGenerateEnvironments) ret[withSuffix("postGenerateEnvironments", suffix)] = serializeToJson(aa);
  307. foreach (suffix, aa; bs.preBuildEnvironments) ret[withSuffix("preBuildEnvironments", suffix)] = serializeToJson(aa);
  308. foreach (suffix, aa; bs.postBuildEnvironments) ret[withSuffix("postBuildEnvironments", suffix)] = serializeToJson(aa);
  309. foreach (suffix, aa; bs.preRunEnvironments) ret[withSuffix("preRunEnvironments", suffix)] = serializeToJson(aa);
  310. foreach (suffix, aa; bs.postRunEnvironments) ret[withSuffix("postRunEnvironments", suffix)] = serializeToJson(aa);
  311. foreach (suffix, arr; bs.buildRequirements) {
  312. string[] val;
  313. foreach (i; [EnumMembers!BuildRequirement])
  314. if (arr & i) val ~= to!string(i);
  315. ret[withSuffix("buildRequirements", suffix)] = serializeToJson(val);
  316. }
  317. foreach (suffix, arr; bs.buildOptions) {
  318. string[] val;
  319. foreach (i; [EnumMembers!BuildOption])
  320. if (arr & i) val ~= to!string(i);
  321. ret[withSuffix("buildOptions", suffix)] = serializeToJson(val);
  322. }
  323. return ret;
  324. }
  325.  
  326. private void parseJson(ref ToolchainRequirements tr, Json json)
  327. {
  328. foreach (string name, value; json)
  329. tr.addRequirement(name, value.get!string);
  330. }
  331.  
  332. private Json toJson(const scope ref ToolchainRequirements tr)
  333. {
  334. auto ret = Json.emptyObject;
  335. if (tr.dub != Dependency.any) ret["dub"] = serializeToJson(tr.dub);
  336. if (tr.frontend != Dependency.any) ret["frontend"] = serializeToJson(tr.frontend);
  337. if (tr.dmd != Dependency.any) ret["dmd"] = serializeToJson(tr.dmd);
  338. if (tr.ldc != Dependency.any) ret["ldc"] = serializeToJson(tr.ldc);
  339. if (tr.gdc != Dependency.any) ret["gdc"] = serializeToJson(tr.gdc);
  340. return ret;
  341. }
  342.  
  343. unittest {
  344. import std.string: strip, outdent;
  345. static immutable json = `
  346. {
  347. "name": "projectname",
  348. "environments": {
  349. "Var1": "env"
  350. },
  351. "buildEnvironments": {
  352. "Var2": "buildEnv"
  353. },
  354. "runEnvironments": {
  355. "Var3": "runEnv"
  356. },
  357. "preGenerateEnvironments": {
  358. "Var4": "preGenEnv"
  359. },
  360. "postGenerateEnvironments": {
  361. "Var5": "postGenEnv"
  362. },
  363. "preBuildEnvironments": {
  364. "Var6": "preBuildEnv"
  365. },
  366. "postBuildEnvironments": {
  367. "Var7": "postBuildEnv"
  368. },
  369. "preRunEnvironments": {
  370. "Var8": "preRunEnv"
  371. },
  372. "postRunEnvironments": {
  373. "Var9": "postRunEnv"
  374. }
  375. }
  376. `.strip.outdent;
  377. auto jsonValue = parseJsonString(json);
  378. PackageRecipe rec1;
  379. parseJson(rec1, jsonValue, null);
  380. PackageRecipe rec;
  381. parseJson(rec, rec1.toJson(), null); // verify that all fields are serialized properly
  382.  
  383. assert(rec.name == "projectname");
  384. assert(rec.buildSettings.environments == ["": ["Var1": "env"]]);
  385. assert(rec.buildSettings.buildEnvironments == ["": ["Var2": "buildEnv"]]);
  386. assert(rec.buildSettings.runEnvironments == ["": ["Var3": "runEnv"]]);
  387. assert(rec.buildSettings.preGenerateEnvironments == ["": ["Var4": "preGenEnv"]]);
  388. assert(rec.buildSettings.postGenerateEnvironments == ["": ["Var5": "postGenEnv"]]);
  389. assert(rec.buildSettings.preBuildEnvironments == ["": ["Var6": "preBuildEnv"]]);
  390. assert(rec.buildSettings.postBuildEnvironments == ["": ["Var7": "postBuildEnv"]]);
  391. assert(rec.buildSettings.preRunEnvironments == ["": ["Var8": "preRunEnv"]]);
  392. assert(rec.buildSettings.postRunEnvironments == ["": ["Var9": "postRunEnv"]]);
  393. }