OCCT

// Created on: 2015-03-15
// Created by: Danila ULYANOV
// Copyright (c) 2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#include <ViewerTest_CmdParser.hxx>

#include <Draw.hxx>
#include <Message.hxx>
#include <ViewerTest.hxx>

#include <algorithm>
#include <iostream>
#include <limits>

namespace
{

//! Converts the given string to lowercase
//! @param theString the string to be converted
//! @return a converted string (a string in lowercase)
static std::string toLowerCase(std::string theString)
{
  std::transform(theString.begin(), theString.end(), theString.begin(), ::LowerCase);
  return theString;
}

//! Converts the vector of std::strings to a vector of pointers to its data
//! @param theStringList the vector of strings to be converted
//! @return a vector of pointers to the data of given strings
static std::vector<const char*> convertToRawStringList(
  const std::vector<std::string>& theStringList)
{
  const std::size_t        aListSize = theStringList.size();
  std::vector<const char*> aRawStringList(aListSize);
  for (std::size_t anIndex = 0; anIndex < aListSize; ++anIndex)
  {
    aRawStringList[anIndex] = theStringList[anIndex].c_str();
  }
  return aRawStringList;
}

} // namespace

const std::size_t ViewerTest_CmdParser::THE_UNNAMED_COMMAND_OPTION_KEY =
  (std::numeric_limits<std::size_t>::max)();

const std::size_t ViewerTest_CmdParser::THE_HELP_COMMAND_OPTION_KEY = 0;

//=================================================================================================

ViewerTest_CmdParser::ViewerTest_CmdParser(const std::string& theDescription)
    : myDescription(theDescription)
{
  AddOption("help|h", "Prints a short description of the command and its options.");
}

//=================================================================================================

ViewerTest_CommandOptionKey ViewerTest_CmdParser::AddOption(const std::string& theOptionNames,
                                                            const std::string& theOptionDescription)
{
  CommandOption aNewOption;

  // extract option names
  std::vector<std::string> aNames;
  std::stringstream        aStream(theOptionNames);
  std::string              anItem;
  while (std::getline(aStream, anItem, '|'))
  {
    if (!anItem.empty())
    {
      aNames.push_back(anItem);
    }
  }

  aNewOption.Name = aNames.front();
  if (aNames.size() > 1)
  {
    const std::size_t aNumberOfAliases = aNames.size() - 1;

    aNewOption.Aliases.reserve(aNumberOfAliases);
    std::copy(aNames.begin() + 1, aNames.end(), std::back_inserter(aNewOption.Aliases));
  }
  aNewOption.Description = theOptionDescription;

  const ViewerTest_CommandOptionKey aNewOptionKey = myOptionStorage.size();

  myOptionStorage.push_back(aNewOption);

  std::vector<std::string>::const_iterator anIt = aNames.begin();
  for (; anIt != aNames.end(); ++anIt)
  {
    const std::string aNameInLowerCase = toLowerCase(*anIt);

    myOptionMap[aNameInLowerCase] = aNewOptionKey;
  }

  return aNewOptionKey;
}

//=================================================================================================

void ViewerTest_CmdParser::PrintHelp() const
{
  std::cout << myDescription << '\n';
  std::vector<CommandOption>::const_iterator anIt = myOptionStorage.begin();
  for (++anIt; anIt != myOptionStorage.end(); ++anIt)
  {
    const CommandOption& aCommandOption = *anIt;
    std::cout << "\n\t-" << aCommandOption.Name;
    const OptionAliases& anAliases = aCommandOption.Aliases;
    if (!anAliases.empty())
    {
      std::cout << " (-" << anAliases.front();
      for (OptionAliases::const_iterator anAliasIterator = anAliases.begin() + 1;
           anAliasIterator != anAliases.end();
           ++anAliasIterator)
      {
        std::cout << ", -" << *anAliasIterator;
      }
      std::cout << ")";
    }
    std::cout << " : " << aCommandOption.Description;
  }
  std::cout << '\n';
}

