lix-project/lix
20
58
Fork 31
Code Issues 364 Code Review (Gerrit) Projects 3 Releases Wiki Activity

nix-env: Add regular expression support in selectors

Browse source 
So you can now do things like:

  $ nix-env -qa '.*zip.*'
  $ nix-env -qa '.*(firefox|chromium).*'
This commit is contained in:
Eelco Dolstra 2014-10-03 18:47:16 +02:00
parent 3800f441e4
commit 104e55bb7f
5 changed files with 165 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

117
doc/manual/command-ref/nix-env.xml
View file

@ -66,6 +66,75 @@ be performed. These are documented below.</para>
<!--######################################################################-->
<refsection><title>Selectors</title>
<para>Several commands, such as <command>nix-env -q</command> and
<command>nix-env -i</command>, take a list of arguments that specify
the packages on which to operate. These are extended regular
expressions that must match the entire name of the package. (For
details on regular expressions, see
<citerefentry><refentrytitle>regex</refentrytitle><manvolnum>7</manvolnum></citerefentry>.)
The match is case-sensitive. The regular expression can optionally be
followed by a dash and a version number; if omitted, any version of
the package will match. Here are some examples:
<variablelist>
<varlistentry>
<term><literal>firefox</literal></term>
<listitem><para>Matches the package name
<literal>firefox</literal> and any version.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>firefox-32.0</literal></term>
<listitem><para>Matches the package name
<literal>firefox</literal> and version
<literal>32.0</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>gtk\\+</literal></term>
<listitem><para>Matches the package name
<literal>gtk+</literal>. The <literal>+</literal> character must
be escaped using a backslash to prevent it from being interpreted
as a quantifier, and the backslash must be escaped in turn with
another backslash to ensure that the shell passes it
on.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>.\*</literal></term>
<listitem><para>Matches any package name. This is the default for
most commands.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>'.*zip.*'</literal></term>
<listitem><para>Matches any package name containing the string
<literal>zip</literal>. Note the dots: <literal>'*zip*'</literal>
does not work, because in a regular expression, the character
<literal>*</literal> is interpreted as a
quantifier.</para></listitem>
</varlistentry>
<varlistentry>
<term><literal>'.*(firefox|chromium).*'</literal></term>
<listitem><para>Matches any package name containing the strings
<literal>firefox</literal> or
<literal>chromium</literal>.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsection>
<!--######################################################################-->
<refsection><title>Common options</title>
@ -262,7 +331,7 @@ number of possible ways:
<emphasis>attribute paths</emphasis> that select attributes from the
top-level Nix expression. This is faster than using derivation
names and unambiguous. To find out the attribute paths of available
packages, use <literal>nix-env -qaP '*'</literal>.</para></listitem>
packages, use <literal>nix-env -qaP</literal>.</para></listitem>
<listitem><para>If <option>--from-profile</option>
<replaceable>path</replaceable> is given,
@ -326,7 +395,7 @@ number of possible ways:
<term><option>-r</option></term>
<listitem><para>Remove all previously installed packages first.
This is equivalent to running <literal>nix-env -e '*'</literal>
This is equivalent to running <literal>nix-env -e '.*'</literal>
first, except that everything happens in a single
transaction.</para></listitem>
@ -369,7 +438,7 @@ $ nix-env -i -A xorg.xorgserver</screen>
<para>To install all derivations in the Nix expression <filename>foo.nix</filename>:
<screen>
$ nix-env -f ~/foo.nix -i '*'</screen>
$ nix-env -f ~/foo.nix -i '.*'</screen>
</para>
@ -537,7 +606,7 @@ upgrading `gcc-3.4' to `gcc-3.3.2'
$ nix-env --upgrade pan
<lineannotation>(no upgrades available, so nothing happens)</lineannotation>
$ nix-env -u '*' <lineannotation>(try to upgrade everything)</lineannotation>
$ nix-env -u <lineannotation>(try to upgrade everything)</lineannotation>
upgrading `hello-2.1.2' to `hello-2.1.3'
upgrading `mozilla-1.2' to `mozilla-1.4'</screen>
@ -624,7 +693,7 @@ paths designated by the symbolic names
<screen>
$ nix-env --uninstall gcc
$ nix-env -e '*' <lineannotation>(remove everything)</lineannotation></screen>
$ nix-env -e '.*' <lineannotation>(remove everything)</lineannotation></screen>
</refsection>
@ -700,7 +769,7 @@ After this, <command>nix-env -u</command> will ignore Firefox.</para>
Firefox while the old remains part of the profile:
<screen>
$ nix-env -q \*
$ nix-env -q
firefox-2.0.0.9 <lineannotation>(the current one)</lineannotation>
$ nix-env --preserve-installed -i firefox-2.0.0.11
@ -716,7 +785,7 @@ setting flag on `firefox-2.0.0.9'
$ nix-env --preserve-installed -i firefox-2.0.0.11
installing `firefox-2.0.0.11'
$ nix-env -q \*
$ nix-env -q
firefox-2.0.0.11 <lineannotation>(the enabled one)</lineannotation>
firefox-2.0.0.9 <lineannotation>(the disabled one)</lineannotation></screen>
@ -817,8 +886,7 @@ profile (<option>--installed</option>), or the derivations that are
available for installation in the active Nix expression
(<option>--available</option>). It only prints information about
derivations whose symbolic name matches one of
<replaceable>names</replaceable>. The wildcard <literal>*</literal>
shows all derivations.</para>
<replaceable>names</replaceable>.</para>
<para>The derivations are sorted by their <literal>name</literal>
attributes.</para>
@ -1024,7 +1092,7 @@ user environment elements, etc. -->
<refsection><title>Examples</title>
<screen>
$ nix-env -q '*' <lineannotation>(show installed derivations)</lineannotation>
$ nix-env -q <lineannotation>(show installed derivations)</lineannotation>
bison-1.875c
docbook-xml-4.2
firefox-1.0.4
@ -1032,14 +1100,14 @@ MPlayer-1.0pre7
ORBit2-2.8.3
...
$ nix-env -qa '*' <lineannotation>(show available derivations)</lineannotation>
$ nix-env -qa <lineannotation>(show available derivations)</lineannotation>
firefox-1.0.7
GConf-2.4.0.1
MPlayer-1.0pre7
ORBit2-2.8.3
...
$ nix-env -qas '*' <lineannotation>(show status of available derivations)</lineannotation>
$ nix-env -qas <lineannotation>(show status of available derivations)</lineannotation>
-P- firefox-1.0.7 <lineannotation>(not installed but present)</lineannotation>
--S GConf-2.4.0.1 <lineannotation>(not present, but there is a substitute for fast installation)</lineannotation>
--S MPlayer-1.0pre3 <lineannotation>(i.e., this is not the installed MPlayer, even though the version is the same!)</lineannotation>
@ -1047,24 +1115,29 @@ IP- ORBit2-2.8.3 <lineannotation>(installed and by definition present)</linea
...
<lineannotation>(show available derivations in the Nix expression <!-- !!! <filename>-->foo.nix<!-- </filename> -->)</lineannotation>
$ nix-env -f ./foo.nix -qa '*'
$ nix-env -f ./foo.nix -qa
foo-1.2.3
$ nix-env -qc '*' <lineannotation>(compare installed versions to what’s available)</lineannotation>
$ nix-env -qc <lineannotation>(compare installed versions to what’s available)</lineannotation>
<replaceable>...</replaceable>
acrobat-reader-7.0 - ? <lineannotation>(package is not available at all)</lineannotation>
autoconf-2.59 = 2.59 <lineannotation>(same version)</lineannotation>
firefox-1.0.4 &lt; 1.0.7 <lineannotation>(a more recent version is available)</lineannotation>
<replaceable>...</replaceable>
<lineannotation>(show info about a specific package, in XML)</lineannotation>
$ nix-env -qa --xml --description firefox
<![CDATA[<?xml version='1.0' encoding='utf-8'?>
<items>
<item attrPath="0.0.firefoxWrapper"
description="Mozilla Firefox - the browser, reloaded (with various plugins)"
name="firefox-1.5.0.7" system="i686-linux" />
</items>]]></screen>
$ nix-env -qa '.*zip.*' <lineannotation>(show all packages with “zip” in the name)</lineannotation>
bzip2-1.0.6
gzip-1.6
zip-3.0
<replaceable>...</replaceable>
$ nix-env -qa '.*(firefox|chromium).*' <lineannotation>(show all packages with “firefox” or “chromium” in the name)</lineannotation>
chromium-37.0.2062.94
chromium-beta-38.0.2125.24
firefox-32.0.3
firefox-with-plugins-13.0.1
<replaceable>...</replaceable>
</screen>
</refsection>

