2014年11月8日土曜日

Roltoへの印刷機能をswiftで書く(本編1)

設計方針も決まりましたので、いよいよコードを書いていきます。まずは、RoltoのSDKを使って、プリンターと直接やり取りするクラスから。クラス名は「RoltoController」としました。

// Roltoを制御するクラス(後述するコードが入る)
class RoltoController {

}

この中に、前回決めた機能を順番に追加していきます。

 

最初の機能は、プリンターの検索と登録です。RoltoのSDKには2つのクラスがあり、検索に利用するのはRoltoPrintDiscoverクラスです。そのsearchPrintersWithCallbackメソッドを使うわけですが、コールバック機能も含まれているため、少し作りにくくなっています。

// searchPrintersWithCallbackメソッドの使用例(RoltoControllerクラスに入らない、別のサンプル)
roltoDiscover.searchPrintersWithCallback({(rRoltoPrint) in
        self.aryRoltoPrint.append(rRoltoPrint)
    }, comletion:{() in
        self.doFinalProcF()
    }, duration: rSerchSec)

少し詳しく説明しましょう。メソッドを呼ぶと同時に、二つの実行ブロックを指定します。1つは、Roltoが見付かった度に呼ばれるブロックで、RoltoPrintクラスのインスタンスが、変数を介して渡されます。それを配列の中に追加していくのが、一般的な使い方です。もう1つは、検索が終わったときに呼ばれるブロックで、検索終了時の後処理を担当します。

このような形になっているのは、なぜでしょうか。それは時間がかかる処理だからです。ずっと待ちながらCPUを回すわけにもいきません。何か見付かったときと、終わったときの処理を記述することで、CPUを無駄に使わずに、必要なタイミングで処理が開始できるという仕組みなのです。

これ単体で考えると、良くできた仕組みなのですが、プリンター自体の機能だけをクラスとして作り、外から呼び出す場合には、非常に使いにくいことになります。プリンターのクラスは、利用する処理から呼ばれる側です。その呼ばれる側が、処理の始まるタイミングを握っているわけですから、立場が逆になってます。利用する側が関数を渡すという手も考えられますけど、構造が複雑になりがちで、プログラムとしては美しくないです(私は、単純な構造のプログラムを美しいと考えます。だからデリゲートも嫌いです)。

 

では、どうすれば良いのでしょう。実は、非常に良い方法があります。タイマー起動によって、定期的に問い合わせればいいのです。相手が1つだけのポーリングみたいなものです。1秒ぐらいの間隔で問い合わせれば、問題になるほどの遅延は発生しません。

具体的に紹介しましょう。まずは、次のような文字列定数を用意します。この問い合わせは、プリンターの検索以外でも使うので、プリンターの共通処理という意味を込めて「PRINTER_PROC」としました。それぞれの役割は、コメントにあるとおりです。この文字列のほかに、これを入れる変数も用意します。

// 問い合わせ結果を知らせる文字列定数
let PRINTER_PROC_GO : String = "GO"  // 処理を開始した
let PRINTER_PROC_OK : String = "OK"  // 処理が終了し、結果は成功
let PRINTER_PROC_NG : String = "NG"  // 処理が終了し、結果は失敗
// 呼び出す側でも使うので、クラスの外に出しておく
// (もしプリンターのスーパークラスがあるなら、そちらに入れる)

検索などの処理を開始する前に、変数に「GO」を入れます。それから何秒か経過して、終わったときに呼ばれるブロック(前述の2番目のブロック)では、処理の成否を判定して、成功なら「OK」を、失敗なら「NG」を変数に入れます。

この機能を呼び出す側では、まず最初に検索などのメソッドを普通に呼びます。その後、1秒ごとにタイマーで起動し、用意した変数の値を問い合わせます。「GO」が返ってきたら、また1秒後に問い合わせするようにセットします。「GO」でない場合は、「OK」か「NG」かを判定して処理するとともに、1秒後の問い合わせは行ないません。非常に簡単で、スッキリした処理です。

 

