libcm is a C development framework with an emphasis on audio signal processing applications.
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

cmPrefs.h 9.1KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. #ifndef cmPrefs_h
  2. #define cmPrefs_h
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. typedef unsigned cmPrRC_t;
  7. typedef cmHandle_t cmPrH_t;
  8. enum
  9. {
  10. kOkPrRC = cmOkRC,
  11. kJsonFailPrRC,
  12. kLHeapFailPrRC,
  13. kCbNotFoundPrRC,
  14. kVarNotFoundPrRC,
  15. kBufTooSmallPrRC,
  16. kCvtErrPrRC,
  17. kInvalidIdPrRC,
  18. kInvalidIndexPrRC,
  19. kWriteFileFailPrRC,
  20. kNodeCreateFailPrRC,
  21. kDuplicateIdPrRC
  22. };
  23. enum
  24. {
  25. kMaxVarPrId = 0x7fffffff // User assigned variable id's given to cmPrefsCreateXXX()
  26. // must be less than kMaxVarPrId
  27. };
  28. typedef void (*cmPrefsOnChangeFunc_t)( cmPrH_t h, void* cbDataPtr, unsigned id );
  29. extern cmPrH_t cmPrNullHandle;
  30. // 'cbFunc' is optional
  31. cmPrRC_t cmPrefsInitialize( cmPrH_t* hp, const cmChar_t* fn, cmPrefsOnChangeFunc_t cbFunc, void* cbDataPtr, cmCtx_t* ctx );
  32. cmPrRC_t cmPrefsFinalize( cmPrH_t* hp );
  33. bool cmPrefsIsValid( cmPrH_t h );
  34. const cmChar_t* cmPrefsFileName( cmPrH_t h );
  35. // Return last RC.
  36. cmPrRC_t cmPrefsRC( cmPrH_t h);
  37. // Return last RC and set new RC.
  38. cmPrRC_t cmPrefsSetRC( cmPrH_t h, cmPrRC_t rc );
  39. cmPrRC_t cmPrefsInstallCallback( cmPrH_t h, cmPrefsOnChangeFunc_t cbFunc, void* cbDataPtr );
  40. cmPrRC_t cmPrefsRemoveCallback( cmPrH_t h, cmPrefsOnChangeFunc_t cbFunc );
  41. // Return cmInvalidId if the no variable is found with the requested path.
  42. unsigned cmPrefsId( cmPrH_t h, const cmChar_t* pathStr, bool reportNotFoundFl );
  43. // Returns -1 (and generates an error msg) if no pref. variable
  44. // is associated with id. Returns 1 if the variable is a scalar.
  45. unsigned cmPrefsEleCount( cmPrH_t h, unsigned id );
  46. // On input *'eleCntPtr' must contain the number of elements in the buffer pointed to by 'vp'.
  47. // On return *'eleCntPtr' contains the actuall number of elements returned by the function.
  48. // Set *eleCntPtr to 1 for scalar a values.
  49. cmPrRC_t cmPrefsGetBool( cmPrH_t h, unsigned id, bool* vp, unsigned* eleCntPtr );
  50. cmPrRC_t cmPrefsGetInt( cmPrH_t h, unsigned id, int* vp, unsigned* eleCntPtr );
  51. cmPrRC_t cmPrefsGetReal( cmPrH_t h, unsigned id, double* vp, unsigned* eleCntPtr );
  52. cmPrRC_t cmPrefsGetString( cmPrH_t h, unsigned id, const cmChar_t** vp, unsigned* eleCntPtr );
  53. // Simplified scalar interface - check cmPrefsRC() for errors.
  54. bool cmPrefsBool( cmPrH_t h, unsigned id );
  55. unsigned cmPrefsUInt( cmPrH_t h, unsigned id );
  56. int cmPrefsInt( cmPrH_t h, unsigned id );
  57. float cmPrefsFloat( cmPrH_t h, unsigned id );
  58. double cmPrefsReal( cmPrH_t h, unsigned id );
  59. const cmChar_t* cmPrefsString( cmPrH_t h, unsigned id );
  60. // Simplified scalar interface w/ default values - check cmPrefsRC() for errors.
  61. // Returns the stored preference variable unless 'pathStr' does not identify a variable
  62. // or if 'h' is not valid. In either of these cases 'dfltVal' is returned.
  63. bool cmPrefsBoolDef( cmPrH_t h, const cmChar_t* pathStr, bool dfltVal );
  64. unsigned cmPrefsUIntDef( cmPrH_t h, const cmChar_t* pathStr, unsigned dfltVal );
  65. int cmPrefsIntDef( cmPrH_t h, const cmChar_t* pathStr, int dfltVal );
  66. float cmPrefsFloatDef( cmPrH_t h, const cmChar_t* pathStr, float dfltVal );
  67. double cmPrefsRealDef( cmPrH_t h, const cmChar_t* pathStr, double dfltVal );
  68. const cmChar_t* cmPrefsStringDef( cmPrH_t h, const cmChar_t* pathStr, const cmChar_t* dfltVal );
  69. // Get a scalar value.
  70. cmPrRC_t cmPrefsBoolRc( cmPrH_t h, const cmChar_t* pathStr, bool* retValPtr );
  71. cmPrRC_t cmPrefsUIntRc( cmPrH_t h, const cmChar_t* pathStr, unsigned* retValPtr );
  72. cmPrRC_t cmPrefsIntRc( cmPrH_t h, const cmChar_t* pathStr, int* retValPtr );
  73. cmPrRC_t cmPrefsFloatRc( cmPrH_t h, const cmChar_t* pathStr, float* retValPtr );
  74. cmPrRC_t cmPrefsRealRc( cmPrH_t h, const cmChar_t* pathStr, double* retValPtr );
  75. cmPrRC_t cmPrefsStringRc( cmPrH_t h, const cmChar_t* pathStr, const cmChar_t** retValPtr );
  76. // Simplified array interface - check cmPrefsRC() for errors
  77. // Returns cmInvalidCnt if 'id' is invalid or 0 if the identified var. is a scalar.
  78. unsigned cmPrefsArrayElementCount( cmPrH_t h, unsigned id );
  79. bool cmPrefsBoolEle( cmPrH_t h, unsigned id, unsigned idx );
  80. unsigned cmPrefsUIntEle( cmPrH_t h, unsigned id, unsigned idx );
  81. int cmPrefsIntEle( cmPrH_t h, unsigned id, unsigned idx );
  82. float cmPrefsFloatEle( cmPrH_t h, unsigned id, unsigned idx );
  83. double cmPrefsRealEle( cmPrH_t h, unsigned id, unsigned idx );
  84. const cmChar_t* cmPrefsStringEle( cmPrH_t h, unsigned id, unsigned idx );
  85. // Set a preference value.
  86. // The size of array variables is allowed to shrink or grow but the type (bool/int/real/string)
  87. // must match.
  88. //
  89. // Note that the following limitations apply:
  90. // 1) This interface allows setting the value of an existing preference variable.
  91. // New variables may not be added.
  92. // 2) The type (bool/int/real/string) of the variable must match the value.
  93. // (e.g. 'int' type variables can only be set via cmPrefsSetInt()).
  94. // 3) For scalar (non-array) variables *eleCntPtr must be set to 1.
  95. //
  96. cmPrRC_t cmPrefsSetBoolArray( cmPrH_t h, unsigned id, const bool* vp, const unsigned* eleCntPtr );
  97. cmPrRC_t cmPrefsSetIntArray( cmPrH_t h, unsigned id, const int* vp, const unsigned* eleCntPtr );
  98. cmPrRC_t cmPrefsSetRealArray( cmPrH_t h, unsigned id, const double* vp, const unsigned* eleCntPtr );
  99. cmPrRC_t cmPrefsSetStringArray( cmPrH_t h, unsigned id, const cmChar_t** vp, const unsigned* eleCntPtr );
  100. cmPrRC_t cmPrefsSetBool( cmPrH_t h, unsigned id, bool val );
  101. cmPrRC_t cmPrefsSetUInt( cmPrH_t h, unsigned id, unsigned val );
  102. cmPrRC_t cmPrefsSetInt( cmPrH_t h, unsigned id, int val );
  103. cmPrRC_t cmPrefsSetFloat( cmPrH_t h, unsigned id, float val );
  104. cmPrRC_t cmPrefsSetReal( cmPrH_t h, unsigned id, double val );
  105. cmPrRC_t cmPrefsSetString( cmPrH_t h, unsigned id, const cmChar_t* val );
  106. cmPrRC_t cmPrefsPathSetBool( cmPrH_t h, const cmChar_t* pathStr, bool val );
  107. cmPrRC_t cmPrefsPathSetUInt( cmPrH_t h, const cmChar_t* pathStr, unsigned val );
  108. cmPrRC_t cmPrefsPathSetInt( cmPrH_t h, const cmChar_t* pathStr, int val );
  109. cmPrRC_t cmPrefsPathSetFloat( cmPrH_t h, const cmChar_t* pathStr, float val );
  110. cmPrRC_t cmPrefsPathSetReal( cmPrH_t h, const cmChar_t* pathStr, double val );
  111. cmPrRC_t cmPrefsPathSetString( cmPrH_t h, const cmChar_t* pathStr, const cmChar_t* val );
  112. // Create a new preference variable and set it's value to 'val'.
  113. // If a variable with the same path and type already exists and kForceValuePrFl is set then update it's value to 'val'.
  114. // Note that in this case if kForceValuePrFl is not set then the function returns quietly.
  115. //
  116. // If a variable with the same path but a different type exists then an error is returned.
  117. //
  118. // The 'id' argument is optional. If 'id' is set to cmInvalidId then the
  119. // variable will be automatically assigned an id. The value of the
  120. // automatically assigned id can be found from the path string
  121. // via cmPrefsId(). If 'id' is not set to cmInvalidId then it must be less than
  122. // kMaxVarId.
  123. // Set kForceValuePrFl
  124. enum { kForceValuePrFl=0x01 };
  125. cmPrRC_t cmPrefsCreateBool( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, bool val );
  126. cmPrRC_t cmPrefsCreateUInt( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, unsigned val );
  127. cmPrRC_t cmPrefsCreateInt( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, int val );
  128. cmPrRC_t cmPrefsCreateFloat( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, float val );
  129. cmPrRC_t cmPrefsCreateReal( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, double val );
  130. cmPrRC_t cmPrefsCreateString( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, const cmChar_t* val );
  131. cmPrRC_t cmPrefsCreateBoolArray( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, const bool* val, unsigned eleCnt );
  132. cmPrRC_t cmPrefsCreateUIntArray( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, const unsigned* val, unsigned eleCnt );
  133. cmPrRC_t cmPrefsCreateIntArray( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, const int* val, unsigned eleCnt );
  134. cmPrRC_t cmPrefsCreateFloatArray( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, const float* val, unsigned eleCnt );
  135. cmPrRC_t cmPrefsCreateRealArray( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, const double* val, unsigned eleCnt );
  136. cmPrRC_t cmPrefsCreateStringArray( cmPrH_t h, unsigned id, const cmChar_t* pathStr, unsigned flags, const cmChar_t** val, unsigned eleCnt );
  137. bool cmPrefsIsDirty( cmPrH_t h );
  138. // If 'fn' is NULL then the filename passed in cmPrefsInitialize() is used.
  139. cmPrRC_t cmPrefsWrite( cmPrH_t h, const cmChar_t* fn );
  140. void cmPrefsTest( cmCtx_t* ctx, const char* ifn, const char* ofn );
  141. #ifdef __cplusplus
  142. }
  143. #endif
  144. #endif