Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
142384b
XGrammar
mhayes853 Apr 24, 2026
6113a31
Basic Grammar Functionallity
mhayes853 Apr 24, 2026
2b38e67
Grammar FFI
mhayes853 Apr 24, 2026
f0d16a9
Bump vendored XGrammar
mhayes853 May 3, 2026
d0afd07
Cleanup
mhayes853 May 3, 2026
5c40a83
Next bitmask regression tests
mhayes853 May 4, 2026
04d483e
Expose more matcher APIs
mhayes853 May 4, 2026
a157f46
EBNF Grammar Method
mhayes853 May 4, 2026
59387c4
Expose fork on matcher
mhayes853 May 4, 2026
6332121
Updates
mhayes853 May 4, 2026
7938e57
Extract grammar compilation logic to reusable GrammarEngine
mhayes853 May 4, 2026
0c4e2d1
Make GrammarVocabulary a TokenizerInfo wrapper
mhayes853 May 4, 2026
d72b9c4
FFI Updates
mhayes853 May 4, 2026
38f0b3b
Add optional comment
mhayes853 May 4, 2026
219d18c
Ensure XGrammar path is linked on Linux
mhayes853 May 5, 2026
99a81ab
Update Python CLI to include xgrammar path
mhayes853 May 5, 2026
ec0beff
Fix linux rust CI
mhayes853 May 5, 2026
5e579b2
Update macOS XGrammar build
mhayes853 May 5, 2026
b98a85a
Export compiler commands
mhayes853 May 5, 2026
f6ec246
Cleanup
mhayes853 May 8, 2026
55f299b
Epsilon Grammar
mhayes853 May 8, 2026
f3c97f4
Optional Grammar
mhayes853 May 8, 2026
59698ad
Repeat Grammar
mhayes853 May 8, 2026
32e8828
Star
mhayes853 May 8, 2026
8dc76c1
Cleanup
mhayes853 May 8, 2026
6e4a4d0
Cleanup
mhayes853 May 8, 2026
f53179c
Use HF metadata for grammar vocabulary
mhayes853 May 11, 2026
b4f2c7e
FFI Updates
mhayes853 May 11, 2026
de23a02
Merge v2
mhayes853 May 12, 2026
1e844c3
Export compile commands
mhayes853 May 12, 2026
fa4e753
Cleanup
mhayes853 May 12, 2026
45734cd
Fix merge conflicts
mhayes853 May 13, 2026
7e88b6d
Cleanup
mhayes853 May 13, 2026
9230f42
Cleanup Grammar FFI
mhayes853 May 13, 2026
23339b2
Fix merge conflicts
mhayes853 May 17, 2026
7f6534d
Remove is_universal
mhayes853 May 17, 2026
c98da01
Fix merge conflicts
mhayes853 May 18, 2026
7658837
test cleanup
mhayes853 May 18, 2026
713d621
Fix merge conflicts
mhayes853 May 22, 2026
c379f5d
Fix merge conflicts
mhayes853 May 22, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,7 @@ tests/assets/test_wav_info.txt
vision_activations.json
gemma-4-eap-extras/
.githooks/
*.cg

