Code Conversion Guide/ja

This is an old revision of Code Conversion Guide/ja, edited by Saeka-jp at . The current revision is 29155.

/* LazarusとDelphiの主要なユニットの違い */

日本語版メニュー
メインページ - Lazarus Documentation日本語版 - 翻訳ノート - 日本語障害情報

このページでは、すでにDelphiやKylixで書いたコードを Free PascalコンパイラやLazarus IDEで動くようにするための方法を説明します。 LazarusとFree PascalコンパイラはDelphiやKylixと同じ方向性をもっていますが、LazarusやFree Pascalは、それらのクローンではありません。 沢山のライブラリコールや使い方に違いがあります。そして、いくつかの場面において、FPCは拡張されており、また、より正しい文法を要求することがあります。

Lazarus For Delphi Users/ja を見て、機能的な違いを確認してください。

このガイドの目的は、Delphiの既存のコードをLazarusに変換するときに、よく出会う特徴的な違いを、きちんと文書化することです。

この文書はWikiの知識ベースに置かれていますので、だれでも問題に出会ったときに他の人にも知らせることができるよう、拡張できます。

変換時のコンポーネントやライブラリの選択

変換するコードの場所を見つける

ネット上には、変換すればFPCやLazarusで使える、沢山の利用可能なコードがあります。たとえば、このページPage Of Code Sitesがスタートとなるでしょう。他のもっといいコードサイトのURLなどを知っていれば書き加えてください。

TurboPowerソフトウエア社は、最近彼らの商用製品をMPLのライセンスの元でリリースしました。使えるパッケージは、http://sourceforge.net/users/tpsfadmin/ ここ]にあります。 作業が重複するのを避けるため、変換されたパッケージはComponents and Code examplesページにあります。 もし、あなたが変換したパッケージや、変換中のものがあれば、Current conversion projects ページに書き加えてください。

ライセンス

Licenses for existing code range from freeware/public domain to restrictive versions that prohibit modification, re-distribution and commercial use. Before converting any package, it's a good idea to examine its licensing and make sure it's going to be compatible with Lazarus and the Free Pascal Compiler. License selection is especially important with components since dropping one on a form can impose an unwanted or incompatible license on an entire application.

When converting components, please respect the wishes of the original author and retain all copyright and licensing headers along with email addresses and url's. It's courteous and often useful to inform the author that their component is being converted... especially if the component is under a restrictive license. New interest in an old or forgotten component can sometimes inspire authors to revise their original and overly restrictive licensing.

In general, Public Domain (freeware), and the LGPL/MPL are the the most flexible for distributing components. For more information, the Open Source Definition is a good place to start. There are also several comparisons available to help clarify how the various types of licenses work and what impact they'll have on code they're linked to. Search for "open source license comparison"

依存関係

変換をはじめる前のもう一つのステップは、それらのコードが、利用できないか、簡単には変換できそうもない他のパッケージと深い依存関係をもっていないことを確認することです。 いくつかのフリーウエアはいまや使われないような利用できないパッケージや、あるいは適切でないライセンスをもつパッケージと結合しているか、拡張されていることがあります。

コンパイラの問題

下記を見てください:

プラットホームとOSの問題

LazarusとFree Pascal Compilerはクロスプラットホームであり、クロスプラットホームアーキテクチャ開発ツールです。DelphiのほとんどのコードはWin32でのインテルCPUで実行されるように設計されていることと比較してみてください。 もし、あなたのコンポーネントが多くのWin32に特化したコードを使っていれば、すこしでもプラットホームに依存しないようにしてみることをお勧めします。 しかし、多くのWindowsに特化したコードをつかっているからといって、LCLに挑戦することをやめないでください。本当にLCLはすばらしい機能を提供しています。

変換をおこなう

変換するプロジェクトのためのLazarusの環境を設定する

テストプロジェクトを作成する

最初に目を向ける事柄

Lazarus上でのDelphi VCL, Kylix CLXのソース

