utility/shared.h

   1 /***********************************************************************
   2  Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; either version 2, or (at your option)
   6    any later version.
   7
   8    This program is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11    GNU General Public License for more details.
  12 ***********************************************************************/
  13 #ifndef FC__SHARED_H
  14 #define FC__SHARED_H
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif /* __cplusplus */
  19
  20 #include <freeciv_config.h>
  21
  22 #include <stdlib.h>             /* size_t */
  23 #include <string.h>             /* memset */
  24 #include <time.h>               /* time_t */
  25
  26 /* utility */
  27 #include "log.h"
  28 #include "support.h" /* bool, fc__attribute */
  29
  30 /* Changing these will break network compatability! */
  31 #define MAX_LEN_ADDR     256    /* see also MAXHOSTNAMELEN and RFC 1123 2.1 */
  32 #define MAX_LEN_PATH    4095
  33
  34 /* Use FC_INFINITY to denote that a certain event will never occur or
  35    another unreachable condition. */
  36 #define FC_INFINITY     (1000 * 1000 * 1000)
  37
  38 #ifndef FREECIV_TESTMATIC
  39 /* Initialize something for the sole purpose of silencing false compiler warning
  40  * about variable possibly used uninitialized. */
  41 #define BAD_HEURISTIC_INIT(_ini_val_) = _ini_val_
  42 #else  /* FREECIV_TESTMATIC */
  43 #define BAD_HEURISTIC_INIT(_ini_val_)
  44 #endif /* FREECIV_TESTMATIC */
  45
  46 enum fc_tristate { TRI_NO, TRI_YES, TRI_MAYBE };
  47 #define BOOL_TO_TRISTATE(tri) ((tri) ? TRI_YES : TRI_NO)
  48
  49 enum fc_tristate fc_tristate_and(enum fc_tristate one,
  50                                  enum fc_tristate two);
  51
  52 #ifndef MAX
  53 #define MAX(x,y) (((x)>(y))?(x):(y))
  54 #define MIN(x,y) (((x)<(y))?(x):(y))
  55 #endif
  56 #define CLIP(lower,current,upper) \
  57     ((current)<(lower)?(lower):(current)>(upper)?(upper):(current))
  58
  59 #ifndef ABS
  60 #define ABS(x) (((x) >= 0) ? (x) : -(x))
  61 #endif
  62
  63 /* Note: Solaris already has a WRAP macro that is completely different. */
  64 #define FC_WRAP(value, range)                                               \
  65     ((value) < 0                                                            \
  66      ? ((value) % (range) != 0 ? (value) % (range) + (range) : 0)           \
  67      : ((value) >= (range) ? (value) % (range) : (value)))
  68
  69 #define BOOL_VAL(x) ((x) != 0)
  70 #define XOR(p, q) (BOOL_VAL(p) != BOOL_VAL(q))
  71 #define EQ(p, q) (BOOL_VAL(p) == BOOL_VAL(q))
  72
  73 /*
  74  * DIVIDE() divides and rounds down, rather than just divides and
  75  * rounds toward 0.  It is assumed that the divisor is positive.
  76  */
  77 #define DIVIDE(n, d) \
  78     ( (n) / (d) - (( (n) < 0 && (n) % (d) < 0 ) ? 1 : 0) )
  79
  80 /* This is duplicated in rand.h to avoid extra includes: */
  81 #define MAX_UINT32 0xFFFFFFFF
  82 #define MAX_UINT16 0xFFFF
  83 #define MAX_UINT8 0xFF
  84
  85 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
  86 #define ADD_TO_POINTER(p, n) ((void *)((char *)(p)+(n)))
  87
  88 #define FC_MEMBER(type, member) (((type *) NULL)->member)
  89 #define FC_MEMBER_OFFSETOF(type, member) ((size_t) &FC_MEMBER(type, member))
  90 #define FC_MEMBER_SIZEOF(type, member) sizeof(FC_MEMBER(type, member))
  91 #define FC_MEMBER_ARRAY_SIZE(type, member) \
  92   ARRAY_SIZE(FC_MEMBER(type, member))
  93
  94 #define FC_INT_TO_PTR(i) ((void *) (intptr_t) (i))
  95 #define FC_PTR_TO_INT(p) ((int) (intptr_t) (p))
  96 #define FC_UINT_TO_PTR(u) ((void *) (intptr_t) (u))
  97 #define FC_PTR_TO_UINT(p) ((unsigned int) (intptr_t) (p))
  98 #define FC_SIZE_TO_PTR(s) ((void *) (intptr_t) (s))
  99 #define FC_PTR_TO_SIZE(p) ((size_t) (intptr_t) (p))
 100
 101 /****************************************************************************
 102   Used to initialize an array 'a' of size 'size' with value 'val' in each
 103   element. Note that the value is evaluated for each element.
 104 ****************************************************************************/
 105 #define INITIALIZE_ARRAY(array, size, value)                                \
 106   {                                                                         \
 107     int _ini_index;                                                         \
 108                                                                             \
 109     for (_ini_index = 0; _ini_index < (size); _ini_index++) {               \
 110       (array)[_ini_index] = (value);                                        \
 111     }                                                                       \
 112   }
 113
 114 #ifndef PATH_SEPARATOR
 115 #if defined(FREECIV_MSWINDOWS) || defined(_WIN32) || defined(__WIN32__) || defined(__EMX__) || defined(__DJGPP__)
 116   /* Win32, OS/2, DOS */
 117 # define PATH_SEPARATOR ";"
 118 #else
 119   /* Unix */
 120 # define PATH_SEPARATOR ":"
 121 #endif
 122 #endif /* PATH_SEPARATOR */
 123
 124 #if defined(FREECIV_MSWINDOWS) || defined(_WIN32) || defined(__WIN32__) || defined(__EMX__) || defined(__DJGPP__)
 125   /* Win32, OS/2, DOS */
 126 # define DIR_SEPARATOR "\\"
 127 # define DIR_SEPARATOR_CHAR '\\'
 128 #else
 129   /* Unix */
 130 # define DIR_SEPARATOR_IS_DEFAULT
 131 # define DIR_SEPARATOR "/"
 132 # define DIR_SEPARATOR_CHAR '/'
 133 #endif
 134
 135 #define PARENT_DIR_OPERATOR ".."
 136
 137 char *create_centered_string(const char *s);
 138
 139 const char *big_int_to_text(unsigned int mantissa, unsigned int exponent);
 140 const char *int_to_text(unsigned int number);
 141
 142 bool is_ascii_name(const char *name);
 143 bool is_base64url(const char *s);
 144 bool is_safe_filename(const char *name);
 145 void randomize_base64url_string(char *s, size_t n);
 146
 147 int compare_strings(const void *first, const void *second);
 148 int compare_strings_ptrs(const void *first, const void *second);
 149 int compare_strings_strvec(const char *const *first,
 150                            const char *const *second);
 151
 152 char *skip_leading_spaces(char *s);
 153 void remove_leading_spaces(char *s);
 154 void remove_trailing_spaces(char *s);
 155 void remove_leading_trailing_spaces(char *s);
 156
 157 bool check_strlen(const char *str, size_t len, const char *errmsg);
 158 size_t loud_strlcpy(char *buffer, const char *str, size_t len,
 159                    const char *errmsg);
 160 /* Convenience macro. */
 161 #define sz_loud_strlcpy(buffer, str, errmsg) \
 162     loud_strlcpy(buffer, str, sizeof(buffer), errmsg)
 163
 164 char *end_of_strn(char *str, int *nleft);
 165
 166 bool str_to_int(const char *str, int *pint);
 167 bool str_to_float(const char *str, float *pfloat);
 168
 169 /**************************************************************************
 170 ...
 171 **************************************************************************/
 172 struct fileinfo {
 173   char *name;           /* descriptive file name string */
 174   char *fullname;       /* full absolute filename */
 175   time_t mtime;         /* last modification time  */
 176 };
 177
 178 #define SPECLIST_TAG fileinfo
 179 #define SPECLIST_TYPE struct fileinfo
 180 #include "speclist.h"
 181 #define fileinfo_list_iterate(list, pnode) \
 182   TYPED_LIST_ITERATE(struct fileinfo, list, pnode)
 183 #define fileinfo_list_iterate_end LIST_ITERATE_END
 184
 185 char *user_home_dir(void);
 186 void free_user_home_dir(void);
 187 char *user_username(char *buf, size_t bufsz);
 188
 189 const struct strvec *get_data_dirs(void);
 190 const struct strvec *get_save_dirs(void);
 191 const struct strvec *get_scenario_dirs(void);
 192
 193 void free_data_dir_names(void);
 194
 195 struct strvec *fileinfolist(const struct strvec *dirs, const char *suffix);
 196 struct fileinfo_list *fileinfolist_infix(const struct strvec *dirs,
 197                                          const char *infix, bool nodups);
 198 const char *fileinfoname(const struct strvec *dirs, const char *filename);
 199 void free_fileinfo_data(void);
 200
 201 void init_nls(void);
 202 void free_nls(void);
 203 char *setup_langname(void);
 204
 205 void dont_run_as_root(const char *argv0, const char *fallback);
 206
 207 /*** matching prefixes: ***/
 208
 209 enum m_pre_result {
 210   M_PRE_EXACT,          /* matches with exact length */
 211   M_PRE_ONLY,           /* only matching prefix */
 212   M_PRE_AMBIGUOUS,      /* first of multiple matching prefixes */
 213   M_PRE_EMPTY,          /* prefix is empty string (no match) */
 214   M_PRE_LONG,           /* prefix is too long (no match) */
 215   M_PRE_FAIL,           /* no match at all */
 216   M_PRE_LAST            /* flag value */
 217 };
 218
 219 const char *m_pre_description(enum m_pre_result result);
 220
 221 /* function type to access a name from an index: */
 222 typedef const char *(*m_pre_accessor_fn_t)(int);
 223
 224 /* function type to compare prefix: */
 225 typedef int (*m_pre_strncmp_fn_t)(const char *, const char *, size_t n);
 226
 227 /* function type to calculate effective string length: */
 228 typedef size_t (m_strlen_fn_t)(const char *str);
 229
 230 enum m_pre_result match_prefix(m_pre_accessor_fn_t accessor_fn,
 231                                size_t n_names,
 232                                size_t max_len_name,
 233                                m_pre_strncmp_fn_t cmp_fn,
 234                                m_strlen_fn_t len_fn,
 235                                const char *prefix,
 236                                int *ind_result);
 237 enum m_pre_result match_prefix_full(m_pre_accessor_fn_t accessor_fn,
 238                                     size_t n_names,
 239                                     size_t max_len_name,
 240                                     m_pre_strncmp_fn_t cmp_fn,
 241                                     m_strlen_fn_t len_fn,
 242                                     const char *prefix,
 243                                     int *ind_result,
 244                                     int *matches,
 245                                     int max_matches,
 246                                     int *pnum_matches);
 247
 248 char *get_multicast_group(bool ipv6_preferred);
 249 void free_multicast_group(void);
 250 void interpret_tilde(char* buf, size_t buf_size, const char* filename);
 251 char *interpret_tilde_alloc(const char* filename);
 252 char *skip_to_basename(char *filepath);
 253
 254 bool make_dir(const char *pathname);
 255 bool path_is_absolute(const char *filename);
 256
 257 char scanin(const char **buf, char *delimiters, char *dest, int size);
 258
 259 void array_shuffle(int *array, int n);
 260
 261 void format_time_duration(time_t t, char *buf, int maxlen);
 262
 263 bool wildcard_fit_string(const char *pattern, const char *test);
 264
 265 /* Custom format strings. */
 266 struct cf_sequence;
 267
 268 int fc_snprintcf(char *buf, size_t buf_len, const char *format, ...)
 269      fc__attribute((nonnull (1, 3)));   /* Not a printf format. */
 270 int fc_vsnprintcf(char *buf, size_t buf_len, const char *format,
 271                   const struct cf_sequence *sequences, size_t sequences_num)
 272      fc__attribute((nonnull (1, 3, 4)));
 273
 274 /* Tools for fc_snprintcf(). */
 275 static inline struct cf_sequence cf_bool_seq(char letter, bool value);
 276 static inline struct cf_sequence cf_trans_bool_seq(char letter, bool value);
 277 static inline struct cf_sequence cf_char_seq(char letter, char value);
 278 static inline void cf_int_seq(char letter, int value, struct cf_sequence *out);
 279 static inline struct cf_sequence cf_hexa_seq(char letter, int value);
 280 static inline struct cf_sequence cf_float_seq(char letter, float value);
 281 static inline struct cf_sequence cf_ptr_seq(char letter, const void *value);
 282 static inline struct cf_sequence cf_str_seq(char letter, const char *value);
 283 static inline struct cf_sequence cf_end(void);
 284
 285 enum cf_type {
 286   CF_BOOLEAN,
 287   CF_TRANS_BOOLEAN,
 288   CF_CHARACTER,
 289   CF_INTEGER,
 290   CF_HEXA,
 291   CF_FLOAT,
 292   CF_POINTER,
 293   CF_STRING,
 294
 295   CF_LAST = -1
 296 };
 297
 298 struct cf_sequence {
 299   enum cf_type type;
 300   char letter;
 301   union {
 302     bool bool_value;
 303     char char_value;
 304     int int_value;
 305     float float_value;
 306     const void *ptr_value;
 307     const char *str_value;
 308   };
 309 };
 310
 311 /****************************************************************************
 312   Build an argument for fc_snprintcf() of boolean type.
 313 ****************************************************************************/
 314 static inline struct cf_sequence cf_bool_seq(char letter, bool value)
 315 {
 316   struct cf_sequence sequence;
 317
 318   sequence.type = CF_BOOLEAN;
 319   sequence.letter = letter;
 320   sequence.bool_value = value;
 321
 322   return sequence;
 323 }
 324
 325 /****************************************************************************
 326   Build an argument for fc_snprintcf() of boolean type (result will be
 327   translated).
 328 ****************************************************************************/
 329 static inline struct cf_sequence cf_trans_bool_seq(char letter, bool value)
 330 {
 331   struct cf_sequence sequence;
 332
 333   sequence.type = CF_TRANS_BOOLEAN;
 334   sequence.letter = letter;
 335   sequence.bool_value = value;
 336
 337   return sequence;
 338 }
 339
 340 /****************************************************************************
 341   Build an argument for fc_snprintcf() of character type (%c).
 342 ****************************************************************************/
 343 static inline struct cf_sequence cf_char_seq(char letter, char value)
 344 {
 345   struct cf_sequence sequence;
 346
 347   sequence.type = CF_CHARACTER;
 348   sequence.letter = letter;
 349   sequence.char_value = value;
 350
 351   return sequence;
 352 }
 353
 354 /****************************************************************************
 355   Build an argument for fc_snprintcf() of integer type (%d).
 356 ****************************************************************************/
 357 static inline void cf_int_seq(char letter, int value, struct cf_sequence *out)
 358 {
 359   out->type = CF_INTEGER;
 360   out->letter = letter;
 361   out->int_value = value;
 362 }
 363
 364 /****************************************************************************
 365   Build an argument for fc_snprintcf() of hexadecimal type (%x).
 366 ****************************************************************************/
 367 static inline struct cf_sequence cf_hexa_seq(char letter, int value)
 368 {
 369   struct cf_sequence sequence;
 370
 371   sequence.type = CF_HEXA;
 372   sequence.letter = letter;
 373   sequence.int_value = value;
 374
 375   return sequence;
 376 }
 377
 378 /****************************************************************************
 379   Build an argument for fc_snprintcf() of float type (%f).
 380 ****************************************************************************/
 381 static inline struct cf_sequence cf_float_seq(char letter, float value)
 382 {
 383   struct cf_sequence sequence;
 384
 385   sequence.type = CF_FLOAT;
 386   sequence.letter = letter;
 387   sequence.float_value = value;
 388
 389   return sequence;
 390 }
 391
 392 /****************************************************************************
 393   Build an argument for fc_snprintcf() of pointer type (%p).
 394 ****************************************************************************/
 395 static inline struct cf_sequence cf_ptr_seq(char letter, const void *value)
 396 {
 397   struct cf_sequence sequence;
 398
 399   sequence.type = CF_POINTER;
 400   sequence.letter = letter;
 401   sequence.ptr_value = value;
 402
 403   return sequence;
 404 }
 405
 406 /****************************************************************************
 407   Build an argument for fc_snprintcf() of string type (%s).
 408 ****************************************************************************/
 409 static inline struct cf_sequence cf_str_seq(char letter, const char *value)
 410 {
 411   struct cf_sequence sequence;
 412
 413   sequence.type = CF_STRING;
 414   sequence.letter = letter;
 415   sequence.str_value = value;
 416
 417   return sequence;
 418 }
 419
 420 /****************************************************************************
 421   Must finish the list of the arguments of fc_snprintcf().
 422 ****************************************************************************/
 423 static inline struct cf_sequence cf_end(void)
 424 {
 425   struct cf_sequence sequence;
 426
 427   sequence.type = CF_LAST;
 428
 429   return sequence;
 430 }
 431
 432 bool formats_match(const char *format1, const char *format2);
 433
 434 #ifdef __cplusplus
 435 }
 436 #endif /* __cplusplus */
 437
 438 #endif  /* FC__SHARED_H */