Methods and systems for finding specific line of source code

Abstract

Methods and systems consistent with the present invention provide an improved software development tool that allows a developer to locate a portion of source code corresponding to a message from a verification tool. The improved software development tool displays a graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

Claims

What is claimed is:

1. A method in a data processing system for developing source code comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

receiving a message corresponding to a portion of the source code;

locating the portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message in a visually distinctive manner;

determining whether the graphical representation of the portion of the source code corresponding to the message is displayed; and

when it is determined that the graphical representation of the portion of the source code corresponding to the message is not displayed, displaying the graphical representation of the portion of the source code corresponding to the message; and

modifying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

2. The method of claim 1, wherein the message is received from a verification tool.

3. The method of claim 2, wherein the verification tool comprises a compiler.

4. The method of claim 2, wherein the verification tool comprises a quality assurance module.

5. The method of claim 1, wherein the message comprises an error message.

6. The method of claim 1, wherein the message comprises a line number of the source code.

7. The method of claim 6, wherein the portion of the source code corresponding to the message is located using the line number.

8. The method of claim 1, wherein the message comprises a name of a file containing the source code.

9. The method of claim 1, wherein the graphical representation comprises a class diagram.

10. A method in a data processing system for developing source code comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

receiving a message corresponding to a portion of the source code;

locating the portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message; and

displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

11. The method of claim 10, further comprising the steps of:

detecting an error in the source code; and

generating a message reflecting the error.

12. The method of claim 10, wherein the message is received from a verification tool.

13. The method of claim 12, wherein the verification tool comprises a compiler.

14. The method of claim 12, wherein the verification tool comprises a quality assurance module.

15. The method of claim 10, wherein the message comprises an error message.

16. The method of claim 10, wherein the message comprises a line number of the source code.

17. The method of claim 16, wherein the portion of the source code corresponding to the message is located using the line number.

18. The method of claim 10, wherein the message comprises a name of a file containing the source code.

19. The method of claim 10, wherein the graphical representation comprises a class diagram.

20. A method in a data processing system for developing source code comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code:

receiving a message corresponding to a portion of the source code; and

displaying the graphical representation generated from the language-neutral representation in the transient meta model pertaining to the portion of the source code corresponding to the message in a visually distinctive manner.

21. The method of claim 20, wherein the message is received from a verification tool.

22. The method of claim 21, wherein the verification tool comprises a compiler.

23. The method of claim 21, wherein the verification tool comprises a quality assurance module.

24. The method of claim 20, wherein the message comprises an error message.

25. The method of claim 20, wherein the message comprises a line number of the source code.

26. The method of claim 25, wherein the portion of the source code corresponding to the message is located using the line number.

27. The method of claim 20, wherein the message comprises a name of a file containing the source code.

28. The method of claim 20, wherein the graphical representation comprises a class diagram.

29. The method of claim 20, wherein the message comprises a basic metrics message.

30. The method of claim 29, wherein the basic metrics message comprises a lines of code message.

31. The method of claim 29, wherein the basic metrics message comprises a number of attributes message.

32. The method of claim 29, wherein the basic metrics message comprises a number of classes message.

33. The method of claim 29, wherein the basic metrics message comprises a number of constructors message.

34. The method of claim 29, wherein the basic metrics message comprises a number of import statements message.

35. The method of claim 29, wherein the basic metrics message comprises a number of members message.

36. The method of claim 29, wherein the basic metrics message comprises a number of operations message.

37. The method of claim 20, wherein the message comprises a cohesion metrics message.

38. The method of claim 37, wherein the cohesion metrics message comprises a lack of cohesion message.

39. The method of claim 20, wherein the message comprises a complexity metrics message.

40. The method of claim 39, wherein the complexity metrics message comprises an attribute complexity message.

41. The method of claim 39, wherein the complexity metrics message comprises a cyclomatic complexity message.

42. The method of claim 39, wherein the complexity metrics message comprises a number of remote methods message.

43. The method of claim 39, wherein the complexity metrics message comprises a response for class message.

44. The method of claim 39, wherein the complexity metrics message comprises a weighted methods per class message.

45. The method of claim 20, wherein the message comprises a coupling metrics message.

46. The method of claim 45, wherein the coupling metrics message comprises a coupling between objects message.

47. The method of claim 45 wherein the coupling metrics message comprises a coupling factor message.

48. The method of claim 45, wherein the coupling metrics message comprises a data abstraction coupling message.

49. The method of claim 45, wherein the coupling metrics message comprises a fanout message.

50. The method of claim 20, wherein the message comprises a Halstead metrics message.

51. The method of claim 50, wherein the Halstead metrics message comprises a Halstead difficulty message.

52. The method of claim 50, wherein the Halstead metrics message comprises a Halstead effort message.

53. The method of claim 50, wherein the Halstead metrics message comprises a Halstead program length message.

54. The method of claim 50, wherein the Halstead metrics message comprises a Halstead program vocabulary message.

55. The method of claim 50, wherein the Halstead metrics message comprises a Halstead program volume message.

56. The method of claim 50, wherein the Halstead metrics message comprises a number of operands message.

57. The method of claim 50, wherein the Halstead metrics message comprises a number of operators message.

58. The method of claim 50, wherein the Halstead metrics message comprises a number of unique operands message.

59. The method of claim 50, wherein the Halstead metrics message comprises a number of unique operators message.

60. The method of claim 20, wherein the message comprises an incapsulation metrics message.

61. The method of claim 60, wherein the incapsulation metrics message comprises an attribute hiding factor message.

62. The method of claim 60, wherein the incapsulation metrics message comprises a method hiding factor message.

63. The method of claim 20, wherein the message comprises an inheritance metrics message.