ただし、これだけだと何が起こったのか分かりません。「OK」でも「NG」でも、その中身が知りたいはずです。何が起こったかは、プリンター側(プログラム)が知っています。ただ、知っていたとしても、特別に何かできるわけではありません。起こった内容または原因を、呼び出した側に知らせることだけです。さらに、呼び出した側(プログラム)も、何かできるわけではありません。何かできるのは、アプリを操作している人間だけです。ですから、人間にわかる言葉で、処理結果やエラー原因を表示するしかないのです。

表示するのは、プリンターのクラスを呼び出した側ですから、プリンターのクラスは、処理結果やエラー原因を人間の言葉で(つまり文字列で)返すのが、現実的にできることとなります。

文字列を返すのも、処理結果を知らせる方法と同じにします。プリンター側のクラスでは、処理結果を示す変数をセットするのに続いて、人間に伝えるためのメッセージも、別に用意した変数に入れます。その文字列を、呼び出した側で受け取れば良いのです。呼び出す側のルールとしては、「OK」または「NG」が返ったら、決まった文字列を受け取るように問い合わせるだけです。「OK」または「NG」のどちらかしか返らないわけですから、メッセージを入れる変数は1だけ用意し、どちらの場合でも使う方法で構いません。

 

ここまでで、細かな部分まで仕様が固まりました。さっそくswiftのコードを作ります。まずは、処理結果とメッセージを入れる変数です。

// クラス内の変数
var strProcStatus : String = "" // 関数を呼び出す側に、処理の進行状態を伝える
var strMsgResult : String = ""  // 処理結果を示すメッセージ

続いて、プリンターを検索するメソッドのコードです。クラス内の最初のコードも含めました。

// Rolto SDKでの主要なクラス
var roltoP : RoltoPrint!
var roltoDiscover : RoltoPrintDiscover!
init() {    // クラスの初期化
    roltoP = nil
    roltoDiscover = RoltoPrintDiscover()
    strMsgResult = ""
}
// 見付かったRoltoPrintを入れる配列
var aryRoltoPrint : [RoltoPrint] = []
// プリンターの検出メソッド(検出秒数を指定して、使う側から呼ばれる)
func catchPrinterF(rSerchSec:NSInteger) {
    strProcStatus = PRINTER_PROC_GO    // 処理開始に設定
    roltoDiscover.searchPrintersWithCallback({(rRoltoPrint) in
            self.aryRoltoPrint.append(rRoltoPrint)
        }, comletion:{() in
            self.setResultMsgF()
        }, duration: rSerchSec)
    return
}
// 検索結果の判定関数(検索が終了したときに呼ばれる)
func setResultMsgF() {
    if (aryRoltoPrint.count == 0) {
        strMsgResult = "Roltoの接続に失敗しました。"
        strProcStatus = PRINTER_PROC_NG // 処理失敗に設定
        return
    }
    roltoP = aryRoltoPrint[0]
    let strPName : String = roltoP.printerName
    strMsgResult = "Rolto「\(strPName)」に接続しました。"
    strProcStatus = PRINTER_PROC_OK    // 処理成功に設定
}

終了処理のブロックは1つの関数にまとめ、外に出しています。コールバックを含むメソッドの部分は、どうしても見づらくなりがちです。それを防ぐ意味でも、全部を外に出して記述するように心掛けています。単純に見えるソースコードが好きなのです。

残りは、処理結果のメッセージを返す関数です。

// 処理結果を返すメソッド(使う側から呼ばれる)
func getMsgResultF(intFormat:Int) -> String {
    switch intFormat {
    case 0: return strMsgResult
    case 1: return "Rolto:" + strMsgResult
    default: return strMsgResult
    }
}

普通なら文字列を返すだけなのですが、見てのとおり、ちょっと小細工してあります。一応、フォーマット番号という意味の引数を付けました。通常は「0」で呼び出し、メッセージだけを返します。「1」を指定すれば、先頭にプリンター名が付いたメッセージを返します。今のところ「0」しか使っていません。

