matlab - 从 C 访问 MATLAB 的 unicode 字符串

Question

如何通过 MATLAB 引擎或 MEX C 接口(interface)访问 MATLAB 字符串的底层 unicode 数据？

这是一个例子。我们把unicode字符放在一个UTF-8编码的文件test.txt中，然后读取为

fid=fopen('test.txt','r','l','UTF-8');
s=fscanf(fid, '%s')

在 MATLAB 中。

现在，如果我首先执行 feature('DefaultCharacterSet', 'UTF-8')，然后从 C engEvalString(ep, "s")，然后作为输出我从文件中取回 UTF-8 格式的文本。这证明 MATLAB 在内部将其存储为 unicode。但是，如果我执行 mxArrayToString(engGetVariable(ep, "s"))，我会得到 unicode2native(s, 'Latin-1') 在 MATLAB 中给我的结果:所有非拉丁 1 字符替换为字符代码 26。我需要的是以任何 unicode 格式(UTF-8、UTF-16 等)访问底层 unicode 数据作为 C 字符串，并保留非拉丁字符-1 个字符。 这可能吗？

我的平台是 OS X，MATLAB R2012b。

附录:documentation明确指出“[mxArrayToString()] 支持多字节编码字符”，但它仍然只给我原始数据的 Latin-1 近似值。

Answer 1

首先，让我分享一些我在网上找到的引用资料:

• 根据 mxChar描述，

  MATLAB stores characters as 2-byte Unicode characters on machines with multi-byte character sets

  MBCS 一词仍然有点 ambiguous对我来说，我认为他们在这种情况下是指 UTF-16(尽管我不确定 surrogate pairs ，这可能是 UCS-2)。

  更新: MathWorks 将措辞更改为:

  MATLAB uses 16-bit unsigned integer character encoding for Unicode characters.

• mxArrayToString页面声明它确实处理多字节编码字符(unlinke mxGetString 仅处理单字节编码方案)。不幸的是，没有关于如何执行此操作的示例。

• 最后，这是一个thread在 MATLAB 新闻组上提到了几个与此相关的未记录的函数(您可以通过将 libmx.dll 库加载到像 Dependency Walker 这样的工具中自己找到它们Windows)。

---

这是我在 MEX 中做的一个小实验:

my_func.c

#include "mex.h"

void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
    char str_ascii[] = {0x41, 0x6D, 0x72, 0x6F, 0x00};   // {'A','m','r','o',0}
    char str_utf8[] = {
        0x41,                   // U+0041
        0xC3, 0x80,             // U+00C0
        0xE6, 0xB0, 0xB4,       // U+6C34
        0x00
    };
    char str_utf16_le[] = {
        0x41, 0x00,             // U+0041
        0xC0, 0x00,             // U+00C0
        0x34, 0x6C,             // U+6C34
        0x00, 0x00
    };

    plhs[0] = mxCreateString(str_ascii);
    plhs[1] = mxCreateString_UTF8(str_utf8);        // undocumented!
    plhs[2] = mxCreateString_UTF16(str_utf16_le);   // undocumented!
}

我在 C 代码中创建了三个字符串，分别用 ASCII、UTF-8 和 UTF-16LE 编码。然后，我使用 mxCreateString MEX 函数(以及它的其他未记录版本)将它们传递给 MATLAB。

我通过查阅 Fileformat.info 网站得到了字节序列: A (U+0041) , À (U+00C0) , 和 水 (U+6C34) .

让我们在 MATLAB 中测试上面的函数:

%# call the MEX function
[str_ascii, str_utf8, str_utf16_le] = my_func()

%# MATLAB exposes the two strings in a decoded form (Unicode code points)
double(str_utf8)       %# decimal form: [65, 192, 27700]
assert(isequal(str_utf8, str_utf16_le))

%# convert them to bytes (in HEX)
b1 = unicode2native(str_utf8, 'UTF-8')
b2 = unicode2native(str_utf16_le, 'UTF-16')
cellstr(dec2hex(b1))'  %# {'41','C3','80','E6','B0','B4'}
cellstr(dec2hex(b2))'  %# {'FF','FE','41','00','C0','00','34','6C'}
                       %# (note that first two bytes are BOM markers)

%# show string
view_unicode_string(str_utf8)

我正在使用 embedded Java capability查看字符串:

function view_unicode_string(str)
    %# create Swing JLabel
    jlabel = javaObjectEDT('javax.swing.JLabel', str);
    font = java.awt.Font('Arial Unicode MS', java.awt.Font.PLAIN, 72);
    jlabel.setFont(font);
    jlabel.setHorizontalAlignment(javax.swing.SwingConstants.CENTER);

    %# place Java component inside a MATLAB figure
    hfig = figure('Menubar','none');
    [~,jlabelHG] = javacomponent(jlabel, [], hfig);
    set(jlabelHG, 'Units','normalized', 'Position',[0 0 1 1])
end

---

现在让我们从相反的方向开始工作(接受来自 MATLAB 的字符串到 C 中):

my_func_reverse.c

#include "mex.h"

void print_hex(const unsigned char* s, size_t len)
{
    size_t i;
    for(i=0; i<len; ++i) {
        mexPrintf("0x%02X ", s[i] & 0xFF);
    }
    mexPrintf("0x00\n");
}

void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])
{
    char *str;
    if (nrhs<1 || !mxIsChar(prhs[0])) {
        mexErrMsgIdAndTxt("mex:error", "Expecting a string");
    }
    str = mxArrayToString_UTF8(prhs[0]); // get UTF-8 encoded string from Unicode
    print_hex(str, strlen(str));         // print bytes
    plhs[0] = mxCreateString_UTF8(str);  // create Unicode string from UTF-8
    mxFree(str);
}

我们从 MATLAB 内部对此进行测试:

>> s = char(hex2dec(['0041';'00C0';'6C34'])');   %# "\u0041\u00C0\u6C34"
>> ss = my_func_reverse(s);
0x41 0xC3 0x80 0xE6 0xB0 0xB4 0x00               %# UTF-8 encoding
>> assert(isequal(s,ss))

---

最后我要说的是，如果出于某种原因您仍然遇到问题，最简单的方法是将非 ASCII 字符串转换为 uint8 数据类型在将其从 MATLAB 传递到您的引擎程序之前。

所以在 MATLAB 过程中做:

%# read contents of a UTF-8 file
fid = fopen('test.txt', 'rb', 'native', 'UTF-8');
str = fread(fid, '*char')';
fclose(fid);
str_bytes = unicode2native(str,'UTF-8');  %# convert to bytes

%# or simply read the file contents as bytes to begin with
%fid = fopen('test.txt', 'rb');
%str_bytes = fread(fid, '*uint8')';
%fclose(fid);

并使用引擎 API 访问变量:

mxArray *arr = engGetVariable(ep, "str_bytes");
uint8_T *bytes = (uint8_T*) mxGetData(arr);
// now you decode this utf-8 string on your end ...

---

所有测试均在运行 R2012b 且默认字符集的 WinXP 上完成:

>> feature('DefaultCharacterSet')
ans =
windows-1252

希望这有帮助..

---

编辑:

在 MATLAB R2014a 中，许多未记录的 C 函数已从 libmx 库(包括上面使用的函数)中删除，并替换为在命名空间 下公开的等效 C++ 函数>matrix::detail::noninlined::mx_array_api.

调整上述示例(如 here 所述)以在最新的 R2014a 版本上运行应该很容易。