aboutsummaryrefslogtreecommitdiff
path: root/src/clients/cave/cmd_print_dependent_ids.cc
blob: b02c983ab534ddb588daba1bf8653275da891863 (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
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2011 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include "cmd_print_dependent_ids.hh"
#include "format_string.hh"
#include "parse_spec_with_nice_error.hh"
#include "exceptions.hh"
#include <paludis/args/args.hh>
#include <paludis/args/do_help.hh>
#include <paludis/name.hh>
#include <paludis/environment.hh>
#include <paludis/package_database.hh>
#include <paludis/repository.hh>
#include <paludis/util/set.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <paludis/util/indirect_iterator-impl.hh>
#include <paludis/util/visitor_cast.hh>
#include <paludis/util/map.hh>
#include <paludis/util/make_null_shared_ptr.hh>
#include <paludis/resolver/collect_depped_upon.hh>
#include <paludis/generator.hh>
#include <paludis/filtered_generator.hh>
#include <paludis/filter.hh>
#include <paludis/filter_handler.hh>
#include <paludis/selection.hh>
#include <paludis/user_dep_spec.hh>
#include <paludis/package_id.hh>
#include <paludis/mask.hh>
#include <paludis/metadata_key.hh>
#include <cstdlib>
#include <iostream>
#include <algorithm>

#include "command_command_line.hh"

using namespace paludis;
using namespace cave;
using std::cout;
using std::endl;

namespace
{
    struct PrintDependentIDsCommandLine :
        CaveCommandCommandLine
    {
        virtual std::string app_name() const
        {
            return "cave print-dependent-ids";
        }

        virtual std::string app_synopsis() const
        {
            return "Prints a list of installed IDs that are dependent upon another installed ID.";
        }

        virtual std::string app_description() const
        {
            return "Prints a list of installed IDs that are dependent upon another installed ID. "
                "No formatting is used, making the output suitable for parsing by scripts.";
        }

        args::ArgsGroup g_display_options;
        args::StringArg a_format;

        PrintDependentIDsCommandLine() :
            g_display_options(main_options_section(), "Display Options", "Controls the output format."),
            a_format(&g_display_options, "format", 'f', "Select the output format. Special tokens recognised are "
                    "%c for category, %p for package, %v for version, %s for slot, %: for ':' if we have a slot and "
                    "empty otherwise, %r for repository, %F for the canonical full form, %V for the canonical full "
                    "version, %W for the canonical full unversioned form, %N for the canonical full unnamed form, "
                    "\\n for newline, \\t for tab. Default is '%F\\n'.")
        {
            add_usage_line("spec");
            a_format.set_argument("%F\\n");
        }
    };

    std::string format_id(
            const PrintDependentIDsCommandLine & c,
            const std::shared_ptr<const PackageID> & i)
    {
        std::shared_ptr<Map<char, std::string> > m(std::make_shared<Map<char, std::string>>());
        m->insert('c', stringify(i->name().category()));
        m->insert('p', stringify(i->name().package()));
        m->insert('v', stringify(i->version()));
        m->insert('s', i->slot_key() ? stringify(i->slot_key()->value()) : "");
        m->insert(':', i->slot_key() ? ":" : "");
        m->insert('r', stringify(i->repository_name()));
        m->insert('F', i->canonical_form(idcf_full));
        m->insert('V', i->canonical_form(idcf_version));
        m->insert('W', i->canonical_form(idcf_no_version));
        m->insert('N', i->canonical_form(idcf_no_name));
        return format_string(c.a_format.argument(), m);
    }
}

int
PrintDependentIDsCommand::run(
        const std::shared_ptr<Environment> & env,
        const std::shared_ptr<const Sequence<std::string > > & args
        )
{
    PrintDependentIDsCommandLine cmdline;
    cmdline.run(args, "CAVE", "CAVE_PRINT_DEPENDENT_IDS_OPTIONS", "CAVE_PRINT_DEPENDENT_IDS_CMDLINE");

    if (cmdline.a_help.specified())
    {
        cout << cmdline;
        return EXIT_SUCCESS;
    }

    if (1 != std::distance(cmdline.begin_parameters(), cmdline.end_parameters()))
        throw args::DoHelp("print-dependent-ids requires exactly one parameter");

    auto installed_filter(filter::InstalledAtRoot(env->system_root_key()->value()));
    auto spec(parse_spec_with_nice_error(*cmdline.begin_parameters(), env.get(), { }, installed_filter));
    auto ids((*env)[selection::AllVersionsSorted(
                generator::Matches(spec, make_null_shared_ptr(), { }) |
                installed_filter)]);

    if (ids->empty())
        throw NothingMatching(spec);
    else if (next(ids->begin()) != ids->end())
        throw BeMoreSpecific(spec, ids);

    auto installed_ids((*env)[selection::AllVersionsSorted(
                generator::All() |
                installed_filter)]);

    auto dependents(resolver::collect_depped_upon(env.get(), *ids->begin(), installed_ids, make_null_shared_ptr()));
    for (auto i(dependents->begin()), i_end(dependents->end()) ;
            i != i_end ; ++i)
        cout << format_id(cmdline, *i);

    return dependents->empty() ? EXIT_FAILURE : EXIT_SUCCESS;
}

std::shared_ptr<args::ArgsHandler>
PrintDependentIDsCommand::make_doc_cmdline()
{
    return std::make_shared<PrintDependentIDsCommandLine>();
}

CommandImportance
PrintDependentIDsCommand::importance() const
{
    return ci_scripting;
}