qi

[![代码行数][loc-shield]][loc-url] [![许可证][license-shield]][license-url] [![网站][website-shield]][website-url] [![大小][size-shield]][size-url]

<!-- 项目标志 --> <br /> <div align="center"> <a href="https://github.com/anonymousaaardvark/qi"> <img src="https://yellow-cdn.veclightyear.com/0a4dffa0/dfda274c-85dd-44b8-b945-2e34f73c8e75.png" alt="标志" width="80" height="80"> </a> <h2 align="center">气 (Qi) 语言</h3> <p align="center"> 气是一种轻量级、快速且开源的中文编程语言。 <br /> <a href="https://qilang.tk"><strong>qilang.tk »</strong></a> <br /><br /> English | <a href="https://github.com/AnonymousAAArdvark/qi/blob/master/README.zh.md">中文</a> </p> </div>

![背景][background-img]

<!-- 关于项目 -->

关于

在阅读了一篇关于如何创建编程语言的文章后，我受到启发，决定自己创建一个解释器。我研究了几种语言的实现方式，发现它们都是基于英语的。我想创建一种基于"外国"自然语言（如中文）的编程语言，看看它可能会带来什么缺点。我首先参考了网上发布的各种资源（尤其是Crafting Interpreters），然后慢慢开始主要靠自己实现概念。事实证明，从头开始创建一种编程语言是相当困难的，但这正是让它变得有趣的原因。

为什么叫它气？ 气源自汉字"气"的拼音，英文意为"air"。我希望这种语言快速轻便，同时完全透明，就像空气一样！

打印行（"你好，世界"）

特点

• 气是<ins>基于中文的</ins>。我们说英语的人常常不会意识到，我们学习的编程语言都是基于我们已经精通的母语。一个以英语为母语的人可以通过阅读关键词（"if"、"int"、"while"等）合理推断一段Python代码的作用。使这种语言基于外语可以让编程对全球更多人来说更容易理解。

• 气是<ins>快速的</ins>。气利用单次编译器编译为高效的字节码，运行速度极快。加上各种优化，如Nan Boxing和哈希表探测，气的速度可以与竞争对手的动态语言相媲美。

• 气是<ins>轻量的</ins>。整个项目不到5000行代码，一天内就可以阅读完。虽然代码简短，但一切都格式良好，易于理解。最终的可执行文件只有约140 kb大小，让你几乎可以在任何设备上运行它。

• 气是<ins>面向对象的</ins>。以类为中心，面向对象编程通过抽象和封装等概念提供了一个清晰的模块化结构，在处理复杂性方面明显优于函数式编程。

性能

虽然几个基准测试并不能很好地判断性能，但它们看起来还是很酷的...所以这里有几个。

每个基准测试运行5次，取每种语言的平均时间。

![性能图表][performance-img]

这些测试是在我的2017款MacBook Air上运行的，配备双核i5 CPU和8 GB RAM。

基准测试的代码可以在测试文件夹中找到。

<!-- 快速开始 -->

快速开始

先决条件

• make
  • macOS

    brew install make

  • Windows

    choco install make

  • Linux
    • 应该已内置在系统中

安装

1. 克隆或下载git仓库的zip文件。
2. 打开终端，并 cd 到 /src/cmake-build-release
3. 运行 make。
4. 完成！

单元测试

单元测试对于编程语言来说非常重要，因此我包含了一个完整的气测试套件，以确保解释器的每个方面都能按预期工作。测试程序可以在 /test 目录这里找到。为了自动化测试过程，这里提供的Go程序 /utils/test.go 使用输入的解释器运行每个测试程序，捕获输出，并验证结果。

运行测试程序

要运行测试，你需要在系统上安装Go。从这里下载并安装它。

执行Go程序非常简单。只需运行 go run test.go 并将所需解释器的路径传递给 -interpreter= 参数。

go run test.go -interpreter=这里是解释器路径

如果你忘记实现取反运算符，测试程序的输出如下：

$ go run test.go -interpreter=路径
FAIL ../test/array/indexing.qi
     Expected output '假' on line 7 and got 'b'.
FAIL ../test/array/methods.qi
     Expected output '【零，1，2，3】' on line 9 and got '【零，2，3，4】'.
FAIL ../test/for/scope.qi
     Expected output '-1' on line 10 and got '1'.
FAIL ../test/number/literals.qi
     Expected output '-0' on line 4 and got '0'.
     Expected output '-0.001' on line 7 and got '0.001'.
FAIL ../test/operator/negate.qi
     Expected output '-3' on line 1 and got '3'.
FAIL ../test/string/indexing.qi
     Expected output 'g' on line 7 and got 't'.
268 tests passed. 6 tests failed.
exit status 1

如果所有测试都通过，输出如下：

$ go run test.go -interpreter=路径
All 274 tests passed (641 expectations).

语法

快速开始页面是安装和设置语言的很好指南。

有关代码示例，请参阅测试。

要更深入地了解气，请查看语言指南。

<!-- 路线图 -->

路线图

• 类
• 继承
• 列表
• 自增/自减运算符
• Switch/Case 语句
• 优化
• 将所有内容翻译成中文
• 制作logo
• 完成Readme
• 将Readme翻译成中文
• 创建网站
  • 首页
  • 快速入门
  • 语言指南
• 转义序列
• 位运算符
• 移除分号
• 支持科学记数法、二进制等数字
• 更多字符串方法
• 更多列表方法
• 模块系统

<!-- 贡献 -->

贡献

贡献是使开源社区成为一个如此令人惊叹的学习、启发和创造的地方的原因。我们非常感谢您做出的任何贡献。

如果您有建议可以使这个项目更好，请fork仓库并创建一个pull request。您也可以简单地打开一个带有"enhancement"标签的issue。 别忘了给项目点个星！再次感谢！

1. Fork项目
2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
3. 提交您的更改 (git commit -m '添加一些很棒的特性')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 打开一个Pull Request

<!-- 许可证 -->

许可证

根据MIT许可证分发。有关更多信息，请参阅 LICENSE.txt。

<!-- 联系方式 -->

联系方式

Andrew Yang - @anonymousaaardvark - andrewhuiyang0830@gmail.com

项目链接：https://github.com/anonymousaaardvark/qi

<!-- 致谢 -->

致谢

• Crafting Interpreters
• Gravity
• Loxido