酒杯上的碟

酒杯上的碟
(the dish on kylix)
clx / customs controls / cross-platform
作者: robert kozak
翻译: cakk

交叉平台控件(cross-platform controls)
从windows到linux,或者相反


borland处在一个令人兴奋的时期.并不是自从delphi--这个borland的令人兴奋的产品的第一声.我正在谈论的当然是关于kylix,这个把c++builder和delphi带到linux操作系统的项目.delphi版本将首先面世,所以在本文余下部分,kylix指的是delphi for linux.

我们正在为delphi开发崭新的能够在windows和linux下工作的vcl.这意味着你可以在windows下写一个应用程序,然后把源代码转移到linux下面重新编译--反之亦然.这个新的vcl叫clx,意即"交叉平台控件库(component library cross-platform)",clx包含整个随kylix发布的交叉平台库.在我写本文时它被分为下面四个子类:


baseclx就是rtl,包含并且升级了
visualclx包含了用户界面类,比如常用的控件
dataclx包含交叉平台的数据库控件
netclx包含internet部分,比如apache等等..

在我写这篇文章的时候(2000年5月之前),kylix的第一部分测试已经正在进行了.当你读到这篇文章的时候,我正在使用的kylix和你将要看到的正式版本将会有很大不同.这为我的工作带来很多不便.是简单地谈一谈便罢?还是涉及一下底层的结构?我更倾向于详细的讨论,这样无论如何你能得到一点关于clx控件构造的头绪.但是要牢记一点: 当你阅读此文的时候,很可能这篇文章中很多细节的讨论已经改变了.

没有更接近的了(no one else comes close)

这篇文章是关于写定制visualclx控件的初级读本.从本质上说,visualclx就是你所知道并热爱的vcl.当你这样认为的时候,"可视构件库"(visual component library)有一点用词不当:还有比"可视构件"更多的东西.但是在这篇文章里面,我只谈论"可视"控件.类似button, edit, listbox, pagecontrol, statusbar, progressbar等等的控件,都已经在交叉平台下重新实现.但是目前的vcl如此依赖windows,我们是怎么做到这些的呢?简单地说,我们剥离了所有的windows元素,然后把它们用别的工具包(toolkit)代替.

在linux下,有大量的工具包包含标准windows控件(如buttons).它们被称做"widgets".其中gtk和qt(被发音成"cute")就是两个非常流行的.qt是一个工作在windows和linux下的widgets,因为它非常接近我们的目标,所以qt被选择作为clx的基础.换句话说,qt和clx就好像windows api/通用控件和vcl的关系.对于linux下的delphi的定制构件开发者来说,qt有一些明显的好处:


它是一个广泛使用的linux下的widgets集,被流行的kde桌面采用.
它的开发和windows api风格非常相似
它的图形模块和vcl的图形模块相似
它的类看上去非常像vcl控件
它引入大量标准widgets,并且具有消息循环

这将引发两个疑问:是否这意味着kylix只支持kde,而不支持其他的桌面(desktop)?比如gnome?并且,以qt为基础的clx会给我带来多大影响? 第一个问题的回答是:kylix应用程序将运行在所有linux桌面下,特别是gnome和kde. 本文的余下部分将回答第二个问题.

不让你返回(????)(don''t want you back)

我们的目标是让开发者容易地将应用程序转移到linux下,并且困难要最小化.大部分(新旧控件)的名字都是一样的,大部分的属性也是一样的.尽管有一些控件的少数属性去掉了,增加了一些新的属性,但对于绝大部分来说,应该可以平稳的转移你的应用程序.

对控件作者来说有一些不同. 对于一个新手,现在没有了,也没有windows api了.你可以对message标识和所有cn,cm通知(notifications)说再见了.这些都转换成了动态的(dynamics)(???).在第一版中也不再有dock,bidi相关的方法/属性,输入法(ime),远东语言支持了.当然,更不会有activex,com或者ole支持,windows 3.1控件也去掉了.


methods
createparams
createsubclass
createwindowhandle
createwnd
destroywindowhandle
destroywnd
doadddockclient
dockover
dodockover
doremovedockclient
doundock
getdevicecontext
mainwndproc
resetime
resetimecomposition
setime
setimecompositionwindow
wndproc
properties
ctl3d
defwndproc
dockmanager
docksite
imemode
imename
parentctl3d
usedockmanager
wheelaccumulator

附图1: 从twidgetcontrol(和twincontrol相类似)里面去掉的methods和properties.


