vim-patch:9.2.0155: filetype: ObjectScript are not recognized (#38288)

Problem:  filetype: ObjectScript are not recognized
Solution: Add ObjectScript filetype detection for *.cls files
          (Hannah Kimura)).

Reference:
https://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GCOS_intro

closes: vim/vim#19668

b11c8efbe6

Co-authored-by: Hannah <hannah.kimura@intersystems.com>

runtime/lua/vim/filetype.lua

@@ -92,14 +92,15 @@ end
 ---
 ---@param bufnr integer The buffer to get the line from
 ---@param start_lnum integer The line number of the first line to start from (inclusive, 1-based)
----@return string|nil The first non-blank line if found or `nil` otherwise
+---@return string|nil line The first non-blank line if found or `nil` otherwise
+---@return integer|nil lnum The line number of the first non-blank line or `nil`
 function M._nextnonblank(bufnr, start_lnum)
-  for _, line in ipairs(M._getlines(bufnr, start_lnum, -1)) do
+  for off, line in ipairs(M._getlines(bufnr, start_lnum, -1)) do
     if not line:find('^%s*$') then
-      return line
+      return line, start_lnum + off - 1
     end
   end
-  return nil
+  return nil, nil
 end
 
 do

runtime/lua/vim/filetype/detect.lua

@@ -252,6 +252,7 @@ function M.class(_, bufnr)
   end
 end
 
+--- Determines whether a *.cls file is ObjectScript, TeX, Rexx, Visual Basic, or Smalltalk.
 --- @type vim.filetype.mapfn
 function M.cls(_, bufnr)
   if vim.g.filetype_cls then
@@ -264,8 +265,26 @@ function M.cls(_, bufnr)
     return 'vb'
   end
 
-  local nonblank1 = nextnonblank(bufnr, 1)
-  if nonblank1 and nonblank1:find('^[%%\\]') then
+  local nonblank1, lnum = nextnonblank(bufnr, 1)
+  local line = nonblank1
+  while line do
+    if matchregex(line, [[\c^\s*\%(import\|include\|includegenerator\)\>]]) then
+      line, lnum = nextnonblank(bufnr, lnum + 1)
+    else
+      nonblank1 = line
+      break
+    end
+  end
+
+  if
+    nonblank1
+    and matchregex(
+      nonblank1,
+      [[\c^\s*class\>\s\+[%A-Za-z][%A-Za-z0-9_.]*\%(\s\+extends\>\|\s*\[\|\s*{\|$\)]]
+    )
+  then
+    return 'objectscript'
+  elseif nonblank1 and nonblank1:find('^[%%\\]') then
     return 'tex'
   elseif nonblank1 and findany(nonblank1, { '^%s*/%*', '^%s*::%w' }) then
     return 'rexx'

src/nvim/eval/executor.c

@@ -130,12 +130,12 @@ static int tv_op_string(typval_T *tv1, const typval_T *tv2, const char *op)
   }
 
   char numbuf[NUMBUFLEN];
+  // str .= str
   const char *s2 = tv_get_string_buf(tv2, numbuf);
   if (grow_string_tv(tv1, s2) == OK) {
     return OK;
   }
 
-  // str .= str
   const char *tvs = tv_get_string(tv1);
   char *const s = concat_str(tvs, s2);
   tv_clear(tv1);

test/old/testdir/test_filetype.vim

@@ -2548,6 +2548,39 @@ func Test_cls_file()
   bwipe!
   unlet g:filetype_cls
 
+  let g:filetype_cls = 'objectscript'
+  split Xfile.cls
+  call assert_equal('objectscript', &filetype)
+  bwipe!
+  unlet g:filetype_cls
+
+  " ObjectScript
+
+  call writefile(['Class User.Person Extends (%Persistent, %Populate)'], 'Xfile.cls')
+  split Xfile.cls
+  call assert_equal('objectscript', &filetype)
+  bwipe!
+
+  call writefile(['Import MyApp.Utils', 'Class User.Person Extends %Persistent'], 'Xfile.cls')
+  split Xfile.cls
+  call assert_equal('objectscript', &filetype)
+  bwipe!
+
+  call writefile(['Include MyMacros', 'Class User.Person Extends %Persistent'], 'Xfile.cls')
+  split Xfile.cls
+  call assert_equal('objectscript', &filetype)
+  bwipe!
+
+  call writefile(['IncludeGenerator MyGen', 'Class User.Person Extends %Persistent'], 'Xfile.cls')
+  split Xfile.cls
+  call assert_equal('objectscript', &filetype)
+  bwipe!
+
+  call writefile(['Import MyApp.Utils', 'Include MyMacros', 'IncludeGenerator MyGen', 'Class User.Person Extends %Persistent'], 'Xfile.cls')
+  split Xfile.cls
+  call assert_equal('objectscript', &filetype)
+  bwipe!
+
   " TeX
 
   call writefile(['%'], 'Xfile.cls')