/*
 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.samsung.memoryanalysis.context;

import java.util.Set;

import com.samsung.memoryanalysis.referencecounter.heap.ContextOrObjectId;
import com.samsung.memoryanalysis.traceparser.IIDMap;
import com.samsung.memoryanalysis.traceparser.Timer;

/**
 * Interface for analyses that needs context information.
 *
 * Created by s.jensen on 6/10/14.
 */
public interface ContextAwareAnalysis<T> {

    public void init(Timer timer, ContextListener list, IIDMap iidMap);

    public void declare(int iid, String name, int objectId, Context context);

    public void create(int iid, int objectId);

    public void createFun(int iid, int objectId, int prototypeId, int functionEnterIID, Set<String> namesReferencedByClosures, Context context);

    public void putField(int iid,int baseId, String offset, int objectId);

    public void write(int iid, String name, int objectId, Context context);

    public void lastUse(int objectId, int iid, int time);

    public void functionEnter(int iid, int funId, int callSiteIID, Context newContext);

    /**
     * Treat this is as toplevel flush.
     * @param iid
     * @param unReferenced The set of name no longer referenced by this context.
     */
    public void functionExit(final int iid, final Context calleeContext, final Context callerContext, final Set<String> unReferenced);

    public void topLevelFlush(int iid, Context currentContext);

    public T endExecution(Context global, Set<String> unreachableGlobals);

    public void updateIID(int objId, int newIID);

    public void debug(int iid, int oid, Context currentContext);

    public void returnStmt(int objId);

    public void createDomNode(int iid, int objectId);

    public void addDOMChild(int parentId, int childId);

    public void removeDOMChild(int parentId, int childId);

	public void addToChildSet(int iid, ContextOrObjectId parentNode, String name, ContextOrObjectId childNode);

	public void removeFromChildSet(int iid, ContextOrObjectId parentNode, String name, ContextOrObjectId childNode);

	public void domRoot(int nodeId);

	public void scriptEnter(int iid, String filename);

	public void scriptExit(int iid);

}
