File: ppb_flash_file.idl

package info (click to toggle)
thunderbird 1%3A60.9.0-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,339,492 kB
  • sloc: cpp: 5,457,040; ansic: 2,360,385; python: 596,167; asm: 340,963; java: 326,296; xml: 258,830; sh: 84,445; makefile: 23,705; perl: 17,317; objc: 3,768; yacc: 1,766; ada: 1,681; lex: 1,364; pascal: 1,264; cs: 879; exp: 527; php: 436; lisp: 258; ruby: 153; awk: 152; sed: 53; csh: 27
file content (126 lines) | stat: -rw-r--r-- 4,048 bytes parent folder | download | duplicates (2)
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/* Copyright (c) 2012 The Chromium Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

/**
 * This file contains the <code>PPB_Flash_File_ModuleLocal</code> and <code>PPB_Flash_File_FileRef</code> interfaces.
 */

label Chrome {
  M24 = 2.0,
  M25 = 3.0
};

struct PP_DirEntry_Dev {
  str_t name;
  PP_Bool is_dir;
};

/* Directory. */
struct PP_DirContents_Dev {
  int32_t count;
  [size_is(count)] PP_DirEntry_Dev[] entries;
};

/* PPB_Flash_File_ModuleLocal */
[version=3.0]
interface PPB_Flash_File_ModuleLocal {
  /* Deprecated. Returns true. */
  PP_Bool CreateThreadAdapterForInstance(
      [in] PP_Instance instance);
  /* Deprecated. Does nothing. */
  void ClearThreadAdapterForInstance(
      [in] PP_Instance instance);

  /* Opens a module-local file, returning a file descriptor (posix) or a HANDLE
   * (win32) into file. Module-local file paths (here and below) are
   * '/'-separated UTF-8 strings, relative to a module-specific root. The return
   * value is the ppapi error, PP_OK if success, one of the PP_ERROR_* in case
   * of failure
   */
  int32_t OpenFile(
      [in] PP_Instance instance,
      [in] str_t path,
      [in] int32_t mode,
      [out] PP_FileHandle file);

  /* Renames a module-local file. The return value is the ppapi error, PP_OK if
   * success, one of the PP_ERROR_* in case of failure.
   */
  int32_t RenameFile(
      [in] PP_Instance instance,
      [in] str_t path_from,
      [in] str_t path_to);

  /* Deletes a module-local file or directory. If recursive is set and the path
   * points to a directory, deletes all the contents of the directory. The
   * return value is the ppapi error, PP_OK if success, one of the PP_ERROR_* in
   * case of failure.
   */
  int32_t DeleteFileOrDir(
      [in] PP_Instance instance,
      [in] str_t path,
      [in] PP_Bool recursive);

  /* Creates a module-local directory. The return value is the ppapi error,
   * PP_OK if success, one of the PP_ERROR_* in case of failure.
   */
  int32_t CreateDir(
      [in] PP_Instance instance,
      [in] str_t path);

  /* Queries information about a module-local file. The return value is the
   * ppapi error, PP_OK if success, one of the PP_ERROR_* in case of failure.
   */
  int32_t QueryFile(
      [in] PP_Instance instance,
      [in] str_t path,
      [out] PP_FileInfo info);

  /* Gets the list of files contained in a module-local directory. The return
   * value is the ppapi error, PP_OK if success, one of the PP_ERROR_* in case
   * of failure. If non-NULL, the returned contents should be freed with
   * FreeDirContents.
   */
  int32_t GetDirContents(
      [in] PP_Instance instance,
      [in] str_t path,
      [out] PP_DirContents_Dev contents);

  /* Frees the data allocated by GetDirContents. */
  void FreeDirContents(
      [in] PP_Instance instance,
      [in] PP_DirContents_Dev contents);

  /* Creates a temporary file. The file will be automatically deleted when all
   * handles to it are closed.
   * Returns PP_OK if successful, one of the PP_ERROR_* values in case of
   * failure.
   * If successful, |file| is set to a file descriptor (posix) or a HANDLE
   * (win32) to the file. If failed, |file| is not touched.
   */
  int32_t CreateTemporaryFile(
      [in] PP_Instance instance,
      [out] PP_FileHandle file);
};

/**
 * This interface provides (for Flash) synchronous access to files whose paths
 * are given by a Pepper FileRef. Such FileRefs are typically obtained via the
 * Pepper file chooser.
 */
[version=2.0]
interface PPB_Flash_File_FileRef {
  /* The functions below correspond exactly to their module-local counterparts
   * (except in taking FileRefs instead of paths, of course). We omit the
   * functionality which we do not provide for FileRefs.
   */
  int32_t OpenFile(
      [in] PP_Resource file_ref_id,
      [in] int32_t mode,
      [out] PP_FileHandle file);
  int32_t QueryFile(
      [in] PP_Resource file_ref_id,
      [out] PP_FileInfo info);
};