Relicensing TinyCC
[tinycc.git] / libtcc.h
blobe69cc6b3f6b7822b71a34c88cbbef095c83f6486
1 #ifndef LIBTCC_H
2 #define LIBTCC_H
4 #ifndef LIBTCCAPI
5 # define LIBTCCAPI
6 #endif
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
12 struct TCCState;
14 typedef struct TCCState TCCState;
16 /* create a new TCC compilation context */
17 LIBTCCAPI TCCState *tcc_new(void);
19 /* free a TCC compilation context */
20 LIBTCCAPI void tcc_delete(TCCState *s);
22 /* set CONFIG_TCCDIR at runtime */
23 LIBTCCAPI void tcc_set_lib_path(TCCState *s, const char *path);
25 /* set error/warning display callback */
26 LIBTCCAPI void tcc_set_error_func(TCCState *s, void *error_opaque,
27 void (*error_func)(void *opaque, const char *msg));
29 /* set options as from command line (multiple supported) */
30 LIBTCCAPI int tcc_set_options(TCCState *s, const char *str);
32 /*****************************/
33 /* preprocessor */
35 /* add include path */
36 LIBTCCAPI int tcc_add_include_path(TCCState *s, const char *pathname);
38 /* add in system include path */
39 LIBTCCAPI int tcc_add_sysinclude_path(TCCState *s, const char *pathname);
41 /* define preprocessor symbol 'sym'. Can put optional value */
42 LIBTCCAPI void tcc_define_symbol(TCCState *s, const char *sym, const char *value);
44 /* undefine preprocess symbol 'sym' */
45 LIBTCCAPI void tcc_undefine_symbol(TCCState *s, const char *sym);
47 /*****************************/
48 /* compiling */
50 /* add a file (C file, dll, object, library, ld script). Return -1 if error. */
51 LIBTCCAPI int tcc_add_file(TCCState *s, const char *filename);
53 /* compile a string containing a C source. Return -1 if error. */
54 LIBTCCAPI int tcc_compile_string(TCCState *s, const char *buf);
56 /*****************************/
57 /* linking commands */
59 /* set output type. MUST BE CALLED before any compilation */
60 LIBTCCAPI int tcc_set_output_type(TCCState *s, int output_type);
61 #define TCC_OUTPUT_MEMORY 0 /* output will be run in memory (default) */
62 #define TCC_OUTPUT_EXE 1 /* executable file */
63 #define TCC_OUTPUT_DLL 2 /* dynamic library */
64 #define TCC_OUTPUT_OBJ 3 /* object file */
65 #define TCC_OUTPUT_PREPROCESS 4 /* only preprocess (used internally) */
67 /* equivalent to -Lpath option */
68 LIBTCCAPI int tcc_add_library_path(TCCState *s, const char *pathname);
70 /* the library name is the same as the argument of the '-l' option */
71 LIBTCCAPI int tcc_add_library(TCCState *s, const char *libraryname);
73 /* add a symbol to the compiled program */
74 LIBTCCAPI int tcc_add_symbol(TCCState *s, const char *name, const void *val);
76 /* output an executable, library or object file. DO NOT call
77 tcc_relocate() before. */
78 LIBTCCAPI int tcc_output_file(TCCState *s, const char *filename);
80 /* link and run main() function and return its value. DO NOT call
81 tcc_relocate() before. */
82 LIBTCCAPI int tcc_run(TCCState *s, int argc, char **argv);
84 /* do all relocations (needed before using tcc_get_symbol()) */
85 LIBTCCAPI int tcc_relocate(TCCState *s1, void *ptr);
86 /* possible values for 'ptr':
87 - TCC_RELOCATE_AUTO : Allocate and manage memory internally
88 - NULL : return required memory size for the step below
89 - memory address : copy code to memory passed by the caller
90 returns -1 if error. */
91 #define TCC_RELOCATE_AUTO (void*)1
93 /* return symbol value or NULL if not found */
94 LIBTCCAPI void *tcc_get_symbol(TCCState *s, const char *name);
96 #ifdef __cplusplus
98 #endif
100 #endif