org.eclipse.efm.symbex/src/fml/trace/TraceFactory.h

/*******************************************************************************
 * Copyright (c) 2016 CEA LIST.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Created on: 11 sept. 2014
 *
 * Contributors:
 *  Arnault Lapitre (CEA LIST) arnault.lapitre@cea.fr
 *   - Initial API and implementation
 ******************************************************************************/

#ifndef TRACEFACTORY_H_
#define TRACEFACTORY_H_

#include <collection/BFContainer.h>
#include <collection/Typedef.h>

#include <fml/trace/TracePoint.h>


namespace sep
{


class AvmCode;

class Configuration;

class EvaluationEnvironment;
class ExecutionData;

class InstanceOfData;
class TraceSequence;

class WObject;


class TraceFactory
{

protected:
	/**
	 * ATTRIBUTE
	 */
	const Configuration & mConfiguration;

	EvaluationEnvironment & ENV;

	const ExecutionData * mED;

	WObject * mParameterWObject;

	BFVector         mDeclaredPoint;
	VectorOfString   mDeclaredPointID;

	ExecutableForm * mLocalExecutableForm;

	InstanceOfData * mVarTime;
	BF              bfVarTime;

	ListOfTracePoint listOfPortTracePoint;
	ListOfTracePoint listOfVariableTracePoint;

	////////////////////////////////////////////////////////////////////////////
	// Computing Variables
	BF  bfTP;
	TracePoint * aTracePoint;
	ListOfTracePoint otherTracePoint;

public:
	avm_size_t TP_ID;


public:
	/**
	 * CONSTRUCTOR
	 * Default
	 */
	TraceFactory(const Configuration & aConfiguration,
			EvaluationEnvironment & anENV, WObject * wfParameterObject,
			ExecutableForm * aLocalExecutable = NULL,
			InstanceOfData * aVarTime = NULL)
	: mConfiguration( aConfiguration ),
	ENV( anENV ),

	mED( NULL ),

	mParameterWObject( wfParameterObject ),

	mDeclaredPoint( ),
	mDeclaredPointID( ),

	mLocalExecutableForm( aLocalExecutable ),

	mVarTime( aVarTime ),
	bfVarTime( ),

	listOfPortTracePoint( ),
	listOfVariableTracePoint( ),

	////////////////////////////////////////////////////////////////////////////
	// Computing Variables
	bfTP( ),
	aTracePoint( NULL ),
	otherTracePoint( ),
	TP_ID( 0 )
	{
		//!! NOTHING
	}

	/**
	 * DESTRUCTOR
	 */
	virtual ~TraceFactory()
	{
		//!! NOTHING
	}


	/**
	 * GETTER
	 * listOfPortTracePoint
	 * listOfVariableTracePoint
	 */
	ListOfTracePoint & getPortTracePoints()
	{
		return( listOfPortTracePoint );
	}

	ListOfTracePoint & getVariableTracePoints()
	{
		return( listOfVariableTracePoint );
	}


	////////////////////////////////////////////////////////////////////////////
	// CONFIGURE API
	////////////////////////////////////////////////////////////////////////////

	bool configure(TraceSequence & aTraceElement, const ExecutionData * anED = NULL);

	bool configure(AvmCode * aTraceExpression, const ExecutionData * anED = NULL);

	bool configure(WObject * aTraceSequence,
			BFCollection & tracePoints, const ExecutionData * anED = NULL);

	bool configure(WObject * aTraceSequence,
			TraceSequence & aTraceElement, const ExecutionData * anED = NULL);

	bool configure(WObject * aTraceSequence,
			AvmCode * aTraceExpression, const ExecutionData * anED = NULL);

	bool configure(BFCollection & tracePoints, WObject * wfProperty);

	bool configure(BFCollection & tracePoints, WObject * wfProperty,
			ENUM_TRACE_POINT::TRACE_NATURE nature, const std::string & object);

	bool configure(BFCollection & tracePoints, WObject * wfProperty,
			AVM_OPCODE opNature, const std::string & object);

	bool configureArray(BFCollection & tracePoints,
			WObject * wfProperty, BuiltinArray * anArray,
			ENUM_TRACE_POINT::TRACE_NATURE nature, AVM_OPCODE opNature);

	bool configureExpression(BFCollection & tracePoints,
			WObject * wfProperty, AvmCode * aCode,
			ENUM_TRACE_POINT::TRACE_NATURE nature, AVM_OPCODE opNature);


	bool configureComposite(
			BFCollection & tracePoints, const std::string & object);


	bool configurePort(
			BFCollection & tracePoints, const std::string & object);

	bool configureTime(
			BFCollection & tracePoints, const std::string & object);

	bool configureVariable(
			BFCollection & tracePoints, const std::string & object);

	bool configureBuffer(
			BFCollection & tracePoints, const std::string & object);

	bool configureFormula(
			BFCollection & tracePoints, const BF & object);

	bool configureNodePathCondition(
			BFCollection & tracePoints, const BF & object);

	bool configureMachine(
			BFCollection & tracePoints, const std::string & object);

	bool configureState(
			BFCollection & tracePoints, const std::string & object);
	bool configureStatemachine(
			BFCollection & tracePoints, const std::string & object);

	bool configureTransition(
			BFCollection & tracePoints, const std::string & object);

	bool configureRoutine(
			BFCollection & tracePoints, const std::string & object);

	bool configureRunnable(
			BFCollection & tracePoints, const std::string & object);


	////////////////////////////////////////////////////////////////////////////
	// BASIC PARSER API
	////////////////////////////////////////////////////////////////////////////

	bool parseBasicTrace(TraceSequence & aTraceElement,
			std::ifstream & inFile, const BF & aVarTime);

	bool parseBasicXliaTrace(TraceSequence & aTraceElement,
			std::ifstream & inFile, const BF & aVarTime);


	////////////////////////////////////////////////////////////////////////////
	// OTHER API
	////////////////////////////////////////////////////////////////////////////

	static bool appendTransitionPoint(
			const Configuration & aConfiguration,
			TraceSequence & aTraceElement,
			const std::string & aTransitionUfid);

	//TODO: removeTracePoint ?


	////////////////////////////////////////////////////////////////////////////
	// SERIALIZATION API
	////////////////////////////////////////////////////////////////////////////

	void toStream(OutStream & os, ListOfTracePoint & listofTracePoint) const;

};


} /* namespace sep */

#endif /* TRACEFACTORY_H_ */