lib/dpkg/pkg-format.h

   1 /*
   2  * libdpkg - Debian packaging suite library routines
   3  * pkg-format.g - customizable package formatting
   4  *
   5  * Copyright © 2001 Wichert Akkerman <wakkerma@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_FORMAT_H
  22 #define LIBDPKG_PKG_FORMAT_H
  23
  24 #include <stdbool.h>
  25
  26 #include <dpkg/macros.h>
  27 #include <dpkg/error.h>
  28 #include <dpkg/dpkg-db.h>
  29
  30 DPKG_BEGIN_DECLS
  31
  32 /**
  33  * @defgroup pkg-format Package information formatting
  34  * @ingroup dpkg-public
  35  * @{
  36  */
  37
  38 struct pkg_format_node;
  39
  40 bool
  41 pkg_format_needs_db_fsys(const struct pkg_format_node *head);
  42
  43 struct pkg_format_node *pkg_format_parse(const char *fmt,
  44                                          struct dpkg_error *err);
  45 void pkg_format_free(struct pkg_format_node *head);
  46 void pkg_format_print(struct varbuf *vb, const struct pkg_format_node *head,
  47                       struct pkginfo *pkg, struct pkgbin *pkgbin);
  48 void pkg_format_show(const struct pkg_format_node *head,
  49                      struct pkginfo *pkg, struct pkgbin *pkgbin);
  50
  51 /** @} */
  52
  53 DPKG_END_DECLS
  54
  55 #endif /* LIBDPKG_PKG_FORMAT_H */