ComRef.h

/*
 * This file is part of OpenModelica.
 *
 * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC),
 * c/o Linköpings universitet, Department of Computer and Information Science,
 * SE-58183 Linköping, Sweden.
 *
 * All rights reserved.
 *
 * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF AGPL VERSION 3 LICENSE OR
 * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
 * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
 *
 * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
 * Public License (OSMC-PL) are obtained from OSMC, either from the above
 * address, from the URLs:
 * http://www.openmodelica.org or
 * https://github.com/OpenModelica/ or
 * http://www.ida.liu.se/projects/OpenModelica,
 * and in the OpenModelica distribution.
 *
 * GNU AGPL version 3 is obtained from:
 * https://www.gnu.org/licenses/licenses.html#GPL
 *
 * This program is distributed WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
 * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
 *
 * See the full OSMC Public License conditions for more details.
 *
 */

#ifndef _OMS_COM_REF_H_
#define _OMS_COM_REF_H_

#include <string>

namespace oms
{
  /**
   * \brief ComRef - component reference
   *
   * A component reference is a qualified name of a component. It uses
   * '.' as component separator. It may also contain a ':' followed by
   * a suffix string which is used to define attributes or filenames.
   */
  class ComRef
  {
  public:
    ComRef();
    ComRef(const std::string& path);
    ComRef(const char* path);
    ~ComRef();

    // methods to copy the component reference
    ComRef(const ComRef& copy);
    ComRef& operator=(const ComRef& copy);
    ComRef operator+(const ComRef& rhs) const; ///< return ComRef(lhs + rhs) - Obs! lhs will lose its suffix

    static bool isValidIdent(const std::string& ident);
    bool isValidIdent() const;

    bool isEmpty() const;
    bool isRootOf(ComRef child) const;

    ComRef front() const; ///< returns the first part of the ComRef (including suffix if its the only part)
    ComRef back() const; ///< returns the last part of the ComRef (including suffix if its the only part)
    ComRef pop_front(); ///< returns the first part of the ComRef and removed it from the current object

    std::string suffix() const; ///< returns the suffix as string
    std::string pop_suffix(); ///< returns the suffix as string and removes it from the current object
    bool pop_suffix(const std::string& suffix);

    bool hasSuffix() const; ///< returns true if the cref has a suffix, i.e. contains ":"
    bool hasSuffix(const std::string& suffix) const; ///< returns true if the cref has a suffix that matches the argument

    const char* c_str() const { return cref; }
    size_t size() const;
    operator std::string() const { return std::string(cref); }

  private:
    char* cref;
  };

  bool operator==(const ComRef& lhs, const ComRef& rhs);
  bool operator!=(const ComRef& lhs, const ComRef& rhs);
  bool operator<(const ComRef& lhs, const ComRef& rhs);
}

namespace std
{
  template <>
  struct hash<oms::ComRef>
  {
    size_t operator()(const oms::ComRef& cref) const
    {
      return hash<std::string>()(std::string(cref));
    }
  };
}

#endif