ProximLineReader.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    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.
 */
/**
 * @file ProximLineReader.hh
 *
 * Declaration of ProximLineReader class.
 *
 * @author Veli-Pekka Jääskeläinen 2005 (vjaaskel-no.spam-cs.tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_PROXIM_LINE_READER_HH
#define TTA_PROXIM_LINE_READER_HH
 
#include <iostream>
#include <wx/wx.h>
#include <string>
#include <queue>
#include "LineReader.hh"
#include "Application.hh"
#include "Exception.hh"
 
/**
 * Handles user input passing between the simulator and GUI threads in Proxim.
 *
 * This class is designed to act as an interface between two threads:
 * A GUI thread handling the user interface, and a worker thread running the
 * simulator engine. The worker thread waits for the user input
 * by listening to the 'input_' condition. When the line reader receives
 * input from the GUI thread, the worker thread is signaled about the input
 * by setting the input_ condition. If the worker thread is busy and not
 * listening to the input_ condition signal when the GUI thread signals
 * about user input, the signal is lost and the user input is ignored.
 * Therefore the user input should be disabled in the GUI when the worker
 * thread is busy. ProximLineReader requests user input and sends simulator
 * engine output to the GUI thread using SimulatorEvents and the standard
 * wxWidgets event handling system.
 */
class ProximLineReader : public LineReader {
public:
    ProximLineReader();
    virtual ~ProximLineReader();
 
    virtual void initialize(
    std::string defPrompt = "",
    FILE* in = stdin,
    FILE* out = stdout,
    FILE* err = stderr);
 
    virtual std::string readLine(std::string prompt = "");
 
    virtual char charQuestion(
        std::string question, std::string allowedChars,
        bool caseSensitive = false, char defaultAnswer = '\0');
 
    void input(std::string command);
 
    virtual std::ostream& outputStream();
    void output(std::string text);
 
    virtual void setInputHistoryLog(const std::string& historyFilename);
 
    std::string inputHistoryFilename() const;
 
private:
    /// Copying not allowed.
    ProximLineReader(const ProximLineReader&);
    /// Assignment not allowed.
    ProximLineReader& operator=(const ProximLineReader&);
    wxMutex* mutex_;
    /// Condition, which is signaled when user input is received from the GUI.
    wxCondition* input_;
    /// Input prompt.
    std::string prompt_;
    /// Input queue.
    std::queue<std::string> inputQueue_;
    /// GUI to send the events to.
    wxEvtHandler* gui_;
    /// Output stream which converts the output to SimulatorEvents.
    std::ostream* outputStream_;
 
    /// Name of the input history file.
    std::string historyFile_;
 
    static const std::string DEFAULT_LOG_FILE_NAME;
};
 
 
/**
 * Stream buffer for the ProximLROutputStream.
 *
 * This streambuffer converts the stream output to SimulatorEvents when
 * the buffer cotnetnts is flushed.
 */
class ProximLROutputBuffer : public std::streambuf {
public:
    ProximLROutputBuffer(ProximLineReader* lineReader);
    virtual ~ProximLROutputBuffer();
protected:
    int overflow(int);
    int sync();
private:
    void flushBuffer();
    ProximLineReader* lineReader_;
    const unsigned int BUFFER_SIZE;
 
};
 
 
/**
 * An output stream which converts stream output to SimulatorEvents.
 */
class ProximLROutputStream : public std::ostream {
public:
    ProximLROutputStream(ProximLineReader* lineReader);
    virtual ~ProximLROutputStream();
};
 
#endif