libs/EDoc/File.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/File.h"
#include "EDoc/PersistenceIFace.h"
#include "EDoc/Dictionary.h"
#include "EDoc/exceptions.h"
#include "EDoc/PStack.h"
#include "EDoc/StackRef.h"

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

namespace EDoc
{
   //===========================================================================
   uint8_t File::GetRecordType() const
   {
      return VALUE_RECORD_TYPE_FILE;
   }
   //===========================================================================
   File::File(Dictionary& dict_in, std::string key_name_in) :
      StringIdentifiedObject(dict_in, key_name_in)
   {
   }
   //===========================================================================
   File::File(Dictionary& dict_in, int32_t index_in) :
      StringIdentifiedObject(dict_in, index_in)
   {
   }
   //===========================================================================
   File& File::operator=(const File& right)
   {
      // @@@Brendon Do i need to assign the StringIdentifiedObject parts too?
      if (this == &right)
      {
         return *this;
      }

      name = right.name;
      return *this;
   }
   //===========================================================================
   void File::Read(PersistenceIFace& file, IndexedDictionary& EDOC_UNUSED(idict))
   {
      name = file.ReadString(KEY_NAME);
      populated = true;
      SetKeyName(name);
   }
   //===========================================================================
   void File::Write(PersistenceIFace& file) const
   {
      file.WriteString(KEY_NAME, name);
   }
   //===========================================================================
   /** \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 file.", Message);
   //===========================================================================
   void File::Merge(const StringIdentifiedObject& right_in)
   {
      const File& right(dynamic_cast<const File&>(right_in));
      
      if (!name.size())
      {
         *this = right;
         return;
      }
      
      if (name != right.name)
      {
         EDOC_MERGE_ERROR("Unable to merge two files with different names.");
      }

      if (!populated)
      {
         populated = right.populated;
      }
   }
   //===========================================================================
   std::ostream& File::Print(std::ostream& out, std::string prefix) const
   {
      out << prefix << "Name: " << name << std::endl;
      return out;
   }
   //===========================================================================
   size_t File::ReplaceReferences(PStack& EDOC_UNUSED(stack), 
      void* EDOC_UNUSED(remove), void* EDOC_UNUSED(replace))
   {
      return 0;
   }
   //===========================================================================
   void File::Validate(PStack& stack, const Dictionary& dict_in) const
   {
      StackRef ref(stack, this);
      if (!ref)
      {
         return;
      }
      
      EDOC_ASSERT(&dict == &dict_in, 
         "Current dict: " << &dict 
         << "\nRequired dict: " << &dict_in
         << "\nKey: " << key_name
         << "\nIndex: " << index);

      //EDOC_ASSERT(populated, "");
      EDOC_ASSERT(dict_in.files.Get(GetKeyName()) == this, "");
      
      // @@@Brendon Validate that the keyname from StringIdentifiedObject is the
      // same as what we would calculate the keyname to be from our internal
      // data. Mismatches may occur from assignment operator.
   }
   //===========================================================================
}

---