Chapter 3. Module Declaration
Prev Wolframe Server Extension Modules Next

Chapter 3. Module Declaration

Table of Contents

3.1. Module Declaration Frame
3.1.1. Empty Module Declaration Example
3.1.2. Module Declaration Macros
3.2. Building a Module
3.3. Exported Objects of a Module
3.3.1. Define Normalization Functions (Normalizers)
Normalizer Interface
Building Blocks
Declaring a resource singleton object
Declaring a normalizer not using any resource
Declaring a normalizer using a resource
Examples
Example without resources
Example with resources
3.3.2. Define Custom Data Types
Custom Data Type Interface
CustomDataType Structure
CustomDataInitializer Interface
Class CustomDataValue
Building Blocks
Declaring a custom data type
3.3.3. Define Filters
Filter element types
Filter element values
Filter Interface
Input Filter Structure
Output Filter Structure
Filter Structure
Building Blocks
Declaring a filter

In this chapter we introduce how modules are declared for extending a Wolframe application with our own functions and objects.

3.1. Module Declaration Frame

A module has to include "appdevel/moduleFrameMacros.hpp" or simply "appDevel.hpp" and declare a module header and a module trailer with the macros WF_MODULE_BEGIN and WF_MODULE_END. A single module source file built as Wolframe application extension module must contain only one WF_MODULE_BEGIN .... WF_MODULE_END declaration. But a module declaration can contain an arbitrary number of objects that not conflicting in anything they define (names, etc.) The following example shows an empty module without any exported objects, thus the simplest module we can declare.

3.1.1. Empty Module Declaration Example


    #include "appDevel.hpp"
    WF_MODULE_BEGIN( "empty", "an example module not exporting anything")
    WF_MODULE_END

3.1.2. Module Declaration Macros

The macro WF_MODULE_BEGIN has two parameters

Table 3.1. Parameters of WF_MODULE_BEGIN

NAMEDESCRIPTION
Identifier of the module (*)Description sentence of the module for user info when inspecting a module.

(*) Currently not used but will be when a namespace concept will be implemented.

The end declaration WF_MODULE_END closes the module object and defines the module entry point structure.

Prev Up Next
Chapter 2. Basic Data Types Home 3.2. Building a Module