TableGram.h

Go to the documentation of this file.
00001 //# TableGram.h: Grammar for table command lines
00002 //# Copyright (C) 1993,1994,1995,1997,1999
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //# $Id$
00027 
00028 #ifndef TABLES_TABLEGRAM_H
00029 #define TABLES_TABLEGRAM_H
00030 
00031 //# Includes
00032 #include <casacore/casa/aips.h>
00033 #include <casacore/casa/BasicSL/String.h>
00034 #include <casacore/casa/Quanta/MVTime.h>
00035 
00036 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00037 
00038 //# Forward Declarations
00039 
00040 
00041 // <summary>
00042 // Global functions for flex/bison scanner/parser for TableGram
00043 // </summary>
00044 
00045 // <use visibility=local>
00046 
00047 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tTableGram">
00048 // </reviewed>
00049 
00050 // <prerequisite>
00051 //# Classes you should understand before using this one.
00052 //  <li> TableGram.l and .y  (flex and bison grammar)
00053 // </prerequisite>
00054 
00055 // <synopsis> 
00056 // Global functions are needed to define the input of the flex scanner
00057 // and to start the bison parser.
00058 // The input is taken from a string.
00059 // </synopsis> 
00060 
00061 // <motivation>
00062 // It is necessary to be able to give a table select command in ASCII.
00063 // This can be used in a CLI or in the table browser to get a subset
00064 // of a table or to sort a table.
00065 // </motivation>
00066 
00067 // <todo asof="$DATE:$">
00068 //# A List of bugs, limitations, extensions or planned refinements.
00069 // </todo>
00070 
00071 // <group name=TableGramFunctions>
00072 
00073 // Declare the bison parser (is implemented by bison command).
00074 int tableGramParseCommand (const String& command);
00075 
00076 // The yyerror function for the parser.
00077 // It throws an exception with the current token.
00078 void TableGramerror (const char*);
00079 
00080 // Give the current position in the string.
00081 // This can be used when parse errors occur.
00082 Int& tableGramPosition();
00083 
00084 // Declare the input routine for flex/bison.
00085 int tableGramInput (char* buf, int max_size);
00086 
00087 // A function to remove escaped characters.
00088 String tableGramRemoveEscapes (const String& in);
00089 
00090 // A function to remove quotes from a quoted string.
00091 String tableGramRemoveQuotes (const String& in);
00092 
00093 // A function to parse a date/time string.
00094 MVTime tableGramParseDateTime (const String& in);
00095 
00096 // A function to parse a time/position string.
00097 // The value is returned in radians.
00098 Double tableGramParseTime (const String& in);
00099 
00100 // </group>
00101 
00102 
00103 
00104 } //# NAMESPACE CASACORE - END
00105 
00106 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1