此刻我打赌你正在想:"还不坏.转移我的应用程序听上去不是很难",但是请等等----还有更多的.在写此文的时候,clx类的名字都被加上了一个"q"的前缀,比如stdctrls变成了qstdctrls,有些类被稍微搅乱了一点,在类继承上面只有一些细微差别.(见附图 2)


附图 2: 在类继承上面的细微区别.


clx的这个"q"前缀不一定是最终版本的前缀.twincontrol现在变成了twidgetcontrol,不过为了安抚痛苦,我们为twidgetcontrol添加了一个twincontrol的别名.twidgetcontrol和它的后代都有一个handle属性,隐式地指向qt对象,有一个hooks属性指向一个hook对象,用来实现事件机制.(hooks是一个复杂的话题,已经超出本文的讨论范围)

ownerdraw将被一种叫做styles的方法替代. 基本上styles是widget或应用程序显示新面孔的一种机制,类似于windows下面的贴图(skins). 这部分正在开发当中,所以本文中我无法更进一步的介绍,我只能说:它非常酷!

(新旧控件中)有没有什么是一样的?当然有,tcanvas(包括pens,brushes等)和你记得的一样.就像我说过的,类的继承基本上一样,还有事件,比如onmousedown, onmousemove, onclick...等等都还在.

让我看看内涵(show me the meaning)(???)

让我们进入到clx的躯体,看看它是如何工作的.qt是一个c++的工具集,所以所有的widgets都是c++对象.另一方面,clx是用object pascal写的,并且object pascal不能直接和c++对象对话.越想简单就越难,qt在几个地方使用了多继承,所以我们建立了一个接口层(interface layer)来获得所有qt的类,并且把它们还原成一系列普通的c函数,然后把它们包装成windows下的dll或是linux下的共享对象(shared object).

每个twidgetcontrol都有createwidget, initwidget, 和hookevents虚方法,并且几乎总是被重载. createwidget创建qt的widget,然后指派handle到fhandle这个私有域变量.当widget被构造(constructed)后,initwidget被调用,然后handle有效.你的一些属性赋值将从create这个构造函数转移到initwidget.这将能够做到延迟构造(delayed construction)一个对象,直到真的需要它的时候.举个例子,你有一个属性叫color,在setcolor里面,你可以通过handleallocated来检测是否你有一个qt的handle,如果handle已经分配(allocated),你就可以正确地调用qt来设置颜色.如果没有分配,你可以把值保存在一个私有域变量中,然后在initwidget中设置属性.


有两种类型的事件(events): widget事件和系统事件.hookevents是一个虚方法(virtual method),它钩住(hooks)clx控件的事件方法到一个特殊的hook对象,通过这个对象和qt对象通讯.(至少这是我希望看到的)
这个hook对象其实是方法指针的集合.系统事件现在通过eventhandler,基本上是wndproc的替代品.

比生命还大(larger than life)(????)

所有这些都只是后台信息(background information),因为你真的不必为了写交叉平台的定制控件而知道这些.在clx的帮助下,写交叉平台控件只是小菜一碟(a snap).就像你不必理解windows api的复杂性而去写vcl控件一样.clx和qt也是如此. 本文最后展示了一个用clx写的定制控件代码

下面是一个工程文件. 计算器控件运行在windows下(见附图4) 和linux下(见附图5) 看上去多么像标准的microsoft windows 计算器!

program calctest;
uses
sysutils, classes, qcontrols, qforms, qstdctrls, qt,
qcomctrls, qcalc, types;
type
ttestform = class(tform)
calc: tcalculator;
public
constructor create(aowner: tcomponent); override;
end;

var
testform: ttestform;
{ ttestform }
constructor (aowner: tcomponent);
begin
inherited createnew(aowner);
setbounds(10,100,640,480);
calc := (self);
// don''t forget: we have to set the parent.
:= self;
:= 100;
:= 200;
// uncomment these to try other border effects:
// style := bsetched;
end;

begin
application := (nil);
form(ttestform, testform);
;
;
end.

附图 3: clx计算器控件的工程文件


附图 4: 运行在windows下的计算器控件.



附图 5: 运行在red hat linux下的计算器控件.

就像你所看到的,tcalculator是tframecontrol的子类.tframecontrol继承自twidgetcontrol的一个子类.它为你的控件提供了一个框架(frame),我们最感兴趣的属性是borderstyle:

tborderstyle = (bsnone, bssingle, bsdouble, bsraisedpanel,bssunkenpanel,
bsraised3d, bssunken3d, bs etched, bsembossed);

