开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 多媒体 > DVD > 查看源码
readTextFile.h
资源名称：tb_i86_wr_1019_1102.　[点击查看]
上传用户：super_houu
上传日期：2008-09-21
资源大小：4099k
文件大小：10k
源码类别：

DVD

开发平台：

Others

readTextFile.h：源码内容
  1. /**************************************************************
  2.  *  readTextFile.h
  3.  **************************************************************
  4.  *  Description:
  5.  *  ============
  6.  *  Functions for reading text file using caching. 
  7.  **************************************************************
  8.  *
  9.  *  Hagayb 14.11.03
  10.  **************************************************************/
  11. #include "Config.h" // Global Configuration - do not remove!
  13. #ifdef USE_AUX_SUBTITLES
  15. #ifndef __READTEXTFILE_H_
  16. #define __READTEXTFILE_H_
  18. #define TF_SEEK_SET 0
  19. #define TF_SEEK_CUR 1
  20. #define TF_SEEK_END 2
  22. #define TF_BUFFER_SIZE 256
  23. #define TF_BUFFER_SIZE_HALF 128
  25. #include "IncludeSysDefs.h"
  27. typedef struct textFileTag {
  28. DWORD dwStartAddress;
  29. DWORD dwFileSize;
  31. DWORD dwCurrentDiscOffset; // offest in disc of the data currently stored in buffer
  33. char *caBuffer;
  34. char *pcCurrentBufferPosition; // points at the current position in the buffer,
  35. // or NULL after reading past the buffers end.
  36. WORD wCurrentBufferSize;
  37. } textFile, *textFilePtr;
  39. /////////////////////////////////////////////////////////////////////////////////////////////
  40. // Function name : textFileOpen
  41. // Purpose : Open a text file for reading with buffering
  42. // Input Parameters : dwStartAddress - Address of the file on disc
  43. //   dwFileSize  - Size if the file
  44. // Return type : Handle to textFile on success, NULL on failure.
  45. // Description : The function allocates a textFile struct and sets up a buffer for reading
  46. /////////////////////////////////////////////////////////////////////////////////////////////
  47. textFilePtr textFileOpen(DWORD dwStartAddress, DWORD dwFileSize);
  49. /////////////////////////////////////////////////////////////////////////////////////////////
  50. // Function name : textFileClose
  51. // Purpose : Closes a text file
  52. // Input Parameters : tfpFile - Handle to the file
  53. // Return type : void.
  54. // Description : The function deallocates the buffer and textFile struct for the file
  55. /////////////////////////////////////////////////////////////////////////////////////////////
  56. void textFileClose(textFilePtr tfpFile);
  58. /////////////////////////////////////////////////////////////////////////////////////////////
  59. // Function name : textFileSeek
  60. // Purpose : Seeks to a position in the file
  61. // Input Parameters : tfpFile - Handle to the file
  62. //   dwOffset - Offset in bytes, relative to the location specifed by bOrigin
  63. //   bOrigin - Specifies the origin of the seek. 
  64. //     Can have the following values:
  65. //   * TF_SEEK_SET - seek is relative to the file's beginning.
  66. //   * TF_SEEK_CUR - seek is relative to the current position
  67. //   * TF_SEEK_END - seek is relative to the file's end.
  68. // Return type : TRUE on success. FALSE on failure, or requested position isn't within the file
  69. // Description : The function checks is the requested position already exist in the buffer.
  70. //   If not, it fills the buffer from that point. In both cases, it updates
  71. //   the internal pointer pcCurrentBufferPosition to the requested position
  72. /////////////////////////////////////////////////////////////////////////////////////////////
  73. BOOL textFileSeek(textFilePtr tfpFile, long dwOffset, BYTE bOrigin);
  75. /////////////////////////////////////////////////////////////////////////////////////////////
  76. // Function name : textFileEOF
  77. // Purpose : Check if end of file was reached
  78. // Input Parameters : tfpFile - Handle to the file
  79. // Return type : TRUE if end of file was reached, FALSE otherwise
  80. // Description : Check if pcCurrentBufferPosition is NULL, and dwCurrentDiscOffset + 
  81. //   wCurrentBufferSize points outside of the file
  82. /////////////////////////////////////////////////////////////////////////////////////////////
  83. BOOL textFileEOF(textFilePtr tfpFile);
  85. /////////////////////////////////////////////////////////////////////////////////////////////
  86. // Function name : textFileReadChar
  87. // Purpose : Reads a character (single byte) from the file.
  88. // Input Parameters : tfpFile - Handle to the file
  89. //   wReserveLast - 
  90. // Output Parameters: c - The character that was read
  91. // Return type : TRUE if successful, FALSE if failed, or already on end of file
  92. // Description : Fills the buffer if necessary, and reads a character.
  93. /////////////////////////////////////////////////////////////////////////////////////////////
  94. BOOL textFileReadChar(textFilePtr tfpFile,WORD wReserveLast, char *c );
  96. /////////////////////////////////////////////////////////////////////////////////////////////
  97. // Function name : textFileGetPosition
  98. // Purpose : Get the current poision in the file.
  99. // Input Parameters : tfpFile - Handle to the file
  100. // Return type : DWORD specifying the position. This value can be used in textFileSeek
  101. //   together with TF_SEEK_SET to reach this position again.
  102. // Description : calculates the offset on disc of the current character in the buffer.
  103. /////////////////////////////////////////////////////////////////////////////////////////////
  104. DWORD textFileGetPosition(textFilePtr tfpFile);
  106. /////////////////////////////////////////////////////////////////////////////////////////////
  107. // Function name : textFileFindString
  108. // Purpose : Searches for the specified string from het current position, in the
  109. //   specified number of bytes.
  110. // Input Parameters : tfpFile - Handle to the file
  111. //   szStr - String (null terminated, single byte) to look for.
  112. //   dwRegionSize - a limit to the number of bytes in the file the search 
  113. // will cover. Specify 0 for search until end of file.
  114. // Return type : TRUE is string was found, else otherwise.
  115. //   The current position in the file will be the first character following the string
  116. // Description : 
  117. /////////////////////////////////////////////////////////////////////////////////////////////
  118. BOOL textFileFindString(textFilePtr tfpFile, const char *szStr, DWORD dwRegionSize);
  120. /////////////////////////////////////////////////////////////////////////////////////////////
  121. // Function name : textFileFindNumber
  122. // Purpose : Finds the next digit in the file, if exists in the next specified number of bytes.
  123. // Input Parameters : tfpFile - Handle to the file
  124. //   dwRegionSize - a limit to the number of bytes in the file the search 
  125. // will cover. Specify 0 for search until end of file.
  126. // Return type : TRUE is a digit was found within the region, else otherwise.
  127. //   The current position in the file will be the digit.
  128. // Description : The function looks of the next digit, starting from the current position
  129. //   for dwRegionSize bytes. If there was already a digit in the current position,
  130. //   it does nothing.
  131. /////////////////////////////////////////////////////////////////////////////////////////////
  132. BOOL textFileFindNumber(textFilePtr tfpFile,DWORD dwRegionSize);
  135. /////////////////////////////////////////////////////////////////////////////////////////////
  136. // Function name : textFileReadNumber
  137. // Purpose : Reads a number from the current position in the file.
  138. // Input Parameters : tfpFile - Handle to the file
  139. // Output Parameters: uiNumber - The number that was read
  140. // Return type : TRUE if successful. FALSE if the was no number in the current position,
  141. //   if already on EOF, or on error.
  142. // Description : The function checks if there's a digit in the current position. If there
  143. //   is, it reads until (not including) the 1st non digit character and 
  144. //   converts the digit sequence to a number.
  145. /////////////////////////////////////////////////////////////////////////////////////////////
  146. BOOL textFileReadNumber(textFilePtr tfpFile, DWORD *uiNumber);
  148. /////////////////////////////////////////////////////////////////////////////////////////////
  149. // Function name : textFileSkipLine
  150. // Purpose : Find the beginning of the next line
  151. // Input Parameters : tfpFile - Handle to the file
  152. // Return type : TRUE if successful. FALSE if EOF encountered before or right after 'n',
  153. //   or on error.
  154. // Description : The function searches for the next 'n'  and sets the current position
  155. //   right after it.
  156. /////////////////////////////////////////////////////////////////////////////////////////////
  157. BOOL textFileSkipLine(textFilePtr tfpFile);
  159. /////////////////////////////////////////////////////////////////////////////////////////////
  160. // Function name : textFileSkipLine
  161. // Purpose : Find the beginning of the next line
  162. // Input Parameters : tfpFile - Handle to the file
  163. // Return type : TRUE if successful. FALSE if EOF encountered before 'n',
  164. //   or on error.
  165. // Description : The function searches for the next 'n'  and sets the current position
  166. //   right after it.
  167. /////////////////////////////////////////////////////////////////////////////////////////////
  168. BOOL textFileSkipLine(textFilePtr tfpFile);
  170. /////////////////////////////////////////////////////////////////////////////////////////////
  171. // Function name : textFileIsCurrentChar
  172. // Purpose : Asserts that the current character in the file is the specified char
  173. // Input Parameters : tfpFile - Handle to the file
  174. //   c - character to be tested.
  175. // Return type : TRUE if character is correct. FALSE otherwise, and on error
  176. // Description : The function reads a character from the file and compares it to the
  177. //   specified character. This function should be used to check correctness
  178. //   of file format.
  179. /////////////////////////////////////////////////////////////////////////////////////////////
  180. BOOL textFileIsCurrentChar(textFilePtr tfpFile,char c);
  181.   
  182. BOOL textFileIsCurrentChar2(textFilePtr tfpFile,char c);
  183.   
  184. #endif // __READTEXTFILE_H_
  186. #endif // USE_OSD_DEBUG