src/selection/SelectionEvaluator.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_SELECTIONEVALUATOR_HPP
#define SELECTION_SELECTIONEVALUATOR_HPP

#include <map>
#include <string>
#include <vector>

#include "brains/SimInfo.hpp"
#include "selection/Token.hpp"
#include "selection/SelectionCompiler.hpp"
#include "selection/NameFinder.hpp"
#include "utils/BitSet.hpp"
#include "primitives/StuntDouble.hpp"
namespace oopse {


class Context {
    public:
        
        void clear() {
            linenumbers.clear();
            lineIndices.clear();
            aatoken.clear();
        }
        
        std::string filename;
        std::string script;
        std::vector<int> linenumbers;
        std::vector<int> lineIndices;
        std::vector<std::vector<Token> > aatoken;
        int pc;
};


/**
 * @class SelectionEvaluator SelectionEvaluator.hpp "selection/SelectionEvaluator"
 * @brief Evalute the tokens compiled by SelectionCompiler and return a BitSet
 */
class SelectionEvaluator{
    public:

        SelectionEvaluator(SimInfo* info, const std::string& script);


        BitSet evaluate();
        
        BitSet evaluate(int frameNo);

        /**
         * Tests if the result from evaluation of script is static.
         * @return true if the result keeps the same even the frame change, otherwise return false
         */         
        bool isStatic();

        bool hadRuntimeError() const{
            return error;
        }

        std::string getErrorMessage() const {
            return errorMessage;
        }


        int getLinenumber() {
            return linenumbers[pc];
        }

        std::string getLine() {
            int ichBegin = lineIndices[pc];
            int ichEnd;
            if ((ichEnd = script.find('\r', ichBegin)) == std::string::npos &&
                (ichEnd = script.find('\n', ichBegin)) == std::string::npos) {
                ichEnd = script.size();
            }            
            return script.substr(ichBegin, ichEnd);
        }
  
    private:

        void clearState();
        
        bool loadScript(const std::string& filename, const std::string& script); 
        bool loadScriptString(const std::string& script);
        bool loadScriptFileInternal(const std::string& filename);
        bool loadScriptFile(const std::string& filename);

        void clearDefinitionsAndLoadPredefined();
         
        void define();
        void select();
        void predefine(const std::string& script);

        void instructionDispatchLoop();

        void withinInstruction(const Token& instruction, BitSet& bs);
        
        BitSet comparatorInstruction(const Token& instruction); 
        void compareProperty(StuntDouble* sd, BitSet& bs, int property, int comparator, float comparisonValue);
        BitSet nameInstruction(const std::string& name);

        BitSet expression(const std::vector<Token>& tokens, int pc);

        BitSet lookupValue(const std::string& variable);
        
        void evalError(const std::string& message);

        void unrecognizedCommand(const Token& token) {
            evalError("unrecognized command:" + boost::any_cast<std::string>(token.value));
        }        

        void unrecognizedExpression() {
            evalError("unrecognized expression");
        }

        void unrecognizedAtomProperty(int property){
            evalError("unrecognized atom property");
        }

        void unrecognizedIdentifier(const std::string& identifier) {
            evalError("unrecognized identifier:" + identifier);
        }    
        SelectionCompiler compiler;

        const static int scriptLevelMax = 10;
        int scriptLevel;

        Context stack[scriptLevelMax];

        std::string filename;
        std::string script;
        std::vector<int> linenumbers;
        std::vector<int> lineIndices;
        std::vector<std::vector<Token> > aatoken;
        int pc; // program counter

        bool error;
        std::string errorMessage;

        std::vector<Token> statement;
        int statementLength;