64. The method of claim 63, wherein the inheritance metrics message comprises an attribute inheritance factor message.

65. The method of claim 63, wherein the inheritance metrics message comprises a depth of inheritance hierarchy message.

66. The method of claim 63, wherein the inheritance metrics message comprises a method inheritance factor message.

67. The method of claim 63, wherein the inheritance metrics message comprises a number of child classes message.

68. The method of claim 20, wherein the message comprises a maximum metrics message.

69. The method of claim 68, wherein the maximum metrics message comprises a maximum number of levels message.

70. The method of claim 68, wherein the maximum metrics message comprises a maximum number of parameters message.

71. The method of claim 68, wherein the maximum metrics message comprises a maximum size of operation message.

72. The method of claim 20, wherein the message comprises a polymorphism metrics message.

73. The method of claim 72, wherein the polymorphism metrics message comprises a number of added methods message.

74. The method of claim 72, wherein the polymorphism metrics message comprises a number of overridden methods message.

75. The method of claim 72, wherein the polymorphism metrics message comprises a polymorphism factor message.

76. The method of claim 20, wherein the message comprises a ratio metrics message.

77. The method of claim 76, wherein the ratio metrics message comprises a comment ratio message.

78. The method of claim 76, wherein the ratio metrics message comprises a percentage of package members message.

79. The method of claim 76, wherein the ratio metrics message comprises a percentage of private members message.

80. The method of claim 76, wherein the ratio metrics message comprises a percentage of protected members message.

81. The method of claim 76, wherein the ratio metrics message comprises a percentage of public members message.

82. The method of claim 76, wherein the ratio metrics message comprises a true comment ratio message.

83. The method of claim 20, wherein the message comprises a coding style audits message.

84. The method of claim 83, wherein the coding style audits message comprises an avoid complex initialization or update clause in for loops message.

85. The method of claim 83, wherein the coding style audits message comprises an avoid implementation packages referencing message.

86. The method of claim 83, wherein the coding style audits message comprises an access of static members through objects message.

87. The method of claim 83, wherein the coding style audits message comprises an assignment to formal parameters message.

88. The method of claim 83, wherein the coding style audits message comprises an avoid too long files message.

89. The method of claim 83, wherein the coding style audits message comprises an avoid too long lines message.

90. The method of claim 83, wherein the coding style audits message comprises a complex assignment message.

91. The method of claim 83, wherein the coding style audits message comprises a don't code numerical constants directly message.

92. The method of claim 83, wherein the coding style audits message comprises a don't place multiple statements on the same line message.

93. The method of claim 83, wherein the coding style audits message comprises a don't use the negation operator frequently message.

94. The method of claim 83, wherein the coding style audits message comprises an operator '?:' may not be used message.

95. The method of claim 83, wherein the coding style audits message comprises a parenthesize conditional part of ternary conditional expression message.

96. The method of claim 83, wherein the coding style audits message comprises a put declarations only at the beginning of blocks message.

97. The method of claim 83, wherein the coding style audits message comprises a provide incremental in for-statement or use while-statement message.

98. The method of claim 83, wherein the coding style audits message comprises a replacement for demand imports message.

99. The method of claim 83, wherein the coding style audits message comprises a switch statement should include a default case message.

100. The method of claim 83, wherein the coding style audits message comprises a use abbreviated assignment operator message.

101. The method of claim 83, wherein the coding style audits message comprises a use 'this' explicitly to access class members message.

102. The method of claim 20, wherein the message comprises a critical errors audits message.

103. The method of claim 102, wherein the critical errors audits message comprises an avoid hiding inherited attributes message.

104. The method of claim 102, wherein the critical errors audits message comprises an avoid hiding inherited static methods message.

105. The method of claim 102, wherein the critical errors audits message comprises a command query separation message.

106. The method of claim 102, wherein the critical errors audits message comprises a hiding of names message.

107. The method of claim 102, wherein the critical errors audits message comprises an inaccessible constructor or method matches message.

108. The method of claim 102, wherein the critical errors audits message comprises a multiple visible declarations with same name message.

109. The method of claim 102, wherein the critical errors audits message comprises an overriding a non-abstract method with an abstract method message.

110. The method of claim 102, wherein the critical errors audits message comprises an overriding a private method message.

111. The method of claim 102, wherein the critical errors audits message comprises an overloading within a subclass message.

112. The method of claim 102, wherein the critical errors audits message comprises a use of static attribute for initialization message.

113. The method of claim 20, wherein the message comprises a declaration style audits message.

114. The method of claim 113, wherein the declaration style audits message comprises a badly located array declarators message.

115. The method of claim 113, wherein the declaration style audits message comprises a constant private attributes must be final message.

116. The method of claim 113, wherein the declaration style audits message comprises a constant variables must be final message.

117. The method of claim 113, wherein the declaration style audits message comprises a declare variables in one statement each message.

118. The method of claim 113, wherein the declaration style audits message comprises an instantiated classes should be final message.

119. The method of claim 113, wherein the declaration style audits message comprises a list all public and package members first message.

120. The method of claim 113, wherein the declaration style audits message comprises an order of class members declaration message.

121. The method of claim 113, wherein the declaration style audits message comprises an order of appearance of modifiers message.

122. The method of claim 113, wherein the declaration style audits message comprises a put the main function last message.

123. The method of claim 113, wherein the declaration style audits message comprises a place public class first message.

124. The method of claim 20, wherein the message comprises a documentation audits message.

125. The method of claim 124, wherein the documentation audits message comprises a bad tag in JavaDoc comments message.

126. The method of claim 124, wherein the documentation audits message comprises a distinguish between JavaDoc and ordinary comments message.

127. The method of claim 124, wherein the documentation audits message comprises a provide file comments message.

