LLVM  9.0.0svn
Compression.h
Go to the documentation of this file.
1 //===-- llvm/Support/Compression.h ---Compression----------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains basic functions for compression/uncompression.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_SUPPORT_COMPRESSION_H
14 #define LLVM_SUPPORT_COMPRESSION_H
15 
16 #include "llvm/Support/DataTypes.h"
17 
18 namespace llvm {
19 template <typename T> class SmallVectorImpl;
20 class Error;
21 class StringRef;
22 
23 namespace zlib {
24 
25 static constexpr int NoCompression = 0;
26 static constexpr int BestSpeedCompression = 1;
27 static constexpr int DefaultCompression = 6;
28 static constexpr int BestSizeCompression = 9;
29 
30 bool isAvailable();
31 
32 Error compress(StringRef InputBuffer, SmallVectorImpl<char> &CompressedBuffer,
33  int Level = DefaultCompression);
34 
35 Error uncompress(StringRef InputBuffer, char *UncompressedBuffer,
36  size_t &UncompressedSize);
37 
38 Error uncompress(StringRef InputBuffer,
39  SmallVectorImpl<char> &UncompressedBuffer,
40  size_t UncompressedSize);
41 
42 uint32_t crc32(StringRef Buffer);
43 
44 } // End of namespace zlib
45 
46 } // End of namespace llvm
47 
48 #endif
This class represents lattice values for constants.
Definition: AllocatorList.h:23
Error compress(StringRef InputBuffer, SmallVectorImpl< char > &CompressedBuffer, int Level=DefaultCompression)
Definition: Compression.cpp:49
static constexpr int BestSpeedCompression
Definition: Compression.h:26
static constexpr int BestSizeCompression
Definition: Compression.h:28
static constexpr int DefaultCompression
Definition: Compression.h:27
bool isAvailable()
Definition: Compression.cpp:47
static constexpr int NoCompression
Definition: Compression.h:25
uint32_t crc32(StringRef Buffer)
Definition: Compression.cpp:84
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
Error uncompress(StringRef InputBuffer, char *UncompressedBuffer, size_t &UncompressedSize)
Definition: Compression.cpp:63