xref: /src/tests/lib/libcurses/slave/lint.lua

#! /usr/bin/lua
-- $NetBSD: lint.lua,v 1.4 2021/06/13 19:25:08 rillig Exp $

--[[

usage: lua ./lint.lua

Check that the argument handling code does not contain unintended
inconsistencies.

]]

---@return string[]
local function load_lines(fname)
  local lines = {}

  local f = assert(io.open(fname, "r"))
  for line in f:lines() do
    table.insert(lines, line)
  end

  f:close()

  return lines
end


local function new_errors()
  local errors = {}
  errors.add = function(self, fmt, ...)
    table.insert(self, string.format(fmt, ...))
  end
  errors.print = function(self)
    for _, msg in ipairs(self) do
      print(msg)
    end
  end
  return errors
end


local function num(s)
  if s == nil then return nil end
  return tonumber(s)
end


-- After each macro ARGC, there must be the corresponding macros for ARG.
local function check_args(errors)
  local fname = "curses_commands.c"
  local lines = load_lines(fname)
  local curr_argc, curr_arg ---@type number|nil, number|nil

  for lineno, line in ipairs(lines) do

    local line_argc = num(line:match("^\tARGC%((%d)"))
    local line_arg = line:match("^\tARG_[%w_]+%(")

    if line_argc and line_argc > 0 then
      curr_argc, curr_arg = line_argc, 0
    end

    if line_arg and not curr_arg then
      errors:add("%s:%d: ARG without preceding ARGC", fname, lineno)
    end

    if not line_arg and curr_arg and not line_argc then
      errors:add("%s:%d: expecting ARG %d, got %s",
        fname, lineno, curr_arg, line)
      curr_argc, curr_arg = nil, nil
    end

    if line_arg and curr_arg then
      curr_arg = curr_arg + 1
      if curr_arg == curr_argc then
        curr_argc, curr_arg = nil, nil
      end
    end
  end
end


local function main(arg)
  local errors = new_errors()
  check_args(errors)
  errors:print()
  return #errors == 0
end


os.exit(main(arg))