// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// vim:set sts=4 ts=8:

// Copyright (c) 2001-2011 XORP, Inc and Others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
// 
// 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. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
// 
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net

// $XORP: xorp/policy/common/operator_base.hh,v 1.9 2008/10/02 21:58:07 bms Exp $

#ifndef __POLICY_COMMON_OPERATOR_BASE_HH__
#define __POLICY_COMMON_OPERATOR_BASE_HH__



#include "policy/policy_module.h"
#include "libxorp/xlog.h"

enum {
    HASH_OP_AND = 1,
    HASH_OP_OR,
    HASH_OP_XOR,
    HASH_OP_NOT,
    HASH_OP_EQ,
    HASH_OP_NE,
    HASH_OP_LT,
    HASH_OP_GT,
    HASH_OP_LE,
    HASH_OP_GE,
    HASH_OP_ADD,
    HASH_OP_SUB,
    HASH_OP_MUL,
    HASH_OP_DIV,
    HASH_OP_LSHIFT,
    HASH_OP_RSHIFT,
    HASH_OP_BITAND,
    HASH_OP_BITOR,
    HASH_OP_BITXOR,
    HASH_OP_REGEX,
    HASH_OP_CTR,
    HASH_OP_NEINT,
    HASH_OP_HEAD,
    HASH_OP_MAX = 32 // last
};

/**
 * @short Base class for operations.
 *
 * An operation is simply an operation that may be done upon elements, such as
 * addition and comparison.
 */
class Oper {
public:
    typedef unsigned char Hash;

    Oper(Hash hash, unsigned arity) : _hash(hash), _arity(arity)
    {
	XLOG_ASSERT(_hash < HASH_OP_MAX);
    }

    virtual ~Oper() {};

    /**
     * @return number of arguments operation takes
     */
    unsigned arity() const { return _arity; }

    /**
     * Must be unique.
     *
     * @return string representation of operation.
     */
    virtual string str() const = 0;

    Hash hash() const { return _hash; }

private:
    Hash	_hash;
    unsigned	_arity;
};

/**
 * @short Base class for unary operations.
 */
class UnOper : public Oper {
public:
    UnOper(Hash hash) : Oper(hash, 1) {}
    virtual ~UnOper() {};

    virtual string str() const = 0;
};

/**
 * @short Base class for binary operations.
 */
class BinOper : public Oper {
public:
    BinOper(Hash hash) : Oper(hash, 2) {}
    virtual ~BinOper() {};

    virtual string str() const = 0;
};

#endif // __POLICY_COMMON_OPERATOR_BASE_HH__
