Parameter.hpp

Go to the documentation of this file.

/* Copyright 2022 - 2026 R. Thomas
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef LIEF_DWARF_PARAMETER_H
#define LIEF_DWARF_PARAMETER_H
 
#include "LIEF/DWARF/Location.hpp"
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/visibility.h"
 
#include <string_view>
#include <cstdint>
#include <memory>
#include <vector>
 
 
namespace LIEF::dwarf {
 
class Type;
 
namespace details {
class Parameter;
}

class LIEF_API Parameter {
  public:
  enum class KIND {
    UNKNOWN = 0,
    TEMPLATE_TYPE,  
    TEMPLATE_VALUE, 
    FORMAL,         
  };

  using Location = dwarf::Location;

  using RegisterLoc = dwarf::RegisterLoc;

  using CompositeLocation = dwarf::CompositeLocation;
 
  Parameter() = delete;
  Parameter(Parameter&& other) noexcept;
  Parameter& operator=(Parameter&& other) noexcept;
  Parameter& operator=(const Parameter&) = delete;
  Parameter(const Parameter&) = delete;
 
 
  KIND kind() const;

  std::string_view name() const LIEF_LIFETIMEBOUND;

  std::unique_ptr<Type> type() const LIEF_LIFETIMEBOUND;

  std::unique_ptr<Location> location() const;

  std::unique_ptr<Location> location(uint64_t pc) const;

  std::vector<LocationEntry> locations() const;
 
  template<class T>
  const T* as() const {
    if (T::classof(this)) {
      return static_cast<const T*>(this);
    }
    return nullptr;
  }
 
  virtual ~Parameter();
 
  LIEF_LOCAL static std::unique_ptr<Parameter>
      create(std::unique_ptr<details::Parameter> impl);
 
  protected:
  Parameter(std::unique_ptr<details::Parameter> impl);
  std::unique_ptr<details::Parameter> impl_;
};
 
namespace parameters {

class LIEF_API Formal : public Parameter {
  public:
  using Parameter::Parameter;
  static bool classof(const Parameter* P) {
    return P->kind() == Parameter::KIND::FORMAL;
  }
 
  ~Formal() override = default;
};
 

class LIEF_API TemplateValue : public Parameter {
  public:
  using Parameter::Parameter;
  static bool classof(const Parameter* P) {
    return P->kind() == Parameter::KIND::TEMPLATE_VALUE;
  }
 
  ~TemplateValue() override = default;
};

class LIEF_API TemplateType : public Parameter {
  public:
  using Parameter::Parameter;
  static bool classof(const Parameter* P) {
    return P->kind() == Parameter::KIND::TEMPLATE_TYPE;
  }
 
  ~TemplateType() override = default;
};
 
}
 
}
 
#endif