Skip to content

Commit da98e59

Browse files
committed
Deprecate duplicated enum LocalPackageType -> PlacementLocation
Two enums, both have the same values, in the same order.
1 parent 67a58e4 commit da98e59

File tree

3 files changed

+33
-32
lines changed

3 files changed

+33
-32
lines changed

source/dub/commandline.d

+4-4
Original file line numberDiff line numberDiff line change
@@ -2190,7 +2190,7 @@ class AddOverrideCommand : Command {
21902190
{
21912191
enforceUsage(app_args.length == 0, "Unexpected application arguments.");
21922192
enforceUsage(free_args.length == 3, "Expected three arguments, not "~free_args.length.to!string);
2193-
auto scope_ = m_system ? LocalPackageType.system : LocalPackageType.user;
2193+
auto scope_ = m_system ? PlacementLocation.system : PlacementLocation.user;
21942194
auto pack = free_args[0];
21952195
auto ver = Dependency(free_args[1]);
21962196
if (existsFile(NativePath(free_args[2]))) {
@@ -2232,7 +2232,7 @@ class RemoveOverrideCommand : Command {
22322232
{
22332233
enforceUsage(app_args.length == 0, "Unexpected application arguments.");
22342234
enforceUsage(free_args.length == 2, "Expected two arguments, not "~free_args.length.to!string);
2235-
auto scope_ = m_system ? LocalPackageType.system : LocalPackageType.user;
2235+
auto scope_ = m_system ? PlacementLocation.system : PlacementLocation.user;
22362236
dub.packageManager.removeOverride(scope_, free_args[0], Dependency(free_args[1]));
22372237
return 0;
22382238
}
@@ -2260,8 +2260,8 @@ class ListOverridesCommand : Command {
22602260
else logInfo("%s %s => %s", ovr.package_, ovr.version_, ovr.targetVersion);
22612261
}
22622262
}
2263-
printList(dub.packageManager.getOverrides(LocalPackageType.user), "User wide overrides");
2264-
printList(dub.packageManager.getOverrides(LocalPackageType.system), "System wide overrides");
2263+
printList(dub.packageManager.getOverrides(PlacementLocation.user), "User wide overrides");
2264+
printList(dub.packageManager.getOverrides(PlacementLocation.system), "System wide overrides");
22652265
return 0;
22662266
}
22672267
}

source/dub/dub.d

+4-4
Original file line numberDiff line numberDiff line change
@@ -964,7 +964,7 @@ class Dub {
964964
void addLocalPackage(string path, string ver, bool system)
965965
{
966966
if (m_dryRun) return;
967-
m_packageManager.addLocalPackage(makeAbsolute(path), ver, system ? LocalPackageType.system : LocalPackageType.user);
967+
m_packageManager.addLocalPackage(makeAbsolute(path), ver, system ? PlacementLocation.system : PlacementLocation.user);
968968
}
969969

970970
/** Removes a directory from the list of locally known packages.
@@ -981,7 +981,7 @@ class Dub {
981981
void removeLocalPackage(string path, bool system)
982982
{
983983
if (m_dryRun) return;
984-
m_packageManager.removeLocalPackage(makeAbsolute(path), system ? LocalPackageType.system : LocalPackageType.user);
984+
m_packageManager.removeLocalPackage(makeAbsolute(path), system ? PlacementLocation.system : PlacementLocation.user);
985985
}
986986

987987
/** Registers a local directory to search for packages to use for satisfying
@@ -997,7 +997,7 @@ class Dub {
997997
void addSearchPath(string path, bool system)
998998
{
999999
if (m_dryRun) return;
1000-
m_packageManager.addSearchPath(makeAbsolute(path), system ? LocalPackageType.system : LocalPackageType.user);
1000+
m_packageManager.addSearchPath(makeAbsolute(path), system ? PlacementLocation.system : PlacementLocation.user);
10011001
}
10021002

10031003
/** Unregisters a local directory search path.
@@ -1012,7 +1012,7 @@ class Dub {
10121012
void removeSearchPath(string path, bool system)
10131013
{
10141014
if (m_dryRun) return;
1015-
m_packageManager.removeSearchPath(makeAbsolute(path), system ? LocalPackageType.system : LocalPackageType.user);
1015+
m_packageManager.removeSearchPath(makeAbsolute(path), system ? PlacementLocation.system : PlacementLocation.user);
10161016
}
10171017

10181018
/** Queries all package suppliers with the given query string.

source/dub/packagemanager.d

+25-24
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ class PackageManager {
146146
import std.algorithm.iteration : map;
147147
import std.array : array;
148148

149-
m_repositories.length = LocalPackageType.max+1;
149+
m_repositories.length = PlacementLocation.max+1;
150150
m_repositories ~= custom_cache_paths.map!(p => Repository(p)).array;
151151

152152
refresh(false);
@@ -319,7 +319,7 @@ class PackageManager {
319319

320320
string gitReference = versionSpec.chompPrefix("~");
321321
NativePath destination = getPackagePath(
322-
m_repositories[LocalPackageType.user].packagePath,
322+
m_repositories[PlacementLocation.user].packagePath,
323323
name, versionSpec);
324324
// For libraries leaking their import path
325325
destination ~= name;
@@ -475,28 +475,28 @@ class PackageManager {
475475

476476
/** Returns a list of all package overrides for the given scope.
477477
*/
478-
const(PackageOverride)[] getOverrides(LocalPackageType scope_)
478+
const(PackageOverride)[] getOverrides(PlacementLocation scope_)
479479
const {
480480
return m_repositories[scope_].overrides;
481481
}
482482

483483
/** Adds a new override for the given package.
484484
*/
485-
void addOverride(LocalPackageType scope_, string package_, Dependency version_spec, Version target)
485+
void addOverride(PlacementLocation scope_, string package_, Dependency version_spec, Version target)
486486
{
487487
m_repositories[scope_].overrides ~= PackageOverride(package_, version_spec, target);
488488
writeLocalPackageOverridesFile(scope_);
489489
}
490490
/// ditto
491-
void addOverride(LocalPackageType scope_, string package_, Dependency version_spec, NativePath target)
491+
void addOverride(PlacementLocation scope_, string package_, Dependency version_spec, NativePath target)
492492
{
493493
m_repositories[scope_].overrides ~= PackageOverride(package_, version_spec, target);
494494
writeLocalPackageOverridesFile(scope_);
495495
}
496496

497497
/** Removes an existing package override.
498498
*/
499-
void removeOverride(LocalPackageType scope_, string package_, Dependency version_spec)
499+
void removeOverride(PlacementLocation scope_, string package_, Dependency version_spec)
500500
{
501501
Repository* rep = &m_repositories[scope_];
502502
foreach (i, ovr; rep.overrides) {
@@ -643,7 +643,7 @@ class PackageManager {
643643
remove(pack);
644644
}
645645

646-
Package addLocalPackage(NativePath path, string verName, LocalPackageType type)
646+
Package addLocalPackage(NativePath path, string verName, PlacementLocation type)
647647
{
648648
path.endsWithSlash = true;
649649
auto pack = Package.load(path);
@@ -669,7 +669,7 @@ class PackageManager {
669669
return pack;
670670
}
671671

672-
void removeLocalPackage(NativePath path, LocalPackageType type)
672+
void removeLocalPackage(NativePath path, PlacementLocation type)
673673
{
674674
path.endsWithSlash = true;
675675

@@ -693,14 +693,14 @@ class PackageManager {
693693
}
694694

695695
/// For the given type add another path where packages will be looked up.
696-
void addSearchPath(NativePath path, LocalPackageType type)
696+
void addSearchPath(NativePath path, PlacementLocation type)
697697
{
698698
m_repositories[type].searchPath ~= path;
699699
writeLocalPackageList(type);
700700
}
701701

702702
/// Removes a search path from the given type.
703-
void removeSearchPath(NativePath path, LocalPackageType type)
703+
void removeSearchPath(NativePath path, PlacementLocation type)
704704
{
705705
m_repositories[type].searchPath = m_repositories[type].searchPath.filter!(p => p != path)().array();
706706
writeLocalPackageList(type);
@@ -711,7 +711,7 @@ class PackageManager {
711711
logDiagnostic("Refreshing local packages (refresh existing: %s)...", refresh_existing_packages);
712712

713713
// load locally defined packages
714-
void scanLocalPackages(LocalPackageType type)
714+
void scanLocalPackages(PlacementLocation type)
715715
{
716716
NativePath list_path = m_repositories[type].packagePath;
717717
Package[] packs;
@@ -770,9 +770,9 @@ class PackageManager {
770770
}
771771
if (!m_disableDefaultSearchPaths)
772772
{
773-
scanLocalPackages(LocalPackageType.system);
774-
scanLocalPackages(LocalPackageType.user);
775-
scanLocalPackages(LocalPackageType.package_);
773+
scanLocalPackages(PlacementLocation.system);
774+
scanLocalPackages(PlacementLocation.user);
775+
scanLocalPackages(PlacementLocation.local);
776776
}
777777

778778
auto old_packages = m_packages;
@@ -825,7 +825,7 @@ class PackageManager {
825825
foreach (p; this.completeSearchPath)
826826
scanPackageFolder(p);
827827

828-
void loadOverrides(LocalPackageType type)
828+
void loadOverrides(PlacementLocation type)
829829
{
830830
m_repositories[type].overrides = null;
831831
auto ovrfilepath = m_repositories[type].packagePath ~ LocalOverridesFilename;
@@ -842,9 +842,9 @@ class PackageManager {
842842
}
843843
if (!m_disableDefaultSearchPaths)
844844
{
845-
loadOverrides(LocalPackageType.package_);
846-
loadOverrides(LocalPackageType.user);
847-
loadOverrides(LocalPackageType.system);
845+
loadOverrides(PlacementLocation.local);
846+
loadOverrides(PlacementLocation.user);
847+
loadOverrides(PlacementLocation.system);
848848
}
849849
}
850850

@@ -878,7 +878,7 @@ class PackageManager {
878878
return hash[].dup;
879879
}
880880

881-
private void writeLocalPackageList(LocalPackageType type)
881+
private void writeLocalPackageList(PlacementLocation type)
882882
{
883883
Json[] newlist;
884884
foreach (p; m_repositories[type].searchPath) {
@@ -902,7 +902,7 @@ class PackageManager {
902902
writeJsonFile(path ~ LocalPackagesFilename, Json(newlist));
903903
}
904904

905-
private void writeLocalPackageOverridesFile(LocalPackageType type)
905+
private void writeLocalPackageOverridesFile(PlacementLocation type)
906906
{
907907
Json[] newlist;
908908
foreach (ovr; m_repositories[type].overrides) {
@@ -975,10 +975,11 @@ struct PackageOverride {
975975
}
976976
}
977977

978-
enum LocalPackageType {
979-
package_,
980-
user,
981-
system
978+
deprecated("Use `PlacementLocation` instead")
979+
enum LocalPackageType : PlacementLocation {
980+
package_ = PlacementLocation.local,
981+
user = PlacementLocation.user,
982+
system = PlacementLocation.system,
982983
}
983984

984985
private enum LocalPackagesFilename = "local-packages.json";

0 commit comments

Comments
 (0)