readargs.c

Go to the documentation of this file.

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*                                                                           */
/*                  This file is part of the program and library             */
/*         SCIP --- Solving Constraint Integer Programs                      */
/*                                                                           */
/*  Copyright (c) 2002-2025 Zuse Institute Berlin (ZIB)                      */
/*                                                                           */
/*  Licensed under the Apache License, Version 2.0 (the "License");          */
/*  you may not use this file except in compliance with the License.         */
/*  You may obtain a copy of the License at                                  */
/*                                                                           */
/*      http://www.apache.org/licenses/LICENSE-2.0                           */
/*                                                                           */
/*  Unless required by applicable law or agreed to in writing, software      */
/*  distributed under the License is distributed on an "AS IS" BASIS,        */
/*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/*  See the License for the specific language governing permissions and      */
/*  limitations under the License.                                           */
/*                                                                           */
/*  You should have received a copy of the Apache-2.0 license                */
/*  along with SCIP; see the file LICENSE. If not visit scipopt.org.         */
/*                                                                           */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
/**@file   readargs.c
 * @brief  read comand line arguments
 * @author Marc Pfetsch
 */
 
#include "readargs.h"
 
 
/** get problem name
 *
 *  Returns 0 if maxsize is not sufficient and 1 otherwise.
 */
int getProblemName(
   const char*           filename,           /**< file name */
   char*                 probname,           /**< name of problem (output) */
   int                   maxsize             /**< max length of problem name */
   )
{
   int result = 1;
   int i = 0;
   int l;
   int j;
 
   /* first find end of string */
   while ( filename[i] != 0)
      ++i;
   l = i; /* end of string */
 
   /* if we found ".gz" */
   if ( l > 3 && filename[l-3] == '.' && filename[l-2] == 'g' && filename[l-1] == 'z' )
   {
      l -= 4;
      i = l;
   }
 
   /* go back until '.' or '/' appears */
   while (i > 0 && filename[i] != '.' && filename[i] != '/')
      --i;
   assert( i > 0 );
 
   /* if we found '.', search for '/' */
   if ( filename[i] == '.' )
   {
      l = i;
      while ( i > 0 && filename[i] != '/' )
         --i;
   }
 
   /* correct counter */
   if ( filename[i] == '/' )
      ++i;
 
   /* copy name */
   j = 0;
   while ( i < l && filename[i] != 0 )
   {
      probname[j++] = filename[i++];
      if ( j >= maxsize-1 )
      {
         result = 0;
         break;
      }
   }
   probname[j] = 0;
 
   return result;
}
 
 
/** read comand line arguments */
SCIP_RETCODE readArguments(
   int                   argc,               /**< number of shell parameters */
   char**                argv,               /**< array with shell parameters */
   const char**          filename,           /**< file name from arguments */
   const char**          settingsname,       /**< name of settings file */
   SCIP_Real*            timelimit,          /**< time limit read from arguments */
   SCIP_Real*            memlimit,           /**< memory limit read from arguments */
   SCIP_Longint*         nodelimit,          /**< node limit read from arguments */
   int*                  dispfreq            /**< display frequency */
   )
{
   int i;
   char usage[SCIP_MAXSTRLEN];
#ifndef NDEBUG
   int status;
#endif
 
   assert( argc > 0 );
   assert( argv != NULL );
   assert( filename != NULL );
   assert( settingsname != NULL );
   assert( timelimit != NULL );
   assert( memlimit != NULL );
   assert( nodelimit != NULL );
   assert( dispfreq != NULL );
 
   /* init usage text */
#ifndef NDEBUG
   status = SCIPsnprintf(usage, SCIP_MAXSTRLEN, "usage: %s <file> [-s <setting file>] [-t <time limit>] [-m <mem limit>] [-n <node limit>] [-d <display frequency>]", argv[0]);
   assert( 0 <= status && status < SCIP_MAXSTRLEN );
#else
   (void) SCIPsnprintf(usage, SCIP_MAXSTRLEN, "usage: %s <file> [-s <setting file>] [-t <time limit>] [-m <mem limit>] [-n <node limit>] [-d <display frequency>]", argv[0]);
#endif
 
   /* init arguments */
   *timelimit = 1e20;
   *memlimit = 1e20;
   *nodelimit = SCIP_LONGINT_MAX;
   *filename = NULL;
   *settingsname = NULL;
   *dispfreq = -1;
 
   /* check all arguments */
   for (i = 1; i < argc; ++i)
   {
      /* check for settings */
      if ( strcmp(argv[i], "-s") == 0 )
      {
         if ( *settingsname != NULL )
         {
            (void) fprintf(stderr, "Error: Setting name already supplied.\n");
            (void) fprintf(stderr, "%s\n", usage);
            return SCIP_INVALIDDATA;
         }
         if ( i == argc-1 )
         {
            fprintf(stderr, "Error: No setting file name supplied.\n");
            fprintf(stderr, "%s\n", usage);
            return SCIP_INVALIDDATA;
         }
         ++i;
         *settingsname = argv[i];
         assert( i < argc );
      }
      else
      {
         /* check for time limit */
         if ( strcmp(argv[i], "-t") == 0 )
         {
            if ( i == argc-1 )
            {
               fprintf(stderr, "Erro: No time limit supplied.\n");
               fprintf(stderr, "%s\n", usage);
               return SCIP_INVALIDDATA;
            }
            ++i;
            *timelimit = atof(argv[i]);
            assert( i < argc );
         }
         else
         {
            /* check for memory limit */
            if ( strcmp(argv[i], "-m") == 0 )
            {
               if ( i == argc-1 )
               {
                  fprintf(stderr, "Error: No memory limit supplied.\n");
                  fprintf(stderr, "%s\n", usage);
                  return SCIP_INVALIDDATA;
               }
               ++i;
               *memlimit = atof(argv[i]);
               assert( i < argc );
            }
            else
            {
               /* check for memory limit */
               if ( strcmp(argv[i], "-n") == 0 )
               {
                  if ( i == argc-1 )
                  {
                     fprintf(stderr, "Error: No node limit supplied.\n");
                     fprintf(stderr, "%s\n", usage);
                     return SCIP_INVALIDDATA;
                  }
                  ++i;
                  *nodelimit = atol(argv[i]);
                  assert( i < argc );
               }
               else
               {
                  /* check for display frequency */
                  if ( strcmp(argv[i], "-d") == 0 )
                  {
                     if ( i == argc-1 )
                     {
                        fprintf(stderr, "Error: No display frequency supplied.\n");
                        fprintf(stderr, "%s\n", usage);
                        return SCIP_INVALIDDATA;
                     }
                     ++i;
                     *dispfreq = atoi(argv[i]);
                     assert( i < argc );
                  }
                  else
                  {
                     /* if filename is already specified */
                     if ( *filename != NULL )
                     {
                        fprintf(stderr, "Error: file name already specified.\n");
                        fprintf(stderr, "%s\n", usage);
                        return SCIP_ERROR;
                     }
                     *filename = argv[i];
                  }
               }
            }
         }
      }
   }
 
   if ( *filename == NULL )
   {
      fprintf(stderr, "Error: No filename supplied.\n");
      fprintf(stderr, "%s\n", usage);
      return SCIP_INVALIDDATA;
   }
 
   return SCIP_OKAY;
}