わざわざ番号を入れといたのは、将来の拡張を考えてのことです。メッセージの返し方を複数使い分ける状況が生じたとき、呼び出し側を変更せず、この関数だけ変更して済ませるためです。手間がかからないから配慮しておきました、という感じでしょうか。複数のプリンターで使う共通のインターフェースだから、拡張したときの手間減らしを強めに配慮した、という面もあります。

プリンターを検出した部分のコードを見て分かるように、最初に見付かったRoltoPrintを入れています。1つしか見付からなかった場合は、このままで構わないのですが、複数ある場合は選択してもらう必要があります。そのためのメソッドを2つ追加しました。

// Roltoの名前一覧を返す
func getPrinterListF() -> [String] {
    var aryPName : [String] = []
    for iRoltoPrint in aryRoltoPrint {
        aryPName.append(iRoltoPrint.printerName)
    }
    return aryPName
}
// 一覧の中から、特定のRoltoに設定
func selectPrinterF(rNum:Int) {
    if rNum < 0 {    // アプリ内部エラー
        println("ERROR:selectPrinterF:1")
        return
    }
    if rNum < aryRoltoPrint.count {
        roltoP = aryRoltoPrint[rNum]
        return
    }
    // アプリ内部エラー
    println("ERROR:selectPrinterF:2")
 }

この2つのメソッドですが、Roltoを1台しか持っていないので、2台以上ではテストできていません。^_^;

 

続いて、呼び出す側のswiftコードも紹介しましょう。主な機能を関数として用意し、必要な箇所から呼び出せるように作ってあります。

// 呼び出すクラスの変数
var printerCtrl : RoltoController! // プリンターのコントローラー
var intRecallCount : Int = 0       // 繰り返しカウント(回数をセットし、ゼロになるまで繰り返す)
   ...
printerCtrl = RoltoController()    // 適したタイミングでインスタンス生成
   ...
// プリンターを探して、見付かれば登録する関数(使うときは、これを1回だけ呼び出す)
var flagUsePrinter : Bool = false  // プリンター関係の処理中ならtrue
func findPrinterF() {
    if flagUsePrinter { return } // プリンター関係の処理中なら中止
    flagUsePrinter = true
    setMsgPrintF("プリンターを検索中です。")
    let iSec : Int = 5
    printerCtrl.catchPrinterF(iSec)
    intRecallCount = 12
    runIntervalF(1.0, self, "getProcResultF")
}
// 繰り返し呼ばれて、プリンターの処理状況を調べる関数
func getProcResultF() {
    let strProcStatus : String = printerCtrl.checkProcStatusF()
    switch strProcStatus {
    case "OK", "NG" :
        setMsgPrintF(printerCtrl.getMsgResultF(0))
        runIntervalF(5.0, self, "clearMsgPrintF")
        flagUsePrinter = false
    case "GO" :
        if (--intRecallCount < 1) { // 指定回数を済ませら、継続せず終了
            setMsgPrintF("プリンターから応答がないまま、待ち時間が過ぎました。")
            runIntervalF(5.0, self, "clearMsgPrintF")
            flagUsePrinter = false
            return
        }
        // さらに継続
        addMsgPrintF("。")
        runIntervalF(1.0, self, "getProcResultF")
    default :
        setMsgPrintF("アプリ内部エラー:PRT01")
        flagUsePrinter = false
    }
}

このコードを見ると関数だらけという印象ですが、処理内容はおおまかに伝わると思います。開始前には、プリンター関係で何か実行していないかを調べています。trueが返ってきたら何かを実行中なので、何もしないで終了します。

開始後の繰り返し処理の中では、checkProcStatusF関数で「OK」または「NG」なら、getMsgResultF関数でメッセージを得て表示します。そのメッセージは5秒後に消しています。

「GO」が返ったら、カウント数を減らして終了回数に達したかどうか見て、達していれば終了メッセージを表示して、5秒後に消します。終了回数に達していなければ、検索の進行を示す意味でメッセージの最後に「。」を追加して、自分自身を1秒後に呼び出します。メッセージ欄への「。」の追加が、プログレスバーと同じ役割を果たしているわけです。

