PluginProtocol.h 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. /****************************************************************************
  2. Copyright (c) 2012-2013 cocos2d-x.org
  3. http://www.cocos2d-x.org
  4. Permission is hereby granted, free of charge, to any person obtaining a copy
  5. of this software and associated documentation files (the "Software"), to deal
  6. in the Software without restriction, including without limitation the rights
  7. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. copies of the Software, and to permit persons to whom the Software is
  9. furnished to do so, subject to the following conditions:
  10. The above copyright notice and this permission notice shall be included in
  11. all copies or substantial portions of the Software.
  12. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  13. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  14. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  15. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  16. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  17. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  18. THE SOFTWARE.
  19. ****************************************************************************/
  20. #ifndef __CCX_IPLUGIN_H__
  21. #define __CCX_IPLUGIN_H__
  22. #include "PluginParam.h"
  23. #include <vector>
  24. #if defined(__GNUC__) && ((__GNUC__ >= 4) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)))
  25. #define CC_DEPRECATED_ATTRIBUTE __attribute__((deprecated))
  26. #elif _MSC_VER >= 1400 //vs 2005 or higher
  27. #define CC_DEPRECATED_ATTRIBUTE __declspec(deprecated)
  28. #else
  29. #define CC_DEPRECATED_ATTRIBUTE
  30. #endif
  31. namespace cocos2d { namespace plugin {
  32. /**
  33. The super class for all plugins.
  34. */
  35. class PluginFactory;
  36. class PluginProtocol
  37. {
  38. public:
  39. virtual ~PluginProtocol();
  40. /**
  41. @brief plug-in info methods(name, version, SDK version)
  42. */
  43. inline const char* getPluginName() { return _pluginName.c_str(); }
  44. std::string getPluginVersion();
  45. std::string getSDKVersion();
  46. /**
  47. @brief switch debug plug-in on/off
  48. */
  49. void setDebugMode(bool bDebug);
  50. /**
  51. * @brief methods for reflections
  52. */
  53. void callFuncWithParam(const char* funcName, PluginParam* param, ...);
  54. void callFuncWithParam(const char* funcName, std::vector<PluginParam*> params);
  55. std::string callStringFuncWithParam(const char* funcName, PluginParam* param, ...);
  56. std::string callStringFuncWithParam(const char* funcName, std::vector<PluginParam*> params);
  57. int callIntFuncWithParam(const char* funcName, PluginParam* param, ...);
  58. int callIntFuncWithParam(const char* funcName, std::vector<PluginParam*> params);
  59. bool callBoolFuncWithParam(const char* funcName, PluginParam* param, ...);
  60. bool callBoolFuncWithParam(const char* funcName, std::vector<PluginParam*> params);
  61. float callFloatFuncWithParam(const char* funcName, PluginParam* param, ...);
  62. float callFloatFuncWithParam(const char* funcName, std::vector<PluginParam*> params);
  63. protected:
  64. PluginProtocol() {}
  65. private:
  66. friend class PluginFactory;
  67. inline void setPluginName(const char* name) {
  68. _pluginName = name;
  69. }
  70. std::string _pluginName;
  71. };
  72. }} //namespace cocos2d { namespace plugin {
  73. #endif /* __CCX_IPLUGIN_H__ */