//////////////////////////////////////////////////////////////////////////////// /// @brief base class for a line editor /// /// @file /// /// DISCLAIMER /// /// Copyright 2014-2015 ArangoDB GmbH, Cologne, Germany /// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany /// /// Licensed under the Apache License, Version 2.0 (the "License"); /// you may not use this file except in compliance with the License. /// You may obtain a copy of the License at /// /// http://www.apache.org/licenses/LICENSE-2.0 /// /// Unless required by applicable law or agreed to in writing, software /// distributed under the License is distributed on an "AS IS" BASIS, /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. /// See the License for the specific language governing permissions and /// limitations under the License. /// /// Copyright holder is ArangoDB GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2014-2015, ArangoDB GmbH, Cologne, Germany /// @author Copyright 2011-2013, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// #ifndef ARANGODB_UTILITIES_LINE_EDITOR_H #define ARANGODB_UTILITIES_LINE_EDITOR_H 1 #include "Basics/Common.h" namespace arangodb { class ShellImplementation; // ----------------------------------------------------------------------------- // --SECTION-- class LineEditor // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief line editor //////////////////////////////////////////////////////////////////////////////// class LineEditor { LineEditor(LineEditor const&) = delete; LineEditor& operator= (LineEditor const&) = delete; // ----------------------------------------------------------------------------- // --SECTION-- public constants // ----------------------------------------------------------------------------- public: //////////////////////////////////////////////////////////////////////////////// /// @brief number of history entries //////////////////////////////////////////////////////////////////////////////// static const int MAX_HISTORY_ENTRIES = 1000; // ----------------------------------------------------------------------------- // --SECTION-- constructors and destructors // ----------------------------------------------------------------------------- public: //////////////////////////////////////////////////////////////////////////////// /// @brief constructor //////////////////////////////////////////////////////////////////////////////// LineEditor (std::string const& history); //////////////////////////////////////////////////////////////////////////////// /// @brief destructor //////////////////////////////////////////////////////////////////////////////// virtual ~LineEditor (); // ----------------------------------------------------------------------------- // --SECTION-- static public methods // ----------------------------------------------------------------------------- //////////////////////////////////////////////////////////////////////////////// /// @brief sort the alternatives results vector //////////////////////////////////////////////////////////////////////////////// static void sortAlternatives (std::vector&); // ----------------------------------------------------------------------------- // --SECTION-- public methods // ----------------------------------------------------------------------------- public: //////////////////////////////////////////////////////////////////////////////// /// @brief line editor open //////////////////////////////////////////////////////////////////////////////// bool open (bool autoComplete); //////////////////////////////////////////////////////////////////////////////// /// @brief line editor shutdown //////////////////////////////////////////////////////////////////////////////// bool close (); //////////////////////////////////////////////////////////////////////////////// /// @brief line editor prompt //////////////////////////////////////////////////////////////////////////////// std::string prompt (const std::string& prompt, const std::string& begin, bool& eof); //////////////////////////////////////////////////////////////////////////////// /// @brief get the history file path /// /// The path is "$HOME" plus _historyFilename, if $HOME is set. Else /// the local file _historyFilename. //////////////////////////////////////////////////////////////////////////////// std::string historyPath (); //////////////////////////////////////////////////////////////////////////////// /// @brief add to history //////////////////////////////////////////////////////////////////////////////// void addHistory (const std::string&); //////////////////////////////////////////////////////////////////////////////// /// @brief save the history //////////////////////////////////////////////////////////////////////////////// bool writeHistory (); //////////////////////////////////////////////////////////////////////////////// /// @brief send a signal to the shell implementation //////////////////////////////////////////////////////////////////////////////// void signal (); // ----------------------------------------------------------------------------- // --SECTION-- protected methods // ----------------------------------------------------------------------------- protected: //////////////////////////////////////////////////////////////////////////////// /// @brief arranges for the correct creation of the the ShellImplementation //////////////////////////////////////////////////////////////////////////////// void prepareShell (); // ----------------------------------------------------------------------------- // --SECTION-- virtual protected methods // ----------------------------------------------------------------------------- protected: //////////////////////////////////////////////////////////////////////////////// /// @brief creates a concrete Shell with the correct parameter //////////////////////////////////////////////////////////////////////////////// virtual void initializeShell () = 0; // ----------------------------------------------------------------------------- // --SECTION-- protected variables // ----------------------------------------------------------------------------- protected: //////////////////////////////////////////////////////////////////////////////// /// @brief the shell implementation //////////////////////////////////////////////////////////////////////////////// ShellImplementation* _shellImpl; //////////////////////////////////////////////////////////////////////////////// /// @brief path to the history file //////////////////////////////////////////////////////////////////////////////// std::string _history; }; } #endif // ----------------------------------------------------------------------------- // --SECTION-- END-OF-FILE // -----------------------------------------------------------------------------