CrystalSpace

Public API Reference

CS::DocSystem::iDocumentPreprocessor Struct Reference

Interface to document preprocessor plugin. More...

#include <ivaria/docpreproc.h>

Inheritance diagram for CS::DocSystem::iDocumentPreprocessor:

List of all members.

Public Member Functions

virtual csPtr< iDocumentNodeProcess (iDocumentNode *doc)=0
 Preprocess a document node and it's children.

Detailed Description

Interface to document preprocessor plugin.

This applies a preprocessing step featuring “templates” (comparable to C++ preprocessor macros), “defines” (comparable to C++ preprocessor conditions) and “generation” (like a for-loop for nodes).

For a reference, see the “Shader Processing Instructions” section in: http://crystalspace3d.org/docs/online/manual/Shader-Conditions-and-Processing-Instructions-Reference.html (Note: “Shader Conditions” support is not handled by the preprocessor plugin!)

Main implementor of this interface:

Definition at line 47 of file docpreproc.h.


Member Function Documentation

virtual csPtr<iDocumentNode> CS::DocSystem::iDocumentPreprocessor::Process ( iDocumentNode doc  )  [pure virtual]

Preprocess a document node and it's children.

Returns a new node instance with the preprocessed result.

Remarks:
The original document node will still be referred to; changing it and simulatenously keeping a preprocessed node around will have undefined results!

The documentation for this struct was generated from the following file:

Generated for Crystal Space 2.1 by doxygen 1.6.1