ScriptJustify

関数

グリフの送り幅を調整して両端揃えを行う。

DLLUSP10.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USP10.dll
#include <windows.h>

HRESULT ScriptJustify(
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    INT cGlyphs,
    INT iDx,
    INT iMinKashida,
    INT* piJustify
);

パラメーター

名前	型	方向	説明
psva	SCRIPT_VISATTR*	in	cGlyphs で指定される長さの配列へのポインター。配列は SCRIPT_VISATTR 構造体を含みます。各構造体は、処理対象の行内のグリフの視覚属性を保持します。
piAdvance	INT*	in	cGlyphs で指定される長さの advance width 配列へのポインター。直前の ScriptPlace 呼び出しで取得したものです。
cGlyphs	INT	in	psva および piAdvance が指す配列のグリフ数。このパラメーターは、出力パラメーター piJustify のグリフ数も示します。
iDx	INT	in	目的とする変更量(増加または減少)のピクセル単位の幅。
iMinKashida	INT	in	生成するカシダ(kashida)グリフの最小幅。
piJustify	INT*	out	この関数が cGlyphs で指定される長さの配列を取得するバッファーへのポインター。この配列には、両端揃え後の advance width が格納されます。両端揃え後の幅は、揃えていない advance width と区別するために「セル幅(cell widths)」と呼ばれることがあります。

戻り値の型: HRESULT

公式ドキュメント

advance width(送り幅)テーブルを作成し、ScriptTextOut 関数に渡すことでテキストの両端揃え(justification)を可能にします。

戻り値

成功した場合は 0 を返します。成功しなかった場合は 0 以外の HRESULT 値を返します。アプリケーションは SUCCEEDED および FAILED マクロで戻り値をテストできます。

解説(Remarks)

この関数が通常呼び出される文脈については、Displaying Text with Uniscribe を参照してください。

この関数は、多言語両端揃えの簡易的な実装を提供します。行上の各グリフ位置で行う調整量を決定します。ScriptShape の呼び出しで生成された SCRIPT_VISATTR 配列を解釈し、カシダを最優先します。カシダのポイントが利用できない場合は、単語間の間隔(interword spacing)を使用します。単語間のポイントが利用できない場合は、文字間の間隔(intercharacter spacing)を使用します。

Note 高度なテキストフォーマッターは、フォーマッター固有の機能と、ScriptShape が SCRIPT_VISATTR 配列に取得した情報を組み合わせて、独自の delta dx 配列を生成する場合があります。

アプリケーションは、ScriptJustify が生成した両端揃え後の advance width を、piJustify パラメーターで ScriptTextOut に渡す必要があります。

ScriptJustify は、各グリフについて更新された advance width を含む、両端揃え後の配列を作成します。あるグリフの advance width が増加されると、追加された幅はグリフの右側に描画され、空白文字、またはアラビア語テキストの場合はカシダで埋められます。

Note カシダの挿入は、視覚的に両端を揃えるためにグリフの右側で行われます。Microsoft Word と Microsoft PowerPoint はこの考え方を使用しています。カシダの配置アルゴリズムを変更する場合は、特定のスクリプトに対応する ScriptTextOut ハンドラー(例えばアラビア語の TextOut 両端揃えハンドラー)も併せて変更する必要があります。

アプリケーションが両端揃えできないグリフを扱おうとすることがあり、その場合、SCRIPT_VISATTR の uJustification メンバーは SCRIPT_JUSTIFY_NONE に設定されます。この場合、ScriptJustify は piAdvance が指す入力配列を piJustify が指す出力配列へコピーし、アプリケーションに S_FALSE を返します。

Important Windows 8 以降: Windows 7 上で実行できるようにするため、Uniscribe を使用するモジュールは、ライブラリリスト内で gdi32.lib より前に Usp10.lib を指定する必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USP10.dll
#include <windows.h>