128. The method of claim 124, wherein the documentation audits message comprises a provide JavaDoc comments message.

129. The method of claim 20, wherein the message comprises a naming style audits message.

130. The method of claim 129, wherein the naming style audits message comprises a class name must match its file name message.

131. The method of claim 129, wherein the naming style audits message comprises a group operations with same name together message.

132. The method of claim 129, wherein the naming style audits message comprises a naming conventions message.

133. The method of claim 129, wherein the naming style audits message comprises a names of exception classes message.

134. The method of claim 129, wherein the naming style audits message comprises a use conventional variable names message.

135. The method of claim 20, wherein the message comprises a performance audits message.

136. The method of claim 135, wherein the performance audits message comprises an avoid declaring variables inside loops message.

137. The method of claim 135, wherein the performance audits message comprises an append to string within a loop message.

138. The method of claim 135, wherein the performance audits message comprises a complex loop expressions message.

139. The method of claim 20, wherein the message comprises a possible error audits message.

140. The method of claim 139, wherein the possible error audits message comprises an avoid empty catch blocks message.

141. The method of claim 139, wherein the possible error audits message comprises an avoid public and package attributes message.

142. The method of claim 139, wherein the possible error audits message comprises an avoid statements with empty body message.

143. The method of claim 139, wherein the possible error audits message comprises an assignment to for-loop variables message.

144. The method of claim 139, wherein the possible error audits message comprises a don't compare floating point types message.

145. The method of claim 139, wherein the possible error audits message comprises an enclosing body within a block message.

146. The method of claim 139, wherein the possible error audits message comprises an explicitly initialize all variables message.

147. The method of claim 139, wherein the possible error audits message comprises a method finalize( ) doesn't call super.finalize( ) message.

148. The method of claim 139, wherein the possible error audits message comprises a mixing logical operators without parentheses message.

149. The method of claim 139, wherein the possible error audits message comprises a no assignments in conditional expressions message.

150. The method of claim 139, wherein the possible error audits message comprises a supply break or comment in case statement message.

151. The method of claim 139, wherein the possible error audits message comprises a use 'equals' instead of '=' message.

152. The method of claim 139, wherein the possible error audits message comprises a use 'L' instead of 'l' at the end of integer constant message.

153. The method of claim 139, wherein the possible error audits message comprises a use of the 'synchronized' modifier message.

154. The method of claim 20, wherein the message comprises a superfluous content audits message.

155. The method of claim 154, wherein the superfluous content audits message comprises a duplicate import declarations message.

156. The method of claim 154, wherein the superfluous content audits message comprises a don't import the package the source file belongs to message.

157. The method of claim 154, wherein the superfluous content audits message comprises an explicit import of the java.lang classes message.

158. The method of claim 154, wherein the superfluous content audits message comprises an equality operations on boolean arguments message.

159. The method of claim 154, wherein the superfluous content audits message comprises an imported items must be used message.

160. The method of claim 154, wherein the superfluous content audits message comprises an unnecessary casts message.

161. The method of claim 154, wherein the superfluous content audits message comprises an unnecessary 'instanceof' evaluations message.

162. The method of claim 154, wherein the superfluous content audits message comprises an unused local variables and formal parameters message.

163. The method of claim 154, wherein the superfluous content audits message comprises a use of obsolete interface modifier message.

164. The method of claim 154, wherein the superfluous content audits message comprises a use of unnecessary interface member modifiers message.

165. The method of claim 154, wherein the superfluous content audits message comprises an unused private class member message.

166. The method of claim 154, wherein the superfluous content audits message comprises an unnecessary return statement parentheses message.

167. A method in a data processing system for developing source code comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code:

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

detecting an error in the source code;

generating a message reflecting the error;

locating a portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message in a visually distinctive manner;

determining whether the graphical representation of the portion of the source code corresponding to the message is displayed; and

when it is determined that the graphical representation of the portion of the source code corresponding to the message is not displayed, displaying the graphical representation of the portion of the source code corresponding to the message; and

modifying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

168. The method of claim 167, wherein the message is generated by a verification tool.

169. The method of claim 168, wherein the verification tool comprises a compiler.

170. The method of claim 168, wherein the verification tool comprises a quality assurance module.

171. The method of claim 167, wherein the message comprises an error message.

172. The method of claim 167, wherein the message comprises a line number of the source code.

173. The method of claim 172, wherein the portion of the source code corresponding to the message is located using the line number.

174. The method of claim 167, wherein the message comprises a name of a file containing the source code.

175. The method of claim 167, wherein the graphical representation comprises a class diagram.

176. A method in a data processing system for developing source code comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

detecting an error in the source code;

generating a message reflecting the error;

locating a portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message; and

displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

177. The method of claim 176, wherein the message is generated by a verification tool.

178. The method of claim 177, wherein the verification tool comprises a compiler.

179. The method of claim 177, wherein the verification tool comprises a quality assurance module.

180. The method of claim 176, wherein the message comprises an error message.

181. The method of claim 176, wherein the message comprises a line number of the source code.

182. The method of claim 181, wherein the portion of the source code corresponding to the message is located using the line number.

183. The method of claim 176, wherein the message comprises a name of a file containing the source code.

184. The method of claim 176, wherein the graphical representation comprises a class diagram.

185. A method in a data processing system for developing source code comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

detecting an error in the source code;

generating a message reflecting the error; and

displaying the graphical representation generated from the language-neutral representation in the transient meta model pertaining to a portion of the source code corresponding to the message in a visually distinctive manner.

186. The method of claim 185, wherein the message is generated by a verification tool.

187. The method of claim 186, wherein the verification tool comprises a compiler.

188. The method of claim 186, wherein the verification tool comprises a quality assurance module.

189. The method of claim 185, wherein the message comprises an error message.

