libcm is a C development framework with an emphasis on audio signal processing applications.
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

cmPrefs.h 10KB

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