JPH0423038A - Automatic generating device for program document - Google Patents

Abstract

PURPOSE:To attain the output of even the use of a variable by applying an analysis in order to identify and sort the instructions using the symbols of the variable names, etc. CONSTITUTION:If a single line read out of a source file 1 is identical with an instruction, it is judged whether the instruction operates a variable or not. If so, an operand part is extracted out of the instruction and the attribute of the operand 'write' or 'read' is added to the variable name according to the group to which the instruction belongs. Then the variable name including the attribute is written into a symbol file 5. When all lines are processed, the contents of the file 5 are outputted after arrangement of the formats.

Description

DETAILED DESCRIPTION OF THE INVENTION [Field of Industrial Application] The present invention relates to an automatic generation device for documents related to computer programs, and in particular to a tool for checking the usage of variables used in a program and outputting the contents. The present invention relates to an automatic document generation device.

[Conventional technology]

Conventionally, as this type of automatic document generation device, there was a "Nunboru list" that outputs a list of variables used.
Indicates whether symbols such as output devices and variable names are defined and used in the program.
There is a reference J output device, etc.

For example, in the case of a program written in assembler language, a symbol list shows the correspondence between the symbols used and the memory addresses assigned to them.
Ru. Further, a cross reference is shown in association with the file name in which a certain symbol is defined and the line number in that file.

[Problem to be solved by the invention]

Program documentation is highly needed when maintaining a program. One of the items that must be clearly stated in the documentation is a list of the uses of the variables used there.

The conventional [symbol list j output device described above simply outputs a list of symbols such as variable names used,
For example, in the case of variables, it was impossible to know from them whether they were being rewritten or only referenced. Also, for example, the cross-reference output device can output the line number where the variable was defined and the line number where it was used, but the purpose of the variable cannot be read from there. It is not possible.

[Means to solve the problem]

The present invention provides a first storage means for storing a source program, a reading means for reading the source program from the first storage means, an identification means for classifying instructions read by the reading means, and an identification means for classifying instructions read by the reading means. a first classification means for classifying the instructions identified by the first classification means; a second classification means for classifying the operands of the instructions classified by the first classification means; and storing the operands of the instructions classified by the second classification means. and an output means for outputting the contents of the second storage means.

Thus, in the present invention, by performing an analysis to identify and classify instructions that use symbols such as variable names, for example, if it is a variable name, whether the variable is rewritten or only referenced is used. It is possible to output up to

〔Example〕

The present invention will be described in detail below with reference to the drawings.

FIG. 3 is an example of an assembler source program used in this embodiment. The instructions shown in FIG. 3 can be classified into three groups from the perspective of variables. The first group, as seen in the MOV instruction written at address 01, has variables for both operands, data is written to the first operand, and the variable specified for the second operand is Its contents are referred to.

The second group has only one variable and data is written there, as seen in the ADD instruction at address 02. The third group is J at address 03.
As seen in the Z command, it only has one variable and its contents are referenced. The fourth group is 0
As seen in the JMP instruction at address 4, the operand does not have any variables. In the following description, it is assumed that all instructions can be classified into these four groups.

FIG. 1 is a block diagram showing the overall structure of an embodiment of the present invention. It is assumed that the source file 1 stores the program explained in FIG.

The instruction identification means 2 reads the source program line by line from the source file 1 and identifies whether an instruction is written in that line (i.e., an instruction line) or a line with only a comment (i.e., a comment line). .

The instruction classification means 3 inputs the line identified as an instruction line by the instruction identification means 2, and classifies its operands into the above-mentioned groups according to the instruction. The operand writing means 4 converts the operands classified by the instruction classification means 3 into symbols.
Write to file 5. The symbol output means 6 formats and outputs the contents of the symbol file 5.

FIG. 2 is a flowchart showing the operation of one embodiment of the present invention. The same numbers are assigned to the parts corresponding to those in Figure 1 of the inner box in Figure 2.

First, the first operation is to read one line from the source file 1 (process 11), determine whether that line is an instruction, and if it is not an instruction, return to process 11 and repeat the above operations (process 12). If it is a command, it is determined whether the command is a variable manipulation command, and if it is not a variable manipulation command line, the process returns to process 11 and repeats the above operation (process 13).

If it is determined in process 13 that the instruction is a variable manipulation instruction, process 14) to extract the operand part from the instruction;
An attribute is attached to the operand "write" or "read" depending on the group to which the instruction belongs (processing 15). The variable name with the attribute is written to the symbol file 5 (process 16).

If all lines of the source file have not been processed, the process returns to process 11 and repeats the above operation (process 17). If all rows have been processed,
Format and output the contents of symbol file 5 (
Processing 18).

FIG. 4 shows the contents of the symbol file in which variable names with attributes are written in process 16. FIG. 5 shows an example in which the source program shown in FIG. 3 is processed and output.

FIG. 6 is a flowchart illustrating the operation of another embodiment of the present invention. Processes that are the same as those in the inner box 2 of FIG. 6 are given the same numbers and their explanations will be omitted.

The embodiment shown in FIG. 6 differs from that shown in FIG. 2 in the method of writing data into the symbol file 5.

In the embodiment shown in FIG. 2, variable names with attributes are written in the symbol file 5, whereas in this embodiment, symbols are written in different areas of the symbol file for each attribute (process 61). FIG. 7 shows the contents of the symbol file in this example.

〔Effect of the invention〕

As described above, the present invention has the advantage that it is possible to automatically create a list of variable uses, which was conventionally created manually for program documentation.

[Brief explanation of the drawing]

FIG. 1 is a configuration diagram showing the configuration of the present invention. FIG. 2 is a flowchart showing the operation of the first embodiment of the present invention. FIG. 3 is a source program example showing the types of instructions according to the embodiment of the present invention. FIG. 4 shows the symbols and symbols shown in the embodiment of FIG.
A diagram showing the contents of a file. FIG. 5 is an example of variable list output according to the present invention. FIG. 6 is a flow chart showing the operation of the second embodiment of the present invention. FIG. 7 is a diagram showing the contents of the symbol file in the embodiment of FIG. 6. Agent Susumu Uchihara, Patent Attorney Figure 1 Figure 2 Address OL OV: Assign the contents of variable 8 to variable DD #5: Add variable A1:5 AZ: Assign MP; Branch unconditionally to Ytlrj pi Figure 3: Variables introduced in the first hour: Variables introduced at the beginning of the discussion

Claims (1)

[Claims] a first storage means for storing a source program;
a reading means for reading a source program from a storage means; an identification means for identifying the instructions read by the reading means; a first classification means for classifying the instructions identified by the identification means; a second classification means for classifying the operands of the classified instructions; a second storage means for storing the operands of the instructions classified by the second classification means; and an output means for outputting the contents of the second storage means. An automatic program/document generation device comprising: