Git情報がなくてもビルドできるようにする (Close #148)

[kobake]

#148

@yoshinrt

git コマンドが利用できない条件でビルドすると .rc でエラーになるようです．

これの修正です。

ビルド結果例

[m-tmatma]

Win32/x64 Release, Debug でビルドを確認しました。
起動確認は x64 Release のみです。

---- Make githash.h ----
NOTE: No .git directory
SHORT_COMMITID:
COMMITID:
GIT_URL:
APPVEYOR_URL          :
APPVEYOR_REPO_NAME    :
APPVEYOR_ACCOUNT_NAME :
APPVEYOR_PROJECT_SLUG :
APPVEYOR_BUILD_VERSION:
APPVEYOR_BUILD_NUMBER :

[m-tmatma]

appveyor 終わったらマージしてください。

[m-tmatma]

おっと appveyor がコケている。

[kobake]

..\sakura_core\sakura_rc.rc(2821): error RC2104: undefined keyword or key name: RESOURCE_VERSION_STRING 

うーん、ちょっと謎ですね。調べます。

それとは別件の問題として、VER_GITHASH 定数名が CDlgAbout.cpp のものと被ってたのでそこも対応します。

[kobake]

推測ですが、
.rc のエンコーディングが SJIS なので、
#include "version.h" をしたときに

version.h の以下のコメント部の日本語文字列の影響でその次の行まで含めてコメント行と認識された可能性があります。

// e.g. "2.3.2.0 UNICODE 64bit"                  … Git 情報無い場合の例
#define RESOURCE_VERSION_STRING(_VersionString) _VersionString VER_GIT_SHORTHASH " " VER_CHARSET " " VER_PLATFORM SPACE_WHEN_DEBUG VER_CONFIG ALPHA_VERSION_STR_WITH_SPACE

現在できる一番簡単な対策としてはコメント行の後ろに ANSI 文字挿入する等があります。次コミットでその対応積みます。

[kobake]

コミット追加により approve 状態消えたので、お手数ですが再レビューお願いします。
AppVeyor ビルドは見た感じちゃんと進むようになったみたいです。

[m-tmatma]

先程のコミットに対して、なぜ必要なのかの説明を
コメントとして、書いた方がいいと思います。

そうすれば、次回同じエラーが発生するのを防げるし、
発生してもすぐにわかります。

[kobake]

だいたい現象としては以下のような感じでした。

以下のファイルがあるとして。

• a.h … こちらのエンコーディングはUTF-8。
• b.rc … こちらはSJIS。a.h をインクルードしている。

a.h 内で以下のような記述があると、

// これはコメント例
#define HOGEHOGE "aaa"

例\r\n もしくは 例\n が文字コードの組み合わせにより正しく改行があるとみなされず、以下のようなヘッダ記述であるように誤認識される。

// これはコメント例 #define HOGEHOGE "aaa"

結果、定数 HOGEHOGE は b.rc から認識できない。

対策としては、コメント行の末尾には極力 ANSI 文字を埋め込むようにする。
今回は // を埋め込んだ。

[m-tmatma]

↑ ソースコードにです。

[kobake]

うーん、これピンポイントでソースコードにコメント書いても大事な注記としては気づかれにくい気が。
書くとしたら Wiki かなと思ってますがどうですか。

[m-tmatma]

そうですね。ここ以外の箇所で発生したら意味ないですね。

[kobake]

以下WikiページにTipsを書き残しました。
https://github.com/sakura-editor/sakura/wiki/50.CodingTips