X-Git-Url: http://git.tuebingen.mpg.de/?p=osl.git;a=blobdiff_plain;f=osl.h.in;h=525587721e837a0b8df67062d4973844cf2ed420;hp=514baa2ed576608c3f0a6b7607e5df68ad1eaccb;hb=7d53d2f571da94ec9caf85fb456118ebee85fcf9;hpb=afee1a06bfa10366c0acb366a2f3b4c09f912cf3 diff --git a/osl.h.in b/osl.h.in index 514baa2..5255877 100644 --- a/osl.h.in +++ b/osl.h.in @@ -7,6 +7,7 @@ /** \file osl.h User interface for the object storage layer. */ #include +#include /** Export all declarations in this file. */ #pragma GCC visibility push(default) @@ -94,10 +95,10 @@ typedef int osl_rbtree_loop_func(struct osl_row *row, void *data); * Describes one column of a osl table. */ struct osl_column_description { - /** One of the tree possible types of storage */ - enum osl_storage_type storage_type; - /** Specifies further properties of the column */ - enum osl_storage_flags storage_flags; + /** One of the tree possible types of storage, \sa osl_storage_type. */ + uint16_t storage_type; + /** Specifies further properties of the column, \sa osl_storage_flags. */ + uint16_t storage_flags; /** * The column name determines the name of the directory where all data * for this column will be stored. Its hash is stored in the table @@ -135,8 +136,8 @@ struct osl_table_description { const char *name; /** The number of columns of this table. */ uint16_t num_columns; - /** Further table-wide information. */ - enum osl_table_flags flags; + /** Further table-wide information, \sa osl_table_flags. */ + uint8_t flags; /** The array describing the individual columns of the table. */ struct osl_column_description *column_descriptions; }; @@ -171,7 +172,7 @@ int osl_create_table(const struct osl_table_description *desc); * * Each osl table must be opened before its data can be accessed. * - * \param table_desc Describes the table to be opened. + * \param desc Describes the table to be opened. * \param result Contains a pointer to the open table on success. * * The table description given by \a desc should coincide with the @@ -220,7 +221,7 @@ int osl_get_row(const struct osl_table *t, unsigned col_num, * Retrieve an object identified by row and column * * \param t Pointer to an open osl table. - * \param r Pointer to the row. + * \param row Pointer to the row. * \param col_num The column number. * \param object The result pointer. * @@ -476,19 +477,6 @@ int osl_get_nth_row(const struct osl_table *t, unsigned col_num, int osl_get_rank(const struct osl_table *t, struct osl_row *r, unsigned col_num, unsigned *rank); -/** - * Compare two osl objects pointing to hash values. - * - * \param obj1 Pointer to the first hash object. - * \param obj2 Pointer to the second hash object. - * - * \return The values required for an osl compare function. - * - * \sa osl_compare_func, uint32_compare(). - */ -int osl_hash_compare(const struct osl_object *obj1, - const struct osl_object *obj2); - /** * Get a string describing the error code passed in the argument. *