scsl 0.1.1
Shimmering Clarity Standard Library
Classes | Namespaces | Enumerations | Functions
Flag.h File Reference

Flag declares a command-line flag parser. More...

#include <cstdint>
#include <functional>
#include <map>
#include <string>
#include <variant>
#include <vector>

Go to the source code of this file.

Classes

union  scsl::FlagValue
 
struct  scsl::Flag
 
class  scsl::Flags
 

Namespaces

namespace  scsl
 scsl is the top-level namespace containing all the code in this library.
 

Enumerations

enum class  scsl::FlagType : uint8_t {
  Unknown = 0 , Boolean = 1 , scsl::Integer = 2 , scsl::UnsignedInteger = 3 ,
  scsl::SizeT = 4 , String = 5
}
 FlagType indicates the value held in a FlagValue. More...
 
enum class  ParseStatus : uint8_t {
  Unknown = 0 , OK = 1 , EndOfFlags = 2 , NotRegistered = 3 ,
  NotEnoughArgs = 4
}
 

Functions

std::string scsl::ParseStatusToString (ParseStatus status)
 
Flag * scsl::NewFlag (FlagType fType, std::string fName, std::string fDescription)
 

Detailed Description

Flag declares a command-line flag parser.

Flag defines a command-line flag parser.

Author
kyle \created 2023-10-12

COPYRIGHT

Copyright 2023 K. Isom kyle@.nosp@m.imap.nosp@m..cc

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all /// copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.