ZipFileCRO.h revision d4066a4ac50cda61bedd97b5f6d29cf176e04127
1/*
2 * Copyright (C) 2008 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17//
18// C API for ead-only access to Zip archives, with minimal heap allocation.
19//
20#ifndef __LIBS_ZIPFILECRO_H
21#define __LIBS_ZIPFILECRO_H
22
23#include <stdio.h>
24#include <stdlib.h>
25#include <unistd.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31/*
32 * Trivial typedef to ensure that ZipFileCRO is not treated as a simple integer.
33 */
34typedef void* ZipFileCRO;
35
36/*
37 * Trivial typedef to ensure that ZipEntryCRO is not treated as a simple
38 * integer.  We use NULL to indicate an invalid value.
39 */
40typedef void* ZipEntryCRO;
41
42extern ZipFileCRO ZipFileXRO_open(const char* path);
43
44extern void ZipFileCRO_destroy(ZipFileCRO zip);
45
46extern ZipEntryCRO ZipFileCRO_findEntryByName(ZipFileCRO zip,
47        const char* fileName);
48
49extern bool ZipFileCRO_getEntryInfo(ZipFileCRO zip, ZipEntryCRO entry,
50        int* pMethod, size_t* pUncompLen,
51        size_t* pCompLen, off_t* pOffset, long* pModWhen, long* pCrc32);
52
53extern bool ZipFileCRO_uncompressEntry(ZipFileCRO zip, ZipEntryCRO entry, int fd);
54
55#ifdef __cplusplus
56}
57#endif
58
59#endif /*__LIBS_ZIPFILECRO_H*/
60