A lot of comments in LLDB are surrounded by an ASCII line to delimit the begging and end of the comment. Its use is not really consistent across the code base, sometimes the lines are longer, sometimes they are shorter and sometimes they are omitted. Furthermore, it looks kind of weird with the 80 column limit, where the comment actually extends past the line, but not by much. Furthermore, when /// is used for Doxygen comments, it looks particularly odd. And when // is used, it incorrectly gives the impression that it's actually a Doxygen comment. I assume these lines were added to improve distinguishing between comments and code. However, given that todays editors and IDEs do a great job at highlighting comments, I think it's worth to drop this for the sake of consistency. The alternative is fixing all the inconsistencies, which would create a lot more churn. Differential revision: https://reviews.llvm.org/D60508 llvm-svn: 358135
122 lines
3.9 KiB
C++
122 lines
3.9 KiB
C++
//===-- MICmdArgValOptionShort.cpp ------------------------------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
// In-house headers:
|
|
#include "MICmdArgValOptionShort.h"
|
|
#include "MICmdArgContext.h"
|
|
|
|
//++
|
|
// Details: CMICmdArgValOptionShort constructor.
|
|
// Type: Method.
|
|
// Args: None.
|
|
// Return: None.
|
|
// Throws: None.
|
|
//--
|
|
CMICmdArgValOptionShort::CMICmdArgValOptionShort() {}
|
|
|
|
//++
|
|
// Details: CMICmdArgValOptionShort constructor.
|
|
// Type: Method.
|
|
// Args: vrArgName - (R) Argument's name to search by.
|
|
// vbMandatory - (R) True = Yes must be present, false = optional
|
|
// argument.
|
|
// vbHandleByCmd - (R) True = Command processes *this option, false =
|
|
// not handled.
|
|
// Return: None.
|
|
// Throws: None.
|
|
//--
|
|
CMICmdArgValOptionShort::CMICmdArgValOptionShort(const CMIUtilString &vrArgName,
|
|
const bool vbMandatory,
|
|
const bool vbHandleByCmd)
|
|
: CMICmdArgValOptionLong(vrArgName, vbMandatory, vbHandleByCmd) {}
|
|
|
|
//++
|
|
// Details: CMICmdArgValOptionLong constructor.
|
|
// Type: Method.
|
|
// Args: vrArgName - (R) Argument's name to search by.
|
|
// vbMandatory - (R) True = Yes must be present, false =
|
|
// optional argument.
|
|
// vbHandleByCmd - (R) True = Command processes *this option,
|
|
// false = not handled.
|
|
// veType - (R) The type of argument to look for and
|
|
// create argument object of a certain type.
|
|
// vnExpectingNOptions - (R) The number of options expected to read
|
|
// following *this argument.
|
|
// Return: None.
|
|
// Throws: None.
|
|
//--
|
|
CMICmdArgValOptionShort::CMICmdArgValOptionShort(
|
|
const CMIUtilString &vrArgName, const bool vbMandatory,
|
|
const bool vbHandleByCmd, const ArgValType_e veType,
|
|
const MIuint vnExpectingNOptions)
|
|
: CMICmdArgValOptionLong(vrArgName, vbMandatory, vbHandleByCmd, veType,
|
|
vnExpectingNOptions) {}
|
|
|
|
//++
|
|
// Details: CMICmdArgValOptionShort destructor.
|
|
// Type: Overridden.
|
|
// Args: None.
|
|
// Return: None.
|
|
// Throws: None.
|
|
//--
|
|
CMICmdArgValOptionShort::~CMICmdArgValOptionShort() {}
|
|
|
|
//++
|
|
// Details: Examine the string and determine if it is a valid short type option
|
|
// argument.
|
|
// Type: Method.
|
|
// Args: vrTxt - (R) Some text.
|
|
// Return: bool - True = yes valid arg, false = no.
|
|
// Throws: None.
|
|
//--
|
|
bool CMICmdArgValOptionShort::IsArgShortOption(
|
|
const CMIUtilString &vrTxt) const {
|
|
// Look for --someLongOption
|
|
MIint nPos = vrTxt.find("--");
|
|
if (nPos == 0)
|
|
return false;
|
|
|
|
// Look for -f short option
|
|
nPos = vrTxt.find('-');
|
|
if (nPos != 0)
|
|
return false;
|
|
|
|
if (vrTxt.length() > 2)
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
//++
|
|
// Details: Examine the string and determine if it is a valid short type option
|
|
// argument.
|
|
// Long type argument looks like -f some short option.
|
|
// Type: Overridden.
|
|
// Args: vrTxt - (R) Some text.
|
|
// Return: bool - True = yes valid arg, false = no.
|
|
// Throws: None.
|
|
//--
|
|
bool CMICmdArgValOptionShort::IsArgOptionCorrect(
|
|
const CMIUtilString &vrTxt) const {
|
|
return IsArgShortOption(vrTxt);
|
|
}
|
|
|
|
//++
|
|
// Details: Does the argument name of the argument being parsed ATM match the
|
|
// name of
|
|
// *this argument object.
|
|
// Type: Overridden.
|
|
// Args: vrTxt - (R) Some text.
|
|
// Return: bool - True = yes arg name matched, false = no.
|
|
// Throws: None.
|
|
//--
|
|
bool CMICmdArgValOptionShort::ArgNameMatch(const CMIUtilString &vrTxt) const {
|
|
const CMIUtilString strArg = vrTxt.substr(1);
|
|
return (strArg == GetName());
|
|
}
|