PDB/types/Method.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_PDB_TYPE_METHOD_H
#define LIEF_PDB_TYPE_METHOD_H
 
#include "LIEF/visibility.h"
 
#include <string>
#include <memory>
#include <cstdint>
 
namespace LIEF {
namespace pdb {
class Type;
namespace types {
 
namespace details {
class Method;
class MethodIt;
}

class LIEF_API Method {
  public:
  class LIEF_API Iterator {
    public:
    using iterator_category = std::forward_iterator_tag;
    using value_type = std::unique_ptr<Method>;
    using difference_type = std::ptrdiff_t;
    using pointer = Method*;
    using reference = Method&;
    using implementation = details::MethodIt;
 
    class LIEF_API PointerProxy {
      // Inspired from LLVM's iterator_facade_base
      friend class Iterator;
      public:
      pointer operator->() const { return R.get(); }
 
      private:
      value_type R;
 
      template <typename RefT>
      PointerProxy(RefT &&R) : R(std::forward<RefT>(R)) {} // NOLINT(bugprone-forwarding-reference-overload)
    };
    Iterator(const Iterator&);
    Iterator(Iterator&&) noexcept;
    Iterator(std::unique_ptr<details::MethodIt> impl);
    ~Iterator();
 
    friend LIEF_API bool operator==(const Iterator& LHS, const Iterator& RHS);
 
    friend LIEF_API bool operator!=(const Iterator& LHS, const Iterator& RHS) {
      return !(LHS == RHS);
    }
 
    Iterator& operator++();
 
    Iterator operator++(int) {
      Iterator tmp = *static_cast<Iterator*>(this);
      ++*static_cast<Iterator *>(this);
      return tmp;
    }
 
    std::unique_ptr<Method> operator*() const;
 
    PointerProxy operator->() const {
      return static_cast<const Iterator*>(this)->operator*();
    }
 
    private:
    std::unique_ptr<details::MethodIt> impl_;
  };
  public:
  enum class TYPE {
    VANILLA = 0x00,                  
    VIRTUAL = 0x01,                  
    STATIC = 0x02,                   
    FRIEND = 0x03,                   
    INTRODUCING_VIRTUAL = 0x04,      
    PURE_VIRTUAL = 0x05,             
    PURE_INTRODUCING_VIRTUAL = 0x06  
  };

  enum class ACCESS : uint8_t {
    NONE = 0,      
    PRIVATE = 1,   
    PROTECTED = 2, 
    PUBLIC = 3     
  };
 
  Method(std::unique_ptr<details::Method> impl);

  std::string name() const;

  TYPE type() const;

  ACCESS access() const;
 
  ~Method();
 
  private:
  std::unique_ptr<details::Method> impl_;
};
 
}
}
}
#endif