Development Blog

To see the whole version, go to the End and see HTML version on Github.com.

Contents

PSP Form

Top

Ideas of Problem-solving

Top

Problem is given in four level and that's good for Incremental model.

Idea of develop solution:

1. Break problem into parts of tasks and queue them.
2. Think sub solutions for tasks.
3. Code and implement the solutions.
4. Test

Design and Implement Processes

Top

Solution steps:

1. Determine file type and check
2. Read corresponding keywords of the language
3. Read the file content
4. Solve for 1st level
5. Solve for 2nd level
6. Solve for 3rd&4th level

Code Description

Top

My project used many to assist the development process. But those do nothing with problem-solving, so I will not explain them here.

Here is key codes and their explanation:

main.py

Top

This is the entrance of whole program. This file contains $sol.1$ and leads to the rest.

xxxxxxxxxx
10
1
# Open File Preparation
2
    f = None
3
    try:
4
        # get the file name
5
        fileName = sys.argv[1]
6
    except IndexError as ie:
7
        estr = OINFOHEADER + f'No file input, no first parameter given. {ie}'
8
        raise IndexError(estr)
9
    # get the program directory
10
    programDir = osp.dirname(sys.argv[0])

xxxxxxxxxx
4
1
# Check ext
2
    fileExt: common.ExtClass = common.ExtClass()
3
    # determine ext
4
    fileExt.extSelect(fileName)

xxxxxxxxxx
6
1
# open file
2
    try:
3
        f = open(fileName)
4
    except FileNotFoundError as fe:
5
        estr = OINFOHEADER + f'{fe}'
6
        raise FileNotFoundError(estr)

xxxxxxxxxx
10
1
# read keywords
2
    keys = []
3
    try:
4
        with open(osp.join(programDir, f'keywords_{fileExt.ext}.txt')) as fkey:
5
        # with open(programDir + dirsep + f'keywords_{fileExt.ext}.txt') as fkey:
6
            t = fkey.read()
7
            keys = t.split()
8
    except FileNotFoundError as fe:
9
        estr = OINFOHEADER + f'{fe}'
10
        raise FileNotFoundError(estr)

xxxxxxxxxx
2
1
# read file data
2
    strs = f.readlines()

xxxxxxxxxx
3
1
# work of 1st level
2
    keycnt, moreinfo = common.countKw(keys, strs)
3
    print('total num: ', keycnt)

xxxxxxxxxx
6
1
# language-specific part of solution's entrance (of .c file)
2
    speMDic = {
3
        'c': specific_c,
4
        'cpp': specific_cpp
5
    }
6
    speMDic[fileExt.ext].entrance(keys, strs, moreinfo)

common.py

Top

This file contains the common parts of codes, i.e. the public codes for all modules.

xxxxxxxxxx
20
1
# Class and method for storing and determining ext
2
class ExtClass():
3
​
4
    ext = None
5
    exti = 0
6
    mode: DevMode = sampleModeCommon
7
​
8
    def __init__(self, mode: DevMode=None):
9
        ...
10
​
11
    def extSelect(self, fileName:str=''):
12
        # debug code
13
        ...
14
        
15
        # set ext
16
        t1 = fileName.rsplit(sep='.', maxsplit=3)
17
        self.ext = t1[-1]
18
​
19
        ...
20
​

xxxxxxxxxx
25
1
# This function count keywords in strings from the file.
2
def countKw(keys, strs:list):
3
    ...
4
    
5
    for i in strs:
6
        cnt1 = 0
7
        for j in keys:
8
            i: str
9
            a = k = 0
10
            while True:
11
                a = i.find(j,a)
12
                if a == -1:
13
                    break
14
                a += keylength[j]
15
                if i[a].isalpha() is False:
16
                    # found a keyword here
17
                    k += 1
18
                    # pairs of location prepared for more operation
19
                    p = [idi, a - keylength[j], j]
20
                    locations.append(p)
21
            cnt1 += k
22
​
23
        cnt2 += cnt1
24
        idi += 1
25
    return cnt2, locations

specific_c.py

Top

Contains part of solutions for c language.

xxxxxxxxxx
27
1
# addon entrance
2
def entrance(pkeys, pstrs, pmoreinfo=None):
3
    ...
4
    
5
    locations = extractWordsBraces(strs, wordLocation)
6
    
7
    # process switch-case
8
    locations_SwCsBraces = extractSwCsBraces(locations)
9
    SwCnt_Group = countSwCs(locations_SwCsBraces)
10
​
11
    # output SwCs