190. The method of claim 185, wherein the message comprises a line number of the source code.

191. The method of claim 190, wherein the portion of the source code corresponding to the message is located using the line number.

192. The method of claim 185, wherein the message comprises a name of a file containing the source code.

193. The method of claim 185, wherein the graphical representation comprises a class diagram.

194. A computer-readable medium containing instructions for controlling a data processing system to perform a method, the data processing system having source code, the method comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

receiving a message corresponding to a portion of the source code;

locating the portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message in a visually distinctive manner;

determining whether the graphical representation of the portion of the source code corresponding to the message is displayed; and

when it is determined that the graphical representation of the portion of the source code corresponding to the message is not displayed, displaying the graphical representation of the portion of the source code corresponding to the message; and

modifying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

195. The computer-readable medium of claim 194, wherein the message is received from a verification tool.

196. The computer-readable medium of claim 195, wherein the verification tool comprises a compiler.

197. The computer-readable medium of claim 195, wherein the verification tool comprises a quality assurance module.

198. The computer-readable medium of claim 194, wherein the message comprises an error message.

199. The computer-readable medium of claim 194, wherein the message comprises a line number of the source code.

200. The computer-readable medium of claim 199, wherein the portion of the source code corresponding to the message is located using the line number.

201. The computer-readable medium of claim 194, wherein the message comprises a name of a file containing the source code.

202. The computer-readable medium of claim 194, wherein the graphical representation comprises a class diagram.

203. A computer-readable medium containing instructions for controlling a data processing system to perform a method, the data processing system having source code, the method comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

receiving a message corresponding to a portion of the source code;

locating the portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message; and

displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

204. The computer-readable medium of claim 203, wherein the method further comprises the steps of:

detecting an error in the source code; and

generating a message reflecting the error.

205. The computer-readable medium of claim 203, wherein the message is received from a verification tool.

206. The computer-readable medium of claim 205, wherein the verification tool comprises a compiler.

207. The computer-readable medium of claim 205, wherein the verification tool comprises a quality assurance module.

208. The computer-readable medium of claim 203, wherein the message comprises an error message.

209. The computer-readable medium of claim 203, wherein the message comprises a line number of the source code.

210. The computer-readable medium of claim 209, wherein the portion of the source code corresponding to the message is located using the line number.

211. The computer-readable medium of claim 203, wherein the message comprises a name of a file containing the source code.

212. The computer-readable medium of claim 203, wherein the graphical representation comprises a class diagram.

213. A computer-readable medium containing instructions for controlling a data processing system to perform a method, the data processing system having source code, the method comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

receiving a message corresponding to a portion of the source code; and

displaying the graphical representation generated from the language-neutral representation in the transient meta model pertaining to the portion of the source code corresponding to the message in a visually distinctive manner.

214. The computer-readable medium of claim 213, wherein the message is received from a verification tool.

215. The computer-readable medium of claim 214, wherein the verification tool comprises a compiler.

216. The computer-readable medium of claim 214, wherein the verification tool comprises a quality assurance module.

217. The computer-readable medium of claim 213, wherein the message comprises an error message.

218. The computer-readable medium of claim 213, wherein the message comprises a line number of the source code.

219. The computer-readable medium of claim 218, wherein the portion of the source code corresponding to the message is located using the line number.

220. The computer-readable medium of claim 213, wherein the message comprises a name of a file containing the source code.

221. The computer-readable medium of claim 213, wherein the graphical representation comprises a class diagram.

222. A computer-readable medium containing instructions for controlling a data processing system to perform a method, the data processing system having source code, the method comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

detecting an error in the source code;

generating a message reflecting the error;

locating a portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message in a visually distinctive manner;

determining whether the graphical representation of the portion of the source code corresponding to the message is displayed; and

when it is determined that the graphical representation of the portion of the source code corresponding to the message is not displayed, displaying the graphical representation of the portion of the source code corresponding to the message; and

modifying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

223. The computer-readable medium of claim 222, wherein the message is generated by a verification tool.

224. The computer-readable medium of claim 223, wherein the verification tool comprises a compiler.

225. The computer-readable medium of claim 223, wherein the verification tool comprises a quality assurance module.

226. The computer-readable medium of claim 222, wherein the message comprises an error message.

227. The computer-readable medium of claim 222, wherein the message comprises a line number of the source code.

228. The computer-readable medium of claim 227, wherein the portion of the source code corresponding to the message is located using the line number.

229. The computer-readable medium of claim 222, wherein the message comprises a name of a file containing the source code.

230. The computer-readable medium of claim 222, wherein the graphical representation comprises a class diagram.

231. A computer-readable medium containing instructions for controlling a data processing system to perform a method, the data processing system having source code, the method comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

displaying a graphical representation of the source code generated from the language-neutral representation in the transient meta model;

detecting an error in the source code;

generating a message reflecting the error;

locating a portion of the source code corresponding to the message;

displaying the portion of the source code corresponding to the message; and

displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

232. The computer-readable medium of claim 231, wherein the message is generated by a verification tool.

233. The computer-readable medium of claim 232, wherein the verification tool comprises a compiler.

234. The computer-readable medium of claim 232, wherein the verification tool comprises a quality assurance module.

235. The computer-readable medium of claim 231, wherein the message comprises an error message.

236. The computer-readable medium of claim 231, wherein the message comprises a line number of the source code.

237. The computer-readable medium of claim 236, wherein the portion of the source code corresponding to the message is located using the line number.

238. The computer-readable medium of claim 231, wherein the message comprises a name of a file containing the source code.

239. The computer-readable medium of claim 231, wherein the graphical representation comprises a class diagram.

240. A computer-readable medium containing instructions for controlling a data processing system to perform a method, the data processing system having source code, the method comprising the steps of:

