Technique for automating code generation in developing software systems

• US 7,793,257 B2
• Filed: 08/28/2003
• Issued: 09/07/2010
• Est. Priority Date: 08/28/2003
• Status: Active Grant

• Current Assignee: Ricoh Company Limited
• Original Assignee: Ricoh Company Limited
• Inventors: Motoyama, Tetsuro, Fong, Avery
• Primary Examiner(s): Deng; Anna
• Application Number:
  US10/652,603
• Publication Number:
  US 20050050520A1
• Time in Patent Office: 2,567 Days
• Field of Search: 717/106
• US Class Current: 717/106
• CPC Class Codes: G06F 8/20 Software design
• CPC Class Codes: G06F 8/30 Creation or generation of source code

Abstract

Programming the creation of a software system is facilitated by automating the generation of some of the program code that is necessary for the software system. The generation of program code may be automated based on a software design specification that can be created by developers. The software design specification may be scanned and code may be generated for implementing the software system based on information obtained from scanning the software design specification.

Claims

1. A method for automatically generation program code, the method comprising the computer-implemented steps of:

examining an input directory containing a plurality of sub-directories and files that form a software design specification that specifies how a software system is to be implemented, wherein examining the input directory includes identifying a section of the software design specification that defines a software class;

identifying a tree directory structure of the input directory that contains the plurality of sub-directories and files that form the software design specification;

creating an output directory having a tree directory structure that is subset of the tree directory structure of the input directory;

traversing the input directory over the tree directory structure to identify and examine one or more files that form the software design specification;

detecting one or more designated characteristics of the software system from examining the one or more files that form the software design specification; and

if the one or more designated characteristics indicate that the one or more files are associated with program code, then

automatically generating program code for implementing at least a portion of the software system based upon the designated characteristics; and

storing a plurality of files containing the program code in the output directory that has a tree directory structure that is subset of the tree directory structure of the input directory, wherein storing the plurality of files includes storing at least one file containing code for each identified software class to a node of the output directory, wherein the node of the output directory is based on a node where a file containing the software class is designated in the input directory containing the plurality of sub-directories and files that form the software design specification.

2. The method of claim 1, wherein generating program code includes creating a program file and generating a skeleton code for the program file.

3. The method of claim 1, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes identifying a section of the software design specification that defines at least a portion of a software class.

4. The method of claim 3, wherein generating program code includes generating, for the software class, a first file containing a first set of program code that, after the first file is compiled, is used for declaring one or more functions of the software class.

5. The method of claim 4, wherein generating program code includes generating, for the software class, a second file containing a second set of program code that, after the second set of code is compiled, is used for implementing the software class.

6. The method of claim 5, wherein generating a second file includes generating program code corresponding to a list of functions that are to be used by the software class.

7. The method of claim 6, wherein generating program code corresponding to a list of one or more functions includes identifying the list of functions from a portion of the software design specification that defines the software class.

8. The method of claim 7, wherein identifying the list of functions includes identifying one or more characters from the portion of the software design specification, wherein the one or more characters is designated as corresponding to a function for the software class.

9. The method of claim 4, wherein generating a first file includes generating program code corresponding to a set of class attributes that are to be used by the software class.

10. The method of claim 5, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes identifying one or more sections of the software design specification that are comments for files containing code, and wherein the steps of generating the first file and the second file include copying at least some of the sections of the software design specification that are the comments into at least one of the first file or the second file.

11. The method of claim 10, wherein the step of identifying one or more sections of the software design specification that are comments for program files includes identifying a character in the software design specification that delineates the comment in a file of the software design specification.

12. The method of claim 1, wherein the step of generating program code includes generating a header for at least one file containing program code.

13. The method of claim 1, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes examining one or more files that form the software design specification, wherein the one or more files are formatted in one or more of a hypertext transfer markup language (HTML), an extensible markup language (XML), or a text file.

14. The method of claim 1, wherein the step of generating program code includes mapping one or more of the designated characteristics to a specific syntax that is to be part of the software system.

15. A computer-readable storage medium for automatically generation program code, the computer-readable storage medium carrying instructions which, when processed by one or more processors, cause:

examining an input directory containing a plurality of sub-directories and files that form a software design specification that specifies how a software system is to be implemented, wherein examining the input directory includes identifying a section of the software design specification that defines a software class;

identifying a tree directory structure of the input directory that contains the plurality of sub-directories and files that form the software design specification;

creating an output directory having a tree directory structure that is subset of the tree directory structure of the input directory;

traversing the input directory over the tree directory structure to identify and examine one or more files that form the software design specification;

detecting one or more designated characteristics of the software system from examining the one or more files that form the software design specification; and

if the one or more designated characteristics indicate that the one or more files are associated with program code, then

