You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
102 lines
3.4 KiB
102 lines
3.4 KiB
9 years ago
|
/* 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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/* From ppb_file_system.idl modified Thu Jun 13 14:30:40 2013. */
|
||
|
|
|
||
|
|
#ifndef PPAPI_C_PPB_FILE_SYSTEM_H_
|
||
|
|
#define PPAPI_C_PPB_FILE_SYSTEM_H_
|
||
|
|
|
||
|
|
#include "ppapi/c/pp_bool.h"
|
||
|
|
#include "ppapi/c/pp_completion_callback.h"
|
||
|
|
#include "ppapi/c/pp_file_info.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"
|
||
|
|
|
||
|
|
#define PPB_FILESYSTEM_INTERFACE_1_0 "PPB_FileSystem;1.0"
|
||
|
|
#define PPB_FILESYSTEM_INTERFACE PPB_FILESYSTEM_INTERFACE_1_0
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @file
|
||
|
|
* This file defines the API to create a file system associated with a file.
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @addtogroup Interfaces
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* The <code>PPB_FileSystem</code> struct identifies the file system type
|
||
|
|
* associated with a file.
|
||
|
|
*/
|
||
|
|
struct PPB_FileSystem_1_0 {
|
||
|
|
/** Create() creates a file system object of the given type.
|
||
|
|
*
|
||
|
|
* @param[in] instance A <code>PP_Instance</code> identifying the instance
|
||
|
|
* with the file.
|
||
|
|
* @param[in] type A file system type as defined by
|
||
|
|
* <code>PP_FileSystemType</code> enum (except PP_FILESYSTEMTYPE_ISOLATED,
|
||
|
|
* which is currently not supported).
|
||
|
|
* @return A <code>PP_Resource</code> corresponding to a file system if
|
||
|
|
* successful.
|
||
|
|
*/
|
||
|
|
PP_Resource (*Create)(PP_Instance instance, PP_FileSystemType type);
|
||
|
|
/**
|
||
|
|
* IsFileSystem() determines if the provided resource is a file system.
|
||
|
|
*
|
||
|
|
* @param[in] resource A <code>PP_Resource</code> corresponding to a file
|
||
|
|
* system.
|
||
|
|
*
|
||
|
|
* @return <code>PP_TRUE</code> if the resource is a
|
||
|
|
* <code>PPB_FileSystem</code>, <code>PP_FALSE</code> if the resource is
|
||
|
|
* invalid or some type other than <code>PPB_FileSystem</code>.
|
||
|
|
*/
|
||
|
|
PP_Bool (*IsFileSystem)(PP_Resource resource);
|
||
|
|
/**
|
||
|
|
* Open() opens the file system. A file system must be opened before running
|
||
|
|
* any other operation on it.
|
||
|
|
*
|
||
|
|
* @param[in] file_system A <code>PP_Resource</code> corresponding to a file
|
||
|
|
* system.
|
||
|
|
*
|
||
|
|
* @param[in] expected_size The expected size of the file system. Note that
|
||
|
|
* this does not request quota; to do that, you must either invoke
|
||
|
|
* requestQuota from JavaScript:
|
||
|
|
* http://www.html5rocks.com/en/tutorials/file/filesystem/#toc-requesting-quota
|
||
|
|
* or set the unlimitedStorage permission for Chrome Web Store apps:
|
||
|
|
* http://code.google.com/chrome/extensions/manifest.html#permissions
|
||
|
|
*
|
||
|
|
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
|
||
|
|
* completion of Open().
|
||
|
|
*
|
||
|
|
* @return An int32_t containing an error code from <code>pp_errors.h</code>.
|
||
|
|
*/
|
||
|
|
int32_t (*Open)(PP_Resource file_system,
|
||
|
|
int64_t expected_size,
|
||
|
|
struct PP_CompletionCallback callback);
|
||
|
|
/**
|
||
|
|
* GetType() returns the type of the provided file system.
|
||
|
|
*
|
||
|
|
* @param[in] file_system A <code>PP_Resource</code> corresponding to a file
|
||
|
|
* system.
|
||
|
|
*
|
||
|
|
* @return A <code>PP_FileSystemType</code> with the file system type if
|
||
|
|
* valid or <code>PP_FILESYSTEMTYPE_INVALID</code> if the provided resource
|
||
|
|
* is not a valid file system. It is valid to call this function even before
|
||
|
|
* Open() completes.
|
||
|
|
*/
|
||
|
|
PP_FileSystemType (*GetType)(PP_Resource file_system);
|
||
|
|
};
|
||
|
|
|
||
|
|
typedef struct PPB_FileSystem_1_0 PPB_FileSystem;
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
*/
|
||
|
|
|
||
|
|
#endif /* PPAPI_C_PPB_FILE_SYSTEM_H_ */
|
||
|
|
|