**/*/compile_commands.json
ruy
5 changes: 5 additions & 0 deletions android/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ set(CACTUS_MBEDTLS_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/mbedtls/${ANDROID_ABI}")
if(NOT EXISTS "${CACTUS_MBEDTLS_ROOT}")
set(CACTUS_MBEDTLS_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/../libs/mbedtls/android/${ANDROID_ABI}")
endif()
set(CACTUS_XGRAMMAR_LIBRARY "${CMAKE_CURRENT_SOURCE_DIR}/../cactus-engine/libs/xgrammar/android/${ANDROID_ABI}/libxgrammar.a")

if(NOT TARGET cactus_engine)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/../cactus ${CMAKE_CURRENT_BINARY_DIR}/cactus)
Expand All @@ -38,6 +39,10 @@ target_link_libraries(cactus_jni PRIVATE ${_DEPS})
find_library(LOG_LIB log)
target_link_libraries(cactus_jni PRIVATE ${LOG_LIB} android)

if(EXISTS "${CACTUS_XGRAMMAR_LIBRARY}")
target_link_libraries(cactus_jni PRIVATE "${CACTUS_XGRAMMAR_LIBRARY}")
endif()

set(_MBEDTLS "${CACTUS_MBEDTLS_ROOT}/lib/libmbedtls.a")
set(_MBEDX509 "${CACTUS_MBEDTLS_ROOT}/lib/libmbedx509.a")
set(_MBEDCRYPTO "${CACTUS_MBEDTLS_ROOT}/lib/libmbedcrypto.a")
Expand Down
7 changes: 7 additions & 0 deletions apple/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ set(CMAKE_OSX_DEPLOYMENT_TARGET "13.0" CACHE STRING "")
set(CMAKE_XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET "13.0" CACHE STRING "")
set(CMAKE_BUILD_TYPE Release CACHE STRING "")
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CACTUS_XGRAMMAR_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/../cactus-engine/libs/xgrammar")

if(NOT TARGET cactus_engine)
add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/../cactus ${CMAKE_CURRENT_BINARY_DIR}/cactus)
Expand Down Expand Up @@ -33,16 +34,22 @@ if(BUILD_SHARED_LIBS)
if(CMAKE_SYSTEM_NAME STREQUAL "iOS")
string(TOLOWER "${CMAKE_OSX_SYSROOT}" _sysroot_lower)
if(_sysroot_lower MATCHES "simulator")
set(CACTUS_XGRAMMAR_LIBRARY "${CACTUS_XGRAMMAR_ROOT}/ios/simulator/libxgrammar.a")
set(_CURL "${CACTUS_CURL_ROOT}/ios/simulator/libcurl.a")
else()
set(CACTUS_XGRAMMAR_LIBRARY "${CACTUS_XGRAMMAR_ROOT}/ios/device/libxgrammar.a")
set(_CURL "${CACTUS_CURL_ROOT}/ios/device/libcurl.a")
endif()
else()
set(CACTUS_XGRAMMAR_LIBRARY "${CACTUS_XGRAMMAR_ROOT}/macos/libxgrammar.a")
set(_CURL "${CACTUS_CURL_ROOT}/macos/libcurl.a")
endif()
if(EXISTS "${_CURL}")
target_link_libraries(cactus_framework PUBLIC "${_CURL}")
endif()
if(EXISTS "${CACTUS_XGRAMMAR_LIBRARY}")
target_link_libraries(cactus_framework PUBLIC "${CACTUS_XGRAMMAR_LIBRARY}")
endif()

set_target_properties(cactus_framework PROPERTIES
FRAMEWORK TRUE
Expand Down
13 changes: 12 additions & 1 deletion cactus-engine/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ endif()

# --- libcurl ---
set(CACTUS_CURL_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/libs/curl" CACHE PATH "Path to vendored libcurl")
set(CACTUS_XGRAMMAR_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/libs/xgrammar" CACHE PATH "Path to vendored xgrammar")

set(CACTUS_XGRAMMAR_INCLUDE_DIR "${CACTUS_XGRAMMAR_ROOT}/include")
if(APPLE)
set(CACTUS_XGRAMMAR_LIBRARY "${CACTUS_XGRAMMAR_ROOT}/macos/libxgrammar.a")
else()
set(CACTUS_XGRAMMAR_LIBRARY "${CACTUS_XGRAMMAR_ROOT}/linux/aarch64/libxgrammar.a")
endif()

set(CACTUS_CURL_INCLUDE_DIR "${CACTUS_CURL_ROOT}/include")
if(APPLE)
Expand Down Expand Up @@ -47,6 +55,8 @@ set(ENGINE_SOURCES
src/bpe.cpp
src/sp.cpp
src/constraints.cpp
src/grammar.cpp
src/grammar_ffi.cpp
src/model.cpp
src/engine_image.cpp
src/index.cpp
Expand Down Expand Up @@ -80,12 +90,13 @@ set_target_properties(cactus_engine PROPERTIES
target_include_directories(cactus_engine
PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}
PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/src
${CACTUS_XGRAMMAR_INCLUDE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/libs
${CMAKE_CURRENT_SOURCE_DIR}/../cactus-kernels/src
${CMAKE_CURRENT_SOURCE_DIR}/../cactus-kernels/libs
)

target_link_libraries(cactus_engine PUBLIC cactus_graph)
target_link_libraries(cactus_engine PRIVATE ${CACTUS_XGRAMMAR_LIBRARY})

# --- curl linking ---
if(CACTUS_HAS_CURL)
Expand Down
79 changes: 78 additions & 1 deletion cactus-engine/cactus_engine.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ extern "C" {

typedef void* cactus_model_t;
typedef void* cactus_index_t;
typedef void* cactus_stream_transcribe_t;
typedef void* cactus_grammar_t;
typedef void* cactus_grammar_vocabulary_t;
typedef void* cactus_grammar_engine_t;
typedef void* cactus_grammar_matcher_t;
typedef void (*cactus_token_callback)(const char* token, uint32_t token_id, void* user_data);

CACTUS_FFI_EXPORT cactus_model_t cactus_init(
Expand Down Expand Up @@ -188,7 +193,7 @@ typedef uint64_t cactus_node_t;
typedef struct {
int32_t precision;
size_t rank;
size_t shape[8];
size_t shape[8];
size_t num_elements;
size_t byte_size;
} cactus_tensor_info_t;
Expand Down Expand Up @@ -421,6 +426,78 @@ cactus_node_t node, void** out_ptr);
CACTUS_FFI_EXPORT int cactus_graph_get_output_info(cactus_graph_t graph,
cactus_node_t node, cactus_tensor_info_t* out_info);

CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_ebnf(const char* ebnf, const char* start_symbol);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_json();
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_empty();
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_epsilon();
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_universal();

typedef struct cactus_grammar_json_schema_options_t {
bool any_whitespace; // negates indent and separators if true
int indent;
const char* separators[2];
bool strict_mode;
int max_whitespace_count; // -1 means no limit
} cactus_grammar_json_schema_options_t;

CACTUS_FFI_EXPORT cactus_grammar_json_schema_options_t cactus_grammar_json_schema_default_options(void);

CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_json_schema(
const char* json_schema,
cactus_grammar_json_schema_options_t options
);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_regex(const char* regex);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_init_structural_tag(
const char* structural_tag_json,
cactus_grammar_vocabulary_t vocabulary // optional
);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_union(cactus_grammar_t* grammars, size_t num_grammars);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_concatenate(cactus_grammar_t* grammars, size_t num_grammars);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_optional(cactus_grammar_t grammar);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_star(cactus_grammar_t grammar);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_repeat(cactus_grammar_t grammar, int count);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_repeat_range(
cactus_grammar_t grammar,
int min_count,
int max_count // -1 means unlimited
);
CACTUS_FFI_EXPORT int cactus_grammar_get_ebnf(cactus_grammar_t grammar, char* buffer, size_t buffer_size);
CACTUS_FFI_EXPORT int cactus_grammar_is_empty(cactus_grammar_t grammar);
CACTUS_FFI_EXPORT void cactus_grammar_destroy(cactus_grammar_t grammar);

CACTUS_FFI_EXPORT cactus_grammar_engine_t cactus_grammar_engine_init(cactus_grammar_vocabulary_t vocabulary);
CACTUS_FFI_EXPORT void cactus_grammar_engine_destroy(cactus_grammar_engine_t engine);
CACTUS_FFI_EXPORT cactus_grammar_matcher_t cactus_grammar_engine_compile_matcher(
cactus_grammar_engine_t engine,
cactus_grammar_t grammar
);

CACTUS_FFI_EXPORT cactus_grammar_vocabulary_t cactus_grammar_vocabulary_init(const char* model_path);
CACTUS_FFI_EXPORT cactus_grammar_vocabulary_t cactus_grammar_vocabulary_init_from_model(cactus_model_t model);
CACTUS_FFI_EXPORT int cactus_grammar_vocabulary_get_add_prefix_space(cactus_grammar_vocabulary_t vocabulary);
CACTUS_FFI_EXPORT size_t cactus_grammar_vocabulary_get_size(cactus_grammar_vocabulary_t vocabulary);
CACTUS_FFI_EXPORT int cactus_grammar_vocabulary_get_stop_token_ids(
cactus_grammar_vocabulary_t vocabulary,
uint32_t* buffer,
size_t buffer_size,
size_t* out_token_count
);
CACTUS_FFI_EXPORT void cactus_grammar_vocabulary_destroy(cactus_grammar_vocabulary_t vocabulary);

CACTUS_FFI_EXPORT void cactus_grammar_matcher_destroy(cactus_grammar_matcher_t matcher);
CACTUS_FFI_EXPORT void cactus_grammar_matcher_reset(cactus_grammar_matcher_t matcher);
CACTUS_FFI_EXPORT void cactus_grammar_matcher_rollback(cactus_grammar_matcher_t matcher, int tokens);
CACTUS_FFI_EXPORT cactus_grammar_matcher_t cactus_grammar_matcher_fork(cactus_grammar_matcher_t matcher);
CACTUS_FFI_EXPORT cactus_grammar_t cactus_grammar_matcher_get_grammar(cactus_grammar_matcher_t matcher);
CACTUS_FFI_EXPORT int cactus_grammar_matcher_is_completed(cactus_grammar_matcher_t matcher);
CACTUS_FFI_EXPORT int cactus_grammar_matcher_is_terminated(cactus_grammar_matcher_t matcher);
CACTUS_FFI_EXPORT int cactus_grammar_matcher_accept(cactus_grammar_matcher_t matcher, uint32_t token_id);
CACTUS_FFI_EXPORT int cactus_grammar_matcher_next_bitmask(
cactus_grammar_matcher_t matcher,
int32_t* bitmask,
size_t logits_buffer_size
);

#ifdef __cplusplus
}
#endif
Expand Down
Loading
Loading