跳到正文
参考文档 / ZLIB × LEAN

inflateInit2_

创建采用所选封装和窗口的解码器。

完整章节与共同规则 ↗
此页源文件快照 · ecafc184cdf44b7f · 对应提交的原文 ↗

先看本函数的前置条件和返回结果;可展开下方共同规则,查看整组接口的缓冲区与所有权要求。

int ZEXPORT inflateInit2_(z_streamp strm, int windowBits, const char *version, int stream_size);

创建采用所选封装和窗口的解码器。

窗口保存近期已经解出的字节,长度/距离引用从中取回旧内容。表中的“窗口位数”是尺度指数 b,表示最多 2^b 字节:例如 15 对应 32768 字节。windowBits 还用符号或附加值选择 raw、zlib、gzip 或自动检测;不能把参数数值直接当成字节数。请求 0、16、32 把大小选择交给头部或默认规则,具体含义见表。

定义域 受限定义域:新的可写流存储、默认分配器,以及 NULL 或可读版本指针;覆盖所有有符号标量参数。

内存与状态效果 分配状态。

前置条件 流尚未有效初始化。分配器字段遵循公共约定。只要求版本首字节可读;不检查整个字符串。

返回与保证 返回 Z_OK 时,流有效,总计数为零,消息为 NULL,data_type 为零,没有窗口、历史、缓冲位或头部登记。zlib/自动检测包装的 adler 初始为 1,仅 gzip 的为 0;raw 保持它不变。缓冲区指针和可用计数不变。

可接受的 windowBits 值为:

值 解码器请求
-15 至 -8 不带封装的 raw DEFLATE,窗口位数为其绝对值
0;8 至 15 zlib;0 从头部选择大小,否则为该最大值
16;24 至 31 仅 gzip;16 使用默认大小,否则减去 16
32;40 至 47 zlib/gzip 检测;32 使用头部/默认大小,否则减去 32

错误路径 版本为 NULL/首字节错误,或 stream_size 错误时,在检查 strm 前返回 Z_VERSION_ERROR,不发生变化。否则,NULL strm 返回 Z_STREAM_ERROR。窗口参数检查前先尝试分配状态。分配失败返回 Z_MEM_ERROR,保留旧 state 字段,清空消息,并按需安装默认回调。分配成功后发现无效窗口参数,则返回 Z_STREAM_ERROR,释放该状态,将 state 置为 NULL。任何失败初始化都不保留新分配。只有成功初始化才需要后续 inflateEnd;其窗口可能由后续调用分配。

本组共同前提与范围

API 手册 · 共享流规则 · 流式压缩

使用 inflate 流分批解码输入,同时控制输出空间。初始化时选择 zlib、gzip 或不带封装的 raw DEFLATE,随后提供更多输入或空间继续,直到完成、请求字典或发生错误。无论出现哪种结果,inflateEnd 都可释放解码器。整块缓冲区的 zlib 解码见 uncompress。

任务 条目
开始或复用 初始化、配置初始化、重置、新配置、保留历史
解码或提供元数据 解压、设置字典、读取历史、gzip 头
恢复或检查 同步搜索、同步点、位置标记、表使用量
调整或分支 预置位、校验、距离选项、复制
释放存储 结束

聚焦契约遵循固定版本的 inflate.c 和 zlib.h,采用默认 LP64 Linux 构建,启用 gzip,不启用可选的无效距离或严格距离模式。范围更广的已登记公开目标保持各自定义域。术语见契约约定,证明状态和剩余工作见进度。

公共条件

调用者与解码器各自保留不同的内容。调用者提供本轮输入和输出缓冲区;解码器保留当前解析阶段、尚未用完的位,以及可能供后续复制使用的历史。更换调用者的输出数组,并不会开始一个新解码任务。

next_in 是本轮未读输入的起点,avail_in 是可读字节数;next_out 是下一个输出位置,avail_out 是从这里开始的剩余可写字节数。例如一块 5 字节输出数组返回时剩余 2 字节空间,就说明本轮写入了 3 字节。先接走这些结果,再把指针和容量设置为下一块可写区域。

下列所有契约都有受限定义域。仅凭 C 指针类型,不能提供这里要求的存储、生命周期或调用历史。

  • 有效流已成功初始化或复制,尚未结束,保留库拥有的状态,且不发生并发调用。使用默认分配器和释放函数。初始化调用接收可写、尚未有效初始化为流的对象,分配器字段为 NULL 或默认函数。
  • 可读或可写范围在整个调用期间都具有所述容量。调用者范围与流及流拥有的存储分离。输入与输出范围不重叠。字典目标、已登记头部记录及其目标缓冲区彼此分离,也与流分离。使用已登记头部存储的调用还要求它与输入/输出范围分离。这些是聚焦定义域的显式限制。
  • 调用者拥有流对象及缓冲区。库拥有状态和可选窗口。调用只改变自己的流、拥有的存储、所述输出范围和任何已登记头部目标。它绝不释放调用者缓冲区。
  • 流检查拒绝时返回 Z_STREAM_ERROR,不发生变化,除非查询或复制契约另有说明。这覆盖 NULL 和可安全读取但未通过检查的记录,不覆盖悬空或任意指针。检查要求分配器、状态、状态的回指针和有效模式满足条件。
  • 计数器使用 C 无符号位宽并回绕。没有契约假设分配成功。解码、字典或分配错误之后,仍可调用 inflateEnd。
flowchart LR
    I["初始化"] --> F["inflate"]
    F -->|"Z_NEED_DICT"| D["设置字典"] --> F
    F -->|"更多空间或输入"| F
    F -->|"结束或放弃"| E["结束"]
    F -->|"数据错误"| R["重置或同步搜索"] --> F

形式化约定

ZlibF.Spec.Public.Goal.inflateInit2_

证明状态:存在阻塞 · 证明记录与剩余工作

/-- `int inflateInit2_(z_streamp strm, int windowBits, const char *version, int stream_size)`.
All signed window arguments and every allocation oracle are included, in source error order. -/
def Goal.inflateInit2_ : Prop :=
  ∀ wb, InflateInitContract (fun p v size => Zlib.Inflate.inflateInit2_ p wb v size) wb
相关定义与源码 ↗
ZLIB × LEAN

全局目录

当前位置inflateInit2_