三題噺：馬・カメラ・Python

LibreOfficeでマクロを実行するときに便利なマクロ実行ボタンを配置することにする。

LibreOfficeのCalcの表計算のシート上にマクロ実行ボタンを付けることにする。

ボタンはフォーム機能が持つ部品の一つである。Calcの画面でプルダウンメニュー「表示」-> 「ツールバー」-> 「フォームコントロール」を選択し、フォーム作成のためのツール一覧を出しておく。

まず一覧窓の上部にあるフォーム機能の切り替えをデザイン・モードする。様々な部品が使えるようになる。その中の「ボタン」選択し、シートの適当な場所にドラックして配置する。

設置したボタンアイコンを右クリックしてメニューから「コントロールのプロパティー」を選択する。「全般」ではボタンの表面にあるタイトルを変えたり（例えば「マクロの実行」）、ボタンの背景色を変えたりできる。「イベント」ではこのボタンで起こり得るイベントとそのイベント処理プログラム（イベント・ハンドラ）を繋げることをする。今の場合は「ボタンが押されたとき」に問題のマクロが実行されるように繋ぐ（マクロに実行関数は引数なしでよいが、イベントハンドラーでは不定個数の引数を取れるようにする。つまりmacro()  -> macro(*arg)）。

これで準備ができた。デザイン・モードをオフにしてボタンを押してみる。マクロが実行されることを確認する。

【重要】このまま表を保存すると再度この表を開いたときにはフォームはデザインモードになっている。これは開発中であればよいがこのフォームをユーザが使うときは都合が悪い。表を開いたときにフォームのデザインモードがオフではじめたい。そのためにはこの表を保存するまえに

プルダウンメニュ「ツール」-> 「フォーム」-> 「フォームナビゲーター」選択。そのナビゲーター画面で「フォーム」を右クリックしデザインモードを解除した後に保存する。

LibreOfficeのマクロをpythonで作ってみた。

標題のように「誕生日から今日まで日数を知る」ためのマクロである。表の誕生日データ（年、月、日）を使い目的の日数を表に記入する。

【例】1950/12/05生まれの人は今日（2021/04/29）までで25713日経過している。

暦計算ではユリウス日（Julian Day)が使われる。これは紀元前4713年1月1日からの連続した通し番号の日数である。この連続した日付けを使うと誕生日から今日までに経過した日数を知ることができる。Pythonではdatetimeモジュールでこれらの機能を提供している。これをマクロで使う。

プログラムの全体は以下のようになる：

#coding: utf-8
import uno
import screen_io as ui
import time
from datetime import date

class Birthday:
    def __init__(self, mydate):
        self.year= mydate[0]
        self.month=mydate[1]
        self.day= mydate[2]
    def get_date(self):
        return date(self.year, self.month, self.day)
    def get_days(self):
        today = date.today()
        my_birthday=date(self.year, self.month, self.day)
        time_to_birthday=abs(today-my_birthday)
        return time_to_birthday.days
    def get_years_days(self):
        my_birthday=date(self.year, self.month, self.day)
        today = date.today()
        today_year=today.year
        my_last_birthday=date(today.year-1,self.month, self.day)
        lastday=date(today_year-1,12,31)
        my_birthday_thisyear=date(today.year, self.month, self.day)
        daydiff_today=abs(today-lastday)
        daydiff_birthday=abs(my_birthday_thisyear-lastday)
        if daydiff_today > daydiff_birthday:
            yearspan=today.year - my_birthday.year
            dayspan=abs(today-my_birthday_thisyear)
        else:
            yearspan=today.year - my_birthday.year-1
            dayspan=abs(today - my_last_birthday)
        return (yearspan, dayspan.days)
        

def elapsed_days_macro():
    doc = XSCRIPTCONTEXT.getDocument()
    sheet = doc.Sheets[0]
    today=date.today()
    msg = "今日は"+str(today)+"です。"
    ui.Print( msg)
    #データのある行数を調べる
    sRange = sheet.getCellRangeByName("A1")
    sCursor=sheet.createCursorByRange(sRange)
    sCursor.collapseToCurrentRegion()
    MaxDataRow = sCursor.Rows.Count-1
    for  i in range(MaxDataRow):
        year = int(sheet.getCellByPosition(0, i+1 ).Value)
        month =int(sheet.getCellByPosition(1, i+1 ).Value)
        day =  int(sheet.getCellByPosition(2, i+1 ).Value)
        mydate=(year, month, day)
        my_birthday=Birthday(mydate)
        sheet.getCellByPosition(3,i+1).Value=my_birthday.get_days()
        sheet.getCellByPosition(4,i+1).Value=my_birthday.get_years_days()[0]
        sheet.getCellByPosition(5,i+1).Value=my_birthday.get_years_days()[1]
    return