//=================================================================================================

void ViewerTest_CmdParser::Parse(const int theArgsNb, const char* const* const theArgVec)
{
  std::size_t aCurrentUsedOptionIndex = 0;
  for (int anIter = 1; anIter < theArgsNb; ++anIter)
  {
    const char* const anArgument = theArgVec[anIter];
    if (anArgument[0] == '-' && !std::isdigit(anArgument[1]))
    {
      const std::string   anOptionName = toLowerCase(anArgument + 1);
      OptionMap::iterator aMapIter     = myOptionMap.find(anOptionName);
      if (aMapIter != myOptionMap.end())
      {
        const ViewerTest_CommandOptionKey aCurrentUsedOptionKey = aMapIter->second;
        aCurrentUsedOptionIndex = addUsedOption(aCurrentUsedOptionKey);
      }
      else
      {
        Message::SendFail() << "Error: unknown argument '" << anOptionName << "'";
        return;
      }
    }
    else
    {
      if (anIter == 1)
      {
        aCurrentUsedOptionIndex = addUsedOption(THE_UNNAMED_COMMAND_OPTION_KEY);
      }
      myOptionArgumentStorage[aCurrentUsedOptionIndex].push_back(anArgument);
    }
  }
}

//=================================================================================================

std::string ViewerTest_CmdParser::GetOptionNameByKey(
  const ViewerTest_CommandOptionKey theOptionKey) const
{
  if (theOptionKey == THE_UNNAMED_COMMAND_OPTION_KEY)
  {
    return "Unnamed";
  }
  return myOptionStorage[theOptionKey].Name;
}

//=================================================================================================

ViewerTest_CommandOptionKeySet ViewerTest_CmdParser::GetUsedOptions() const
{
  ViewerTest_CommandOptionKeySet aUsedOptions;
  for (UsedOptionMap::const_iterator aUsedOptionMapIterator = myUsedOptionMap.begin();
       aUsedOptionMapIterator != myUsedOptionMap.end();
       ++aUsedOptionMapIterator)
  {
    aUsedOptions.insert(aUsedOptionMapIterator->first);
  }
  return aUsedOptions;
}

//=================================================================================================

bool ViewerTest_CmdParser::HasNoOption() const
{
  return myUsedOptionMap.empty();
}

//=================================================================================================

bool ViewerTest_CmdParser::HasUnnamedOption() const
{
  return myUsedOptionMap.find(THE_UNNAMED_COMMAND_OPTION_KEY) != myUsedOptionMap.end();
}

//=================================================================================================

bool ViewerTest_CmdParser::HasOnlyUnnamedOption() const
{
  return HasUnnamedOption() && (myUsedOptionMap.size() == 1);
}

//=================================================================================================

bool ViewerTest_CmdParser::HasOption(const std::string& theOptionName,
                                     const std::size_t  theMandatoryArgsNb /* = 0 */,
                                     const bool         isFatal /* = false */) const
{
  ViewerTest_CommandOptionKey anOptionKey;
  if (!findOptionKey(theOptionName, anOptionKey))
  {
    return false;
  }
  return HasOption(anOptionKey, theMandatoryArgsNb, isFatal);
}

//=================================================================================================

bool ViewerTest_CmdParser::HasOption(const ViewerTest_CommandOptionKey theOptionKey,
                                     const std::size_t                 theMandatoryArgsNb /* = 0 */,
                                     const bool                        isFatal /* = false */) const
{
  std::size_t aUsedOptionIndex = 0;
  if (!findUsedOptionIndex(theOptionKey, aUsedOptionIndex))
  {
    return false;
  }
  const OptionArguments& anOptionArguments = myOptionArgumentStorage[aUsedOptionIndex];
  const bool             aResult           = (anOptionArguments.size() >= theMandatoryArgsNb);
  if (isFatal && !aResult)
  {
    Message::SendFail() << "Error: wrong syntax at option '" << myOptionStorage[theOptionKey].Name
                        << "'\n"
                        << "At least " << theMandatoryArgsNb << "expected, but only "
                        << anOptionArguments.size() << "provided.";
  }
  return aResult;
}

