/indra/llcommon/u64.h

https://bitbucket.org/lindenlab/viewer-beta/ · C++ Header · 74 lines · 8 code · 7 blank · 59 comment · 0 complexity · 9bb6f7fa77eb7f707280f08f05ade07e MD5 · raw file

  1. /**
  2. * @file u64.h
  3. * @brief Utilities to deal with U64s.
  4. *
  5. * $LicenseInfo:firstyear=2001&license=viewerlgpl$
  6. * Second Life Viewer Source Code
  7. * Copyright (C) 2010, Linden Research, Inc.
  8. *
  9. * This library is free software; you can redistribute it and/or
  10. * modify it under the terms of the GNU Lesser General Public
  11. * License as published by the Free Software Foundation;
  12. * version 2.1 of the License only.
  13. *
  14. * This library is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17. * Lesser General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Lesser General Public
  20. * License along with this library; if not, write to the Free Software
  21. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22. *
  23. * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
  24. * $/LicenseInfo$
  25. */
  26. #ifndef LL_U64_H
  27. #define LL_U64_H
  28. /**
  29. * @brief Forgivingly parse a null terminated character array.
  30. *
  31. * @param str The string to parse.
  32. * @return Returns the first U64 value found in the string or 0 on failure.
  33. */
  34. LL_COMMON_API U64 str_to_U64(const std::string& str);
  35. /**
  36. * @brief Given a U64 value, return a printable representation.
  37. * @param value The U64 to turn into a printable character array.
  38. * @return Returns the result string.
  39. */
  40. LL_COMMON_API std::string U64_to_str(U64 value);
  41. /**
  42. * @brief Given a U64 value, return a printable representation.
  43. *
  44. * The client of this function is expected to provide an allocated
  45. * buffer. The function then snprintf() into that buffer, so providing
  46. * NULL has undefined behavior. Providing a buffer which is too small
  47. * will truncate the printable value, so usually you want to declare
  48. * the buffer:
  49. *
  50. * char result[U64_BUF];
  51. * std::cout << "value: " << U64_to_str(value, result, U64_BUF);
  52. *
  53. * @param value The U64 to turn into a printable character array.
  54. * @param result The buffer to use
  55. * @param result_size The size of the buffer allocated. Use U64_BUF.
  56. * @return Returns the result pointer.
  57. */
  58. LL_COMMON_API char* U64_to_str(U64 value, char* result, S32 result_size);
  59. /**
  60. * @brief Convert a U64 to the closest F64 value.
  61. */
  62. LL_COMMON_API F64 U64_to_F64(const U64 value);
  63. /**
  64. * @brief Helper function to wrap strtoull() which is not available on windows.
  65. */
  66. LL_COMMON_API U64 llstrtou64(const char* str, char** end, S32 base);
  67. #endif