Codestyle.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  1. /* vim: set expandtab ts=4 sw=4: */
  2. /*
  3. * You may redistribute this program and/or modify it under the terms of
  4. * the GNU General Public License as published by the Free Software Foundation,
  5. * either version 3 of the License, or (at your option) any later version.
  6. *
  7. * This program is distributed in the hope that it will be useful,
  8. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. * GNU General Public License for more details.
  11. *
  12. * You should have received a copy of the GNU General Public License
  13. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. var Fs = require('fs');
  16. var nThen = require('nthen');
  17. var Semaphore = require('../tools/lib/Semaphore');
  18. var Child = require('child_process');
  19. var headerLines = [
  20. '/* vim: set expandtab ts=4 sw=4: */',
  21. '/*',
  22. ' * You may redistribute this program and/or modify it under the terms of',
  23. ' * the GNU General Public License as published by the Free Software Foundation,',
  24. ' * either version 3 of the License, or (at your option) any later version.',
  25. ' *',
  26. ' * This program is distributed in the hope that it will be useful,',
  27. ' * but WITHOUT ANY WARRANTY; without even the implied warranty of',
  28. ' * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the',
  29. ' * GNU General Public License for more details.',
  30. ' *',
  31. ' * You should have received a copy of the GNU General Public License',
  32. ' * along with this program. If not, see <http://www.gnu.org/licenses/>.',
  33. ' */'
  34. ];
  35. var parseFile = function (fileName, fileContent) {
  36. var output = '';
  37. var parenthCount = 0;
  38. var functionParenthCount = 0;
  39. var expectBracket = 0;
  40. var name = fileName.replace(/^.*\//, '').replace(/\..*$/,'');
  41. var lines = fileContent.split('\n');
  42. var lineInfo = '';
  43. var ignore = false;
  44. var error = function(msg) {
  45. if (!ignore) {
  46. output += lineInfo + ' ' + msg + '\n';
  47. }
  48. };
  49. for (var lineNum = 0; lineNum < lines.length; lineNum++) {
  50. var line = lines[lineNum];
  51. // switch to 1 indexing for human readability
  52. lineInfo = fileName + ":" + (lineNum+1);
  53. ignore = false;
  54. if (lineNum < headerLines.length) {
  55. var expectedLine = headerLines[lineNum];
  56. if (line !== headerLines[lineNum]) {
  57. error("missing header\n" + expectedLine + "\n" + line);
  58. }
  59. } else if (/\.h$/.test(fileName) && lineNum < headerLines.length + 1) {
  60. if (line !== '#ifndef ' + name + "_H") {
  61. error("expected #ifndef " + name + "_H found " + line);
  62. }
  63. } else if (/\.h$/.test(fileName) && lineNum < headerLines.length + 2) {
  64. if (line !== '#define ' + name + "_H") {
  65. error("expected #define " + name + "_H found " + line);
  66. }
  67. }
  68. ignore = /CHECKFILES_IGNORE/.test(line);
  69. if (expectBracket === 1) {
  70. expectBracket = 0;
  71. if (!(/^[\s]*{/.test(line))) {
  72. error("expecting a { bracket " + line);
  73. }
  74. }
  75. // implementations.. TUNConfigurator_Linux contains TUNConfigurator_doStuff...
  76. var n = name.replace(/_.*/, '');
  77. if ((/^\w+\s.*\(/).test(line)) {
  78. if (!(/^int main\(/.test(line)
  79. || line.indexOf(' '+n) > -1
  80. || /^[ ]?static /.test(line)
  81. || /^typedef /.test(line)))
  82. {
  83. error("all globally visible functions must begin with the name of the file.");
  84. }
  85. }
  86. var matches;
  87. if (functionParenthCount === 0) {
  88. matches = /^\w+\s.*(\(.*)$/.exec(line);
  89. }
  90. if (functionParenthCount > 0 || matches) {
  91. var txt = (functionParenthCount > 0) ? line : matches[1];
  92. functionParenthCount += (txt.match(/\(/g)||[]).length;
  93. functionParenthCount -= (txt.match(/\)/g)||[]).length;
  94. if (functionParenthCount === 0) {
  95. txt = txt.substring(txt.lastIndexOf(')') + 1);
  96. if (/{/.test(txt)) {
  97. error("please put the opening bracket on the next line.");
  98. }
  99. }
  100. }
  101. if (/[\w]*int[\w]*\s+\*+\w/.test(line) || /[\w]*struct\s+[\w]+\s+\*+\w/.test(line)) {
  102. error("int* blah; means int pointer named blah, int *blah; means int names splatblah");
  103. }
  104. if (line.length > 100) {
  105. error("cjd's editor window is only 100 characters wide");
  106. }
  107. if (/\.h$/.test(fileName) && fileName.indexOf('util/platform/libc/') === -1) {
  108. // If the name is CryptoAuth_pvt.h, it's ok to make a structure called CryptoAuth
  109. var nameRe = name.replace(/_pvt$/, '').replace(/_impl$/, '');
  110. if (/^struct /.test(line) && line.indexOf('struct ' + nameRe) !== 0 && !(/\(/.test(line))) {
  111. error("all structures must begin with the name of the file.");
  112. }
  113. if (/#define /.test(line) && line.indexOf('#define ' + nameRe) === -1) {
  114. error("all defines must begin with the name of the file.");
  115. }
  116. }
  117. if (/\t/.test(line)) {
  118. error("tabs are not allowed, use 4 spaces.");
  119. }
  120. if (/\s$/.test(line)) {
  121. error("trailing whitespace.");
  122. }
  123. if (/[^A-Z](TODO|FIXME|XXX)[^A-Z]/.test(line)) {
  124. if (/[^A-Z](TODO|FIXME|XXX)[^\(A-Z]/.test(line)) {
  125. error("Please take responsibility for your TODO: eg: // TODO(cjd): make this work");
  126. } else {
  127. console.log(lineInfo + ' ' + line.replace(/[ \/]*/, ''));
  128. }
  129. }
  130. if (/(if|for|while)\(/.test(line)) {
  131. error("If/for/while statements must be followed by whitespace.");
  132. }
  133. matches = null;
  134. if (parenthCount === 0) {
  135. matches = /[^\w#](if|for|while) (\(.*$)/.exec(line);
  136. }
  137. if (parenthCount > 0 || matches) {
  138. var txt1 = (parenthCount > 0) ? line : matches[2];
  139. parenthCount += (txt1.match(/\(/g)||[]).length;
  140. parenthCount -= (txt1.match(/\)/g)||[]).length;
  141. if (parenthCount === 0) {
  142. txt1 = txt1.substring(txt1.lastIndexOf(')') + 1);
  143. // for (x; y; z) ; <-- ok
  144. // for (x; y; z) { <-- ok
  145. // for (x; y; z) { \ <-- ok (in preprocessor macro)
  146. // for (x; y; z) <-- ok but you better put a bracket on the next line
  147. // for (x; y; z) { j++; } <-- ok
  148. // for (x; y; z) j++; <-- BZZZZZZZZZZT
  149. if (!(/^[\s]*[;{].*$/.test(txt1)) && !(/^[\s]+{[\s]*\\$/).test(txt1)) {
  150. if (/[\s]*$/.test(txt1)) {
  151. expectBracket = 1;
  152. } else {
  153. error(parenthCount + ' ' + line);
  154. }
  155. }
  156. }
  157. }
  158. }
  159. return output;
  160. };
  161. var checkFile = module.exports.checkFile = function (file, callback) {
  162. Fs.readFile(file, function (err, ret) {
  163. if (err) { throw err; }
  164. callback(parseFile(file, ret.toString()));
  165. });
  166. };
  167. var lint = module.exports.lint = function (fileName, fileContent, callback) {
  168. var out = parseFile(fileName, fileContent);
  169. callback(out, !!out);
  170. };
  171. var checkFiles = module.exports.checkFiles = function (files, callback) {
  172. var sema = Semaphore.create(64);
  173. var errors = '';
  174. nThen(function (waitFor) {
  175. files.forEach(function (file) {
  176. sema.take(waitFor(function (returnAfter) {
  177. checkFile(file, waitFor(returnAfter(function (err) {
  178. if (err) {
  179. errors += file + '\n' + err + '\n';
  180. }
  181. })));
  182. }));
  183. });
  184. }).nThen(function (waitFor) {
  185. callback(errors);
  186. });
  187. };
  188. var checkDir = module.exports.checkDir = function (dir, runInFork, callback) {
  189. var gitIgnoreLines;
  190. if (runInFork) {
  191. var err = '';
  192. var out = '';
  193. var proc = Child.spawn(process.execPath, [__filename]);
  194. proc.stdout.on('data', function (data) { err += data.toString('utf8'); });
  195. proc.stderr.on('data', function (data) { err += data.toString('utf8'); });
  196. proc.on('close', function (ret) {
  197. out += err;
  198. var error;
  199. if (ret !== 0) { error = new Error(out); }
  200. callback(error, out);
  201. });
  202. return;
  203. }
  204. var output = '';
  205. nThen(function (waitFor) {
  206. Fs.readFile('.gitignore', waitFor(function (err, ret) {
  207. if (err) { throw err; }
  208. gitIgnoreLines = ret.toString('utf8').split('\n');
  209. }));
  210. }).nThen(function (waitFor) {
  211. var addDir = function (dir) {
  212. Fs.readdir(dir, waitFor(function (err, files) {
  213. if (err) { throw err; }
  214. files.forEach(function (file) {
  215. Fs.stat(dir + '/' + file, waitFor(function (err, stat) {
  216. if (err) { throw err; }
  217. if (file === '.git') {
  218. } else if (file === 'contrib') {
  219. } else if (file === 'dependencies') {
  220. } else if (gitIgnoreLines.indexOf(file) !== -1) {
  221. } else {
  222. if (stat.isDirectory()) {
  223. addDir(dir + '/' + file);
  224. } else if (/.*\.[ch]$/.test(file)) {
  225. checkFile(dir + '/' + file, waitFor(function (ret) {
  226. output += ret;
  227. }));
  228. }
  229. }
  230. }));
  231. });
  232. }));
  233. };
  234. addDir(dir);
  235. }).nThen(function (waitFor) {
  236. callback(output);
  237. });
  238. };
  239. if (module.parent === null) {
  240. checkDir('.', false, function(output) {
  241. if (output !== '') {
  242. console.log(output);
  243. process.exit(1);
  244. }
  245. });
  246. }