//=================================================================================================

int ViewerTest_CmdParser::GetNumberOfOptionArguments(const std::string& theOptionName) const
{
  ViewerTest_CommandOptionKey anOptionKey = THE_UNNAMED_COMMAND_OPTION_KEY;
  if (!findOptionKey(theOptionName, anOptionKey))
  {
    return 0;
  }
  return GetNumberOfOptionArguments(anOptionKey);
}

//=================================================================================================

int ViewerTest_CmdParser::GetNumberOfOptionArguments(
  const ViewerTest_CommandOptionKey theOptionKey) const
{
  std::size_t aUsedOptionIndex = 0;
  if (!findUsedOptionIndex(theOptionKey, aUsedOptionIndex))
  {
    return false;
  }
  return static_cast<int>(myOptionArgumentStorage[aUsedOptionIndex].size());
}

//=================================================================================================

bool ViewerTest_CmdParser::Arg(const std::string& theOptionName,
                               const int          theArgumentIndex,
                               std::string&       theOptionArgument) const
{
  Standard_ASSERT_RETURN(theArgumentIndex >= 0,
                         "'theArgumentIndex' must be greater than or equal to zero.",
                         false);
  ViewerTest_CommandOptionKey anOptionKey = THE_UNNAMED_COMMAND_OPTION_KEY;
  if (!theOptionName.empty() && !findOptionKey(theOptionName, anOptionKey))
  {
    return false;
  }
  return Arg(anOptionKey, theArgumentIndex, theOptionArgument);
}

//=================================================================================================

bool ViewerTest_CmdParser::Arg(const ViewerTest_CommandOptionKey theOptionKey,
                               const int                         theArgumentIndex,
                               std::string&                      theOptionArgument) const
{
  Standard_ASSERT_RETURN(theArgumentIndex >= 0,
                         "'theArgumentIndex' must be greater than or equal to zero.",
                         false);
  std::size_t aUsedOptionIndex = 0;
  if (!findUsedOptionIndex(theOptionKey, aUsedOptionIndex))
  {
    return false;
  }
  const OptionArguments& anOptionArguments = myOptionArgumentStorage[aUsedOptionIndex];
  if (static_cast<std::size_t>(theArgumentIndex) >= anOptionArguments.size())
  {
    return false;
  }
  theOptionArgument = anOptionArguments[theArgumentIndex];
  return true;
}

//=================================================================================================

std::string ViewerTest_CmdParser::Arg(const std::string& theOptionName,
                                      const int          theArgumentIndex) const
{
  Standard_ASSERT_RETURN(theArgumentIndex >= 0,
                         "'theArgumentIndex' must be greater than or equal to zero.",
                         std::string());
  std::string anOptionArgument;
  if (!Arg(theOptionName, theArgumentIndex, anOptionArgument))
  {
    return std::string();
  }
  return anOptionArgument;
}

//=================================================================================================

std::string ViewerTest_CmdParser::Arg(const ViewerTest_CommandOptionKey theOptionKey,
                                      const int                         theArgumentIndex) const
{
  std::string anOptionArgument;
  if (!Arg(theOptionKey, theArgumentIndex, anOptionArgument))
  {
    return std::string();
  }
  return anOptionArgument;
}

//=================================================================================================

NCollection_Vec3<float> ViewerTest_CmdParser::ArgVec3f(const std::string& theOptionName,
                                                       int                theArgumentIndex) const
{
  return NCollection_Vec3<float>(
    static_cast<float>(Draw::Atof(Arg(theOptionName, theArgumentIndex).c_str())),
    static_cast<float>(Draw::Atof(Arg(theOptionName, theArgumentIndex + 1).c_str())),
    static_cast<float>(Draw::Atof(Arg(theOptionName, theArgumentIndex + 2).c_str())));
}

