Skip to content
Office Oxide

C / FFI-библиотека для Office — быстрый старт

C API office_oxide — стабильный тонкий ABI поверх Rust-ядра. Все высокоуровневые привязки (Go, C#, Node.js native) дёргают эти же точки входа. Если в вашей экосистеме нет готовой обёртки — всегда можно линковать C-библиотеку напрямую.

Каноничная поверхность лежит в include/office_oxide_c/office_oxide.h; этот гайд описывает тот же API.

Установка

Вариант 1 — собрать из исходников Rust

git clone https://github.com/yfedoseev/office_oxide
cd office_oxide
cargo build --release --lib

Шар-библиотека окажется в target/release/:

OS Файл
Linux liboffice_oxide.so
macOS liboffice_oxide.dylib
Windows office_oxide.dll (+ .lib import library)

Заголовок — include/office_oxide_c/office_oxide.h.

Вариант 2 — установить prebuilt

install -Dm644 include/office_oxide_c/office_oxide.h /usr/local/include/office_oxide.h
install -Dm755 target/release/liboffice_oxide.so     /usr/local/lib/liboffice_oxide.so

Прочитать документ

#include <stdio.h>
#include <stdlib.h>
#include "office_oxide.h"

int main(void) {
    int err = 0;
    char *text = office_extract_text("report.docx", &err);
    if (!text) {
        fprintf(stderr, "office_oxide failed: code=%d\n", err);
        return 1;
    }
    printf("%s\n", text);
    office_oxide_free_string(text);
    return 0;
}

Сборка и запуск:

cc quickstart.c -I/usr/local/include -L/usr/local/lib -loffice_oxide -o quickstart
LD_LIBRARY_PATH=/usr/local/lib ./quickstart

Базовый API

Информация о библиотеке

const char *version = office_oxide_version();          // "0.1.0" — не освобождать
const char *fmt     = office_oxide_detect_format("f"); // "docx"/... или NULL

Document (read-only)

int err = 0;
OfficeDocumentHandle *doc = office_document_open("file.xlsx", &err);
if (!doc) { /* обработать err */ }

const char *fmt = office_document_format(doc);         // "xlsx" — не освобождать

char *text = office_document_plain_text(doc, &err);
char *md   = office_document_to_markdown(doc, &err);
char *html = office_document_to_html(doc, &err);
char *ir   = office_document_to_ir_json(doc, &err);

if (office_document_save_as(doc, "file.docx", &err) != 0) { /* обработать err */ }

office_oxide_free_string(text);
office_oxide_free_string(md);
office_oxide_free_string(html);
office_oxide_free_string(ir);

office_document_free(doc);

Открытие из in-memory буфера:

uint8_t *data = ...;
size_t   len  = ...;
OfficeDocumentHandle *doc =
    office_document_open_from_bytes(data, len, "docx", &err);

format должен быть одним из шести строк: "docx" | "xlsx" | "pptx" | "doc" | "xls" | "ppt".

EditableDocument

Редактирование сохраняет дословно все нетронутые OPC-части. Только DOCX, XLSX и PPTX.

int err = 0;
OfficeEditableHandle *ed = office_editable_open("template.docx", &err);
if (!ed) { /* обработать err */ }

int64_t n = office_editable_replace_text(ed, "{{name}}", "Alice", &err);
if (n < 0) { /* обработать err */ }
printf("%lld замен\n", (long long)n);

if (office_editable_save(ed, "out.docx", &err) != 0) { /* обработать err */ }

office_editable_free(ed);

Запись ячеек XLSX:

OfficeEditableHandle *wb = office_editable_open("budget.xlsx", &err);

office_editable_set_cell(wb, 0, "A1", OFFICE_CELL_STRING, "Total", 0.0,  &err);
office_editable_set_cell(wb, 0, "B1", OFFICE_CELL_NUMBER,  NULL,   42.5, &err);
office_editable_set_cell(wb, 0, "C1", OFFICE_CELL_BOOLEAN, NULL,   1.0,  &err);
office_editable_set_cell(wb, 0, "D1", OFFICE_CELL_EMPTY,   NULL,   0.0,  &err);

office_editable_save(wb, "budget.xlsx", &err);
office_editable_free(wb);

Для booleans: value_num ≠ 0 — это true.

Сериализация в heap-буфер:

size_t   out_len = 0;
uint8_t *buf     = office_editable_save_to_bytes(ed, &out_len, &err);
if (!buf) { /* обработать err */ }
/* загрузить или стримить buf[0..out_len] */
office_oxide_free_bytes(buf, out_len);

Одноразовые помощники

char *text = office_extract_text("file.docx", &err);
char *md   = office_to_markdown("file.pptx", &err);
char *html = office_to_html("file.xlsx", &err);
/* каждое освобождать через office_oxide_free_string */

Правила работы с памятью

  • char*, возвращённые office_document_*, office_editable_* и одноразовыми помощниками, освобождать через office_oxide_free_string(ptr).
  • uint8_t* (с out-параметром out_len) освобождать через office_oxide_free_bytes(ptr, len). len должен совпадать со значением, что API записал в out_len.
  • Непрозрачные handles освобождать парным *_free().
  • const char*, возвращённые office_oxide_version, office_oxide_detect_format, office_document_format — статика. Не освобождать.

Ошибки

Каждый возможный сбой принимает int *error_code out-параметр:

int err = 0;
OfficeDocumentHandle *doc = office_document_open("missing.docx", &err);
if (!doc) {
    switch (err) {
        case OFFICE_ERR_IO:    fputs("io ошибка\n", stderr); break;
        case OFFICE_ERR_PARSE: fputs("ошибка парсинга\n", stderr); break;
        /* ... */
    }
}
Макрос Значение Смысл
OFFICE_OK 0 успех
OFFICE_ERR_INVALID_ARG 1 nil-указатель / неизвестная строка формата
OFFICE_ERR_IO 2 ошибка файловой системы
OFFICE_ERR_PARSE 3 повреждённый документ
OFFICE_ERR_EXTRACTION 4 парсинг ОК, но рендер сорвался
OFFICE_ERR_INTERNAL 5 баг — заведите issue
OFFICE_ERR_UNSUPPORTED 6 расширение/фича не поддерживаются

Константы значений ячеек

Макрос Значение
OFFICE_CELL_EMPTY 0
OFFICE_CELL_STRING 1
OFFICE_CELL_NUMBER 2
OFFICE_CELL_BOOLEAN 3

Legacy-форматы

Открывайте через office_document_open — формат определяется по расширению, верифицируется magic-байтами. office_document_save_as прозрачно конвертирует legacy → OOXML:

OfficeDocumentHandle *doc = office_document_open("old.xls", &err);
office_document_save_as(doc, "modern.xlsx", &err);
office_document_free(doc);

Потокобезопасность

Каждый handle принадлежит вызывающему — не делите один handle между потоками. Разные handles можно использовать параллельно; сама библиотека реентерабельна.

C++

Заголовок обёрнут extern "C"-гвардами, поэтому подключается прямо в C++:

#include "office_oxide.h"

Сочетайте с RAII-обёртками (std::unique_ptr<OfficeDocumentHandle, decltype(&office_document_free)>), чтобы очистка была exception-safe.

Диагностика

Симптом Что делать
Линкер: undefined reference to office_document_open Добавьте -loffice_oxide и соответствующий -L; проверьте, что библиотека собрана --release --lib.
Рантайм: error while loading shared libraries: liboffice_oxide.so Добавьте каталог библиотеки в LD_LIBRARY_PATH (Linux), DYLD_LIBRARY_PATH (macOS) или положите рядом с exe (Windows).
OFFICE_ERR_INVALID_ARG для open_from_bytes format строго одно из `“docx”
Двойное освобождение или порча кучи Каждый char* — через office_oxide_free_string, каждый байтовый буфер — через office_oxide_free_bytes(ptr, len) с исходным out_len.
office_editable_replace_text возвращает 0 на XLSX Это нормально — для редактирования таблиц используйте office_editable_set_cell.

Смотрите также