automatically generating program code for implementing at least a portion of the software system based upon the designated characteristics; and

storing a plurality of files containing the program code in the output directory that has a tree directory structure that is subset of the tree directory structure of the input directory, wherein storing the plurality of files includes storing at least one file containing code for each identified software class to a node of the output directory, wherein the node of the output directory is based on a node where a file containing the software class is designated in the input directory containing the plurality of sub-directories and files that form the software design specification.

16. The computer-readable storage medium of claim 15, wherein generating program code includes creating a program file and generating a skeleton code for the program file.

17. The computer-readable storage medium of claim 15, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes identifying a section of the software design specification that defines at least a portion of a software class.

18. The computer-readable storage medium of claim 17, wherein generating program code includes generating, for the software class, a first file containing a first set of program code that, after the first file is compiled, is used for declaring one or more functions of the software class.

19. The computer-readable storage medium of claim 18, wherein generating program code includes generating, for the software class, a second file containing a second set of program code that, after the second set of code is compiled, is used for implementing the software class.

20. The computer-readable storage medium of claim 19, wherein generating a second file includes generating program code corresponding to a list of functions that are to be used by the software class.

21. The computer-readable storage medium of claim 20, wherein generating program code corresponding to a list of one or more functions includes identifying the list of functions from a portion of the software design specification that defines the software class.

22. The computer-readable storage medium of claim 21, wherein identifying the list of functions includes identifying one or more characters from the portion of the software design specification, wherein the one or more characters is designated as corresponding to a function for the software class.

23. The computer-readable storage medium of claim 18, wherein generating a first file includes generating program code corresponding to a set of class attributes that are to be used by the software class.

24. The computer-readable storage medium of claim 19, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes identifying one or more sections of the software design specification that are comments for files containing code, and wherein the steps of generating the first file and the second file include copying at least some of the sections of the software design specification that are the comments into at least one of the first file or the second file.

25. The computer-readable storage medium of claim 24, wherein the step of identifying one or more sections of the software design specification that are comments for program files includes identifying a character in the software design specification that delineates the comment in a file of the software design specification.

26. The computer-readable storage medium of claim 15, wherein the step of generating program code includes generating a header for at least one file containing program code.

27. The computer-readable storage medium of claim 15, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes examining one or more files that form the software design specification, wherein the one or more files are formatted in one or more of a hypertext transfer markup language (HTML), an extensible markup language (XML), or a text file.

28. The computer-readable storage medium of claim 15, wherein the step of generating program code includes mapping one or more of the designated characteristics to a specific syntax that is to be part of the software system.

29. An apparatus for automatically generation program code, the apparatus comprising a memory having instructions which, when processed by one or more processors, cause:

examining an input directory containing a plurality of sub-directories and files that form a software design specification that specifies how a software system is to be implemented, wherein examining the input directory includes identifying a section of the software design specification that defines a software class;

identifying a tree directory structure of the input directory that contains the plurality of sub-directories and files that form the software design specification;

creating an output directory having a tree directory structure that is subset of the tree directory structure of the input directory;

traversing the input directory over the tree directory structure to identify and examine one or more files that form the software design specification;

detecting one or more designated characteristics of the software system from examining the one or more files that form the software design specification; and

if the one or more designated characteristics indicate that the one or more files are associated with program code, then

automatically generating program code for implementing at least a portion of the software system based upon the designated characteristics; and

storing a plurality of files containing the program code in the output directory that has a tree directory structure that is subset of the tree directory structure of the input directory, wherein storing the plurality of files includes storing at least one file containing code for each identified software class to a node of the output directory, wherein the node of the output directory is based on a node where a file containing the software class is designated in the input directory containing the plurality of sub-directories and files that form the software design specification.

30. The apparatus of claim 29, wherein generating program code includes creating a program file and generating a skeleton code for the program file.

31. The apparatus of claim 29, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes identifying a section of the software design specification that defines at least a portion of a software class.

32. The apparatus of claim 31, wherein generating program code includes generating, for the software class, a first file containing a first set of program code that, after the first file is compiled, is used for declaring one or more functions of the software class.

33. The apparatus of claim 32, wherein generating program code includes generating, for the software class, a second file containing a second set of program code that, after the second set of code is compiled, is used for implementing the software class.

34. The apparatus of claim 33, wherein generating a second file includes generating program code corresponding to a list of functions that are to be used by the software class.

35. The apparatus of claim 34, wherein generating program code corresponding to a list of one or more functions includes identifying the list of functions from a portion of the software design specification that defines the software class.

36. The apparatus of claim 35, wherein identifying the list of functions includes identifying one or more characters from the portion of the software design specification, wherein the one or more characters is designated as corresponding to a function for the software class.

37. The apparatus of claim 32, wherein generating a first file includes generating program code corresponding to a set of class attributes that are to be used by the software class.

