Imported Upstream version 9.20
[platform/upstream/7zip.git] / C / Bra.h
1 /* Bra.h -- Branch converters for executables\r
2 2009-02-07 : Igor Pavlov : Public domain */\r
3 \r
4 #ifndef __BRA_H\r
5 #define __BRA_H\r
6 \r
7 #include "Types.h"\r
8 \r
9 #ifdef __cplusplus\r
10 extern "C" {\r
11 #endif\r
12 \r
13 /*\r
14 These functions convert relative addresses to absolute addresses\r
15 in CALL instructions to increase the compression ratio.\r
16   \r
17   In:\r
18     data     - data buffer\r
19     size     - size of data\r
20     ip       - current virtual Instruction Pinter (IP) value\r
21     state    - state variable for x86 converter\r
22     encoding - 0 (for decoding), 1 (for encoding)\r
23   \r
24   Out:\r
25     state    - state variable for x86 converter\r
26 \r
27   Returns:\r
28     The number of processed bytes. If you call these functions with multiple calls,\r
29     you must start next call with first byte after block of processed bytes.\r
30   \r
31   Type   Endian  Alignment  LookAhead\r
32   \r
33   x86    little      1          4\r
34   ARMT   little      2          2\r
35   ARM    little      4          0\r
36   PPC     big        4          0\r
37   SPARC   big        4          0\r
38   IA64   little     16          0\r
39 \r
40   size must be >= Alignment + LookAhead, if it's not last block.\r
41   If (size < Alignment + LookAhead), converter returns 0.\r
42 \r
43   Example:\r
44 \r
45     UInt32 ip = 0;\r
46     for ()\r
47     {\r
48       ; size must be >= Alignment + LookAhead, if it's not last block\r
49       SizeT processed = Convert(data, size, ip, 1);\r
50       data += processed;\r
51       size -= processed;\r
52       ip += processed;\r
53     }\r
54 */\r
55 \r
56 #define x86_Convert_Init(state) { state = 0; }\r
57 SizeT x86_Convert(Byte *data, SizeT size, UInt32 ip, UInt32 *state, int encoding);\r
58 SizeT ARM_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);\r
59 SizeT ARMT_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);\r
60 SizeT PPC_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);\r
61 SizeT SPARC_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);\r
62 SizeT IA64_Convert(Byte *data, SizeT size, UInt32 ip, int encoding);\r
63 \r
64 #ifdef __cplusplus\r
65 }\r
66 #endif\r
67 \r
68 #endif\r