/**
 * @fileoverview XML要素の範囲の背景に画像を配置する
 * @author Kenshi Muto <kmuto@debian.org>
 * @requires libBackGroundImage.jsx
*/

/*
    Copyright:
    2008 Kenshi Muto <kmuto@debian.org>
----------------------------------------------------------------------
ソフトウェア使用許諾同意書
本ソフトウェアの利用・変更・再配布にあたっては、下記の使用許諾同意書に
同意する必要があります。

1. 本使用許諾同意書における「ソフトウェア」とは、機械可読の資料 (ライブ
   ラリ、スクリプト、ソースファイル、データファイル)、実行形式、および
   文書を意味します。
2. 本ソフトウェアの使用許諾同意書に同意する限りにおいて、使用者は
   本ソフトウェアを自由に利用、変更することができます。
3. 本ソフトウェアに変更を加えない限りにおいて、使用者は本ソフトウェアを
   自由にコピー、再配布することができます。
4. 本ソフトウェアは無保証です。作者およびそれに関連する組織、配布者は、
   本ソフトウェアの使用に起因する一切の直接損害、間接損害、偶発的損害、
   特別損害、懲戒的損害、派生的損害について何らの責任・保証も負いません。
5. 本ソフトウェアを変更した上で再配布するときには、下記の事項すべてに
   従わなければなりません。
   - 使用許諾同意書の内容に変更を加えてはなりません。技術上の理由で
     文字エンコーディングの変換を行うことは許可しますが、その使用者が
     特殊な技術的措置なしに可読な形でなければなりません。
   - 技術上の理由でバイナリ化・難読化を行う場合も、変更箇所を含めた
     ソフトウェアを、その使用者が可読可能な形式の形で同一のメディアで
     提供しなければなりません。本使用許諾同意書の2条および3条により、
     使用者が可読形式の該当ソフトウェアを変更、コピー、再配布することを
     妨げてはなりません。
   - ソフトウェア構成物の所定の作者名の欄に、変更者のクレジット
     (個人名、企業名、所属、連絡先など)を「追加」しなければなりません。
6. 本ソフトウェアを変更した上で再配布するときには、変更理由および
   その内容を明記することが推奨されます。
7. 使用者がソフトウェアに適用可能な特許に対して特許侵害にかかわる何らか
   の行動を開始した時点で、この使用許諾同意書は自動的に終了し、以降
   使用者はこの使用許諾書によって与えられた一切の権利を放棄するものと
   します。

著作権所有者 Copyright (C) 2008 Kenshi Muto. All rights reserved.
使用許諾同意書バージョン1.0
著作権所有者による書面での事前の許可がない限り、この使用許諾同意書
に変更を加えてはなりません。
----------------------------------------------------------------------
*/
#include "../libs/libBackGroundImage.jsx"

/**
 * XML要素を探してその範囲の背景に指定のファイルを配置する。オブジェクトオフセットおよび画像ファイルオブジェクトはページごとに指定できる。配列がページ数に満たなかった場合、その最後のオブジェクトが使われる。オフセットとファイルは別個に指定できる
 * @param {String} layername レイヤー名。nullの場合には現在のレイヤー
 * @param {XMLItems} items XMLItemsオブジェクト
 * @param {String} tagname XML要素名。noback属性が付いているときには適用しない
 * @param {Long[][4]} offsets 各ページごとのオフセット値
 * @param {File[]} files 各ページごとの画像ファイルオブジェクト
 * @param {ObjectStyle} ostyle オブジェクトスタイルオブジェクト
 * @param {boolean} lfit 左端を版面に合わせるか(true=合わせる、false=合わせずに先頭文字から判定)
 * @param {Float} width ボックスの幅。nullのときには文字から自動算出
 * @param {boolean} fit ページをまたぐときにオフセット前の下の位置を版面に合わせる(true=合わせる、false=合わせない)
 * @type boolean
 * @return 再帰のために関数処理を継続するか(true=継続する、false=継続しない)
*/
function processXMLforBackgroundImage(layername, items, tagname, offsets, files, ostyle, lfit, width, fit) {
  if (items == null || items.length == 0)  {
    return false;
  }
  for (var i = 0; i < items.length; i++) {
    if (items[i].xmlElements != null && items[i].xmlElements.length > 0) {
      for (var i2 = 0; i2 < items[i].xmlElements.length; i2++) {
        var e = items[i].xmlElements[i2];
        if (e.markupTag.name == tagname) {
          if (e.xmlAttributes.itemByRange("noback", "noback") != null) continue; // noback属性が付いているときにはスキップ
          
          var startelement = e;
          var startpoint = startelement.storyOffset;
          var endpoint = getEndStoryPoint(startelement);
          backGroundImage(layername, startelement.parentStory, startpoint, endpoint, offsets, files, ostyle, lfit, width, fit);
        }
      }
    }
    processXMLforBackgroundImage(layername, items[i].xmlItems, tagname, offsets, files, ostyle, lfit, width, fit);
  }
  return true;
}

/**
 * XML要素を探してその範囲の背景に指定のファイルを配置する(終端検索の更新版)。オブジェクトオフセットおよび画像ファイルオブジェクトはページごとに指定できる。配列がページ数に満たなかった場合、その最後のオブジェクトが使われる。オフセットとファイルは別個に指定できる
 * @param {String} layername レイヤー名。nullの場合には現在のレイヤー
 * @param {XMLItems} items XMLItemsオブジェクト
 * @param {String} tagname XML要素名。noback属性が付いているときには適用しない
 * @param {Long[][4]} offsets 各ページごとのオフセット値
 * @param {File[]} files 各ページごとの画像ファイルオブジェクト
 * @param {ObjectStyle} ostyle オブジェクトスタイルオブジェクト
 * @param {boolean} lfit 左端を版面に合わせるか(true=合わせる、false=合わせずに先頭文字から判定)
 * @param {Float} width ボックスの幅。nullのときには文字から自動算出
 * @param {boolean} fit ページをまたぐときにオフセット前の下の位置を版面に合わせる(true=合わせる、false=合わせない)
 * @type boolean
 * @return 再帰のために関数処理を継続するか(true=継続する、false=継続しない)
*/
function processXMLforBackgroundImage2(layername, items, tagname, offsets, files, ostyle, lfit, width, fit) {
  if (items == null || items.length == 0)  {
    return false;
  }
  for (var i = 0; i < items.length; i++) {
    if (items[i].xmlElements != null && items[i].xmlElements.length > 0) {
      for (var i2 = 0; i2 < items[i].xmlElements.length; i2++) {
        var e = items[i].xmlElements[i2];
        if (e.markupTag.name == tagname) {
          if (e.xmlAttributes.itemByRange("noback", "noback") != null) continue; // noback属性が付いているときにはスキップ
          
          var startelement = e;
          var startpoint = startelement.storyOffset;
          var endpoint = getEndStoryPoint2(startelement);
          backGroundImage(layername, startelement.parentStory, startpoint, endpoint, offsets, files, ostyle, lfit, width, fit);
        }
      }
    }
    processXMLforBackgroundImage2(layername, items[i].xmlItems, tagname, offsets, files, ostyle, lfit, width, fit);
  }
  return true;
}