generating a transient meta model which stores a language-neutral representation of the source code;

detecting an error in the source code;

generating a message reflecting the error; and

displaying the graphical representation generated from the language-neutral representation in the transient meta model pertaining to a portion of the source code corresponding to the message in a visually distinctive manner.

241. The computer-readable medium of claim 240, wherein the message is generated by a verification tool.

242. The computer-readable medium of claim 241, wherein the verification tool comprises a compiler.

243. The computer-readable medium of claim 241, wherein the verification tool comprises a quality assurance module.

244. The computer-readable medium of claim 240, wherein the message comprises an error message.

245. The computer-readable medium of claim 240, wherein the message comprises a line number of the source code.

246. The computer-readable medium of claim 245, wherein the portion of the source code corresponding to the message is located using the line number.

247. The computer-readable medium of claim 240, wherein the message comprises a name of a file containing the source code.

248. The computer-readable medium of claim 240, wherein the graphical representation comprises a class diagram.

249. A data processing system comprising:

a secondary storage device further comprising source code;

a memory device further comprising a program that generates a transient meta model which stores a language-neutral representation of the source code, that displays a graphical representation of the source code generated from the language-neutral representation in the transient meta model, that receives a message corresponding to a portion of the source code, that locates the portion of the source code corresponding to the message, that displays the portion of the source code corresponding to the message, and that displays the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner; and

a processor for running the program.

250. The data processing system of claim 249, wherein the program further detects an error in the source code, and generates a message reflecting the error.

251. The data processing system of claim 249, wherein the message is received from a verification tool.

252. The data processing system of claim 251, wherein the verification tool comprises a compiler.

253. The data processing system of claim 251, wherein the verification tool comprises a quality assurance module.

254. The data processing system of claim 249, wherein the message comprises an error message.

255. The data processing system of claim 249, wherein the message comprises a line number of the source code.

256. The data processing system of claim 255, wherein the portion of the source code corresponding to the message is located using the line number.

257. The data processing system of claim 249, wherein the message comprises a name of a file containing the source code.

258. The data processing system of claim 249, wherein the graphical representation comprises a class diagram.

259. A data processing system comprising:

a secondary storage device further comprising source code;

a memory device further comprising a program that generates a transient meta model which stores a language-neutral representation of the source code, that displays a graphical representation of the source code generated from the language-neutral representation in the transient meta model, that detects an error in the source code, that generates a message reflecting the error, that locates a portion of the source code corresponding to the message, that displays the portion of the source code corresponding to the message, and that displays the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner; and

a processor for running the program.

260. The data processing system of claim 259, wherein the message is generated by a verification tool.

261. The data processing system of claim 260, wherein the verification tool comprises a compiler.

262. The data processing system of claim 260, wherein the verification tool comprises a quality assurance module.

263. The data processing system of claim 259, wherein the message comprises an error message.

264. The data processing system of claim 259, wherein the message comprises a line number of the source code.

265. The data processing system of claim 264, wherein the portion of the source code corresponding to the message is located using the line number.

266. The data processing system of claim 259, wherein the message comprises a name of a file containing the source code.

267. The data processing system of claim 259, wherein the graphical representation comprises a class diagram.

268. A system for developing source code comprising:

means for generating a transient meta model which stores a language-neutral representation of the source code;

means for receiving a message corresponding to a portion of the source code; and

means for displaying the graphical representation generated from the language-neutral representation in the transient meta model pertaining to the portion of the source code corresponding to the message in a visually distinctive manner.

Description

FIELD OF THE INVENTION

The present invention relates to a method and system for developing software. More particularly, the invention relates to a method and system for locating source code corresponding to a message from a verification tool.

BACKGROUND OF THE INVENTION

Computer instructions are written in source code. Although a skilled programmer can understand source code to determine what the code is designed to accomplish, with highly complex software systems, a graphical representation or model of the source code is helpful to organize and visualize the structure and components of the system. Using models, the complex systems are easily identified, and the structural and behavioral patterns can be visualized and documented.

The well-known Unified Modeling Language (UML) is a general-purpose notational language for visualizing, specifying, constructing, and documenting complex software systems. UML is used to model systems ranging from business information systems to Web-based distributed systems, to real-time embedded systems. UML formalizes the notion that real-world objects are best modeled as self-contained entities that contain both data and functionality. UML is more clearly described in the following references, which are incorporated herein by reference: (1) Martin Fowler, UML Distilled Second Edition: Applying the Standard Object Modeling Language, Addison-Wesley (1999); (2) Booch, Rumbaugh, and Jacobson, The Unified Modeling Language User Guide, Addison-Wesley (1998); (3) Peter Coad, Jeff DeLuca, and Eric Lefebvre, Java Modeling in Color with UML: Enterprise Components and Process, Prentice Hall (1999); and (4) Peter Coad, Mark Mayfield, and Jonathan Kern, Java Design: Building Better Apps & Applets (2nd Ed.), Prentice Hall (1998).