10
doc/manual/release-notes/rl-1.8.xml
View file

@ -8,6 +8,16 @@
<itemizedlist>
<listitem><para><command>nix-env</command> selectors are now regular
expressions. For instance, you can do
<screen>
$ nix-env -qa '.*zip.*'
</screen>
to query all packages with a name containing
<literal>zip</literal>.</para></listitem>
<listitem><para>Derivations can specify the new special attribute
<varname>allowedRequisites</varname>, which has a similar meaning to
<varname>allowedReferences</varname>. But instead of only enforcing

6
src/libexpr/names.cc
View file

@ -1,5 +1,6 @@
#include "names.hh"
#include "util.hh"
#include "regex.hh"
namespace nix {
@ -32,7 +33,10 @@ DrvName::DrvName(const string & s) : hits(0)
bool DrvName::matches(DrvName & n)
{
if (name != "*" && name != n.name) return false;
if (name != "*") {
Regex regex(name);
if (!regex.matches(n.name)) return false;
}
if (version != "" && version != n.version) return false;
return true;
}

33
src/libutil/regex.cc Normal file
View file

@ -0,0 +1,33 @@
#include "regex.hh"
#include "types.hh"
namespace nix {
Regex::Regex(const string & pattern)
{
/* Patterns must match the entire string. */
int err = regcomp(&preg, ("^(" + pattern + ")$").c_str(), REG_NOSUB | REG_EXTENDED);
if (err) throw Error(format("compiling pattern ‘%1%’: %2%") % pattern % showError(err));
}
Regex::~Regex()
{
regfree(&preg);
}
bool Regex::matches(const string & s)
{
int err = regexec(&preg, s.c_str(), 0, 0, 0);
if (err == 0) return true;
else if (err == REG_NOMATCH) return false;
throw Error(format("matching string ‘%1%’: %2%") % s % showError(err));
}
string Regex::showError(int err)
{
char buf[256];
regerror(err, &preg, buf, sizeof(buf));
return string(buf);
}
}

22
src/libutil/regex.hh Normal file
View file

@ -0,0 +1,22 @@
#pragma once
#include "types.hh"
#include <sys/types.h>
#include <regex.h>
namespace nix {
class Regex
{
public:
Regex(const string & pattern);
~Regex();
bool matches(const string & s);
private:
regex_t preg;
string showError(int err);
};
}