fex_rule.h

Go to the documentation of this file.

//
//    FreeLing - Open Source Language Analyzers
//
//    Copyright (C) 2014   TALP Research Center
//                         Universitat Politecnica de Catalunya
//
//    This library is free software; you can redistribute it and/or
//    modify it under the terms of the GNU Affero General Public
//    License as published by the Free Software Foundation; either
//    version 3 of the License, or (at your option) any later version.
//
//    This library 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
//    Affero General Public License for more details.
//
//    You should have received a copy of the GNU Affero General Public
//    License along with this library; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
//    contact: Lluis Padro (padro@lsi.upc.es)
//             TALP Research Center
//             despatx C6.212 - Campus Nord UPC
//             08034 Barcelona.  SPAIN
//

#ifndef _FEX_RULE
#define _FEX_RULE

#include <map>
#include <set>
#include "freeling/morfo/language.h"
#include "freeling/morfo/tagset.h"
#include "freeling/regexp.h"

#define OP_NONE 0
#define OP_AND 1
#define OP_OR 2

namespace freeling {

  class fex_rulepack;  // predeclaration


  class fex_status : public processor_status {
  public:
    std::map<std::wstring,std::map<int,std::list<std::wstring> > > features;
    std::map<std::wstring,std::vector<std::wstring> > re_result;
  };


  class fex_condition {
  private:
    std::wstring cid;
    std::wstring function;
    std::wstring focus;
    std::wstring split;
    std::wstring literal;
    std::set<std::wstring> *fileset;
    freeling::regexp match_re;

    bool negated;
    bool cond_true;

    static const freeling::regexp split_re;

    std::list<std::wstring> get_target(const word &, const tagset&) const;    

  public:
    // constructor
    fex_condition();
    fex_condition(const std::wstring&,const std::wstring&,const std::wstring&,const std::wstring&, 
                  std::map<std::wstring,std::set<std::wstring> > &);
    fex_condition(const fex_condition &);
    fex_condition& operator=(const fex_condition&);

    bool check(const word&, const tagset&, fex_status *) const;
    bool is_true() const;
    std::wstring get_match(int, fex_status *) const;
    void trace(int) const;
  };


  class feature_function {  
  public: 
    virtual void extract (const sentence &, int, std::list<std::wstring> &) const =0;
    virtual ~feature_function() {};
  };



  class fex_rule {  
  private:
    std::wstring rid;
    std::wstring pattern;
    int left,right;
    std::list<fex_condition> conds;
    int operation;
    const std::map<std::wstring,const feature_function*> & feat_functs;

    static const freeling::regexp rulepat;
    static const freeling::regexp rulepat_anch;
    static const freeling::regexp subexpr;
    static const freeling::regexp featfun;

    void pattern_instance(const sentence &, int, const tagset &, std::list<std::wstring> &) const;
    void get_replacements(const std::wstring &, const word &, const tagset &, std::list<std::wstring> &) const;

  public:
    fex_rule (const std::wstring &, const std::wstring &, const std::wstring &, int, 
              const std::list<fex_condition> &, const std::map<std::wstring,const feature_function*> &);
    fex_rule(const fex_rule &);
    fex_rule& operator=(const fex_rule&);

    // get rule id
    std::wstring get_id() const;
    void precompute(const sentence&, int, const tagset&) const;
    void extract(const sentence&, int, int, const tagset&, std::list<std::wstring> &) const;
    int get_left() const;
    int get_right() const;

    static bool check_conds(const std::list<fex_condition> &, int, const word &, const tagset &, fex_status*);

    void trace(int) const;
  };



  class fex_rulepack  {

  public:
    std::list<fex_condition> conds;
    int operation;
    std::list<fex_rule> rules;

    fex_rulepack();
    fex_rulepack(const fex_rulepack &);
    fex_rulepack& operator=(const fex_rulepack&);

    void trace(int) const;
  };

} // namespace

#endif