软工作业(一)

软工作业(一):实现WordCount命令行程序

github传送门

  1. 实现一个简单而完整的软件工具(源程序特征统计程序)。
  2. 进行单元测试、回归测试、效能测试,在实现上述程序的过程中使用相关的工具。
  3. 进行个人软件过程(PSP)的实践,逐步记录自己在每个软件工程环节花费的时间。

WC 项目要求

wc.exe 是一个常见的工具,它能统计文本文件的字符数、单词数和行数。这个项目要求写一个命令行程序,模仿已有wc.exe 的功能,并加以扩充,给出某程序设计语言源文件的字符数、单词数和行数。
实现一个统计程序,它能正确统计程序文件中的字符数、单词数、行数,以及还具备其他扩展功能,并能够快速地处理多个文件。
具体功能要求:
程序处理用户需求的模式为:

wc.exe [parameter] [file_name]
  • 基本功能列表(已完成):
wc.exe -c file.c     //返回文件 file.c 的字符数
wc.exe -w file.c    //返回文件 file.c 的词的数目  
wc.exe -l file.c      //返回文件 file.c 的行数

  • 扩展功能:

-s递归处理目录下符合条件的文件。(未完成)

-a返回更复杂的数据(代码行 / 空行 / 注释行)。(已完成)

  • 空行:本行全部是空格或格式控制字符,如果包括代码,则只有不超过一个可显示的字符,例如“{”。

  • 代码行:本行包括多于一个字符的代码。

  • 注释行:本行不是代码行,并且本行包括注释。一个有趣的例子是有些程序员会在单字符后面加注释:

    } //注释

在这种情况下,这一行属于注释行。

  • 高级功能(未完成):

-x 参数。这个参数单独使用。如果命令行有这个参数,则程序会显示图形界面,用户可以通过界面选取单个文件,程序就会显示文件的字符数、行数等全部统计信息。

  • 需求举例:
  wc.exe -s -a *.c

返回当前目录及子目录中所有*.c 文件的代码行数、空行数、注释行数。

关键代码or设计说明

注册选项,并自动调用

void
Parse::registerOption(string option, function<void(void)> f) {
    actions[option] = f;
}

void
Parse::setup() {
    registerOption("-c", [&]() {
        for (auto &f : counters) {
            string append = " Character: " + to_string(f.getCharacterNum());
            output_per_file[f.getFilename()] += append;
        }
    });
    registerOption("-w", [&]() {
        for (auto &f : counters) {
            string append = " Word: " + to_string(f.getWordNum());
            output_per_file[f.getFilename()] += append;
        }
    });   
    registerOption("-l", [&]() {
        for (auto &f : counters) {
            string append = " Line: " + to_string(f.getLineNum());
            output_per_file[f.getFilename()] += append;
        }
    });
    registerOption("-a", [&]() {
        for (auto &f : counters) {
            string append = " Blank line: " + to_string(f.getBlankLineNum());
            append += " Code line: " + to_string(f.getCodeLineNum());
            append += " Comment line: " + to_string(f.getCommentLineNum());
            output_per_file[f.getFilename()] += append;
        }
    });

    handleOption();
}

void
Parse::handleOption() {
    for (auto s : options) {
        if (actions.find(s) == actions.end()) {
            usage();
            exit(-1);
        } else {
            actions[s]();
        }
    }
}

计数关键代码

void
Counter::work() {
    string line;
    string word;
    bool comment_flag = false;

    while (getline(in, line)) {
        if (judgeBlankLine(line)) {
            blank_line_number++;
        } else if (comment_flag) {//当前是否是注释行
            comment_line_number++;
            judgeAndUpdateCommentLine(line, comment_flag);//更新flag
        } else if (judgeAndUpdateCommentLine(line, comment_flag)) {
            comment_line_number++;
        } else {
            code_line_number++;
        }
        character_number += line.length();
        word_number += countWordInOneLine(line);
    }
    line_number = blank_line_number + comment_line_number + code_line_number;
}

注释行的判断

bool
Counter::judgeAndUpdateCommentLine(string line, bool& flag) {
    if(line[0] == '/' && line[1] == '/') return true;// "//"
	if(line[0] == '*' && line[1] == '/' && line.length()==2) {flag = false; return true;} // "*/"
	if(line[0] == '/' && line[1] == '*' && line.length()==2) return flag = true;// "/*"
	if(line[0] == '/' && line[1] == '*' && line.find("*/")==string::npos) return flag = true; // "/* ... */"

    string::size_type i = 0;
    while (isblank(line[i])) {
        i++;
    }
    if (line[i] == '}' && line[i+1] == '/' && line[i+2] == '/') return true;// "}//"
    
	string::size_type index = line.find("/*");
	if(index != string::npos) {
		flag = true;
	}
	if(flag) {
		index = line.find("*/");
		if(index != string::npos)
		{
			flag = false;
			line[index] = line[index+1] = ' ';
			string sub = line.substr(index+2, line.length()-index-2);
			trim(sub);
			if (judgeAndUpdateCommentLine(sub, flag)) return true;
		}
	}
	return false;
}


PSP

PSP2.1 Personal Software Process Stages 预估耗时(分钟) 实际耗时(分钟)
Planning 计划
· Estimate · 估计这个任务需要多少时间 10 5
Development 开发
· Analysis · 需求分析 (包括学习新技术) 60 60
· Design Spec · 生成设计文档 60 0
· Design Review · 设计复审 (和同事审核设计文档) 60 0
· Coding Standard · 代码规范 (为目前的开发制定合适的规范) 20 20
· Design · 具体设计 60 60
· Coding · 具体编码 360 480
· Code Review · 代码复审 30 30
· Test · 测试(自我测试,修改代码,提交修改) 60 60
Reporting 报告
· Test Report · 测试报告 60 10
· Size Measurement · 计算工作量 30 30
· Postmortem & Process Improvement Plan · 事后总结, 并提出过程改进计划 30 20
合计 900 770
posted @ 2018-09-08 20:33  邹卓辉  阅读(210)  评论(0编辑  收藏  举报