+++ /dev/null
-/** @file\r
- \r
- Copyright (c) 2006, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
- \r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
- \r
- **/\r
-package org.tianocore.migration;\r
-\r
-import java.io.BufferedReader;\r
-import java.io.StringReader;\r
-import java.util.regex.Matcher;\r
-import java.util.regex.Pattern;\r
-\r
-public final class Critic {\r
- public static final Pattern PTN_NEW_HEAD_COMMENT = Pattern.compile(\r
- "^\\/\\*\\*.*?\\*\\*\\/", Pattern.DOTALL);\r
-\r
- private static final Pattern ptnheadcomment = Pattern.compile(\r
- "^\\/\\*\\+\\+(.*?)\\-\\-\\*\\/", Pattern.DOTALL);\r
-\r
- private static final Pattern ptnfunccomment = Pattern\r
- .compile(\r
- "([\\};\\/\">]\\s*)([\\w\\s\\*]*?[_\\w][_\\w\\d]*\\s*\\([^\\)\\(]*\\)\\s*)\\/\\*\\+\\+(.*?)\\-\\-\\*\\/\\s*(.*?)(?=[\\{;])",\r
- Pattern.DOTALL); // find function with {;">/ , may be\r
- // unsafe\r
-\r
- // private static Pattern ptncommentstructure =\r
- // Pattern.compile("\\/\\*\\+\\+\\s*Routine\r
- // Description:\\s*(.*?)\\s*Arguments:\\s*(.*?)\\s*Returns:\\s*(.*?)\\s*\\-\\-\\*\\/",Pattern.DOTALL);\r
- private static final Pattern ptncommentequation = Pattern\r
- .compile("([^\\s]*)\\s+-\\s+(.*)\\s*");\r
-\r
- private static Matcher mtrcommentequation;\r
-\r
- private static final Pattern ptnnewcomment = Pattern\r
- .compile("(\\s*@(param|retval)\\s+[^\\s]+)\\s+(.*)");\r
-\r
- private static Matcher mtrnewcomment;\r
-\r
- private static final int totallinelength = 82;\r
-\r
- public static final void run(String filepath) throws Exception {\r
- if (MigrationTool.doCritic) { // this is left here to set an example\r
- // for future structure\r
- critic(filepath);\r
- }\r
- }\r
-\r
- private static final void critic(String filepath) throws Exception {\r
- if (filepath.contains(".c") || filepath.contains(".h")) {\r
- BufferedReader rd = null;\r
- String line = null;\r
- StringBuffer templine = new StringBuffer();\r
- boolean incomment = false;\r
-\r
- System.out.println("Criticing " + filepath);\r
- String wholeline = Common.file2string(filepath);\r
-\r
- wholeline = wholeline.replaceAll("\t", " ");\r
- wholeline = Common.replaceAll(wholeline, ptnheadcomment,\r
- "/** @file$1**/");\r
- wholeline = Common.replaceAll(wholeline, ptnfunccomment,\r
- "$1\n/**$3\n**/\n$4$2");\r
- // wholeline = Common.replaceAll(wholeline, ptncommentstructure,\r
- // "/**\n#%\n$1\n%#\n#%%\n$2\n%%#\n#%%%\n$3\n%%%#\n**/");\r
-\r
- // first scan\r
- boolean description = false;\r
- boolean arguments = false;\r
- boolean returns = false;\r
- boolean inequation = false;\r
- rd = new BufferedReader(new StringReader(wholeline));\r
- while ((line = rd.readLine()) != null) {\r
- if (line.matches("\\/\\*\\*")) {\r
- incomment = true;\r
- description = false;\r
- arguments = false;\r
- returns = false;\r
- templine.append(line + "\n");\r
- } else if (line.matches("\\*\\*\\/")) {\r
- incomment = false;\r
- templine.append("\n" + line + "\n");\r
- } else if (incomment) {\r
- if (line.contains("Routine Description:")) {\r
- description = true;\r
- arguments = false;\r
- returns = false;\r
- } else if (line.contains("Arguments:")) {\r
- description = false;\r
- arguments = true;\r
- returns = false;\r
- templine.append("\n");\r
- } else if (line.contains("Returns:")) {\r
- description = false;\r
- arguments = false;\r
- returns = true;\r
- templine.append("\n");\r
- } else if (description) {\r
- if (line.trim().length() != 0) {\r
- templine.append(" " + line.trim() + "\n");\r
- }\r
- } else if (arguments) {\r
- mtrcommentequation = ptncommentequation.matcher(line);\r
- if (mtrcommentequation.find()) {\r
- inequation = true;\r
- templine.append(" @param "\r
- + mtrcommentequation.group(1) + " "\r
- + mtrcommentequation.group(2) + "\n");\r
- } else if (inequation && line.trim().length() == 0) {\r
- inequation = false;\r
- } else if (inequation && line.trim().length() != 0) {\r
- templine.append("#%#%" + line + "\n");\r
- } else {\r
- if (line.trim().length() != 0) {\r
- templine.append(" " + line.trim() + "\n");\r
- }\r
- }\r
- } else if (returns) {\r
- mtrcommentequation = ptncommentequation.matcher(line);\r
- if (mtrcommentequation.find()) {\r
- inequation = true;\r
- templine.append(" @retval "\r
- + mtrcommentequation.group(1) + " "\r
- + mtrcommentequation.group(2) + "\n");\r
- } else if (inequation && line.trim().length() == 0) {\r
- inequation = false;\r
- } else if (inequation && line.trim().length() != 0) {\r
- templine.append("#%#%" + line + "\n");\r
- } else {\r
- if (line.trim().length() != 0) {\r
- templine.append(" @return " + line.trim()\r
- + "\n");\r
- }\r
- }\r
- }\r
- } else {\r
- templine.append(line + "\n");\r
- }\r
- }\r
- wholeline = templine.toString();\r
- wholeline = wholeline.replaceAll("\n#%#%\\s*", " ");\r
- //\r
-\r
- // secend scan\r
- int startmax = 0;\r
- rd = new BufferedReader(new StringReader(wholeline));\r
- while ((line = rd.readLine()) != null) {\r
- if (line.matches("\\/\\*\\*")) {\r
- incomment = true;\r
- templine.append(line + "\n");\r
- } else if (line.matches("\\*\\*\\/")) {\r
- incomment = false;\r
- templine.append(line + "\n");\r
- } else if (incomment) {\r
- mtrnewcomment = ptnnewcomment.matcher(line);\r
- if (mtrnewcomment.find()) {\r
- startmax = mtrnewcomment.group(1).length() > startmax ? mtrnewcomment\r
- .group(1).length()\r
- : startmax;\r
- }\r
- }\r
- }\r
- startmax++;\r
- //\r
-\r
- // third scan\r
- int n = 0;\r
- String temp = null;\r
- String[] tempcont = null;\r
- int count = 0;\r
- templine = new StringBuffer();\r
- rd = new BufferedReader(new StringReader(wholeline));\r
- while ((line = rd.readLine()) != null) {\r
- if (line.matches("\\/\\*\\*")) {\r
- incomment = true;\r
- templine.append(line + "\n");\r
- } else if (line.matches("\\*\\*\\/")) {\r
- incomment = false;\r
- templine.append(line + "\n");\r
- } else if (incomment) {\r
- mtrnewcomment = ptnnewcomment.matcher(line);\r
- if (mtrnewcomment.find()) {\r
- n = startmax - mtrnewcomment.group(1).length();\r
- templine.append(mtrnewcomment.group(1));\r
- while (n-- >= 0) {\r
- templine.append(" ");\r
- }\r
- temp = mtrnewcomment.group(3);\r
- tempcont = temp.split(" "); // use \\s+ ?\r
-\r
- count = 0;\r
- for (int i = 0; i < tempcont.length; i++) {\r
- count += tempcont[i].length();\r
- if (count <= (totallinelength - startmax)) {\r
- templine.append(tempcont[i] + " ");\r
- count += 1;\r
- } else {\r
- templine.append("\n");\r
- n = startmax;\r
- while (n-- >= 0) {\r
- templine.append(" ");\r
- }\r
- templine.append(tempcont[i] + " ");\r
- count = tempcont[i].length() + 1;\r
- }\r
- }\r
- templine.append("\n");\r
- } else {\r
- templine.append(line + "\n");\r
- }\r
- } else {\r
- templine.append(line + "\n");\r
- }\r
- }\r
- wholeline = templine.toString();\r
- //\r
- // Remove trailing blanks.\r
- // \r
- wholeline = wholeline.replaceAll(" +\n", "\n");\r
- Common.string2file(wholeline, filepath);\r
- }\r
- }\r
-\r
- public static final void fireAt(String path) throws Exception {\r
- // Common.toDoAll(Common.dirCopy_(path),\r
- // Critic.class.getMethod("critic", String.class), null, null,\r
- // Common.FILE);\r
- Common.toDoAll(path, Critic.class.getMethod("run", String.class), null,\r
- null, Common.FILE);\r
- // Common.toDoAll(Common.dirCopy_(path), critic, Common.FILE);\r
- System.out.println("Critic Done");\r
- }\r
-}
\ No newline at end of file