ziplist.h

/*
 * Copyright (c) 2009-2012, Pieter Noordhuis <pcnoordhuis at gmail dot com>
 * Copyright (c) 2009-2012, Salvatore Sanfilippo <antirez at gmail dot com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   * Neither the name of Redis nor the names of its contributors may be used
 *     to endorse or promote products derived from this software without
 *     specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#define ZIPLIST_HEAD 0
#define ZIPLIST_TAIL 1



//创建并返回一个新的压缩列表
unsigned char *ziplistNew(void);
//将长度为slen的字符串推入到zl的表头或表尾
unsigned char *ziplistPush(unsigned char *zl, unsigned char *s, unsigned int slen, int where);
//根据下标index返回该下标的节点的地址
unsigned char *ziplistIndex(unsigned char *zl, int index);
//返回p指向节点的后继节点的地址
unsigned char *ziplistNext(unsigned char *zl, unsigned char *p);
//返回p指向节点的前驱节点地址
unsigned char *ziplistPrev(unsigned char *zl, unsigned char *p);
//提取p指向的节点的值
unsigned int ziplistGet(unsigned char *p, unsigned char **sval, unsigned int *slen, long long *lval);
//在p指向的地址插入节点，如果p指向一个节点，意味着是前插
unsigned char *ziplistInsert(unsigned char *zl, unsigned char *p, unsigned char *s, unsigned int slen);
//从zl中删除*p指向的节点
unsigned char *ziplistDelete(unsigned char *zl, unsigned char **p);
//删除下标index开始的num个节点
unsigned char *ziplistDeleteRange(unsigned char *zl, unsigned int index, unsigned int num);
// 将p指向的节点和sstr比较，相等返回1，不相等返回0
unsigned int ziplistCompare(unsigned char *p, unsigned char *s, unsigned int slen);
//寻找节点值和vstr相等的节点，并返回给节点地址，并跳过skip个节点
unsigned char *ziplistFind(unsigned char *p, unsigned char *vstr, unsigned int vlen, unsigned int skip);
//返回压缩列表的节点数量
unsigned int ziplistLen(unsigned char *zl);
//返回压缩列表的所占内存字节数
size_t ziplistBlobLen(unsigned char *zl);