summaryrefslogtreecommitdiffstats
path: root/xpcom/io/SnappyFrameUtils.h
blob: af8bcd8617c755828944a422f1f812bc82186023 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_SnappyFrameUtils_h__
#define mozilla_SnappyFrameUtils_h__

#include "mozilla/Attributes.h"
#include "nsError.h"

namespace mozilla {
namespace detail {

//
// Utility class providing primitives necessary to build streams based
// on the snappy compressor.  This essentially abstracts the framing format
// defined in:
//
//  other-licences/snappy/src/framing_format.txt
//
// NOTE: Currently only the StreamIdentifier and CompressedData chunks are
//       supported.
//
class SnappyFrameUtils
{
public:
  enum ChunkType
  {
    Unknown,
    StreamIdentifier,
    CompressedData,
    UncompressedData,
    Padding,
    Reserved,
    ChunkTypeCount
  };

  static const size_t kChunkTypeLength = 1;
  static const size_t kChunkLengthLength = 3;
  static const size_t kHeaderLength = kChunkTypeLength + kChunkLengthLength;
  static const size_t kStreamIdentifierDataLength = 6;
  static const size_t kCRCLength = 4;

  static nsresult
  WriteStreamIdentifier(char* aDest, size_t aDestLength,
                        size_t* aBytesWrittenOut);

  static nsresult
  WriteCompressedData(char* aDest, size_t aDestLength,
                      const char* aData, size_t aDataLength,
                      size_t* aBytesWrittenOut);

  static nsresult
  ParseHeader(const char* aSource, size_t aSourceLength, ChunkType* aTypeOut,
              size_t* aDataLengthOut);

  static nsresult
  ParseData(char* aDest, size_t aDestLength,
            ChunkType aType, const char* aData, size_t aDataLength,
            size_t* aBytesWrittenOut, size_t* aBytesReadOut);

  static nsresult
  ParseStreamIdentifier(char* aDest, size_t aDestLength,
                        const char* aData, size_t aDataLength,
                        size_t* aBytesWrittenOut, size_t* aBytesReadOut);

  static nsresult
  ParseCompressedData(char* aDest, size_t aDestLength,
                      const char* aData, size_t aDataLength,
                      size_t* aBytesWrittenOut, size_t* aBytesReadOut);

  static size_t
  MaxCompressedBufferLength(size_t aSourceLength);

protected:
  SnappyFrameUtils() { }
  virtual ~SnappyFrameUtils() { }
};

} // namespace detail
} // namespace mozilla

#endif // mozilla_SnappyFrameUtils_h__