1 // Copyright 2012 The Kyua Authors. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above copyright 11 // notice, this list of conditions and the following disclaimer in the 12 // documentation and/or other materials provided with the distribution. 13 // * Neither the name of Google Inc. nor the names of its contributors 14 // may be used to endorse or promote products derived from this software 15 // without specific prior written permission. 16 // 17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29 /// \file utils/units.hpp 30 /// Formatters and parsers of user-friendly units. 31 32 #if !defined(UTILS_UNITS_HPP) 33 #define UTILS_UNITS_HPP 34 35 #include "utils/units_fwd.hpp" 36 37 extern "C" { 38 #include <stdint.h> 39 } 40 41 #include <istream> 42 #include <ostream> 43 #include <string> 44 45 namespace utils { 46 namespace units { 47 48 49 namespace { 50 51 /// Constant representing 1 kilobyte. 52 const uint64_t KB = int64_t(1) << 10; 53 54 /// Constant representing 1 megabyte. 55 const uint64_t MB = int64_t(1) << 20; 56 57 /// Constant representing 1 gigabyte. 58 const uint64_t GB = int64_t(1) << 30; 59 60 /// Constant representing 1 terabyte. 61 const uint64_t TB = int64_t(1) << 40; 62 63 } // anonymous namespace 64 65 66 /// Representation of a bytes quantity. 67 /// 68 /// The purpose of this class is to represent an amount of bytes in a semantic 69 /// manner, and to provide functions to format such numbers for nice user 70 /// presentation and to parse back such numbers. 71 /// 72 /// The input follows this regular expression: [0-9]+(|\.[0-9]+)[GgKkMmTt]? 73 /// The output follows this regular expression: [0-9]+\.[0-9]{3}[GKMT]? 74 class bytes { 75 /// Raw representation, in bytes, of the quantity. 76 uint64_t _count; 77 78 public: 79 bytes(void); 80 explicit bytes(const uint64_t); 81 82 static bytes parse(const std::string&); 83 std::string format(void) const; 84 85 operator uint64_t(void) const; 86 }; 87 88 89 std::istream& operator>>(std::istream&, bytes&); 90 std::ostream& operator<<(std::ostream&, const bytes&); 91 92 93 } // namespace units 94 } // namespace utils 95 96 #endif // !defined(UTILS_UNITS_HPP) 97