checkProcStatusF関数で、3種類以外の文字列が返ってきたら、内部エラーであることをメッセージで伝えます。ユニークなエラーコードを付けて、どこから出たエラーなのかを特定できるようにしておきます。

 

上記で使っている関数の説明もしておきましょう。runIntervalF関数は、指定した秒数後に、特定の関数を実行させます。1秒後に自分自身を動かす処理だけではなく、表示したメッセージを5秒後に消す処理にも使っています。

// 指定した秒数だけ待って、特定の処理を開始する(共通ライブラリ内)
func runIntervalF(rSec:NSTimeInterval, rTarget:AnyObject, rNextFunc:String) {
    let iTimer = NSTimer(timeInterval:rSec, target:rTarget, selector:Selector(rNextFunc), userInfo:nil, repeats:false)
    NSRunLoop.currentRunLoop().addTimer(iTimer, forMode: NSRunLoopCommonModes)
}

この関数は、どのアプリでも使うため、どこからでも呼び出せる関数として最初から用意してあります。UI部品の生成関数と同じく共通ライブラリに入れてあり、アプリ開発の最初に追加するのが私の定番です。

メッセージの表示や消去でも、それぞれ関数を用意しています。順番に、メッセージの表示、メッセージの後ろへ追加、メッセージの消去です。このうちメッセージの表示では、時刻の文字列を前に追加します。

// メッセージの表示(3つとも、呼び出す側のクラス内)
func setMsgPrintF(rStrMsg:String) {
    let iStr = zDate.getStrTimeF()
    labelMsgPrint.text = iStr + ", " + rStrMsg
}
// メッセージの後ろに追加
func addMsgPrintF(rStrMsg:String) {
    labelMsgPrint.text! += rStrMsg
}
// メッセージの消去
func clearMsgPrintF() {
    labelMsgPrint.text = " "
}

これらの関数を用意しているのは、メッセージ表示を間接参照として作るためです。呼び出す側を何も触らず、これらの関数を変更するだけで、メッセージの表示先を変えたり、メッセージを加工して表示したりが可能となります。

あと細かいことですが、メッセージの消去では空白文字を入れてあります。初期化のときは空の文字列、クリアーでは空白文字という違いを意識してのことです。画面上は同じに見えてても、内部では小さな違いをあえて作っておき、トラブル時の解析に役立てるという考えからです。空白文字が入っていれば、クリアー処理が1度は実行されたという証拠になりますから。これの発展形としては、空白の数とか、全角と半角の空白文字でも小さな違いを作れます。

 

ここまでの説明でも、かなり長くなってしまいました。いったん区切りたいと思います。続きは、次の投稿にて。

2014年11月6日木曜日

Roltoへの印刷機能をswiftで書く(全体設計編)

どんな機能でも、ある程度の設計方針を決めてから作り始めないと、効率が悪いのはもちろん、仕上がりまで悪くなりがちです。ただの印刷機能ですが、全体の構造を先に考えました。今回は、その辺の話でも。

印刷機能といっても、いろいろな要素が含まれます。プリンターのドライバーと関わる部分、印刷内容を作る部分、ユーザーインターフェースに関わる部分などです。これらをどのように組み合わせるのか、どのように分割するのかを考えるのが、全体設計です。構成要素への分割だけでなく、要素間のインターフェースも含みます。

 

まずは、プリンターに近い部分から。プリンターを用いた印刷のような、特定の機器に依存する機能は、機器へ依存する箇所をできるだけ少なく作ることが大切です。つまり、別なプリンターを追加したり切り替えたときに、印刷機能を利用する側の変更が、少なくて済むように作るということです。具体的には、プリンターとやり取りするインターフェースを、特定のプリンターに依存せず、どのプリンターでも共通の仕様にしておきます。

プリンタを利用するための一般的な機能として、次のように洗い出してみました。

プリンターのクラスで用意する機能
・プリンターの検索と登録
・プリンターの状態確認
・プリンターで印刷
・印刷のキャンセル
・プリンターの解放と登録解除

