razor.h
author James Bowes <jbowes@redhat.com>
Sun Jun 15 10:50:16 2008 -0400 (2008-06-15)
changeset 226 6d9713bfc346
parent 224 5803b6151d02
child 229 cae6308aa5b1
permissions -rw-r--r--
Add info command to bash completion
krh@212
     1
/*
krh@212
     2
 * Copyright (C) 2008  Kristian Høgsberg <krh@redhat.com>
krh@212
     3
 * Copyright (C) 2008  Red Hat, Inc
krh@212
     4
 *
krh@212
     5
 * This program is free software; you can redistribute it and/or modify
krh@212
     6
 * it under the terms of the GNU General Public License as published by
krh@212
     7
 * the Free Software Foundation; either version 2 of the License, or
krh@212
     8
 * (at your option) any later version.
krh@212
     9
 *
krh@212
    10
 * This program is distributed in the hope that it will be useful,
krh@212
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
krh@212
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
krh@212
    13
 * GNU General Public License for more details.
krh@212
    14
 *
krh@212
    15
 * You should have received a copy of the GNU General Public License along
krh@212
    16
 * with this program; if not, write to the Free Software Foundation, Inc.,
krh@212
    17
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
krh@212
    18
 */
krh@212
    19
krh@27
    20
#ifndef _RAZOR_H_
krh@27
    21
#define _RAZOR_H_
krh@27
    22
krh@43
    23
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
krh@43
    24
krh@43
    25
struct razor_set;
krh@92
    26
struct razor_package;
krh@92
    27
struct razor_property;
krh@43
    28
krh@66
    29
enum razor_property_type {
krh@66
    30
	RAZOR_PROPERTY_REQUIRES,
krh@66
    31
	RAZOR_PROPERTY_PROVIDES,
krh@66
    32
	RAZOR_PROPERTY_CONFLICTS,
krh@66
    33
	RAZOR_PROPERTY_OBSOLETES
krh@66
    34
};
krh@66
    35
danw@109
    36
enum razor_version_relation {
danw@109
    37
	RAZOR_VERSION_LESS,
danw@109
    38
	RAZOR_VERSION_LESS_OR_EQUAL,
danw@109
    39
	RAZOR_VERSION_EQUAL,
danw@109
    40
	RAZOR_VERSION_GREATER_OR_EQUAL,
danw@109
    41
	RAZOR_VERSION_GREATER
danw@109
    42
};
danw@137
    43
extern const char * const razor_version_relations[];
danw@109
    44
krh@91
    45
struct razor_set *razor_set_create(void);
krh@43
    46
struct razor_set *razor_set_open(const char *filename);
krh@43
    47
void razor_set_destroy(struct razor_set *set);
krh@197
    48
int razor_set_write_to_fd(struct razor_set *set, int fd);
krh@43
    49
int razor_set_write(struct razor_set *set, const char *filename);
krh@43
    50
krh@92
    51
struct razor_package *
krh@92
    52
razor_set_get_package(struct razor_set *set, const char *package);
krh@92
    53
jbowes@225
    54
void
jbowes@225
    55
razor_package_get_details(struct razor_set *set, struct razor_package *package,
jbowes@225
    56
			  const char **summary, const char **description,
jbowes@225
    57
			  const char **url, const char **license);
jbowes@224
    58
krh@92
    59
struct razor_package_iterator;
krh@92
    60
struct razor_package_iterator *
krh@92
    61
razor_package_iterator_create(struct razor_set *set);
krh@101
    62
struct razor_package_iterator *
krh@101
    63
razor_package_iterator_create_for_property(struct razor_set *set,
krh@101
    64
					   struct razor_property *property);
krh@102
    65
struct razor_package_iterator *
krh@102
    66
razor_package_iterator_create_for_file(struct razor_set *set,
krh@102
    67
				       const char *filename);
krh@92
    68
krh@92
    69
int razor_package_iterator_next(struct razor_package_iterator *pi,
krh@92
    70
				struct razor_package **package,
krh@192
    71
				const char **name,
krh@192
    72
				const char **version,
krh@192
    73
				const char **arch);
