pstack_options.hpp

Go to the documentation of this file.

// ===-- include/pstack/pstack_options.hpp ---------------- -*- C++ -*- --=== //
// Copyright (c) 2014 Matt Bisson.  All rights reserved.

#pragma once
#ifndef PSTACK_PSTACK_OPTIONS_HPP
#define PSTACK_PSTACK_OPTIONS_HPP

#include "pstack_ns.hpp"

#include <set>
#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 pstack {

class pstack_options final
    : psystem::not_copyable
{
public:
    using pid_list = std::set<psystem::process_id_t>;

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

public:
    static bool get_image_symbols() noexcept;

    static pid_list const& process_id_list() noexcept;

    static psystem::tstring const& program_name() noexcept;

    static bool search_all_threads() noexcept;

    static bool show_frames() noexcept;

    static bool show_debug() noexcept;

    static bool show_error() noexcept;

    static bool show_info() 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:
    pstack_options(int argc, char const *argv[]);

public:
    ~pstack_options() noexcept;

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

    void try_pid(char const *arg);

    void try_switch(char arg);

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 pstack
    // namespace, we make sure to declare it above, and be explicit about the
    // global namespace.
    friend int ::main(int argc, char const *argv[]);
};

} // namespace pstack

#endif // PSTACK_PSTACK_OPTIONS_HPP