これらをメソッドとして用意すれば、プリンターを切り替えたときの、プリンターを利用する側の変更が最小限で済みます。メソッド名も、機種に依存しない一般的な用語で作るのは当然のことですね。

クラスの作り方としては、プリンター全体のスーパークラスを先に用意し、そのサブクラスとしてRoltoのクラスを作るのが順当な考え方でしょう。でも、Roltoが1台目ですし、後で大きく違うタイプのプリンターを追加することもあり得ます。スーパークラスは2機種目の追加のときに考えれば良いし、余計な作業はやりたくないので、今はスーパークラスを作らないと決めました。今回は、スーパークラスを後で追加しても大丈夫なようにメソッドを用意し、Roltoのクラスだけを作ります。

Roltoを別なプリンターに切り替える話をしましたが、逆のこともいえます。別なアプリでRoltoを使う場合、Roltoのクラスをそのままコピーすれば、それを呼び出すコードだけ書けば済みます。つまり、再利用しやすいコードになるわけです。

 

続いて、印刷内容を作る部分です。オフスクリーンで描画し、その内容をUIImageとして仕上げます。オフスクリーンの描画に関しては、作成から終了までの機能を、独立したクラスとして以前に作りました。どのアプリにでも使えるようになっています。今回も、それを使います。

印刷内容を作るのに使うデータは、そのデータを扱うモデルのクラスに入っています。オフスクリーン描画クラスを使うと、実際に書くコード量は短くなるでしょう。今回は印刷の種類が1つで、わざわざ別クラスに作る必要もないと考え、モデルのクラスに含めることとしました。今後、印刷の種類が増えたら、別クラスに分けるかもしれません。

 

最後に、ユーザーインターフェース(UI)部分です。プリンターのような機器を使う場合は、UIに2つの要素が含まれます。1つは、印刷するデータを選んだり、印刷の形式を選んだりするもので、プリンターに直接関係しない要素です。残りは、プリンターを検索したり、印刷を開始したりとか、プリンターを操作する要素で、プリンターに直接関係するものです。これらが明確に分けて画面に付けられれば良いのですが、実際には混在して作ることになります。

また、プリントする機能は、対象となる内容を表示した画面に付けるのが一般的で、印刷する内容の種類だけ追加することになります。大抵の操作手順は、関係する画面ごとに印刷ボタンを用意して、タップしたら選択画面に切り替わります。現れた画面では、データの選択や、印刷の開始などが行なえます。

難しいのは印刷の途中キャンセルで、キャンセルを可能にするとUIが使いづらくなりがちです。現れた選択画面を消さないままキャンセル可能にしておき、そこに印刷の成否などを表示し、確認できたらユーザー操作で戻るといった形でしょうか。逆にキャンセルが不要なら、印刷開始で元の画面に戻り、印刷の成否は、戻った画面にメッセージを表示するという形も可能です。余計な操作を不要に作れます。

以上のようなことを総合的に検討するのですが、今回は印刷が1種類で、特定の画面上でしか使わないため、そこに多くの機能をつけることとしました。もちろん依頼主と相談し、要望を重視しての結果です。

具体的には、その画面を開いたときにRoltoを自動的に検出して(検出の手間を不要にする配慮)、画面上には、Roltoの状態を表示するボタン(もし接続してなければ、検出から始める)、印刷ダイアログの呼び出しボタンを加えます。ダイアログ内では、印刷対象のデータを選択する機能と、印刷の開始とキャンセルのボタンも付けます。印刷時間が短そうなので、印刷の途中キャンセル機能は付けません。また、Roltoの画質変更機能は、アプリの環境設定画面に付けることとしました。

以上の機能は、それぞれ対象となるクラスに加えます。こちらも、印刷の種類が増えた時点で、新しいクラスを追加するか検討することとしました。

 

全体の構造が固まったので、あとは1つずつ作っていくだけです。まずは、Roltoのクラスからでしょう。

2014年11月4日火曜日

Roltoへの印刷機能をSwiftで書く(準備編)

