razor.h
author Kristian H?gsberg <krh@redhat.com>
Wed Jun 04 20:16:50 2008 -0400 (2008-06-04)
changeset 219 1c2997b34929
parent 212 e8f493d8ff9a
child 224 5803b6151d02
child 230 c1e2aed8dd07
permissions -rw-r--r--
Support bundling of single letter options.
     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  */
    19 
    20 #ifndef _RAZOR_H_
    21 #define _RAZOR_H_
    22 
    23 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
    24 
    25 struct razor_set;
    26 struct razor_package;
    27 struct razor_property;
    28 
    29 enum razor_property_type {
    30 	RAZOR_PROPERTY_REQUIRES,
    31 	RAZOR_PROPERTY_PROVIDES,
    32 	RAZOR_PROPERTY_CONFLICTS,
    33 	RAZOR_PROPERTY_OBSOLETES
    34 };
    35 
    36 enum razor_version_relation {
    37 	RAZOR_VERSION_LESS,
    38 	RAZOR_VERSION_LESS_OR_EQUAL,
    39 	RAZOR_VERSION_EQUAL,
    40 	RAZOR_VERSION_GREATER_OR_EQUAL,
    41 	RAZOR_VERSION_GREATER
    42 };
    43 extern const char * const razor_version_relations[];
    44 
    45 struct razor_set *razor_set_create(void);
    46 struct razor_set *razor_set_open(const char *filename);
    47 void razor_set_destroy(struct razor_set *set);
    48 int razor_set_write_to_fd(struct razor_set *set, int fd);
    49 int razor_set_write(struct razor_set *set, const char *filename);
    50 
    51 struct razor_package *
    52 razor_set_get_package(struct razor_set *set, const char *package);
    53 
    54 struct razor_package_iterator;
    55 struct razor_package_iterator *
    56 razor_package_iterator_create(struct razor_set *set);
    57 struct razor_package_iterator *
    58 razor_package_iterator_create_for_property(struct razor_set *set,
    59 					   struct razor_property *property);
    60 struct razor_package_iterator *
    61 razor_package_iterator_create_for_file(struct razor_set *set,
    62 				       const char *filename);
    63 
    64 int razor_package_iterator_next(struct razor_package_iterator *pi,
    65 				struct razor_package **package,
    66 				const char **name,
    67 				const char **version,
    68 				const char **arch);
    69 void razor_package_iterator_destroy(struct razor_package_iterator *pi);
    70 
    71 struct razor_package_query *
    72 razor_package_query_create(struct razor_set *set);
    73 void
    74 razor_package_query_add_package(struct razor_package_query *pq,
    75 				struct razor_package *p);
    76 void
    77 razor_package_query_add_iterator(struct razor_package_query *pq,
    78 				 struct razor_package_iterator *pi);
    79 struct razor_package_iterator *
    80 razor_package_query_finish(struct razor_package_query *pq);
    81 
    82 struct razor_property_iterator;
    83 struct razor_property_iterator *
    84 razor_property_iterator_create(struct razor_set *set,
    85 			       struct razor_package *package);
    86 int razor_property_iterator_next(struct razor_property_iterator *pi,
    87 				 struct razor_property **property,
    88 				 const char **name,
    89 				 enum razor_version_relation *relation,
    90 				 const char **version,
    91 				 enum razor_property_type *type);
    92 void
    93 razor_property_iterator_destroy(struct razor_property_iterator *pi);
    94 
    95 void razor_set_list_files(struct razor_set *set, const char *prefix);
    96 void razor_set_list_package_files(struct razor_set *set, const char *name);
    97 
    98 void razor_set_list_unsatisfied(struct razor_set *set);
    99 
   100 typedef void (*razor_package_callback_t)(const char *name,
   101 					 const char *old_version,
   102 					 const char *new_version,
   103 					 const char *arch,
   104 					 void *data);
   105 void
   106 razor_set_diff(struct razor_set *set, struct razor_set *upstream,
   107 	       razor_package_callback_t callback, void *data);
   108 
   109 /* Package transactions */
   110 
   111 enum razor_transaction_package_state {
   112 	/* Basic states */
   113 	RAZOR_PACKAGE_INSTALL,
   114 	RAZOR_PACKAGE_FORCED_UPDATE,
   115 	RAZOR_PACKAGE_REMOVE,
   116 	RAZOR_PACKAGE_OBSOLETED,
   117 
   118 	/* Error states */
   119 
   120 	RAZOR_PACKAGE_FIRST_ERROR_STATE = 0x4,
   121 	RAZOR_PACKAGE_UNAVAILABLE_FLAG = 0x4,
   122 
   123 	/* Package requested for install does not exist */
   124 	RAZOR_PACKAGE_INSTALL_UNAVAILABLE = RAZOR_PACKAGE_INSTALL | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
   125 	/* Package requiring update does not have any update */
   126 	RAZOR_PACKAGE_UPDATE_UNAVAILABLE = RAZOR_PACKAGE_FORCED_UPDATE | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
   127 	/* Package requested for removal does not exist */
   128 	RAZOR_PACKAGE_REMOVE_NOT_INSTALLED = RAZOR_PACKAGE_REMOVE | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
   129 	/* (not used) */
   130 	RAZOR_PACKAGE_OBSOLETE_UNAVAILABLE = RAZOR_PACKAGE_OBSOLETED | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
   131 
   132 	/* No newer version of package is available */
   133 	RAZOR_PACKAGE_UP_TO_DATE,
   134 	/* Package marked for both install and remove */
   135 	RAZOR_PACKAGE_CONTRADICTION,
   136 	/* Package would add a conflict with an already-installed package */
   137 	RAZOR_PACKAGE_NEW_CONFLICT,
   138 	/* Already-installed package has a conflict against this package */
   139 	RAZOR_PACKAGE_OLD_CONFLICT,
   140 	/* Requirement of to-be-installed package can't be satisfied */
   141 	RAZOR_PACKAGE_UNSATISFIABLE,
   142 };
   143 
   144 struct razor_transaction *
   145 razor_transaction_create(struct razor_set *system, struct razor_set *upstream);
   146 void razor_transaction_install_package(struct razor_transaction *transaction,
   147 				       struct razor_package *package);
   148 void razor_transaction_remove_package(struct razor_transaction *transaction,
   149 				      struct razor_package *package);
   150 void razor_transaction_update_all(struct razor_transaction *transaction);
   151 int razor_transaction_resolve(struct razor_transaction *trans);
   152 struct razor_set *razor_transaction_finish(struct razor_transaction *trans);
   153 void razor_transaction_destroy(struct razor_transaction *trans);
   154 
   155 /* Temporary helper for test suite. */
   156 int razor_transaction_unsatisfied_property(struct razor_transaction *trans,
   157 					   const char *name,
   158 					   enum razor_version_relation rel,
   159 					   const char *version);
   160 
   161 /* Importer interface; for building a razor set from external sources,
   162  * like yum, rpmdb or razor package files. */
   163 
   164 struct razor_importer;
   165 struct razor_rpm;
   166 
   167 struct razor_importer *razor_importer_new(void);
   168 void razor_importer_destroy(struct razor_importer *importer);
   169 void razor_importer_begin_package(struct razor_importer *importer,
   170 				  const char *name,
   171 				  const char *version,
   172 				  const char *arch);
   173 void razor_importer_add_property(struct razor_importer *importer,
   174 				 const char *name,
   175 				 enum razor_version_relation relation,
   176 				 const char *version,
   177 				 enum razor_property_type type);
   178 void razor_importer_add_file(struct razor_importer *importer,
   179 			     const char *name);
   180 void razor_importer_finish_package(struct razor_importer *importer);
   181 
   182 int razor_importer_add_rpm(struct razor_importer *importer,
   183 			   struct razor_rpm *rpm);
   184 
   185 struct razor_set *razor_importer_finish(struct razor_importer *importer);
   186 
   187 void razor_build_evr(char *evr_buf, int size, const char *epoch,
   188 		     const char *version, const char *release);
   189 
   190 struct razor_set *razor_set_create_from_yum(void);
   191 struct razor_set *razor_set_create_from_rpmdb(void);
   192 
   193 /* RPM functions */
   194 
   195 struct razor_rpm *razor_rpm_open(const char *filename);
   196 int razor_rpm_install(struct razor_rpm *rpm, const char *root);
   197 int razor_rpm_close(struct razor_rpm *rpm);
   198 
   199 #endif /* _RAZOR_H_ */