lib/dpkg/pkg-array.h

   1 /*
   2  * libdpkg - Debian packaging suite library routines
   3  * pkg-array.h - primitives for pkg array handling
   4  *
   5  * Copyright © 2009-2015 Guillem Jover <guillem@debian.org>
   6  *
   7  * This is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef LIBDPKG_PKG_ARRAY_H
  22 #define LIBDPKG_PKG_ARRAY_H
  23
  24 #include <dpkg/dpkg-db.h>
  25 #include <dpkg/pkg.h>
  26
  27 DPKG_BEGIN_DECLS
  28
  29 /**
  30  * @defgroup pkg-array Package array primitives
  31  * @ingroup dpkg-public
  32  * @{
  33  */
  34
  35 /**
  36  * Holds an array of pointers to package data.
  37  */
  38 struct pkg_array {
  39         int n_pkgs;
  40         struct pkginfo **pkgs;
  41 };
  42
  43 typedef struct pkginfo *pkg_mapper_func(const char *name);
  44 typedef void pkg_array_visitor_func(struct pkg_array *a, struct pkginfo *pkg,
  45                                     void *pkg_data);
  46
  47 void pkg_array_init_from_hash(struct pkg_array *a);
  48 void pkg_array_init_from_names(struct pkg_array *a, pkg_mapper_func *pkg_mapper,
  49                                const char **pkg_names);
  50 void pkg_array_foreach(struct pkg_array *a, pkg_array_visitor_func *pkg_visitor,
  51                        void *pkg_data);
  52 void pkg_array_sort(struct pkg_array *a, pkg_sorter_func *pkg_sort);
  53 void pkg_array_destroy(struct pkg_array *a);
  54
  55 /** @} */
  56
  57 DPKG_END_DECLS
  58
  59 #endif /* LIBDPKG_PKG_ARRAY_H */