        SimInfo* info;
        NameFinder finder;
        int nStuntDouble;   //natoms + nrigidbodies
        std::map<std::string, boost::any > variables;
};

}
#endif
Revision:	1967
Committed:	Thu Feb 3 23:14:05 2005 UTC (19 years, 5 months ago) by tim
File size:	6238 byte(s)
Log Message:	more work in selection library
#	User	Rev	Content
1	tim	1961	/*
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_SELECTIONEVALUATOR_HPP
43			#define SELECTION_SELECTIONEVALUATOR_HPP
44
45			#include <map>
46			#include <string>
47			#include <vector>
48
49			#include "brains/SimInfo.hpp"
50			#include "selection/Token.hpp"
51			#include "selection/SelectionCompiler.hpp"
52	tim	1967	#include "selection/NameFinder.hpp"
53	tim	1961	#include "utils/BitSet.hpp"
54	tim	1967	#include "primitives/StuntDouble.hpp"
55	tim	1961	namespace oopse {
56
57	tim	1967
58	tim	1962	class Context {
59	tim	1965	public:
60
61			void clear() {
62			linenumbers.clear();
63			lineIndices.clear();
64			aatoken.clear();
65			}
66
67			std::string filename;
68			std::string script;
69			std::vector<int> linenumbers;
70			std::vector<int> lineIndices;
71			std::vector<std::vector<Token> > aatoken;
72			int pc;
73			};
74	tim	1962
75	tim	1967
76	tim	1961	/**
77			* @class SelectionEvaluator SelectionEvaluator.hpp "selection/SelectionEvaluator"
78			* @brief Evalute the tokens compiled by SelectionCompiler and return a BitSet
79			*/
80			class SelectionEvaluator{
81			public:
82
83			SelectionEvaluator(SimInfo* info, const std::string& script);
84
85	tim	1962
86	tim	1961	BitSet evaluate();
87
88			BitSet evaluate(int frameNo);
89
90			/**
91			* Tests if the result from evaluation of script is static.
92			* @return true if the result keeps the same even the frame change, otherwise return false
93			*/
94			bool isStatic();
95	tim	1962
96			bool hadRuntimeError() const{
97			return error;
98			}
99
100			std::string getErrorMessage() const {
101			return errorMessage;
102			}
103
104
105			int getLinenumber() {
106			return linenumbers[pc];
107			}
108
109			std::string getLine() {
110			int ichBegin = lineIndices[pc];
111			int ichEnd;
112	tim	1965	if ((ichEnd = script.find('\r', ichBegin)) == std::string::npos &&
113			(ichEnd = script.find('\n', ichBegin)) == std::string::npos) {
114	tim	1962	ichEnd = script.size();
115			}
116			return script.substr(ichBegin, ichEnd);
117			}
118
119	tim	1961	private:
120
121	tim	1962	void clearState();
122
123			bool loadScript(const std::string& filename, const std::string& script);
124			bool loadScriptString(const std::string& script);
125			bool loadScriptFileInternal(const std::string& filename);
126	tim	1965	bool loadScriptFile(const std::string& filename);
127	tim	1962
128			void clearDefinitionsAndLoadPredefined();
129
130	tim	1961	void define();
131	tim	1966	void select();
132	tim	1967	void predefine(const std::string& script);
133	tim	1961
134	tim	1962	void instructionDispatchLoop();
135
136	tim	1967	void withinInstruction(const Token& instruction, BitSet& bs);
137
138			BitSet comparatorInstruction(const Token& instruction);
139			void compareProperty(StuntDouble* sd, BitSet& bs, int property, int comparator, float comparisonValue);
140			BitSet nameInstruction(const std::string& name);
141	tim	1961
142	tim	1967	BitSet expression(const std::vector<Token>& tokens, int pc);
143	tim	1962
144	tim	1967	BitSet lookupValue(const std::string& variable);
145
146	tim	1966	void evalError(const std::string& message);
147
148			void unrecognizedCommand(const Token& token) {
149	tim	1967	evalError("unrecognized command:" + boost::any_cast<std::string>(token.value));
150	tim	1966	}
151	tim	1967
152			void unrecognizedExpression() {
153			evalError("unrecognized expression");
154			}
155
156			void unrecognizedAtomProperty(int property){
157			evalError("unrecognized atom property");
158			}
159
160			void unrecognizedIdentifier(const std::string& identifier) {
161			evalError("unrecognized identifier:" + identifier);
162			}
163	tim	1962	SelectionCompiler compiler;
164
165			const static int scriptLevelMax = 10;
166			int scriptLevel;
167
168			Context stack[scriptLevelMax];
169
170			std::string filename;
171			std::string script;
172			std::vector<int> linenumbers;
173			std::vector<int> lineIndices;
174			std::vector<std::vector<Token> > aatoken;
175			int pc; // program counter
176
177	tim	1965	bool error;
178	tim	1962	std::string errorMessage;
179
180			std::vector<Token> statement;
181			int statementLength;
182
183	tim	1965	SimInfo* info;
184	tim	1967	NameFinder finder;
185			int nStuntDouble; //natoms + nrigidbodies
186			std::map<std::string, boost::any > variables;
187	tim	1961	};
188
189			}
190			#endif