DelphiやKylixのソースを変換しているとき、特定の機能の関数がなにをやっているか、宣言を探すことは、よく役に立ちます。LazarusのIDEは、DelphiやKylixのソースコードを解析できます。これをするためには、検索パスとコンパイラ設定をきちんとおこなわなくてはなりません。これらは、Environment->CodeTools Defines Editor->Insert Templateで簡単におこなうことができます。

変換に関する問題と解決方法

LazarusでのDelphi / Kylix ファイルとの対応

Delphi / Kylix Lazarus Description

.pas .dfm / .xfm .dcu / .dpu .dpr (main project file) .res .dof / .kof

--- --- ---

.pas, .pp .lfm .o .lpr

--- --- .lrs .lpi (main project file) .ppu

Pascal unit file Form data file Compiled unit file Project file Resource file Project options file Lazarus resource file Lazarus project information file FPC unit description file

Delphi プロジェクト/フォーム/ユニットを Lazarus に変換する

.dprファイルを.lprへcopyするか、名前を変更します。{$R *.res}ディレクティブをコメントアウトするか、削除して、{$mode delphi}{$H+} か {$mode objfpc}{$H+}ディレクティブを.lprファイルへ加えます。

Toolsメニューの中には、変換に便利な"Convert Delphi Project to Lazarus Project"という項目があり、lazarus IDEは変換を手助けします。 この項目を実行すると、.dprファイルを.lprに変換するかどうか聞きます。そして、.lpiファイルを作って、全てのユニットを変換します。多くのすでにあるDelphiフォームは、Lazarusが .dfmを.lfmフォームに変換します。これは、Toolsメニューの"Convert DFM file to LFM"という項目で出来ます。ファイルダイアログが立ち上がり、dfmファイルを選択すると、自動で変換をおこないます。

もしフォームであろうがなかろうが、全ユニットを変換する場合、Lazarusの"Convert Delphi unit to Lazarus unit"では次のようにおこないます。

  1. includeのファイル名とuses部分の大文字小文字を修正します。
  2. .dfm ファイルを .lfm ファイルに変換します。(currently without content check, just format)
  3. 空の.lrs ファイルを作成します。 (中身は後で生成されます。)
  4. {$mode delphi}ディレクティブを追加します。
  5. windowsユニットをLCLIntfに置き換えます。
  6. 必要であれば LResources ユニットを付け加えます。(もし unit.lrs が使われている場合 uses LResources をimplementation 部分に入れます)
  7. variants ユニットは削除します。
  8. {$R *.dfm} ディレクティブは削除します。
  9. initialization 部分に {$i unit.lrs} ディレクティブを加えます。

この方法でほとんどのユニットをDelphiフォーマットをLazarusフォーマットへ迅速に変換できます。この方法は、正当性のチェックや、自動的な文法の変換をするものではありませんが、いろいろなウイザードがそのようなことや変換などををするので、文法上の変換したり、他のユニット名を変換したり、コンポーネントやコントロールの違いで、dfm/pasファイルを手で変更する必要はありません。

正しいコンパイラモードを選択する

Free Pascalコンパイラには5つの異なったパスカルモードがあります。たとえば、TPはTurbo Pascal互換モードですが、これをつかってTurbo Pascalのユニットをコンパイルできます。また、DELPHI互換モードがあり、既存のDELPHIコードの変換を簡単にします。Lazarusにおいては、DELPHIモードよりもOBJFPCモードをお勧めします。このモードはほとんどDELPHIのモードと似ていますが、DELPHIの文法よりもあいまいさがすくなくなっています。 下記に重要な点を示します。

モードはコマンドラインか、もしくは、ソースコードの最初に指定します。もしソースを変更する必要が無いなら、コマンドラインを使うほうが良いですが、他の諸々を指定しなくてはならない場合は、使わないほうが良いでしょう。

ほとんどのDelphiのユニットは下記のようにすることでFree Pascalでコンパイルできます。

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}

ユニット名の直後におきます。

Free Pascalのモードについて、詳しくは、Free Pascal Documentation をご覧下さい。

クロスプラットホームで考慮すべきこと

