summaryrefslogtreecommitdiffstats
path: root/src/CheckBasicStyle.lua
diff options
context:
space:
mode:
authorHowaner <franzi.moos@googlemail.com>2014-07-26 13:27:27 +0200
committerHowaner <franzi.moos@googlemail.com>2014-07-26 13:27:27 +0200
commitef4d68adfd70488df0887f3a5fba1c9aad7a0108 (patch)
tree1ea3acb0e6b16e8badf7d1d56301bf3dd3a5d99e /src/CheckBasicStyle.lua
parentAdd armor items directly to the armor slots. (diff)
parentGit: Ignore AllFiles.lst (generated by cmake) (diff)
downloadcuberite-ef4d68adfd70488df0887f3a5fba1c9aad7a0108.tar
cuberite-ef4d68adfd70488df0887f3a5fba1c9aad7a0108.tar.gz
cuberite-ef4d68adfd70488df0887f3a5fba1c9aad7a0108.tar.bz2
cuberite-ef4d68adfd70488df0887f3a5fba1c9aad7a0108.tar.lz
cuberite-ef4d68adfd70488df0887f3a5fba1c9aad7a0108.tar.xz
cuberite-ef4d68adfd70488df0887f3a5fba1c9aad7a0108.tar.zst
cuberite-ef4d68adfd70488df0887f3a5fba1c9aad7a0108.zip
Diffstat (limited to 'src/CheckBasicStyle.lua')
-rw-r--r--src/CheckBasicStyle.lua142
1 files changed, 83 insertions, 59 deletions
diff --git a/src/CheckBasicStyle.lua b/src/CheckBasicStyle.lua
index f9bb41975..13a6d15d2 100644
--- a/src/CheckBasicStyle.lua
+++ b/src/CheckBasicStyle.lua
@@ -1,3 +1,4 @@
+#!/usr/bin/env lua
-- CheckBasicStyle.lua
@@ -6,39 +7,29 @@ Checks that all source files (*.cpp, *.h) use the basic style requirements of th
- Tabs for indentation, spaces for alignment
- Trailing whitespace on non-empty lines
- Two spaces between code and line-end comment ("//")
- - (TODO) Spaces around +, -, (cannot check /, * or & due to their other usage - comment, ptr deref, address-of)
+ - Spaces after comma, not before
+ - Opening braces not at the end of a code line
+ - Spaces after if, for, while
- (TODO) Spaces before *, /, &
- - (TODO) Spaces after ,
- (TODO) Hex numbers with even digit length
- (TODO) Hex numbers in lowercase
- - (TODO) Braces not on the end of line
- (TODO) Line dividers (////...) exactly 80 slashes
+ - (TODO) Not using "* "-style doxy comment continuation lines
+
+Violations that cannot be checked easily:
+ - Spaces around "+" (there are things like "a++", "++a", "a += 1", "X+", "stack +1" and ascii-drawn tables)
Reports all violations on stdout in a form that is readable by Visual Studio's parser, so that dblclicking
the line brings the editor directly to the violation.
Returns 0 on success, 1 on internal failure, 2 if any violations found
-This script requires LuaFileSystem to be available in the current Lua interpreter.
--]]
--- Check that LFS is installed:
-local hasLfs = pcall(require, "lfs")
-if not(hasLfs) then
- print("This script requires LuaFileSystem to be installed")
- os.exit(1)
-end
-local lfs = require("lfs")
-assert(lfs ~= nil)
-
-
-
-
-
-- The list of file extensions that are processed:
local g_ShouldProcessExt =
{
@@ -49,13 +40,12 @@ local g_ShouldProcessExt =
--- The list of files not to be processed:
local g_IgnoredFiles =
{
- "./Bindings/Bindings.cpp",
- "./Bindings/DeprecatedBindings.cpp",
- "./LeakFinder.cpp",
- "./LeakFinder.h",
- "./MersenneTwister.h",
- "./StackWalker.cpp",
- "./StackWalker.h",
+ "Bindings/Bindings.cpp",
+ "LeakFinder.cpp",
+ "LeakFinder.h",
+ "MersenneTwister.h",
+ "StackWalker.cpp",
+ "StackWalker.h",
}
--- The list of files not to be processed, as a dictionary (filename => true), built from g_IgnoredFiles
@@ -76,8 +66,8 @@ local g_NumViolations = 0
--- Reports one violation
-- Pretty-prints the message
-- Also increments g_NumViolations
-local function ReportViolation(a_FileName, a_LineNumber, a_Message)
- print(a_FileName .. "(" .. a_LineNumber .. "): " .. a_Message)
+local function ReportViolation(a_FileName, a_LineNumber, a_PatStart, a_PatEnd, a_Message)
+ print(a_FileName .. "(" .. a_LineNumber .. "): " .. a_PatStart .. " .. " .. a_PatEnd .. ": " .. a_Message)
g_NumViolations = g_NumViolations + 1
end
@@ -85,6 +75,64 @@ end
+--- Searches for the specified pattern, if found, reports it as a violation with the given message
+local function ReportViolationIfFound(a_Line, a_FileName, a_LineNum, a_Pattern, a_Message)
+ local patStart, patEnd = a_Line:find(a_Pattern)
+ if not(patStart) then
+ return
+ end
+ ReportViolation(a_FileName, a_LineNum, patStart, patEnd, a_Message)
+end
+
+
+
+
+
+local g_ViolationPatterns =
+{
+ -- Check against indenting using spaces:
+ {"^\t* +", "Indenting with a space"},
+
+ -- Check against alignment using tabs:
+ {"[^%s]\t+[^%s]", "Aligning with a tab"},
+
+ -- Check against trailing whitespace:
+ {"[^%s]%s+\n", "Trailing whitespace"},
+
+ -- Check that all "//"-style comments have at least two spaces in front (unless alone on line):
+ {"[^%s] //", "Needs at least two spaces in front of a \"//\"-style comment"},
+
+ -- Check that all "//"-style comments have at least one spaces after:
+ {"%s//[^%s/*<]", "Needs a space after a \"//\"-style comment"},
+
+ -- Check that all commas have spaces after them and not in front of them:
+ {" ,", "Extra space before a \",\""},
+ {",[^%s\"%%]", "Needs a space after a \",\""}, -- Report all except >> "," << needed for splitting and >>,%s<< needed for formatting
+
+ -- Check that opening braces are not at the end of a code line:
+ {"[^%s].-{\n?$", "Brace should be on a separate line"},
+
+ -- Space after keywords:
+ {"[^_]if%(", "Needs a space after \"if\""},
+ {"for%(", "Needs a space after \"for\""},
+ {"while%(", "Needs a space after \"while\""},
+ {"switch%(", "Needs a space after \"switch\""},
+ {"catch%(", "Needs a space after \"catch\""},
+
+ -- No space after keyword's parenthesis:
+ {"[^%a#]if %( ", "Remove the space after \"(\""},
+ {"for %( ", "Remove the space after \"(\""},
+ {"while %( ", "Remove the space after \"(\""},
+ {"catch %( ", "Remove the space after \"(\""},
+
+ -- No space before a closing parenthesis:
+ {" %)", "Remove the space before \")\""},
+}
+
+
+
+
+
--- Processes one file
local function ProcessFile(a_FileName)
assert(type(a_FileName) == "string")
@@ -103,7 +151,7 @@ local function ProcessFile(a_FileName)
if ((lastChar ~= 13) and (lastChar ~= 10)) then
local numLines = 1
string.gsub(all, "\n", function() numLines = numLines + 1 end) -- Count the number of line-ends
- ReportViolation(a_FileName, numLines, "Missing empty line at file end")
+ ReportViolation(a_FileName, numLines, 1, 1, "Missing empty line at file end")
return
end
@@ -113,26 +161,11 @@ local function ProcessFile(a_FileName)
all:gsub("\r\n", "\n") -- normalize CRLF into LF-only
string.gsub(all .. "\n", "[^\n]*\n", -- Iterate over each line, while preserving empty lines
function(a_Line)
- -- Check against indenting using spaces:
- if (a_Line:find("^\t* +")) then -- Find any number of tabs at the start of line (incl 0), followed by a space
- ReportViolation(a_FileName, lineCounter, "Indenting with a space")
- end
- -- Check against alignment using tabs:
- if (a_Line:find("[^%s]\t+[^%s]")) then -- Find any number of tabs after non-whitespace followed by non-whitespace
- ReportViolation(a_FileName, lineCounter, "Aligning with a tab")
- end
- -- Check against trailing whitespace:
- if (a_Line:find("[^%s]%s+\n")) then -- Find any whitespace after non-whitespace at the end of line
- ReportViolation(a_FileName, lineCounter, "Trailing whitespace")
- end
- -- Check that all "//"-style comments have at least two spaces in front (unless alone on line):
- if (a_Line:find("[^%s] //")) then
- ReportViolation(a_FileName, lineCounter, "Needs at least two spaces in front of a \"//\"-style comment")
- end
- -- Check that all "//"-style comments have at least one spaces after:
- if (a_Line:find("%s//[^%s/*<]")) then
- ReportViolation(a_FileName, lineCounter, "Needs a space after a \"//\"-style comment")
+ -- Check against each violation pattern:
+ for _, pat in ipairs(g_ViolationPatterns) do
+ ReportViolationIfFound(a_Line, a_FileName, lineCounter, pat[1], pat[2])
end
+
lineCounter = lineCounter + 1
end
)
@@ -151,17 +184,6 @@ local function ProcessItem(a_ItemName)
return
end
- -- If the item is a folder, recurse:
- local attrs = lfs.attributes(a_ItemName)
- if (attrs and (attrs.mode == "directory")) then
- for fnam in lfs.dir(a_ItemName) do
- if ((fnam ~= ".") and (fnam ~= "..")) then
- ProcessItem(a_ItemName .. "/" .. fnam)
- end
- end
- return
- end
-
local ext = a_ItemName:match("%.([^/%.]-)$")
if (g_ShouldProcessExt[ext]) then
ProcessFile(a_ItemName)
@@ -172,8 +194,10 @@ end
--- Process the entire current folder:
-ProcessItem(".")
+-- Process all files in the AllFiles.lst file (generated by cmake):
+for fnam in io.lines("AllFiles.lst") do
+ ProcessItem(fnam)
+end
-- Report final verdict:
print("Number of violations found: " .. g_NumViolations)