//=================================================================================================

NCollection_Vec3<double> ViewerTest_CmdParser::ArgVec3d(const std::string& theOptionName,
                                                        int                theArgumentIndex) const
{
  return NCollection_Vec3<double>(Draw::Atof(Arg(theOptionName, theArgumentIndex).c_str()),
                                  Draw::Atof(Arg(theOptionName, theArgumentIndex + 1).c_str()),
                                  Draw::Atof(Arg(theOptionName, theArgumentIndex + 2).c_str()));
}

//=================================================================================================

gp_Vec ViewerTest_CmdParser::ArgVec(const std::string& theOptionName, int theArgumentIndex) const
{
  return gp_Vec(Draw::Atof(Arg(theOptionName, theArgumentIndex).c_str()),
                Draw::Atof(Arg(theOptionName, theArgumentIndex + 1).c_str()),
                Draw::Atof(Arg(theOptionName, theArgumentIndex + 2).c_str()));
}

//=================================================================================================

gp_Pnt ViewerTest_CmdParser::ArgPnt(const std::string& theOptionName, int theArgumentIndex) const
{
  return gp_Pnt(Draw::Atof(Arg(theOptionName, theArgumentIndex).c_str()),
                Draw::Atof(Arg(theOptionName, theArgumentIndex + 1).c_str()),
                Draw::Atof(Arg(theOptionName, theArgumentIndex + 2).c_str()));
}

//=================================================================================================

double ViewerTest_CmdParser::ArgDouble(const std::string& theOptionName, int theArgumentIndex) const
{
  return Draw::Atof(Arg(theOptionName, theArgumentIndex).c_str());
}

//=================================================================================================

float ViewerTest_CmdParser::ArgFloat(const std::string& theOptionName, int theArgumentIndex) const
{
  return static_cast<float>(Draw::Atof(Arg(theOptionName, theArgumentIndex).c_str()));
}

//=================================================================================================

int ViewerTest_CmdParser::ArgInt(const std::string& theOptionName, const int theArgumentIndex) const
{
  return static_cast<int>(Draw::Atoi(Arg(theOptionName, theArgumentIndex).c_str()));
}

//=================================================================================================

bool ViewerTest_CmdParser::ArgBool(const std::string& theOptionName,
                                   const int          theArgumentIndex) const
{
  return Draw::Atoi(Arg(theOptionName, theArgumentIndex).c_str()) != 0;
}

//=================================================================================================

template <typename TheColor>
bool ViewerTest_CmdParser::ArgColor(const std::string& theOptionName,
                                    int&               theArgumentIndex,
                                    TheColor&          theColor) const
{
  ViewerTest_CommandOptionKey anOptionKey;
  if (!findOptionKey(theOptionName, anOptionKey))
  {
    return false;
  }
  return ArgColor(anOptionKey, theArgumentIndex, theColor);
}

//! ViewerTest_CmdParser::ArgColor() explicit template instantiation definitions
template bool ViewerTest_CmdParser::ArgColor(const std::string& theOptionName,
                                             int&               theArgumentIndex,
                                             Quantity_Color&    theColor) const;

template bool ViewerTest_CmdParser::ArgColor(const std::string&  theOptionName,
                                             int&                theArgumentIndex,
                                             Quantity_ColorRGBA& theColor) const;

//=================================================================================================