As shown in FIG. 1, conventional software development tools 100 allow a programmer to view UML 102 while viewing source code 104. The source code 104 is stored in a file, and a reverse engineering module 106 converts the source code 104 into a representation of the software project in a database or repository 108. The software project comprises source code 104 in at least one file which, when compiled, forms a sequence of instructions to be run by the data processing system. The repository 108 generates the UML 102. If any changes are made to the UML 102, they are automatically reflected in the repository 108, and a code generator 110 converts the representation in the repository 108 into source code 104. Such software development tools 100, however, do not synchronize the displays of the UML 102 and the source code 104. Rather, the repository 108 stores the representation of the software project while the file stores the source code 104. A modification in the UML 102 does not appear in the source code 104 unless the code generator 110 re-generates the source code 104 from the data in the repository 108. When this occurs, the portion of the source code 104 that is not protected from being overwritten is rewritten. Similarly, any modifications made to the source code 104 do not appear in the UML 102 unless the reverse engineering module 106 updates the repository 108. As a result, redundant information is stored in the repository 108 and the source code 104. In addition, rather than making incremental changes to the source code 104, conventional software development tools 100 rewrite the overall source code 104 when modifications are made to the UML 102, resulting in wasted processing time. This type of manual, large-grained synchronization requires either human intervention, or a "batch" style process to try to keep the two views (the UML 102 and the source code 104) in sync. Unfortunately, this approach, adopted by many tools, leads to many undesirable side-effects; such as desired changes to the source code being overwritten by the tool. A further disadvantage with conventional software development tools 100 is that they are designed to only work in a single programming language. Thus, a tool 100 that is designed for Java™ programs cannot be utilized to develop a program in C++. There is a need in the art for a tool that avoids the limitations of these conventional software development tools.

SUMMARY OF THE INVENTION

Methods and systems consistent with the present invention provide an improved software development tool that overcomes the limitations of conventional software development tools. The improved software development tool of the present invention allows a developer to simultaneously view a graphical and a textual display of source code. The graphical and textual views are synchronized so that a modification in one view is automatically reflected in the other view. In addition, the software development tool is designed for use with more than one programming language.

The improved software development tool enables a developer to quickly determine the location of an error detected by a verification tool. Not only can the developer locate the specific line of source code, but the software development tool also displays the graphical representation of the source code corresponding to the message in a visually distinctive manner. This assists the developer in debugging the source code by allowing the developer to visually determine the location of the error.

In accordance with methods consistent with the present invention, a method is provided in a data processing system for developing source code. The method comprises the steps of receiving a message corresponding to a portion of the source code, and displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

In accordance with methods consistent with the present invention, a method is provided in a data processing system for developing source code. The method comprises the steps of detecting an error in the source code, generating a message reflecting the error, and displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

In accordance with articles of manufacture consistent with the present invention, a computer-readable medium is provided. The computer-readable medium contains instructions for controlling a data processing system to perform a method. The data processing system has source code. The method comprises the steps of receiving a message corresponding to a portion of the source code, and displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

In accordance with articles of manufacture consistent with the present invention, a computer-readable medium is provided. The computer-readable medium contains instructions for controlling a data processing system to perform a method. The data processing system has source code. The method comprises the steps of detecting an error in the source code, generating a message reflecting the error, and displaying the graphical representation of the portion of the source code corresponding to the message in a visually distinctive manner.

Other systems, methods, features and advantages of the invention will be or will become apparent to one with skill in the art upon examination of the following figures and detailed description. It is intended that all such additional systems, methods, features and advantages be included within this description, be within the scope of the invention, and be protected by the accompanying claims.

BRIEF DESCRIPTION OF THE DRAWINGS

The accompanying drawings, which are incorporated in and constitute a part of this specification, illustrate an implementation of the invention and, together with the description, serve to explain the advantages and principles of the invention. In the drawings,

FIG. 1 depicts a conventional software development tool;

FIG. 2 depicts an overview of a software development tool in accordance with methods and systems consistent with the present invention;

FIG. 3 depicts a data structure of the language-neutral representation created by the software development tool of FIG. 2;

FIG. 4 depicts representative source code;

FIG. 5 depicts the data structure of the language-neutral representation of the source code of FIG. 4;

FIG. 6 depicts a data processing system suitable for practicing the present invention;

FIG. 7 depicts an architectural overview of the software development tool of FIG. 2;

FIG. 8 depicts a flow diagram of the steps performed by the software development tool depicted in FIG. 2;

FIG. 9 depicts a flow diagram illustrating the update model step of FIG. 8;

FIG. 10 depicts a flow diagram of the steps performed by the software development tool in FIG. 2 when creating a class;

FIG. 11 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a use case diagram of source code;

FIG. 12 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays both a class diagram and a textual view of source code;

FIG. 13 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a sequence diagram of source code;

FIG. 14 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a collaboration diagram of source code;

FIG. 15 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a statechart diagram of source code;

FIG. 16 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays an activity diagram of source code;

FIG. 17 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a component diagram of source code;

FIG. 18 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a deployment diagram of source code;

FIG. 19A depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a list of predefined criteria which the software development tool checks in the source code;

FIG. 19B depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays the definition of the criteria which the software development tool checks in the source code, and an example of source code which does not conform to the criteria;

FIG. 19C depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays an example of source code which conforms to the criteria which the software development tool checks in the source code;

FIGS. 20A and B depict a flow diagram of the steps performed by the software development tool in FIG. 2 when locating source code related to a message from a verification tool;

FIG. 21 depicts a user interface displayed by the software development tool depicted in FIG. 2, where the user interface displays a message from a verification tool;

FIG. 22 depicts the user interface in FIG. 21 illustrating the selection of a message; and

FIG. 23 depicts the user interface in FIG. 22 after the selection of a message.

DETAILED DESCRIPTION OF THE INVENTION

Methods and systems consistent with the present invention provide an improved software development tool that creates a graphical representation of source code regardless of the programming language in which the code is written. In addition, the software development tool simultaneously reflects any modifications to the source code to both the display of the graphical representation as well as the textual display of the source code.

