Data structure used for directory structure navigation in a skeleton code creation tool

• US 8,219,969 B2
• Filed: 05/07/2007
• Issued: 07/10/2012
• 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): CHAVIS, JOHN Q
• Application Number:
  US11/800,844
• Publication Number:
  US 20070214450A1
• Time in Patent Office: 1,891 Days
• Field of Search: 717/106
• US Class Current: 717/106
• CPC Class Codes: G06F 8/10 Requirements analysis; Specification techniques
• CPC Class Codes: G06F 8/20 Software design
• CPC Class Codes: G06F 8/35 model driven

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 code, the method comprising the computer-implemented steps of:

scanning a plurality of electronic documents that form a software design specification, wherein the software design specification defines software functions that form a software system, and wherein the software design specification defines an output directory structure;

detecting, from interpreting the software design specification, one or more designated characteristics that define one or more functions and function attributes of the software system;

generating an output directory comprising a plurality of nodes, wherein a structure of the plurality of nodes of the output directory corresponds at least partially to the output directory structure defined by the software design specification;

programmatically generating skeleton code of at least a first program file from the one or more designated characteristics; and

storing the first program file within a node of the plurality of nodes of the output directory that corresponds to a node in the directory structure defined by the software design specification where the one or more electronic documents that specify the one or more designated characteristics are located.

2. The method of claim 1, wherein programmatically generating skeleton code of at least a first program file from the one or more designated characteristics includes programmatically generating skeleton code of the first program file and of a second program file from the one or more designated characteristics.

3. The method of claim 2, further comprising locating the second program file at the node of the output directory with the first program file.

4. The method of claim 2, wherein the first program file corresponds to a declaration file of the software function, and wherein the second program file corresponds to an implementation file of the software function.

5. The method of claim 1, wherein detecting one or more designated characteristics of the software system includes detecting at least one of a tag or a character that correspond to a characteristic of the software function.

6. The method of claim 1, wherein detecting one or more designated characteristics of the software system includes detecting at least one of a tag or a character that delineates at least one of a function, a function attribute, and a comment for the software function.

7. The method of claim 1, wherein generating an output directory includes replicating a substantial portion of a node structure of the software design specification.

8. The method of claim 1, further comprising generating a data structure that maintains the location of the one or more functions and function attributes, wherein the one or more functions and function attributes are correlated to the directory path described in the software design specification wherein are located the one or more designated characteristics that correspond to elements defining the one or more functions and function attributes.

9. The method of claim 8, wherein the data structure comprises a hash table.

10. The method of claim 8, wherein a structure of the output directory is identical to the output directory structure defined by the software design specification except for the root node.

11. A non-transitory computer-readable medium for automatically generating code, the computer-readable medium carrying instructions which, when executed by one or more processors, cause:

scanning a plurality of electronic documents that form a software design specification, wherein the software design specification defines software functions that form a software system, and wherein the software design specification defines an output directory structure;

detecting, from interpreting the software design specification, one or more designated characteristics that define one or more functions and function attributes of the software system;

generating an output directory comprising a plurality of nodes, wherein a structure of the plurality of nodes of the output directory corresponds at least partially to the output directory structure defined by the software design specification;

programmatically generating skeleton code of at least a first program file from the one or more designated characteristics; and

storing the first program file within a node of the plurality of nodes of the output directory that corresponds to a node in the directory structure defined by the software design specification where the one or more electronic documents that specify the one or more designated characteristics are located.

12. The non-transitory computer-readable medium of claim 11, wherein programmatically generating skeleton code of at least a first program file from the one or more designated characteristics includes programmatically generating skeleton code of the first program file and of a second program file from the one or more designated characteristics.

13. The non-transitory computer-readable medium of claim 12, further comprising additional instructions which, when executed by the one or more processors, causes locating the second program file at the node of the output directory with the first program file.

14. The non-transitory computer-readable medium of claim 12, wherein the first program file corresponds to a declaration file of the software function, and wherein the second program file corresponds to an implementation file of the software function.

15. The non-transitory computer-readable medium of claim 11, wherein detecting one or more designated characteristics of the software system includes detecting at least one of a tag or a character that correspond to a characteristic of the software function.

16. The non-transitory computer-readable medium of claim 11, wherein detecting one or more designated characteristics of the software system includes detecting at least one of a tag or a character that delineates at least one of a function, a function attribute, and a comment for the software function.

17. The non-transitory computer-readable medium of claim 11, wherein generating an output directory includes replicating a substantial portion of a node structure of the software design specification.

18. The non-transitory computer-readable medium of claim 11, further comprising generating a data structure that maintains the location of the one or more functions and function attributes, wherein the one or more functions and function attributes are correlated to the directory path described in the software design specification wherein are located the one or more designated characteristics that correspond to elements defining the one or more functions and function attributes.

19. The non-transitory computer-readable medium of claim 18, wherein the data structure comprises a hash table.

20. The non-transitory computer-readable medium of claim 18, wherein a structure of the output directory is identical to the output directory structure defined by the software design specification except for the root node.

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

scanning a plurality of electronic documents that form a software design specification, wherein the software design specification defines software functions that form a software system, and wherein the software design specification defines an output directory structure;

detecting, from interpreting the software design specification, one or more designated characteristics that define one or more functions and function attributes of the software system;

generating an output directory comprising a plurality of nodes, wherein a structure of the plurality of nodes of the output directory corresponds at least partially to the output directory structure defined by the software design specification;

programmatically generating skeleton code of at least a first program file from the one or more designated characteristics; and

storing the first program file within a node of the plurality of nodes of the output directory that corresponds to a node in the directory structure defined by the software design specification where the one or more electronic documents that specify the one or more designated characteristics are located.

22. The apparatus of claim 21, wherein programmatically generating skeleton code of at least a first program file from the one or more designated characteristics includes programmatically generating skeleton code of the first program file and of a second program file from the one or more designated characteristics.

23. The apparatus of claim 22, wherein the memory further stores additional instructions which, when executed by the one or more processors, causes locating the second program file at the node of the output directory with the first program file.

24. The apparatus of claim 21, wherein the first program file corresponds to a declaration file of the software function, and wherein the second program file corresponds to an implementation file of the software function.

25. The apparatus of claim 21, wherein detecting one or more designated characteristics of the software system includes detecting at least one of a tag or a character that correspond to a characteristic of the software function.

26. The apparatus of claim 21, wherein detecting one or more designated characteristics of the software system includes detecting at least one of a tag or a character that delineates at least one of a function, a function attribute, and a comment for the software function.

27. The apparatus of claim 21, wherein generating an output directory includes replicating a substantial portion of a node structure of the software design specification.

28. The apparatus of claim 21, further comprising generating a data structure that maintains the location of the one or more functions and function attributes, wherein the one or more functions and function attributes are correlated to the directory path described in the software design specification wherein are located the one or more designated characteristics that correspond to elements defining the one or more functions and function attributes.

29. The apparatus of claim 28, wherein the data structure comprises a hash table.

30. The apparatus of claim 28, wherein a structure of the output directory is identical to the output directory structure defined by the software design specification except for the root node.