/*

 * Copyright (C) 2008, 2009 Google 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:

 *

 *     * Redistributions of source code must retain the above copyright

 * notice, this list of conditions and the following disclaimer.

 *     * 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.

 *     * Neither the name of Google Inc. nor the names of its

 * contributors may be used to endorse or promote products derived from

 * this software without specific prior written permission.

 * 

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "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 THE COPYRIGHT

 * OWNER 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.

 */

#ifndef ScriptCallStack_h

#define ScriptCallStack_h

#include "ScriptArray.h"

#include "ScriptCallFrame.h"

#include "ScriptState.h"

#include "ScriptValue.h"

#include <wtf/Noncopyable.h>

#include <wtf/RefPtr.h>

namespace v8 {

    class Arguments;

}

namespace WebCore {

class InspectorArray;

class ScriptCallStack : public Noncopyable {

public:

    static const int maxCallStackSizeToCapture;

    static PassOwnPtr<ScriptCallStack> create(const v8::Arguments&, unsigned skipArgumentCount = 0, int framCountLimit = 1);

    static PassOwnPtr<ScriptCallStack> create(ScriptState*, v8::Handle<v8::StackTrace>);

    ~ScriptCallStack();

    // Returns false if there is no running JavaScript or if fetching the stack failed.

    // Sets stackTrace to be an array of stack frame objects.

    // A stack frame object looks like:

    // {

    //   scriptName: <file name for the associated script resource>

    //   functionName: <name of the JavaScript function>

    //   lineNumber: <1 based line number>

    //   column: <1 based column offset on the line>

    // }

    static bool stackTrace(int frameLimit, const RefPtr<InspectorArray>& stackTrace);

    const ScriptCallFrame& at(unsigned);

    unsigned size();

    ScriptState* state() const { return m_scriptState; }

    ScriptState* globalState() const { return m_scriptState; }

private:

    ScriptCallStack(ScriptState* scriptState, PassOwnPtr<ScriptCallFrame> topFrame, Vector<OwnPtr<ScriptCallFrame> >& scriptCallFrames);

    ScriptCallStack(ScriptState* scriptState, v8::Handle<v8::StackTrace> stackTrace);

    OwnPtr<ScriptCallFrame> m_topFrame;

    ScriptState* m_scriptState;

    Vector<OwnPtr<ScriptCallFrame> > m_scriptCallFrames;

};

} // namespace WebCore

#endif // ScriptCallStack_h