← Back to branch summary

~nme/nme/1.1

« back to all changes in this revision

Viewing changes to Src/NMEPluginUppercase.h

  • Committer: michael.owens at linterra
  • Date: 2008-11-19 17:49:21 UTC
  • Revision ID: michael.owens@linterra.org-20081119174921-5rh22x5qdh6ltf4o
Initial submission.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Src/NMEPluginUppercase.h
 
1
/**
 
2
 *      @file NMEPluginUppercase.h
 
3
 *      @brief NME optional plugin for cnverting text to uppercase.
 
4
 *      @author Yves Piguet. Copyright 2007-2008, Yves Piguet.
 
5
 */
 
6
 
 
7
/* License: new BSD license (see NME.h) */
 
8
 
 
9
#ifndef __NMEPluginUppercase__
 
10
#define __NMEPluginUppercase__
 
11
 
 
12
#ifdef __cplusplus
 
13
extern "C" {
 
14
#endif
 
15
 
 
16
#include "NME.h"
 
17
 
 
18
/** Plugin implementation for reversing text
 
19
        @param[in] name plugin name, such as "reverse"
 
20
        @param[in] nameLen length of name
 
21
        @param[in] data data text
 
22
        @param[in] dataLen length of data
 
23
        @param[in,out] context current context
 
24
        @param[in] userData pointer passed from the parser, as specified in NMEPlugin
 
25
        @return error code (kNMEErrOk for success)
 
26
        @test @code
 
27
        << reverse
 
28
        abcdef 123456
 
29
        >>
 
30
        @endcode
 
31
*/
 
32
NMEErr NMEPluginUppercase(NMEConstText name, NMEInt nameLen,
 
33
                NMEConstText data, NMEInt dataLen,
 
34
                NMEContext *context,
 
35
                void *userData);
 
36
 
 
37
/// NMEPlugin entry for table of plugins
 
38
#define NMEPluginUppercaseEntry \
 
39
        {"uppercase", kNMEPluginOptReparseOutput, NMEPluginUppercase, NULL}
 
40
 
 
41
#ifdef __cplusplus
 
42
}
 
43
#endif
 
44
 
 
45
#endif