deprecations.c

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.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif /* HAVE_CONFIG_H */
 
#include "fc_prehdrs.h"
 
#include <stdarg.h>
 
/* utility */
#include "log.h"
#include "shared.h"
 
#include "deprecations.h"
 
static deprecation_warn_callback depr_cb = nullptr;
 
static bool depr_warns_enabled = FALSE;
 
static char depr_pending[1024] = "";
 
/********************************************************************/
void deprecation_warnings_enable(void)
{
  depr_warns_enabled = TRUE;
 
  if (depr_pending[0] != '\0') {
    do_log_deprecation("%s", depr_pending);
    depr_pending[0] = '\0';
  }
}
 
/********************************************************************/
bool are_deprecation_warnings_enabled(void)
{
  return depr_warns_enabled;
}
 
/********************************************************************/
void deprecation_warn_cb_set(deprecation_warn_callback new_cb)
{
  depr_cb = new_cb;
}
 
/********************************************************************/
void do_log_deprecation(const char *format, ...)
{
  va_list args;
  char buf[1024];
 
  va_start(args, format);
  vdo_log(__FILE__, __FUNCTION__, __FC_LINE__, FALSE, LOG_DEPRECATION,
          buf, sizeof(buf), format, args);
  if (depr_cb != nullptr) {
    depr_cb(buf);
  }
  va_end(args);
}
 
/********************************************************************/
void deprecation_pending(const char *format, ...)
{
  va_list args;
 
  va_start(args, format);
  fc_vsnprintf(depr_pending, sizeof(depr_pending), format, args);
  va_end(args);
 
  if (depr_warns_enabled) {
    /* Enabled already. Log */
    do_log_deprecation("%s", depr_pending);
    depr_pending[0] = '\0';
  }
}