addr2ln_options.hpp

Go to the documentation of this file.

// ===-- include/addr2ln/addr2ln_options.hpp -------------- -*- C++ -*- --=== //
// Copyright (c) 2016 Matt Bisson.  All rights reserved.

#pragma once
#ifndef ADDR2LN_ADDR2LN_OPTIONS_HPP
#define ADDR2LN_ADDR2LN_OPTIONS_HPP

#include "addr2ln_ns.hpp"

#include <set>
#include <string>

#include <psystem/framework/memory.hpp>
#include <psystem/framework/not_copyable.hpp>

// Declare this so the friend relationship below will work
int main(int argc, char const *argv[]);

namespace addr2ln {

class addr2ln_options final
    : psystem::not_copyable
{
public:
    using address_list = std::set<psystem::address_t>;

    // Forward declaration of the PImpl details.
    struct options_data;

public:
    static psystem::address_t const *get_module_base_address() noexcept;

    static address_list const& get_address_list() noexcept;

    static std::string const& get_module_name() noexcept;

public:
    static void print_usage() noexcept;

    static void print_version_info() noexcept;

private:
    static void print_usage(const char *const prog_name) noexcept;

private:
    addr2ln_options(int argc, char const *argv[]);

public:
    ~addr2ln_options() noexcept;

private:
    static void dump_arguments(addr2ln_options::options_data const& d) noexcept;

    int try_switch(int i, int argc, char const *argv[]);

private:
    std::unique_ptr<options_data> m_data;

    // Doxygen doesn't parse "int ::main" (it sees "int::main").  Skip this bit.

    // Section 7.3.1.2 [namespace.memdef] --
    // "If a friend declaration in a nonlocal class first declares a class or
    // function, the friend class or function is a member of the innermost
    // enclosing namespace."
    //
    // Since we don't want to mysteriously inject main() into the addr2ln
    // namespace, we make sure to declare it above, and be explicit about the
    // global namespace.
    friend int ::main(int argc, char const *argv[]);
};

} // namespace addr2ln

#endif // ADDR2LN_ADDR2LN_OPTIONS_HPP