summaryrefslogtreecommitdiffstats
path: root/extensions/spellcheck/hunspell/glue/mozHunspellFileMgrSandbox.h
blob: c0434c14ca052fb53e60d7dbb7d998d4ec8b6333 (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
/* -*- 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 mozHunspellFileMgrSandbox_h
#define mozHunspellFileMgrSandbox_h

#include <string>
#include <stdint.h>

#include "mozilla/Result.h"
#include "mozilla/ResultExtensions.h"
#include "nsIInputStream.h"
#include "nsReadLine.h"

// Note: This class name and lack of namespacing terrible, but are necessary
// for Hunspell compatibility.
class FileMgr final {
 public:
  /**
   * aFilename must be a local file/jar URI for the file to load.
   *
   * aKey is the decription key for encrypted Hunzip files, and is
   * unsupported. The argument is there solely for compatibility.
   */
  explicit FileMgr(const char* aFilename, const char* aKey = nullptr);
  ~FileMgr();

  // Note: The nonstandard naming conventions of these methods are necessary for
  // Hunspell compatibility.
  bool getline(std::string& aLine);
  int getlinenum() const;

 private:
  // opaque file descriptor got from the host application
  uint32_t mFd;
};

#endif  // mozHunspellFileMgrSandbox_h