1855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi/* 2855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * Copyright (C) 2011 The Android Open Source Project 3855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * 4855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * Licensed under the Apache License, Version 2.0 (the "License"); 5855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * you may not use this file except in compliance with the License. 6855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * You may obtain a copy of the License at 7855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * 8855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * http://www.apache.org/licenses/LICENSE-2.0 9855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * 10855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * Unless required by applicable law or agreed to in writing, software 11855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * distributed under the License is distributed on an "AS IS" BASIS, 12855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * See the License for the specific language governing permissions and 14855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * limitations under the License. 15855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi */ 16855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi/** 17855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi ************************************************************************ 18855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * @file M4OSA_FileReader.h 19855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * @ingroup OSAL 20855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * @brief File reader 21855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * @note This file declares functions and types to read a file. 22855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi ************************************************************************ 23855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi*/ 24855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 25855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 26855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#ifndef M4OSA_FILEREADER_H 27855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#define M4OSA_FILEREADER_H 28855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 29855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 30855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_Types.h" 31855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_Error.h" 32855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_FileCommon.h" 33855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_Memory.h" 34855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 35855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 36855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 37855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi/** This enum defines the option ID to be used in M4OSA_FileReadGetOption() 38855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi and M4OSA_FileReadSetOption()*/ 39855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargitypedef enum M4OSA_FileReadOptionID 40855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi{ 41855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Get the file size (M4OSA_fpos*)*/ 42855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileReadGetFileSize 43855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_READER, 0x01), 44855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 45855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Get the file attributes (M4OSA_FileAttribute*)*/ 46855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileReadGetFileAttribute 47855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_READER, 0x02), 48855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 49855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Get the file URL, provided by the M4OSA_FileReadOpen (M4OSA_Char*)*/ 50855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileReadGetURL 51855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_READER, 0x03), 52855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 53855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Get the file position (M4OSA_fpos*)*/ 54855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileReadGetFilePosition 55855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_READER, 0x04), 56855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 57855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Check end of file: TRUE if the EOF has been reached, FALSE else 58855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi (M4OSA_Bool*)*/ 59855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileReadIsEOF 60855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_READER, 0x05), 61855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 62855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Check lock of file */ 63855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileReadLockMode 64855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READWRITE, M4OSA_FILE_READER, 0x06) 65855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 66855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi} M4OSA_FileReadOptionID; 67855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 68855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 69855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 70855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 71855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 72855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi/** This structure stores the set of the function pointer to access to a 73855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi file in read mode*/ 74855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargitypedef struct 75855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi{ 76855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*openRead) (M4OSA_Context* context, 77855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_Void* fileDescriptor, 78855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32 fileModeAccess); 79855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 80855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*readData) (M4OSA_Context context, 81855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_MemAddr8 buffer, 82855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32* size); 83855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 84855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*seek) (M4OSA_Context context, 85855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileSeekAccessMode seekMode, 86855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FilePosition* position); 87855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 88855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*closeRead) (M4OSA_Context context); 89855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 90855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*setOption) (M4OSA_Context context, 91855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileReadOptionID optionID, 92855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption optionValue); 93855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 94855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*getOption) (M4OSA_Context context, 95855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileReadOptionID optionID, 96855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption *optionValue); 97855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi} M4OSA_FileReadPointer; 98855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 99855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#ifdef __cplusplus 100855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargiextern "C" 101855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi{ 102855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#endif 103855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 104855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileReadOpen (M4OSA_Context* context, 105855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_Void* fileDescriptor, 106855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32 fileModeAccess); 107855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 108855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileReadData (M4OSA_Context context, 109855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_MemAddr8 buffer, 110855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32* size); 111855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 112855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileReadSeek (M4OSA_Context context, 113855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileSeekAccessMode seekMode, 114855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FilePosition* position); 115855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 116855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileReadClose (M4OSA_Context context); 117855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 118855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileReadGetOption (M4OSA_Context context, 119855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileReadOptionID optionID, 120855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption *optionValue); 121855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 122855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileReadSetOption (M4OSA_Context context, 123855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileReadOptionID optionID, 124855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption optionValue); 125855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 126855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#ifdef __cplusplus 127855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi} 128855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#endif 129855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 130855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#endif /*M4OSA_FILEREADER_H*/ 131855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 132