System and methodology for asynchronous code refactoring with symbol injection

• US 7,370,318 B1
• Filed: 09/02/2004
• Issued: 05/06/2008
• Est. Priority Date: 09/02/2004
• Status: Expired due to Fees

• Current Assignee: Borland Software Corporation (Open Text Corporation)
• Original Assignee: Borland Software Corporation (Open Text Corporation)
• Inventors: Litchev, Lubomir B., Howe, Mark K., Kemper, Christian K.
• Primary Examiner(s): Kiss; Eric B.
• Assistant Examiner(s): Nahar; Qamrun
• Application Number:
  US10/711,230
• Time in Patent Office: 1,342 Days
• Field of Search: 717/110, 717/111, 717/112, 717/113
• US Class Current: 717/110
• CPC Class Codes: G06F 8/427 Parsing
• CPC Class Codes: G06F 8/436 Semantic checking
• CPC Class Codes: G06F 8/4441 Reducing the execution time required by the program code
• CPC Class Codes: G06F 8/72 Code refactoring

Abstract

A system and methodology for asynchronous code refactoring with symbol injection is described. In one embodiment, for example, a method is described for refactoring a plurality of interdependent software modules that reside in separate projects, the method comprises steps of: in response to a change that affects a particular symbol of a software module that resides in a first project, refactoring the software module of the first project to propagate the change to all instances of the particular symbol in the software module; during the refactoring of the software module of the first project, recording meta data about the refactoring that is required to effect the change; and automatically propagating the change to a dependent software module residing in a second project, by refactoring the dependent software module based on the recorded meta data about the refactoring that occurred to the software module of the first project.

Claims

1. A method for refactoring a plurality of interdependent software modules that reside in separate projects, the method comprising:

in response to a change that affects a particular symbol of a software module that resides in a first project, refactoring the software module of the first project to propagate the change to all instances of the particular symbol in the software module;

during the refactoring of the software module of the first project at a given point in time, recording meta data about the refactoring that is required to effect the change; and

at a subsequent point in time, automatically propagating the change to a dependent software module residing in a second project, by refactoring the dependent software module based on the recorded meta data about the refactoring that occurred to the software module of the first project;

wherein the dependent software module is refactored with assistance of a symbol table used for resolving symbol references, and wherein said automatically propagating step includes;

copying symbol information about the particular symbol used for the software module of the first project into the symbol table used for refactoring the dependent software module.

2. The method of claim 1, further comprising:

removing symbol information about the particular symbol used for the software module of the first project from the symbol table used for refactoring the dependent software module after the refactoring of the dependent software module.

3. The method of claim 1, wherein said copying symbol information step includes copying symbol information into a compiler symbol table used for refactoring the dependent software module.

4. The method of claim 1, wherein said copying symbol information step includes creating source code based on the recorded meta data.

5. The method of claim 4, further comprising:

parsing the source code so as to indirectly inject symbol information into the symbol table used for refactoring the dependent software module.

6. The method of claim 4, wherein said copying symbol information step includes indirectly injecting symbol information for a class into the symbol table by parsing the source code and directly injecting symbol information for members of the class into the symbol table.

7. The method of claim 4, further comprising:

deleting the source code after refactoring the dependent software module.

8. The method of claim 1, wherein the refactoring of the software module of the first project comprises a selected one of renaming a package, changing a method signature, renaming a method, renaming a field, and renaming a class.

9. The method of claim 1, wherein said automatically propagating step includes propagating changes to the dependent software module so as to maintain compatibility with the software module of the first project.

10. The method of claim 1, wherein said recording step includes recording meta data before and after refactoring of the software module of the first project.

11. The method of claim 1, wherein said recording step includes recording information in Extensible Markup Language (XML) format.

12. The method of claim 1, wherein the software module of the first project is in a first programming language and the dependent software module of the second project is in a second programming language.

13. A computer-readable medium having processor-executable instructions for performing the method of claim 1.

14. A downloadable set of processor-executable instructions for performing the method of claim 1.

15. A system for automatically applying a refactoring to a second software module based on a refactoring of a first software module, the system comprising:

a computer having a processor and memory;

a refactoring module for refactoring the first software module to propagate a change to all instances of a particular symbol in the first software module in response to the change that affects the particular symbol of the first software module;

a recording module for recording meta data about changes made to the first software module in a first project during the refactoring of the first software module at a given point in time;

an injector module for copying symbol information about the particular symbol of the first software module into a symbol table for the second software module in a second project; and

the refactoring module for automatically propagating the change to the second software module by applying a refactoring to the second software module at a subsequent point in time using said symbol table for the second software module and the recorded meta data about changes made to the first software module.

16. The system of claim 15, wherein the second software module is dependent upon the first software module.

17. The system of claim 16, wherein the refactoring module applies changes to the second software module so as to maintain compatibility of the second software module with the first software module.

18. The system of claim 15, wherein the refactoring of the first software module comprises a selected one of renaming a package, changing a method signature, renaming a method, renaming a field, and renaming a class.

