src/selection/SelectionCompiler.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 */

#ifndef SELECTION_SELECTIONCOMPILER_HPP
#define SELECTION_SELECTIONCOMPILER_HPP
#include <iostream>
#include <string>
#include <vector>

#include "selection/SelectionToken.hpp"
#include "selection/TokenMap.hpp"
#include "brains/SimInfo.hpp"

namespace oopse {


  /**
   * @class SelectionCompiler SelectionCompiler.hpp "selection/SelectionCompiler.hpp"
   * @brief compile a selection script to tokens
   * @todo document
   * <pre>

   expression       :: = clauseOr

   clauseOr         ::= clauseAnd {OR clauseAnd}*

   clauseAnd        ::= clauseNot {AND clauseNot}*

   clauseNot        ::= NOT clauseNot | clausePrimitive

   clausePrimitive  ::= clauseComparator |
   clauseWithin |
   clauseName |
   none | all |
   ( clauseOr )

   clauseComparator ::= atomproperty comparatorop integer

   clauseWithin     ::= WITHIN ( clauseDistance , expression )

   clauseDistance   ::= integer | decimal
        
   clauseName::= *|string{.string{.string}}


   * </pre>
   */
  class SelectionCompiler{
  public:
    bool compile(const std::string& filename, const std::string& script );
        

    std::vector<int> getLineNumbers() {
      return lineNumbers;
    }

    std::vector<int> getLineIndices() {
      return lineIndices;
    }

    std::vector<std::vector<Token> > getAatokenCompiled() {
      return aatokenCompiled;
    }

    std::string getErrorMessage() {
      std::string strError = errorMessage;
      strError += " : " + errorLine + "\n";

      if (!filename.empty()) {
        strError += filename;
      }

      return strError;
    }

        
  private:

    bool internalCompile();


    bool lookingAtLeadingWhitespace();
    //bool lookingAtComment();
    bool lookingAtEndOfLine();
    bool lookingAtEndOfStatement();
    bool lookingAtString();
    bool lookingAtDecimal(bool allowNegative);
    bool lookingAtInteger(bool allowNegative);
    bool lookingAtLookupToken();
    bool lookingAtSpecialString();

    std::string getUnescapedStringLiteral();
    int getHexitValue(char ch);        

    bool compileCommand(const std::vector<Token>& ltoken);
    bool compileExpression();        
    bool compileExpression(int itoken);        
        
    bool clauseOr();
    bool clauseAnd();
    bool clauseNot();
    bool clausePrimitive();
    bool clauseWithin();
    bool clauseComparator();
    bool clauseChemObjName();        
    bool clauseIndex();
    Token tokenNext();
    boost::any valuePeek();
    int tokPeek();

    bool addTokenToPostfix(const Token& token);
    bool isNameValid(const std::string& name);

    bool compileError(const std::string& errorMsg) {

      sprintf( painCave.errMsg,
               "SelectionCompiler Error: %s\n", errorMsg.c_str());
      painCave.severity = OOPSE_ERROR;
      painCave.isFatal = 1;
      simError();

      error = true;
      this->errorMessage = errorMsg;
      return false;
    }
        
    bool commandExpected() {
      return compileError("command expected");
    }

    bool invalidExpressionToken(const std::string& ident) {
      return compileError("invalid expression token:" + ident);
    }

    bool unrecognizedToken() {
      return compileError("unrecognized token");
    }

    bool badArgumentCount() {
      return compileError("bad argument count");
    }

    bool endOfExpressionExpected() {
      return compileError("end of expression expected");
    }

    bool leftParenthesisExpected() {
      return compileError("left parenthesis expected");
    }

    bool rightParenthesisExpected() {
      return compileError("right parenthesis expected");
    }

    bool commaExpected() {
      return compileError("comma expected");
    }

    bool unrecognizedExpressionToken() {
      boost::any tmp = valuePeek();
      std::string tokenStr;

      try {
        tokenStr = boost::any_cast<std::string>(tmp);                
      } catch(const boost::bad_any_cast &) {
        return compileError("any_cast error");
      }
            
      return compileError("unrecognized expression token:" + tokenStr);
    }

    bool comparisonOperatorExpected() {
      return compileError("comparison operator expected");
    }

    bool numberExpected() {
      return compileError("number expected");
    }        
        
    bool numberOrKeywordExpected() {
      return compileError("number or keyword expected");
    }        
        
    std::string filename;
    std::string script;

    std::vector<int> lineNumbers;
    std::vector<int> lineIndices;
    std::vector<std::vector<Token> >aatokenCompiled;

    bool error;
    std::string errorMessage;
    std::string errorLine;

