sideEffect.h

Go to the documentation of this file.

#ifndef SIDEEFFEECT_H
#define SIDEEFFEECT_H

#include "sage3.h"
#include <list>

// DQ (12/30/2005): This is a Bad Bad thing to do (I can explain)
// it hides names in the global namespace and causes errors in 
// otherwise valid and useful code. Where it is needed it should
// appear only in *.C files (and only ones not included for template 
// instantiation reasons) else they effect user who use ROSE unexpectedly.
// using namespace std;

// Abstract base class interface to the side effect implementation.
// Implements the algorithm described in:
// Interprocedural side-effect analysis in linear time
// Cooper and Kennedy
// PLDI 1988
// Pass command line arguments (as passed to compiler front end)
// to calcSideEffect in order to calculate side effects across the
// whole program.  Currently does not handle aliasing, though
// Cooper and Kennedy describe where to plug in an aliasing module.
// Also probably will not handle virtual method calls.   
class SideEffectAnalysis {

 public:

  static SideEffectAnalysis* create();

  virtual ~SideEffectAnalysis() = 0;

  virtual int calcSideEffect(SgProject& project) = 0;
#if 1
  virtual int calcSideEffect(SgFile& file) = 0;

  virtual int calcSideEffect(SgNode& node) = 0;
#endif
  virtual std::list<const char* > getCalledFunctions() = 0;

  virtual std::list<const char* > getGMOD(const char* func) = 0;

  virtual std::list<const char* > getDMOD(const char* stmt) = 0;

  virtual std::string getNodeIdentifier(SgNode *node) = 0;

 protected:
  
  SideEffectAnalysis();
  SideEffectAnalysis(const SideEffectAnalysis& rhs);

 private:
  SideEffectAnalysis& operator=(const SideEffectAnalysis& rhs);

};

std::string getQualifiedFunctionName(SgFunctionCallExp *astNode);

std::string getQualifiedFunctionName(SgFunctionDeclaration *astNode);

#endif /* SIDEEFFECT_H */