/** API for script procedure
 * Is a proxy to ScriptProcedure, but only exposes relevant methods
 */
class ScriptProcedureApi {
public:
    ScriptProcedureApi(ProcedureApi*, ScriptProcedure* p);

public slots:
    // Functions to change something to Apex

    QStringList parameterNames(const QString stimulusID) const;

    QVariantMap parameterMap(const QString stimulusID) const;

    QVariant parameterValue (const QString& parameter_id);

    /**
     * Register a new parameter with the manager.
     */
    void registerParameter(const QString& name); //TODO more parameters?

    // Functions to get something from Apex
    /** Get list of trials for this procedure
     * will return a QList of ApexTrial objects
     */
    QObjectList trials() const;

    QStringList stimuli() const;

    QVariant fixedParameterValue(const QString stimulusID,
                                    const QString parameterID);

    QString answerElement(const QString trialid);

    // Misc functions
    /** Shows the user a messagebox with the specified messagebox
     */
    void messageBox(const QString message) const;

    void showMessage(const QString& message) const;

    void abort(const QString& message) const;

    /**
      * Returns full filepath for relative path
      */
    QString absoluteFilePath(const QString& path);

signals:
    void showMessageBox(const QString title, const QString text) const;
};

class Trial {
public:
        Trial(QObject* parent = 0);
        Trial(const Trial& other);
        virtual ~Trial();

        virtual Trial& operator=(const Trial& other);

        typedef QList<Trial> List;

public slots:

        /** Add a screen to the list of screens to be shown
        * Every subsequently added stimulus will be associated with this screen
        * @param id the id of the screen
        * @param acceptresponse if true, the response of this screen will be
        * reported in the next processResult call
        * @param timeout if timeout >0, the screen wil disappear after timeout s.
        * If acceptresponse is true, timeout must be <=0
        */
        virtual void addScreen(const QString& id, bool acceptResponse, double timeout);

        /**
         * Add a stimulus to be played during the last added screen
         *
         * @param id id of the stimulus to be added
         * @param parameters parameters to be set before the stimulus is played
         * @param highlightElement id of screenelement to be highlighted during
         *                         presentation of this stimulus
         * @param waitafter time in s to wait after the stimulus was played
         */
        virtual void addStimulus(const QString& id, const QMap<QString, QVariant>& parameters,
                         const QString& highlightedElement, double waitAfter);

        virtual void setId(const QString& id);
        virtual void setAnswer(const QString& answer);

        virtual bool isValid() const;


        virtual int screenCount() const;
        virtual QString screen(int screenIndex) const;
        virtual bool acceptResponse(int screenIndex) const;
        virtual double timeout(int screenIndex) const;

        virtual int stimulusCount(int screenIndex) const;
        virtual QString stimulus(int screenIndex, int stimulusIndex) const;
        virtual QMap<QString, QVariant> parameters(int screenIndex, int stimulusIndex) const;
        virtual QString highlightedElement(int screenIndex, int stimulusIndex) const;
        virtual bool doWaitAfter(int screenIndex, int stimulusIndex) const;
        virtual double waitAfter(int screenIndex, int stimulusIndex);
        virtual QString id() const;
        virtual QString answer() const;

        /**
         * Clear all data
         */
        virtual void reset();

private:

        QSharedDataPointer<TrialPrivate> d;
};

class APEXDATA_EXPORT ScreenResult
{
public:
    ScreenResult();
    virtual ~ScreenResult();

    const QString toXML() const;

    virtual void clear();

    void SetStimulusParameter(const QString& parameter, const QString& value);
    const stimulusParamsT& GetStimulusParameters() const { return stimulusparams;};

    void setLastClickPosition(const QPointF& point);
    const QPointF& lastClickPosition() const;

    private:
        stimulusParamsT stimulusparams;     //! used to keep parameters set on the screen of the last trial (eg using a spinbox)
        QPointF mLastClickPosition;

        typedef QString KeyType;
        typedef QString ValueType;
        typedef QMap<KeyType, ValueType> Parent;
        Parent map;

        friend QDebug operator<< (QDebug dbg, const ScreenResult& screenResult);
    public:
        typedef Parent::const_iterator const_iterator;

        Parent::const_iterator begin() const;
        Parent::const_iterator end() const;
        const ValueType value (const KeyType& key, const ValueType& defaultValue = QString()) const;
        ValueType& operator[](const KeyType& key);
        const ValueType operator[](const KeyType& key) const;
        bool contains(const KeyType& key) const ;
        const Parent get() const;
};

class ResultHighlight {
    Q_OBJECT
    Q_PROPERTY(bool correct READ getCorrect WRITE setCorrect)
    Q_PROPERTY(QString highlightElement READ getHighlightElement WRITE setHighlightElement)
    Q_PROPERTY(bool overrideCorrectFalse READ getOverrideCorrectFalse WRITE setOverrideCorrectFalse)
    Q_PROPERTY(bool showCorrectFalse  READ getShowCorrectFalse WRITE setShowCorrectFalse)

public:
    ScriptResultHighlight(QObject* parent=0): QObject(parent) {}

    bool getCorrect() const {return correct;}
    void setCorrect(bool p) {correct=p;}

    QString getHighlightElement() const {return highlightElement;}
    void setHighlightElement(const QString& p) {highlightElement = p;}

    bool getOverrideCorrectFalse () {return overrideCorrectFalse;}
    void setOverrideCorrectFalse(bool p) {overrideCorrectFalse=p;}

    bool getShowCorrectFalse () {return showCorrectFalse; }
    void setShowCorrectFalse(bool p) {showCorrectFalse=p;}
};

public slots:
    QString version();

    /**
     * Get all files in the filesystem matching wildcard
     */
    QStringList files(const QString& path);

    /**
      * Read file content into string
      */
    QString readAll(const QString& path);

    /**
      * Get the duration of a WAV file in seconds
      */
    double stimulusDuration(const QString& path);

    /**
     * Get path without filename for relative path
     */
    QString path(const QString &s);

    // Deprecated: do not use!
    QString stripPath(const QString &s);

    /**
      * Returns full filepath for relative path
      */
    QString absoluteFilePath(const QString& path);

    /**
     * Add warning message to message window
     */
    void addWarning(const QString& warning);

    /**
     * Add error message to message window
     */
    void addError(const QString& warning);