在这个控件(tcalculator)中有两个重要的方法.buildcalc创建所有的按钮,并且把它们摆放到正确的位置.正如你所看到的,我使用了一个叫tbuttontype的枚举类型来控制按钮的"功能(function)",还有少量的信息做为整型保存在tag属性里面.我在后面的calc方法里面会讲到它.所有的计算器按钮保存在一个叫做btns的受保护的(protected)记录数组里面,类型是tbuttonrecord.

tbuttonrecord = record
top: integer;
left: integer;
width: integer;
height: integer;
caption: string;
color: tcolor;
end;

这样做能够容易的在一个循环里面设置所有的按钮,而不用写一大串的调用.注意所有按钮的onclick句柄都指派给了tcalculator的calc方法.直接指派到一个自定义事件是不错的,因为所有按钮都在计算器的内部,并且这些事件都不用被published(见附图6)

for i := low(tbuttontype) to high(tbuttontype) do
with (self) do
begin
parent := self;
setbounds(btns[i].left, btns[i].top, btns[i].width,
btns[i].height);
caption := btns[i].caption;
color := btns[i].color;
onclick := calc;
tag := ord(i);
end;
附图 6: 在这种情况下,直接指派一个自定义事件是明智的

我有一个叫fstatus的tlabel控件. tlabel也是tframecontrol的后代,我想在计算器里面使用它,所以我让它具有"sunken box"的外观来显示计算器的存储记忆,就像windows里面的计算器一样.qt标签的widget非常像vcl里面的tpanel控件.对于clx里面的tlabel,我们没有发布(publish)它的框架(frame)属性,但是这并不妨碍你继承使用它.

在buildcalc里面我做的最后一件事是创建一个edit控件来显示计算结果,正像你所看到的,计算器控件的text属性和edit控件的text属性直接挂钩.

另一个重要的方法是calc,它实质上是一个庞大的case语句,用来计算哪一个按钮被按下,并且决定该如何去做.我使用了私有域变量fcurrentvalue, flastvalue 和 frepeatvalue来保存计算的值,所以我不必使用堆栈来实现.这个例子只是为了展示如何创建交叉平台控件,而不是如何写一个计算器.

很好,还记得吗,我在buildcalc中使用了tag属性来控制它的功能.在这个方法里面,我们将参数sender强制转化成tbutton,再将它的tag强制转化成tbuttontype类型,最后赋值给buttontype. butontype就是那个case语句里面的选择器表达式.

buttontype := tbuttontype(tbutton(sender).tag);

对于我们如何把这些转换成交叉平台控件,你感到惊奇吗? 不? 非常好! 这说明你已经集中注意力了.这些代码可以同时在windows和linux下面编译,而不用改动任何地方.没有任何额外的步骤.正是仰仗于clx的优点,控件已经全部完工了.

所有不得不交待的(all i have to give)(????)

你已经看到,写一个交叉平台控件和写一个vcl控件并不是完全不同.如果你是一个控件开发的新手,学习起来不会很难.如果你是一个经验丰富的vcl控件作者,你的大部分知识都将平滑地转移到kylix上去.

我前面说过,(交叉平台控件)会有一些不同,但是这只会影响那些依赖于windows api写控件的开发者.如果你写的控件是从vcl继承的,是聚合(aggregate)了一些控件的(就像我在tcalculator里面做的),是一个非可视的不依赖于windows api的,或者是一个tgraphic控件,那么转移到linux下不会遇到什么麻烦.

这篇文章介绍的软件产品的功能正在开发中,并且会在没有通知的情况下有些变化.相应功能的描述是应时而变的,并且没有任何确定的服务承诺.

做为delphi最初测试版的用户,robert kozak从1999年下半年加入borland的kylix r&d小组.从他加入borland开始,他就和c++builder 5和kylix的开发密切相关.robert还和tadda(多伦多区delphi开发者协会)有关,这个协会后来和tdug(多伦多区delphi用户组)合并.robert在这些用户社团一直很活跃,同时也经常出现在borland的新闻组里面.

[列表1]


{ ***************************************************** }
{ }
{ borland delphi visual component library }
{ borland delphi component library (x)crossplatform }
{ }
{ copyright (c) 2000 inprise/borland }
{ }
{ ***************************************************** }

unit qcalc;

// this is the very first custom control written for clx.

interface

uses
sysutils, classes, qt, qcontrols, qstdctrls, qcomctrls,
qgraphics;

