add programmatic language support

outline,hover,jump2definition
Merge branch 'next' into master

Author: xsro

CHANGELOG.md

@@ -8,6 +8,23 @@ All notable changes to the "masm-tasm" extension will be documented in this file
 - [ ] 问题匹配功能完善
 - [ ] hover的简单实现:如中断的简单信息
 - [ ] LSP和DAP支持（目前对我来说太难了）
+- [ ] 根据具体的AH值显示跳转到不同的信息
+
+### 0.1.5
+
+- [x] DOS 汇编基本的语法支持
+- [x] vscode 界面的大纲视图的简单实现
+
+汇编语言支持的symbol大概有以下几种，但是vscode的[SymbolKind](https://code.visualstudio.com/api/references/vscode-api#SymbolKind)却与它们不对应，我决定做以下对应
+
+|assembly symbol|vscode symbol|
+|---|---|
+|macro|Module|
+|segment|Class|
+|procedure|Function|
+|struct|Struct|
+|label|Key|
+|variable|Variable|
 
 ### 0.1.4
 

README.md

@@ -1,24 +1,23 @@
-# run and debug TASM and MASM via dosbox(and msdos-player)
+# DOS assembly (MASM/TASM) via DOSBox(and msdos-player)
 
 [中文](https://github.com/xsro/masm-tasm/blob/master/doc/README_zh.md)
 
-This extension is modified from "[masm-code](https://github.com/Woodykaixa/masm-code)", focusing on the interaction with DOS emulator (DOSBox and msdos-player). It is helpful for you to study MASM, TASM and also the course <*principles& peripheral technology of microprocessor*>.
+Language support for DOS assembly,suitable for studying MASM/TASM and the course <*principles& peripheral technology of microprocessor*>.
 
-- Support both **TASM and MASM**: you can choose MASM or TASM in the preference
-- **Editor Menu**: run and debug with right click on the VSCode editor panel
-- **Convenient**: related tools packaged in the extension. Just install and right click (recommand to use this ext in windows otherwise you should install dosbox first)
+- Offer *grammar*,basic *outline* view and *hover* support for DOS assembly language
+- Support both **TASM and MASM** assembler tools: choose MASM or TASM in the preference
+- In **Editor Menu**: run and debug assembly with right click on the VSCode editor panel
+- **Convenient**: related tools packaged in the extension. Just install and right click
 - **Diagnose**: process the output of ASM tools and ouput them in VSCode
-- Welcome [issue](https://github.com/xsro/masm-tasm/issues) and PR to build a better extension with your help.
-- Some interesting code your may need:[masm-tasm wiki](https://github.com/xsro/masm-tasm/wiki/dosbox)
+- **Note**: Currently not support multi files assembly
 
-Thanks to [Roncho](https://marketplace.visualstudio.com/publishers/Roncho)'s extension [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086). This extension now support assembly language using codes from  it.
-Also, this extension may also work with extensions like: [MASM](https://marketplace.visualstudio.com/items?itemName=bltg-team.masm)、[masm-code](https://marketplace.visualstudio.com/items?itemName=kaixa.masm-code)、[x86 and x86_64 Assembly](https://marketplace.visualstudio.com/items?itemName=13xforever.language-x86-64-assembly)
+Thanks to [Roncho](https://marketplace.visualstudio.com/publishers/Roncho) 's extension [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086) and [Woodykaixa](https://github.com/Woodykaixa)'s [masm-code](https://github.com/Woodykaixa/masm-code). Welcome [issue](https://github.com/xsro/masm-tasm/issues) and PR to build a better extension with your help.Here are some interesting code I use:[masm-tasm wiki](https://github.com/xsro/masm-tasm/wiki/dosbox)
 
 ## Features
 
-when your are editing `.asm(.ASM)` files ,you can right click at the editor panel,then you will see several choices listed below:
+when you are editing `assembly` files ,you can right click at the editor panel,then you will see several choices listed below:
 
-1. "Open dosbox": Open the dosbox. Copy current file to workspace as `D:\T.asm` in DOSBox. You can use command like `tasm T.asm` .[more info](https://github.com/xsro/masm-tasm/blob/master/doc/ASM_commands.md)
+1. "Open dosbox": Open the dosbox, prepare the environment(copy file to dosbox's D:\ and add tools to path),[more info](https://github.com/xsro/masm-tasm/blob/master/doc/ASM_commands.md)
 2. "Run ASM code": Compile and Run the program
 3. "Debug ASM code": Compile and Debug the program
 
@@ -40,12 +39,41 @@ your file will be copied as `D:\T.ASM` in DOSBox. (The extension will copy your
 
 ![diagnose](https://github.com/xsro/masm-tasm/raw/master/pics/demo_diagnose_tasm.gif)
 
+## Extension Settings
+
+for more,please see the `preference->settings`
+
+- `masmtasm.ASM.MASMorTASM` use `MASM` or `TASM` assembler in DOS emulator to run and debug assembly
+- `masmtasm.ASM.emulator` use dosbox or msdos-player as DOS emulator,defalut is DOSBox
+  - `DOSBox` more stable
+  - `msdos-player`quiet, it runs in command prompt(CMD).  So it cannot support GUI like `TD.exe`
+  - `auto` auto select
+    1. use msdos-player to compile and link
+    2. use DOSBox to run
+    3. use msdos-player for MASM(debug)
+    4. use DOSBox for TASM(TD)
+- `masmtasm.ASM.savefirst`  save file first before using
+- `masmtasm.ASM.toolspath` custom path of your ASM tools. [more info](#about-tools)
+- `masmtasm.dosbox.CustomResolution`: size(resolution) of the dosbox window,for example `1024x960`
+
+### About Tools
+
+The assembler MASM and TASM can only run in 16-bit environment. So the extension use DOSBox and MSDOS-player to emulate the 16-bit environment.
+the extension has built in tools for windows. But if you need to use assembler or emulator of different version. You can oragnize your tools follow the structure bellow and add the you folder's path to  `masmtasm.ASM.toolspath`
+
+- tools:your tools folder name, you can add the path of it to settings `masmtasm.ASM.toolspath`
+  1. `TASM`: TASM tools including `tasm.exe`,`tlink.exe`,`td.exe`
+  2. `MASM`: MASM tools including `masm.exe`,`link.exe`,`debug.exe`
+  3. `dosbox`: dosbox.exe and related files
+  4. `player`: msdos.exe
+
+Linux and other OS user do not need folder dosbox and player. Instead, we should make sure DOSBox can be opened by shell command `dosbox` (node: child_process.exec("dosbox"))
+
 ## Docs & Thanks & Licenses
 
 - this extension is [MIT license](https://github.com/xsro/masm-tasm/blob/master/LICENSE).
-  - thanks for [masm-code](https://github.com/Woodykaixa/masm-code),[msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com)
-  - their [info and licences](https://github.com/xsro/masm-tasm/blob/master/doc/license_and_info.md)
-- [about the tools](https://github.com/xsro/masm-tasm/blob/master/doc/Toolspath.md)
+- thanks for [Roncho](https://marketplace.visualstudio.com/publishers/Roncho)'s [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086),[Woodykaixa](https://github.com/Woodykaixa)'s [masm-code](https://github.com/Woodykaixa/masm-code),[msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com)
+- [about the assembly and emulator tools](https://github.com/xsro/masm-tasm/blob/master/doc/Toolspath.md)
 - [some infomation :wiki](https://github.com/xsro/masm-tasm/wiki)
 
 Enjoy!:smile:

doc/README_zh.md

@@ -5,21 +5,21 @@
 1. 同时支持调用**TASM**和**MASM**: 可以在设置（首选项）中修改使用MASM还是TASM工具集
 2. 提供编辑器**右键菜单**：在汇编语言的编辑器添加了“打开dosbox，运行，调试”的三个选项
 3. 提供diagnose**问题输出**功能：假如汇编未通过，会标明错误信息与位置，可以在命令面板输入`清除MASM/TASM的所有问题信息`清除本插件输出的diagnose问题信息
-4. 调用[dosbox](https://www.dosbox.com)和[msdos player](http://takeda-toshiya.my.coocan.jp/msdos)模拟16位系统环境，运行相关组件
-5. 通过 [Roncho](https://marketplace.visualstudio.com/publishers/Roncho)'s extension [Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086)的代码来实现语法支持
+4. 提供悬浮提示，跳转定义
+5. 调用[dosbox](https://www.dosbox.com)和[msdos player](http://takeda-toshiya.my.coocan.jp/msdos)模拟16位系统环境，运行相关组件
 
-非常感谢以上软件！插件难免会有一些bug，欢迎到github发[issue](https://github.com/xsro/masm-tasm/issues)以及PR，大家一起交流和完善。
+非常感谢[Roncho](https://marketplace.visualstudio.com/publishers/Roncho)的[Assembly (TASM)](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086)和[Woodykaixa](https://github.com/Woodykaixa)的 [masm-code](https://github.com/Woodykaixa/masm-code)！插件难免会有一些bug，欢迎到github发[issue](https://github.com/xsro/masm-tasm/issues)以及PR，大家一起交流和完善。
 
 ## 安装使用
 
 - windows 无需其他操作，相关软件已打包在插件之中
-- linux 请先安装dosbox [详情](https://github.com/xsro/masm-tasm/blob/master/doc/Get_start.md#linux)
+- linux 请先安装dosbox [详情](doc/Get_start.md#linux)
 
 ## Features主要功能
 
 当编辑器为汇编文件时，在编辑器界面右键菜单中会提供以下三个选项：
 
-1. 打开dosbox并配置环境(挂载)：打开DOSBox，然后就可以手动在打开的DOSBox窗口进行[汇编相关操作](https://github.com/xsro/masm-tasm/blob/master/doc/ASM_commands.md)
+1. 打开dosbox并配置环境(挂载)：打开DOSBox，然后就可以手动在打开的DOSBox窗口进行[汇编相关操作](doc/ASM_commands.md)
 2. 运行当前程序(汇编+链接+运行)：生成exe程序并运行
 3. 调试当前程序(汇编+链接+调试)：生成exe程序并调试，使用MASM则会调用debug调试，使用TASM会调用td调试
 
@@ -43,7 +43,6 @@
 
 ## Some Tips 一些相关信息
 
-- 这个插件专注于汇编的编译运行调试环节，推荐结合汇编语法支持（高亮、代码片段等）的插件一起使用，如：[MASM](https://marketplace.visualstudio.com/items?itemName=bltg-team.masm)、[TASM](https://marketplace.visualstudio.com/items?itemName=Roncho.assembly-8086)、[masm-code](https://marketplace.visualstudio.com/items?itemName=kaixa.masm-code)、[x86 and x86_64 Assembly](https://marketplace.visualstudio.com/items?itemName=13xforever.language-x86-64-assembly)等。
 - 一些有趣的汇编代码: [dosbox codes](https://github.com/xsro/masm-tasm/wiki/dosbox#写代码)
 - 使用终端任务调用dosbox：[VSC-ASMtasks](https://github.com/xsro/VSC-ASMtasks)
 
@@ -63,13 +62,13 @@
 - 调整dosbox窗口大小
 - 规定dosbox运行程序之后进行什么操作（是否直接退出程序，还是等待）
 - 启动相关功能之前是否先保存文件（不保存的话，只能操作之前保存的版本，建议保存）
-- 设置自定义汇编工具路径,详见:[自定义汇编工具路径](https://github.com/xsro/masm-tasm/blob/master/doc/Toolspath.md#自定义汇编工具路径)
+- 设置自定义汇编工具路径,详见:[自定义汇编工具路径](doc/Toolspath.md#自定义汇编工具路径)
 
 ### 文档 & 感谢 & 许可
 
-- 这个插件是[MIT license](https://github.com/xsro/masm-tasm/blob/master/LICENSE).
+- 这个插件是[MIT license](LICENSE).
 - 感谢[masm-code](https://github.com/Woodykaixa/masm-code),[msdos player](http://takeda-toshiya.my.coocan.jp/msdos),[dosbox](https://www.dosbox.com)
-  - 他们的[相关信息](https://github.com/xsro/masm-tasm/blob/master/doc/license_and_info.md)
+  - 他们的[相关信息](doc/license_and_info.md)
 - [一些相关资料:wiki](https://github.com/xsro/VSC-ASMtasks/wiki)
 
 Enjoy!:smile:

package.json

@@ -1,9 +1,9 @@
 {
 	"name": "masm-tasm",
-	"displayName": "MASM/TASM via DOSBox",
+	"displayName": "MASM/TASM",
 	"publisher": "xsro",
-	"description": "Run and Debug MASM/TASM code in DOSBox with right click in the editor of assembly codes",
-	"version": "0.1.4",
+	"description": "DOS汇编语言开发环境和语法支持，安装即用,自带DOSBox.exe和TASM/MASM工具",
+	"version": "0.2.0",
 	"keywords":["dosbox","16位","汇编","微机原理","tasm","masm"],
 	"icon":"dosboxasm.png",
 	"engines": {
@@ -32,16 +32,20 @@
 			{
 				"id": "assembly",
 				"aliases": [
-					"Assembly (TASM)",
-					"assembly",
-					"TASM"
+					"assembly(DOS)"
 				],
 				"extensions": [
 					".asm"
 				],
 				"configuration": "./language-configuration.json"
 			}
 		],
+		"snippets": [
+			{
+				"language": "assembly",
+				"path": "./snippets.json"
+			}
+		],
 		"grammars": [
 			{
 				"language": "assembly",
@@ -52,17 +56,17 @@
 		"menus": {
 			"editor/context": [
 				{
-					"when": "resourceExtname == .ASM || resourceExtname == .asm && editorFocus",
+					"when": "resourceLangId == assembly && editorFocus",
 					"command": "masm-tasm.opendosbox",
 					"group": "0_MASM-TASM@1"
 				},
 				{
-					"when": "resourceExtname == .ASM || resourceExtname == .asm && editorFocus",
+					"when": "resourceLangId == assembly && editorFocus",
 					"command": "masm-tasm.runASM",
 					"group": "0_MASM-TASM@2"
 				},
 				{
-					"when": "resourceExtname == .ASM || resourceExtname == .asm && editorFocus",
+					"when": "resourceLangId == assembly && editorFocus",
 					"command": "masm-tasm.debugASM",
 					"group": "0_MASM-TASM@3"
 				}
@@ -120,15 +124,10 @@
                     "default": true,
                     "description": "%dosasm.config.savefirst%"
 				},
-				"masmtasm.language.hover":{
+				"masmtasm.language.programmaticFeatures":{
 					"type":"boolean",
 					"default":true,
-					"description": "hover for test，need restart to apply changes"
-				},
-				"masmtasm.language.CompletionItem":{
-					"type":"boolean",
-					"default":false,
-					"description": "autocomplet for test,need restart to apply changes"
+					"description": "experimental programmatic features like hover,outline,jump to definition. You can close them by choosing false"
 				},
 				"masmtasm.dosbox.run": {
 					"type": "string",

snippets.json

@@ -0,0 +1,57 @@
+{
+    "Macro":{
+        "prefix":"macro",
+        "body":[
+            "${1:name} MACRO ${2:params}",
+            "\t$0",
+            "ENDM"
+        ]
+    },
+    "Procedure":{
+        "prefix":"proc",
+        "body":[
+            ";${2:description}",
+            "${1:name} PROC",
+            "\t$0",
+            "${1:name} ENDP"
+        ]
+    },
+    "Segment":{
+        "prefix":"segment",
+        "body":[
+            ";${2:description}",
+            "${1:name} SEGMENT USE16",
+            "\t$0",
+            "${1:name} ENDS"
+        ]
+    },
+    "DOS print Char":{
+        "prefix":"cprint",
+        "body":[
+            "MOV DL, '${1:char}'",
+            "MOV AH, 2H",
+            "INT 21H"
+        ],
+        "description":"Prints a charcters"
+    },
+    "helloworld":{
+        "prefix":"helloword",
+        "body":[
+            ".386",
+            "DATA SEGMENT USE16",
+            "${1:MESG DB 'Hello word','$'}",
+            "DATA ENDS",
+            "CODE SEGMENT USE16",
+            "\tASSUME CS:CODE,DS:DATA",
+            "BEG:",
+            "\tMOV AX,DATA",
+            "\tMOV DS,AX",
+			"${2:\tMOV AH,9\n\tMOV DX, OFFSET MESG\n\tINT 21H}",
+			"\tMOV AH,4CH",
+			"\tINT 21H;back to dos",
+            "CODE ENDS",
+            "END BEG"
+        ],
+        "description":"HELLO WORD assembly sample"
+    }
+}

src/DOSBox.ts

@@ -1,8 +1,8 @@
-import { Uri,workspace, window} from 'vscode'
+import { Uri,workspace, window, TextDocument} from 'vscode'
 
 import { Config } from './configration'
 import { execSync} from 'child_process'
-import { landiagnose } from './diagnose'
+import { landiagnose } from './language/diagnose'
 export class DOSBox{
     constructor(){
     }
@@ -12,52 +12,41 @@ export class DOSBox{
      * @param fileuri 清理工作文件夹，复制该文件到工作文件夹，假如没有那么就不处理
      * @param diag 如果有则诊断输出信息
      */
-    public openDOSBox(conf:Config,more?:string,fileuri?:Uri,diag?:landiagnose) {
+    public openDOSBox(conf:Config,more?:string,doc?:TextDocument,diag?:landiagnose) {
         let boxcommand=' '
         if(more){
             let boxparam=more.replace(/\n/g,'"-c "')
             boxcommand='-c "'+boxparam+'"'
         }
         if(process.platform=='win32'){
             let wincommand='start/min/wait "" "'+conf.path+'/dosbox/dosbox.exe" -conf "'+conf.dosboxconfuri.fsPath+'" '
-            if(fileuri) wincommand='del/Q T*.* & copy "'+fileuri.fsPath+'" "T.ASM" & '+wincommand
+            if(doc) wincommand='del/Q T*.* & copy "'+doc.fileName+'" "T.ASM" & '+wincommand
             execSync(wincommand+boxcommand,{cwd:conf.workpath,shell:'cmd.exe'})
-            console.log(wincommand+boxcommand)
         }
         else{
             let linuxcommand='dosbox -conf "'+conf.dosboxconfuri.fsPath+'" '
-            if(fileuri) linuxcommand='rm -f [Tt]*.*;cp "'+fileuri.fsPath+'" T.ASM;'+linuxcommand
-            console.log(linuxcommand+boxcommand)
+            if(doc) linuxcommand='rm -f [Tt]*.*;cp "'+doc.fileName+'" T.ASM;'+linuxcommand
             execSync(linuxcommand+boxcommand,{cwd:conf.workpath})
 
         }
-        if(diag) this.BOXdiag(conf,diag)
+        if(diag && doc) this.BOXdiag(conf,diag,doc)
     }
-    private BOXdiag(conf:Config,diag:landiagnose):string{
-        let info:string=' ',content
-        let turi=window.activeTextEditor?.document.uri
-        let texturi:Uri
-        if (turi) {
-            texturi=turi
+    private BOXdiag(conf:Config,diag:landiagnose,doc:TextDocument):string{
+        let info:string=' ',content:string
+        let document=doc
+        if (document) {
+            content=document.getText()
             workspace.fs.readFile(conf.workloguri).then(
             (text)=>{
                 info=text.toString()
-                workspace.fs.readFile(texturi).then(
-                    (text)=>{
-                        content=text.toString()
-                        if(diag.ErrMsgProcess(content,info,texturi,conf.MASMorTASM)==0){
-                            let Errmsgwindow=conf.MASMorTASM+'汇编出错,无法运行/调试'
-                            window.showErrorMessage(Errmsgwindow);
-                        }
-                    }
-                )
-            },
+                if(diag.ErrMsgProcess(content,info,doc.uri,conf.MASMorTASM)==0){
+                    let Errmsgwindow=conf.MASMorTASM+'汇编出错,无法运行/调试'
+                    window.showErrorMessage(Errmsgwindow);
+                }},
             ()=>{console.error('read dosbox mode T.txt FAILED')}
         )}
         return info
     }
-    
-    
 }