mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 21:33:55 +00:00
110 lines
3.8 KiB
C++
110 lines
3.8 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
//
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
//============================================================================
|
|
#ifndef vtk_m_cont_Initialize_h
|
|
#define vtk_m_cont_Initialize_h
|
|
|
|
#include <vtkm/cont/DeviceAdapterTag.h>
|
|
#include <vtkm/cont/vtkm_cont_export.h>
|
|
#include <vtkm/internal/ExportMacros.h>
|
|
|
|
#include <string>
|
|
#include <type_traits>
|
|
#include <vector>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
struct InitializeResult
|
|
{
|
|
/// Device passed into --vtkm-device, or undefined
|
|
DeviceAdapterId Device = DeviceAdapterTagUndefined{};
|
|
|
|
/// Usage statement for arguments parsed by VTK-m
|
|
std::string Usage;
|
|
};
|
|
|
|
enum class InitializeOptions
|
|
{
|
|
None = 0x00,
|
|
|
|
/// Issue an error if the device argument is not specified.
|
|
RequireDevice = 0x01,
|
|
|
|
/// If no device is specified, treat it as if the user gave --vtkm-device=Any. This means that
|
|
/// DeviceAdapterTagUndefined will never be return in the result.
|
|
DefaultAnyDevice = 0x02,
|
|
|
|
/// Add a help argument. If -h or --vtkm-help is provided, prints a usage statement. Of course,
|
|
/// the usage statement will only print out arguments processed by VTK-m.
|
|
AddHelp = 0x04,
|
|
|
|
/// If an unknown option is encountered, the program terminates with an error and a usage
|
|
/// statement is printed. If this option is not provided, any unknown options are returned
|
|
/// in argv. If this option is used, it is a good idea to use AddHelp as well.
|
|
ErrorOnBadOption = 0x08,
|
|
|
|
/// If an extra argument is encountered, the program terminates with an error and a usage
|
|
/// statement is printed. If this option is not provided, any unknown arguments are returned
|
|
/// in argv.
|
|
ErrorOnBadArgument = 0x10,
|
|
|
|
/// If supplied, Initialize treats its own arguments as the only ones supported by the
|
|
/// application and provides an error if not followed exactly. This is a convenience
|
|
/// option that is a combination of ErrorOnBadOption, ErrorOnBadArgument, and AddHelp.
|
|
Strict = ErrorOnBadOption | ErrorOnBadArgument | AddHelp
|
|
};
|
|
|
|
// Allow options to be used as a bitfield
|
|
inline InitializeOptions operator|(const InitializeOptions& lhs, const InitializeOptions& rhs)
|
|
{
|
|
using T = std::underlying_type<InitializeOptions>::type;
|
|
return static_cast<InitializeOptions>(static_cast<T>(lhs) | static_cast<T>(rhs));
|
|
}
|
|
inline InitializeOptions operator&(const InitializeOptions& lhs, const InitializeOptions& rhs)
|
|
{
|
|
using T = std::underlying_type<InitializeOptions>::type;
|
|
return static_cast<InitializeOptions>(static_cast<T>(lhs) & static_cast<T>(rhs));
|
|
}
|
|
|
|
/**
|
|
* Initialize the VTKm library, parsing arguments when provided:
|
|
* - Sets log level names when logging is configured.
|
|
* - Sets the calling thread as the main thread for logging purposes.
|
|
* - Sets the default log level to the argument provided to --vtkm-log-level.
|
|
* - Forces usage of the device name passed to --vtkm-device.
|
|
* - Prints usage when -h or --vtkm-help is passed.
|
|
*
|
|
* The parameterless version only sets up log level names.
|
|
*
|
|
* Additional options may be supplied via the @a opts argument, such as
|
|
* requiring the --vtkm-device option.
|
|
*
|
|
* Results are available in the returned InitializeResult.
|
|
*
|
|
* @note This method may call exit() on parse error.
|
|
* @{
|
|
*/
|
|
VTKM_CONT_EXPORT
|
|
VTKM_CONT
|
|
InitializeResult Initialize(int& argc,
|
|
char* argv[],
|
|
InitializeOptions opts = InitializeOptions::None);
|
|
VTKM_CONT_EXPORT
|
|
VTKM_CONT
|
|
InitializeResult Initialize();
|
|
/**@}*/
|
|
}
|
|
} // end namespace vtkm::cont
|
|
|
|
|
|
#endif // vtk_m_cont_Initialize_h
|