krh@92
    74
void razor_package_iterator_destroy(struct razor_package_iterator *pi);
krh@92
    75
krh@216
    76
struct razor_package_query *
krh@216
    77
razor_package_query_create(struct razor_set *set);
krh@216
    78
void
krh@216
    79
razor_package_query_add_package(struct razor_package_query *pq,
krh@216
    80
				struct razor_package *p);
krh@216
    81
void
krh@216
    82
razor_package_query_add_iterator(struct razor_package_query *pq,
krh@216
    83
				 struct razor_package_iterator *pi);
krh@216
    84
struct razor_package_iterator *
krh@216
    85
razor_package_query_finish(struct razor_package_query *pq);
krh@216
    86
krh@92
    87
struct razor_property_iterator;
krh@92
    88
struct razor_property_iterator *
krh@92
    89
razor_property_iterator_create(struct razor_set *set,
krh@92
    90
			       struct razor_package *package);
krh@92
    91
int razor_property_iterator_next(struct razor_property_iterator *pi,
krh@92
    92
				 struct razor_property **property,
danw@109
    93
				 const char **name,
danw@109
    94
				 enum razor_version_relation *relation,
danw@109
    95
				 const char **version,
krh@92
    96
				 enum razor_property_type *type);
krh@92
    97
void
krh@92
    98
razor_property_iterator_destroy(struct razor_property_iterator *pi);
krh@92
    99
krh@49
   100
void razor_set_list_files(struct razor_set *set, const char *prefix);
krh@56
   101
void razor_set_list_package_files(struct razor_set *set, const char *name);
krh@43
   102
krh@43
   103
void razor_set_list_unsatisfied(struct razor_set *set);
krh@43
   104
krh@44
   105
typedef void (*razor_package_callback_t)(const char *name,
krh@44
   106
					 const char *old_version,
krh@44
   107
					 const char *new_version,
krh@192
   108
					 const char *arch,
krh@44
   109
					 void *data);
krh@44
   110
void
krh@44
   111
razor_set_diff(struct razor_set *set, struct razor_set *upstream,
krh@44
   112
	       razor_package_callback_t callback, void *data);
krh@44
   113
danw@137
   114
/* Package transactions */
danw@137
   115
danw@137
   116
enum razor_transaction_package_state {
danw@137
   117
	/* Basic states */
danw@145
   118
	RAZOR_PACKAGE_INSTALL,
danw@154
   119
	RAZOR_PACKAGE_FORCED_UPDATE,
danw@145
   120
	RAZOR_PACKAGE_REMOVE,
danw@154
   121
	RAZOR_PACKAGE_OBSOLETED,
danw@137
   122
danw@137
   123
	/* Error states */
danw@145
   124
danw@169
   125
	RAZOR_PACKAGE_FIRST_ERROR_STATE = 0x4,
danw@169
   126
	RAZOR_PACKAGE_UNAVAILABLE_FLAG = 0x4,
danw@169
   127
danw@145
   128
	/* Package requested for install does not exist */
danw@169
   129
	RAZOR_PACKAGE_INSTALL_UNAVAILABLE = RAZOR_PACKAGE_INSTALL | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@169
   130
	/* Package requiring update does not have any update */
danw@169
   131
	RAZOR_PACKAGE_UPDATE_UNAVAILABLE = RAZOR_PACKAGE_FORCED_UPDATE | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@145
   132
	/* Package requested for removal does not exist */
danw@169
   133
	RAZOR_PACKAGE_REMOVE_NOT_INSTALLED = RAZOR_PACKAGE_REMOVE | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@169
   134
	/* (not used) */
danw@169
   135
	RAZOR_PACKAGE_OBSOLETE_UNAVAILABLE = RAZOR_PACKAGE_OBSOLETED | RAZOR_PACKAGE_UNAVAILABLE_FLAG,
danw@169
   136
danw@145
   137
	/* No newer version of package is available */
danw@145
   138
	RAZOR_PACKAGE_UP_TO_DATE,
danw@145
   139
	/* Package marked for both install and remove */
danw@145
   140
	RAZOR_PACKAGE_CONTRADICTION,
danw@145
   141
	/* Package would add a conflict with an already-installed package */
danw@145
   142
	RAZOR_PACKAGE_NEW_CONFLICT,
danw@145
   143
	/* Already-installed package has a conflict against this package */
danw@145
   144
	RAZOR_PACKAGE_OLD_CONFLICT,
danw@145
   145
	/* Requirement of to-be-installed package can't be satisfied */
danw@154
   146
	RAZOR_PACKAGE_UNSATISFIABLE,
danw@137
   147
};
danw@137
   148