38. The apparatus of claim 33, wherein the step of examining an input directory structure containing a plurality of sub-directories and files that form a software design specification includes identifying one or more sections of the software design specification that are comments for files containing code, and wherein the steps of generating the first file and the second file include copying at least some of the sections of the software design specification that are the comments into at least one of the first file or the second file.

39. The apparatus of claim 38, wherein the step of identifying one or more sections of the software design specification that are comments for program files includes identifying a character in the software design specification that delineates the comment in a file of the software design specification.

40. The apparatus of claim 29, wherein the step of generating program code includes generating a header for at least one file containing program code.

41. The apparatus of claim 29, wherein the step of examining an input directory containing a plurality of sub-directories and files that form a software design specification includes examining one or more files that form the software design specification, wherein the one or more files are formatted in one or more of a hypertext transfer markup language (HTML), an extensible markup language (XML), or a text file.

42. The apparatus of claim 29, wherein the step of generating program code includes mapping one or more of the designated characteristics to a specific syntax that is to be part of the software system.

43. A method for automatically generating code, the method comprising the computer-implemented steps of:

scanning a software design specification that comprises one or more files;

wherein scanning said software design specification includes scanning a tree directory structure of an input directory that contains a plurality of sub-directories and files that includes the one or more files;

creating an output directory having a tree directory structure that is a subset of the tree directory structure of the input directory;

detecting one or more designated characteristics in the software design specification;

programmatically generating skeleton code of at least a first program file based on contents of the software design specification, wherein programmatically generating the skeleton code includes creating syntax based for the first program file based on the detected one or more designated characteristics; and

storing the first program file at a node in the tree directory structure of the output directory that corresponds to a node in the tree directory structure of the input directory where a corresponding portion of the software design specification is located.

44. The method of claim 43, wherein scanning a software design specification includes scanning a plurality of files formatted using one of hypertext transfer markup language (HTML), an extensible markup language (XML), or a text file.

45. The method of claim 43, wherein scanning a software design specification includes scanning a file formatted in a markup language and detecting one or more tags provided in the file in order to programmatically generate the skeleton code.

46. The method of claim 43, wherein scanning a software design specification includes ignoring one or more specified types of data in the software design specification.

47. The method of claim 43, wherein programmatically generating skeleton code of at least the first program file includes generating a header for the first program file using data contained in the one or more files of the software design specification.

48. The method of claim 43, wherein programmatically generating skeleton code of at least the first program file includes generating syntax representing code for defining a software class specified in the software design specification.

49. The method of claim 43, wherein programmatically generating skeleton code of at least the first program file includes generating syntax representing code for defining a software structure specified in the software design specification.

50. The method of claim 43, wherein programmatically generating skeleton code of at least a first program file includes generating syntax representing code for defining a function of a software class identified in the software design specification.

51. The method of claim 50, wherein programmatically generating skeleton code of at least the first program file includes returning a value for the function.

52. The method of claim 43, wherein programmatically generating skeleton code of at least the first program file includes generating a section of comments for the first program file using data contained in the one or more files.

53. The method of claim 52, wherein generating a section of comments for the first program file includes duplicating a section of comments from the software design specification.

54. The method of claim 43, further comprising the computer-implemented step of programmatically generating skeleton code of at least a second program file based on a section of the software design specification used to generate the first program file.

55. The method of claim 43, wherein programmatically generating skeleton code of at least a first program file includes creating the first program file after detecting a designated characteristic that is to be provided in a software class that is implemented by the first program file.

56. The method of claim 55, wherein programmatically generating skeleton code of at least a first program file includes inserting syntax representing code into the first program file after creating the first program file.

57. A computer-readable storage medium for automatically generating code, the computer-readable storage medium carrying instructions which, when processed by one or more processors, cause:

scanning a software design specification that comprises one or more files;

wherein scanning said software design specification includes scanning a tree directory structure of an input directory that contains a plurality of sub-directories and files that includes the one or more files;

creating an output directory having a tree directory structure that is a subset of the tree directory structure of the input directory;

detecting one or more designated characteristics in the software design specification;

programmatically generating skeleton code of at least a first program file based on contents of the software design specification, wherein programmatically generating the skeleton code includes creating syntax based for the first program file based on the detected one or more designated characteristics; and

storing the first program file at a node in the tree directory structure of the output directory that corresponds to a node in the tree directory structure of the input directory where a corresponding portion of the software design specification is located.

58. The computer-readable storage medium of claim 57, wherein scanning a software design specification includes scanning a plurality of files formatted using one of hypertext transfer markup language (HTML), an extensible markup language (XML), or a text file.