以前開発したiPad業務アプリの依頼主から、新しい要望が来ました。運用中の業務アプリから、小型プリンターRolto PT-10への印刷機能を追加してほしいとのことでした。強い要望だったのと、プリンターをプレゼントされたので、結局作りました。その要点を何回かに分けて紹介します。

 

話を聞いたとき、そのプリンターの存在は知りませんでした。同じように知らない人がいると思いますから、まずプリンターを紹介します。キングジムさんが開発した、50mm幅の感熱ロール紙を使う小型プリンターです。他の機器とのインターフェースはWiFiのみで、iPhoneアプリが無料で公開されています。そのアプリを使って、メモや写真や、ウェブブラウザの表示内容などを印刷できます。

感熱ロール紙ですから、印刷できるのはモノクロ2値のドットだけです。そのままだと中間調を印刷できないため、写真の印刷では誤差拡散によるディザ画像となります。

プリンターと同時に、iOS用のSDKも公開されたようで、そのことを知った依頼主が、何とか作れないかと相談に来たわけです。SDKは誰でもダウンロードできるようになっていました(検索で簡単に探せるので、リンクは付けません)。

 

SDKを調べると、次のようなことが判明しました。ドライバーはC++で開発され、Objective-C用にラッピングされていること。サンプルのアプリケーションは、すべてObjective-Cで書かれていました。また、注意点もありました。組み込むためには、C++のコンパイラーを呼び出す形にすること、コンパイラーを「libc++」から「libstdc++」に変更すること。

機能追加の対象となるiPad業務アプリの最終版は、すべてSwiftで書いています。つまり、追加する印刷機能もSwiftで書くことになります。当然、Objective-C用の作られたドライバーを、Swiftから呼び出す形です。少し工夫が必要となる分、誰かの参考になると思い、ここで紹介することにしました。

 

まずは、Objective-C用ドライバーを呼び出すための準備から。検索すると、非常に丁寧に解説しているウェブページを発見しました。Xcode上の設定操作まで含めて、かなり詳しく書かれています。

  Objective-Cコードをswiftから呼び出す方法を解説
   How to call Objective C code from Swift

私は少し遠回りしましたが、このとおり操作すると、問題なく使えるようになります。

 

開発環境のXcodeは6.0.1、RoltoのSDKは最新の1.01です。SDKに付いてきた、ヘッダーファイルの「RoltoPrint.h」とモジュールの「libRolto-PrintSDK.a」も、プロジェクトに読み込みました。SDKに付属の資料を見ながら、swiftのコードも少し書き始めていました。

上記サイトの説明どおりに操作したところ、いきなりのコンパイルエラーです。SDKの資料を見ながら速攻で書いた部分も多数のエラーが出ました。さらに、SDKに付属のヘッダーファイル「RoltoPrint.h」にもエラーが出ています。サイトの説明どおりに操作したつもりが、どこかで間違ったのかと思い、何度も確認しましたが、どうやら間違ってはいないようです。行き詰まってしまいました。

少し休憩して「RoltoPrint.h」を眺めていたら、アレレと気付きました。UI部品を使っているのに、そのimport文が付いてないのです。さっそく「RoltoPrint.h」に「#import <UIKit/UIKit.h>」を追加して、エラーは消えました。まさか提供されている側にエラーの原因があるなんて、予想もしませんでした。そのため気付くのが遅れ、数十分ほど無駄にしました。いやあ、思い込みは怖いですね。ちなみにこのエラーは、「ご意見・お問い合わせ」受付からのメールにて、キングジムさんに報告しました。先ほどですが。ははは(汗)。

今回エラーが出たのは、「RoltoPrint.h」を「Lib」フォルダ以外にもコピーしていたのも原因なのですが、エラーが出るようなヘッダーファイルじゃマズイでしょうという話です。

 

「RoltoPrint.h」のエラーが消えると、「RoltoPrint.h」のクラスが認識され、他のコードのコンパイルエラーも大きく減りました。当たり前ですね。コンパイルエラーが消えたことで、正常に接続されたことが確認できました。ここまでで、ようやく開発準備が整いました。