Skip to content

Documentation

Jaeyong Sung edited this page Mar 26, 2020 · 7 revisions

This tool contains all the tools for developing in hyeo-ung programming language.

hyeong build FILE.hyeong

hyeong-build
Compiles hyeong code

USAGE:
    hyeong build [FLAGS] [OPTIONS] <FILE.hyeong>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
        --verbose    verbose output

OPTIONS:
        --build-path <build-path>    set temporary build path
        --color <color>              whether prints color [default: auto]  [possible values: never, auto, always]
    -O, --optimize <optimize>        optimize level [default: 2]  [possible values: 0, 1, 2]
    -o, --output <output>            binary output file (filename by default)

ARGS:
    <FILE.hyeong>    input file to compile

Builds FILE into binary (or exe). Extension of FILE has to be .hyeong.

How it works?

It makes rust code with hyeong code. Then, it compiles with cargo to make binary.

hyeong check FILE.hyeong

hyeong-check
Parse your code and check if you are right

USAGE:
    hyeong check [FLAGS] [OPTIONS] <FILE.hyeong>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
        --verbose    verbose output

OPTIONS:
        --color <color>    whether prints color [default: auto]  [possible values: never, auto, always]

ARGS:
    <FILE.hyeong>    input file to compile

This parses the code of FILE and prints the result in better format. This feature can be used in checking typos.

hyeong debug FILE.hyeong

hyeong-debug
Debug your code command by command

USAGE:
    hyeong debug [FLAGS] [OPTIONS] <FILE.hyeong>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
        --verbose    verbose output

OPTIONS:
        --color <color>    whether prints color [default: auto]  [possible values: never, auto, always]

ARGS:
    <FILE.hyeong>    input file to compile

This is the debugger for hyeong. Writing hyeong code is difficult... So, we made a debugger that has huge features.

[b] break       show breakpoints
[b] break NUM   set/unset breakpoint on NUM
exit            Exit debugger
[h] help        Print this
[n] next        goto next command
[s] state       print state status
[p] previous    move to previous state
[r] run         run until breakpoint

These are the features for the debugger. It can be used as typing one of the commands above. All of the commands have shorten way to type except exit. Hope you use well!

hyeong run FILE.hyeong

hyeong-run
Run hyeong code directly

USAGE:
    hyeong run [FLAGS] [OPTIONS] <FILE.hyeong>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
        --verbose    verbose output

OPTIONS:
        --color <color>          whether prints color [default: auto]  [possible values: never, auto, always]
    -O, --optimize <optimize>    optimize level [default: 2]  [possible values: 0, 1, 2]

ARGS:
    <FILE.hyeong>    input file to compile

This runs the hyeong code directly. It can be used when you don't want to make binary.

hyeong (interpreter)

This is the hyeong interpreter. It would print stdout and stderr separately for you.

hyeong install and hyeong uninstall

This installs (or make cargo dir) to fully operate build command. build would build the cargo project with pre-made dir. If you don't want to use build, you don't have to run these commands.

When uninstall, it just removes the dir.