## 
##     misc.py 1.1 -- miscellaneous support functions required for Prescript
##     Copyright (C) 1996  Todd Reed
##  
##     This program is free software; you can redistribute it and/or modify
##     it under the terms of the GNU General Public License as published by
##     the Free Software Foundation; either version 2 of the License, or
##     (at your option) any later version.
##  
##     This program is distributed in the hope that it will be useful,
##     but WITHOUT ANY WARRANTY; without even the implied warranty of
##     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
##     GNU General Public License for more details.
##  
##     You should have received a copy of the GNU General Public License
##     along with this program; if not, write to the Free Software
##     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
## 

#Module to provide misc functions for the analysis program

import os, regex, sys, string
from string import atof


# defEqualness:
#
# Used as the default equalness in the isEqual function to do a loose comparison between a and b.
#
# expressed as a decimal, the comparison will fail if the difference is greater than defEq %

defEqualness = 0.003831

def MakeFilename(sourceName, newExt):
   head, tail = os.path.split(sourceName)
   root, ext = os.path.splitext(tail)
   return root + newExt

def short(string):
   length=(len(string))
   length=length-1
   
   position=0

   if length!=0:
      while length!=0:
	 if string[length]!=" ":
	    position=length
	    break
	 else:
	    length=length-1
   
   return string[:position+1]

def checkforBib(string):
   
   bibPattern = regex.compile("^\[[A-Za-z0-9\+]+\] *[A-Z]")

   position=bibPattern.search(string)
   if ((position==0) or (position==1)):
      return "bib"
   else:
      return "normal"

def findLastChar(string):
   def checkForParen(char):
      if char==")" or char=="]" or char=="}" or char=="\"" or char=="\'":
	 return 1
      else:
	 return 0

   def checkForPunc(char):
      if char=="." or char=="!" or char=="?":
	 return "stop"
      elif char==":":
	 return "colon"
      else:
	 return "other"

   string=short(string)
   char=string[(len(string)-1)]
   if checkForParen(char)==1:
      char=string[(len(string)-2)]

   return checkForPunc(char)

def getNum(string):
   string=string[4:]
   list=[]
   i=0
   for p in range(5):
      value=""
      done=1
      while(done!=0):
	
	 if (i <=len(string)-1) and (string[i]!=" "):
	    value=value + string[i]
	    i=i+1
	 else:
	    done=0
	    number=atof(value)
	    list.append(number)
	    i=i+1
   return list

def getLineSpace(string):
   position=regex.pattern("@!@", string)
   if position!=-1:
      values=getNum(string)
      return value[1]-value[0]
   else:
      return 0

def firstCharCase(string):
   if string[0]=="[":
      string=string[3:]
   startParaPattern = regex.compile("^ *[A-Z]")
   if startParaPattern.search(string) >=0:
      return "true"
   else:
      return "false"
   


def my_assert( expr, gsymtab, lsymtab ):
    if not eval(expr, gsymtab, lsymtab):
       sys.stderr.write( "assertion failed:"+expr+"\n" )



# determines if the two arguments are sufficiently "equal".
# governed by module default variable defEqualness
def isEqual( a, b, Equalness=defEqualness ):
    # hack to handle b==0 case.  there is probably a better action
    # than this, but this will do
    if b == 0:	return a <= Equalness
    return abs((float(a)/float(b))-1) <= Equalness


# readline:
#
# Wrapper to raw_input (or whatever) to return either a whole line of text
# or None, indicating end of file.
lno = 0
def readline():
    global lno
    try:
	lno = lno + 1
	return raw_input()
    except EOFError:
	return None


# nextline:
#
# Get next significant (ie, not comment etc) line of ARFF file.
#
# Essentially, all this function does is return the next non-
# empty, comment-stripped line from the input (as per
# readline())
def nextline():
    i = ""    
    while i == "":
	i = readline()
	if i == None: return None
	i = string.strip(i)
	cmntcol = string.find(i,'%')
	if cmntcol != -1: i = i[:cmntcol] # strip comments
	
    return i


# qsplit:
#
# like string.split() only quotes protect spaces
# BE WARNED: I think this function is buggy
def qsplit(i,delim=' '):
    if i == None: return None

    i = string.split(i,'"')	# first find quotes

    # resplit only unquoted words (which will be every other item in the list)
    o = []
    for x in range(len(i)): 
	if x % 2:   o = o + [i[x]]	# odd indexes
	else:
	    # get rid of trailing or leading
#	    if i[x][:len(delim)] == delim: del i[x][:len(delim)] 
#	    if i[x][len(delim):] == delim: del i[x][len(delim):]
	    o = o + string.split(i[x],delim) # even indexes

    return o
	    
# msg:
#
# print the given message to the message device, ususally stderr
def msg(msg,cr='\n'):
    sys.stderr.write(msg+cr)