使用VC内嵌Python实现的一个代码检测工具

最近组内准备整顿代码，领导让我写个简单的python脚本分析代码中注释的行数和无效注释。因为这个需求不是很急，所以我想把简单的事情做复杂点。于是就写了一个用VC内嵌Python，并通过模拟按键和发消息去控制其他软件的工具。

作为一个程序员，总是希望自己写的东西别人能用上且喜欢去用。因为python更新很快，往往两个版本中存在一些语法或者实现的改动。其实最讨厌的就是语法变动了，像2.X的print到3.X时就是print()了。我本意是希望做个大家都能用上的，于是我决定用VC内嵌一个python引擎去完成相关工作。

首先说一下环境准备，这个网上一大堆，主要是下载并配置好pythonXX_d.lib、pythonXX.lib、python.dll等几个文件。然后一切就可以开始了。

python分析的过程也很简单，AnalyzeFloder.py是对一个文件夹进行遍历，并做相关统计；AnalyzeFileComment.py是分析每个文件并且帅选出注释；CommentUseOrNo.py是分析每个注释，看看是否是无用注释；AnalyzeReport.py做相关统计和序列化、反序列化工作。AFCUI.py 是对上述功能的封装。这里说一下对无用注释的定义，我们定义如果注释内容为符合VC编码风格的代码即认为是无效代码。在现实开发中，特别是人员流动性特别大的公司，新人做需求时往往不敢去碰那些没有任何注释的代码，于是他们就直接把这些似乎不用了的代码注释掉。这样长久下来，“无用注释”的量就会很大了。

Python代码 

