/dep/libmpq/libmpq/mpq.h

https://github.com/kizura/server · C Header · 98 lines · 51 code · 13 blank · 34 comment · 1 complexity · 64ab484f8a7f6fe87d5cc7fa15bc7fcb MD5 · raw file 

    

  1. /*
    2. 

  2.  *  mpq.h -- some default types and defines.
    3. 

  3.  *
    4. 

  4.  *  Copyright (c) 2003-2008 Maik Broemme <mbroemme@plusserver.de>
    5. 

  5.  *
    6. 

  6.  *  Some parts (the encryption and decryption stuff) were adapted from
    7. 

  7.  *  the C++ version of StormLib.h and StormPort.h included in stormlib.
    8. 

  8.  *  The C++ version belongs to the following authors:
    9. 

  9.  *
    10. 

  10.  *  Ladislav Zezula <ladik@zezula.net>
    11. 

  11.  *  Marko Friedemann <marko.friedemann@bmx-chemnitz.de>
    12. 

  12.  *
    13. 

  13.  *  This program is free software; you can redistribute it and/or modify
    14. 

  14.  *  it under the terms of the GNU General Public License as published by
    15. 

  15.  *  the Free Software Foundation; either version 2 of the License, or
    16. 

  16.  *  (at your option) any later version.
    17. 

  17.  *
    18. 

  18.  *  This program is distributed in the hope that it will be useful,
    19. 

  19.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
    20. 

  20.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    21. 

  21.  *  GNU General Public License for more details.
    22. 

  22.  *
    23. 

  23.  *  You should have received a copy of the GNU General Public License
    24. 

  24.  *  along with this program; if not, write to the Free Software
    25. 

  25.  *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
    26. 

  26.  */
    27. 

  27. 

  28. #ifndef _MPQ_H
    29. 

  29. #define _MPQ_H
    30. 

  30. 

  31. #ifdef __cplusplus
    32. 

  32. extern "C" {
    33. 

  33. #endif
    34. 

  34. 

  35. /* generic includes. */
    36. 

  36. #include <stdint.h>
    37. 

  37. #include <sys/types.h>
    38. 

  38. 

  39. #if defined(__GNUC__) && (__GNUC__ >= 4)
    40. 

  40. # define LIBMPQ_API __attribute__((visibility("default")))
    41. 

  41. #else
    42. 

  42. # define LIBMPQ_API
    43. 

  43. #endif
    44. 

  44. 

  45. /* define errors. */
    46. 

  46. #define LIBMPQ_ERROR_OPEN			-1		/* open error on file. */
    47. 

  47. #define LIBMPQ_ERROR_CLOSE			-2		/* close error on file. */
    48. 

  48. #define LIBMPQ_ERROR_SEEK			-3		/* lseek error on file. */
    49. 

  49. #define LIBMPQ_ERROR_READ			-4		/* read error on file. */
    50. 

  50. #define LIBMPQ_ERROR_WRITE			-5		/* write error on file. */
    51. 

  51. #define LIBMPQ_ERROR_MALLOC			-6		/* memory allocation error. */
    52. 

  52. #define LIBMPQ_ERROR_FORMAT			-7		/* format errror. */
    53. 

  53. #define LIBMPQ_ERROR_NOT_INITIALIZED		-8		/* libmpq__init() wasn't called. */
    54. 

  54. #define LIBMPQ_ERROR_SIZE			-9		/* buffer size is to small. */
    55. 

  55. #define LIBMPQ_ERROR_EXIST			-10		/* file or block does not exist in archive. */
    56. 

  56. #define LIBMPQ_ERROR_DECRYPT			-11		/* we don't know the decryption seed. */
    57. 

  57. #define LIBMPQ_ERROR_UNPACK			-12		/* error on unpacking file. */
    58. 

  58. 

  59. /* internal data structure. */
    60. 

  60. typedef struct mpq_archive mpq_archive_s;
    61. 

  61. 

  62. /* file offset data type for API*/
    63. 

  63. typedef int64_t libmpq__off_t;
    64. 

  64. 

  65. /* generic information about library. */
    66. 

  66. extern LIBMPQ_API const char *libmpq__version(void);
    67. 

  67. 

  68. /* generic mpq archive information. */
    69. 

  69. extern LIBMPQ_API int32_t libmpq__archive_open(mpq_archive_s **mpq_archive, const char *mpq_filename, libmpq__off_t archive_offset);
    70. 

  70. extern LIBMPQ_API int32_t libmpq__archive_close(mpq_archive_s *mpq_archive);
    71. 

  71. extern LIBMPQ_API int32_t libmpq__archive_packed_size(mpq_archive_s *mpq_archive, libmpq__off_t *packed_size);
    72. 

  72. extern LIBMPQ_API int32_t libmpq__archive_unpacked_size(mpq_archive_s *mpq_archive, libmpq__off_t *unpacked_size);
    73. 

  73. extern LIBMPQ_API int32_t libmpq__archive_offset(mpq_archive_s *mpq_archive, libmpq__off_t *offset);
    74. 

  74. extern LIBMPQ_API int32_t libmpq__archive_version(mpq_archive_s *mpq_archive, uint32_t *version);
    75. 

  75. extern LIBMPQ_API int32_t libmpq__archive_files(mpq_archive_s *mpq_archive, uint32_t *files);
    76. 

  76. 

  77. /* generic file processing functions. */
    78. 

  78. extern LIBMPQ_API int32_t libmpq__file_packed_size(mpq_archive_s *mpq_archive, uint32_t file_number, libmpq__off_t *packed_size);
    79. 

  79. extern LIBMPQ_API int32_t libmpq__file_unpacked_size(mpq_archive_s *mpq_archive, uint32_t file_number, libmpq__off_t *unpacked_size);
    80. 

  80. extern LIBMPQ_API int32_t libmpq__file_offset(mpq_archive_s *mpq_archive, uint32_t file_number, libmpq__off_t *offset);
    81. 

  81. extern LIBMPQ_API int32_t libmpq__file_blocks(mpq_archive_s *mpq_archive, uint32_t file_number, uint32_t *blocks);
    82. 

  82. extern LIBMPQ_API int32_t libmpq__file_encrypted(mpq_archive_s *mpq_archive, uint32_t file_number, uint32_t *encrypted);
    83. 

  83. extern LIBMPQ_API int32_t libmpq__file_compressed(mpq_archive_s *mpq_archive, uint32_t file_number, uint32_t *compressed);
    84. 

  84. extern LIBMPQ_API int32_t libmpq__file_imploded(mpq_archive_s *mpq_archive, uint32_t file_number, uint32_t *imploded);
    85. 

  85. extern LIBMPQ_API int32_t libmpq__file_number(mpq_archive_s *mpq_archive, const char *filename, uint32_t *number);
    86. 

  86. extern LIBMPQ_API int32_t libmpq__file_read(mpq_archive_s *mpq_archive, uint32_t file_number, uint8_t *out_buf, libmpq__off_t out_size, libmpq__off_t *transferred);
    87. 

  87. 

  88. /* generic block processing functions. */
    89. 

  89. extern LIBMPQ_API int32_t libmpq__block_open_offset(mpq_archive_s *mpq_archive, uint32_t file_number);
    90. 

  90. extern LIBMPQ_API int32_t libmpq__block_close_offset(mpq_archive_s *mpq_archive, uint32_t file_number);
    91. 

  91. extern LIBMPQ_API int32_t libmpq__block_unpacked_size(mpq_archive_s *mpq_archive, uint32_t file_number, uint32_t block_number, libmpq__off_t *unpacked_size);
    92. 

  92. extern LIBMPQ_API int32_t libmpq__block_read(mpq_archive_s *mpq_archive, uint32_t file_number, uint32_t block_number, uint8_t *out_buf, libmpq__off_t out_size, libmpq__off_t *transferred);
    93. 

  93. 

  94. #ifdef __cplusplus
    95. 

  95. }
    96. 

  96. #endif
    97. 

  97. 

  98. #endif						/* _MPQ_H */
    99.