Files
@ r20134:837df448e71c
Branch filter:
Location: cpp/openttd-patchpack/source/src/strings_func.h
r20134:837df448e71c
6.5 KiB
text/x-c
(svn r25107) -Change: be slightly more lenient with trying to detect a subversion repository in case someone has a sparse tags checkout. In that case the .svn folder misses from the $ROOT_DIR because it is in the $ROOT_DIR/.. (i.e. tags) folder
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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 | /* $Id$ */
/*
* This file is part of OpenTTD.
* OpenTTD 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, version 2.
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file strings_func.h Functions related to OTTD's strings. */
#ifndef STRINGS_FUNC_H
#define STRINGS_FUNC_H
#include "strings_type.h"
#include "string_type.h"
#include "gfx_type.h"
class StringParameters {
StringParameters *parent; ///< If not NULL, this instance references data from this parent instance.
uint64 *data; ///< Array with the actual data.
WChar *type; ///< Array with type information about the data. Can be NULL when no type information is needed. See #StringControlCode.
public:
uint offset; ///< Current offset in the data/type arrays.
uint num_param; ///< Length of the data array.
/** Create a new StringParameters instance. */
StringParameters(uint64 *data, uint num_param, WChar *type) :
parent(NULL),
data(data),
type(type),
offset(0),
num_param(num_param)
{ }
/** Create a new StringParameters instance. */
template <size_t Tnum_param>
StringParameters(int64 (&data)[Tnum_param]) :
parent(NULL),
data((uint64 *)data),
type(NULL),
offset(0),
num_param(Tnum_param)
{
assert_compile(sizeof(data[0]) == sizeof(uint64));
}
/**
* Create a new StringParameters instance that can reference part of the data of
* the given partent instance.
*/
StringParameters(StringParameters &parent, uint size) :
parent(&parent),
data(parent.data + parent.offset),
offset(0),
num_param(size)
{
assert(size <= parent.num_param - parent.offset);
if (parent.type == NULL) {
this->type = NULL;
} else {
this->type = parent.type + parent.offset;
}
}
~StringParameters()
{
if (this->parent != NULL) {
this->parent->offset += this->num_param;
}
}
void ClearTypeInformation();
int64 GetInt64(WChar type = 0);
/** Read an int32 from the argument array. @see GetInt64. */
int32 GetInt32(WChar type = 0)
{
return (int32)this->GetInt64(type);
}
void ShiftParameters(uint amount);
/** Get a pointer to the current element in the data array. */
uint64 *GetDataPointer() const
{
return &this->data[this->offset];
}
/** Get a pointer to a specific element in the data array. */
uint64 *GetPointerToOffset(uint offset) const
{
assert(offset < this->num_param);
return &this->data[offset];
}
/** Does this instance store information about the type of the parameters. */
bool HasTypeInformation() const
{
return this->type != NULL;
}
/** Get the type of a specific element. */
WChar GetTypeAtOffset(uint offset) const
{
assert(offset < this->num_param);
assert(this->HasTypeInformation());
return this->type[offset];
}
void SetParam(uint n, uint64 v)
{
assert(n < this->num_param);
this->data[n] = v;
}
uint64 GetParam(uint n) const
{
assert(n < this->num_param);
return this->data[n];
}
};
extern StringParameters _global_string_params;
char *InlineString(char *buf, StringID string);
char *GetString(char *buffr, StringID string, const char *last);
char *GetStringWithArgs(char *buffr, StringID string, StringParameters *args, const char *last, uint case_index = 0, bool game_script = false);
const char *GetStringPtr(StringID string);
uint ConvertKmhishSpeedToDisplaySpeed(uint speed);
uint ConvertDisplaySpeedToKmhishSpeed(uint speed);
void InjectDParam(uint amount);
/**
* Set a string parameter \a v at index \a n in a given array \a s.
* @param s Array of string parameters.
* @param n Index of the string parameter.
* @param v Value of the string parameter.
*/
static inline void SetDParamX(uint64 *s, uint n, uint64 v)
{
s[n] = v;
}
/**
* Set a string parameter \a v at index \a n in the global string parameter array.
* @param n Index of the string parameter.
* @param v Value of the string parameter.
*/
static inline void SetDParam(uint n, uint64 v)
{
_global_string_params.SetParam(n, v);
}
void SetDParamMaxValue(uint n, uint64 max_value, uint min_count = 0);
void SetDParamMaxDigits(uint n, uint count);
void SetDParamStr(uint n, const char *str);
void CopyInDParam(int offs, const uint64 *src, int num);
void CopyOutDParam(uint64 *dst, int offs, int num);
void CopyOutDParam(uint64 *dst, const char **strings, StringID string, int num);
/**
* Get the current string parameter at index \a n from parameter array \a s.
* @param s Array of string parameters.
* @param n Index of the string parameter.
* @return Value of the requested string parameter.
*/
static inline uint64 GetDParamX(const uint64 *s, uint n)
{
return s[n];
}
/**
* Get the current string parameter at index \a n from the global string parameter array.
* @param n Index of the string parameter.
* @return Value of the requested string parameter.
*/
static inline uint64 GetDParam(uint n)
{
return _global_string_params.GetParam(n);
}
extern TextDirection _current_text_dir; ///< Text direction of the currently selected language
void InitializeLanguagePacks();
const char *GetCurrentLanguageIsoCode();
int CDECL StringIDSorter(const StringID *a, const StringID *b);
/**
* A searcher for missing glyphs.
*/
class MissingGlyphSearcher {
public:
/** Make sure everything gets destructed right. */
virtual ~MissingGlyphSearcher() {}
/**
* Get the next string to search through.
* @return The next string or NULL if there is none.
*/
virtual const char *NextString() = 0;
/**
* Get the default (font) size of the string.
* @return The font size.
*/
virtual FontSize DefaultSize() = 0;
/**
* Reset the search, i.e. begin from the beginning again.
*/
virtual void Reset() = 0;
/**
* Whether to search for a monospace font or not.
* @return True if searching for monospace.
*/
virtual bool Monospace() = 0;
/**
* Set the right font names.
* @param settings The settings to modify.
* @param font_name The new font name.
*/
virtual void SetFontNames(struct FreeTypeSettings *settings, const char *font_name) = 0;
bool FindMissingGlyphs(const char **str);
};
void CheckForMissingGlyphs(bool base_font = true, MissingGlyphSearcher *search = NULL);
#endif /* STRINGS_FUNC_H */
|