ZINC (stands for "ZINC Is a Nice Compiler") is a transcompiler that converts some of the BASIC programming language syntax into C++.
flowchart LR
input[/BASIC File/] --> lexer["Lexer"]
subgraph Transcompiler
lexer --> tokens[/Tokens/]
tokens --> parser["Parser"]
parser --> ast[/AST/]
ast --> emitter["Emitter"]
end
emitter --> output[/C++ File/]
output --> compiler["C++ Compiler"]
compiler --> executable[/Executable/]
click lexer "https://github.com/AhmedYasser5/ZINC/blob/main/include/lexer.hpp"
click parser "https://github.com/AhmedYasser5/ZINC/blob/main/include/parser.hpp"
click emitter "https://github.com/AhmedYasser5/ZINC/blob/main/include/emitter.hpp"
click compiler "https://github.com/AhmedYasser5/ZINC/blob/main/run.sh"
As shown in the flowchart, the transcompiler has
The extracted tokens are then passed to the parser which converts sequence of tokens into an AST (Abstract Syntax Tree). It also checks for some syntax errors before passing the tree to the next stage.
The final stage is the emitter which takes in complete statements and emits their corresponding C++ statements. The final output is saved to a file with the same name as the input file with ".cpp" extension.
Finally, if the provided script was used, the output file would be formatted using clang-format, compiled using make, and run eventually.
To compile and run the compiler, just use the script as follows:
$ ./run.sh -r -- <filepath>The following operators are supported :
- Greater than or equal
>= - Equal equal
== - Equal
= - Greater than
> - Less than
< - Less than or equal
<= - Not equal
!= - Addition(Plus)
+ - Subtraction(Minus)
- - Division(Slash)
/ - Multiplication(Asterisk)
*
# write your comment like this :D
# one line after the other
for printing strings , literals or variables.
examples:
PRINT 13
PRINT "HELLO WORLD!"
to denote an expression whether it involves defining a variable , assignment or a mathematical expression.
LET a = 12
LET b = a + 1
LET c = a + b
PRINT a
PRINT b
PRINT c
Strings and string assignment are not supported yet
Something likeLET A = "Hello there"will not work
accept input from the user into a variable, the INPUTcommand also handles variable definition for you.
PRINT "Please enter a number :"
INPUT a
PRINT "the number you entered is : "
PRINT a
#Simple conditional program
PRINT "Please enter a number"
INPUT A
IF A >= 0 THEN
PRINT "The number you entered is positive"
ENDIF
# with else added
PRINT "Please enter a number"
INPUT A
IF A > 0 THEN
PRINT "The number you entered is positive"
ELSE
PRINT "The number you entered is negative"
ENDIF
# with else if added
PRINT "Please enter a number"
INPUT A
IF A > 0 THEN
PRINT "The number you entered is positive"
ELSEIF A < 0 THEN
PRINT "The number you entered is negative"
ELSE
PRINT "The number you entered is Zero"
ENDIF
# calculating the sum from 1 till 10
LET A = 1
LET SUM = 0
WHILE A <= 10 REPEAT
LET SUM = SUM + A
LET A = A + 1
ENDWHILE
PRINT "The sum is "
PRINT SUM
LABEL identifies a location within source code that GOTO can jump to.
# a program that won't print anything when 0 is entered
PRINT "Please enter any number other than zero"
INPUT num
IF num == 0 THEN
GOTO END
ENDIF
# If the num is Zero
# this line will be skipped because of GOTO
PRINT "The number is not Zero"
LABEL END
Please note that you shouldn't have any variable definitions that
GOTOcan jump over, otherwise an error will be raised by the compiler
More examples are available in the repository , feel free to play around and give them a try :D.