59. The computer-readable storage medium of claim 57, wherein scanning a software design specification includes scanning a file formatted in a markup language and detecting one or more tags provided in the file in order to programmatically generate the skeleton code.

60. The computer-readable storage medium of claim 57, wherein scanning a software design specification includes ignoring one or more specified types of data in the software design specification.

61. The computer-readable storage medium of claim 57, wherein programmatically generating skeleton code of at least the first program file includes generating a header for the first program file using data contained in the one or more files of the software design specification.

62. The computer-readable storage medium of claim 57, wherein programmatically generating skeleton code of at least the first program file includes generating syntax representing code for defining a software class specified in the software design specification.

63. The computer-readable storage medium of claim 57, wherein programmatically generating skeleton code of at least the first program file includes generating syntax representing code for defining a software structure specified in the software design specification.

64. The computer-readable storage medium of claim 57, wherein programmatically generating skeleton code of at least a first program file includes generating syntax representing code for defining a function of a software class identified in the software design specification.

65. The computer-readable storage medium of claim 64, wherein programmatically generating skeleton code of at least the first program file includes returning a value for the function.

66. The computer-readable storage medium of claim 57, wherein programmatically generating skeleton code of at least the first program file includes generating a section of comments for the first program file using data contained in the one or more files.

67. The computer-readable storage medium of claim 66, wherein generating a section of comments for the first program file includes duplicating a section of comments from the software design specification.

68. The computer-readable storage medium of claim 57, further comprising one or more additional instructions which, when executed by the one or more processors, causes the one or more processors to perform the step of programmatically generating skeleton code of at least a second program file based on a section of the software design specification used to generate the first program file.

69. The computer-readable storage medium of claim 57, wherein programmatically generating skeleton code of at least a first program file includes creating the first program file after detecting a designated characteristic that is to be provided in a software class that is implemented by the first program file.

70. The computer-readable storage medium of claim 69, wherein programmatically generating skeleton code of at least a first program file includes inserting syntax representing code into the first program file after creating the first program file.

71. An apparatus for automatically generating code, the apparatus comprising a memory with instructions which, when processed by one or more processors, cause:

scanning a software design specification that comprises one or more files;

wherein scanning said software design specification includes scanning a tree directory structure of an input directory that contains a plurality of sub-directories and files that includes the one or more files;

creating an output directory having a tree directory structure that is a subset of the tree directory structure of the input directory;

detecting one or more designated characteristics in the software design specification;

programmatically generating skeleton code of at least a first program file based on contents of the software design specification, wherein programmatically generating the skeleton code includes creating syntax based for the first program file based on the detected one or more designated characteristics; and

storing the first program file at a node in the tree directory structure of the output directory that corresponds to a node in the tree directory structure of the input directory where a corresponding portion of the software design specification is located.

72. The apparatus of claim 71, wherein scanning a software design specification includes scanning a plurality of files formatted using one of hypertext transfer markup language (HTML), an extensible markup language (XML), or a text file.

73. The apparatus of claim 71, wherein scanning a software design specification includes scanning a file formatted in a markup language and detecting one or more tags provided in the file in order to programmatically generate the skeleton code.

74. The apparatus of claim 71, wherein scanning a software design specification includes ignoring one or more specified types of data in the software design specification.

75. The apparatus of claim 71, wherein programmatically generating skeleton code of at least the first program file includes generating a header for the first program file using data contained in the one or more files of the software design specification.

76. The apparatus of claim 71, wherein programmatically generating skeleton code of at least the first program file includes generating syntax representing code for defining a software class specified in the software design specification.

77. The apparatus of claim 71, wherein programmatically generating skeleton code of at least the first program file includes generating syntax representing code for defining a software structure specified in the software design specification.

78. The apparatus of claim 71, wherein programmatically generating skeleton code of at least a first program file includes generating syntax representing code for defining a function of a software class identified in the software design specification.

79. The apparatus of claim 78, wherein programmatically generating skeleton code of at least the first program file includes returning a value for the function.

80. The apparatus of claim 71, wherein programmatically generating skeleton code of at least the first program file includes generating a section of comments for the first program file using data contained in the one or more files.

81. The apparatus of claim 80, wherein generating a section of comments for the first program file includes duplicating a section of comments from the software design specification.

82. The apparatus of claim 71, wherein the memory further includes one or more additional instructions which, when executed by the one or more processors, causes the one or more processors to perform the step of programmatically generating skeleton code of at least a second program file based on a section of the software design specification used to generate the first program file.

83. The apparatus of claim 71, wherein programmatically generating skeleton code of at least a first program file includes creating the first program file after detecting a designated characteristic that is to be provided in a software class that is implemented by the first program file.

84. The apparatus of claim 83, wherein programmatically generating skeleton code of at least a first program file includes inserting syntax representing code into the first program file after creating the first program file.