razor: librazor/razor.h@a87a4f1e5db7

     1 /*

     2  * Copyright (C) 2008  Kristian Høgsberg <krh@redhat.com>

     3  * Copyright (C) 2008  Red Hat, Inc

     4  *

     5  * This program is free software; you can redistribute it and/or modify

     6  * it under the terms of the GNU General Public License as published by

     7  * the Free Software Foundation; either version 2 of the License, or

     8  * (at your option) any later version.

     9  *

    10  * This program is distributed in the hope that it will be useful,

    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of

    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    13  * GNU General Public License for more details.

    14  *

    15  * You should have received a copy of the GNU General Public License along

    16  * with this program; if not, write to the Free Software Foundation, Inc.,

    17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

    18  */

    20 #ifndef _RAZOR_H_

    21 #define _RAZOR_H_

    23 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))

    25 struct razor_set;

    26 struct razor_package;

    27 struct razor_property;

    29 enum razor_repo_file_type {

    30 	RAZOR_REPO_FILE_MAIN,

    31 	RAZOR_REPO_FILE_DETAILS,

    32 	RAZOR_REPO_FILE_FILES

    33 };

    35 enum razor_property_flags {

    36 	RAZOR_PROPERTY_LESS		= 1 << 0,

    37 	RAZOR_PROPERTY_GREATER		= 1 << 1,

    38 	RAZOR_PROPERTY_EQUAL		= 1 << 2,

    39 	RAZOR_PROPERTY_RELATION_MASK	=

    40 		RAZOR_PROPERTY_LESS |

    41 		RAZOR_PROPERTY_GREATER |

    42 		RAZOR_PROPERTY_EQUAL,

    44 	RAZOR_PROPERTY_REQUIRES		= 0 << 3,

    45 	RAZOR_PROPERTY_PROVIDES		= 1 << 3,

    46 	RAZOR_PROPERTY_CONFLICTS	= 2 << 3,

    47 	RAZOR_PROPERTY_OBSOLETES	= 3 << 3,

    48 	RAZOR_PROPERTY_TYPE_MASK	= 3 << 3,

    50 	RAZOR_PROPERTY_PRE		= 1 << 5,

    51 	RAZOR_PROPERTY_POST		= 1 << 6,

    52 	RAZOR_PROPERTY_PREUN		= 1 << 7,

    53 	RAZOR_PROPERTY_POSTUN		= 1 << 8

    54 };

    56 const char *

    57 razor_property_relation_to_string(struct razor_property *p);

    58 const char *

    59 razor_property_type_to_string(struct razor_property *p);

    61 struct razor_set *razor_set_create(void);

    62 struct razor_set *razor_set_open(const char *filename);

    63 void razor_set_destroy(struct razor_set *set);

    64 int razor_set_write_to_fd(struct razor_set *set, int fd,

    65 			  enum razor_repo_file_type type);

    66 int razor_set_write(struct razor_set *set, const char *filename,

    67 		    enum razor_repo_file_type type);

    69 void razor_set_open_details(struct razor_set *set, const char *filename);

    70 void razor_set_open_files(struct razor_set *set, const char *filename);

    72 struct razor_package *

    73 razor_set_get_package(struct razor_set *set, const char *package);

    75 void

    76 razor_package_get_details(struct razor_set *set, struct razor_package *package,

    77 			  const char **summary, const char **description,

    78 			  const char **url, const char **license);

    80 struct razor_package_iterator;

    81 struct razor_package_iterator *

    82 razor_package_iterator_create(struct razor_set *set);

    83 struct razor_package_iterator *

    84 razor_package_iterator_create_for_property(struct razor_set *set,

    85 					   struct razor_property *property);

    86 struct razor_package_iterator *

    87 razor_package_iterator_create_for_file(struct razor_set *set,

    88 				       const char *filename);

    90 int razor_package_iterator_next(struct razor_package_iterator *pi,

    91 				struct razor_package **package,

    92 				const char **name,

    93 				const char **version,

    94 				const char **arch);

    95 void razor_package_iterator_destroy(struct razor_package_iterator *pi);

    97 struct razor_package_query *

    98 razor_package_query_create(struct razor_set *set);

    99 void

   100 razor_package_query_add_package(struct razor_package_query *pq,

   101 				struct razor_package *p);

   102 void

   103 razor_package_query_add_iterator(struct razor_package_query *pq,

   104 				 struct razor_package_iterator *pi);

   105 struct razor_package_iterator *

   106 razor_package_query_finish(struct razor_package_query *pq);

   108 struct razor_property_iterator;

   109 struct razor_property_iterator *

   110 razor_property_iterator_create(struct razor_set *set,

   111 			       struct razor_package *package);

   112 int razor_property_iterator_next(struct razor_property_iterator *pi,

   113 				 struct razor_property **property,

   114 				 const char **name,

   115 				 uint32_t *flags,

   116 				 const char **version);

   117 void

   118 razor_property_iterator_destroy(struct razor_property_iterator *pi);

   120 void razor_set_list_files(struct razor_set *set, const char *prefix);

   121 void razor_set_list_package_files(struct razor_set *set, const char *name);

   123 void razor_set_list_unsatisfied(struct razor_set *set);

   125 enum razor_diff_action {

   126 	RAZOR_DIFF_ACTION_ADD,

   127 	RAZOR_DIFF_ACTION_REMOVE,

   128 };

   130 typedef void (*razor_diff_callback_t)(enum razor_diff_action action,

   131 				      struct razor_package *package,

   132 				      const char *name,

   133 				      const char *version,

   134 				      const char *arch,

   135 				      void *data);

   137 void

   138 razor_set_diff(struct razor_set *set, struct razor_set *upstream,

   139 	       razor_diff_callback_t callback, void *data);

   140 struct razor_package_iterator *

   141 razor_set_create_remove_iterator(struct razor_set *set,

   142 				 struct razor_set *next);

   143 struct razor_package_iterator *

   144 razor_set_create_install_iterator(struct razor_set *set,

   145 				  struct razor_set *next);

   147 /* Package transactions */

   149 struct razor_transaction *

   150 razor_transaction_create(struct razor_set *system, struct razor_set *upstream);

   151 void razor_transaction_install_package(struct razor_transaction *transaction,

   152 				       struct razor_package *package);

   153 void razor_transaction_remove_package(struct razor_transaction *transaction,

   154 				      struct razor_package *package);

   155 void razor_transaction_update_package(struct razor_transaction *trans,

   156 				      struct razor_package *package);

   157 void razor_transaction_update_all(struct razor_transaction *transaction);

   158 int razor_transaction_resolve(struct razor_transaction *trans);

   159 int razor_transaction_describe(struct razor_transaction *trans);

   160 struct razor_set *razor_transaction_finish(struct razor_transaction *trans);

   161 void razor_transaction_destroy(struct razor_transaction *trans);

   163 /* Temporary helper for test suite. */

   164 int razor_transaction_unsatisfied_property(struct razor_transaction *trans,

   165 					   const char *name,

   166 					   uint32_t flags,

   167 					   const char *version);

   169 /* Importer interface; for building a razor set from external sources,

   170  * like yum, rpmdb or razor package files. */

   172 struct razor_importer;

   173 struct razor_rpm;

   175 struct razor_importer *razor_importer_create(void);

   176 void razor_importer_destroy(struct razor_importer *importer);

   177 void razor_importer_begin_package(struct razor_importer *importer,

   178 				  const char *name,

   179 				  const char *version,

   180 				  const char *arch);

   181 void razor_importer_add_details(struct razor_importer *importer,

   182 				const char *summary,

   183 				const char *description,

   184 				const char *url,

   185 				const char *license);

   186 void razor_importer_add_property(struct razor_importer *importer,

   187 				 const char *name,

   188 				 uint32_t flags,

   189 				 const char *version);

   190 void razor_importer_add_file(struct razor_importer *importer,

   191 			     const char *name);

   192 void razor_importer_finish_package(struct razor_importer *importer);

   194 int razor_importer_add_rpm(struct razor_importer *importer,

   195 			   struct razor_rpm *rpm);

   197 struct razor_set *razor_importer_finish(struct razor_importer *importer);

   199 void razor_build_evr(char *evr_buf, int size, const char *epoch,

   200 		     const char *version, const char *release);

   201 int razor_versioncmp(const char *s1, const char *s2);

   203 struct razor_set *razor_set_create_from_yum(void);

   204 struct razor_set *razor_set_create_from_rpmdb(void);

   206 /* RPM functions */

   208 struct razor_rpm *razor_rpm_open(const char *filename);

   209 int razor_rpm_install(struct razor_rpm *rpm, const char *root);

   210 int razor_rpm_close(struct razor_rpm *rpm);

   213 /* Razor root functions. The root data structure encapsulates

   214  * filesystem conventions and the locking protocol. */

   216 struct razor_root;

   218 int razor_root_create(const char *root);

   219 struct razor_root *razor_root_open(const char *root);

   220 struct razor_set *razor_root_open_read_only(const char *root);

   221 struct razor_set *razor_root_get_system_set(struct razor_root *root);

   222 int razor_root_close(struct razor_root *root);

   223 void razor_root_update(struct razor_root *root, struct razor_set *next);

   224 int razor_root_commit(struct razor_root *root);

   226 #endif /* _RAZOR_H_ */

author	Richard Hughes <richard@hughsie.com>
	Mon Jun 23 10:31:04 2008 -0400 (2008-06-23)
changeset 261	a87a4f1e5db7
parent 254	ccb1c11968ab
parent 258	29d5002bd17f
child 262	63644cc28e0b
permissions	-rw-r--r--