Implement short patterns (patterns starting with ~)

Also make pattern detector in cacheset and private's list accept
such patterns. We probably should just try to parse and see if it
is a (start of a) pattern.

6 files changed, 145 insertions, 21 deletions

diff --git a/apt-pkg/cachefilter-patterns.cc b/apt-pkg/cachefilter-patterns.cc
index 7abc4536d..11ad5d723 100644
--- a/apt-pkg/cachefilter-patterns.cc
+++ b/apt-pkg/cachefilter-patterns.cc
@@ -17,6 +17,32 @@ namespace APT
 namespace Internal
 {
 
+static const constexpr struct
+{
+   APT::StringView shortName;
+   APT::StringView longName;
+   bool takesArgument;
+} shortPatterns[] = {
+   {"r"_sv, "?architecture"_sv, true},
+   {"A"_sv, "?archive"_sv, true},
+   {"M"_sv, "?automatic"_sv, false},
+   {"b"_sv, "?broken"_sv, false},
+   {"c"_sv, "?config-files"_sv, false},
+   {"E"_sv, "?essential"_sv, false},
+   {"F"_sv, "?false"_sv, false},
+   {"g"_sv, "?garbage"_sv, false},
+   {"i"_sv, "?installed"_sv, false},
+   {"n"_sv, "?name"_sv, true},
+   {"o"_sv, "?obsolete"_sv, false},
+   {"O"_sv, "?origin"_sv, true},
+   {"s"_sv, "?section"_sv, true},
+   {"e"_sv, "?source-package"_sv, true},
+   {"T"_sv, "?true"_sv, false},
+   {"U"_sv, "?upgradable"_sv, false},
+   {"V"_sv, "?version"_sv, true},
+   {"v"_sv, "?virtual"_sv, false},
+};
+
 template <class... Args>
 std::string rstrprintf(Args... args)
 {
@@ -42,6 +68,8 @@ std::unique_ptr<PatternTreeParser::Node> PatternTreeParser::parseTop()
 std::unique_ptr<PatternTreeParser::Node> PatternTreeParser::parse()
 {
    std::unique_ptr<Node> node;
+   if ((node = parseShortPattern()) != nullptr)
+      return node;
    if ((node = parsePattern()) != nullptr)
       return node;
    if ((node = parseQuotedWord()) != nullptr)
@@ -53,6 +81,35 @@ std::unique_ptr<PatternTreeParser::Node> PatternTreeParser::parse()
 	       "Expected pattern, quoted word, or word"};
 }
 
+// Parse a short pattern
+std::unique_ptr<PatternTreeParser::Node> PatternTreeParser::parseShortPattern()
+{
+   if (sentence[state.offset] != '~')
+      return nullptr;
+
+   for (auto &sp : shortPatterns)
+   {
+      if (sentence.substr(state.offset + 1, sp.shortName.size()) != sp.shortName)
+	 continue;
+
+      auto node = std::make_unique<PatternNode>();
+      node->end = node->start = state.offset;
+      node->term = sp.longName;
+
+      state.offset += sp.shortName.size() + 1;
+      if (sp.takesArgument)
+      {
+	 node->arguments.push_back(parse());
+	 node->haveArgumentList = true;
+      }
+      node->end = state.offset;
+
+      return node;
+   }
+
+   throw Error{Node{state.offset, sentence.size()}, "Unknown short pattern"};
+}
+
 // Parse a list pattern (or function call pattern)
 std::unique_ptr<PatternTreeParser::Node> PatternTreeParser::parsePattern()
 {
diff --git a/apt-pkg/cachefilter-patterns.h b/apt-pkg/cachefilter-patterns.h
index 8317665bc..0d6e9d99e 100644
--- a/apt-pkg/cachefilter-patterns.h
+++ b/apt-pkg/cachefilter-patterns.h
@@ -96,6 +96,7 @@ struct PatternTreeParser
    private:
    std::unique_ptr<Node> parse();
    std::unique_ptr<Node> parsePattern();
+   std::unique_ptr<Node> parseShortPattern();
    std::unique_ptr<Node> parseWord();
    std::unique_ptr<Node> parseQuotedWord();
 };
diff --git a/apt-pkg/cacheset.cc b/apt-pkg/cacheset.cc
index f5251eda8..ae1d5ee3e 100644
--- a/apt-pkg/cacheset.cc
+++ b/apt-pkg/cacheset.cc
@@ -295,7 +295,7 @@ bool CacheSetHelper::PackageFromPackageName(PackageContainerInterface * const pc
 
 bool CacheSetHelper::PackageFromPattern(PackageContainerInterface *const pci, pkgCacheFile &Cache, std::string const &pattern)
 {
-   if (pattern.size() < 1 || pattern[0] != '?')
+   if (pattern.size() < 1 || (pattern[0] != '?' && pattern[0] != '~'))
       return false;
 
    auto compiledPattern = APT::CacheFilter::ParsePattern(pattern, &Cache);
diff --git a/apt-private/private-list.cc b/apt-private/private-list.cc
index 6071129a7..f5c31bbcd 100644
--- a/apt-private/private-list.cc
+++ b/apt-private/private-list.cc
@@ -48,8 +48,8 @@ class PackageNameMatcher : public Matcher
       {
          std::string pattern = patterns[i];
          APT::CacheFilter::Matcher *cachefilter = NULL;
-         if (pattern.size() > 0 && pattern[0] == '?')
-            cachefilter = APT::CacheFilter::ParsePattern(pattern, &cacheFile).release();
+	 if (pattern.size() > 0 && (pattern[0] == '?' || pattern[0] == '~'))
+	    cachefilter = APT::CacheFilter::ParsePattern(pattern, &cacheFile).release();
          else if(_config->FindB("APT::Cmd::Use-Regexp", false) == true)
             cachefilter = new APT::CacheFilter::PackageNameMatchesRegEx(pattern);
          else
diff --git a/doc/apt-patterns.7.xml b/doc/apt-patterns.7.xml
index b94a9b226..f18fe6a19 100644
--- a/doc/apt-patterns.7.xml
+++ b/doc/apt-patterns.7.xml
@@ -46,7 +46,7 @@
      <varlistentry><term><code>?and(PATTERN, PATTERN, ...)</code></term>
      <listitem><para>Selects objects where all specified patterns match.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?false</code></term>
+     <varlistentry><term><code>?false</code></term><term><code>~F</code></term>
      <listitem><para>Selects nothing.</para></listitem>
      </varlistentry>
      <varlistentry><term><code>?not(PATTERN)</code></term>
@@ -55,7 +55,7 @@
      <varlistentry><term><code>?or(PATTERN, PATTERN, ...)</code></term>
      <listitem><para>Selects objects where at least one of the specified patterns match.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?true</code></term>
+     <varlistentry><term><code>?true</code></term><term><code>~T</code></term>
      <listitem><para>Selects all objects.</para></listitem>
      </varlistentry>
    </variablelist>
@@ -83,40 +83,40 @@
    These patterns select specific packages.
    </para>
    <variablelist>
-     <varlistentry><term><code>?architecture(WILDCARD)</code></term>
+     <varlistentry><term><code>?architecture(WILDCARD)</code></term><term><code>~rWILDCARD</code></term>
      <listitem><para>Selects packages matching the specified architecture, which may contain wildcards using any.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?automatic</code></term>
+     <varlistentry><term><code>?automatic</code></term><term><code>~M</code></term>
      <listitem><para>Selects packages that were installed automatically.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?broken</code></term>
+     <varlistentry><term><code>?broken</code></term><term><code>~b</code></term>
      <listitem><para>Selects packages that have broken dependencies.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?config-files</code></term>
+     <varlistentry><term><code>?config-files</code></term><term><code>~c</code></term>
      <listitem><para>Selects packages that are not fully installed, but have solely residual configuration files left.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?essential</code></term>
+     <varlistentry><term><code>?essential</code></term><term><code>~E</code></term>
      <listitem><para>Selects packages that have Essential: yes set in their control file.</para></listitem>
      </varlistentry>
      <varlistentry><term><code>?exact-name(NAME)</code></term>
      <listitem><para>Selects packages with the exact specified name.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?garbage</code></term>
+     <varlistentry><term><code>?garbage</code></term><term><code>~g</code></term>
      <listitem><para>Selects packages that can be removed automatically.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?installed</code></term>
+     <varlistentry><term><code>?installed</code></term><term><code>~i</code></term>
      <listitem><para>Selects packages that are currently installed.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?name(REGEX)</code></term>
+     <varlistentry><term><code>?name(REGEX)</code></term><term><code>~nREGEX</code></term>
      <listitem><para>Selects packages where the name matches the given regular expression.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?obsolete</code></term>
+     <varlistentry><term><code>?obsolete</code></term><term><code>~o</code></term>
      <listitem><para>Selects packages that no longer exist in repositories.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?upgradable</code></term>
+     <varlistentry><term><code>?upgradable</code></term><term><code>~U</code></term>
      <listitem><para>Selects packages that can be upgraded (have a newer candidate).</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?virtual</code></term>
+     <varlistentry><term><code>?virtual</code></term><term><code>~v</code></term>
      <listitem><para>Selects all virtual packages; that is packages without a version.
       These exist when they are referenced somewhere in the archive,
       for example because something depends on that name.</para></listitem>
@@ -129,22 +129,22 @@
    These patterns select specific versions of a package.
    </para>
    <variablelist>
-     <varlistentry><term><code>?archive(REGEX)</code></term>
+     <varlistentry><term><code>?archive(REGEX)</code></term><term><code>~AREGEX</code></term>
      <listitem><para>Selects versions that come from the archive that matches the specified regular expression. Archive, here, means the values after <code>a=</code> in <command>apt-cache policy</command>.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?origin(REGEX)</code></term>
+     <varlistentry><term><code>?origin(REGEX)</code></term><term><code>~OREGEX</code></term>
      <listitem><para>Selects versions that come from the origin that matches the specified regular expression. Origin, here, means the values after <code>o=</code> in <command>apt-cache policy</command>.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?section(REGEX)</code></term>
+     <varlistentry><term><code>?section(REGEX)</code></term><term><code>~sREGEX</code></term>
      <listitem><para>Selects versions where the section matches the specified regular expression.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?source-package(REGEX)</code></term>
+     <varlistentry><term><code>?source-package(REGEX)</code></term><term><code>~eREGEX</code></term>
      <listitem><para>Selects versions where the source package name matches the specified regular expression.</para></listitem>
      </varlistentry>
      <varlistentry><term><code>?source-version(REGEX)</code></term>
      <listitem><para>Selects versions where the source package version matches the specified regular expression.</para></listitem>
      </varlistentry>
-     <varlistentry><term><code>?version(REGEX)</code></term>
+     <varlistentry><term><code>?version(REGEX)</code></term><term><code>~VREGEX</code></term>
      <listitem><para>Selects versions where the version string matching the specified regular expression.</para></listitem>
      </varlistentry>
    </variablelist>
diff --git a/test/libapt/pattern_test.cc b/test/libapt/pattern_test.cc
index de2fbceb9..492a29eac 100644
--- a/test/libapt/pattern_test.cc
+++ b/test/libapt/pattern_test.cc
@@ -93,3 +93,69 @@ TEST(TreeParserTest, ParseWithManyArgsWithSpacesWithTrailingComma)
    EXPECT_EQ(patternNode->term, "?hello");
    EXPECT_EQ(2u, patternNode->arguments.size());
 }
+
+// Helper
+static bool samePattern(const std::unique_ptr<PatternTreeParser::Node> &a, const std::unique_ptr<PatternTreeParser::Node> &b)
+{
+   auto pa = dynamic_cast<const PatternTreeParser::PatternNode *>(a.get());
+   auto pb = dynamic_cast<const PatternTreeParser::PatternNode *>(b.get());
+
+   if (pa && pb)
+   {
+      if (pa->term != pb->term || pa->haveArgumentList != pb->haveArgumentList || pa->arguments.size() != pb->arguments.size())
+	 return false;
+
+      for (size_t i = 0; i < pa->arguments.size(); i++)
+      {
+	 if (!samePattern(pa->arguments[i], pb->arguments[i]))
+	    return false;
+      }
+      return true;
+   }
+
+   auto wa = dynamic_cast<const PatternTreeParser::WordNode *>(a.get());
+   auto wb = dynamic_cast<const PatternTreeParser::WordNode *>(b.get());
+   if (wa && wb)
+      return wa->word == wb->word && wa->quoted == wb->quoted;
+
+   return false;
+}
+
+#define EXPECT_PATTERN_EQ(shrt, lng) \
+   EXPECT_TRUE(samePattern(PatternTreeParser(shrt).parseTop(), PatternTreeParser(lng).parseTop()))
+#define EXPECT_PATTERN_EQ_ATOMIC(shrt, lng)                           \
+   EXPECT_TRUE(PatternTreeParser(shrt).parseTop());                   \
+   caught = false;                                                    \
+   try                                                                \
+   {                                                                  \
+      PatternTreeParser(shrt "XXX").parseTop();                       \
+   }                                                                  \
+   catch (PatternTreeParser::Error & e)                               \
+   {                                                                  \
+      caught = true;                                                  \
+   };                                                                 \
+   EXPECT_TRUE(caught) << shrt "XXX should have thrown an exception"; \
+   EXPECT_PATTERN_EQ(shrt, lng)
+
+TEST(TreeParserTest, ParseShortPattern)
+{
+   bool caught;
+   EXPECT_PATTERN_EQ("~ramd64", "?architecture(amd64)");
+   EXPECT_PATTERN_EQ("~AanArchive", "?archive(anArchive)");
+   EXPECT_PATTERN_EQ_ATOMIC("~M", "?automatic");
+   EXPECT_PATTERN_EQ_ATOMIC("~b", "?broken");
+   EXPECT_PATTERN_EQ_ATOMIC("~c", "?config-files");
+   EXPECT_PATTERN_EQ_ATOMIC("~E", "?essential");
+   EXPECT_PATTERN_EQ_ATOMIC("~F", "?false");
+   EXPECT_PATTERN_EQ_ATOMIC("~g", "?garbage");
+   EXPECT_PATTERN_EQ_ATOMIC("~i", "?installed");
+   EXPECT_PATTERN_EQ("~napt", "?name(apt)");
+   EXPECT_PATTERN_EQ_ATOMIC("~o", "?obsolete");
+   EXPECT_PATTERN_EQ("~Obar", "?origin(bar)");
+   EXPECT_PATTERN_EQ("~sfoo", "?section(foo)");
+   EXPECT_PATTERN_EQ("~esourcename", "?source-package(sourcename)");
+   EXPECT_PATTERN_EQ_ATOMIC("~T", "?true");
+   EXPECT_PATTERN_EQ_ATOMIC("~U", "?upgradable");
+   EXPECT_PATTERN_EQ("~Vverstr", "?version(verstr)");
+   EXPECT_PATTERN_EQ_ATOMIC("~v", "?virtual");
+}