Create New Commands in Tcl
eryar@163.com
摘要Abstract：Tcl/Tk腳本可以很容易實現用戶自定義的命令，方便的創建圖形化的用戶界面GUI，所以Tcl和Tk的應用領域幾乎覆蓋了圖形和工程應用的全部范圍，包括計算機輔助設計、軟件開發、測試、儀器控制、科學可視化及多媒體方面。本文主要詳解如何在C程序中使用Tcl來創建自定義的命令，并理解OpenCascade的Draw Test Harness的實現。
關鍵字Key Words：OpenCascade, Tcl/Tk, Draw Test Harness, Software Customization
一、引言 Introduction
Tcl是”Tool Command Language”，和Python、Perl、Lua等一樣也是一種腳本語言。利用Tcl可以很容易實現自定義的命令，利用Tk可以很方便地創建出跨平臺的用戶界面UI。因Tcl/Tk功能強大，跨平臺便于移植，且是開源免費的，所以在OpenCascade中就利用這個庫來實現了測試程序Draw Test Harness，并且也利用Tcl實現了自動化測試。
因為Tcl是解析語言，所以Tcl可用來做為程序中的二次開發語言。因為修改Tcl的腳本不需要重新編譯鏈接，只需要重新加載下，加快開發速度。
通過在Tcl中實現自定義的命令，來理解OpenCascade中Draw Test Harness的實現，并去感受Tcl的強大功能。
Figure 1.1 Draw Test Harness with Tcl/Tk
二、Tcl/Tk應用 OpenCascade Draw Test Harness
在Draw Test Harness中輸入自定義的命令就可以對相應的建模造型程序進行檢驗。理解其實現方法，也可以加深對OpenCascade的其他模塊的理解。如下圖所示為自定義命令：
Figure 2.1 User defined command in Draw Test Harness
Figure 2.2 Command result in Test3d view
可以結合《OpenCascade Test Harness User’s Guide》來試試Draw Test Harness，如果將命令做在自己的程序中，就可以實現腳本建模啦。
Draw Test Harness中的命令都是用Tcl/Tk來實現的，下面通過一個簡單的示例來說明如何在Tcl中實現自定義的命令。學會Tcl腳本應該也是掌握了一種強大的腳本工具，可以為自己的程序實現二次開發功能。
三、程序示例 Example Code
在Tcl中實現自定義命令很方便，只需要按Tcl的格式定義一個命令函數。基于對象的命令函數的聲明如下：
typedef int (Tcl_ObjCmdProc) _ANSI_ARGS_((ClientData clientData,
Tcl_Interp *interp, int objc, struct Tcl_Obj * CONST * objv));
為了能在Tcl中調用一個命令函數，必須先調用Tcl_CreateObjCommand注冊它，格式如下所示：
EXTERN Tcl_Command Tcl_CreateObjCommand (Tcl_Interp * interp,
CONST char * cmdName, Tcl_ObjCmdProc * proc,
ClientData clientData,
Tcl_CmdDeleteProc * deleteProc);
這就是把Tcl中的字符串與實現它的C函數關聯起來“魔術”。一個完整的程序如下所示，程序實現了兩個自定義的命令randomcmd和equalcmd，分別用來生成一個隨機數和相等判斷：
/*
* Copyright (c) 2014 eryar All Rights Reserved.
*
* File : Main.cpp
* Author : eryar@163.com
* Date : 2014-01-09 18:58
* Version : 1.0v
*
* Description : Create new command for Tcl in C. Refer to
* 1. Tcl and Tk Toolkit
* 2. Practical Programming in Tcl and Tk
*
* Key Words : Tcl/Tk, C Interface, New Command
*
*/
#include <tcl.h>
#include <stdlib.h>
#include <string.h>
#pragma comment(lib, "tcl85.lib")
/*
* @breif Definitions for application-specific command procedures.
*/
int RandomCmd(ClientData clientData, Tcl_Interp* interp, int objc, Tcl_Obj *CONST objv[])
{
if (objc != 2)
{
Tcl_WrongNumArgs(interp, 1, objv, "?range");
return TCL_ERROR;
}
int limit = 0;
Tcl_Obj* result = NULL;
Tcl_GetIntFromObj(interp, objv[1], &limit);
result = Tcl_NewIntObj(rand() % limit);
Tcl_SetObjResult(interp, result);
return TCL_OK;
}
int EqualCmd(ClientData clientData, Tcl_Interp* interp, int objc, Tcl_Obj *CONST objv[])
{
if (objc != 3)
{
Tcl_WrongNumArgs(interp, 1, objv, "string1 string2");
return TCL_ERROR;
}
Tcl_Obj* result = NULL;
char* arg1 = Tcl_GetString(objv[1]);
char* arg2 = Tcl_GetString(objv[2]);
if (strcmp(arg1, arg2) == 0)
{
result = Tcl_NewBooleanObj(1);
}
else
{
result = Tcl_NewBooleanObj(0);
}
Tcl_SetObjResult(interp, result);
return TCL_OK;
}
/*
* @breif Tcl_AppInit is called from Tcl_Main after the Tcl interpreter has been created,
* and before the script file or interactive command loop is entered.
*/
int Tcl_AppInit(Tcl_Interp* interp)
{
// Initialize packages Tcl_Init sets up the Tcl library facility.
if (Tcl_Init(interp) == TCL_ERROR)
{
return TCL_ERROR;
}
// Register application-specific commands.
Tcl_CreateObjCommand(interp, "randomcmd", RandomCmd, NULL, NULL);
Tcl_CreateObjCommand(interp, "equalcmd", EqualCmd, NULL, NULL);
return TCL_OK;
}
int main(int argc, char* argv[])
{
Tcl_Main(argc, argv, Tcl_AppInit);
return 0;
}
程序效果如下圖所示：
Figure 3.1 User defined command in Tcl
結合上面的代碼來理解Draw Test Harness中自定義命令的實現可以事半功倍。當然也可以在C程序中使用Tk來定義用戶界面UI。詳細信息請參考References中羅列的參考資料。
由上可知，使用Tcl/Tk可以使自己的程序實現命令行的功能，如AutoCAD、PDMS中都有這種功能，用戶通過輸入命令來實現一定的功能，很方便，如下圖所示為PDMS中的命令窗口：
Figure 3.2 Command Window of AVEVA Plant/PDMS
四、結論 Conclusion
通過在程序中使用Tcl實現自定義的命令，理解Tcl中C接口的用法。在此基礎上來理解OpenCascade中Draw Test Harness的實現要更容易。
通過學習Tcl/Tk可知，Tcl可以作為程序的二次開發語言，類似PDMS中的PML。Tcl中自定義命令方便，還可對表達式進行解析并求值，功能相當強大。缺點就是在Tcl中面向對象的功能要差點兒，如在Tcl腳本中自定義一個對象，像在PML中可以這樣來自定義對象，而在Tcl中這種自定義類型是不支持的：
Figure 4.1 User Defined Object in PDMS PML
好像Tcl也有對面向對象的加強庫TclOO，基本用法如圖所示：
Figure 4.2 Basic Usage of TclOO
五、參考資料 References
1. Tcl and the Tk Toolkit
2. Practical Programming in Tcl and Tk
3. Tcl/Tk A Developer’s Guide
4. http://sourceforge.net/projects/tcl/
5. http://www.tcl.tk/