include/EDoc/Location.h

Go to the documentation of this file.

/*******************************************************************************

   Copyright (C) 2007 by Brendon Costa

   This library is free software; you can redistribute it and/or modify 
   it under the terms of the "LGPL Like" License defined in the file COPYING 
   that should have been distributed along with this source.

   This library 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.  

   You should have received a copy of the "LGPL Like" License 
   along with this library; see the file COPYING. if not, it can be 
   obtained from the EDoc++ website: 
   http://edoc.sourceforge.net/license.html

*******************************************************************************/
#ifndef EDOC_LOCATION_H
#define EDOC_LOCATION_H

#include "EDoc/DictionarySpecific.h"
#include "EDoc/stdint.h"
#include "EDoc/File.h"

#include <cstddef>
#include <ostream>
#include <sstream>

namespace EDoc
{
   class File;
   class PersistenceIFace;
   class IndexedDictionary;
   class Dictionary;
   class PStack;
   
   //===========================================================================
   /** \brief Represents a location in a source file used during compilation.
    *
    * The location is represented using a file and a line number. Quite often 
    * this information is not available and in those situations the instance
    * will contain an "empt" location, where the file is eithre NULL or pointing
    * to file type "", or the line number is 0
    */
   class Location : public DictionarySpecific
   {
      typedef void(Location::*safe_bool_t)() const;
      void this_type_does_not_support_comparison() const {}
   public:

      //------------------------------------------------------------------------
      /** \brief See CodeBlock::CodeBlock(Dictionary* dict_in=NULL)
       */
      Location(Dictionary* dict_in=NULL);

      //------------------------------------------------------------------------
      /** \brief See CodeBlock::CodeBlock(const CodeBlock& right)
       */
      Location(const Location& right);

      //------------------------------------------------------------------------
      /** \brief See CodeBlock::CodeBlock(const CodeBlock& right, 
       * Dictionary& dict_in)
       */
      Location(const Location& right, Dictionary& dict_in);

      //------------------------------------------------------------------------
      /** \brief See CodeBlock::operator=()
       */
      Location& operator=(const Location& right);

      //------------------------------------------------------------------------
      /** \brief See CodeBlock::Read()
       */
      void Read(PersistenceIFace& file, IndexedDictionary& idict);

      //------------------------------------------------------------------------
      /** \brief See CodeBlock::Write()
       */
      void Write(PersistenceIFace& file) const;

      //------------------------------------------------------------------------
      /** \brief See StringIdentifiedObject::Merge()
       */
      void Merge(const Location& right);

      //------------------------------------------------------------------------
      /** \brief See DictionarySpecific::ReplaceReferences()
       */
      virtual size_t ReplaceReferences(PStack& stack, 
         void* remove, void* replace);

      //------------------------------------------------------------------------
      /** \brief See DictionarySpecific::Print()
       */
      virtual std::ostream& Print(std::ostream& out, 
         std::string prefix="") const;

      //------------------------------------------------------------------------
      /** \brief See DictionarySpecific::Validate()
       */
      virtual void Validate(PStack& stack, const Dictionary& dict_in) const;

      //------------------------------------------------------------------------
      /** \brief Equivilance operator (Works across dictionaries).
       */
      bool operator==(const Location& right) const;

      //------------------------------------------------------------------------
      /** \brief Less than comparison so this can be used for std::map keys.
       *
       * Compares File first then line.
       */
      bool operator<(const Location& right) const;

      //------------------------------------------------------------------------
      /** \brief Returns true if location is non-empty through the boolean
       * evaluation operator.
       *
       * Uses the safe bool pattern which makes use of a member function pointer
       * type for the boolean operation.
       *
       * \return Returns true if the location provided is not an "empty"
       * location. I.e. it contains a file name or line number.
       */
      operator safe_bool_t() const
      {
         return ((line || (file && file->GetName().size())) ? 
            &Location::this_type_does_not_support_comparison : 
            NULL);
      }

      //------------------------------------------------------------------------
      /** \brief Prints to given stream in single line format which is
       * filename:line.
       */
      std::ostream& SingleLinePrint(std::ostream& out) const;


      //------------------------------------------------------------------------
      /** \brief Returns a string for this locatrion in single line format 
       * which is filename:line.
       */
      inline std::string GetNormalisedName() const
      {
         std::ostringstream stream;
         stream << file->GetName() << ":" << line;
         return stream.str();
      }
      

      //------------------------------------------------------------------------
      /** \brief A reference to the file object identifying the source file.
       */
      File* file;

      //------------------------------------------------------------------------
      /** \brief The line within the given source file.
       */
      uint32_t line;

      //------------------------------------------------------------------------
   };
   //===========================================================================
}

#endif // EDOC_LOCATION_H

---