(訳注:おもにシリアル通信やパラレルの制御などで、特定のIOポートやハードウエアを制御していることがあるが、APIやエスケープファンクションに置換することができるが、そのようなものまでクロスプラットホームにできるようにPascalの標準IFが準備されているわけもないので、ある程度OSには依存してしまうだろう。)

便利なコンパイラ変数

異なったシステムで異なった動きをするコードを書くために、{$IFDEF Name} 指令を使うことができます。

この値はLCLパッケージを使っているときに定義されています。LCLとDelphiの両方で動くコードを書くときに便利です。

これらの値は、LCLが特定のwidgetsetで使われているときに定義されています。 LCLが特定のプラットホームで動くときのコードを書くときに便利です。

この値はFPCコンパイラ定数を使っているときに定義されています。FPCとDelphiの両方で動くコードを書くときに便利です。

FPCによって現在のターゲットOSのために定義されています。Delphi(やKylix)は"Linux", "Win32" and "MSWindows"を定義します。Free Pascalはさらに多くのプラットホームで動作し、一般的に使われることが推奨されています。 たとえば、"Unix"はLinux、FreeBSD,NetBSD、OpenBSDで定義されていて、すでにLazarusが動いています。

Kylixでも動くようにするためには、

{$IfDef Linux}
  {$Define Unix}
{$EndIf}

としてください。

もっと詳しいことは、こちらをみてください。Free Pascal Documentation.

失った識別子を見つける

Delphi VCLと、LCLを比較すると構成の方法に違いがあります。 もし、"not found"というコンパイラエラーが、主要なクラスや識別子で出たときは、多くの場合異なったユニットにあります。

完全なクロスリファレンスは、lazarus/docs/xml か LCLのサブディレクトリをgrepしてください。

