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_FileWriter.h 19855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * @ingroup OSAL 20855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * @brief File writer 21855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi * @note This file declares functions and types to write in a file. 22855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi ************************************************************************ 23855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi*/ 24855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 25855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 26855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#ifndef M4OSA_FILEWRITER_H 27855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#define M4OSA_FILEWRITER_H 28855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 29855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_Types.h" 30855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_Error.h" 31855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_FileCommon.h" 32855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#include "M4OSA_Memory.h" 33855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 34855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 35855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi/** This enum defines the option ID to be used in M4OSA_FileWriteGetOption() 36855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargiand M4OSA_FileWriteSetOption()*/ 37855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargitypedef enum 38855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi{ 39855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Get the file URL, provided by the M4OSA_FileWriteOpen (M4OSA_Char*)*/ 40855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileWriteGetURL 41855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_WRITER, 0x01), 42855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 43855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Get the file attributes (M4OSA_FileAttribute*)*/ 44855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileWriteGetAttribute 45855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_WRITER, 0x02), 46855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 47855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Get the reader context for read & write file. (M4OSA_Context*)*/ 48855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileWriteGetReaderContext 49855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_WRITER, 0x03), 50855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 51855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileWriteGetFilePosition 52855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_WRITER, 0x04), 53855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 54855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileWriteGetFileSize 55855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READ, M4OSA_FILE_WRITER, 0x05), 56855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 57855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 58855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileWriteLockMode 59855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READWRITE, M4OSA_FILE_WRITER, 0x06), 60855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 61855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 62855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi /** Check lock of file */ 63855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_kFileWriteDescMode 64855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi = M4OSA_OPTION_ID_CREATE(M4_READWRITE, M4OSA_FILE_WRITER, 0x07) 65855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi} M4OSA_FileWriteOptionID; 66855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 67855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 68855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi/** This structure stores the set of the function pointer to access to a file 69855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi in read mode*/ 70855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargitypedef struct 71855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi{ 72855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*openWrite) (M4OSA_Context* context, 73855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_Void* fileDescriptor, 74855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32 fileModeAccess); 75855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 76855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*writeData) (M4OSA_Context context, 77855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_MemAddr8 data, 78855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32 size); 79855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 80855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*seek) (M4OSA_Context context, 81855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileSeekAccessMode seekMode, 82855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FilePosition* position); 83855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 84855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*Flush) (M4OSA_Context context); 85855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*closeWrite) (M4OSA_Context context); 86855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*setOption) (M4OSA_Context context, 87855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_OptionID optionID, 88855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption optionValue); 89855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 90855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_ERR (*getOption) (M4OSA_Context context, 91855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_OptionID optionID, 92855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption* optionValue); 93855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi} M4OSA_FileWriterPointer; 94855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 95855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#ifdef __cplusplus 96855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargiextern "C" 97855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi{ 98855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#endif 99855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 100855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileWriteOpen (M4OSA_Context* context, 101855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_Void* fileDescriptor, 102855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32 fileModeAccess); 103855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 104855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileWriteData (M4OSA_Context context, 105855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_MemAddr8 data, 106855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_UInt32 size); 107855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 108855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi/* Pierre Lebeaupin 2008/04/29: WARNING! the feature of file*Seek which returns 109855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargithe position in the file (from the beginning) after the seek in the "position" 110855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargipointer has been found to be unreliably (or sometimes not at all) implemented 111855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargiin some OSALs, so relying on it is strongly discouraged, unless you really want 112855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargito have a pizza evening. */ 113855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileWriteSeek (M4OSA_Context context, 114855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FileSeekAccessMode seekMode, 115855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_FilePosition* position); 116855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 117855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileWriteClose (M4OSA_Context context); 118855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 119855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileWriteFlush (M4OSA_Context context); 120855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 121855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileWriteGetOption (M4OSA_Context context, 122855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_OptionID optionID, 123855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption* optionValue); 124855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 125855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray KundargiM4OSAL_FILE_EXPORT_TYPE M4OSA_ERR M4OSA_fileWriteSetOption (M4OSA_Context context, 126855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_OptionID optionID, 127855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi M4OSA_DataOption optionValue); 128855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 129855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#ifdef __cplusplus 130855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi} 131855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#endif 132855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 133855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 134855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi#endif /*M4OSA_FILEWRITER_H*/ 135855ec7c4be7ad642721909d5837a8d25a117c22fDharmaray Kundargi 136