

"""
======================COPYRIGHT/LICENSE START==========================

acqParsHelpReader.py: Varian acquisition parameters help reader

Copyright (C) 2005 Wim Vranken (European Bioinformatics Institute)

=======================================================================

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
 
A copy of this license can be found in ../../../../license/LGPL.license
 
This library 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
Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


======================COPYRIGHT/LICENSE END============================

for further information, please contact :

- CCPN website (http://www.ccpn.ac.uk/)
- PDBe website (http://www.ebi.ac.uk/pdbe/)

- contact Wim Vranken (wim@ebi.ac.uk)
=======================================================================

If you are using this software for academic purposes, we suggest
quoting the following references:

===========================REFERENCE START=============================
R. Fogh, J. Ionides, E. Ulrich, W. Boucher, W. Vranken, J.P. Linge, M.
Habeck, W. Rieping, T.N. Bhat, J. Westbrook, K. Henrick, G. Gilliland,
H. Berman, J. Thornton, M. Nilges, J. Markley and E. Laue (2002). The
CCPN project: An interim report on a data model for the NMR community
(Progress report). Nature Struct. Biol. 9, 416-418.

Wim F. Vranken, Wayne Boucher, Tim J. Stevens, Rasmus
H. Fogh, Anne Pajon, Miguel Llinas, Eldon L. Ulrich, John L. Markley, John
Ionides and Ernest D. Laue (2005). The CCPN Data Model for NMR Spectroscopy:
Development of a Software Pipeline. Proteins 59, 687 - 696.

===========================REFERENCE END===============================
"""
import os

from memops.universal.Util import joinUnquote

from ccp.format.varian.generalIO import VarianGenericFile

from memops.universal.Io import getTopDirectory

#####################
# Class definitions #
#####################

class VarianAcqParHelp(VarianGenericFile):

  def initialize(self):
  
    self.readParsHelpFile()

  def readParsHelpFile(self):

    self.tags = {}
    
    fileLocation = os.path.join(getTopDirectory(),'data','ccp','varian','parhelp.txt')
  
    fin = open(fileLocation, 'rU')
    line = fin.readline()

    while line:
    
      if not (self.patt['emptyline'].search(line) or self.patt['hash'].search(line)):
        cols = line.split()
        if len(cols) < 3 or cols[1] != '=':

          print "Error parsing following line:" + self.newline + line + self.newline

        else:
          # Sort out tag
          tag = cols[0]

          # Sort out value (remove ' and rejoin with single spaces)
          value = joinUnquote(cols[2:],"'")

          self.tags[tag] = value

      line=fin.readline()

if __name__ == '__main__':

  aqhelp = VarianAcqParHelp('help')
  
  print aqhelp.tags