type
tbuttontype = (bt0, bt1, bt2, bt3, bt4, bt5, bt6, bt7,
bt8, bt9, btdecimal, btplusminus, btmultiply, btdivide,
btadd, btsubtract, btsqrt, btpercent, btinverse,
btequals, btbackspace, btclear, btclearall,
btmemoryrecall, btmemorystore, btmemoryclear,
btmemoryadd);

tcalcstate = (csnone, csadd, cssubtract, csmultiply, csdivide);

tbuttonrecord = record
top: integer;
left: integer;
width: integer;
height: integer;
caption: string;
color: tcolor;
end;

tcalculator = class(tframecontrol)
private
fresultedit: tedit;
fstatus: tlabel;
fmemoryvalue: single;
fcurrentvalue: single;
flastvalue: single;
frepeatvalue: single;
fstate: tcalcstate;
fbackspacevalid: boolean;
protected
btns: array [tbuttontype] of tbuttonrecord;
procedure buildcalc;
procedure calc(sender: tobject);
function gettext : string; override;
procedure settext(const value : string); override;
public
constructor create(aowner: tcomponent); override;
property value : single read fcurrentvalue;
published
property text : string read gettext write settext;
property borderstyle;
property linewidth;
property margin;
property midlinewidth;
property framerect;
end;

implementation

function buttonrecord(atop, aleft, awidth, aheight: integer; acaption: string;
acolor: tcolor = clbtnface): tbuttonrecord;
begin
:= atop;
:= aleft;
:= awidth;
:= aheight;
n := acaption;
:= acolor;
end;

{ tcalculator }

constructor (aowner: tcomponent);
begin
inherited create(aowner);
setbounds(0,0,250,200);
fmemoryvalue := 0;
fcurrentvalue := 0;
flastvalue := 0;
frepeatvalue := 0;
borderstyle := bsraisedpanel;
buildcalc;
end;

procedure alc;
var
i: tbuttontype;
begin
btns[bt7] := buttonrecord(70, 48, 36, 29, ''7'');
btns[bt4] := buttonrecord(102, 48, 36, 29, ''4'');
btns[bt1] := buttonrecord(134, 48, 36, 29, ''1'');
btns[bt0] := buttonrecord(166, 48, 36, 29, ''0'');
btns[bt8] := buttonrecord(70, 88, 36, 29, ''8'');
btns[bt5] := buttonrecord(102, 88, 36, 29, ''5'');
btns[bt2] := buttonrecord(134, 88, 36, 29, ''2'');
btns[btplusminus] :=
buttonrecord(166, 88, 36, 29, ''+/-'');
btns[bt9] := buttonrecord(70, 128, 36, 29, ''9'');
btns[bt6] := buttonrecord(102, 128, 36, 29, ''6'');
btns[bt3] := buttonrecord(134, 128, 36, 29, ''3'');
btns[btdecimal] := buttonrecord(166, 128, 36, 29, ''.'');
btns[btdivide] := buttonrecord(70, 168, 36, 29, ''/'');
btns[btmultiply] := buttonrecord(102, 168, 36, 29, ''*'');
btns[btsubtract] := buttonrecord(134, 168, 36, 29, ''-'');
btns[btadd] := buttonrecord(166, 168, 36, 29, ''+'');
btns[btbackspace] :=
buttonrecord(37, 49, 63, 25, ''backspace'');
btns[btclear] := buttonrecord(37, 115, 63, 25, ''ce'');
btns[btclearall] := buttonrecord(37, 181, 63, 25, ''c'');
btns[btsqrt] := buttonrecord(70, 208, 36, 29, ''sqrt'');
btns[btpercent] := buttonrecord(102, 208, 36, 29, ''%'');
btns[btinverse] := buttonrecord(134, 208, 36, 29, ''1/x'');
btns[btequals] := buttonrecord(166, 208, 36, 29, ''='');
btns[btmemoryadd] := buttonrecord(166, 5, 36, 29, ''m+'');
btns[btmemorystore] :=
buttonrecord(134, 5, 36, 29, ''ms'');
btns[btmemoryrecall] :=
buttonrecord(102, 5, 36, 29, ''mr'');
btns[btmemoryclear] := buttonrecord(70, 5, 36, 29, ''mc'');

for i := low(tbuttontype) to high(tbuttontype) do
with (self) do
begin
parent := self;
setbounds(btns[i].left, btns[i].top, btns[i].width,
btns[i].height);
caption := btns[i].caption;
color := btns[i].color;
onclick := calc;
tag := ord(i);
end;