danw@137
   149
struct razor_transaction *
krh@208
   150
razor_transaction_create(struct razor_set *system, struct razor_set *upstream);
krh@208
   151
void razor_transaction_install_package(struct razor_transaction *transaction,
krh@208
   152
				       struct razor_package *package);
krh@208
   153
void razor_transaction_remove_package(struct razor_transaction *transaction,
krh@208
   154
				      struct razor_package *package);
krh@208
   155
void razor_transaction_update_all(struct razor_transaction *transaction);
krh@210
   156
int razor_transaction_resolve(struct razor_transaction *trans);
krh@196
   157
struct razor_set *razor_transaction_finish(struct razor_transaction *trans);
danw@137
   158
void razor_transaction_destroy(struct razor_transaction *trans);
krh@44
   159
krh@190
   160
/* Temporary helper for test suite. */
krh@190
   161
int razor_transaction_unsatisfied_property(struct razor_transaction *trans,
krh@190
   162
					   const char *name,
krh@190
   163
					   enum razor_version_relation rel,
krh@190
   164
					   const char *version);
krh@190
   165
krh@44
   166
/* Importer interface; for building a razor set from external sources,
krh@44
   167
 * like yum, rpmdb or razor package files. */
krh@44
   168
krh@30
   169
struct razor_importer;
krh@77
   170
struct razor_rpm;
krh@27
   171
krh@30
   172
struct razor_importer *razor_importer_new(void);
krh@75
   173
void razor_importer_destroy(struct razor_importer *importer);
krh@30
   174
void razor_importer_begin_package(struct razor_importer *importer,
krh@192
   175
				  const char *name,
krh@192
   176
				  const char *version,
krh@192
   177
				  const char *arch);
jbowes@224
   178
void razor_importer_add_details(struct razor_importer *importer,
jbowes@224
   179
				const char *summary,
jbowes@225
   180
				const char *description,
jbowes@225
   181
				const char *url,
jbowes@225
   182
				const char *license);
krh@66
   183
void razor_importer_add_property(struct razor_importer *importer,
danw@109
   184
				 const char *name,
danw@109
   185
				 enum razor_version_relation relation,
danw@109
   186
				 const char *version,
krh@66
   187
				 enum razor_property_type type);
krh@46
   188
void razor_importer_add_file(struct razor_importer *importer,
krh@46
   189
			     const char *name);
krh@30
   190
void razor_importer_finish_package(struct razor_importer *importer);
krh@75
   191
krh@75
   192
int razor_importer_add_rpm(struct razor_importer *importer,
krh@77
   193
			   struct razor_rpm *rpm);
krh@75
   194
krh@30
   195
struct razor_set *razor_importer_finish(struct razor_importer *importer);
krh@27
   196
danw@143
   197
void razor_build_evr(char *evr_buf, int size, const char *epoch,
danw@143
   198
		     const char *version, const char *release);
danw@143
   199
krh@70
   200
struct razor_set *razor_set_create_from_yum(void);
krh@28
   201
struct razor_set *razor_set_create_from_rpmdb(void);
krh@27
   202
krh@74
   203
/* RPM functions */
krh@77
   204
krh@77
   205
struct razor_rpm *razor_rpm_open(const char *filename);
krh@77
   206
int razor_rpm_install(struct razor_rpm *rpm, const char *root);
krh@77
   207
int razor_rpm_close(struct razor_rpm *rpm);
krh@74
   208
krh@27
   209
#endif /* _RAZOR_H_ */