// ---------------------------------------------------------------------------
// - IpPoint.hpp                                                             -
// - afnix:mth module - integer plane point class definitions                -
// ---------------------------------------------------------------------------
// - This program is free software;  you can redistribute it  and/or  modify -
// - it provided that this copyright notice is kept intact.                  -
// -                                                                         -
// - 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.  In no event shall -
// - the copyright holder be liable for any  direct, indirect, incidental or -
// - special damages arising in any way out of the use of this software.     -
// ---------------------------------------------------------------------------
// - copyright (c) 1999-2012 amaury darsch                                   -
// ---------------------------------------------------------------------------

#ifndef  AFNIX_IPPOINT_HPP
#define  AFNIX_IPPOINT_HPP

#ifndef  AFNIX_STRING_HPP
#include "String.hpp"
#endif

namespace afnix {

  /// The IpPoint class is a class that implements a two dimensional (plane)
  /// point with integer coordinates. The coordinates are denoted by the
  /// (x,y) tuple, thus making this class extremelly simple.
  /// @author amaury darsch

  class IpPoint : public Object {
  protected:
    /// the x coordinate
    long d_x;
    /// the y coordinate
    long d_y;

  public:
    /// create a default point
    IpPoint (void);

    /// create a point by coordinates
    /// @param x the x coordinate
    /// @param y the y coordinate
    IpPoint (const long x, const long y);

    /// copy construct this point
    /// @param that the object to copy
    IpPoint (const IpPoint& that);

    /// assign a point to this one
    /// @param that the object to assign
    IpPoint& operator = (const IpPoint& that);

    /// @return the class name
    String repr (void) const;

    /// @return a clone of this object
    Object* clone (void) const;

    /// set the point x coordinate
    /// @param x the x coordinate to set
    virtual void setx (const long x);

    /// @return the point x coordinate
    virtual long getx (void) const;

    /// set the point y coordinate
    /// @param y the y coordinate to set
    virtual void sety (const long y);

    /// @return the point y coordinate
    virtual long gety (void) const;

    /// set the point coordinates at once
    /// @param x the x coordinate
    /// @param y the y coordinate
    virtual void set (const long x, const long y);

  public:
    /// create a new object in a generic way
    /// @param argv the argument vector
    static Object* mknew (Vector* argv);

    /// @return true if the given quark is defined
    bool isquark (const long quark, const bool hflg) const;

    /// apply this object with a set of arguments and a quark
    /// @param robj  the current runnable
    /// @param nset  the current nameset    
    /// @param quark the quark to apply these arguments
    /// @param argv  the arguments to apply
    Object* apply (Runnable* robj, Nameset* nset, const long quark,
                   Vector* argv);
  };
}

#endif
