ResourceStringTable.hpp

Go to the documentation of this file.

/* Copyright 2017 - 2025 R. Thomas
 * Copyright 2017 - 2025 Quarkslab
 
 * 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_PE_RESOURCE_STRING_TABLE_H
#define LIEF_PE_RESOURCE_STRING_TABLE_H
#include <string>
#include <ostream>
 
#include "LIEF/visibility.h"
#include "LIEF/Object.hpp"
#include "LIEF/errors.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/optional.hpp"
 
namespace LIEF {
class BinaryStream;
namespace PE {
class LIEF_API ResourceStringTable : public Object {
  public:  struct entry_t {
    std::u16string key;
    std::u16string value;
    std::string key_u8() const;
    std::string value_u8() const;
 
    bool is_defined() const {
      return !key.empty() || !value.empty();
    }
 
    operator bool() const {
      return is_defined();
    }
 
    std::string to_string() const {
      return key_u8() + ": " + value_u8();
    }
 
    friend LIEF_API
      std::ostream& operator<<(std::ostream& os, const entry_t& entry)
    {
      os << entry.to_string();
      return os;
    }
  };

using entries_t = std::vector<entry_t>;

using it_entries = ref_iterator<entries_t&>;

using it_const_entries = const_ref_iterator<const entries_t&>;

ResourceStringTable() = default;

static result<ResourceStringTable> parse(BinaryStream& stream);

ResourceStringTable(const ResourceStringTable&) = default;

ResourceStringTable& operator=(const ResourceStringTable&) = default;

ResourceStringTable(ResourceStringTable&&) = default;

ResourceStringTable& operator=(ResourceStringTable&&) = default;

~ResourceStringTable() override = default;

const std::u16string& key() const {

return key_;

}