1. <span style="white-space: pre;">  </span># a(x)  
2.         # a (x)  
3.         # a    (x)  
4.         # x = x  
5.         #     x x  
6.         #     x x,y y  
7.         self.InitNoUseRe(r'[a-zA-Z](\w)*([ \t])*\([\w\s]*|([\w\s]*(,[\w\s]*))\)')  
8.           
9.         # }  
10.         # }a;  
11.         self.InitNoUseRe(r'\}[ \t\r\n]*([a-zA-z]+;)?[ \t\r\n]*)  
12.           
13.         self.InitNoUseRe(r'^([ \r\t\n]*)({[ \r\t\n]*))  
14.           
15.         self.InitNoUseRe(r'[a-zA-Z]+[ \t]*[=><]{1,2}([ \t]*[a-z0-9A-Z]+[ \t]*))  
16.           
17.         self.InitNoUseRe(r'#define[ \t][a-zA-Z]*([ \r\t\n]*))  
18.           
19.         self.InitNoUseRe(r'return[ \t][a-zA-Z]*(;[ \r\t\n]*))  
20.           
21.         self.InitNoUseRe(r'[a-zA-Z](\w)*\+\+(;[ \r\t\n]*))  
22.           
23.         self.InitNoUseRe(r'[a-zA-Z](\w)*--(;[ \r\t\n]*))  
24.           
25.         self.InitNoUseRe(r'^([ \r\t\n]*continue)(;[ \r\t\n]*))  
26.           
27.         self.InitNoUseRe(r'^([ \r\t\n]*break)(;[ \r\t\n]*))  
28.           
29.         self.InitNoUseRe(r'case (\w)+(:[ \r\t\n]*))  
30.           
31.         self.InitNoUseRe(r'^([ \r\t\n]*[a-zA-Z](\w)*[ \r\t\n]+[_a-zA-Z](\w)*)((;|\{|(\[\w*\]);)[ \r\t\n]*))  
32.           
33.         self.InitNoUseRe(r'^([ \r\t\n]*))  
34.           
35.         self.InitNoUseRe(r'^([ \r\t\n]*(struct|class))([ \r\t\n]* [a-zA-Z](\w)*)((\{|;)?[ \r\t\n]*))  

以上是我定义的无效代码的正则表达式，因为正则也是拿来用用，没有好好研究过，所以写的不好，凑合着用了，从目前的效果看，还是可以的。

其次，对于分析出来的数据，我将其序列化到一个文件中，这样以后要是加载之前分析过的工程，就可以直接反序列化那个文件就行了，不用重复分析。

Python代码 

1. def GetFileInfoMapFromDump(self,filepath):  
2.     with open(filepath, 'rb') as f:  
3.         data = pickle.load(f)  
4.     return data  
5.   
6. def DumpFileInfoMap(self,filemap,filepath):  
7.     with open(filepath, 'wb') as f:  
8.         pickle.dump(filemap, f, pickle.HIGHEST_PROTOCOL)  

再次，说下python和VC的通信。python可以直接和VC通信，但是我返回的数据是一个复杂的结构，我一直也没想到一个简便的办法去解决，于是，我就自定义一种格式，让python在处理完数据后，将数据保存为我定义的格式，然后把文件名返回给VC，VC去读并分析这个文件，从而得到数据。

Python代码 

1. def GenerateVcDataFile(self,fileinfomap,vcdatefilepath):  
2.         vcdatafileobj = open( vcdatefilepath, 'w+')   
3.           
4.         for key in fileinfomap:  
5.             strvcdata = None  
6.             strvcdata = key  
7.             index = 0  
8.             for value in fileinfomap[key]:  
9.                 if index == 3:  
10.                    for linenum in value:  
11.                         strvcdata = strvcdata + '|' + str(linenum)  
12.                 else:  
13.                    strvcdata = strvcdata + '|' + str(value)           
14.                 index = index + 1  
15.             strvcdata = strvcdata + '|\n'  
16.             vcdatafileobj.write(strvcdata)      
17.         if None != vcdatafileobj:  
18.             vcdatafileobj.close()  
19.           
20.         return vcdatefilepath  

对应的VC解析代码我放在CAnalyzeVcData中，代码就不贴的（没严格省代码）。

python的大致流程就是如此，VC要是想执行Python的脚本，就如下了

Cpp代码 

1. CString CManageTask::AnanlyzeCodeFloder( const CString& cstrCodeFloderPath,  
2.                                          const CString& cstrProjectFloderPath )  
3. {  
4.     CString cstrVcDataPath = L"";  
5.     Py_Initialize();    
6.   
7.     // 进行初始化python  
8.     PyObject* pModule = NULL;  
9.      // 函数对象  
10.     PyObject* pFunc = NULL;                                  
11.   
12.     do   
13.     {  
14.         // 找到模块对象指针  
15.         pModule = PyImport_ImportModule("AFCUI");             
16.   
17.         if ( NULL == pModule )  
18.         {  
19.             ASSERT(pModule);  
20.             break;  
21.         }  
22.   
23.         // 从模块对象中获取指定函数对象指针  
24.         pFunc = PyObject_GetAttrString( pModule, "AFloderFunc" );   
25.         if ( NULL == pFunc )  
26.         {  
27.             ASSERT(pFunc);  
28.             break;  
29.         }  
30.   
31.         std::string strProjectPath = ConvertCstrint2String(cstrProjectFloderPath);  
32.         std::string strCodeFloderPath = ConvertCstrint2String(cstrCodeFloderPath);  
33.   
34.         // 构造参数  
35.         PyObject* pargslist = Py_BuildValue("(s,s)", strCodeFloderPath.c_str(), strProjectPath.c_str());  
36.   
37.         char* pchvcdatapath = NULL;  
38.   
39.         // 调用函数    
40.         PyObject* pstr = PyEval_CallObject(pFunc, pargslist);              
41.         if ( NULL == pstr )  
42.         {  
43.             ASSERT(pstr);  
44.             break;  
45.         }  
46.   
47.         PyArg_Parse(pstr, "s", &pchvcdatapath);  
48.   
49.         if ( NULL != pchvcdatapath )  
50.         {  
51.             cstrVcDataPath = CA2W(pchvcdatapath);  
52.         }  
53.     } while (0);  
54.   
55.   
56.     Py_Finalize();   
57.     return cstrVcDataPath;  
58. }  

如果对于分析出的数据，为了方便用户查看，我得打开源代码并定位到那个位置。我想过很多方法，想过自己做RichEdit，但是我对界面实在不感冒，于是懒的情绪就上来了。但是我对“玩”还是很有感觉的，我决定盗用微软的Notepad.exe，还修改了Notepad.exe的资源，成为我定制版的东东。然后通过模拟按键和发消息等方法去让它去打开源代码并定位位置。

但是使用中，我发现有点不爽。因为我发现，notepad.exe不可以显示行。UE呢还要注册，于是选用Notepadplusplus了。Notepadplusplus还支持多标签页，让我感觉很兴奋，超出我的预期。

贴一段控制notepadplusplus的代码。

Cpp代码 

1. DWORD CManageTask::CreateNotePad()  
2. {  
3.     STARTUPINFO si;  
4.     PROCESS_INFORMATION pi;  
5.     ZeroMemory( &pi, sizeof(pi) );  
6.     ZeroMemory( &si, sizeof(si) );  
7.     si.cb = sizeof(si);  
8.   
9.     CString cstrNNotepadPath = m_strFloder + L"\\Notepadplusplus\\notepad++.exe";  
10.     CreateProcess( cstrNNotepadPath,  
11.         L"", NULL, NULL, FALSE, NULL, NULL,NULL , &si, &pi);  
12.   
13.     return pi.dwProcessId;  
14. }  
15.   
16. RECT CManageTask::GetNotePadRect()  
17. {  
18.     RECT rc;  
19.     m_pAnalyzeCodeDlg->GetWindowRect(&rc);  
20.     m_pAnalyzeCodeDlg->ClientToScreen(&rc);  
21.     RECT nrc;  
22.     nrc.left = rc.left;  
23.     nrc.right = nrc.left + rc.right - rc.left;  
24.     nrc.top = rc.top + rc.bottom - rc.top;  
25.     nrc.bottom = nrc.top + rc.bottom - rc.top;  
26.     m_pAnalyzeCodeDlg->ScreenToClient( &nrc );  
27.     return nrc;  
28. }  
29.   
30. HWND CManageTask::GetNotePadFilePathEdit( HWND hwndP )  
31. {  
32.     if ( NULL == hwndP )  
33.     {  
34.         return NULL;  
35.     }  
36.   
37.     HWND hComboBoxEx32 = ::FindWindowEx( hwndP, NULL, L"ComboBoxEx32", NULL );  
38.     HWND hComboBox = ::FindWindowEx( hComboBoxEx32 , NULL, L"ComboBox", NULL );  
39.     HWND hEdit = ::FindWindowEx( hComboBox , NULL, L"Edit", NULL );  
40.     return hEdit;  
41. }  
42.   
43. HWND CManageTask::GetNotePadOkButton( HWND hwndP )  
44. {  
45.     if ( NULL == hwndP )  
46.     {  
47.         return NULL;  
48.     }  
49.     HWND hOKButton = ::FindWindowEx( hwndP, NULL, L"Button", NOTEPADOPENFILENAME2 );  
50.     return hOKButton;  
51. }  
52.   
53. HWND CManageTask::GetNotePadOpenFileDialog()  
54. {  
55.     HWND hAfter = NULL;  
56.     HWND h = ::FindWindowEx( NULL, hAfter, NULL, NOTEPADOPENFILENAME );  
57.     DWORD dwPID = 0;  
58.   
59.     while ( NULL != h )  
60.     {  
61.         h = ::FindWindowEx( NULL, hAfter, NULL, NOTEPADOPENFILENAME );  
62.         GetWindowThreadProcessId( h, &dwPID );  
63.         if ( dwPID == m_dwThreadNotePadID )  
64.         {  
65.             return h;  
66.         }  
67.         else  
68.         {  
69.             hAfter = h;  
70.         }  
71.     }  
72.   
73.     return NULL;  
74. }  
75.   
76. HWND CManageTask::GetNotePadEdit( HWND hwndP )  
77. {  
78.     if ( NULL == hwndP )  
79.     {  
80.         return NULL;  
81.     }  
82.     HWND hEidt = ::FindWindowEx( hwndP, NULL, L"Scintilla", NULL);  
83.     return hEidt;  
84. }  
85.   
86. VOID CManageTask::OpenNewFile( const CString& cstrFilePath )  
87. {  
88.     HWND hwndP = NULL;  
89.     while ( NULL == hwndP )  
90.     {  
91.         ::SetForegroundWindow( m_hwndNotePad );  
92.         ::SetActiveWindow( m_hwndNotePad );  
93.         ::SetFocus( m_hwndNotePad );  
94.         {  
95.             keybd_event( VK_CONTROL, MapVirtualKey(VK_CONTROL, 0), 0, 0 );  
96.             keybd_event( 0x4F, 0, 0, 0 );  
97.             keybd_event( 0x4F, 0, KEYEVENTF_KEYUP, 0 );  
98.             keybd_event( VK_CONTROL, MapVirtualKey(VK_CONTROL, 0), KEYEVENTF_KEYUP, 0 );  
99.         }  
100.         Sleep(500);  
101.   
102.         hwndP = GetNotePadOpenFileDialog();  
103.     }  
104.   
105.     HWND hEdit = GetNotePadFilePathEdit(hwndP);  
106.     HWND hOKButton = GetNotePadOkButton(hwndP);  
107.   
108.     CString strTmp = cstrFilePath;  
109.   
110.     if ( NULL != hEdit )  
111.     {  
112.         ::SendMessage( hEdit, WM_SETTEXT, 0, (LPARAM)strTmp.GetBuffer() );  
113.         strTmp.ReleaseBuffer();  
114.         if ( NULL != hOKButton )  
115.         {  
116.             ::SendMessage( hOKButton, WM_LBUTTONDOWN, 0, 0);  
117.             ::SendMessage( hOKButton, WM_LBUTTONUP, 0, 0);  
118.         }  
119.     }  
120. }  

于是大功告成了。

目前还有很多没有完善的地方，比如字符串的转码（程序放在中文目录下有转码问题，出在python回传结果的时候）和规则（规则不全面）。还有很多可以“玩”的功能，比如对单个文件的重新分析。目前我思路都想好了，也预留了接口。我想通过 FindFirstChangeNotification监控指定目录文件，如果有改动，就调用AFCUI.py中

Python代码 

1. def AnalyzeCodeFilePathFunc(self,codefilepath):  
2.        analyzefile = CAnalyzeFloder()  
3.        analyzefile.AnalyzeFile(codefilepath)  
4.        fileinfomap = analyzefile.GetCodeFloderInfo()  
5.        AnalyzeReport(fileinfomap)  

(需要封装)。然后VC得到当个文件的可以解析的数据，并更新内存和界面。因为之前玩过 FindFirstChangeNotification（我毕设就是玩它的），所以我就没多大兴趣去做这个功能了。

还有这次MFC代码，我尝试了下界面和逻辑分离的原则，很好玩，代码也清晰很多，所有的逻辑都在CManageTask类中。

代码链接：AnalyzeCode//https://onedrive.live.com/?cid=8d63dcd52e7cd4fe&id=8D63DCD52E7CD4FE%21151&authkey=!ANEGnTJMGSCR_Eo