/*
 * Copyright (C) 2016-2017 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "CodeType.h"
#include "Heap.h"
#include "VM.h"
#include "WriteBarrier.h"
#include <wtf/text/WTFString.h>
#include <limits.h>

namespace JSC {

class CodeBlock;
class JSCell;
class JSObject;
class ScriptExecutable;
class SlotVisitor;

class StackFrame {
public:
    StackFrame();

    StackFrame(const VM&, JSCell* owner, JSObject* callee);

    StackFrame(const VM&, JSCell* owner, JSObject* callee, CodeBlock*, unsigned bytecodeOffset);

	~StackFrame();

    String sourceURL() const;
	JS_EXPORT_PRIVATE String toString(VM&) const;
	String functionName(VM&) const;

    bool hasLineAndColumnInfo() const { return !!m_executable; }

	JS_EXPORT_PRIVATE void computeLineAndColumn(unsigned& line, unsigned& column) const;

    bool hasBytecodeOffset() const { return m_bytecodeOffset != UINT_MAX && !m_isWasmFrame; }
    unsigned bytecodeOffset() const
    {
        ASSERT(hasBytecodeOffset());
        return m_bytecodeOffset;
    }

	void visitChildren(SlotVisitor&);
    bool isMarked() const { return (!m_callee || Heap::isMarked(m_callee.get())) && (!m_executable || Heap::isMarked(m_executable.get())); }

private:
	WriteBarrier<JSObject> m_callee;
	WriteBarrier<ScriptExecutable> m_executable;
	CodeType m_codeType;
	unsigned m_bytecodeOffset;
	bool m_isWasmFrame;
	unsigned m_line;
	unsigned m_column;
};

} // namespace JSC

namespace WTF {
template <> struct VectorTraits<JSC::StackFrame> : SimpleClassVectorTraits { };
}
