doc/src/ja_JP/development/qmake-manual.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2015 The Qt Company Ltd.
   4 ** Contact: http://www.qt.io/licensing/
   5 **
   6 ** This file is part of the documentation of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:FDL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and The Qt Company. For licensing terms
  14 ** and conditions see http://www.qt.io/terms-conditions. For further
  15 ** information use the contact form at http://www.qt.io/contact-us.
  16 **
  17 ** GNU Free Documentation License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Free
  19 ** Documentation License version 1.3 as published by the Free Software
  20 ** Foundation and appearing in the file included in the packaging of
  21 ** this file.  Please review the following information to ensure
  22 ** the GNU Free Documentation License version 1.3 requirements
  23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
  24 ** $QT_END_LICENSE$
  25 **
  26 ****************************************************************************/
  27
  28 /*!
  29     \page qmake-tutorial.html
  30     \title qmake チュートリアル
  31
  32     このチュートリアルでは \c qmake の使い方を説明します。
  33     このチュートリアルを読み終わったら \c qmake
  34     のユーザガイドを読むことをお勧めします。
  35
  36     \section1 簡単な例
  37
  38     アプリケーションの基本的な実装は既に完了していて、
  39     次のファイルが作成されていると仮定します。
  40
  41     \list
  42     \o hello.cpp
  43     \o hello.h
  44     \o main.cpp
  45     \endlist
  46
  47     これらのファイルは Qt ディストリビューションの
  48     \c{examples/qmake/tutorial} ディレクトリにあります。
  49     アプリケーションの設定について知っておくべきことは、
  50     それが Qt で書かれているということだけです。
  51     まず、テキストエディタで \c{examples/qmake/tutorial} に
  52     \c hello.pro というファイルを作成します。
  53     最初にすることは、開発プロジェクトに含まれるソースファイルとヘッダファイルを
  54     \c qmake に教える行を追加することです。
  55
  56     ソースファイルをプロジェクトファイルに追加します。
  57     これには \l{qmake Variable Reference#SOURCES}{SOURCES} 変数を使います。
  58     新しい行を作り、\c{SOURCES +=}、続いて hello.cpp を入力します。
  59     つまり、以下のようになります:
  60
  61     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 108
  62
  63     これを以下のようになるまでプロジェクトの各ソースファイルに対して行います:
  64
  65     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 109
  66
  67     make に似たシンタックスを使いたい場合は、
  68     以下のように改行をエスケープしてすべてのファイルを 1 行に書きます:
  69
  70     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 110
  71
  72     ソースファイルの一覧をプロジェクトファイルに追加しました。
  73     次にヘッダファイルを追加します。
  74     ヘッダファイルはソースファイルと全く同じ方法で追加することができます。
  75     ただし変数は \l{qmake Variable Reference#HEADERS}{HEADERS}
  76     を使います。
  77
  78     これを終えると、プロジェクトファイルは以下のようになるでしょう:
  79
  80     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 111
  81
  82     ターゲットの名前は自動的に設定され、
  83     プロジェクトファイルと同じ名前になります。
  84     ただしプラットフォームに合わせたサフィックスがつけられます。
  85     例えば、プロジェクトファイルが \c hello.pro である場合、
  86     ターゲットは Windows では \c hello.exe 、Unix では \c hello になります。
  87     プロジェクトファイルで別の名前を指定することもできます:
  88
  89     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 112
  90
  91     最後に \l{qmake Variable Reference#CONFIG}{CONFIG} 変数を設定します。
  92     このアプリケーションは Qt アプリケーションなので \c CONFIG に
  93     \c qt を追加する必要があります。
  94     \c qmake は リンクの必要があるライブラリを追加し、
  95     \c moc と \c uic の実行コマンドが Makefile に含まれるようにします。
  96
  97     最終的なプロジェクトファイルは以下のようになります:
  98
  99     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 113
 100
 101     \c qmake を使って、このアプリケーションのための Makefile を生成します。
 102     プロジェクトのディレクトリでコマンドラインに次のように入力します:
 103
 104     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 114
 105
 106     そして、使用するコンパイラによって \c make または \c nmake を入力します。
 107
 108     Visual Studio ユーザの場合、\c qmake は、以下のように
 109     \c .dsp ファイルまたは \c .vcproj ファイルも作成できます:
 110
 111     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 115
 112
 113     \section1 アプリケーションをデバッグできるようにする
 114
 115     アプリケーションのリリースバージョンはデバッグシンボルなどのデバッグ情報を含みません。
 116     開発中は、関連情報を含むアプリケーションのデバッグバージョンを作成するのが便利です。
 117     これは、プロジェクトファイルの \c CONFIG 変数に \c debug
 118     を追加することで簡単に実現できます。
 119
 120     たとえば:
 121
 122     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 116
 123
 124     直前の例と同様に、Makefile を生成するには \c qmake を使います。
 125     アプリケーションをデバッグ環境で実行する際に役に立つ情報を得られるようになります。
 126
 127     \section1 プラットフォーム固有のソースファイルを追加する
 128
 129     数時間コーディングをしていると、
 130     アプリケーションにプラットフォーム固有な部分が出てきて
 131     プラットフォーム固有のコードを別のファイルに分けたい場合があるかもしれません。
 132     ここでは 2 つのファイル \c hellowin.cpp と \c hellounix.cpp があるとして、
 133     これをプロジェクトファイルに追加します。
 134     これらのファイルをそのまま \c SOURCES 変数に追加することはできません。
 135     なぜなら、両方のファイルが Makefile に追加されてしまうからです。
 136     \c qmake が実行されたプラットフォームにしたがって処理されるスコープを使う必要があります。
 137
 138     Windows 用のファイルを追加するシンプルなスコープは以下のようになります:
 139
 140     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 117
 141
 142     \c qmake が Windows 上で実行されると、ソースファイルのリストに
 143     \c hellowin.cpp が追加されます。
 144     \c qmake が他のプラットフォームで実行された場合、この部分は無視されます。
 145     次に Unix 用ファイルのスコープを作成します。
 146
 147     これを終えると、プロジェクトファイルは以下のようになります:
 148
 149     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 118
 150
 151     これまでと同様に、Makefile を生成するには \c qmake を使います。
 152
 153     \section1 ファイルが存在しない場合に qmake を中止する
 154
 155     特定のファイルが存在しない場合に Makefile を作成したくない場合、
 156     exists() 関数を使ってファイルが存在するかどうかを確認することができます。
 157     また error() 関数を使って \c qmake の処理を中止させることができます。
 158     これらの関数はスコープとして動作します。
 159     使い方はスコープの条件をこれらの関数で置き換えるだけです。
 160     \c main.cpp ファイルの確認は以下のようになります :
 161
 162     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 119
 163
 164     記号 \c{!} はテストを否定します。
 165     つまり \c{exists( main.cpp )} はファイルが存在する場合に真になり、
 166     \c{!exists( main.cpp )} はファイルが存在しない場合に真になります。
 167
 168     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 120
 169
 170     前と同様に、\c qmake を実行して Makefile を生成します。
 171     仮に \c main.cpp の名前を変更すると、上記のメッセージが表示され、
 172     \c qmake は処理を中止します。
 173
 174     \section1 複数の条件をチェックする
 175
 176     Windows を使っていて、
 177     コマンドラインからこのアプリケーションを実行したときに
 178     qDebug() の出力を見ることができるようにしたい場合、
 179     アプリケーションをコンソールの設定を追加してビルドする必要があります。
 180     Windows で Makefile をこの設定にするには、
 181     \c CONFIG に \c console を追加します。
 182     Windows で実行されていて、\e{かつ} \c CONFIG にすでに \c debug
 183     がある場合にのみ \c CONFIG を追加したい場合があるかもしれません。
 184     このような場合、2 つのスコープをネストさせて使います。
 185     まず 1 つのスコープを作成し、その中にもう 1 つスコープを作成します。
 186     そして 2 つのスコープの中に設定を書きます。例えば:
 187
 188     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 121
 189
 190     ネストされたスコープはコロンを使ってつなぐことができます。
 191     最終的なプロジェクトファイルは以下のようになります:
 192
 193     \snippet doc/src/snippets/code/doc_src_qmake-manual.pro 122
 194
 195     以上です。\c qmake のチュートリアルが終了しました。
 196     それでは、あなたの開発プロジェクトのプロジェクトファイルを作成してみましょう。
 197 */
 198