diff options
Diffstat (limited to '3rdparty/python-console/ParseHelper.h')
-rw-r--r-- | 3rdparty/python-console/ParseHelper.h | 169 |
1 files changed, 169 insertions, 0 deletions
diff --git a/3rdparty/python-console/ParseHelper.h b/3rdparty/python-console/ParseHelper.h new file mode 100644 index 00000000..8824fc39 --- /dev/null +++ b/3rdparty/python-console/ParseHelper.h @@ -0,0 +1,169 @@ +/** +Copyright (c) 2014 Alex Tsui + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. +*/ + +#ifndef PARSE_HELPER_H +#define PARSE_HELPER_H +#include <string> +#include <vector> +#include <list> +#include <boost/shared_ptr.hpp> +#include "ParseMessage.h" + +class ParseListener; + +/** +Helps chunk lines of Python code into compilable statements. +*/ +class ParseHelper +{ +public: + struct Indent + { + std::string Token; + Indent( ); + Indent( const std::string& indent ); + }; + + /** + Handle different states of parsing. Subclasses override + process(const std::string&) to handle different types of multiline + statements. + */ + struct ParseState + { + ParseHelper& parent; + ParseState( ParseHelper& parent_ ); + virtual ~ParseState( ); + + /** + Processes a single line of user input. + + Subclasses should return false if further processing should be done. In + this case, the command buffer should be topped by the next statement to + parse. + + \return whether processing of the line is done. + */ + virtual bool process(const std::string& str) = 0; + }; + + struct ContinuationParseState : public ParseState + { + using ParseState::parent; + ContinuationParseState( ParseHelper& parent_ ); + virtual bool process( const std::string& str); + }; + + /** + Handle parsing a multiline indented block. Example of such a block: + + for i in range(10): + print i + print i*i + + */ + struct BlockParseState : public ParseState + { + Indent indent; + + BlockParseState( ParseHelper& parent ); + BlockParseState( ParseHelper& parent, const std::string& indent_ ); + + // return whether processing is finished + virtual bool process(const std::string& str); + + // return if there was an error + bool initializeIndent(const std::string& str); + }; + friend class BlockParseState; + + struct BracketParseState : public ParseState + { + static const std::string OpeningBrackets; + static const std::string ClosingBrackets; + + std::list<char> brackets; + std::list<std::string> m_buffer; + + /** + Return whether open brackets remain unclosed in \a str. + */ + static bool HasOpenBrackets(const std::string& str); + static bool LoadBrackets(const std::string& str, + std::list<char>* stack); + + BracketParseState( ParseHelper& parent, const std::string& firstLine ); + + virtual bool process(const std::string& str); + }; + +protected: + // TODO: Create a ContinuationParseState to handle this + bool inContinuation; + std::vector< ParseListener* > listeners; + std::vector< boost::shared_ptr< ParseState > > stateStack; + std::vector< std::string > commandBuffer; + +public: + static bool PeekIndent( const std::string& str, Indent* indent ); + +public: + ParseHelper( ); + +public: + void process( const std::string& str ); + + bool buffered( ) const; + + /** + Generate a parse event from the current command buffer. + */ + void flush( ); + + /** + Reset the state of the helper. + */ + void reset( ); + + bool isInContinuation( ) const; + + void subscribe( ParseListener* listener ); + void unsubscribeAll( ); + void broadcast( const ParseMessage& msg ); + +}; // class ParseHelper + +inline bool operator== ( const ParseHelper::Indent& a, const ParseHelper::Indent& b ) +{ + return a.Token == b.Token; +} + +inline bool operator!= ( const ParseHelper::Indent& a, const ParseHelper::Indent& b ) +{ + return a.Token != b.Token; +} + +#ifndef NDEBUG +void print(const ParseHelper::Indent& indent); +#endif + +#endif // PARSE_HELPER_H |