As depicted in FIG. 2, source code 202 is being displayed in both a graphical form 204 and a textual form 206. In accordance with methods and systems consistent with the present invention, the improved software development tool generates a transient meta model (TMM) 200 which stores a language-neutral representation of the source code 202. The graphical 204 and textual 206 representations of the source code 202 are generated from the language-neutral representation in the TMM 200. Alternatively, the textual view 206 of the source code may be obtained directly from the source code file. Although modifications made on the displays 204 and 206 may appear to modify the displays 204 and 206, in actuality all modifications are made directly to the source code 202 via an incremental code editor (ICE) 208, and the TMM 200 is used to generate the modifications in both the graphical 204 and the textual 206 views from the modifications to the source code 202.

The improved software development tool provides simultaneous round-trip engineering, i.e., the graphical representation 204 is synchronized with the textual representation 206. Thus, if a change is made to the source code 202 via the graphical representation 204, the textual representation 206 is updated automatically. Similarly, if a change is made to the source code 202 via the textual representation 206, the graphical representation 204 is updated to remain synchronized. There is no repository, no batch code generation, and no risk of losing code.

The data structure 300 of the language-neutral representation is depicted in FIG. 3. The data structure 300 comprises a Source Code Interface (SCI) model 302, an SCI package 304, an SCI class 306, and an SCI member 308. The SCI model 302 is the source code organized into packages. The SCI model 302 corresponds to a directory for a software project being developed by the user, and the SCI package 304 corresponds to a subdirectory. The software project comprises the source code in at least one file that is compiled to form a sequence of instructions to be run by a data processing system. The data processing system is discussed in detail below. As is well known in object-oriented programming, the class 306 is a category of objects which describes a group of objects with similar properties (attributes), common behavior (operations or methods), common relationships to other objects, and common semantics. The members 308 comprise attributes and/or operations.

For example, the data structure 500 for the source code 400 depicted in FIG. 4 is depicted in FIG. 5. UserInterface 402 is defined as a package 404. Accordingly, UserInterface 402 is contained in SCI package 502. Similarly, Bank 406, which is defined as a class 408, is contained in SCI class 504, and Name 410 and Assets 412, which are defined as attributes (strings 414), are contained in SCI members 506. Since these elements are in the same project, all are linked. The data structure 500 also identifies the language in which the source code is written 508, e.g., the Java™ programming language.

FIG. 6 depicts a data processing system 600 suitable for practicing methods and systems consistent with the present invention. Data processing system 600 comprises a memory 602, a secondary storage device 604, an I/O device 606, and a processor 608. Memory 602 includes the improved software development tool 610. The software development tool 610 is used to develop a software project 612, and create the TMM 200 in the memory 602. The project 612 is stored in the secondary storage device 604 of the data processing system 600. One skilled in the art will recognize that data processing system 600 may contain additional or different components.

Although aspects of the present invention are described as being stored in memory, one skilled in the art will appreciate that these aspects can also be stored on or read from other types of computer-readable media, such as secondary storage devices, like hard disks, floppy disks or CD-ROM; a carrier wave from a network, such as Internet; or other forms of RAM or ROM either currently known or later developed.

FIG. 7 illustrates an architectural overview of the improved software development tool 610. The tool 610 comprises a core 700, an open application program interface (API) 702, and modules 704. The core 700 includes a parser 706 and an ICE 208. The parser 706 converts the source code into the language-neutral representation in the TMM, and the ICE 208 converts the text from the displays into source code. There are three main packages composing the API 702: Integrated Development Environment (IDE) 708; Read-Write Interface (RWI) 710; and Source Code Interface (SCI) 712. Each package includes corresponding subpackages. As is well known in the art, a package is a collection of attributes, notifications, operations, or behaviors that are treated as a single module or program unit.

IDE 708 is the API 702 needed to generate custom outputs based on information contained in a model. It is a read-only interface, i.e., the user can extract information from the model, but not change the model. IDE 708 provides the functionality related to the model's representation in IDE 708 and interaction with the user. Each package composing the IDE group has a description highlighting the areas of applicability of this concrete package. RWI 710 enables the user to go deeper into the architecture. Using RWI 710, information can be extracted from and written to the models. RWI not only represents packages, classes and members, but it may also represent different diagrams (class diagrams, use case diagrams, sequence diagrams and others), links, notes, use cases, actors, states, etc.

SCI 712 is at the source code level, and allows the user to work with the source code almost independently of the language being used.

The improved software development tool of the present invention is used to develop source code in a project. The project comprises a plurality of files and the source code of a chosen one of the plurality of files is written in a given language. The software development tool determines the language of the source code of the chosen file, converts the source code from the language into a language-neutral representation, uses the language-neutral representation to textually display the source code of the chosen file in the language, and uses the language-neutral representation to display a graphical representation of at least a portion of the project. The source code and the graphical representation are displayed simultaneously.

The improved software development tool of the present invention is also used to develop source code. The software development tool receives an indication of a selected language for the source code, creates a file to store the source code in the selected language, converts the source code from the selected language into a language-neutral representation, uses the language-neutral representation to display the source code of the file, and uses the language-neutral representation to display a graphical representation of the file. Again, the source code and the graphical representation are displayed simultaneously.

Moreover, if the source code in the file is modified, the modified source code and a graphical representation of at least a portion of the modified source code are displayed simultaneously. The QA module of the software development tool provides an error message if the modification does not conform to predefined or user-defined styles, as described above. The modification to the source code may be received by the software development tool via the programmer editing the source code in the textual pane or the graphical pane, or via some other independent software tool that the programmer uses to modify the code. The graphical representation of the project may be in Unified Modeling Language; however, one skilled in the art will recognize that other graphical representations of the source code may be displayed. Further, although the present invention is described and shown using the various views of the UML, one of ordinary skill in the art will recognize that other views may be displayed.

