libs/EDoc/Location.cpp

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

*******************************************************************************/
#include "config.h"

#include "EDoc/Location.h"
#include "EDoc/PersistenceIFace.h"
#include "EDoc/File.h"
#include "EDoc/Dictionary.h"
#include "EDoc/Logger.h"
#include "EDoc/exceptions.h"
#include "EDoc/PStack.h"
#include "EDoc/StackRef.h"

#include "EDoc/persistence_data.h"
#include "IndexedDictionary.h"

namespace EDoc
{
   //===========================================================================
   Location::Location(Dictionary* dict_in) :
      DictionarySpecific(dict_in),
      file(NULL),
      line(0)
   {
      file = dict.files.AlwaysGet("");
   }
   //===========================================================================
   Location::Location(const Location& right) :
      DictionarySpecific(&right.dict),
      file(right.file),
      line(right.line)
   {
   }
   //===========================================================================
   Location::Location(const Location& right, Dictionary& dict_in) :
      DictionarySpecific(&dict_in),
      file(NULL),
      line(right.line)
   {
      if (right.file)
      {
         file = dict.files.AlwaysGet(*right.file);
      }
   }
   //===========================================================================
   Location& Location::operator=(const Location& right)
   {
      if (this == &right)
      {
         return *this;
      }

      file = NULL;
      if (right.file)
      {
         file = dict.files.AlwaysGet(*right.file);
      }
      line = right.line;
      
      return *this;
   }
   //===========================================================================
   void Location::Read(PersistenceIFace& file, IndexedDictionary& idict)
   {
      Location::file = idict.files.AlwaysGet(
         file.ReadUInt32(KEY_SOURCE_FILE_NAME));
      line = file.ReadUInt32(KEY_SOURCE_LINE_NUMBER);
   }
   //===========================================================================
   void Location::Write(PersistenceIFace& file) const
   {
      file.WriteUInt32Debug(KEY_SOURCE_FILE_NAME, 
         Location::file->GetIndex(), Location::file->name);
      file.WriteUInt32(KEY_SOURCE_LINE_NUMBER, line);
   }
   //===========================================================================
   /** \brief define a small macro that is called upon a merge error.
    */
   #define EDOC_MERGE_ERROR(Message) \
      EDOC_Error(Message); \
      EDOC_THROW_EXCEPTION(MergeException, "Failed merging location.", Message);
   //===========================================================================
   void Location::Merge(const Location& right)
   {
      if (file->GetKeyName() == "")
      {
         // Assign merge the filename.
         file = dict.files.AlwaysGet(*right.file);
      }
      else if ((right.file->GetKeyName() != "") && 
         (file->GetKeyName() != right.file->GetKeyName()))
      {
         EDOC_MERGE_ERROR("Unable to merge two locations with different "
            "file names.");
      }
      
      if (line == 0)
      {
         line = right.line;
      }
      else if (right.line && line != right.line)
      {
         EDOC_MERGE_ERROR("Unable to merge two locations with different "
            "line numbers.");
      }
   }
   //===========================================================================
   bool Location::operator==(const Location& right) const
   {
      return ((line == right.line) &&
         file->GetName() == right.file->GetName());
   }
   //===========================================================================
   std::ostream& Location::Print(std::ostream& out, std::string prefix) const
   {
      out << prefix << "File: " << file->GetName() << std::endl;
      out << prefix << "Line: " << line << std::endl;
      return out;
   }
   //===========================================================================
   std::ostream& Location::SingleLinePrint(std::ostream& out) const
   {
      out << file->GetName() << ":" << line;
      return out;
   }
   //===========================================================================
   //@@@Brendon Possibly use special C++ type conversion functions.
   #define EDOC_REPLACE(DataType, Data, From, To, Count) \
      if ((void*)Data == From) {Data = (DataType*)To; Count++;}
   //===========================================================================
   size_t Location::ReplaceReferences(PStack& stack, void* remove, 
      void* replace)
   {
      size_t count = 0;
      if (!stack.Push(this))
      {
         return count;
      }

      EDOC_REPLACE(File, file, remove, replace, count);
      
      return count;
   }
   //===========================================================================
   void Location::Validate(PStack& stack, const Dictionary& dict_in) const
   {
      StackRef ref(stack, this);
      if (!ref)
      {
         return;
      }
      
      EDOC_ASSERT(&dict == &dict_in, "");
      file->Validate(stack, dict_in);
   }
   //===========================================================================
   bool Location::operator<(const Location& right) const
   {
      if (line < right.line)
      {
         return true;
      }
      else if (line > right.line)
      {
         return false;
      }

      return file->GetName() < right.file->GetName();
   }
   //===========================================================================
}

---