StackFrameBase.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef KERNEL_PROCESSOR_STACKFRAMEBASE_H
#define KERNEL_PROCESSOR_STACKFRAMEBASE_H

#include "pedigree/kernel/processor/state_forward.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/StaticString.h"
#include "pedigree/kernel/utilities/demangle.h"

class StackFrameBase
{
  public:
#if defined(DEBUGGER)

    void prettyPrint(HugeStaticString &buf);
#endif

    StackFrameBase(
        const ProcessorState &State, uintptr_t basePointer,
        LargeStaticString mangledSymbol);
    virtual ~StackFrameBase();

    static void construct(
        ProcessorState &state, uintptr_t returnAddress, unsigned int nParams,
        ...);
#if defined(DEBUGGER)
  protected:
    symbol_t m_Symbol;
    const ProcessorState &m_State;
    uintptr_t m_BasePointer;

  private:
    virtual uintptr_t getParameter(size_t n) = 0;

    bool isClassMember();

    void
    format(uintptr_t n, const LargeStaticString &type, HugeStaticString &dest);
#endif
};

#endif