/*
BSD 3-Clause License
Copyright (c) 2024, k4m1 <me@k4m1.net>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. 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.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __KLSH_HISTORY__
#define __KLSH_HISTORY__
#include <fstream>
#include <string>
// Functionality related keeping track of given user input
//
class history {
public:
bool enabled = true;
// Enable history logging
//
inline void enable() {
this->enabled = this->open_logfile();
}
// Disable history logging
//
inline void disable() {
this->close_logfile();
this->enabled = false;
}
/* Write a new entry to our histfile if logging is enabled
*
* @param std::string& entry -- Line to write
*/
inline void log(std::string& entry) {
if (this->enabled) {
this->write(entry);
}
}
history(std::string name) : logfile_name(name) {
logfile.exceptions( std::ofstream::failbit | std::ofstream::badbit );
this->enable();
}
private:
std::ofstream logfile;
std::string logfile_name;
// Close our logfile
//
inline void close_logfile() {
this->logfile.close();
}
/* Try and open our logfile
*
* @return bool true on success, false on error.
*/
bool open_logfile();
/* Write new log entry to histfile.
* If writing fails, we'll disable logging.
*
* @param std::string entry -- String to write
*/
void write(std::string& entry);
};
#endif // __KLSH_HISTORY__