include/EDoc/File.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_FILE_H
#define EDOC_FILE_H

#include "EDoc/StringIdentifiedObject.h"

#include <string>
#include <ostream>
#include <sstream>
#include <list>

namespace EDoc
{
   class PersistenceIFace;
   class IndexedDictionary;
   class Dictionary;
   class PStack;
   
   //===========================================================================
   /** \brief Represents a source file used during compilation.
    *
    * This is the simplest of the StringIdentifiedObject implementations. It
    * represents a source file used in compilation and as its data only contains
    * a string with that files name. This data type was created in order to
    * reduce the size of the .edc files by storing a refrenced file for location
    * objects etc as an integer index instead of the string with the full files
    * name.
    */
   class File : public StringIdentifiedObject
   {
   public:

      //------------------------------------------------------------------------
      /** \brief See StringIdentifiedObject::(Dictionary& dict_in, 
       * std::string key_name_in, bool populated_in=false)
       */
      File(Dictionary& dict_in, std::string key_name_in);

      //------------------------------------------------------------------------
      /** \brief See StringIdentifiedObject(Dictionary& dict_in, 
       * int32_t index_in, bool populated_in=false)
       */
      File(Dictionary& dict_in, int32_t index_in);

      //------------------------------------------------------------------------
      /** \brief Copies data from another object into this one.
       *
       * This can be used across different dictionaries and will only copy
       * object data but not identification information used in the
       * StringIdentifiedObject such as the key name.
       */
      File& operator=(const File& right);




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

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

      //------------------------------------------------------------------------
      /** \brief See StringIdentifiedObject::Merge()
       *
       * Merge will fail if the file names are not the same.
       */
      virtual void Merge(const StringIdentifiedObject& 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 See StringIdentifiedObject::GetRecordType()
       */
      virtual uint8_t GetRecordType() const;

      //------------------------------------------------------------------------
      /** \brief Returns the file name for the source file this represents.
       */
      inline std::string GetName() const 
      {
         return name;
      }

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




      // @@@Brendon Seems a bit silly having GetName() and a public data
      // attribute. Trying to be consistent with other objects where the data is
      // public
      //------------------------------------------------------------------------
      /** \brief Name of source file this object represents.
       */
      std::string name;

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

   };
   //===========================================================================
   typedef std::list<File*> FilePList;
   
   //---------------------------------------------------------------------------
}

#endif // EDOC_FILE_H

---