    int cchScript;
    short lineCurrent;

    int ichToken;
    int cchToken;
    std::vector<Token> atokenCommand;

    int ichCurrentCommand;

    std::vector<Token> ltokenPostfix;
    std::vector<Token> atokenInfix;
    int itokenInfix;

    //std::vector<Token> compiledTokens_;
  };

}
#endif

Revision:	1364
Committed:	Wed Oct 7 20:49:50 2009 UTC (15 years, 6 months ago) by cli2
File size:	6963 byte(s)
Log Message:	Bug fixes in the SelectionEvaluator and SelectionCompiler Added print option in Restraints
#	User	Rev	Content
1	tim	277	/*
2			* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9			* 1. Acknowledgement of the program authors must be made in any
10			* publication of scientific results based in part on use of the
11			* program. An acceptable form of acknowledgement is citation of
12			* the article in which the program was described (Matthew
13			* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14			* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15			* Parallel Simulation Engine for Molecular Dynamics,"
16			* J. Comput. Chem. 26, pp. 252-271 (2005))
17			*
18			* 2. Redistributions of source code must retain the above copyright
19			* notice, this list of conditions and the following disclaimer.
20			*
21			* 3. Redistributions in binary form must reproduce the above copyright
22			* notice, this list of conditions and the following disclaimer in the
23			* documentation and/or other materials provided with the
24			* distribution.
25			*
26			* This software is provided "AS IS," without a warranty of any
27			* kind. All express or implied conditions, representations and
28			* warranties, including any implied warranty of merchantability,
29			* fitness for a particular purpose or non-infringement, are hereby
30			* excluded. The University of Notre Dame and its licensors shall not
31			* be liable for any damages suffered by licensee as a result of
32			* using, modifying or distributing the software or its
33			* derivatives. In no event will the University of Notre Dame or its
34			* licensors be liable for any lost revenue, profit or data, or for
35			* direct, indirect, special, consequential, incidental or punitive
36			* damages, however caused and regardless of the theory of liability,
37			* arising out of the use of or inability to use software, even if the
38			* University of Notre Dame has been advised of the possibility of
39			* such damages.
40			*/
41
42			#ifndef SELECTION_SELECTIONCOMPILER_HPP
43			#define SELECTION_SELECTIONCOMPILER_HPP
44	tim	281	#include <iostream>
45	tim	278	#include <string>
46	tim	277	#include <vector>
47	tim	281
48	tim	770	#include "selection/SelectionToken.hpp"
49	tim	281	#include "selection/TokenMap.hpp"
50	cli2	1364	#include "brains/SimInfo.hpp"
51
52	tim	277	namespace oopse {
53
54
55	gezelter	507	/**
56			* @class SelectionCompiler SelectionCompiler.hpp "selection/SelectionCompiler.hpp"
57			* @brief compile a selection script to tokens
58			* @todo document
59			* <pre>
60	tim	277
61	gezelter	507	expression :: = clauseOr
62	tim	277
63	gezelter	507	clauseOr ::= clauseAnd {OR clauseAnd}*
64	tim	277
65	gezelter	507	clauseAnd ::= clauseNot {AND clauseNot}*
66	tim	277
67	gezelter	507	clauseNot ::= NOT clauseNot \| clausePrimitive
68	tim	277
69	gezelter	507	clausePrimitive ::= clauseComparator \|
70			clauseWithin \|
71			clauseName \|
72			none \| all \|
73			( clauseOr )
74	tim	277
75	gezelter	507	clauseComparator ::= atomproperty comparatorop integer
76	tim	277
77	gezelter	507	clauseWithin ::= WITHIN ( clauseDistance , expression )
78	tim	277
79	gezelter	507	clauseDistance ::= integer \| decimal
80	tim	283
81	gezelter	507	clauseName::= *\|string{.string{.string}}
82	tim	277
83	tim	278
84	gezelter	507	* </pre>
85			*/
86			class SelectionCompiler{
87			public:
88			bool compile(const std::string& filename, const std::string& script );
89	tim	278
90	tim	277
91	gezelter	507	std::vector<int> getLineNumbers() {
92			return lineNumbers;
93			}
94	tim	277
95	gezelter	507	std::vector<int> getLineIndices() {
96			return lineIndices;
97			}
98	tim	277
99	gezelter	507	std::vector<std::vector<Token> > getAatokenCompiled() {
100			return aatokenCompiled;
101			}
102	tim	277
103	gezelter	507	std::string getErrorMessage() {
104			std::string strError = errorMessage;
105			strError += " : " + errorLine + "\n";
106	tim	277
107	gezelter	507	if (!filename.empty()) {
108			strError += filename;
109			}
110	tim	277
111	gezelter	507	return strError;
112			}
113	tim	277
114	tim	278
115	gezelter	507	private:
116	tim	277
117	gezelter	507	bool internalCompile();
118	tim	278
119
120	gezelter	507	bool lookingAtLeadingWhitespace();
121			//bool lookingAtComment();
122			bool lookingAtEndOfLine();
123			bool lookingAtEndOfStatement();
124			bool lookingAtString();
125			bool lookingAtDecimal(bool allowNegative);
126			bool lookingAtInteger(bool allowNegative);
127			bool lookingAtLookupToken();
128			bool lookingAtSpecialString();
129	tim	278
130	gezelter	507	std::string getUnescapedStringLiteral();
131			int getHexitValue(char ch);
132	tim	278
133	gezelter	507	bool compileCommand(const std::vector<Token>& ltoken);
134			bool compileExpression();
135			bool compileExpression(int itoken);
136	tim	278
137	gezelter	507	bool clauseOr();
138			bool clauseAnd();
139			bool clauseNot();
140			bool clausePrimitive();
141			bool clauseWithin();
142			bool clauseComparator();
143			bool clauseChemObjName();
144			bool clauseIndex();
145			Token tokenNext();
146			boost::any valuePeek();
147			int tokPeek();
148	tim	281
149	gezelter	507	bool addTokenToPostfix(const Token& token);
150			bool isNameValid(const std::string& name);
151	tim	281
152	gezelter	507	bool compileError(const std::string& errorMsg) {
153	cli2	1364
154			sprintf( painCave.errMsg,
155			"SelectionCompiler Error: %s\n", errorMsg.c_str());
156			painCave.severity = OOPSE_ERROR;
157			painCave.isFatal = 1;
158			simError();
159
160	gezelter	507	error = true;
161			this->errorMessage = errorMsg;
162			return false;
163			}
164	tim	277
165	gezelter	507	bool commandExpected() {
166			return compileError("command expected");
167			}
168	tim	277
169	gezelter	507	bool invalidExpressionToken(const std::string& ident) {
170			return compileError("invalid expression token:" + ident);
171			}
172	tim	278
173	gezelter	507	bool unrecognizedToken() {
174			return compileError("unrecognized token");
175			}
176	tim	278
177	gezelter	507	bool badArgumentCount() {
178			return compileError("bad argument count");
179			}
180	tim	278
181	gezelter	507	bool endOfExpressionExpected() {
182			return compileError("end of expression expected");
183			}
184	tim	278
185	gezelter	507	bool leftParenthesisExpected() {
186			return compileError("left parenthesis expected");
187			}
188	tim	278
189	gezelter	507	bool rightParenthesisExpected() {
190			return compileError("right parenthesis expected");
191			}
192	tim	278
193	gezelter	507	bool commaExpected() {
194			return compileError("comma expected");
195			}
196	tim	278
197	gezelter	507	bool unrecognizedExpressionToken() {
198			boost::any tmp = valuePeek();
199			std::string tokenStr;
200	tim	281
201	gezelter	507	try {
202			tokenStr = boost::any_cast<std::string>(tmp);
203			} catch(const boost::bad_any_cast &) {
204			return compileError("any_cast error");
205			}
206	tim	281
207	gezelter	507	return compileError("unrecognized expression token:" + tokenStr);
208			}
209	tim	278
210	gezelter	507	bool comparisonOperatorExpected() {
211			return compileError("comparison operator expected");
212			}
213	tim	278
214	gezelter	507	bool numberExpected() {
215			return compileError("number expected");
216			}
217	tim	278
218	gezelter	507	bool numberOrKeywordExpected() {
219			return compileError("number or keyword expected");
220			}
221	tim	278
222	gezelter	507	std::string filename;
223			std::string script;
224	tim	278
225	gezelter	507	std::vector<int> lineNumbers;
226			std::vector<int> lineIndices;
227			std::vector<std::vector<Token> >aatokenCompiled;
228	tim	278
229	gezelter	507	bool error;
230			std::string errorMessage;
231			std::string errorLine;
232	tim	278
233	gezelter	507	int cchScript;
234			short lineCurrent;
235	tim	278
236	gezelter	507	int ichToken;
237			int cchToken;
238			std::vector<Token> atokenCommand;
239	tim	278
240	gezelter	507	int ichCurrentCommand;
241	tim	278
242	gezelter	507	std::vector<Token> ltokenPostfix;
243			std::vector<Token> atokenInfix;
244			int itokenInfix;
245	tim	278
246	gezelter	507	//std::vector<Token> compiledTokens_;
247			};
248	tim	277
249			}
250			#endif
251	tim	278