原始碼格式化器

wiki

為何？

• 手動格式化實在很痛苦 :o)
• Tab 大小不一致。不同的作者與編輯者有不同的 tab 大小，可能會與這裡 wiki 的 8 個空格 tab 大小不同。這種情況可以互換。將程式碼貼到此處時，tab 大小可能不同，而且從 wiki 複製程式碼時也可能不一致。
• 編輯器中的自動縮排可能會在您的程式碼中加入 tab（您可能甚至不知道！）此處可能會將它們擴充成不同的尺寸。
• 當程式碼為標準寬度時，非常方便，因為您不必繼續重新調整視窗大小。
• 均質的外觀讓腳本更具一致性，我們希望這能讓眼睛更輕鬆。我們的用意是讓 wiki 看起來像是集體合作的成果，而非個人的努力。我們是 Lua Wiki 博格！（Borg！） :-)

免責聲明： 您並非一定要使用此腳本！！在 wiki 編輯器中貼上程式碼片段或腳本時，您可能會因為 tab 而遇到問題。此腳本在此處是為了提供協助。希望藉由使用類似的原始碼格式，讓這個 wiki 看起來一致，而且組織更好。請不要開始爭論何謂良好或不良的格式。您可以自由進行任何您想做的事。

腳本所執行的動作

• 移除 tab 縮排，並以空格取代。
• 將縮排標準化為每縮排 2 個空格。
• 檢查行長是否超過 80 個字元。

使用方式

• 使用方式：lua -f codeformat.lua ...options...。
• --file <lua file> - 要處理的 Lua 檔案
• --ts <size> - Tab 的大小，例如 --ts 4（空格）
• --in <indent size> - 縮排所使用的空格數量。
• 例如，具有 4 個空格 tab 大小以及 4 個空格縮排步驟的檔案：lua -f codeformat.lua --file myfile.lua --ts 4 --in 4。

此腳本可搭配 Lua 5.0 使用。（感謝更新 Lua 4.0 版本中函式庫呼叫的人員。）

-- Lua code formatter
-- Removes tabs and checks lines arent too long.
-- Nick Trout
-- $Header: /Tools/build/codefmt.lua 3     16/08/01 20:00 Nick $
-- For Lua 5.0

mytabs = 4 -- spaces (default)
myindent = 4 -- spaces (default)
codetabsize = 8 -- spaces
codeindent = 2 -- spaces per indent
codelinelength = 80 -- characters


usage = 
[[

Usage: lua -f codeformat.lua ...options...

Options are:
--file <lua file>
--ts <spaces>, tabsize: number of spaces in your tabs
--in <spaces>, indent size: number of spaces for each indentation

]]


function process_args()
  -- get args set by user in command line
  local t,i = {},1
  while i<table.getn(arg) do
    local a=arg[i]
    if a=="--file" then
      t.filename,i = arg[i+1],i+2
    elseif a=="--ts" then
      t.mytabsize,i = arg[i+1]+0,i+2
    elseif a=="--in" then
      t.myindent,i = arg[i+1]+0,i+2
    else
      print(usage.."Bad flag: "..a)
      os.exit(-1)
    end
  end
  return t
end

function readfile(f)
  local fh=io.open(f,"rt")
  local t={}
  while 1 do
    local ln=fh:read("*l")
    if ln then table.insert(t,ln) else break end
  end
  fh:close()
  return t
end

-- convert any leading tabs in a given string to spaces.
-- the number of spaces to replace the tab by is given by args.mytabsize
function convertTabsToSpaces(ln)
  local s,e = string.find(ln,"\t+",1)
  if s and s==1 then
    local spc = string.rep(" ",args.mytabsize*(e-s+1))
    ln = spc..string.sub(ln,e+1)
  end
  return ln
end

-- convert any indentation to use the standard indent
function indent(ln)
  local s,e = string.find(ln," +",1)
  if s==1 then
    local indent = (e-s+1)/args.myindent
    ln = string.rep(" ",codeindent*indent)..string.sub(ln,e+1)
  end
  return ln
end
  
function process(lines)
  for li=1,table.getn(lines) do
    local line=lines[li]
    line = convertTabsToSpaces(line)
    line = indent(line)
    -- warn if length too long
    local len=string.len(line)
    if len>codelinelength then
      print("-- ######## Line too long ("..len.." chars) ######## :")
    end
    print(line)
  end
end

args = process_args()
if not args.filename then error(usage.."no Lua file given") end
args.mytabsize = args.mytabsize or mytabs
args.myindent = args.myindent or myindent
process( readfile(args.filename) )