1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/* Format.h
Copyright (c) 2014-2020 by Michael Zahniser
Endless Sky is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.
Endless Sky is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
*/
#pragma once
#include <cstdint>
#include <functional>
#include <map>
#include <string>
#include <vector>
// Collection of functions for formatting strings for display.
class Format {
public:
// Function to retrieve a condition's value. Receives a string that contains
// the condition name, and the start & size of the substring with the condition
// name.
using ConditionGetter = std::function<int64_t(const std::string &source, size_t start, size_t size)>;
public:
// Convert the given number into abbreviated format with a suffix like
// "M" for million, "B" for billion, or "T" for trillion. Any number
// above 1 quadrillion is instead shown in scientific notation.
static std::string Credits(int64_t value);
// Convert the given number into abbreviated format as described in Format::Credits,
// then attach the ' credit' or ' credits' suffix to it.
static std::string CreditString(int64_t value);
// Writes the given number into a string,
// then attach the ' ton' or ' tons' suffix to it.
static std::string MassString(double amount);
// Creates a string similar to '<amount> tons of <cargo>'.
static std::string CargoString(double amount, const std::string &cargo);
// Converts the integer to string, and adds the noun, pluralized if needed.
static std::string SimplePluralization(int amount, const std::string &noun);
// Convert a number of steps (1/60 sec each) to seconds.
static std::string StepsToSeconds(size_t steps);
// Convert a time in seconds to years/days/hours/minutes/seconds
static std::string PlayTime(double timeVal);
// Convert an ammo count into a short string for use in the ammo display.
// Only the absolute value of a negative number is considered.
static std::string AmmoCount(int64_t value);
// Convert the given number to a string, with at most one decimal place.
// This is primarily for displaying ship and outfit attributes.
static std::string Number(double value);
// Format the given value as a number with exactly the given number of
// decimal places (even if they are all 0).
static std::string Decimal(double value, int places);
// Convert numbers to word forms. Capitalize the first letter if at the start of a sentence.
static std::string WordForm(int64_t value, bool startOfSentence = false);
// Conditionally convert numbers to word forms, based on the Chicago Manual of Style.
static std::string ChicagoForm(int64_t value, bool startOfSentence = false);
// Conditionally convert numbers to word forms, based on the MLA Style guide.
static std::string MLAForm(int64_t value, bool startOfSentence = false);
// Convert a string into a number. As with the output of Number(), the
// string can have suffixes like "M", "B", etc.
static double Parse(const std::string &str);
// Replace a set of "keys," which must be strings in the form "<name>", with
// a new set of strings, and return the result.
static std::string Replace(const std::string &source, const std::map<std::string, std::string> &keys);
// Recursively expand substitutions in all key/value pairs. Will detect
// infinite recursion; offending substitutions will not be expanded.
static void Expand(std::map<std::string, std::string> &keys);
// Replace all occurrences of "target" with "replacement" in-place.
static void ReplaceAll(std::string &text, const std::string &target, const std::string &replacement);
// Convert a string to title caps or to lower case.
static std::string Capitalize(const std::string &str);
static std::string LowerCase(const std::string &str);
// Split a single string into substrings with the given separator.
static std::vector<std::string> Split(const std::string &str, const std::string &separator);
// Finds &[condition] and &[format@condition] in strings and expands them
static std::string ExpandConditions(const std::string &source, const ConditionGetter &getter);
// Function for the "find" dialogs:
static int Search(const std::string &str, const std::string &sub);
// Return a string containing the elements separated with commas and "and" where needed.
template<template<class...> class C, class... T>
static std::string List(const C<T...> &elements,
std::function<std::string(typename C<T...>::const_reference)> toString);
};
template<template<class...> class C, class... T>
std::string Format::List(const C<T...> &elements,
std::function<std::string(typename C<T...>::const_reference)> toString)
{
std::string result;
if(elements.empty())
return result;
auto it = elements.begin();
result = toString(*it);
std::advance(it, 1);
if(it == elements.end())
return result;
if(elements.size() == 2)
return result + " and " + toString(*it);
for( ; it != std::prev(elements.end()); std::advance(it, 1))
result += ", " + toString(*it);
return result + ", and " + toString(*it);
}
|
