Approach for automatically generating program code

• US 7,987,447 B2
• Filed: 05/15/2007
• Issued: 07/26/2011
• Est. Priority Date: 08/28/2003
• Status: Expired due to Fees

• Current Assignee: Ricoh Company Limited
• Original Assignee: Ricoh Company Limited
• Inventors: Motoyama, Tetsuro, Fong, Avery
• Primary Examiner(s): WANG, RONGFA PHILIP
• Application Number:
  US11/803,915
• Publication Number:
  US 20070220483A1
• Time in Patent Office: 1,533 Days
• Field of Search: None
• US Class Current: 717/106
• CPC Class Codes: G06F 8/10 Requirements analysis; Specification techniques
• CPC Class Codes: G06F 8/24 Object-oriented
• 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 generating program code, the method comprising the computer-implemented steps of:

while scanning a directory comprising a plurality of electronic documents that form a software design specification that defines software elements, automatically

identifying a section of the software design specification that corresponds to a definition of a particular software element, and

maintaining a location of the section of the software design specification within the directory using a data structure mapping (a) the particular software element to (b) a path, within the directory, of the section of the software design specification that corresponds to the definition of the particular software element;

programmatically generating skeleton code of at least a first program file and of a second program file based on the definition of the particular software element;

wherein the skeleton code of the first program file corresponds to code for declaring the particular software element;

wherein the skeleton code of the second program file corresponds to code for implementing the particular software element;

automatically creating, based at least in part on the location of the section of the software design specification within the directory of the software design specification, an output directory for locating the first program file and the second program file.

2. The method of claim 1, further comprising the computer-implemented step of locating the first program file and the second program file at a first node, wherein the first node has a corresponding node in the software design specification where the definition of the software element is located.

3. The method of claim 1, wherein creating an output directory for locating the first program file and the second program file includes providing that at least a portion of the output directory is to have a node structure that is substantially similar to a portion of the directory of the software design specification.

4. The method of claim 3, wherein the output directory has the node structure that is substantially similar to the portion of the directory of the software design specification, but that a root node of the output directory is different than a root node of the directory of the software design specification.

5. The method of claim 1, wherein the skeleton code of the second program file includes skeleton code corresponding to one or more functions of the particular software element.

6. The method of claim 5, wherein the skeleton code corresponding to one or more functions of the particular software element includes default return values corresponding to at least one of the one or more functions.

7. The method of claim 5, wherein the skeleton code corresponding to one or more functions of the particular software element includes code for debugging at least one of the one or more functions.

8. The method of claim 5, wherein the skeleton code corresponding to one or more functions of the particular software element includes function header comments that describe at least one of the one or more functions, wherein the function header comments describe an algorithm corresponding to the at least one function.

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

while scanning a directory comprising a plurality of electronic documents that form a software design specification that defines software elements, automatically

identifying a section of the software design specification that corresponds to a definition of a particular software element, and

maintaining a location of the section of the software design specification within the directory using a data structure mapping (a) the particular software element to (b) a path, within the directory, of the section of the software design specification that corresponds to the definition of the particular software element;

programmatically generating skeleton code of at least a first program file and of a second program file based on the definition of the particular software element;

wherein the skeleton code of the first program file corresponds to code for declaring one or more functions of the particular software element;

wherein the skeleton code of the second program file corresponds to code for implementing the particular software element;

automatically creating, based at least in part on the location of the section of the software design specification within the directory of the software design specification, an output directory for locating the first program file and the second program file.

10. The computer-readable medium of claim 9, further comprising one or more additional instructions which, when processed by the one or more processors, causes locating the first program file and the second program file at a first node, wherein the first node has a corresponding node in the software design specification where the definition of the software element is located.

11. The computer-readable medium of claim 9, wherein creating an output directory for locating the first program file and the second program file includes providing that at least a portion of the output directory is to have a node structure that is substantially similar to a portion of the directory of the software design specification.

12. The computer-readable medium of claim 11, wherein the output directory has the node structure that is substantially similar to the portion of the directory of the software design specification, but that a root node of the output directory is different than a root node of the directory of the software design specification.

13. The computer-readable medium of claim 9, wherein the skeleton code of the second program file includes skeleton code corresponding to one or more functions of the particular software element.

14. The computer-readable medium of claim 13, wherein the skeleton code corresponding to one or more functions of the particular software element includes default return values corresponding to at least one of the one or more functions.

15. The computer-readable medium of claim 13, wherein the skeleton code corresponding to one or more functions of the particular software element includes code for debugging at least one of the one or more functions.

16. The computer-readable medium of claim 13, wherein the skeleton code corresponding to one or more functions of the particular software element includes function header comments that describe at least one of the one or more functions, wherein the function header comments describe an algorithm corresponding to the at least one function.

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

while scanning a directory comprising a plurality of electronic documents that form a software design specification that defines software elements, automatically

identifying a section of the software design specification that corresponds to a definition of a particular software element, and

maintaining a location of the section of the software design specification within the directory using a data structure mapping (a) the particular software element to (b) a path, within the directory, of the section of the software design specification that corresponds to the definition of the particular software element;

programmatically generating skeleton code of at least a first program file and of a second program file based on the definition of the particular software element;

wherein the skeleton code of the first program file corresponds to code for declaring one or more functions of the particular software element;

wherein the skeleton code of the second program file corresponds to code for implementing the particular software element;

automatically creating, based at least in part on the location of the section of the software design specification within the directory of the software design specification, an output directory for locating the first program file and the second program file.

18. The apparatus of claim 17, wherein the memory further stores one or more additional instructions which, when processed by the one or more processors, causes locating the first program file and the second program file at a first node, wherein the first node has a corresponding node in the software design specification where the definition of the software element is located.

19. The apparatus of claim 17, wherein creating an output directory for locating the first program file and the second program file includes providing that at least a portion of the output directory is to have a node structure that is substantially similar to a portion of the directory of the software design specification.

20. The apparatus of claim 19, wherein the output directory has the node structure that is substantially similar to the portion of the directory of the software design specification, but that a root node of the output directory is different than a root node of the directory of the software design specification.

21. The apparatus of claim 17, wherein the skeleton code of the second program file includes skeleton code corresponding to one or more functions of the particular software element.

22. The apparatus of claim 21, wherein the skeleton code corresponding to one or more functions of the particular software element includes default return values corresponding to at least one of the one or more functions.

23. The apparatus of claim 21, wherein the skeleton code corresponding to one or more functions of the particular software element includes code for debugging at least one of the one or more functions.

24. The apparatus of claim 21, wherein the skeleton code corresponding to one or more functions of the particular software element includes function header comments that describe at least one of the one or more functions, wherein the function header comments describe an algorithm corresponding to the at least one function.