19. The system of claim 15, wherein the injector module creates source code based on the first software module and the recorded information.

20. The system of claim 19, wherein said injector module decompiles at least a portion of the first software module for creating source code.

21. The system of claim 19, wherein the injector module parses the source code so as to indirectly inject symbol information into said symbol table.

22. The system of claim 15, wherein the injector module copies symbol information into a compiler symbol table used by the refactoring module in the refactoring of the second software module.

23. The system of claim 15, wherein the first software module comprises a library.

24. The system of claim 23, wherein the second software module comprises an application using the library.

25. The system of claim 15, wherein said recording module records information before and after refactoring of the first software module.

26. The system of claim 15, wherein said recording module records information in Extensible Markup Language (XML) format.

27. The system of claim 15, wherein the first software module runs on a first machine and the second software module runs on a second machine.

28. The system of claim 15, wherein the first software module is in a first programming language and the second software module is in a second programming language.

29. A method for asynchronous refactoring of a plurality of interdependent software programs, the method comprising:

refactoring a first software program residing in a first project so as to change symbols of the first software program;

recording information about changes made to symbols of the first software program during the refactoring of the first software program at a given point in time; and

at a subsequent point in time, applying the refactoring to a second software program in a second project which is dependent upon the first software program by automatically propagating changes to symbols of the second software program based on said recorded information;

wherein the second software program is refactored with assistance of a symbol table used for resolving symbol references, and wherein said applying step includes;

copying information about at least one symbol used in the first software program into the symbol table used for refactoring the second software program.

30. The method of claim 29, further comprising:

removing said information about at least one symbol used in the first software program from the symbol table after applying the refactoring of the second software program.

31. The method of claim 29, wherein said symbol table comprises a compiler symbol table.

32. The method of claim 29, wherein said copying information step includes creating source code based on the recorded information and parsing the source code so as to indirectly inject symbol information into the symbol table used for refactoring the second software program.

33. The method of claim 32, wherein said copying information step includes indirectly injecting symbol information for a class into the symbol table by parsing the source code and directly injecting symbol information for members of the class into the symbol table.

34. The method of claim 29, wherein said applying step includes applying the refactoring with assistance of a compiler for identifying and changing symbols of the second software program.

35. The method of claim 29, wherein the refactoring of the first software program comprises a selected one of renaming a package, changing a method signature, renaming a method, renaming a field, and renaming a class.

36. The method of claim 29, wherein the first software program comprises a library.

37. The method of claim 36, wherein the second software program comprises an application using the library.

38. The method of claim 29, wherein said recording step includes recording information before and after refactoring of the first software program.

39. The method of claim 29, wherein said recording step includes recording information in Extensible Markup Language (XML) format.

40. A computer-readable medium having processor-executable instructions for performing the method of claim 29.

41. A downloadable set of processor-executable instructions for performing the method of claim 29.

42. A method for applying a refactoring to a plurality of software modules, the method comprising:

recording information about changes made to a first software module in a first project during a refactoring of the first software module at a given point in time;

at a subsequent point in time, refactoring a second software module in a second project by performing substeps of;

creating at least one symbol table entry based upon the recorded information about changes made to the first software module;

wherein said creating substep includes creating source code based on the first software module and the recorded information;

injecting said at least one symbol table entry into a symbol table for a second software module;

wherein said injecting substep includes indirectly injecting symbol table entries for a class into the symbol table by parsing the source code and directly injecting symbol table entries for members of the class into the symbol table; and

refactoring the second software module using said symbol table and the recorded information about changes made to the first software module.

43. The method of claim 42, wherein the second software module is dependent upon the first software module.

44. The method of claim 43, wherein said refactoring the second software module step includes applying changes to the second software module so as to maintain compatibility with the first software module.

45. The method of claim 42, wherein the refactoring of the first software module comprises a selected one of renaming a package, changing a method signature, renaming a method, renaming a field, and renaming a class.

46. The method of claim 42, wherein said substep of creating source code includes decompiling at least a portion of the first software module.

47. The method of claim 42, wherein said injecting substep includes parsing the source code so as to indirectly inject a symbol table entry into said symbol table.

48. The method of claim 42, further comprising:

removing said at least one symbol table entry from said symbol table after applying the refactoring to the second software module.

49. The method of claim 42, wherein said symbol table comprises a compiler symbol table.

50. The method of claim 42, wherein said recording step includes recording information before and after refactoring of the first software module.

51. The method of claim 42, wherein said recording step includes recording information in Extensible Markup Language (XML) format.

52. The method of claim 42, wherein the first software module runs on a first machine and the second software module runs on a second machine.

53. The method of claim 42, wherein the first software module is in a first programming language and the second software module is in a second programming language.

54. A computer-readable medium having processor-executable instructions for performing the method of claim 42.

55. A downloadable set of processor-executable instructions for performing the method of claim 42.