//----------------------------------------------------------------------------------------------------------------------
//
//  'C_LocationInSource'                                                                         
//
//  This file is part of libpm library                                                           
//
//  Copyright (C) 1996, ..., 2011 Pierre Molinaro.
//
//  e-mail : pierre@pcmolinaro.name
//
//  This library 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 2 of the License, or (at your option)
//  any later version.
//
//  This program is distributed in the hope it will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANDIBILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
//  more details.
//
//----------------------------------------------------------------------------------------------------------------------

#pragma once

//----------------------------------------------------------------------------------------------------------------------

#include "utilities/M_machine.h"
#include "utilities/MF_Assert.h"
#include "galgas2/C_SourceTextInString.h"

//----------------------------------------------------------------------------------------------------------------------

class C_String ;

//----------------------------------------------------------------------------------------------------------------------
//
//                 Class for referencing a location in source text                               
//
//----------------------------------------------------------------------------------------------------------------------

class C_LocationInSource {
  private: int32_t mIndex ;
  private: int32_t mLineNumber ;
  private: int32_t mColumnNumber ;
  private: C_SourceTextInString mSourceText ;

//---  
  public: C_LocationInSource (void) ;
  public: virtual ~C_LocationInSource (void) ;

  public: C_LocationInSource (const C_LocationInSource & inObject) ;

  public: C_LocationInSource & operator = (const C_LocationInSource & inObject) ;

  public: C_LocationInSource (const C_SourceTextInString & inSourceText,
                               const int32_t inIndex,
                               const int32_t inLine,
                               const int32_t inColumn) ;

  public: C_LocationInSource (const C_SourceTextInString & inSourceText,
                               const int32_t inLine,
                               const int32_t inColumn) ;

  public: void gotoNextLocation (const bool inPreviousCharWasEndOfLine) ;

  public: void resetLocation (void) ;

  public: void resetWithSourceText (const C_SourceTextInString & inSourceText) ;

  public: inline int32_t index (void) const { return mIndex ; }

  public: inline int32_t lineNumber (void) const { return mLineNumber ; }

  public: inline int32_t columnNumber (void) const { return mColumnNumber ; }

  public: C_String sourceFilePath (void) const ;
} ;

//----------------------------------------------------------------------------------------------------------------------