ParameterOption.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ParameterOption.h                                           (C) 2000-2025 */
/*                                                                           */
/* Class representing the set of parameters that can modify the              */
/* data set options.                                                         */
/*---------------------------------------------------------------------------*/
 
#ifndef ARCANE_UTILS_INTERNAL_PARAMETEROPTION_H
#define ARCANE_UTILS_INTERNAL_PARAMETEROPTION_H
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/UtilsTypes.h"
#include "arcane/utils/String.h"
#include "arcane/utils/List.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_UTILS_EXPORT
ParameterOptionAddrPart
{
 public:
 
  static constexpr const char* ANY_TAG = "/";
  static constexpr Integer ANY_INDEX = -1;
  static constexpr Integer GET_INDEX = -2;
 
 public:

  ParameterOptionAddrPart();

  explicit ParameterOptionAddrPart(const StringView tag);

  ParameterOptionAddrPart(const StringView tag, const Integer index);
 
 public:
 
  StringView tag() const;
  Integer index() const;

  void setTag(const StringView tag);
  void setIndex(const Integer index);

  bool isAny() const;

  bool operator==(const ParameterOptionAddrPart& other) const;
  // TODO AH: To be removed when migrating to C++20.
  bool operator!=(const ParameterOptionAddrPart& other) const;
 
 private:
 
  StringView m_tag;
  Integer m_index;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_UTILS_EXPORT
ParameterOptionAddr
{
 public:

  explicit ParameterOptionAddr(StringView addr_str_view);
 
 public:
 
  // We must not block multiple ParameterOptionAddrPart(ANY):
  // Construction by iteration: aaaa/bb/ANY/ANY/cc
  void addAddrPart(ParameterOptionAddrPart* part);

  ParameterOptionAddrPart* addrPart(const Integer index_of_part) const;
 
  ParameterOptionAddrPart* lastAddrPart() const;

  Integer nbAddrPart() const;

  bool getIndexInAddr(const ParameterOptionAddr& addr_with_get_index, ArrayView<Integer> indexes) const;

  Integer nbIndexToGetInAddr() const;
 
 public:

  bool operator==(const ParameterOptionAddr& other) const;
 
  // TODO AH: To be removed when migrating to C++20.
  bool operator!=(const ParameterOptionAddr& other) const;
 
 private:
 
  UniqueArray<Ref<ParameterOptionAddrPart>> m_parts;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_UTILS_EXPORT
ParameterOptionElement
{
 public:
 
  ParameterOptionElement(const StringView addr, const StringView value);
 
  ParameterOptionAddr addr() const;
 
  StringView value() const;
 
  bool operator==(const ParameterOptionAddr& addr) const;
 
 private:
 
  ParameterOptionAddr m_addr;
  StringView m_value;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_UTILS_EXPORT
ParameterOptionElementsCollection
{
 public:

  void addParameter(const String& parameter, const String& value);
 
  void addElement(StringView addr, StringView value);
 
  // ParameterOptionElement element(const Integer index)
  // {
  //   return m_elements[index];
  // }
 
  // An empty StringView is equal to a null StringView.
  // Since we are working with Strings and the distinction
  // empty/null is important, we use std::optional.
  std::optional<StringView> value(const ParameterOptionAddr& addr);

  bool isExistAddr(const ParameterOptionAddr& addr);

  Integer countAddr(const ParameterOptionAddr& addr);

  void getIndexInAddr(const ParameterOptionAddr& addr_with_get_index, UniqueArray<Integer>& indexes);
 
 private:
 
  UniqueArray<ParameterOptionElement> m_elements;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif