public/sourcepawn/sp_file_headers.h File Reference

Defines the structure present in a SourcePawn compiled binary. More...

#include <stddef.h>

Include dependency graph for sp_file_headers.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	sp_file_section_s
	File section header format. More...
struct	sp_file_hdr_s
	File header format. If compression is 0, then disksize may be 0 to mean that only the imagesize is needed. More...
struct	sp_file_code_s
	File-encoded format of the ".code" section. More...
struct	sp_file_data_s
	File-encoded format of the ".data" section. More...
struct	sp_file_publics_s
	File-encoded format of the ".publics" section. More...
struct	sp_file_natives_s
	File-encoded format of the ".natives" section. More...
struct	sp_file_pubvars_s
	File-encoded format of the ".pubvars" section. More...
struct	sp_file_tag_s
	File-encoded tag info. More...
struct	sp_fdbg_info_s
	File-encoded debug information table. More...
struct	sp_fdbg_file_s
	File-encoded debug file table. More...
struct	sp_fdbg_line_s
	File-encoded debug line table. More...
struct	sp_fdbg_symbol_s
	File-encoded debug symbol information. More...
struct	sp_fdbg_arraydim_s
	File-encoded debug symbol array dimension info. More...
Defines
#define	SPFILE_MAGIC   0x53504646
#define	SPFILE_VERSION   0x0101
#define	SPFILE_COMPRESSION_NONE   0
#define	SPFILE_COMPRESSION_GZ   1
#define	SP_FLAG_DEBUG   (1<<0)
#define	SP_CODEVERS_JIT1   9
#define	SP_CODEVERS_JIT2   10
#define	SP_SYM_VARIABLE   1
#define	SP_SYM_REFERENCE   2
#define	SP_SYM_ARRAY   3
#define	SP_SYM_REFARRAY   4
#define	SP_SYM_FUNCTION   9
Typedefs
typedef unsigned __int64	uint64_t
typedef __int64	int64_t
typedef unsigned __int32	uint32_t
typedef __int32	int32_t
typedef unsigned __int16	uint16_t
typedef __int16	int16_t
typedef unsigned __int8	uint8_t
typedef __int8	int8_t
typedef sp_file_section_s	sp_file_section_t
	File section header format.
typedef sp_file_hdr_s	sp_file_hdr_t
	File header format. If compression is 0, then disksize may be 0 to mean that only the imagesize is needed.
typedef sp_file_code_s	sp_file_code_t
	File-encoded format of the ".code" section.
typedef sp_file_data_s	sp_file_data_t
	File-encoded format of the ".data" section.
typedef sp_file_publics_s	sp_file_publics_t
	File-encoded format of the ".publics" section.
typedef sp_file_natives_s	sp_file_natives_t
	File-encoded format of the ".natives" section.
typedef sp_file_pubvars_s	sp_file_pubvars_t
	File-encoded format of the ".pubvars" section.
typedef sp_file_tag_s	sp_file_tag_t
	File-encoded tag info.
typedef sp_fdbg_info_s	sp_fdbg_info_t
	File-encoded debug information table.
typedef sp_fdbg_file_s	sp_fdbg_file_t
	File-encoded debug file table.
typedef sp_fdbg_line_s	sp_fdbg_line_t
	File-encoded debug line table.
typedef sp_fdbg_symbol_s	sp_fdbg_symbol_t
	File-encoded debug symbol information.
typedef sp_fdbg_arraydim_s	sp_fdbg_arraydim_t
	File-encoded debug symbol array dimension info.
typedef char *	sp_file_nametab_t

---

Detailed Description

Defines the structure present in a SourcePawn compiled binary.

Note: These structures should be 1-byte packed to match the file format.

Definition in file sp_file_headers.h.

---

Define Documentation

#define SPFILE_MAGIC   0x53504646

Source Pawn File Format (SPFF)

Definition at line 59 of file sp_file_headers.h.

#define SPFILE_VERSION   0x0101

Uncompressed bytecode

Definition at line 60 of file sp_file_headers.h.

#define SPFILE_COMPRESSION_NONE   0

No compression in file

Definition at line 70 of file sp_file_headers.h.

#define SPFILE_COMPRESSION_GZ   1

GZ compression

Definition at line 71 of file sp_file_headers.h.

#define SP_FLAG_DEBUG   (1<<0)

Debug information is present in the file

Definition at line 99 of file sp_file_headers.h.

#define SP_CODEVERS_JIT1   9

Code version for JIT1

Definition at line 101 of file sp_file_headers.h.

#define SP_CODEVERS_JIT2   10

Code version for JIT2

Definition at line 102 of file sp_file_headers.h.

#define SP_SYM_VARIABLE   1

Cell that has an address and that can be fetched directly (lvalue)

Definition at line 197 of file sp_file_headers.h.

#define SP_SYM_REFERENCE   2

VARIABLE, but must be dereferenced

Definition at line 198 of file sp_file_headers.h.

#define SP_SYM_ARRAY   3

Symbol is an array

Definition at line 199 of file sp_file_headers.h.

#define SP_SYM_REFARRAY   4

An array passed by reference (i.e. a pointer)

Definition at line 200 of file sp_file_headers.h.

#define SP_SYM_FUNCTION   9

Symbol is a function

Definition at line 201 of file sp_file_headers.h.

---

Typedef Documentation

typedef unsigned __int64 uint64_t

64bit unsigned integer

Definition at line 47 of file sp_file_headers.h.

typedef __int64 int64_t

64bit signed integer

Definition at line 48 of file sp_file_headers.h.

typedef unsigned __int32 uint32_t

32bit unsigned integer

Definition at line 49 of file sp_file_headers.h.

typedef __int32 int32_t

32bit signed integer

Definition at line 50 of file sp_file_headers.h.

typedef unsigned __int16 uint16_t

16bit unsigned integer

Definition at line 51 of file sp_file_headers.h.

typedef __int16 int16_t

16bit signed integer

Definition at line 52 of file sp_file_headers.h.

typedef unsigned __int8 uint8_t

8bit unsigned integer

Definition at line 53 of file sp_file_headers.h.

typedef __int8 int8_t

8bit signed integer

Definition at line 54 of file sp_file_headers.h.

typedef char* sp_file_nametab_t

Typedef for .names table

Definition at line 228 of file sp_file_headers.h.

---