obj_api.h 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. /*
  2. * 文件名: obj_api.h
  3. * 目标:
  4. * 1) 定义一些函数签名
  5. * 2) 定义Object的函数签名
  6. *
  7. * 注意: 该文件不包含在object.h中, object.h并不依赖该文件
  8. */
  9. #ifndef AFUN_OBJ_API_H
  10. #define AFUN_OBJ_API_H
  11. #include "env.h"
  12. #include "object.h"
  13. #include "var.h"
  14. #include "func.h"
  15. #include "gc.h"
  16. /* 定义一些函数原型 */
  17. /* API函数 */
  18. typedef void objectAPIFunc(); // 位于object.h (所有Object API函数指针都转换为该类型存储, 注: 具体调用类型参见下文)
  19. /* 顶层信号处理器函数 */
  20. typedef void TopMsgProcessFunc(af_Message *msg, bool is_gc, af_Environment *env); // 位于env.h
  21. /* 回调C函数 */
  22. typedef struct CallFuncInfo CallFuncInfo;
  23. typedef struct af_FuncBody *callFuncBody(CallFuncInfo *info, af_Environment *env); // 位于env.h
  24. /* 定义Object的函数签名 */
  25. /*
  26. * API的第一个参数必须为: id
  27. * API第二个参数通常为: object
  28. * API第三个参数: 通常为void *data [仅与data有关的函数会直接传入该值]
  29. */
  30. #define BASE_ARG char *id, af_Object *obj /* 基础参数 */
  31. /*** Object void *data 管理 ***/
  32. typedef size_t obj_getDataSize(BASE_ARG); // 获取data的大小
  33. typedef void obj_initData(BASE_ARG, void *data, af_Environment *env); // 初始化data
  34. typedef void obj_destructData(BASE_ARG, void *data, af_Environment *env); // 释放data的内容 (但不释放void *data)指针
  35. /*** Object 面向对象管理 ***/
  36. typedef af_VarSpace *obj_getShareVarSpace(BASE_ARG);
  37. /*** Object 函数调用 ***/
  38. /* 获取参数计算表 */
  39. typedef bool obj_funcGetArgCodeList(BASE_ARG, af_ArgCodeList **acl, af_Code *code, void **mark, af_Environment *env);
  40. /* 获取函数变量空间 */
  41. typedef bool obj_funcGetVarList(BASE_ARG, af_VarSpaceListNode **vsl, void *mark, af_Environment *env);
  42. /* 获取参数赋值表 */
  43. typedef bool obj_funcGetArgList(BASE_ARG, af_ArgList **al, af_ArgCodeList *acl, void *mark, af_Environment *env);
  44. /* 获取函数信息 */
  45. typedef bool obj_funcGetInfo(BASE_ARG, af_FuncInfo **fi, af_Code *code, void *mark, af_Environment *env);
  46. /* 释放mask的函数 */
  47. typedef void obj_funcFreeMask(BASE_ARG, void *mark);
  48. /*** Object 字面量设定 ***/
  49. typedef void obj_literalSetting(BASE_ARG, void *data, char *str, af_Environment *env);
  50. /*** Object 函数管理 ***/
  51. typedef bool obj_isObjFunc(BASE_ARG); // 是否对象函数
  52. typedef bool obj_isInfixFunc(BASE_ARG); // 是否中缀函数
  53. /*** Object gc管理 ***/
  54. typedef af_GcList *obj_getGcList(BASE_ARG, void *data); // 是否对象函数
  55. #undef BASE_ARG
  56. #endif //AFUN_OBJ_API_H