template <typename TheColor>
bool ViewerTest_CmdParser::ArgColor(const ViewerTest_CommandOptionKey theOptionKey,
                                    int&                              theArgumentIndex,
                                    TheColor&                         theColor) const
{
  std::size_t aUsedOptionIndex = 0;
  if (!findUsedOptionIndex(theOptionKey, aUsedOptionIndex))
  {
    return false;
  }
  const RawStringArguments aRawStringArguments = getRawStringArguments(aUsedOptionIndex);
  const int                aNumberOfArguments  = static_cast<int>(aRawStringArguments.size());
  Standard_ASSERT_RETURN(
    theArgumentIndex < aNumberOfArguments,
    "'theArgumentIndex' must be less than the number of command-line arguments "
    "passed with the option which access key is 'theOptionKey'.",
    false);
  const int aNumberOfAvailableArguments = aNumberOfArguments - theArgumentIndex;
  TheColor  aColor;
  const int aNumberOfParsedArguments =
    Draw::ParseColor(aNumberOfAvailableArguments, &aRawStringArguments[theArgumentIndex], aColor);
  if (aNumberOfParsedArguments == 0)
  {
    return false;
  }
  theArgumentIndex += aNumberOfParsedArguments;
  theColor = aColor;
  return true;
}

//! ViewerTest_CmdParser::ArgColor() explicit template instantiation definitions
template bool ViewerTest_CmdParser::ArgColor(ViewerTest_CommandOptionKey theOptionKey,
                                             int&                        theArgumentIndex,
                                             Quantity_Color&             theColor) const;

template bool ViewerTest_CmdParser::ArgColor(ViewerTest_CommandOptionKey theOptionKey,
                                             int&                        theArgumentIndex,
                                             Quantity_ColorRGBA&         theColor) const;

//=================================================================================================

bool ViewerTest_CmdParser::findOptionKey(const std::string&           theOptionName,
                                         ViewerTest_CommandOptionKey& theOptionKey) const
{
  const std::string               anOptionNameInLowercase = toLowerCase(theOptionName);
  const OptionMap::const_iterator aMapIter = myOptionMap.find(anOptionNameInLowercase);
  if (aMapIter == myOptionMap.end())
  {
    return false;
  }
  theOptionKey = aMapIter->second;
  return true;
}

//=================================================================================================

bool ViewerTest_CmdParser::findUsedOptionIndex(const ViewerTest_CommandOptionKey theOptionKey,
                                               std::size_t& theUsedOptionIndex) const
{
  const UsedOptionMap::const_iterator aUsedOptionIterator = myUsedOptionMap.find(theOptionKey);
  if (aUsedOptionIterator == myUsedOptionMap.end())
  {
    return false;
  }
  theUsedOptionIndex = aUsedOptionIterator->second;
  return true;
}

//=================================================================================================

bool ViewerTest_CmdParser::findUsedOptionIndex(const std::string& theOptionName,
                                               std::size_t&       theUsedOptionIndex) const
{
  ViewerTest_CommandOptionKey anOptionKey = THE_UNNAMED_COMMAND_OPTION_KEY;
  if (!findOptionKey(theOptionName, anOptionKey))
  {
    return false;
  }
  std::size_t aUsedOptionIndex = 0;
  if (!findUsedOptionIndex(anOptionKey, aUsedOptionIndex))
  {
    return false;
  }
  theUsedOptionIndex = aUsedOptionIndex;
  return true;
}

//=================================================================================================

std::size_t ViewerTest_CmdParser::addUsedOption(
  const ViewerTest_CommandOptionKey theNewUsedOptionKey)
{
  const std::size_t aNewUsedOptionIndex = myOptionArgumentStorage.size();
  myOptionArgumentStorage.push_back(OptionArguments());
  myUsedOptionMap[theNewUsedOptionKey] = aNewUsedOptionIndex;
  return aNewUsedOptionIndex;
}

//=================================================================================================

ViewerTest_CmdParser::RawStringArguments ViewerTest_CmdParser::getRawStringArguments(
  const std::size_t theUsedOptionIndex) const
{
  Standard_ASSERT_RETURN(
    theUsedOptionIndex < myOptionArgumentStorage.size(),
    "'theUsedOptionIndex' must be less than the size of 'myOptionArgumentStorage'.",
    RawStringArguments());
  const OptionArguments& anOptionArguments = myOptionArgumentStorage[theUsedOptionIndex];
  return convertToRawStringList(anOptionArguments);
}