feat: Assembly support

Signed-off-by: Ian Lewis <ianlewis@google.com>
ianlewis · Jul 21, 2023 · 2e96cbe · 2e96cbe
1 parent 08a378d
commit 2e96cbe
Show file tree

Hide file tree

Showing 2 changed files with 150 additions and 15 deletions.
diff --git a/internal/scanner/config.go b/internal/scanner/config.go
@@ -24,6 +24,7 @@ type Config struct {
 
 var (
 	languageMap = map[string]*Config{
+		"Assembly":     &AssemblyConfig,
 		"C":            &CConfig,
 		"C++":          &CPPConfig,
 		"C#":           &CSConfig,
@@ -35,21 +36,34 @@ var (
 		"Java":         &JavaConfig,
 		"JavaScript":   &JavascriptConfig,
 		// NOTE: Some JSON files support JS comments (e.g. tsconfig.json)
-		"JSON":        &JavascriptConfig,
-		"Lua":         &LuaConfig,
-		"Makefile":    &MakefileConfig,
-		"Objective-C": &ObjectiveCConfig,
-		"Perl":        &PerlConfig,
-		"PHP":         &PHPConfig,
-		"Python":      &PythonConfig,
-		"Ruby":        &RubyConfig,
-		"Scala":       &ScalaConfig,
-		"Shell":       &ShellConfig,
-		"Swift":       &SwiftConfig,
-		"TOML":        &TOMLConfig,
-		"TypeScript":  &TypescriptConfig,
-		"XML":         &XMLConfig,
-		"YAML":        &YAMLConfig,
+		"JSON":          &JavascriptConfig,
+		"Lua":           &LuaConfig,
+		"Makefile":      &MakefileConfig,
+		"Objective-C":   &ObjectiveCConfig,
+		"Perl":          &PerlConfig,
+		"PHP":           &PHPConfig,
+		"Python":        &PythonConfig,
+		"Ruby":          &RubyConfig,
+		"Scala":         &ScalaConfig,
+		"Shell":         &ShellConfig,
+		"Swift":         &SwiftConfig,
+		"TOML":          &TOMLConfig,
+		"TypeScript":    &TypescriptConfig,
+		"Unix Assembly": &UnixAssemblyConfig,
+		"XML":           &XMLConfig,
+		"YAML":          &YAMLConfig,
+	}
+
+	// AssemblyConfig is a config for Assembly.
+	AssemblyConfig = Config{
+		LineCommentStart: []string{";"},
+		// TODO(#1): Parsing should exclude the leading '*' for multi-line comments.
+		MultilineCommentStart: "/*",
+		MultilineCommentEnd:   "*/",
+		Strings: [][2]string{
+			{"\"", "\""},
+			{"'", "'"},
+		},
 	}
 
 	// CConfig is a config for C.
@@ -194,6 +208,9 @@ var (
 	// TypescriptConfig is a config for Typescript.
 	TypescriptConfig = JavascriptConfig
 
+	// UnixAssemblyConfig is a config for Unix Assembly.
+	UnixAssemblyConfig = AssemblyConfig
+
 	// XMLConfig is a config for XML.
 	XMLConfig = Config{
 		MultilineCommentStart: "<!--",

diff --git a/internal/scanner/scanner_test.go b/internal/scanner/scanner_test.go
@@ -36,6 +36,124 @@ var scannerTestCases = []*struct {
 		line int
 	}
 }{
+	// Assembly
+	{
+		name: "line_comments.s",
+		src: `; file comment
+
+			; TODO is a function.
+			TODO:
+				ret ; Random comment`,
+		config: UnixAssemblyConfig,
+		comments: []struct {
+			text string
+			line int
+		}{
+			{
+				text: "; file comment",
+				line: 1,
+			},
+			{
+				text: "; TODO is a function.",
+				line: 3,
+			},
+			{
+				text: "; Random comment",
+				line: 5,
+			},
+		},
+	},
+	{
+		name: "comments_in_string.s",
+		src: `; file comment
+
+			; TODO is a function.
+			TODO:
+				msg x "; Random comment",0
+				msg y '; Random comment',0
+				ret`,
+		config: UnixAssemblyConfig,
+		comments: []struct {
+			text string
+			line int
+		}{
+			{
+				text: "; file comment",
+				line: 1,
+			},
+			{
+				text: "; TODO is a function.",
+				line: 3,
+			},
+		},
+	},
+	{
+		name: "escaped_string.s",
+		src: `; file comment
+
+			; TODO is a function.
+			TODO:
+				msg x "\"; Random comment",0
+				msg y '\'; Random comment',0
+				ret`,
+		config: UnixAssemblyConfig,
+		comments: []struct {
+			text string
+			line int
+		}{
+			{
+				text: "; file comment",
+				line: 1,
+			},
+			{
+				text: "; TODO is a function.",
+				line: 3,
+			},
+			// TODO(#1): Assembly doesn't seems to support escaped double or single quotes.
+			// {
+			// 	text: "; Random comment',0",
+			// 	line: 5,
+			// },
+			// {
+			// 	text: "; Random comment',0",
+			// 	line: 6,
+			// },
+		},
+	},
+	{
+		name: "multi_line.s",
+		src: `; file comment
+
+			/*
+			TODO is a function.
+			*/
+			TODO:
+				ret ; Random comment
+			/* extra comment */`,
+		config: UnixAssemblyConfig,
+		comments: []struct {
+			text string
+			line int
+		}{
+			{
+				text: "; file comment",
+				line: 1,
+			},
+			{
+				text: "/*\n\t\t\tTODO is a function.\n\t\t\t*/",
+				line: 3,
+			},
+			{
+				text: "; Random comment",
+				line: 7,
+			},
+			{
+				text: "/* extra comment */",
+				line: 8,
+			},
+		},
+	},
+
 	// Go
 	{
 		name: "line_comments.go",