predictorActivator.h

Go to the documentation of this file.

/******************************************************
 *  Presage, an extensible predictive text entry system
 *  ---------------------------------------------------
 *
 *  Copyright (C) 2008  Matteo Vescovi <matteo.vescovi@yahoo.co.uk>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
                                                                             *
                                                                **********(*)*/


#ifndef PRESAGE_PREDICTORACTIVATOR
#define PRESAGE_PREDICTORACTIVATOR

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include "configuration.h"
#include "predictorRegistry.h"
#include "context_tracker/contextTracker.h"
#include "prediction.h"
#include "logger.h"
#include "dispatcher.h"

#include "combiner.h"
#include "meritocracyCombiner.h"

#include "predictors/predictor.h"


#ifdef STDC_HEADERS
# include <stdlib.h>  // needed for abort function
#endif


class PredictorActivator : public Observer {
public:
//PLUMP    PredictorActivator(HistoryTracker&,
//PLUMP              plump::Plump&);

    PredictorActivator(Configuration* config, PredictorRegistry* registry, ContextTracker* contextTracker);

    ~PredictorActivator();

    Prediction predict(unsigned int multiplier, const char** filter);

    int getPredictTime() const;
    
    void setPredictTime(const std::string& predictTime);

    std::string getCombinationPolicy() const;

    void setCombinationPolicy(const std::string& policy);

    void setMaxPartialPredictionSize (const std::string& size);

    void setLogger (const std::string& level);

    void parse_internal_commands (Prediction& pred);

    virtual void update (const Observable* variable);

    static const char* LOGGER;
    static const char* PREDICT_TIME;
    static const char* MAX_PARTIAL_PREDICTION_SIZE;
    static const char* COMBINATION_POLICY;

private:
    // execute predictor function (invoked in thread)
    void *execute(void *);


    Configuration*  config;
    PredictorRegistry* predictorRegistry;
    ContextTracker* contextTracker;

    Logger<char>    logger;

    Combiner*       combiner;
    std::string     combinationPolicy;

    int max_partial_prediction_size;

    std::vector<Prediction> predictions; // predictions computed by each predictor are returned here

    int predict_time;

    Dispatcher<PredictorActivator> dispatcher;
};

#endif // PRESAGE_PREDICTORACTIVATOR