2946cd7010
to reflect the new license. We understand that people may be surprised that we're moving the header entirely to discuss the new license. We checked this carefully with the Foundation's lawyer and we believe this is the correct approach. Essentially, all code in the project is now made available by the LLVM project under our new license, so you will see that the license headers include that license only. Some of our contributors have contributed code under our old license, and accordingly, we have retained a copy of our old license notice in the top-level files in each project and repository. llvm-svn: 351636
108 lines
4.4 KiB
C++
108 lines
4.4 KiB
C++
//===-- MICmdArgSet.h -------------------------------------------*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#pragma once
|
|
|
|
#include <vector>
|
|
|
|
#include "MICmdArgContext.h"
|
|
#include "MICmnBase.h"
|
|
|
|
// Declarations:
|
|
class CMICmdArgValBase;
|
|
|
|
//++
|
|
//============================================================================
|
|
// Details: MI common code class. Command arguments container class.
|
|
// A command may have one or more arguments of which some may be
|
|
// optional.
|
|
// *this class contains a list of the command's arguments which are
|
|
// validates against the commands argument options string (context
|
|
// string).
|
|
// Each argument tries to extract the value it is looking for.
|
|
// Argument objects added to *this container are owned by this
|
|
// container
|
|
// and are deleted when this container goes out of scope. Allocate
|
|
// argument
|
|
// objects on the heap.
|
|
// It is assumed the arguments to be parsed are read from left to right
|
|
// in
|
|
// order. The order added to *this container is the order they will
|
|
// parsed.
|
|
//--
|
|
class CMICmdArgSet : public CMICmnBase {
|
|
// Classes:
|
|
public:
|
|
//++
|
|
// Description: ArgSet's interface for command arguments to implement.
|
|
//--
|
|
class IArg {
|
|
public:
|
|
virtual bool GetFound() const = 0;
|
|
virtual bool GetIsHandledByCmd() const = 0;
|
|
virtual bool GetIsMandatory() const = 0;
|
|
virtual bool GetIsMissingOptions() const = 0;
|
|
virtual const CMIUtilString &GetName() const = 0;
|
|
virtual bool GetValid() const = 0;
|
|
virtual bool Validate(CMICmdArgContext &vwArgContext) = 0;
|
|
|
|
virtual ~IArg() = default;
|
|
};
|
|
|
|
// Typedefs:
|
|
typedef std::vector<CMICmdArgValBase *> SetCmdArgs_t;
|
|
|
|
// Methods:
|
|
CMICmdArgSet();
|
|
|
|
void Add(CMICmdArgValBase *vArg);
|
|
bool GetArg(const CMIUtilString &vArgName, CMICmdArgValBase *&vpArg) const;
|
|
const SetCmdArgs_t &GetArgsThatAreMissing() const;
|
|
const SetCmdArgs_t &GetArgsThatInvalid() const;
|
|
size_t GetCount() const;
|
|
bool IsArgContextEmpty() const;
|
|
bool IsArgsPresentButNotHandledByCmd() const;
|
|
void WarningArgsNotHandledbyCmdLogFile(const CMIUtilString &vrCmdName);
|
|
bool Validate(const CMIUtilString &vStrMiCmd,
|
|
CMICmdArgContext &vwCmdArgsText);
|
|
|
|
// Overrideable:
|
|
~CMICmdArgSet() override;
|
|
|
|
// Methods:
|
|
private:
|
|
const SetCmdArgs_t &GetArgsNotHandledByCmd() const;
|
|
void Destroy(); // Release resources used by *this object
|
|
bool ValidationFormErrorMessages(const CMICmdArgContext &vwCmdArgsText);
|
|
|
|
// Attributes:
|
|
bool m_bIsArgsPresentButNotHandledByCmd; // True = The driver's client
|
|
// presented the command with options
|
|
// recognised but not handled by
|
|
// a command, false = all args handled
|
|
SetCmdArgs_t m_setCmdArgs; // The set of arguments that are that the command
|
|
// is expecting to find in the options string
|
|
SetCmdArgs_t m_setCmdArgsThatAreMissing; // The set of arguments that are
|
|
// required by the command but are
|
|
// missing
|
|
SetCmdArgs_t m_setCmdArgsThatNotValid; // The set of arguments found in the
|
|
// text but for some reason unable to
|
|
// extract a value
|
|
SetCmdArgs_t m_setCmdArgsNotHandledByCmd; // The set of arguments specified by
|
|
// the command which were present to
|
|
// the command but not handled
|
|
SetCmdArgs_t m_setCmdArgsMissingInfo; // The set of arguments that were
|
|
// present but were found to be missing
|
|
// additional information i.e.
|
|
// --thread 3 but 3 is missing
|
|
CMICmdArgContext m_cmdArgContext; // Copy of the command's argument options
|
|
// text before validate takes place (empties
|
|
// it of content)
|
|
const CMIUtilString m_constStrCommaSpc;
|
|
};
|