FIG. 8 depicts a flow diagram of the steps performed by the software development tool to develop a project in accordance with methods and systems consistent with the present invention. As previously stated, the project comprises a plurality of files. The developer either uses the software development tool to open a file that contains existing source code, or to create a file in which the source code will be developed. If the software development tool is used to open the file, determined in step 800, the software development tool initially determines the programming language in which the code is written (step 802). The language is identified by the extension of the file, e.g., "java" identifies source code written in the Java™ language, while ".cpp" identifies source code written in C++. The software development tool then obtains a template for the current programming language, i.e., a collection of generalized definitions for the particular language that can be used to build the data structure (step 804). For example, the templates used to define a new Java™ class contains a default name, e.g., "Class1," and the default code, "public class Class1 { }." Such templates are well known in the art. For example, the "Microsoft Foundation Class Library" and the "Microsoft Word Template For Business Use Case Modeling" are examples of standard template libraries from which programmers can choose individual template classes. The software development tool uses the template to parse the source code (step 806), and create the data structure (step 808). After creating the data structure or if there is no existing code, the software development tool awaits an event, i.e., a modification or addition to the source code by the developer (step 810). If an event is received and the event is to close the file (step 812), the file is saved (step 814) and closed (step 816). Otherwise, the software development tool performs the event (step 818), i.e., the tool makes the modification. The software development tool then updates the TMM or model (step 820), as discussed in detail below, and updates both the graphical and the textual views (step 822).

FIG. 9 depicts a flow diagram illustrating the update model step of FIG. 8. The software development tool selects a file from the project (step 900), and determines whether the file is new (step 902), whether the file has been updated (step 904), or whether the file has been deleted (step 906). If the file is new, the software development tool adds the additional symbols from the file to the TMM (step 908). To add the symbol to the TMM, the software development tool uses the template to parse the symbol to the TMM. If the file has been updated, the software development tool updates the symbols in the TMM (step 910). Similar to the addition of a symbol to the TMM, the software development tool uses the template to parse the symbol to the TMM. If the file has been deleted, the software development tool deletes the symbols in the TMM (step 912). The software development tool continues this analysis for all files in the project. After all files are analyzed (step 914), any obsolete symbols in the TMM (step 916) are deleted (step 918).

FIG. 10 depicts a flow diagram illustrating the performance of an event, specifically the creation of a class, in accordance with methods and systems consistent with the present invention. After identifying the programming language (step 1000), the software development tool obtains a template for the language (step 1002), creates a source code file in the project directory (step 1004), and pastes the template onto the TMM (step 1006). The project directory corresponds to the SCI model 302 of FIG. 3. Additional events which a developer may perform using the software development tool include the creation, modification or deletion of packages, projects, attributes, interfaces, links, operations, and the closing of a file.

Applications to be developed using the software development tool are collectively broken into three views of the application: the static view, the dynamic view, and the functional view. The static view is modeled using the use-case and class diagrams. A use case diagram 1100, depicted in FIG. 11, shows the relationship among actors 1102 and use cases 1104 within the system 1106. A class diagram 1200, depicted in FIG. 12 with its associated source code 1202, on the other hand, includes classes 1204, interfaces, packages and their relationships connected as a graph to each other and to their contents.

The dynamic view is modeled using the sequence, collaboration and statechart diagrams. As depicted in FIG. 13, a sequence diagram 1300 represents an interaction, which is a set of messages 1302 exchanged among objects 1304 within a collaboration to effect a desired operation or result. In a sequence diagram 1300, the vertical dimension represents time and the horizontal dimension represents different objects. A collaboration diagram 1500, depicted in FIG. 15, is also an interaction with messages 1502 exchanged among objects 1504, but it is also a collaboration, which is a set of objects 1504 related in a particular context. Contrary to sequence diagrams 1300 (FIG. 13), which emphasize the time ordering of messages along the vertical axis, collaboration diagrams 1400 (FIG. 14) emphasize the structural organization of objects.

A statechart diagram 1500 is depicted in FIG. 15. The statechart diagram 1500 includes the sequences of states 1502 that an object or interaction goes through during its life in response to stimuli, together with its responses and actions. It uses a graphic notation that shows states of an object, the events that cause a transition from one state to another, and the actions that result from the transition.

The functional view can be represented by activity diagrams 1600 and more traditional descriptive narratives such as pseudo code and minispecifications. An activity diagram 1600 is depicted in FIG. 16, and is a special case of a state diagram where most, if not all, of the states are action states 1602 and where most, if not all, of the transitions are triggered by completion of the actions in the source states. Activity diagrams 1600 are used in situations where all or most of the events represent the completion of internally generated actions.

There is also a fourth view mingled with the static view called the architectural view. This view is modeled using package, component and deployment diagrams. Package diagrams show packages of classes and the dependencies among them. Component diagrams 1700, depicted in FIG. 17, are graphical representations of a system or its component parts. Component diagrams 1700 show the dependencies among software components, including source code components, binary code components and executable components. As depicted in FIG. 18, Deployment diagrams 1800 are used to show the distribution strategy for a distributed object system. Deployment diagrams 1800 show the configuration of run-time processing elements and the software components, processes and objects that live on them.

Although discussed in terms of class diagrams, one skilled in the art will recognize that the software development tool of the present invention may support these and other graphical views.

QUALITY ASSURANCE MODULE

There are a variety of modules 704 in the software development tool 610 of the present invention. Some of the modules 704 access information to generate graphical and code documentation in custom formats, export to different file formats, or develop patterns. The software development tool also includes a quality assurance (QA) module which monitors the modifications to the source code and calculates various complexity metrics, i.e., various measurements of the program's performance or efficiency, to support quality assurance. The types of metrics calculated by the software development tool include basic metrics, cohesion metrics, complexity metrics, coupling metrics, Halstead metrics, inheritance metrics, maximum metrics, polymorphism metrics, and ratio metrics. Examples of these metrics with their respective definitions are identified in Tables 1-9 below.