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/Token.hpp"
#include "selection/TokenMap.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;
            }

            strError += " line#" + lineCurrent;
            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 clauseName(std::string& name);
        bool clauseIndex();
        Token tokenNext();
        boost::any valuePeek();
        int tokPeek();

        bool addTokenToPostfix(const Token& token);


        bool compileError(const std::string& errorMessage) {
            std::cerr << "SelectionCompiler Error: " << errorMessage << std::endl;
            error = true;
            this->errorMessage = errorMessage;
            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:	1979
Committed:	Mon Feb 7 19:13:18 2005 UTC (19 years, 5 months ago) by tim
File size:	7490 byte(s)
Log Message:	selection library is working
#	Content
1	/*
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	#include <iostream>
45	#include <string>
46	#include <vector>
47
48	#include "selection/Token.hpp"
49	#include "selection/TokenMap.hpp"
50	namespace oopse {
51
52
53	/**
54	* @class SelectionCompiler SelectionCompiler.hpp "selection/SelectionCompiler.hpp"
55	* @brief compile a selection script to tokens
56	* @todo document
57	* <pre>
58
59	expression :: = clauseOr
60
61	clauseOr ::= clauseAnd {OR clauseAnd}*
62
63	clauseAnd ::= clauseNot {AND clauseNot}*
64
65	clauseNot ::= NOT clauseNot \| clausePrimitive
66
67	clausePrimitive ::= clauseComparator \|
68	clauseWithin \|
69	clauseName \|
70	none \| all \|
71	( clauseOr )
72
73	clauseComparator ::= atomproperty comparatorop integer
74
75	clauseWithin ::= WITHIN ( clauseDistance , expression )
76
77	clauseDistance ::= integer \| decimal
78
79	clauseName::= *\|string{.string{.string}}
80
81
82	* </pre>
83	*/
84	class SelectionCompiler{
85	public:
86	bool compile(const std::string& filename, const std::string& script );
87
88
89	std::vector<int> getLineNumbers() {
90	return lineNumbers;
91	}
92
93	std::vector<int> getLineIndices() {
94	return lineIndices;
95	}
96
97	std::vector<std::vector<Token> > getAatokenCompiled() {
98	return aatokenCompiled;
99	}
100
101	std::string getErrorMessage() {
102	std::string strError = errorMessage;
103	strError += " : " + errorLine + "\n";
104
105	if (!filename.empty()) {
106	strError += filename;
107	}
108
109	strError += " line#" + lineCurrent;
110	return strError;
111	}
112
113
114	private:
115
116	bool internalCompile();
117
118
119	bool lookingAtLeadingWhitespace();
120	//bool lookingAtComment();
121	bool lookingAtEndOfLine();
122	bool lookingAtEndOfStatement();
123	bool lookingAtString();
124	bool lookingAtDecimal(bool allowNegative);
125	bool lookingAtInteger(bool allowNegative);
126	bool lookingAtLookupToken();
127	bool lookingAtSpecialString();
128
129	std::string getUnescapedStringLiteral();
130	int getHexitValue(char ch);
131
132	bool compileCommand(const std::vector<Token>& ltoken);
133	bool compileExpression();
134	bool compileExpression(int itoken);
135
136	bool clauseOr();
137	bool clauseAnd();
138	bool clauseNot();
139	bool clausePrimitive();
140	bool clauseWithin();
141	bool clauseComparator();
142	bool clauseChemObjName();
143	bool clauseName(std::string& name);
144	bool clauseIndex();
145	Token tokenNext();
146	boost::any valuePeek();
147	int tokPeek();
148
149	bool addTokenToPostfix(const Token& token);
150
151
152	bool compileError(const std::string& errorMessage) {
153	std::cerr << "SelectionCompiler Error: " << errorMessage << std::endl;
154	error = true;
155	this->errorMessage = errorMessage;
156	return false;
157	}
158
159	bool commandExpected() {
160	return compileError("command expected");
161	}
162
163	bool invalidExpressionToken(const std::string& ident) {
164	return compileError("invalid expression token:" + ident);
165	}
166
167	bool unrecognizedToken() {
168	return compileError("unrecognized token");
169	}
170
171	bool badArgumentCount() {
172	return compileError("bad argument count");
173	}
174
175	bool endOfExpressionExpected() {
176	return compileError("end of expression expected");
177	}
178
179	bool leftParenthesisExpected() {
180	return compileError("left parenthesis expected");
181	}
182
183	bool rightParenthesisExpected() {
184	return compileError("right parenthesis expected");
185	}
186
187	bool commaExpected() {
188	return compileError("comma expected");
189	}
190
191	bool unrecognizedExpressionToken() {
192	boost::any tmp = valuePeek();
193	std::string tokenStr;
194
195	try {
196	tokenStr = boost::any_cast<std::string>(tmp);
197	} catch(const boost::bad_any_cast &) {
198	return compileError("any_cast error");
199	}
200
201	return compileError("unrecognized expression token:" + tokenStr);
202	}
203
204	bool comparisonOperatorExpected() {
205	return compileError("comparison operator expected");
206	}
207
208	bool numberExpected() {
209	return compileError("number expected");
210	}
211
212	bool numberOrKeywordExpected() {
213	return compileError("number or keyword expected");
214	}
215
216	std::string filename;
217	std::string script;
218
219	std::vector<int> lineNumbers;
220	std::vector<int> lineIndices;
221	std::vector<std::vector<Token> >aatokenCompiled;
222
223	bool error;
224	std::string errorMessage;
225	std::string errorLine;
226
227	int cchScript;
228	short lineCurrent;
229
230	int ichToken;
231	int cchToken;
232	std::vector<Token> atokenCommand;
233
234	int ichCurrentCommand;
235
236	std::vector<Token> ltokenPostfix;
237	std::vector<Token> atokenInfix;
238	int itokenInfix;
239
240	//std::vector<Token> compiledTokens_;
241	};
242
243	}
244	#endif
245