fstatus := (self);
with fstatus do
begin
parent := self;
setbounds(10, 38, 25, 25);
borderstyle := bsraisedpanel;
end;

fresultedit := (self);
:= self;
nds(5, 5, 240, 25);
ent := tarightjustify;
:= -13;
:= ''arial'';
:= ''0'';
end;

procedure (sender: tobject);
const
memorystoremap: array [boolean] of string = ('' m'','''');
var
buttontype: tbuttontype;
temp: string;
tempvalue: single;
begin
buttontype := tbuttontype(tbutton(sender).tag);

try
case buttontype of
bt0..bt9:
begin
fbackspacevalid := true;
if ( = ''0'') or (fcurrentvalue = 0) then := '''';
:=
+ btns[buttontype].caption;
fcurrentvalue := strtofloat();
frepeatvalue := 0;
end;

btdecimal:
if pos(''.'', ) < 1 then
begin
fcurrentvalue := strtofloat();
flastvalue := 0;
:=
+ btns[buttontype].caption;
end;

btplusminus:
begin
fcurrentvalue := strtofloat();
fcurrentvalue := fcurrentvalue * -1;
:= floattostr(fcurrentvalue);
end;

btclearall:
begin
fcurrentvalue := 0;
flastvalue := 0;
:= ''0'';
fstate := csnone;
end;

btclear:
begin
fcurrentvalue := 0;
:= ''0'';
end;

btadd:
begin
fcurrentvalue := strtofloat();
fstate := csadd;
flastvalue := fcurrentvalue;
fcurrentvalue := 0;
end;

btsubtract:
begin
fcurrentvalue := strtofloat();
fstate := cssubtract;
flastvalue := fcurrentvalue;
fcurrentvalue := 0;
end;

btdivide:
begin
fcurrentvalue := strtofloat();
fstate := csdivide;
flastvalue := fcurrentvalue;
fcurrentvalue := 0;
end;

btmultiply:
begin
fcurrentvalue := strtofloat();
fstate := csmultiply;
flastvalue := fcurrentvalue;
fcurrentvalue := 0;
end;

btbackspace:
if fbackspacevalid then
begin
temp := ;
delete(temp, length(temp),1);
if temp = '''' then temp := ''0'';
fcurrentvalue := strtofloat(temp);
:= floattostr(fcurrentvalue);
end;

btinverse:
begin
fcurrentvalue := strtofloat();
fcurrentvalue := 1 / fcurrentvalue;
:= floattostr(fcurrentvalue);
end;

btpercent:
begin
fcurrentvalue := strtofloat();
fcurrentvalue := fcurrentvalue / 100;
:= floattostr(fcurrentvalue);
end;

btsqrt:
begin
fcurrentvalue := strtofloat();
fcurrentvalue := sqrt(fcurrentvalue);
:= floattostr(fcurrentvalue);
end;

btmemorystore:
begin
fmemoryvalue := strtofloat();
fmemoryvalue := fmemoryvalue * 1;
fcurrentvalue := 0;
end;

btmemoryadd:
begin
tempvalue := fmemoryvalue;
fmemoryvalue := strtofloat();
fmemoryvalue := (fmemoryvalue * 1) + tempvalue;
end;

btmemoryrecall:
begin
:= floattostr(fmemoryvalue);
fcurrentvalue := 0;
end;

btmemoryclear:
begin
fmemoryvalue := 0;
end;

btequals:
if fstate <> csnone then
begin
fbackspacevalid := false;
fcurrentvalue := strtofloat();
if frepeatvalue = 0 then
begin
frepeatvalue := fcurrentvalue;
fcurrentvalue := flastvalue;
end;
flastvalue := frepeatvalue;
case fstate of
csadd:
fcurrentvalue := fcurrentvalue + flastvalue;
csmultiply:
fcurrentvalue := fcurrentvalue * flastvalue;
cssubtract:
fcurrentvalue := fcurrentvalue - flastvalue;
csdivide:
fcurrentvalue := fcurrentvalue / flastvalue;
end;
flastvalue := fcurrentvalue;
:= floattostr(fcurrentvalue);
fcurrentvalue := 0;
end;
end; // case buttontype of...

except
on e: exception do
begin
:= e;
flastvalue := 0;
fcurrentvalue := 0;
frepeatvalue := 0;
fstate := csnone;
end;
end;
n := memorystoremap[fmemoryvalue = 0];
end;

function t: string;
begin
result := ;
end;

procedure t(const value: string);
begin
:= value;
end;

end.