TermExpander.h

Go to the documentation of this file.

//-*- Mode: C++ -*-
//
//  DDC originally by Alexey Sokirko
//  Changes and modifications 2011-2018 by Bryan Jurish
//
//  This file is part of DDC.
// 
//  DDC is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
// 
//  DDC 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 Lesser General Public License for more details.
// 
//  You should have received a copy of the GNU Lesser General Public License
//  along with DDC.  If not, see <http://www.gnu.org/licenses/>.
//

#ifndef DDC_TERM_EXPANDER_H
#define DDC_TERM_EXPANDER_H

#include "../CommonLib/utilit.h"
#include "CCurl.h"

//======================================================================
class CTermExpander {
public:
    string m_Class;

    string m_Label;

    string m_Param;

public:
    //------------------------------------------------------------

    CTermExpander(const string &cls, const string& label, const string& param)
        : m_Class(cls), m_Label(label), m_Param(param)
    {};

    CTermExpander(const string &label=string("NoLabel"), const string& param=string(""))
        : m_Class("None"), m_Label(label), m_Param(param)
    {};

    virtual CTermExpander* mapClone(map<CTermExpander*,CTermExpander*>& xlate) const;

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const
    { return new CTermExpander(m_Class, m_Label, m_Param); };

    virtual ~CTermExpander(void) {};

    virtual void compile(void) {};

public:
    //------------------------------------------------------------

    virtual string configString(void) const;

    virtual void expand(const string& src, set<string>& dst);

    virtual void expand(const set<string>& src, set<string>& dst);
};

//======================================================================
class TxId : public CTermExpander {
public:
    TxId(const string &label=string("Id"), const string& param=string(""))
        : CTermExpander("Id",label,param)
    {};
    virtual ~TxId(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const
    { return new TxId(m_Label,m_Param); };
    
    virtual void expand(const set<string>& src, set<string>& dst);
};

//======================================================================
typedef vector<CTermExpander*> TxList;

class TxChain : public CTermExpander {
public:
    TxList m_Chain;

public:
    TxChain(const string &label=string("Chain"), const string& param=string(""))
        : CTermExpander("Chain",label,param)
    {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const;

    virtual ~TxChain(void) {};

    void append(TxList& txl);

    inline void append(TxChain& txc);

    void append(CTermExpander *tx);

    string chainString(const string& joinstr=string("|"));

    virtual void expand(const set<string>& src, set<string>& dst);
};

//======================================================================
class TxLang : public CTermExpander {
public:
    MorphLanguageEnum m_Lang;

public:
    TxLang(const string& cls=string("Lang"), const string &label=string("Lang"), const string& param=string("Generic"));
    virtual ~TxLang(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const
    { return (CTermExpander*)new TxLang(*this); };
  
    //virtual void expand(const set<string>& src, set<string>& dst);

    virtual void setLanguage(MorphLanguageEnum lang);

    virtual void setLanguage(const string &lang);
};

//======================================================================
class TxMorph : public TxLang {
public:
    TxMorph(const string &label=string("Morph"), const string& param=string(""))
        : TxLang("Morph",label,param)
    {};
    virtual ~TxMorph(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const
    { return (CTermExpander*)new TxMorph(*this); };

    virtual void expand(const set<string>& src, set<string>& dst);
};

//======================================================================
class TxToLower : public TxLang {
public:
    TxToLower(const string &label=string("ToLower"), const string& param=string(""))
        : TxLang("ToLower",label,param)
    {};
    virtual ~TxToLower(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const
    { return (CTermExpander*)new TxToLower(*this); };
  
    virtual void expand(const set<string>& src, set<string>& dst);
};

//======================================================================
class TxToUpper : public TxLang {
public:
    TxToUpper(const string &label=string("ToUpper"), const string& param=string(""))
        : TxLang("ToUpper",label,param)
    {};
    virtual ~TxToUpper(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const
    { return (CTermExpander*)new TxToUpper(*this); };
  
    virtual void expand(const set<string>& src, set<string>& dst);
};

//======================================================================
class TxCase : public TxLang {
public:
    TxCase(const string &label=string("Case"), const string& param=string(""))
        : TxLang("Case",label,param)
    {};
    virtual ~TxCase(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const
    { return (CTermExpander*)new TxCase(*this); };
  
    virtual void expand(const set<string>& src, set<string>& dst);
};


//======================================================================
class TxCurl : public CTermExpander {
public:
    CCurl m_CCurl;

public:
    TxCurl(const string &cls=string("Curl"), const string &label=string("Curl"), const string& param=string(""))
        : CTermExpander(cls,label,param)
    {};

    virtual ~TxCurl(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const;
  
    //--------------------------------------------------------------
    //\name Subclass API

    virtual void compile(void);

    virtual bool perform(void)
    { return m_CCurl.perform_cached(); };

    //--------------------------------------------------------------
    // expansion API (nothing here)
    //virtual void expand(const set<string>& src, set<string>& dst);
};


//======================================================================
class TxCab : public TxCurl {
public:
    string m_UrlBase;

    int m_Debug;

    int m_MapMode;

public:
    //------------------------------------------------------------
    TxCab(const string &label=string("Cab"), const string& param=string(""), int Debug=0, int MapMode=0)
        : TxCurl("Cab",label,param), m_Debug(Debug), m_MapMode(MapMode)
    {};
    virtual ~TxCab(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const;
  
    virtual void compile(void);

    virtual void expand(const set<string>& src, set<string>& dst);
};

//======================================================================
class TxCabMap : public TxCab {
public:
    //------------------------------------------------------------
    TxCabMap(const string &label=string("CabMap"), const string& param=string(""), int Debug=0, int MapMode=1)
        : TxCab(label,param,Debug,MapMode)
    {
        m_Class = "CabMap";
    };
    virtual ~TxCabMap(void) {};

    virtual CTermExpander* clone(map<CTermExpander*,CTermExpander*>& xlate) const;
};


//======================================================================
class TxDispatcher {
public:
    typedef map<string,CTermExpander*> TxMap;

    TxMap m_tx;

    list<string> m_txlist;

public:
    //--------------------------------------------------------------
    //\name Constructors etc.
    TxDispatcher(void)
    {};

    TxDispatcher* clone() const;

    ~TxDispatcher(void);

    void clear(bool doDelete=true);

    void ensureDefaultExpanders(MorphLanguageEnum mlang, MorphLanguageEnum clang, bool doInfl=true, bool doCase=true);

    inline void ensureDefaultExpanders(MorphLanguageEnum lang=morphGeneric)
    { ensureDefaultExpanders(lang,lang); };

public:
    //--------------------------------------------------------------
    //\name I/O API
    CTermExpander *addExpander(const string &spec);

    void compile(void);

    string configString(const string &prefix="") const;

public:
    //--------------------------------------------------------------
    //\name Runtime API
    void insert(const string &label, CTermExpander *tx);

    void insert(CTermExpander *tx);

    void remove(const string &label);

    CTermExpander *get(const string &label) const;

    TxChain getChain(const vector<string> &labels);

    TxChain getChain(const string& spec);
};


//======================================================================
// Utilities

void parseTermExpanderSpec(const string &spec, string &txclass, string &txlabel, string &txparam);

CTermExpander *newTermExpander(const string& class_="Id", const string& label=string(""), const string& param=string(""));

#endif /* DDC_TERM_EXPANDER_H */

/*--- emacs style variables ---
 * Local Variables:
 *  mode: C++
 *  c-file-style: "ellemtel"
 *  c-basic-offset: 4
 *  tab-width: 8
 *  indent-tabs-mode: nil
 * End:
 */