#  This software and supporting documentation are distributed by
#      Institut Federatif de Recherche 49
#      CEA/NeuroSpin, Batiment 145,
#      91191 Gif-sur-Yvette cedex
#      France
#
# This software is governed by the CeCILL license version 2 under
# French law and abiding by the rules of distribution of free software.
# You can  use, modify and/or redistribute the software under the 
# terms of the CeCILL license version 2 as circulated by CEA, CNRS
# and INRIA at the following URL "http://www.cecill.info". 
#
# As a counterpart to the access to the source code and  rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty  and the software's author,  the holder of the
# economic rights,  and the successive licensors  have only  limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading,  using,  modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean  that it is complicated to manipulate,  and  that  also
# therefore means  that it is reserved for developers  and  experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or 
# data to be ensured and,  more generally, to use and operate it in the 
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license version 2 and that you accept its terms.
import os, sys, inspect

debugLevel = 0

#----------------------------------------------------------------------------
def printReferrers( obj, levelMax=0, level=0 ):
  import gc
  for x in gc.get_referrers( obj ):
    print '\n' + '    ' * ( level + 1 ) + str( x )
    if level < levelMax:
      printReferrers( x, levelMax, level+1 )


#----------------------------------------------------------------------------
def debugHere( level=1, *args ):
  if debugLevel >= level:
    # Get the caller's frame information
    frame = sys._getframe( 1 )
    filename, currentLineInFile, functionName, lines, currentLineInLines = \
    inspect.getframeinfo( frame )
    # If 'self' is in locals consider the function as a method and displays
    # its class and object
    self = frame.f_locals.get( 'self' )
    if self is not None:
      functionName = self.__class__.__name__ + '.' + functionName + '(' + str( self ) + ')'
    
    print >> sys.stderr, '-=#)', functionName, ' in', os.path.basename( filename ), '[', currentLineInFile, ']', '(#=-'
    if args:
      print ' '.join( [str(x) for x in args] )