githubmirror/ding-libs

collection/collection_priv.h
84 строки3 KB
Dmitri Pal
COLLECTION Making iterations pinnable
05 окт 2009, 18:32
05 окт 2009, 18:32b69cc7a
/*
    COLLECTION LIBRARY

    Header file for internal structures used by the collection interface.

    Copyright (C) Dmitri Pal <dpal@redhat.com> 2009

    Collection Library is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Collection Library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Collection Library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef COLLECTION_PRIV_H
#define COLLECTION_PRIV_H

#include <stdint.h>

/* Define real strcutures */
/* Structure that holds one property.
 * This structure should never be assumed and used directly other than
 * inside the collection.c that contains actual implementation or
 * collection_tools.c or collection_utils.c.
 */
struct collection_item {
    /* Member that contains element linking information.
     * This member should never be directly accessed by an application.
     */
    struct collection_item *next;

    /* Your implementation can assume that these members
     * will always be members of the collection_item.
     * but you should use get_item_xxx functions to get them.
     */
    char *property;
    int property_len;
    int type;
    int length;
    void *data;
    uint64_t phash;
};


/* Internal iterator structure - exposed for reference.
 * Never access internals of this structure in your application.
 */
struct collection_iterator {
    struct collection_item *top;
    struct collection_item **stack;
    unsigned stack_size;
    unsigned stack_depth;
    unsigned item_level;
    int flags;
    struct collection_item *end_item;
    struct collection_item *pin;
    unsigned pin_level;
    unsigned can_break;
};


/* Special type of data that stores collection header information. */
struct collection_header {
    struct collection_item *last;
    unsigned reference_count;
    unsigned count;
    unsigned cclass;
};

/* Internal function to allocate item */
int col_allocate_item(struct collection_item **ci,
                      const char *property,
                      const void *item_data,
                      int length,
                      int type);

#endif