LIbreOfficeのPythonマクロで使える関数・定数などの情報は「マクロの森」が詳しい。また、ASOPのデバッガやコンソールはプログラミングに結構役に立つことが分った、

LibreOfficeのマクロをPythonで作るときに使えるユーティリティーにASOPというLibreOffice用の拡張機能がある。

ASOPの詳しい説明はここにある。

【準備】

早速最新版のapso.oxtファイルをダウンロードする。

LibreOfficeへの登録は

• libreOfficeのアプリケーションの一つを開く。プルダウンメニューの「ツール」->「拡張機能マネジャー」
• 登録済みの機能が表示される。
• 追加ボタンを押してダウンロードしたaop.oxtファイルを指名する。
• 登録が終わるとASOPが登録済みとなる。この窓の左下のあるオプションボタンを選択して、コードを記述するためのエディターを登録する（terapadを登録してみた）。

【実行】

早速ASOPを使ってみる。

Calcの「ツール」->「マクロ」->「Pythonスクリプトの管理」を選択する。ASOPの管理窓がでるので実行したいマクロを選択する。管理窓の「メニュー」から「デバッグ」を選ぶと以下のようなデバッガの画面がでる：

この画面で「端末」ボタンを押すとPythonコンソールの別画面が出る。「次へ」のボタンでプログラムの一行毎の実行と変数の値等が表示される。apso.oxtのインストールと同様にMRI.oxtをインストールしておくとこのデバッガの画面で変数の名前空間の性質も調べられる。「編集」ボタンで登録したエディタでマクロの編集ができる。「再スタート」ボタンを押すと編集の結果が反映される。「終了」ボタンを押すとデバッガは終了する（このデバッガはかなり有効に使える感じである）。またマクロにprint文があるとASOP管理下ではコンソールその出力がでる（これはprint文の多用したデバッグには便利）。

久ぶりのPythonの話題である。

LibreOfficeはそのマクロをPythonで書くことができるが、pythonが元々機能として持っていたprint文などがそのままでは使えない。このままではユーザインタフェースやデバッグ機能に欠けた状況でPythonマクロはあまり魅力的ではない。

調べてみるとprint文などに対応するユーザフェース機能をマクロが使うモジュールとして用意することできることがわかった。少し面白くなった。まずマクロのサンプルを示す：

import uno
import screen_io as ui


def my_first_macro_calc():
    doc = XSCRIPTCONTEXT.getDocument()
    for num, column in enumerate(['A1', 'A2', 'A3']):
        cell = doc.Sheets[0][column]
        cell.Value = num 
        ui.Print('OK?')
    return

このマクロの保存場所は(windowsの場合）

C:\Users\～～\AppData\Roaming\LibreOffice\4\user\python

である。

これはLibreOfficeの表計算ソフトCalcのシート番号0のシートの’A1’欄に数値0、’A2’欄に数値1、’A3’欄の数値2を入れる簡単なマクロである。

ui.Print(‘OK’)は数値を書き込む毎に警告窓を出す。ここではデバッグ機能として使っている。この関数Printはscreen_ioモジュールで定義されていて、import screen_io as uiとしてインポートされてされている。import unoがシステムモジュールのインポートであるのに対してimport screen_ioはユーザモジュールのインポートである。このモジュールのの実体はここにある。このモジュールの保存場所は

C:\Users\～～\AppData\Roaming\LibreOffice\4\user\python\pythonpath

である。

このモジュールはbasic言語で作ったモジュールのラッパーらしい。このbasic言語のモジュールの実体もここにある。このモジュールも保存する。保存する場所はLibreOfficeのプルダウン・メニュのマクロで

マイマクロ->standard->module1と進み、編集ボタンで編集画面になるので実体をペーストし、保存する（モジュール名をuiScriptsとすることを忘れないで）。

以上でPrint関数を含むマクロを実行できる環境ができあがった。

最後にPrint関数の実行結果の画面を示す：

【蛇足】pythonでマクロを書くときの注意：

• indentはTabキーではダメで半角スペースを使う。
• Pythonでよく使うprint文は使えない
• 登録しようとしているマクロに構文エラーがあるとマクロの登録すらできない。しかもその構文エラーを知る手掛りがない