12
    print(f'switch num: ', SwCnt_Group.__len__())
13
    print('case num: ', end='')
14
    for i in SwCnt_Group:
15
        print(i, end=' ')
16
    print('')
17
    
18
    # process if-else, if-elseif-else
19
    # these codes are only designed for cases with entire braces attached to keywords.
20
    locations_IfEsBraces = extractIfEsBraces(locations)
21
    cnt_IfEs, cnt_IfEsifEs = countIfEs(locations_IfEsBraces)
22
    cntIFES = [cnt_IfEs, cnt_IfEsifEs]
23
​
24
    # output IFES
25
    print(f'if-else num: ', cnt_IfEs)
26
    print(f'if-elseif-else num: ', cnt_IfEsifEs)
27
​

xxxxxxxxxx
32
1
# This function count 'switch's and each group's 'case's. Support nested structure.
2
def countSwCs(plocations_SwCsBraces):
3
    ...
4
​
5
    i = 0
6
    while i < length:
7
        # find a 'switch', do iteration
8
        if plocations_SwCsBraces[i][2]=='switch':
9
            ...
10
            interval = [i, endBrace+1]
11
            intervals.append(interval)
12
            # iterate
13
            CsCntItr = countSwCs(plocations_SwCsBraces[i+1:endBrace+1])
14
            SwCnt_Group.extend(CsCntItr)
15
            # print(SwCnt_Group)
16
            i = endBrace
17
        i += 1
18
​
19
    ...
20
    
21
    # count 'case's of given strings
22
    i = 0
23
    while i < length:
24
        ...
25
        
26
        if plocations_SwCsBraces[i][2]=='case':
27
            CsCnt += 1
28
        i += 1
29
    if CsCnt!=0:
30
        SwCnt_Group.append(CsCnt)
31
    return SwCnt_Group
32
​

xxxxxxxxxx
36
1
# This function figures the answers of sol.3. Support nested structure.
2
def countIfEs(plocations_IfEsBraces):
3
    ...
4
    while i < length:
5
        # find a/an 'if'/'else', do iteration
6
        if plocations_IfEsBraces[i][2] == 'if' or \
7
                (plocations_IfEsBraces[i][2] == 'else' and plocations_IfEsBraces[i+1 if i+1 <length else i][2] != 'if'):
8
            ...
9
            interval = [i + 2, endBrace]
10
            intervals.append(interval)
11
            # iterate
12
            retv = countIfEs(plocations_IfEsBraces[i + 1:endBrace + 1])
13
            ...
14
            cnt_IfEs += retv[0]
15
            cnt_IfEsifEs += retv[1]
16
            i = endBrace
17
        i += 1
18
​
19
    ...
20
    
21
    # count cases of 'if-else' and 'if-elseif-else' of given strings
22
    i = 0
23
    tlength = tpifesloclist.__len__()
24
    while i < tlength:
25
        if tpifesloclist[i][2] == 'else':
26
            if tpifesloclist[i+1 if i+1<tlength else i][2] == 'if':
27
                cnt_IfEsifEs += 1
28
                while i < tlength:
29
                    if tpifesloclist[i][2] == 'else' and tpifesloclist[i+1 if i+1<tlength else i][2] != 'if':
30
                        break
31
                    i += 1
32
            elif tpifesloclist[i+1 if i+1<tlength else i][2] == '{':
33
                cnt_IfEs += 1
34
        i += 1
35
    cntIFES = [cnt_IfEs, cnt_IfEsifEs]
36
    return cntIFES

Unit Test

Top

my_unit_test.py

Screenshots and Description

Top

Test Data

Top

Test file, $testfile.c$, is copied from website. See the website at the End.

Result

Top

Picture shown below tells that of 4th level, i.e. the ultimate requirement. It goes to expectation.

Coverage Optimization

Top

Comment useless codes.

$81$% ->$82$%

Performance Testing

Top

Summary

Top

In this program, I used lots of new knowledge. Software Engineering is truly a systematic engineering. Methodology is really important.

End

Top

Project on Github.com: https://github.com/LiuJiewenTT/ee308fz_lab1

URL on github.com of this passage(download): https://liujiewentt.github.io/ee308fz_lab1/development%20blog.md
URL on github.com of this passage(view with Github md): https://github.com/LiuJiewenTT/ee308fz_lab1/tree/main/development%20blog.md

URL on github.com of this passage(view as html): https://liujiewentt.github.io/ee308fz_lab1/development%20blog.html
URL on csdn.net of this passage(view as html): https://bbs.csdn.net/topics/608838406