FileWriter.h

Go to the documentation of this file.

#ifndef OSMSCOUT_FILEWRITER_H
#define OSMSCOUT_FILEWRITER_H
 
/*
  This source is part of the libosmscout library
  Copyright (C) 2009  Tim Teulings
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  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.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/
 
#include <cstdio>
#include <string>
#include <vector>
 
#include <osmscout/lib/CoreImportExport.h>
#include <osmscout/lib/CoreFeatures.h>
 
#include <osmscout/GeoCoord.h>
#include <osmscout/ObjectRef.h>
#include <osmscout/Point.h>
#include <osmscout/OSMScoutTypes.h>
 
#include <osmscout/util/Color.h>
#include <osmscout/util/Exception.h>
#include <osmscout/util/GeoBox.h>
 
namespace osmscout {

  class OSMSCOUT_API FileWriter CLASS_FINAL
  {
  private:
    std::string          filename;      
    std::FILE            *file=nullptr; 
    bool                 hasError=true; 
    std::vector<int32_t> deltaBuffer;   
    std::vector<uint8_t> byteBuffer;    
 
  public:
    static const uint64_t MAX_NODES;
 
  public:
    FileWriter() = default;
    ~FileWriter();
 
    void Open(const std::string& filename);
    void Close();
    void CloseFailsafe();
    bool IsOpen() const
    {
      return file!=nullptr;
    }
 
    bool HasError() const
    {
      return file==nullptr || hasError;
    }
 
    std::string GetFilename() const;
 
    FileOffset GetPos();
    void SetPos(FileOffset pos);
    void GotoBegin();
 
    void Write(const char* buffer, size_t bytes);
 
    void Write(const std::string& value);
 
    void Write(bool boolean);
 
    void Write(std::byte byteValue);
 
    void Write(int8_t number);
    void Write(int16_t number);
    void Write(int32_t number);
    void Write(int64_t number);
 
    void Write(uint8_t number);
    void Write(uint16_t number);
    void Write(uint32_t number);
    void Write(uint64_t number);
 
    void Write(uint16_t number, size_t bytes);
    void Write(uint32_t number, size_t bytes);
    void Write(uint64_t number, size_t bytes);
 
    void Write(const ObjectFileRef& ref);
 
    void Write(const MagnificationLevel& level)
    {
      Write(level.Get());
    }
 
    void Write(const Color& color);
 
    void WriteFileOffset(FileOffset offset);
    void WriteFileOffset(FileOffset offset,
                         size_t bytes);
 
    void WriteNumber(int16_t number);
    void WriteNumber(int32_t number);
    void WriteNumber(int64_t number);
 
    void WriteNumber(uint16_t number);
    void WriteNumber(uint32_t number);
    void WriteNumber(uint64_t number);
 
    void WriteNumber(const MagnificationLevel& level)
    {
      WriteNumber(level.Get());
    }

    void WriteBox(const GeoBox &bbox);

    void WriteCoord(const GeoCoord& coord);
    void WriteInvalidCoord();
 
    void Write(const std::vector<Point>& nodes, bool writeIds);
    void Write(const std::vector<GeoCoord>& nodes);
 
    void WriteTypeId(TypeId id, uint8_t maxBytes);
 
    void Flush();
    void FlushCurrentBlockWithZeros(size_t blockSize);
  };
 
  extern OSMSCOUT_API bool IsValidToWrite(const std::vector<Point>& nodes);

  class OSMSCOUT_API ObjectFileRefStreamWriter
  {
  private:
    FileWriter& writer;
    FileOffset  lastFileOffset=0;
 
  public:
    explicit ObjectFileRefStreamWriter(FileWriter& writer);
 
    void Reset();
 
    void Write(const ObjectFileRef& ref);
  };
}
 
#endif