KSString.h 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. //
  2. // KSString.h
  3. //
  4. // Created by Karl Stenerud on 2012-09-15.
  5. //
  6. // Copyright (c) 2012 Karl Stenerud. All rights reserved.
  7. //
  8. // Permission is hereby granted, free of charge, to any person obtaining a copy
  9. // of this software and associated documentation files (the "Software"), to deal
  10. // in the Software without restriction, including without limitation the rights
  11. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. // copies of the Software, and to permit persons to whom the Software is
  13. // furnished to do so, subject to the following conditions:
  14. //
  15. // The above copyright notice and this permission notice shall remain in place
  16. // in this source code.
  17. //
  18. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. // THE SOFTWARE.
  25. //
  26. #ifndef HDR_KSString_h
  27. #define HDR_KSString_h
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif
  31. #include <stdbool.h>
  32. #include <stdint.h>
  33. /** Check if a memory location contains a null terminated UTF-8 string.
  34. *
  35. * @param memory The memory location to test.
  36. *
  37. * @param minLength The minimum length to be considered a valid string.
  38. *
  39. * @param maxLength The maximum length to be considered a valid string.
  40. */
  41. bool ksstring_isNullTerminatedUTF8String(const void* memory, int minLength, int maxLength);
  42. /** Extract a hex value in the form "0x123456789abcdef" from a string.
  43. *
  44. * @param string The string to search.
  45. *
  46. * @param stringLength The length of the string.
  47. *
  48. * @param result Buffer to hold the resulting value.
  49. *
  50. * @return true if the operation was successful.
  51. */
  52. bool ksstring_extractHexValue(const char* string, int stringLength, uint64_t* result);
  53. #ifdef __cplusplus
  54. }
  55. #endif
  56. #endif // HDR_KSString_h