lci - LOLCODE 解释器技术文档

1. 安装指南

1.1 系统要求

• CMake：必须安装 CMake（版本要求未明确，建议使用最新版本）。
  • 在 Linux 发行版中，通常可以通过包管理器安装 CMake。
• Python：需要 Python 2.7 或更高版本，且需安装 argparse 模块。

1.2 安装步骤

1.2.1 Linux 或 macOS 上的简易安装

1. 运行 install.py 脚本。
   • 使用 ./install.py -h 可以查看相关的安装选项。
   • 例如，如果你想将 lci 安装到 /home/kurtis/opt 目录，可以运行：

     ./install.py --prefix="/home/kurtis/opt"
     

1.2.2 Linux 或 macOS 上的详细安装

1. 使用 CMake 配置 lci：

   • 打开终端，导航到包含 lci 的目录，然后运行：

     cmake .
     

   • 如果需要启用内存测试，可以运行：

     cmake -DPERFORM_MEM_TESTS:BOOL=ON .
     

   • 也可以使用 ccmake 命令或 CMake GUI 进行配置。

2. 构建项目：

   make
   

3. 安装：

   make install
   

4. （可选）生成文档：

   make docs
   

5. （可选）运行测试：

   ctest
   

1.2.3 Windows 上的安装

1. 将 MinGW 和 Python 添加到系统 PATH 中：

   • 打开“计算机”属性，进入“高级系统设置” > “环境变量”。
   • 编辑 PATH 变量，添加 ;C:\MinGW\bin;C:\Python32。

2. 以管理员身份打开命令提示符。

3. 导航到项目目录，例如：

   cd C:\Users\%user%\Documents\lci
   

4. 运行 install.py 脚本：

   • 使用 install.py -h 可以查看相关的安装选项。
   • 例如，如果你想将 lci 安装到 C:\Program Files\lci 目录，可以运行：

     install.py --prefix="C:/Program Files/lci"
     

2. 项目使用说明

2.1 概述

lci 是一个用 C 语言编写的 LOLCODE 解释器，旨在正确、便携、快速且精确地文档化。它遵循 LOLCODE 语言规范，并提供了丰富的功能，包括标准库、网络支持、字符串处理等。

2.2 使用方法

• 解释器运行：安装完成后，可以直接运行 lci 解释器来执行 LOLCODE 脚本。
• 单元测试：项目附带了单元测试，可以通过 ctest 命令运行这些测试，以验证解释器的正确性。

3. 项目 API 使用文档

3.1 标准库

• CAN HAS STDIO?：提供标准输入输出功能。
• CAN HAS SOCKS?：提供网络功能。
• CAN HAS STRING?：提供字符串处理功能。

3.2 自定义功能

• 开发者可以通过扩展 lci 的源码来添加自定义功能，具体方法可以参考项目的 Doxygen 生成的文档。

4. 项目安装方式

4.1 简易安装

• 使用 install.py 脚本进行快速安装。

4.2 详细安装

• 使用 CMake 进行配置、构建和安装。

4.3 Windows 安装

• 在 Windows 上，需要手动配置环境变量并使用管理员权限运行安装脚本。

---

通过以上文档，用户可以顺利安装并使用 lci 解释器，同时了解如何通过 API 扩展其功能。