Files
PhysX4.1/physx/samples/sampleframework/framework/include/SampleCommandLine.h
2025-11-28 23:13:44 +05:30

99 lines
4.1 KiB
C++

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// * Neither the name of NVIDIA CORPORATION nor the names of its
// contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2021 NVIDIA Corporation. All rights reserved.
#ifndef SAMPLE_COMMANDLINE_H
#define SAMPLE_COMMANDLINE_H
#include <assert.h>
namespace SampleFramework
{
// Container for command-line arguments.
// This class assumes argument 0 is always the executable path!
class SampleCommandLine
{
public:
//! commandLineFilePathFallback is an optional fall-back to a configuration file containing command line arguments.
// Its contents are only processed and used if the other constructor arguments yield only an executable path.
// This is especially useful in the case of an Andriod platform, which does not support command line options.
// e.g. commandLineFilePathFallback = "commandline.txt"
// e.g. contents of commandline.txt = --argument1 --argument2
SampleCommandLine(unsigned int argc, const char *const* argv, const char * commandLineFilePathFallback = 0);
SampleCommandLine(const char *args, const char * commandLineFilePathFallback = 0);
~SampleCommandLine(void);
//! has a given command-line switch?
// e.g. s=="foo" checks for -foo
bool hasSwitch(const char *s, const unsigned int argNum = invalidArgNum) const;
//! gets the value of a switch...
// e.g. s="foo" returns "bar" if '-foo=bar' is in the commandline.
const char* getValue(const char *s, unsigned int argNum = invalidArgNum) const;
// return how many command line arguments there are
unsigned int getNumArgs(void) const;
// what is the program name
const char* getProgramName(void) const;
// get the string that contains the unsued args
unsigned int unusedArgsBufSize(void) const;
// get the string that contains the unsued args
const char* getUnusedArgs(char *buf, unsigned int bufSize) const;
//! if the first argument is the given command.
bool isCommand(const char *s) const;
//! get the first argument assuming it isn't a switch.
// e.g. for the command-line "myapp.exe editor -foo" it will return "editor".
const char *getCommand(void) const;
//! get the raw command-line argument list...
unsigned int getArgC(void) const { return m_argc; }
const char *const*getArgV(void) const { return m_argv; }
//! whether or not an argument has been read already
bool isUsed(unsigned int argNum) const;
private:
SampleCommandLine(const SampleCommandLine&);
SampleCommandLine(void);
SampleCommandLine operator=(const SampleCommandLine&);
void initCommon(const char * commandLineFilePathFallback);
unsigned int m_argc;
const char *const *m_argv;
void *m_freeme;
static const unsigned int invalidArgNum = 0xFFFFFFFFU;
bool* m_argUsed;
};
} // namespace SampleFramework
#endif // SAMPLE_COMMANDLINE_H