Index: ppapi/c/ppb_file_io.h |
=================================================================== |
--- ppapi/c/ppb_file_io.h (revision 0) |
+++ ppapi/c/ppb_file_io.h (revision 0) |
@@ -0,0 +1,119 @@ |
+/* Copyright (c) 2011 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. |
+ */ |
+#ifndef PPAPI_C_PPB_FILE_IO_H_ |
+#define PPAPI_C_PPB_FILE_IO_H_ |
+ |
+#include "ppapi/c/pp_bool.h" |
+#include "ppapi/c/pp_instance.h" |
+#include "ppapi/c/pp_macros.h" |
+#include "ppapi/c/pp_resource.h" |
+#include "ppapi/c/pp_stdint.h" |
+#include "ppapi/c/pp_time.h" |
+ |
+struct PP_CompletionCallback; |
+struct PP_FileInfo; |
+ |
+typedef enum { |
+ // Requests read access to a file. |
+ PP_FILEOPENFLAG_READ = 1 << 0, |
+ |
+ // Requests write access to a file. May be combined with |
+ // PP_FILEOPENFLAG_READ to request read and write access. |
+ PP_FILEOPENFLAG_WRITE = 1 << 1, |
+ |
+ // Requests that the file be created if it does not exist. If the file |
+ // already exists, then this flag is ignored unless PP_FILEOPENFLAG_EXCLUSIVE |
+ // was also specified, in which case FileIO::Open will fail. |
+ PP_FILEOPENFLAG_CREATE = 1 << 2, |
+ |
+ // Requests that the file be truncated to length 0 if it exists and is a |
+ // regular file. PP_FILEOPENFLAG_WRITE must also be specified. |
+ PP_FILEOPENFLAG_TRUNCATE = 1 << 3, |
+ |
+ // Requests that the file is created when this flag is combined with |
+ // PP_FILEOPENFLAG_CREATE. If this flag is specified, and the file already |
+ // exists, then the FileIO::Open call will fail. |
+ PP_FILEOPENFLAG_EXCLUSIVE = 1 << 4 |
+} PP_FileOpenFlags; |
+PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_FileOpenFlags, 4); |
+ |
+#define PPB_FILEIO_INTERFACE_0_4 "PPB_FileIO;0.4" |
+#define PPB_FILEIO_INTERFACE PPB_FILEIO_INTERFACE_0_4 |
+ |
+// Use this interface to operate on a regular file (PP_FileType_Regular). |
+struct PPB_FileIO { |
+ // Creates a new FileIO object. Returns 0 if the module is invalid. |
+ PP_Resource (*Create)(PP_Instance instance); |
+ |
+ // Returns PP_TRUE if the given resource is a FileIO. Returns PP_FALSE if the |
+ // resource is invalid or some type other than a FileIO. |
+ PP_Bool (*IsFileIO)(PP_Resource resource); |
+ |
+ // Open the specified regular file for I/O according to the given open flags, |
+ // which is a bit-mask of the PP_FileOpenFlags values. Upon success, the |
+ // corresponding file is classified as "in use" by this FileIO object until |
+ // such time as the FileIO object is closed or destroyed. |
+ int32_t (*Open)(PP_Resource file_io, |
+ PP_Resource file_ref, |
+ int32_t open_flags, |
+ struct PP_CompletionCallback callback); |
+ |
+ // Queries info about the file opened by this FileIO object. Fails if the |
+ // FileIO object has not been opened. |
+ int32_t (*Query)(PP_Resource file_io, |
+ struct PP_FileInfo* info, |
+ struct PP_CompletionCallback callback); |
+ |
+ // Updates timestamps for the file opened by this FileIO object. Fails if |
+ // the FileIO object has not been opened. |
+ int32_t (*Touch)(PP_Resource file_io, |
+ PP_Time last_access_time, |
+ PP_Time last_modified_time, |
+ struct PP_CompletionCallback callback); |
+ |
+ // Read from an offset in the file. The size of the buffer must be large |
+ // enough to hold the specified number of bytes to read. May perform a |
+ // partial read. Returns the number of bytes read or an error code. If the |
+ // return value is 0, then it indicates that end-of-file was reached. It is |
+ // valid to call Read multiple times with a completion callback to queue up |
+ // parallel reads from the file at different offsets. |
+ int32_t (*Read)(PP_Resource file_io, |
+ int64_t offset, |
+ char* buffer, |
+ int32_t bytes_to_read, |
+ struct PP_CompletionCallback callback); |
+ |
+ // Write to an offset in the file. May perform a partial write. Returns the |
+ // number of bytes written or an error code. It is valid to call Write |
+ // multiple times with a completion callback to queue up parallel writes to |
+ // the file at different offsets. The FileIO object must have been opened |
+ // with write access. |
+ int32_t (*Write)(PP_Resource file_io, |
+ int64_t offset, |
+ const char* buffer, |
+ int32_t bytes_to_write, |
+ struct PP_CompletionCallback callback); |
+ |
+ // Sets the length of the file. If the file size is extended, then the |
+ // extended area of the file is zero-filled. The FileIO object must have |
+ // been opened with write access. |
+ int32_t (*SetLength)(PP_Resource file_io, |
+ int64_t length, |
+ struct PP_CompletionCallback callback); |
+ |
+ // Flush changes to disk. This call can be very expensive! |
+ int32_t (*Flush)(PP_Resource file_io, |
+ struct PP_CompletionCallback callback); |
+ |
+ // Cancels any IO that may be pending, and closes the FileIO object. Any |
+ // pending callbacks will still run, reporting PP_Error_Aborted if pending IO |
+ // was interrupted. It is NOT valid to call Open again after a call to this |
+ // method. Note: If the FileIO object is destroyed, and it is still open, |
+ // then it will be implicitly closed, so you are not required to call the |
+ // Close method. |
+ void (*Close)(PP_Resource file_io); |
+}; |
+ |
+#endif /* PPAPI_C_PPB_FILE_IO_H_ */ |