add a "deprecated" command style for flagging future removed commands

This commit is contained in:
Axel Kohlmeyer
2018-10-05 17:23:09 +02:00
parent b02d3b1b94
commit 43ae9656d7
4 changed files with 124 additions and 1 deletions

48
src/deprecated.cpp Normal file
View File

@ -0,0 +1,48 @@
/* ----------------------------------------------------------------------
LAMMPS - Large-scale Atomic/Molecular Massively Parallel Simulator
http://lammps.sandia.gov, Sandia National Laboratories
Steve Plimpton, sjplimp@sandia.gov
Copyright (2003) Sandia Corporation. Under the terms of Contract
DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains
certain rights in this software. This software is distributed under
the GNU General Public License.
See the README file in the top-level LAMMPS directory.
------------------------------------------------------------------------- */
/* ----------------------------------------------------------------------
Contributing authors: Axel Kohlmeyer (Temple U),
------------------------------------------------------------------------- */
#include <cstring>
#include "deprecated.h"
#include "comm.h"
#include "force.h"
#include "error.h"
#include "input.h"
using namespace LAMMPS_NS;
static void writemsg(LAMMPS *lmp, const char *msg, int abend=1)
{
if (lmp->comm->me == 0) {
if (lmp->screen) fputs(msg,lmp->screen);
if (lmp->logfile) fputs(msg,lmp->logfile);
}
if (abend)
lmp->error->all(FLERR,"This command is no longer available");
}
/* ---------------------------------------------------------------------- */
void Deprecated::command(int narg, char **arg)
{
if (strcmp(input->command,"deprecated") == 0) {
writemsg(lmp,"\nCommand 'deprecated' is a dummy command\n\n",0);
} else if (strcmp(input->command,"XXX") == 0) {
writemsg(lmp, "\nCommand 'XXX' has been removed from LAMMPS "
"after the\n## XXX 20## stable release.\n\n");
}
}