[Artwork] / [QisMLib]

QisMLib Extensions

Welcome to the reference page for QisMLib Extensions, heart of the extension (plug-in) mechanism of QisMLib, Artwork Conversion's CAD processing framework.

The framework is built as a core library plus a set of optional components, each delivered as a separate shared library. This page describes the gateway that ties them together. It explains how the framework discovers an extension listed in its configuration file, how the extension announces the programming interfaces it offers so that other software can find them, how it reports its version and any start-up warnings or errors, and how it cleans up when the program ends.

This is the page to read if you are writing your own extension for the framework or want to understand how the existing ones plug in.

This page is the complete reference for the extension mechanism. Here is what you will find, in the order it appears:

If you are building a new extension, read the two exported functions first, then the manager, since those three define the contract. If you only use extensions, the report interface explains where start-up messages come from.


C++ API for QisMLib extensions (qismextension.h)

class QisMExtensionAPI

Opaque interface to a QisMExtension API

Implementation_version()

Get any information specific to the API implementation

Extension_class_name()

Returns the name of the api class representing this extension (that directly inherits QisMExtensionAPI)

Extension_class_ptr()

Returns the ptr to the api class representing this extension (that directly inherits QisMExtensionAPI)

Extension_class_ptr()

Returns the const ptr to the api class representing this extension (that directly inherits QisMExtensionAPI)

class QisMExtensionReport

Pre-loaded extension API to enable dynamically loaded QisMExtensions to report information, warnings, errors during initialization so that they appear in the QisMExtension report obtained using QisMLib::Get_extension_report()

Report_info()

Report API specific information (version etc.)

Report_warning()

Report any warnings encountered during initialization of a QisMExtension

Report_error()

Report any errors encountered during initialization of a QisMExtension

class QisMExtensionMgr

API to the component that manages QisMExtensions

Register_extension_api()

Register an API with the extension manager so that it can be made available via QisMLib::Get_extension_api(...) for use in the client or other QisMExtensions

Get_qism_extension_api()

Get access to a pre-loaded extension API. Such an API is defined and implemented inside the QisM library and is guaranteed to be available during the initialization of the dynamic QisMExtensions (unlike QisMLib::Get_extension_api)

QisMLib_extension_init_v2() export

A function exported by a QisMExtension component (shared library) that gets called during QisMLib_initialize_once when that component is being loaded and allows the component to perform initialization of it's internal objects and resources as well as register one or more QisMExtension APIs

QisMLib_extension_close_v2() export

A function exported by a QisMExtension component (shared library) that gets called at the end of the application when that component is being unloaded and allows the component to perform cleanup of it's internal objects and resources


ARTWORK CONVERSION SOFTWARE, INC.
509 N. Sepulveda Blvd. Suite 201 Manhattan Beach, CA 90266  tel: 831.426.6163  email: info@artwork.surf

Last Updated -- Wed Sep 30 01:12:17 UTC 2026