ui/base/text/bytes_formatting.h

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_BASE_TEXT_BYTES_FORMATTING_H_
   6 #define UI_BASE_TEXT_BYTES_FORMATTING_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/strings/string16.h"
  10 #include "ui/base/ui_base_export.h"
  11
  12 namespace ui {
  13
  14 // Simple API ------------------------------------------------------------------
  15
  16 // Simple call to return a byte quantity as a string in human-readable format.
  17 // Ex: FormatBytes(512) => "512 B"
  18 // Ex: FormatBytes(101479) => "99.1 kB"
  19 UI_BASE_EXPORT base::string16 FormatBytes(int64 bytes);
  20
  21 // Simple call to return a speed as a string in human-readable format.
  22 // Ex: FormatSpeed(512) => "512 B/s"
  23 // Ex: FormatSpeed(101479) => "99.1 kB/s"
  24 UI_BASE_EXPORT base::string16 FormatSpeed(int64 bytes);
  25
  26 // Less-Simple API -------------------------------------------------------------
  27
  28 enum DataUnits {
  29   DATA_UNITS_BYTE = 0,
  30   DATA_UNITS_KIBIBYTE,
  31   DATA_UNITS_MEBIBYTE,
  32   DATA_UNITS_GIBIBYTE,
  33   DATA_UNITS_TEBIBYTE,
  34   DATA_UNITS_PEBIBYTE
  35 };
  36
  37 // Return the unit type that is appropriate for displaying the amount of bytes
  38 // passed in. Most of the time, an explicit call to this isn't necessary; just
  39 // use FormatBytes()/FormatSpeed() above.
  40 UI_BASE_EXPORT DataUnits GetByteDisplayUnits(int64 bytes);
  41
  42 // Return a byte quantity as a string in human-readable format with an optional
  43 // unit suffix. Specify in the |units| argument the units to be used.
  44 // Ex: FormatBytes(512, DATA_UNITS_KIBIBYTE, true) => "0.5 kB"
  45 // Ex: FormatBytes(10*1024, DATA_UNITS_MEBIBYTE, false) => "0.1"
  46 UI_BASE_EXPORT base::string16 FormatBytesWithUnits(int64 bytes,
  47                                                    DataUnits units,
  48                                                    bool show_units);
  49
  50 // As above, but with "/s" units for speed values.
  51 // Ex: FormatSpeed(512, DATA_UNITS_KIBIBYTE, true) => "0.5 kB/s"
  52 // Ex: FormatSpeed(10*1024, DATA_UNITS_MEBIBYTE, false) => "0.1"
  53 base::string16 FormatSpeedWithUnits(int64 bytes,
  54                                     DataUnits units,
  55                                     bool show_units);
  56
  57 }  // namespace ui
  58
  59 #endif  // UI_BASE_TEXT_BYTES_FORMATTING_H_