razor.h
author Dan Winship <danw@gnome.org>
Fri Mar 07 15:38:31 2008 -0500 (2008-03-07)
changeset 157 57e8182f59bc
parent 147 c3eab84160e5
child 169 2d0ad2111cb0
permissions -rw-r--r--
depsolving plan
     1 #ifndef _RAZOR_H_
     2 #define _RAZOR_H_
     3 
     4 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
     5 
     6 struct razor_set;
     7 struct razor_package;
     8 struct razor_property;
     9 
    10 enum razor_property_type {
    11 	RAZOR_PROPERTY_REQUIRES,
    12 	RAZOR_PROPERTY_PROVIDES,
    13 	RAZOR_PROPERTY_CONFLICTS,
    14 	RAZOR_PROPERTY_OBSOLETES
    15 };
    16 
    17 enum razor_version_relation {
    18 	RAZOR_VERSION_LESS,
    19 	RAZOR_VERSION_LESS_OR_EQUAL,
    20 	RAZOR_VERSION_EQUAL,
    21 	RAZOR_VERSION_GREATER_OR_EQUAL,
    22 	RAZOR_VERSION_GREATER
    23 };
    24 extern const char * const razor_version_relations[];
    25 
    26 struct razor_set *razor_set_create(void);
    27 struct razor_set *razor_set_open(const char *filename);
    28 void razor_set_destroy(struct razor_set *set);
    29 int razor_set_write(struct razor_set *set, const char *filename);
    30 
    31 struct razor_package *
    32 razor_set_get_package(struct razor_set *set, const char *package);
    33 
    34 struct razor_package_iterator;
    35 struct razor_package_iterator *
    36 razor_package_iterator_create(struct razor_set *set);
    37 struct razor_package_iterator *
    38 razor_package_iterator_create_for_property(struct razor_set *set,
    39 					   struct razor_property *property);
    40 struct razor_package_iterator *
    41 razor_package_iterator_create_for_file(struct razor_set *set,
    42 				       const char *filename);
    43 
    44 int razor_package_iterator_next(struct razor_package_iterator *pi,
    45 				struct razor_package **package,
    46 				const char **name, const char **version);
    47 void razor_package_iterator_destroy(struct razor_package_iterator *pi);
    48 
    49 struct razor_property_iterator;
    50 struct razor_property_iterator *
    51 razor_property_iterator_create(struct razor_set *set,
    52 			       struct razor_package *package);
    53 int razor_property_iterator_next(struct razor_property_iterator *pi,
    54 				 struct razor_property **property,
    55 				 const char **name,
    56 				 enum razor_version_relation *relation,
    57 				 const char **version,
    58 				 enum razor_property_type *type);
    59 void
    60 razor_property_iterator_destroy(struct razor_property_iterator *pi);
    61 
    62 void razor_set_list_files(struct razor_set *set, const char *prefix);
    63 void razor_set_list_package_files(struct razor_set *set, const char *name);
    64 
    65 void razor_set_list_unsatisfied(struct razor_set *set);
    66 
    67 typedef void (*razor_package_callback_t)(const char *name,
    68 					 const char *old_version,
    69 					 const char *new_version,
    70 					 void *data);
    71 void
    72 razor_set_diff(struct razor_set *set, struct razor_set *upstream,
    73 	       razor_package_callback_t callback, void *data);
    74 
    75 /* Package transactions */
    76 
    77 enum razor_transaction_package_state {
    78 	/* Basic states */
    79 	RAZOR_PACKAGE_INSTALL,
    80 	RAZOR_PACKAGE_FORCED_UPDATE,
    81 	RAZOR_PACKAGE_REMOVE,
    82 	RAZOR_PACKAGE_OBSOLETED,
    83 
    84 	/* Error states */
    85 
    86 	/* Package requested for install does not exist */
    87 	RAZOR_PACKAGE_INSTALL_UNAVAILABLE,
    88 	/* Package requested for removal does not exist */
    89 	RAZOR_PACKAGE_REMOVE_NOT_INSTALLED,
    90 	/* No newer version of package is available */
    91 	RAZOR_PACKAGE_UP_TO_DATE,
    92 	/* Package marked for both install and remove */
    93 	RAZOR_PACKAGE_CONTRADICTION,
    94 	/* Package would add a conflict with an already-installed package */
    95 	RAZOR_PACKAGE_NEW_CONFLICT,
    96 	/* Already-installed package has a conflict against this package */
    97 	RAZOR_PACKAGE_OLD_CONFLICT,
    98 	/* Requirement of to-be-installed package can't be satisfied */
    99 	RAZOR_PACKAGE_UNSATISFIABLE,
   100 };
   101 
   102 struct razor_transaction_package {
   103 	const char *name, *old_version, *new_version;
   104 	struct razor_package *old_package, *new_package;
   105 	enum razor_transaction_package_state state;
   106 
   107 	/* dep_package is the name of the package that resulted in
   108 	 * this entry being created (or NULL if the user requested the
   109 	 * install/remove), with the other dep_ fields providing
   110 	 * additional information.
   111 	 *
   112 	 * For INSTALL, if dep_type is REQUIRES, then dep_package
   113 	 * required something that this package provides. If dep_type
   114 	 * is CONFLICTS, then dep_package is a package that conflicted
   115 	 * with an older version of this package, forcing an upgrade.
   116 	 *
   117 	 * For REMOVE, if dep_type is REQUIRES, then dep_package is a
   118 	 * package that is being removed. If dep_type is OBSOLETES,
   119 	 * then dep_package is a package that obsoletes this one.
   120 	 *
   121 	 * For OLD_CONFLICT or NEW_CONFLICT, dep_package is an
   122 	 * existing package that conflicts with this one. The
   123 	 * conflicting property comes from the already-installed
   124 	 * package for OLD_CONFLICT, or the to-be-installed package
   125 	 * for NEW_CONFLICT.
   126 	 *
   127 	 * For UNSATISFIABLE, the dep_ fields are as for an INSTALL,
   128 	 * but the name field will be NULL.
   129 	 */
   130 	const char *dep_package;
   131 	enum razor_property_type dep_type;
   132 	const char *dep_property;
   133 	enum razor_version_relation dep_relation;
   134 	const char *dep_version;
   135 };
   136 
   137 struct razor_transaction {
   138 	int package_count, errors;
   139 	struct razor_transaction_package *packages;
   140 
   141 	struct razor_set *system, *upstream;
   142 };
   143 
   144 struct razor_transaction *
   145 razor_transaction_create(struct razor_set *system, struct razor_set *upstream,
   146 			 int update_count, const char **update_packages,
   147 			 int remove_count, const char **remove_packages);
   148 void razor_transaction_describe(struct razor_transaction *trans);
   149 struct razor_set *razor_transaction_run(struct razor_transaction *trans);
   150 void razor_transaction_destroy(struct razor_transaction *trans);
   151 
   152 /* Importer interface; for building a razor set from external sources,
   153  * like yum, rpmdb or razor package files. */
   154 
   155 struct razor_importer;
   156 struct razor_rpm;
   157 
   158 struct razor_importer *razor_importer_new(void);
   159 void razor_importer_destroy(struct razor_importer *importer);
   160 void razor_importer_begin_package(struct razor_importer *importer,
   161 				  const char *name, const char *version);
   162 void razor_importer_add_property(struct razor_importer *importer,
   163 				 const char *name,
   164 				 enum razor_version_relation relation,
   165 				 const char *version,
   166 				 enum razor_property_type type);
   167 void razor_importer_add_file(struct razor_importer *importer,
   168 			     const char *name);
   169 void razor_importer_finish_package(struct razor_importer *importer);
   170 
   171 int razor_importer_add_rpm(struct razor_importer *importer,
   172 			   struct razor_rpm *rpm);
   173 
   174 struct razor_set *razor_importer_finish(struct razor_importer *importer);
   175 
   176 void razor_build_evr(char *evr_buf, int size, const char *epoch,
   177 		     const char *version, const char *release);
   178 
   179 struct razor_set *razor_set_create_from_yum(void);
   180 struct razor_set *razor_set_create_from_rpmdb(void);
   181 
   182 /* RPM functions */
   183 
   184 struct razor_rpm *razor_rpm_open(const char *filename);
   185 int razor_rpm_install(struct razor_rpm *rpm, const char *root);
   186 int razor_rpm_close(struct razor_rpm *rpm);
   187 
   188 #endif /* _RAZOR_H_ */