gs-lang

• GS语言vscode插件，暂时只包含不完整的语法高亮，调试功能，调试堆栈和变量的查看。

Configured

• 通用方式的配置：

      {
          "type": "gsdebug",
          "name": "launch-release",
          "request": "launch",
          "with_debug": false,
          "debug_port": 20001,
          "root_path": "${workspaceFolder}",
          "execute_path": "./bin/cmmshell.exe",
          "command_line": "/r ./ /e main.gs",
          "program": "${command:LaunchRelease}"
      }
  

  • type：配置类型，GsLang的配置类型为gsdebug。
  • name：配置名称，显示在左侧菜单栏的调试列表中。
  • request：请求类型，launch或attach，用于识别启动和附加操作。
  • root_path：根目录，一般为工作目录，${workspaceFolder}表示当前项目的工作目录。
  • program：响应内置预设的操作。

• 启动方式的配置:

      {
          "type": "gsdebug",
          "name": "launch-release",
          "request": "launch",
          "with_debug": false,
          "debug_port": 20001,
          "root_path": "${workspaceFolder}",
          "execute_path": "./bin/cmmshell.exe",
          "command_line": "/r ./ /e main.gs",
          "program": "${command:LaunchRelease}"
      }
  

  • with_debug：launch的启动参数，表示带调试启动和不带调试启动的两种模式。
  • debug_port：提供给Gs的预设的调试端口。
  • execute_path：Gs执行程序的路径，支持完整路径和相对路径。
  • command_line：命令行运行参数。

• 附加方式的配置：

      {
                  "type": "gsdebug",
                  "name": "attach-input",
                  "request": "attach",
                  "debug_port": 20001,
                  "root_path": "${workspaceFolder}",
                  "program": "${command:AttachInput}"
      }
  

  • program：
    • ${command:AttachInput}表示执行输入指定端口号内置程序。
    • ${command:AttachSelect}表示执行通过选择列表选择端口内置程序。

Features

• 提供两种启动方式：带调试启动和不带调试启动。
  • 两种启动方式都会在运行参数后面加上--enable-debugger 端口号::是否等待调试，确保开启Gs的调试功能。
    • 端口号为指定的话，默认端口为20001。
    • 如果指定的端口号被占用，Gs会重新分配，直到获得一个唯一的监听端口。
  • 两种方式的区别:
    • 带调试启动：启动时会根据VsCode上已设置的断点进行暂停。
    • 不带调试启动：启动时脱离VsCode执行，可以通过attach方式进行附加到Gs进程中。
• 提供两种附加方式：输入指定端口号和通过选择列表选择端口
  • 输入指定端口号：
    • 在开启Gs调试功能后，Gs会分配一个用于调试的唯一端口，可通过该端口号attach到Gs进程中。
    • 查看Gs的调试的端口，可以在Gs中输入'get_env("debug_port")获得调试端口。
  • 通过列表选择端口：
    • 启动调试功能的Gs都会在个人文件夹下创建gslang_debug的目录，用于记录此次启动调试功能的相关信息（进程号，端口号等.）。
    • VsCode通过遍历个人文件夹/gslang_debug/*中的文件，从而获取所有已启动的调试端口。
    • 用户可以通过选择启动的调试端口进行附加到Gs进程中。
• 调试堆栈和变量的查看：
  • 在VsCode处于调试状态时才可以进行查看操作。
  • 调用堆栈的查看：
    • 在左侧菜单栏的调用堆栈中显示协程列表，并且显示当前暂停的协程的调用堆栈。
    • 可以通过点击调用堆栈进行切换当前堆栈信息。
  • 变量的查看：
    • 在左侧菜单栏的变量显示当前执行协程的相关信息。
    • 支持鼠标悬浮在变量上方时，能进行变量查看。
    • 支持层级展示map和array的数据结构。

Requirements

• 如果要进行Attach操作:
  • 要求Gs的版本大于0.1.190220.01。
  • 在运行程序前，需要在运行参数加上--enable-debugger 端口号::是否等待调试的命令。

Coding Standard

• 目录名：全部小写，单词之间用_隔开。
• 文件名：全部小写，单词之间用_隔开。
• 类名：首字母大写，单词之间无间隔符号。
• 接口：同类名。
• 函数：除第一个单词的首字母小写外，后续单词首字母大写，单词之间无间隔符号。
• 变量：
  • 局部变量：全部小写，单词自己用空格隔开。
  • 全局变量：同局部变量。
  • 常量：全部大写，单词之间用空格隔开。
  • 私有变量：同局部变量，但需要加前缀下划线'_'。

Extension Settings

• TODO

Known Issues

• 在VsCode处于调试状态时，mount目录的文件无法设置断点，但可以被断下来和执行其他调试操作。
  • 设置断点时，由于无法转换mount目录的文件路径，会向Gs发送文件的绝对路径。
  • 而Gs收到文件的绝对路径，无法识别准确识别，导致该断点的设置被否决。

Release Notes

• TODO