Location.cs

Go to the documentation of this file.

// -------------------------------------------------------------------------- //
// Project StaDyn                                                             //
// -------------------------------------------------------------------------- //
// File: Location.cs                                                          //
// Author: Daniel Zapico Rodríguez -  danzapico@gmail.com                     //
//         Francisco Ortín Soler - ortin@uniovi.es                            //
// Description:                                                               //
//    It Stores de location of a text element. I.e.class definition, an arith-//
//    metical operation,etc.                                                  //
//    Specificly, it is used for locating anspecific token of source code.    // 
//    An inmutable pattern is used because the instances of this class are    //
//    passive in nature. The instance don not ever need to change its state.  //
// -------------------------------------------------------------------------- //
// Create date: 05-03-2009                                                    //
// Modification date: 05-03-2009                                              //
namespace ErrorManagement {
    public class Location {
        
        #region Fields
        private string fileName;
        private int line;
        private int column;

        bool valid = false;
        #endregion

        #region Properties

        public string FileName {
            get { return fileName; }
        }
        public int Line {
            get { return line; }
        }
        public int Column {
            get { return column; }
        }

        public bool Valid {
            get { return this.valid; }
        }
        
        #endregion

        #region Constructor

        public Location(string fileName, int lineNumber, int columnNumber) {
            this.line = lineNumber;
            this.column = columnNumber;
            this.fileName = fileName;
            this.valid = true;
        }

        public Location() {
            this.valid = false;
        }
        #endregion
        
        #region ToString


        public override string ToString() {
            if (valid)
            return FileName + "[" + Line + ", " + Column + "]";
            return "[Cannot stablish location of the element]";
        }
        #endregion

        #region Equals & HasCode
        public override int GetHashCode() {
            return this.line.GetHashCode() * this.column.GetHashCode() * this.fileName.GetHashCode();
        }

        
        public override bool Equals(object obj) {
            if (obj == this) return true;
            
            Location node = obj as Location;
            
            if (obj == null) return false;
            
            return this.line == node.line && this.column == node.column && this.fileName.Equals(node.fileName);
        }
        public Location Clone() {
            return new Location(this.fileName, this.line, this.column);
        }
        #endregion
    }
}