Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chugin ck_info() support added to host #426

Merged
merged 2 commits into from
Jan 17, 2024
Merged

chugin ck_info() support added to host #426

merged 2 commits into from
Jan 17, 2024

Conversation

gewang
Copy link
Member

@gewang gewang commented Jan 17, 2024

chugins can now implement a "info query function" to provide chugin-specific information to be accessible from host, including:
* chugin version (not to be confused with compatibility version)
* chugin author(s)
* chugin description
* (optional) chugin URL
* (optional) contact email

for example, in the chugin source:

// chugin info func
CK_DLL_INFO( MyChugin )
{
    // set info
    QUERY->setinfo( QUERY, CHUGIN_INFO_AUTHORS, "Ana B. Croft" );
    QUERY->setinfo( QUERY, CHUGIN_INFO_CHUGIN_VERSION, "v3.6.1" );
    QUERY->setinfo( QUERY, CHUGIN_INFO_DESCRIPTION, "what does it do?" );
    QUERY->setinfo( QUERY, CHUGIN_INFO_URL, "https://foo.com/FooBar" );
    QUERY->setinfo( QUERY, CHUGIN_INFO_EMAIL, "[email protected]" );
}

this information is read by the host (and will be read even if the API compatibility check fails, as long as the chugin implements the CK_DLL_INFO function)

@gewang gewang merged commit 4e2e015 into main Jan 17, 2024
3 checks passed
@gewang gewang deleted the 2024-dl-info branch January 17, 2024 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant