about summary refs log tree commit diff
path: root/third_party/nix/src/nix/command.cc
blob: f7f183ab0ab73ef067317d0897264dfed5e0c843 (plain) (blame)
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
#include "nix/command.hh"

#include <utility>

#include "libstore/derivations.hh"
#include "libstore/store-api.hh"

namespace nix {

Commands* RegisterCommand::commands = nullptr;

void Command::printHelp(const std::string& programName, std::ostream& out) {
  Args::printHelp(programName, out);

  auto exs = examples();
  if (!exs.empty()) {
    out << "\n";
    out << "Examples:\n";
    for (auto& ex : exs) {
      out << "\n"
          << "  " << ex.description << "\n"  // FIXME: wrap
          << "  $ " << ex.command << "\n";
    }
  }
}

MultiCommand::MultiCommand(Commands _commands)
    : commands(std::move(_commands)) {
  expectedArgs.push_back(ExpectedArg{
      "command", 1, true, [=](std::vector<std::string> ss) {
        assert(!command);
        auto i = commands.find(ss[0]);
        if (i == commands.end()) {
          throw UsageError("'%s' is not a recognised command", ss[0]);
        }
        command = i->second;
      }});
}

void MultiCommand::printHelp(const std::string& programName,
                             std::ostream& out) {
  if (command) {
    command->printHelp(programName + " " + command->name(), out);
    return;
  }

  out << "Usage: " << programName << " <COMMAND> <FLAGS>... <ARGS>...\n";

  out << "\n";
  out << "Common flags:\n";
  printFlags(out);

  out << "\n";
  out << "Available commands:\n";

  Table2 table;
  for (auto& command : commands) {
    auto descr = command.second->description();
    if (!descr.empty()) {
      table.push_back(std::make_pair(command.second->name(), descr));
    }
  }
  printTable(out, table);

#if 0
    out << "\n";
    out << "For full documentation, run 'man " << programName << "' or 'man " << programName << "-<COMMAND>'.\n";
#endif
}

bool MultiCommand::processFlag(Strings::iterator& pos, Strings::iterator end) {
  if (Args::processFlag(pos, end)) {
    return true;
  }
  if (command && command->processFlag(pos, end)) {
    return true;
  }
  return false;
}

bool MultiCommand::processArgs(const Strings& args, bool finish) {
  if (command) {
    return command->processArgs(args, finish);
  }
  return Args::processArgs(args, finish);
}

StoreCommand::StoreCommand() = default;

ref<Store> StoreCommand::getStore() {
  if (!_store) {
    _store = createStore();
  }
  return ref<Store>(_store);
}

ref<Store> StoreCommand::createStore() { return openStore(); }

void StoreCommand::run() { run(getStore()); }

StorePathsCommand::StorePathsCommand(bool recursive) : recursive(recursive) {
  if (recursive) {
    mkFlag()
        .longName("no-recursive")
        .description("apply operation to specified paths only")
        .set(&this->recursive, false);
  } else {
    mkFlag()
        .longName("recursive")
        .shortName('r')
        .description("apply operation to closure of the specified paths")
        .set(&this->recursive, true);
  }

  mkFlag(0, "all", "apply operation to the entire store", &all);
}

void StorePathsCommand::run(ref<Store> store) {
  Paths storePaths;

  if (all) {
    if (!installables.empty() != 0u) {
      throw UsageError("'--all' does not expect arguments");
    }
    for (auto& p : store->queryAllValidPaths()) {
      storePaths.push_back(p);
    }
  }

  else {
    for (auto& p : toStorePaths(store, NoBuild, installables)) {
      storePaths.push_back(p);
    }

    if (recursive) {
      PathSet closure;
      store->computeFSClosure(PathSet(storePaths.begin(), storePaths.end()),
                              closure, false, false);
      storePaths = Paths(closure.begin(), closure.end());
    }
  }

  run(store, storePaths);
}

void StorePathCommand::run(ref<Store> store) {
  auto storePaths = toStorePaths(store, NoBuild, installables);

  if (storePaths.size() != 1) {
    throw UsageError("this command requires exactly one store path");
  }

  run(store, *storePaths.begin());
}

}  // namespace nix