HRESULT ScriptJustify(
    const SCRIPT_VISATTR* psva,
    const INT* piAdvance,
    INT cGlyphs,
    INT iDx,
    INT iMinKashida,
    INT* piJustify
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptJustify(
    IntPtr psva,   // SCRIPT_VISATTR*
    ref int piAdvance,   // INT*
    int cGlyphs,   // INT
    int iDx,   // INT
    int iMinKashida,   // INT
    out int piJustify   // INT* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptJustify(
    psva As IntPtr,   ' SCRIPT_VISATTR*
    ByRef piAdvance As Integer,   ' INT*
    cGlyphs As Integer,   ' INT
    iDx As Integer,   ' INT
    iMinKashida As Integer,   ' INT
    <Out> ByRef piJustify As Integer   ' INT* out
) As Integer
End Function

' psva : SCRIPT_VISATTR*
' piAdvance : INT*
' cGlyphs : INT
' iDx : INT
' iMinKashida : INT
' piJustify : INT* out
Declare PtrSafe Function ScriptJustify Lib "usp10" ( _
    ByVal psva As LongPtr, _
    ByRef piAdvance As Long, _
    ByVal cGlyphs As Long, _
    ByVal iDx As Long, _
    ByVal iMinKashida As Long, _
    ByRef piJustify As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptJustify = ctypes.windll.usp10.ScriptJustify
ScriptJustify.restype = ctypes.c_int
ScriptJustify.argtypes = [
    ctypes.c_void_p,  # psva : SCRIPT_VISATTR*
    ctypes.POINTER(ctypes.c_int),  # piAdvance : INT*
    ctypes.c_int,  # cGlyphs : INT
    ctypes.c_int,  # iDx : INT
    ctypes.c_int,  # iMinKashida : INT
    ctypes.POINTER(ctypes.c_int),  # piJustify : INT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptJustify = Fiddle::Function.new(
  lib['ScriptJustify'],
  [
    Fiddle::TYPE_VOIDP,  # psva : SCRIPT_VISATTR*
    Fiddle::TYPE_VOIDP,  # piAdvance : INT*
    Fiddle::TYPE_INT,  # cGlyphs : INT
    Fiddle::TYPE_INT,  # iDx : INT
    Fiddle::TYPE_INT,  # iMinKashida : INT
    Fiddle::TYPE_VOIDP,  # piJustify : INT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptJustify(
        psva: *const SCRIPT_VISATTR,  // SCRIPT_VISATTR*
        piAdvance: *const i32,  // INT*
        cGlyphs: i32,  // INT
        iDx: i32,  // INT
        iMinKashida: i32,  // INT
        piJustify: *mut i32  // INT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptJustify(IntPtr psva, ref int piAdvance, int cGlyphs, int iDx, int iMinKashida, out int piJustify);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptJustify' -Namespace Win32 -PassThru
# $api::ScriptJustify(psva, piAdvance, cGlyphs, iDx, iMinKashida, piJustify)

#uselib "USP10.dll"
#func global ScriptJustify "ScriptJustify" sptr, sptr, sptr, sptr, sptr, sptr
; ScriptJustify varptr(psva), varptr(piAdvance), cGlyphs, iDx, iMinKashida, varptr(piJustify)   ; 戻り値は stat
; psva : SCRIPT_VISATTR* -> "sptr"
; piAdvance : INT* -> "sptr"
; cGlyphs : INT -> "sptr"
; iDx : INT -> "sptr"
; iMinKashida : INT -> "sptr"
; piJustify : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptJustify "ScriptJustify" var, var, int, int, int, var
; res = ScriptJustify(psva, piAdvance, cGlyphs, iDx, iMinKashida, piJustify)
; psva : SCRIPT_VISATTR* -> "var"
; piAdvance : INT* -> "var"
; cGlyphs : INT -> "int"
; iDx : INT -> "int"
; iMinKashida : INT -> "int"
; piJustify : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptJustify "ScriptJustify" sptr, sptr, int, int, int, sptr
; res = ScriptJustify(varptr(psva), varptr(piAdvance), cGlyphs, iDx, iMinKashida, varptr(piJustify))
; psva : SCRIPT_VISATTR* -> "sptr"
; piAdvance : INT* -> "sptr"
; cGlyphs : INT -> "int"
; iDx : INT -> "int"
; iMinKashida : INT -> "int"
; piJustify : INT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。