Mercurial > hg > orthanc
view Plugins/OrthancCPlugin/OrthancCPlugin.h @ 898:7000fc86fe62 plugins
improved plugin api
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 18 Jun 2014 09:18:28 +0200 |
parents | bafc9d592632 |
children | bb0a51561016 |
line wrap: on
line source
/** * Orthanc - A Lightweight, RESTful DICOM Store * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, * Belgium * * This program is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * In addition, as a special exception, the copyright holders of this * program give permission to link the code of its release with the * OpenSSL project's "OpenSSL" library (or with modified versions of it * that use the same license as the "OpenSSL" library), and distribute * the linked executables. You must obey the GNU General Public License * in all respects for all of the code used other than "OpenSSL". If you * modify file(s) with this exception, you may extend this exception to * your version of the file(s), but you are not obligated to do so. If * you do not wish to do so, delete this exception statement from your * version. If you delete this exception statement from all source files * in the program, then also delete it here. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. **/ #pragma once #ifdef WIN32 #define ORTHANC_PLUGINS_API __declspec(dllexport) #else #define ORTHANC_PLUGINS_API #endif /******************************************************************** ** Check that function inlining is properly supported. The use of ** inlining is required, to avoid the duplication of object code ** between two compilation modules that would use the Orthanc Plugin ** API. ********************************************************************/ /* If the auto-detection of the "inline" keyword below does not work automatically and that your compiler is known to properly support inlining, uncomment the following #define and adapt the definition of "static inline". */ /* #define ORTHANC_PLUGIN_INLINE static inline */ #ifndef ORTHANC_PLUGIN_INLINE # if __STDC_VERSION__ >= 199901L /* This is C99 or above: http://predef.sourceforge.net/prestd.html */ # define ORTHANC_PLUGIN_INLINE static inline # elif defined(__cplusplus) /* This is C++ */ # define ORTHANC_PLUGIN_INLINE static inline # elif defined(__GNUC__) /* This is GCC running in C89 mode */ # define ORTHANC_PLUGIN_INLINE static __inline # elif defined(_MSC_VER) /* This is Visual Studio running in C89 mode */ # define ORTHANC_PLUGIN_INLINE static __inline # else # error Your compiler is not known to support the "inline" keyword # endif #endif /******************************************************************** ** Inclusion of standard libaries. ********************************************************************/ #ifdef _MSC_VER #include "../../Resources/VisualStudio/stdint.h" #else #include <stdint.h> #endif #include <stdlib.h> /******************************************************************** ** Definition of the Orthanc Plugin API. ********************************************************************/ #ifdef __cplusplus extern "C" { #endif typedef struct OrthancPluginRestOutput_t OrthancPluginRestOutput; typedef enum { OrthancPluginHttpMethod_Get = 1, OrthancPluginHttpMethod_Post = 2, OrthancPluginHttpMethod_Put = 3, OrthancPluginHttpMethod_Delete = 4 } OrthancPluginHttpMethod; typedef enum { OrthancPluginService_LogInfo = 1, OrthancPluginService_LogWarning = 2, OrthancPluginService_LogError = 3 } OrthancPluginService; typedef int32_t (*OrthancPluginRestCallback) (OrthancPluginRestOutput* output, OrthancPluginHttpMethod method, const char* url, const char* const* getKeys, const char* const* getValues, uint32_t getSize, const char* body, uint32_t bodySize); typedef struct OrthancPluginContext_t { void* pluginsManager; const char* orthancVersion; void (*FreeBuffer) (void* buffer); int32_t (*InvokeService) (struct OrthancPluginContext_t* context, OrthancPluginService service, const void* parameters); /* REST API */ void (*RegisterRestCallback) (const struct OrthancPluginContext_t* context, const char* pathRegularExpression, OrthancPluginRestCallback callback); void (*AnswerBuffer) (OrthancPluginRestOutput* output, const char* answer, uint32_t answerSize, const char* mimeType); } OrthancPluginContext; ORTHANC_PLUGIN_INLINE void OrthancPluginLogError(OrthancPluginContext* context, const char* str) { context->InvokeService(context, OrthancPluginService_LogError, str); } ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning(OrthancPluginContext* context, const char* str) { context->InvokeService(context, OrthancPluginService_LogWarning, str); } ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo(OrthancPluginContext* context, const char* str) { context->InvokeService(context, OrthancPluginService_LogInfo, str); } /** Each plugin must define 4 functions, whose signature are: - int32_t OrthancPluginInitialize(const OrthancPluginContext*); - void OrthancPluginFinalize(); - const char* OrthancPluginGetName(); - const char* OrthancPluginGetVersion(); nm -C -D --defined-only libPluginTest.so **/ #ifdef __cplusplus } #endif