fine tune and add more comments

Author: wxiaoguang

modules/markup/console/console.go

@@ -52,26 +52,16 @@ func (Renderer) CanRender(filename string, sniffedType typesniffer.SniffedType,
 	rs := []rune(s)
 	cnt := 0
 	firstErrPos := -1
+	isCtrlSep := func(p int) bool {
+		return p < len(rs) && (rs[p] == ';' || rs[p] == 'm')
+	}
 	for i, c := range rs {
 		if c == 0 {
 			return false
 		}
 		if c == '\x1b' {
-			match, c2, c3, c4, c5 := false, false, false, false, false
-			if i+2 < len(rs) {
-				match = rs[i+1] == '['
-				c2 = rs[i+2] == ';' || rs[i+2] == 'm'
-			}
-			if i+3 < len(rs) {
-				c3 = rs[i+3] == ';' || rs[i+3] == 'm'
-			}
-			if i+4 < len(rs) {
-				c4 = rs[i+4] == ';' || rs[i+4] == 'm'
-			}
-			if i+5 < len(rs) {
-				c5 = rs[i+5] == ';' || rs[i+5] == 'm'
-			}
-			if match && (c2 || c3 || c4 || c5) {
+			match := i+1 < len(rs) && rs[i+1] == '['
+			if match && (isCtrlSep(i+2) || isCtrlSep(i+3) || isCtrlSep(i+4) || isCtrlSep(i+5)) {
 				cnt++
 			}
 		}
@@ -82,7 +72,7 @@ func (Renderer) CanRender(filename string, sniffedType typesniffer.SniffedType,
 	if firstErrPos != -1 && firstErrPos != len(rs)-1 {
 		return false
 	}
-	return cnt >= 2
+	return cnt >= 2 // only render it as console output if there are at least two escape sequences
 }
 
 // Render renders terminal colors to HTML with all specific handling stuff.

modules/markup/console/console_test.go

@@ -22,6 +22,10 @@ func TestRenderConsole(t *testing.T) {
 		{"\x1b[1;2m \x1b[123m 啊", `<span class="term-fg2">  啊</span>`},
 		{"\x1b[1;2m \x1b[123m \xef", `<span class="term-fg2">  �</span>`},
 		{"\x1b[1;2m \x1b[123m \xef \xef", ``},
+		{"\x1b[12", ``},
+		{"\x1b[1", ``},
+		{"\x1b[FOO\x1b[", ``},
+		{"\x1b[mFOO\x1b[m", `FOO`},
 	}
 
 	var render Renderer

routers/web/repo/view_file.go

@@ -236,6 +236,11 @@ func prepareFileView(ctx *context.Context, entry *git.TreeEntry) {
 		return
 	}
 
+	// TODO: in the future maybe we need more accurate flags, for example:
+	// * IsRepresentableAsText: some files are text, some are not
+	// * IsRenderableXxx: some files are rendered by backend "markup" engine, some are rendered by frontend (pdf, 3d)
+	// * DefaultViewMode: when there is no "display" query parameter, which view mode should be used by default, source or rendered
+
 	utf8Reader := charset.ToUTF8WithFallbackReader(io.MultiReader(bytes.NewReader(buf), dataRc), charset.ConvertOpts{})
 	switch {
 	case fInfo.fileSize >= setting.UI.MaxDisplayFileSize:

web_src/js/features/file-view.ts

@@ -23,6 +23,7 @@ function showRenderRawFileButton(elFileView: HTMLElement, renderContainer: HTMLE
   const displayingRendered = Boolean(renderContainer);
   toggleClass(toggleButtons.querySelectorAll('.file-view-toggle-source'), 'active', !displayingRendered); // it may not exist
   toggleClass(toggleButtons.querySelector('.file-view-toggle-rendered'), 'active', displayingRendered);
+  // TODO: if there is only one button, hide it?
 }
 
 async function renderRawFileToContainer(container: HTMLElement, rawFileLink: string, mimeType: string) {

web_src/js/render/plugins/3d-viewer.ts

@@ -24,7 +24,13 @@ export function newRenderPlugin3DViewer(): FileRenderPlugin {
   // .ifc, .igs, .iges, .stp, .step are: TEXT
   // .stl .ply: TEXT or BINARY
   // .obj .off .wrl: TEXT
-  // So we need to be able to render when the file is recognized as plaintext file by backend
+  // So we need to be able to render when the file is recognized as plaintext file by backend.
+  //
+  // It needs more logic to make it overall right (render a text 3D model automatically):
+  // we need to distinguish the ambiguous filename extensions.
+  // For example: "*.obj, *.off, *.step" might be or not be a 3D model file.
+  // So when it is a text file, we can't assume that "we only render it by 3D plugin",
+  // otherwise the end users would be impossible to view its real content when the file is not a 3D model.
   const SUPPORTED_EXTENSIONS = [
     '.3dm', '.3ds', '.3mf', '.amf', '.bim', '.brep',
     '.dae', '.fbx', '.fcstd', '.glb', '.gltf',
@@ -41,6 +47,7 @@ export function newRenderPlugin3DViewer(): FileRenderPlugin {
     },
 
     async render(container: HTMLElement, fileUrl: string): Promise<void> {
+      // TODO: height and/or max-height?
       const OV = await import(/* webpackChunkName: "online-3d-viewer" */'online-3d-viewer');
       const viewer = new OV.EmbeddedViewer(container, {
         backgroundColor: new OV.RGBAColor(59, 68, 76, 0),