support.h

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   This program 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 2, or (at your option)
   any later version.
 
   This program 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.
***********************************************************************/
 
#ifndef FC__SUPPORT_H
#define FC__SUPPORT_H
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/***********************************************************************
  Replacements for functions which are not available on all platforms.
  Where the functions are available natively, these are just wrappers.
  See also mem.h, netintf.h, rand.h, and see support.c for more comments.
***********************************************************************/
 
#include <freeciv_config.h>
 
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>             /* size_t */
#include <sys/stat.h>
 
#ifdef FREECIV_HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
 
#ifdef TRUE
#undef TRUE
#endif
 
#ifdef FALSE
#undef FALSE
#endif
 
#define TRUE true
#define FALSE false
 
#ifdef __cplusplus
#ifndef FREECIV_HAVE_CXX_NULLPTR
#define nullptr 0
#endif
#else
#ifndef FREECIV_HAVE_C23_NULLPTR
#define nullptr NULL
#endif
#endif
 
#ifndef __cplusplus
#if __BEOS__
#include <posix/be_prim.h>
#define __bool_true_false_are_defined 1
#else
#ifdef FREECIV_HAVE_STDBOOL_H
#include <stdbool.h>
#else /* Implement <stdbool.h> ourselves */
#undef bool
#undef true
#undef false
#undef __bool_true_false_are_defined
#define bool unsigned int
#define true  1
#define false 0
#define __bool_true_false_are_defined 1
#endif /* ! FREECIV_HAVE_STDBOOL_H */
#endif /* ! __BEOS__ */
#endif /* __cplusplus */
 
/* intptr_t header */
/* Prefer full inttypes.h if present. */
#ifdef FREECIV_HAVE_INTTYPES_H
#include <inttypes.h>
#else
#ifdef FREECIV_HAVE_STDINT_H
#include <stdint.h>
#endif /* FREECIV_HAVE_STDINT_H */
#endif /* FREECIV_HAVE_INTTYPES_H */
 
/* Want to use GCC's __attribute__ keyword to check variadic
 * parameters to printf-like functions, without upsetting other
 * compilers: put any required defines magic here.
 * If other compilers have something equivalent, could also
 * work that out here.   Should this use configure stuff somehow?
 * --dwp
 */
#if defined(__GNUC__)
#define fc__attribute(x)  __attribute__(x)
#else
#define fc__attribute(x)
#endif
 
/* __attribute__((warn_unused_result)) requires at least gcc 3.4 */
#if defined(__GNUC__)
#if (__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
#define fc__warn_unused_result  __attribute__((warn_unused_result))
#endif
#endif
#ifndef fc__warn_unused_result
#define fc__warn_unused_result
#endif
 
/* TODO: C++17 compilers (also other than g++) could use [[fallthrough]]
   for C++ code */
#if defined(__GNUC__) && __GNUC__ >= 7
#define fc__fallthrough __attribute__((fallthrough))
#elif defined (__clang__) && __clang_major__ >= 12
#define fc__fallthrough __attribute__((fallthrough))
#else
#define fc__fallthrough
#endif
 
#if defined(__GNUC__) && __GNUC__ >= 5
#define fc__noreturn __attribute__((noreturn))
#else
#define fc__noreturn
#endif
 
#ifdef FREECIV_HAVE_UNREACHABLE
#define fc__unreachable(_cond_) \
  if (_cond_) {                 \
    __builtin_unreachable();    \
  }
#else  /* FREECIV_HAVE_UNREACHABLE */
#define fc__unreachable(_cond_) fc_assert(!(_cond_))
#endif /* FREECIV_HAVE_UNREACHABLE */
 
#ifdef FREECIV_MSWINDOWS
typedef long int fc_errno;
#else
typedef int fc_errno;
#endif
 
#ifdef FREECIV_RETURN_VALUE_AFTER_EXIT
#define RETURN_VALUE_AFTER_EXIT(_val_) return _val_ ;
#else
#define RETURN_VALUE_AFTER_EXIT(_val_)
#endif
 
