libaegis/sub/functor.h

Go to the documentation of this file.

//
//      aegis - project change supervisor
//      Copyright (C) 2007, 2008 Peter Miller
//
//      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 3 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, see
//      <http://www.gnu.org/licenses/>.
//

#ifndef LIBAEGIS_SUB_FUNCTOR_H
#define LIBAEGIS_SUB_FUNCTOR_H

#include <common/ac/shared_ptr.h>

#include <common/nstring.h>
#include <common/wstring.h>

class sub_context_ty; // forward
class wstring_list; // forward

class sub_functor
{
public:
    typedef aegis_shared_ptr<sub_functor> pointer;

    virtual ~sub_functor();

    nstring name_get() const { return name; }

    virtual wstring evaluate(sub_context_ty *cp, const wstring_list &arg) = 0;

    wstring
    operator()(sub_context_ty *cp, const wstring_list &arg)
    {
        return evaluate(cp, arg);
    }

    virtual bool append_if_unused() const = 0;

    virtual bool override() const = 0;

    virtual bool resubstitute() const = 0;

    virtual bool must_be_used() const = 0;

    virtual void resubstitute_set() = 0;

    virtual void override_set() = 0;

    virtual void optional_set() = 0;

    virtual void append_if_unused_set() = 0;

protected:
    sub_functor(const nstring &name);

private:
    nstring name;

    sub_functor();

    sub_functor(const sub_functor &);

    sub_functor &operator=(const sub_functor &);
};

#endif // LIBAEGIS_SUB_FUNCTOR_H

---