llvm-project/lldb/tools/lldb-mi/MICmdArgValNumber.h

//===-- MICmdArgValNumber.h -------------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#pragma once

// In-house headers:
#include "MICmdArgValBase.h"

// Declarations:
class CMICmdArgContext;

//++ ============================================================================
// Details: MI common code class. Command argument class. Arguments object
//          needing specialization derived from the CMICmdArgValBase class.
//          An argument knows what type of argument it is and how it is to
//          interpret the options (context) string to find and validate a matching
//          argument and so extract a value from it .
//          Based on the Interpreter pattern.
//--
class CMICmdArgValNumber : public CMICmdArgValBaseTemplate<MIint64>
{
    // Enums:
  public:
    //++ ---------------------------------------------------------------------------------
    // Details: CMICmdArgValNumber needs to know what format of argument to look for in
    //          the command options text.
    //--
    enum ArgValNumberFormat_e
    {
        eArgValNumberFormat_Decimal     = (1u << 0),
        eArgValNumberFormat_Hexadecimal = (1u << 1),
        eArgValNumberFormat_Auto        = ((eArgValNumberFormat_Hexadecimal << 1) - 1u)  ///< Indicates to try and lookup everything up during a query.
    };

    // Methods:
  public:
    /* ctor */ CMICmdArgValNumber(void);
    /* ctor */ CMICmdArgValNumber(const CMIUtilString &vrArgName, const bool vbMandatory, const bool vbHandleByCmd,
                                  const MIuint vnNumberFormatMask = eArgValNumberFormat_Decimal);
    //
    bool IsArgNumber(const CMIUtilString &vrTxt) const;

    // Overridden:
  public:
    // From CMICmdArgValBase
    /* dtor */ ~CMICmdArgValNumber(void) override;
    // From CMICmdArgSet::IArg
    bool Validate(CMICmdArgContext &vwArgContext) override;

    // Methods:
  private:
    bool ExtractNumber(const CMIUtilString &vrTxt);
    MIint64 GetNumber(void) const;

    // Attributes:
  private:
    MIuint m_nNumberFormatMask;
    MIint64 m_nNumber;
};