/indra/llcommon/u64.h

 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
27#ifndef LL_U64_H
28#define LL_U64_H
29
30/**
31 * @brief Forgivingly parse a null terminated character array.
32 *
33 * @param str The string to parse.
34 * @return Returns the first U64 value found in the string or 0 on failure.
35 */
36LL_COMMON_API U64 str_to_U64(const std::string& str);
37
38/**
39 * @brief Given a U64 value, return a printable representation.
40 * @param value The U64 to turn into a printable character array.
41 * @return Returns the result string.
42 */
43LL_COMMON_API std::string U64_to_str(U64 value);
44
45/**
46 * @brief Given a U64 value, return a printable representation.
47 *
48 * The client of this function is expected to provide an allocated
49 * buffer. The function then snprintf() into that buffer, so providing
50 * NULL has undefined behavior. Providing a buffer which is too small
51 * will truncate the printable value, so usually you want to declare
52 * the buffer:
53 *
54 *  char result[U64_BUF];
55 *  std::cout << "value: " << U64_to_str(value, result, U64_BUF);
56 *
57 * @param value The U64 to turn into a printable character array.
58 * @param result The buffer to use
59 * @param result_size The size of the buffer allocated. Use U64_BUF.
60 * @return Returns the result pointer.
61 */
62LL_COMMON_API char* U64_to_str(U64 value, char* result, S32 result_size);
63
64/**
65 * @brief Convert a U64 to the closest F64 value.
66 */
67LL_COMMON_API F64 U64_to_F64(const U64 value);
68
69/**
70 * @brief Helper function to wrap strtoull() which is not available on windows.
71 */
72LL_COMMON_API U64 llstrtou64(const char* str, char** end, S32 base);
73
74#endif