libs/EDoc/Exception.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/Exception.h"
#include "EDoc/Dictionary.h"
#include "EDoc/Function.h"
#include "EDoc/PStack.h"
#include "EDoc/StackRef.h"
#include "EDoc/Dictionary.h"
#include "EDoc/Type.h"

namespace EDoc
{
   //===========================================================================
   Exception::Exception(Dictionary* dict_in) :
      DictionarySpecific(dict_in),
      type(dict_in),
      visible(true),
      auto_throw_spec(false),
      function(NULL)
   {
   }
   //===========================================================================
   Exception::Exception(const Exception& right) :
      DictionarySpecific(&right.dict),
      type(right.type),
      visible(right.visible),
      auto_throw_spec(right.auto_throw_spec),
      function(right.function)
   {
   }
   //===========================================================================
   Exception::Exception(const Exception& right, Dictionary& dict_in) :
      DictionarySpecific(&dict_in),
      type(right.type, dict_in),
      visible(right.visible),
      auto_throw_spec(right.auto_throw_spec),
      function(NULL)
   {
      if (right.function)
      {
         function = dict.functions.AlwaysGet(*right.function);
      }
   }
   //===========================================================================
   Exception& Exception::operator=(const Exception& right)
   {
      if (this == &right)
      {
         return *this;
      }

      function = NULL;
      if (right.function)
      {
         function = dict.functions.AlwaysGet(*right.function);
      }
      type = right.type;
      visible = right.visible;
      auto_throw_spec = right.auto_throw_spec;
      return *this;
   }
   //===========================================================================
   void Exception::Validate(PStack& stack, const Dictionary& dict_in) const
   {
      StackRef ref(stack, this);
      if (!ref)
      {
         return;
      }
      
      EDOC_ASSERT(&dict == &dict_in, "");
      
      if (function)
      {
         function->Validate(stack, dict_in);
      }
      
      type.Validate(stack, dict_in);
   }
   //===========================================================================
   void Exception::Read(PersistenceIFace& file, IndexedDictionary& idict)
   {
      type.Read(file, idict);
   }
   //===========================================================================
   void Exception::Write(PersistenceIFace& file) const
   {
      EDOC_ASSERT(!auto_throw_spec, 
         "Auto generated exceptions should not be written to a merged file.");
      type.Write(file);
   }
   //===========================================================================
   bool Exception::operator==(const Exception& right) const
   {
      EDOC_Finer("function: " << function << ", right.function: " 
         << right.function);
      return type == right.type && auto_throw_spec == right.auto_throw_spec;
   }
   //===========================================================================
   //@@@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 Exception::ReplaceReferences(PStack& stack, void* remove, 
      void* replace)
   {
      size_t count = 0;
      if (!stack.Push(this))
      {
         return count;
      }

      // Dont replace recursivly. Only replace inside us.
      EDOC_REPLACE(Function, function, remove, replace, count);
      
      count += type.ReplaceReferences(stack, remove, replace);
      return count;
   }
   //===========================================================================
   std::ostream& Exception::Print(std::ostream& out, 
      std::string prefix) const
   {
      out << prefix << "Exception Type: " 
          << type.value->GetKeyName() << std::endl;
      type.loc.Print(out, prefix + INDENT_STR);
      out << prefix << "Visible: " << (visible ? "True":"False") << std::endl;
      out << prefix << "Auto Generated: " << (auto_throw_spec ? "True":"False") << std::endl;

      return out;
   }
   //===========================================================================
}

---