librazor/razor.h
changeset 241 c3eb520e2219
child 247 63444a10fb8e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/librazor/razor.h	Mon Jun 16 15:40:30 2008 -0400
     1.3 @@ -0,0 +1,189 @@
     1.4 +/*
     1.5 + * Copyright (C) 2008  Kristian Høgsberg <krh@redhat.com>
     1.6 + * Copyright (C) 2008  Red Hat, Inc
     1.7 + *
     1.8 + * This program is free software; you can redistribute it and/or modify
     1.9 + * it under the terms of the GNU General Public License as published by
    1.10 + * the Free Software Foundation; either version 2 of the License, or
    1.11 + * (at your option) any later version.
    1.12 + *
    1.13 + * This program is distributed in the hope that it will be useful,
    1.14 + * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.15 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.16 + * GNU General Public License for more details.
    1.17 + *
    1.18 + * You should have received a copy of the GNU General Public License along
    1.19 + * with this program; if not, write to the Free Software Foundation, Inc.,
    1.20 + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
    1.21 + */
    1.22 +
    1.23 +#ifndef _RAZOR_H_
    1.24 +#define _RAZOR_H_
    1.25 +
    1.26 +#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
    1.27 +
    1.28 +struct razor_set;
    1.29 +struct razor_package;
    1.30 +struct razor_property;
    1.31 +
    1.32 +enum razor_property_type {
    1.33 +	RAZOR_PROPERTY_REQUIRES,
    1.34 +	RAZOR_PROPERTY_PROVIDES,
    1.35 +	RAZOR_PROPERTY_CONFLICTS,
    1.36 +	RAZOR_PROPERTY_OBSOLETES
    1.37 +};
    1.38 +
    1.39 +enum razor_version_relation {
    1.40 +	RAZOR_VERSION_LESS,
    1.41 +	RAZOR_VERSION_LESS_OR_EQUAL,
    1.42 +	RAZOR_VERSION_EQUAL,
    1.43 +	RAZOR_VERSION_GREATER_OR_EQUAL,
    1.44 +	RAZOR_VERSION_GREATER
    1.45 +};
    1.46 +extern const char * const razor_version_relations[];
    1.47 +
    1.48 +struct razor_set *razor_set_create(void);
    1.49 +struct razor_set *razor_set_open(const char *filename);
    1.50 +void razor_set_destroy(struct razor_set *set);
    1.51 +int razor_set_write_to_fd(struct razor_set *set, int fd);
    1.52 +int razor_set_write(struct razor_set *set, const char *filename);
    1.53 +
    1.54 +struct razor_package *
    1.55 +razor_set_get_package(struct razor_set *set, const char *package);
    1.56 +
    1.57 +struct razor_package_iterator;
    1.58 +struct razor_package_iterator *
    1.59 +razor_package_iterator_create(struct razor_set *set);
    1.60 +struct razor_package_iterator *
    1.61 +razor_package_iterator_create_for_property(struct razor_set *set,
    1.62 +					   struct razor_property *property);
    1.63 +struct razor_package_iterator *
    1.64 +razor_package_iterator_create_for_file(struct razor_set *set,
    1.65 +				       const char *filename);
    1.66 +
    1.67 +int razor_package_iterator_next(struct razor_package_iterator *pi,
    1.68 +				struct razor_package **package,
    1.69 +				const char **name,
    1.70 +				const char **version,
    1.71 +				const char **arch);
    1.72 +void razor_package_iterator_destroy(struct razor_package_iterator *pi);
    1.73 +
    1.74 +struct razor_package_query *
    1.75 +razor_package_query_create(struct razor_set *set);
    1.76 +void
    1.77 +razor_package_query_add_package(struct razor_package_query *pq,
    1.78 +				struct razor_package *p);
    1.79 +void
    1.80 +razor_package_query_add_iterator(struct razor_package_query *pq,
    1.81 +				 struct razor_package_iterator *pi);
    1.82 +struct razor_package_iterator *
    1.83 +razor_package_query_finish(struct razor_package_query *pq);
    1.84 +
    1.85 +struct razor_property_iterator;
    1.86 +struct razor_property_iterator *
    1.87 +razor_property_iterator_create(struct razor_set *set,
    1.88 +			       struct razor_package *package);
    1.89 +int razor_property_iterator_next(struct razor_property_iterator *pi,
    1.90 +				 struct razor_property **property,
    1.91 +				 const char **name,
    1.92 +				 enum razor_version_relation *relation,
    1.93 +				 const char **version,
    1.94 +				 enum razor_property_type *type);
    1.95 +void
    1.96 +razor_property_iterator_destroy(struct razor_property_iterator *pi);
    1.97 +
    1.98 +void razor_set_list_files(struct razor_set *set, const char *prefix);
    1.99 +void razor_set_list_package_files(struct razor_set *set, const char *name);
   1.100 +
   1.101 +void razor_set_list_unsatisfied(struct razor_set *set);
   1.102 +
   1.103 +typedef void (*razor_package_callback_t)(const char *name,
   1.104 +					 const char *old_version,
   1.105 +					 const char *new_version,
   1.106 +					 const char *arch,
   1.107 +					 void *data);
   1.108 +void
   1.109 +razor_set_diff(struct razor_set *set, struct razor_set *upstream,
   1.110 +	       razor_package_callback_t callback, void *data);
   1.111 +
   1.112 +/* Package transactions */
   1.113 +
   1.114 +struct razor_transaction *
   1.115 +razor_transaction_create(struct razor_set *system, struct razor_set *upstream);
   1.116 +void razor_transaction_install_package(struct razor_transaction *transaction,
   1.117 +				       struct razor_package *package);
   1.118 +void razor_transaction_remove_package(struct razor_transaction *transaction,
   1.119 +				      struct razor_package *package);
   1.120 +void razor_transaction_update_package(struct razor_transaction *trans,
   1.121 +				      struct razor_package *package);
   1.122 +void razor_transaction_update_all(struct razor_transaction *transaction);
   1.123 +int razor_transaction_resolve(struct razor_transaction *trans);
   1.124 +int razor_transaction_describe(struct razor_transaction *trans);
   1.125 +struct razor_set *razor_transaction_finish(struct razor_transaction *trans);
   1.126 +void razor_transaction_destroy(struct razor_transaction *trans);
   1.127 +
   1.128 +/* Temporary helper for test suite. */
   1.129 +int razor_transaction_unsatisfied_property(struct razor_transaction *trans,
   1.130 +					   const char *name,
   1.131 +					   enum razor_version_relation rel,
   1.132 +					   const char *version,
   1.133 +					   enum razor_property_type type);
   1.134 +
   1.135 +/* Importer interface; for building a razor set from external sources,
   1.136 + * like yum, rpmdb or razor package files. */
   1.137 +
   1.138 +struct razor_importer;
   1.139 +struct razor_rpm;
   1.140 +
   1.141 +struct razor_importer *razor_importer_new(void);
   1.142 +void razor_importer_destroy(struct razor_importer *importer);
   1.143 +void razor_importer_begin_package(struct razor_importer *importer,
   1.144 +				  const char *name,
   1.145 +				  const char *version,
   1.146 +				  const char *arch);
   1.147 +void razor_importer_add_property(struct razor_importer *importer,
   1.148 +				 const char *name,
   1.149 +				 enum razor_version_relation relation,
   1.150 +				 const char *version,
   1.151 +				 enum razor_property_type type);
   1.152 +void razor_importer_add_file(struct razor_importer *importer,
   1.153 +			     const char *name);
   1.154 +void razor_importer_finish_package(struct razor_importer *importer);
   1.155 +
   1.156 +int razor_importer_add_rpm(struct razor_importer *importer,
   1.157 +			   struct razor_rpm *rpm);
   1.158 +
   1.159 +struct razor_set *razor_importer_finish(struct razor_importer *importer);
   1.160 +
   1.161 +void razor_build_evr(char *evr_buf, int size, const char *epoch,
   1.162 +		     const char *version, const char *release);
   1.163 +
   1.164 +struct razor_set *razor_set_create_from_yum(void);
   1.165 +struct razor_set *razor_set_create_from_rpmdb(void);
   1.166 +
   1.167 +/* RPM functions */
   1.168 +
   1.169 +struct razor_rpm *razor_rpm_open(const char *filename);
   1.170 +int razor_rpm_install(struct razor_rpm *rpm, const char *root);
   1.171 +int razor_rpm_close(struct razor_rpm *rpm);
   1.172 +
   1.173 +
   1.174 +/* Razor root functions. The root data struct encapsulates filesystem
   1.175 + * conventions and the locking protocol. */
   1.176 +
   1.177 +struct razor_root;
   1.178 +#define RAZOR_ROOT_OPEN_WRITE 0x01
   1.179 +
   1.180 +int razor_root_create(const char *root);
   1.181 +struct razor_root *razor_root_open(const char *root, int flags);
   1.182 +struct razor_set *razor_root_open_read_only(const char *root);
   1.183 +struct razor_transaction *
   1.184 +razor_root_create_transaction(struct razor_root *image,
   1.185 +			      struct razor_set *upstream);
   1.186 +int razor_root_close(struct razor_root *image);
   1.187 +void razor_root_update(struct razor_root *image, struct razor_set *next);
   1.188 +int razor_root_commit(struct razor_root *image);
   1.189 +void razor_root_diff(struct razor_root *root,
   1.190 +		     razor_package_callback_t callback, void *data);
   1.191 +
   1.192 +#endif /* _RAZOR_H_ */