个人项目wc.exe

一、前言

实现语言：c语言

编译工具：CodeBlocks

GitHub地址：https://github.com/JXQQQ/wordcount

二、项目要求

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   返回更复杂的数据（代码行 / 空行 / 注释行）。（已实现）

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

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

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

    } //注释
在这种情况下，这一行属于注释行。

[file_name]: 文件或目录名，可以处理一般通配符。

高级功能：（未实现）

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

三、解题思路

　　拿到题目后我决定用自己最熟悉的c语言去完成项目，因为以前没有接触过有关文档的操作，所以经过一段时间在网络上查找资料，准备在写代码前复习以往的知识并学习c语言中的FILE操作，通过fopen()fgetc()fclose()等函数实现该项目。

四、设计实现过程

　　我将通过1个主函数，4个功能函数来实现计算文件字符数、词的数目、行数、更复杂数据这四个功能。

 

五、代码说明

1、功能一：计算文件字符数-c

　　通过输入的文件路径打开文件，用fgetc()函数每读取一个字符时记录字符数+1，最后关闭文件，输出字符数。

void printCount(char path[]){//计算文件字符数
    FILE *fp;
    fp=fopen(path,"r");
    if(fp==NULL){//读取文件为空时，结束程序
        printf("读取文件失败
");
        return ;
    }
    int count=0;
    char read=fgetc(fp);//打开文件后读取字符
    while(read!=EOF){
        count++;//每读取一个字符，字符数+1
        read=fgetc(fp);
        }
    printf("文件字符数为：%d 
",count);//打印数据
    fclose(fp);
    return ;
    }

2、功能二：计算文件词汇数-w

　　通过输入的文件路径打开文件，用fgetc()函数每读取一个字符，当上一个字符为空且本次读取字符有效时，记录词汇数+1，最后关闭文件，输出词汇数。

void printWord(char path[]){//计算文件词汇数
    FILE *fp;
    fp=fopen(path,"r");//打开文件
    if(fp==NULL){
        printf("读取文件失败
");
        return ;
    }
    int count=0;
    int blank=0;//balnk=1是光标位于单词中，blank=0时光标位于单词间隔处
    char read=fgetc(fp);
    while(read!=EOF){
        if((read>='a'&&read<='z')||(read>='A'&&read<='Z')||(read>='0'&&read<='9')){
            if(blank==0) count++,blank=1;//当blank0变1时，词汇数+1
        }else blank=0;
        read=fgetc(fp);
    }
    printf("文件词数为：%d 
",count);//输出数据
    fclose(fp);
    return ;
}

3、功能三：计算文件行数

　　通过输入的文件路径打开文件，初始行数为1，用fgetc()函数每读取一个字符，当读取到' '时，记录行数+1，最后关闭文件，输出行数。

void printLine(char path[]){//计算行数
    FILE *fp;
    fp=fopen(path,"r");//读取文件
    if(fp==NULL){
        printf("读取文件失败
");
        return ;
    }
    int count=1;//初始值为1
    char read=fgetc(fp);
    while(read!=EOF){
        if(read=='
') count++;//读取到'
'时行数+1
        read=fgetc(fp);
    }
    printf("文件行数为：%d 
",count);//输出数据
    fclose(fp);
    return ;
}

4、功能四：计算文件空行、代码行、注释行数

　　通过输入的文件路径打开文件，用fgetc()函数每读取一个字符。

　　当读取到' '时：

　　　　若记录的该行的小于等于1个'{''}'或都为空格，记录空行数+1；

　　　　若记录的该行非空行，记录代码行数+1；

　　　　若记录该行存在连续两个'/'符号，注释行数+1；

　　最后关闭文件，输出数据。

void printMore(char path[]){//计算空行、代码行、注释行数
    FILE *fp;
    fp=fopen(path,"r");
    if(fp==NULL){
        printf("读取文件失败
");
        return ;
    }
    int ept=0,ch=0,count=0,codeline=0,noteline=0,note=0,flag=0;//ch可视符号数，count字符数,ept空行数,codeline代码行,noteline注释行;flag=0时该行无注释;note=1时表示前一个符号为'/'
    char read=fgetc(fp);
    while(1){
        if(read=='
'||read==EOF){//判断一行的结束
            if(count==0&&ch<=1) ept++;//当字符数都是空格且有小于一个可视字符时，空行+1
            else if(count>0) codeline++;
            ch=0;count=0,note=0,flag=0;//在下一行重置变量
        }
        else if(read=='{'||read=='}') {
            if(ch==1) count++;
            ch++;
        }//一行中的可视字符数
        else if(read!=' ') count++;
        if(note==1&&read!='/') note=0;//计算注释行数,'/'非连续时重置flag为0
        if(read=='/'&&flag==0){
            if(note==0) note++;
            if(note==1) flag=1,noteline++;//'/'连续时flag为1且注释行+1
        }
        if(read==EOF) break;
        read=fgetc(fp);
    }
    printf("文件空行数为：%d 
",ept);
    printf("文件代码行数为：%d 
",codeline);
    printf("文件注释行数为：%d 
",noteline);
    fclose(fp);
    return ;
}

5、主函数

int main()
{
    char choice,path[200];
    while(1){
        printf("===菜单===
输入“c”：计算文件字符数；
输入“w”，计算文件词汇数；
输入“l”：计算文件行数；
输入“a”：计算文件空行/代码行/注释行数；

");
        printf("
请输入您想进行的操作:wc.exe-");
        scanf("%c",&choice);
        switch(choice){
    case 'c':
        printf("请输入文件路径：");
        scanf("%s",&path);
        printCount(path);
        printf("按任意键返回
");
        break;
    case 'w':
        printf("请输入文件路径：");
        scanf("%s",&path);
        printWord(path);
        printf("按任意键返回");
        break;
    case 'l':
        printf("请输入文件路径：");
        scanf("%s",&path);
        printLine(path);
        printf("按任意键返回");
        break;
    case 'a':
        printf("请输入文件路径：");
        scanf("%s",&path);
        printMore(path);
        printf("按任意键返回");
        break;
    default:break;
        }
        getch();
        system("CLS");
    }
    return 0;
}

六、测试运行

文件1-5分别是：空文件，只有一个字符的文件，只有一个词的文件，只有一行的文件，一个典型的源文件。

1、计算字符数

2、计算词汇数

3、计算行数

 4、计算空行/代码行/注释行数

七、项目小结

      对于完成一个项目来说，对编程语言的掌握尤为重要。因为之前没有接触过FILE操作，所以拿到题目的时候有点茫然，随后我马上去查找资料，并且翻看以前做过的项目重温c语言的知识。尽管事先做了这样的准备，还是避免不了开发过程中的许多问题，只好边学习边做项目，这不是一个好习惯，我以后应该多学多练才行，不能到了要实战的时候才临时抱佛脚。

      在开发过程中，应该养成随时写注释的好习惯。这次的作业中，我在开发的时候没有做太多的注释，以至于后来写报告的时候才发现项目完成后补充注释确实是一件麻烦事，会降低效率，也有可能出现自己读不懂的情况，所以以后应该要养成这个习惯。

      对于扩展功能中的递归调用，我有尝试写过，但是运行不起来，但是提交作业不等于结束，我想等我再继续学习思考，努力提升自我，争取早日解决这个问题并且早日实现高级功能。

八、PSP表格

PSP2.1	Personal Software Process Stages	预估耗时（分钟）	实际耗时（分钟）
Planning	计划	30	20
· Estimate	· 估计这个任务需要多少时间	30	20
Development	开发	430	535
· Analysis	· 需求分析 (包括学习新技术)	60	120
· Design Spec	· 生成设计文档	20	20
· Design Review	· 设计复审 (和同事审核设计文档)	0	0
· Coding Standard	· 代码规范 (为目前的开发制定合适的规范)	30	15
· Design	· 具体设计	30	20
· Coding	· 具体编码	240	270
· Code Review	· 代码复审	20	30
· Test	· 测试（自我测试，修改代码，提交修改）	30	60
Reporting	报告	65	110
· Test Report	· 测试报告	30	75
· Size Measurement	· 计算工作量	20	15
· Postmortem & Process Improvement Plan	· 事后总结, 并提出过程改进计划	15	15
合计		525	660