Hex.h 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. /* vim: set expandtab ts=4 sw=4: */
  2. /*
  3. * You may redistribute this program and/or modify it under the terms of
  4. * the GNU General Public License as published by the Free Software Foundation,
  5. * either version 3 of the License, or (at your option) any later version.
  6. *
  7. * This program is distributed in the hope that it will be useful,
  8. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. * GNU General Public License for more details.
  11. *
  12. * You should have received a copy of the GNU General Public License
  13. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  14. */
  15. #ifndef Hex_H
  16. #define Hex_H
  17. #include "memory/Allocator.h"
  18. #include "util/Linker.h"
  19. Linker_require("util/Hex.c")
  20. #include <stdint.h>
  21. #include <stdbool.h>
  22. /** Returned by Hex_decode() if the input is not valid hex. */
  23. #define Hex_BAD_INPUT -1
  24. /** Returned by Hex_decode() or Hex_encode() if the output buffer is too small. */
  25. #define Hex_TOO_BIG -2
  26. int Hex_encode(uint8_t* output,
  27. const uint32_t outputLength,
  28. const uint8_t* in,
  29. const uint32_t inputLength);
  30. int Hex_decode(uint8_t* output,
  31. const uint32_t outLength,
  32. const uint8_t* in,
  33. const uint32_t inputLength);
  34. bool Hex_isHexEntity(const uint8_t character);
  35. int Hex_decodeByte(const uint8_t highNibble, const uint8_t lowNibble);
  36. uint8_t Hex_encodeLowNibble(const uint8_t nibble);
  37. char* Hex_print(void* bytes, uint32_t length, struct Allocator* alloc);
  38. #endif