Language: (English | 中文简体)

My programming exerise: a simple Brainfuck language (hereinafter referred to as "BF") simulator, written in ANSI C (C89).

(BF's wiki page: Wikipedia | Baidu Baike (in Chinese))

Some interfaces and some documents are modeled after repository benhoyt/inih.

Interface is as below:

typedef unsigned char bf_byte_t;
typedef int (*bf_reader_t)(void *stream);
typedef int (*bf_handler_t)(int b, void *stream);
typedef struct {
    bf_byte_t        *current;
    const bf_byte_t  *begin;
    const bf_byte_t  *end;  /* past-the-end */
} bf_s;

int bf_init(bf_s *ths, bf_byte_t *begin, bf_byte_t *end);

void bf_show_nearby_memory(const bf_s *ths, size_t on_the_left,
    size_t on_the_right);

int bf_run_filename(bf_s *ths, const char *command,
    const char *filename, bf_handler_t handler, void *out_stream);

int bf_run_file(bf_s *ths, const char *command, FILE *in_file,
    bf_handler_t handler, void *out_stream);

int bf_run_memory(bf_s *ths, const char *command, const bf_byte_t *mem,
    size_t mem_size, bf_handler_t handler, void *out_stream);

int bf_run_stream(bf_s *ths, const char *command, bf_reader_t reader,
    void *in_stream, bf_handler_t handler, void *out_stream);

bf_s is a class. Functions bf_run_*() and bf_show_nearby_memory() are member functions (methods).

Funtions bf_run_*() interpret and execute BF code, which is passed as string:

• Functions bf_run_filename() and bf_run_file() get in-stream from file.
• Function bf_run_memory() get in-stream from an array in memory.
• Function bf_run_stream() enables user to customize input method. It is the most general one. The first three are implemented through it.

Each time a command . (output command in BF) is executed, call the callback function (*handler)(), with arguments: byte currently pointed to by the data pointer and out_stream.

bf_show_nearby_memory() function is used for visualization, showing the data around the current data pointer.

For detailed documentation, see the comments in the function prototypes and typedefs in the header file .

library:

• bf.c

interpreter:

• library
• bf_repl.c

if you only compile bf.c and bf_repl.c together, you get an interpreter.

You can also ignore bf_repl.c and include bf.h in your own code, and use the code here as library.

This interpreter is a programming exercise I made myself half a year after I learned C language (which is, written in 2022-12-05). I also made a video and posted it on Bilibili (a Chinese video website) that time:

(Video) (for source code, see introduction) An overly simple Brainfuck interpreter (in Chinese)

Now (2024-12-18), I imitated benhoyt/inih and made changes to my code, and then posted it here (GitHub).

The code style basically follows Nginx style.

Open source licence: BSD-3-Clause.