たとえば、一般的によく使われるTButtonのDelphiのコードは、Lazarusではbuttons.ppというユニットにあるので、コンパイル時にエラーになります。 次のコマンドは、正しいユニットをLazarusのソースディレクトリから高速に見つけ出します。

 grep -in ' tbutton =' lcl/*

LazarusとDelphiの主要なユニットの違い

このトピックに書き加えてください。

LCLはWindowsに限ったものではないので、DelphiのWin32APIに直接アクセスするためのWindowsユニットは、インターフェースに抽象化されてLCLIntfユニットからアクセスするようになります。 覚えておいて頂きたいことは、Lazarusはwin32をエミュレートするのではないので、多くの関数が欠落していたり、Win32と同等な働きをしない関数があります。これらの関数はDelphiとの互換性だけのためにあり、とにかく移植するだけのためにあります。LCLは多くの型を利用し、LCLTypeやVCLGlobalsを必要とします。LCLProcは、FreeThenNilのようなDelphi5以降で導入された便利ないくつかの関数や、コントロールのばめに余分なアンパーサンドを取り除くDeleteAmpersandsのようなものを含みます。 Interfacesユニットは、適切なwidgetsetを初期化するための.lprファイルをインクルードするために必要です。

TControl Messages for win32 event callbacks of the format WM_CALLBACK and the structs associated with them are often found in the Messages unit in Delphi. In the LCL these types of messages and there structs are usually found in LMessages, usually with name changes of WM to LM, so for instance WM_MOUSEENTER becomes LM_MOUSEENTER, and TWMMouse becomes TLMMouse.

To simplify some things and break complexity of circles between units, a few types have been abstracted into a shared unit called GraphType, which includes things, which in Delphi are located in Graphics or Controls, for instance the bvNone etc of panels. So sometimes you have to include it. Also a unit which, although incompatible with Delphi, adds other useful functionality is GraphMath, which adds a TFloatPoint for precision, misc routines for dealing with beziers, lines, and arcs, as well as some operator overloading for use with TPoints and TRect, such as for instance Point1 := Point2 + Point3, and comparing two rects like if (rect1 = rect2) then ...

For more intelligent naming considerations, the unit for TMaskEdit is called [MaskEdit|] instead of the slightly more nebulous Mask as in many versions of Delphi.

In many version of Delphi TButton is located in StdCtrls, while TSpeedButton and TBitBtn are in Buttons. For consistency and simplicity the LCL puts all button types in Buttons, which can occasionally break code conversion, so it is always a good idea to include.

Delphiのプロパティとメソッドの違い -> FPC/LCL

文法上の違い

Please add to this topic!

Because of the inherent strictness in FPC, some syntax changes are necessary, even though {$Mode Delphi} does allow more laziness like Delphi does. For this reason complying as much with the syntax rules of {$Mode ObjFPC} as possible is highly recommended, even when the codebase is still going to be shared between Delphi and the LCL. Some of these are simply better coding practices, and sometimes because Delphi mode is not entirely accurate, or in a few instances Delphi acceptible code does not function as expected with FPC, even though it might compile. To that end even though not all such are strictly required, the following list of changes should be considered mandatory :

When assigning an event handling entry point, prefix it with an "@"

For instance, you might assign a button callback manually

Delphi FPC

begin

  if not Assigned(MyButton.OnClick) then
    MyButton.OnClick:= SomeFunction; //@ not required
  //more code...
end;

begin

  if not Assigned(MyButton.OnClick) then
    MyButton.OnClick:= @SomeFunction; //@ IS required
  //more code...
end;
When calling a procedure variable use this syntax
theprocname()

In Delphi there is no difference between a function result and a variable, however there is in FPC, so to call a function, even if it has no parameters, you must append parenthesis. For Example -

Delphi FPC

With (SomeObject) do begin

  If Assigned(OnMyCallback) then 
    OnMyCallback; //parenthesis not required 
end; 

With (SomeObject) do begin

  If Assigned(OnMyCallback) then
    OnMyCallback(); //parenthesis  required
end;

When accessing values in a pointer to a record you must dereference first

In Delphi it is not required to de-reference a pointer to a record to access values within it, it can, in fact, be treated just like the record itself, or any other object. In FPC it must be first de-referenced. As an example,

Delphi FPC

Function GetSomeValue(ARecord: PMyRecord)

  : Integer;
begin
  If Assigned(ARecord) then
    Result:= ARecord.SomeValue
  else
    Result:= 0;
end;

Function GetSomeValue(ARecord: PMyRecord)

  : Integer;
begin
  If Assigned(ARecord) then
    Result:= ARecord^.SomeValue
  else
    Result:= 0;
end; 

When accessing chars of an indexed string Property of an object, it must be enclosed in parentheses

With Delphi it is possible to treat a Property exactly like some other const or var, even to accessing for instance individual chars of a string directly, while this is not always possible in FPC, specifically for indexed properties. Instead it must be enclosed in parentheses, to make distinct. While this may not always hold true it is probably a good practice to consider anyway. For example

Delphi FPC

Type TSomeComponent= class(TComponent)

  //More code...
Published
  Property MyString: String index 3
    read GetMyString;
  //More code...
End;
var
  MyChar: char;
begin
  If Length(MyString)> 2 then
    //no parenthesis needed
    MyChar:= MyString[3];
  //More code...
end;

Type TSomeComponent= class(TComponent)

  //More code...
Published
  Property MyString: String index 3
    read GetMyString;
  //More code...
End;
var
  MyChar: char;
begin
  If Length(MyString)> 2 then
    //parenthesis sometimes needed
    MyChar:= (MyString)[3];
  //More code...
end;

You must typecast pointers to actual type when using with var or function of that type

Sometimes in Delphi you will have a null pointer variable representing an object. While it might seem a complex situation, it is oddly quite common especially in large component packs as a method of preventing too many circular includes between objects in different units. In Delphi it is then possible to send this null pointer to a function expecting that object, without bothering to typecast to actual type, in fpc you must typecast.

For example -

Delphi FPC

Unit 1

Type TSomeObject= class(TComponent)
  //More code...
End;
Procedure DoSomething(Value: TSomeObject);
Function GetSomeObject: TSomeObject;

Unit 2

Type TSomeComponent= class(TComponent)
  //More code...
Published
  SomeObject: Pointer;
  //More code...
End;

Application

var
  MyComponent: TSomeComponent;
begin
  MyComponent.SomeObject:= GetSomeObject;
  //More code...
  DoSomething(MyComponent.SomeObject);
end;

Unit 1

Type TSomeObject= class(TComponent)
  //More code...
End;
Procedure DoSomething(Value: TSomeObject);
Function GetSomeObject: TSomeObject;

Unit 2

Type TSomeComponent= class(TComponent)
  //More code...
Published
  SomeObject: Pointer;
  //More code...
End;

Application

var
 MyComponent: TSomeComponent;
begin
  MyComponent.SomeObject:= Pointer(GetSomeObject);
  //More code...
  DoSomething(TSomeObject(MyComponent.SomeObject));
end;

リソース

Delphi resource files are win32 specific and not compatible with Lazarus, so you'll have to recreate and compile them using the lazres. Lazres can be found in the lazarus/tools subdirectory. If you've downloaded the Lazarus sources, you'll need to compile it first.

To add a resource to your application:

Example:

function TForm1.LoadGlyph(const GlyphName: String): TBitMap;

begin
  Result:= TPixmap.Create;
  Result.LoadFromLazarusResource(GlyphName);
end; 
  //More code...
begin
  Speedbutton1.glyph:= LoadGlyph('mypix');
  //More code...
end;
initialization
  {$I unit1.lrs}
  {$I myresource.lrs}
end.

DelphiやKylixプロジェクトをLazarusに変換する他の方法

  1. Add {$mode delphi}{$H+} or {$mode objfpc}{H+} directives
  2. Add 'Interfaces' to uses clause
  3. Comment out or delete {$R *.res} or directive
  1. Add {$mode delphi}{$H+} or {$mode objfpc}{H+} directives
  2. Add 'LResources', and if the form has buttons, add 'Buttons' to uses clause
  3. Comment out or delete {$R *.dfm} or {$R *.xfm} directive
  4. Add 'Initialization' section at the end of each unit file, and add {$I unitname.lrs} directive in it

ヘルプを見つける

If you encounter a problem during conversion that you just can't solve, there are a wide variety of places to get help. For pure Object Pascal and FPC issues, the best place to start is the Free Pascal Documentation by Michaël Van Canneyt and Florian Klämpfl. For more Lazarus oriented problems, the Lazarus Project Documentation in the Lazarus-CCR Knowledgebase Main Page is the next place to look. Finally you can post a question on any of the mailing lists for the Free Pascal Compiler or the FPC forums where a lot of experts are subscribed.

There are some outstanding search and knowledge bases online that can also be a great help for learning new techniques and solving problems. Tamarack Associates operates a fast search engine specifically for the Borland usenet archives. Mer Systems Inc. provides a similar search engine. Another outstanding source of information along with a sitewide search capability is Earl F. Glynn's Computer Lab and Reference Library.

コンポーネントをパッケージしてリリースする

コンポーネントのLazarusパッケージを作る

Creating a package makes installing the code you've converted a much easier process... especially if you're providing more then one component. Mattias Gärtner has written an overview of Lazarus Packages that should be read before beginning this process.

文書

The purpose of this site and the wiki format is to make the generation of professional documentation an easy and quick process. The wiki also makes it possible to see the results of your posting immediately and make any changes you'd like in real time.

Using the Lazarus-CCR wiki to create nice looking documentation is very easy. If you've never used wiki markup before, you can get familiar with it in the Sand Box practice area.

コードリリースページを作る

The Code Release Page contains vital information about your component that a potential downloader will need to know, such as license, intended platform, status (alpha, beta, stable...), where to download it, who wrote it, is support available... etc.

The following procedure will let you create a Code Release Page with your browser:

Submitting the component

If you're a release technician on the project, upload your component to the SourceForge File Release System and add it to the list of release packages. Otherwise send it to one of the project administrators (Tom Lisjac or Vincent Snijders) and we'll add it to the repository.

If you think you need to continue to develop on the component, we can also put it into CVS so you'll continue to have access to it.

Contributors and Changes

This page has been converted from the epikwiki version.