#ifdef FREECIV_NO_CONST_VAR_ARG
#define VAR_ARG_CONST
#else
#define VAR_ARG_CONST const
#endif
 
int fc_strcasecmp(const char *str0, const char *str1);
int fc_strncasecmp(const char *str0, const char *str1, size_t n);
int fc_strncasequotecmp(const char *str0, const char *str1, size_t n);
 
/* TODO: Make UTF-8 aware */
#define fc_strncmp(_s1_, _s2_, _len_) strncmp(_s1_, _s2_, _len_)
 
void fc_support_init(void);
void fc_support_free(void);
bool are_support_services_available(void);
 
size_t effectivestrlenquote(const char *str);
 
char *fc_strcasestr(const char *haystack, const char *needle);
 
int fc_strcoll(const char *str0, const char *str1);
int fc_stricoll(const char *str0, const char *str1);
 
FILE *fc_fopen(const char *filename, const char *opentype);
#ifdef FREECIV_HAVE_LIBZ
#include <zlib.h>
gzFile fc_gzopen(const char *filename, const char *opentype);
#endif
int fc_remove(const char *filename);
int fc_stat(const char *filename, struct stat *buf);
 
fc_errno fc_get_errno(void);
const char *fc_strerror(fc_errno err);
void fc_usleep(unsigned long usec);
 
bool fc_strrep(char *str, size_t len, const char *search,
               const char *replace);
char *fc_strrep_resize(char *str, size_t *len, const char *search,
                       const char *replace)
                       fc__warn_unused_result;
 
size_t fc_strlcpy(char *dest, const char *src, size_t n);
size_t fc_strlcat(char *dest, const char *src, size_t n);
 
/* Convenience macros for use when dest is a char ARRAY: */
#define sz_strlcpy(dest,src) ((void) fc_strlcpy((dest), (src), sizeof(dest)))
#define sz_strlcat(dest,src) ((void) fc_strlcat((dest), (src), sizeof(dest)))
 
int fc_snprintf(char *str, size_t n, const char *format, ...)
     fc__attribute((__format__ (__printf__, 3, 4)))
     fc__attribute((nonnull (1, 3)));
int fc_vsnprintf(char *str, size_t n, const char *format, va_list ap )
     fc__attribute((nonnull (1, 3)));
int cat_snprintf(char *str, size_t n, const char *format, ...)
     fc__attribute((__format__ (__printf__, 3, 4)))
     fc__attribute((nonnull (1, 3)));
 
int fc_gethostname(char *buf, size_t len);
 
#ifdef FREECIV_SOCKET_ZERO_NOT_STDIN
/* Support for console I/O in case FREECIV_SOCKET_ZERO_NOT_STDIN. */
void fc_init_console(void);
char *fc_read_console(void);
#endif /* FREECIV_SOCKET_ZERO_NOT_STDIN */
 
bool is_reg_file_for_access(const char *name, bool write_access);
 
int fc_break_lines(char *str, size_t desired_len);
 
bool fc_isalnum(char c);
bool fc_isalpha(char c);
bool fc_isdigit(char c);
bool fc_isprint(char c);
bool fc_isspace(char c);
bool fc_isupper(char c);
char fc_toupper(char c);
char fc_tolower(char c);
 
const char *fc_basename(const char *path);
 
struct tm *fc_localtime(const time_t *timep, struct tm *result);
 
/************************************************************************/
static inline bool is_bigendian(void)
{
#ifdef WORDS_BIGENDIAN
  return TRUE;
#else  /* WORDS_BIGENDIAN */
  return FALSE;
#endif /* WORDS_BIGENDIAN */
}
 
void make_escapes(const char *str, char *buf, size_t buf_len);
void remove_escapes(const char *str, bool full_escapes,
                    char *buf, size_t buf_len);
 
int fc_at_quick_exit(void (*func)(void));
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* FC__SUPPORT_H */