home *** CD-ROM | disk | FTP | other *** search
/ Chip 2005 June / ccd0605.iso / LINUX / gopchop-1.1.7.tar.tar / gopchop-1.1.7.tar / gopchop-1.1.7 / src / file_buffer.h < prev    next >
C/C++ Source or Header  |  2005-04-30  |  3KB  |  117 lines
  1. /*
  2. #
  3. # Header for Utilities for seeking around in a file stream
  4. #
  5. # $Id: file_buffer.h,v 1.5 2005/04/30 20:22:37 keescook Exp $
  6. #
  7. # Copyright (C) 2001-2003 Kees Cook
  8. # kees@outflux.net, http://outflux.net/
  9. # 
  10. # This program is free software; you can redistribute it and/or
  11. # modify it under the terms of the GNU General Public License
  12. # as published by the Free Software Foundation; either version 2
  13. # of the License, or (at your option) any later version.
  14. # 
  15. # This program is distributed in the hope that it will be useful,
  16. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18. # GNU General Public License for more details.
  19. # 
  20. # You should have received a copy of the GNU General Public License
  21. # along with this program; if not, write to the Free Software
  22. # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23. # http://www.gnu.org/copyleft/gpl.html
  24. #
  25. */
  26.  
  27. /*
  28.  * buffer management inspired by mplayer
  29.  */
  30. #ifndef _FILE_BUFFER_H_
  31. #define _FILE_BUFFER_H_
  32.  
  33.  
  34. #ifdef HAVE_CONFIG_H
  35. # include "config.h"
  36. # ifdef HAVE_STDINT_H
  37. #  include <stdint.h>
  38. # endif
  39. # ifdef HAVE_INTTYPES_H
  40. #  include <inttypes.h>
  41. # endif
  42. # ifdef HAVE_STRING_H
  43. #  include <string.h> /* memmove, memcpy */
  44. # endif
  45. # ifdef HAVE_STDLIB_H
  46. #  include <stdlib.h> /* off_t */
  47. # endif
  48. #else
  49. # include <stdint.h>
  50. # include <string.h>
  51. # include <stdlib.h> /* off_t */
  52. #endif
  53.  
  54. // This seems to be needed to catch the largefile functions in stdio.h?
  55. #define __USE_LARGEFILE
  56.  
  57. #include <stdio.h> /* fopen, fread, fseek*, fclose */
  58.  
  59. /* figure out which fseek/ftell we need */
  60. #undef FSEEK
  61. #undef FTELL
  62. #ifdef HAVE_FSEEKO
  63. # define FSEEK      fseeko
  64. # define FSEEK_NAME "fseeko"
  65. # define FTELL      ftello
  66. # define FTELL_NAME "ftello"
  67. #else
  68. # define FSEEK      fseek
  69. # define FSEEK_NAME "fseek"
  70. # define FTELL      ftell
  71. # define FTELL_NAME "ftell"
  72. #endif
  73.  
  74. /* figure out off_t formatting */
  75. #undef OFF_T_FORMAT
  76. #undef ATOL
  77. #if _FILE_OFFSET_BITS==64 || defined(__NetBSD__)
  78. # define OFF_T_FORMAT  "llu"
  79. # define ATOL(arg)     atoll(arg)
  80. #else
  81. # warning "Not compiling for large file (>2G) support!"
  82. # define OFF_T_FORMAT  "lu"
  83. # define ATOL(arg)     atol(arg)
  84. #endif
  85.  
  86. #define DEFAULT_FILE_BUFFER_SIZE        (1024*512)
  87.  
  88. #define FILE_BUF_OKAY                            0
  89. #define FILE_BUF_ERR_NULL_STRUCT                -1
  90. #define FILE_BUF_ERR_NULL_ARG                   -2
  91. #define FILE_BUF_ERR_READ                       -3
  92. #define FILE_BUF_ERR_SEEK                       -4
  93. #define FILE_BUF_ERR_OPEN                       -5
  94. #define FILE_BUF_ERR_PAST_END                   -6
  95. #define FILE_BUF_ERR_NEED_POSITIVE_COUNT        -7
  96. #define FILE_BUF_ERR_COUNT_EXCEEDS_BUFFER_SIZE  -8
  97.  
  98. typedef struct file_buf_t file_buf;
  99.  
  100. // A NULL return from "buffer_start" indicates that errno has been set,
  101. // and calls to "perror" and the like are valid.
  102. // Passing a previously-return file_buf into buffer_start will re-allocate it
  103. file_buf * buffer_start(file_buf *fb, char *filename, size_t size);
  104. int buffer_look_ahead(file_buf *fb, uint8_t * bytes, size_t count);
  105. int buffer_get_byte(file_buf *fb, uint8_t * byte);
  106. off_t buffer_tell(file_buf *fb);
  107. off_t buffer_file_size(file_buf *fb);
  108. int buffer_seek(file_buf *fb, off_t location);
  109. int buffer_end(file_buf *fb);
  110.  
  111. // can point to a file offset to refill from
  112. int buffer_refill(file_buf *fb);
  113.  
  114. #endif /* _FILE_BUFFER_H_ */
  115.  
  116. /* vi:set ai ts=4 sw=4 expandtab: */
  117.