blob: 00da679d7733bf2a961139144eb3e9ee72f5325b (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
//===-- MICmdArgSet.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
// Third party headers:
#include <vector>
// In-house headers:
#include "MICmnBase.h"
#include "MICmdArgContext.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 assummed 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.
// Gotchas: None.
// Authors: Illya Rudkin 14/04/2014.
// Changes: None.
//--
class CMICmdArgSet : public CMICmnBase
{
// Classes:
public:
//++
// Description: ArgSet's interface for command arguments to implement.
//--
class IArg
{
public:
virtual bool GetFound(void) const = 0;
virtual bool GetIsHandledByCmd(void) const = 0;
virtual bool GetIsMandatory(void) const = 0;
virtual bool GetIsMissingOptions(void) const = 0;
virtual const CMIUtilString &GetName(void) const = 0;
virtual bool GetValid(void) const = 0;
virtual bool Validate(CMICmdArgContext &vwArgContext) = 0;
/* dtor */ virtual ~IArg(void){};
};
// Typedefs:
public:
typedef std::vector<CMICmdArgValBase *> SetCmdArgs_t;
// Methods:
public:
/* ctor */ CMICmdArgSet(void);
bool Add(const CMICmdArgValBase &vArg);
bool GetArg(const CMIUtilString &vArgName, CMICmdArgValBase *&vpArg) const;
const SetCmdArgs_t &GetArgsThatAreMissing(void) const;
const SetCmdArgs_t &GetArgsThatInvalid(void) const;
MIuint GetCount(void) const;
bool IsArgContextEmpty(void) const;
bool IsArgsPresentButNotHandledByCmd(void) const;
void WarningArgsNotHandledbyCmdLogFile(const CMIUtilString &vrCmdName);
bool Validate(const CMIUtilString &vStrMiCmd, CMICmdArgContext &vwCmdArgsText);
// Overrideable:
public:
/* dtor */ virtual ~CMICmdArgSet(void);
// Methods:
private:
const SetCmdArgs_t &GetArgsNotHandledByCmd(void) const;
void
Destroy(void); // Release resources used by *this object
bool ValidationFormErrorMessages(const CMICmdArgContext &vwCmdArgsText);
// Attributes:
private:
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;
};
|
