summaryrefslogtreecommitdiffstats
path: root/xpcom/base/nsGZFileWriter.h
blob: 4bb91173c3c14d76a88d43cf190a6105ca5891b3 (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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 nsGZFileWriter_h
#define nsGZFileWriter_h

#include "nsIGZFileWriter.h"
#include "zlib.h"

/**
 * A simple class for writing .gz files.
 */
class nsGZFileWriter final : public nsIGZFileWriter
{
  virtual ~nsGZFileWriter();

public:

  enum Operation {
    Append,
    Create
  };


  explicit nsGZFileWriter(Operation aMode = Create);

  NS_DECL_ISUPPORTS
  NS_DECL_NSIGZFILEWRITER

  /**
   * nsIGZFileWriter exposes two non-virtual overloads of Write().  We
   * duplicate them here so that you can call these overloads on a pointer to
   * the concrete nsGZFileWriter class.
   */
  MOZ_MUST_USE nsresult Write(const char* aStr)
  {
    return nsIGZFileWriter::Write(aStr);
  }

  MOZ_MUST_USE nsresult Write(const char* aStr, uint32_t aLen)
  {
    return nsIGZFileWriter::Write(aStr, aLen);
  }

private:
  Operation mMode;
  bool mInitialized;
  bool mFinished;
  gzFile mGZFile;
};

#endif