include/id3/io_helpers.h

// -*- C++ -*-
// $Id: io_helpers.h,v 1.7 2002/06/29 17:43:19 t1mpy Exp $

// id3lib: a software library for creating and manipulating id3v1/v2 tags
// Copyright 1999, 2000  Scott Thomas Haug

// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Library General Public License as published by
// the Free Software Foundation; either version 2 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 Library General Public
// License for more details.
//
// You should have received a copy of the GNU Library 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.

// The id3lib authors encourage improvements and optimisations to be sent to
// the id3lib coordinator.  Please see the README file for details on where to
// send such submissions.  See the AUTHORS file for a list of people who have
// contributed to id3lib.  See the ChangeLog file for a list of changes to
// id3lib.  These files are distributed with id3lib at
// http://download.sourceforge.net/id3lib/

#ifndef _ID3LIB_IO_HELPERS_H_
#define _ID3LIB_IO_HELPERS_H_

#include "id3/id3lib_strings.h"
#include "reader.h"
#include "writer.h"

namespace dami
{
  namespace io
  {
    /**
     **/
    class ID3_CPP_EXPORT ExitTrigger
    {
      ID3_Reader& _reader;
      ID3_Reader::pos_type _pos;
      bool _locked;
     public:
      ExitTrigger(ID3_Reader& rdr) 
        : _reader(rdr), _pos(rdr.getCur()), _locked(true)
      { ; }
      ExitTrigger(ID3_Reader& rdr, ID3_Reader::pos_type pos) 
        : _reader(rdr), _pos(pos) 
      { ; }
      virtual ~ExitTrigger() { if (_locked) _reader.setCur(_pos); }
    
      void release() { _locked = false; }
      void update() { _pos = _reader.getCur(); }
      void setExitPos(ID3_Reader::pos_type pos) { _pos = pos; }
    };

    ID3_C_EXPORT String      readString(ID3_Reader&);
    ID3_C_EXPORT String      readText(ID3_Reader&, size_t);
    ID3_C_EXPORT String      readUnicodeString(ID3_Reader&);
    ID3_C_EXPORT String      readUnicodeText(ID3_Reader&, size_t);
    ID3_C_EXPORT BString     readAllBinary(ID3_Reader&);
    ID3_C_EXPORT BString     readBinary(ID3_Reader&, size_t);
    ID3_C_EXPORT uint32      readLENumber(ID3_Reader&, size_t);
    ID3_C_EXPORT uint32      readBENumber(ID3_Reader&, size_t);
    ID3_C_EXPORT String      readTrailingSpaces(ID3_Reader&, size_t);
    ID3_C_EXPORT uint32      readUInt28(ID3_Reader&);

    ID3_C_EXPORT size_t      writeString(ID3_Writer&, String);
    ID3_C_EXPORT size_t      writeText(ID3_Writer&, String);
    ID3_C_EXPORT size_t      writeUnicodeString(ID3_Writer&, String, bool = true);
    ID3_C_EXPORT size_t      writeUnicodeText(ID3_Writer&, String, bool = true);
    ID3_C_EXPORT size_t      writeBENumber(ID3_Writer&, uint32 val, size_t);
    ID3_C_EXPORT size_t      writeTrailingSpaces(ID3_Writer&, String, size_t);
    ID3_C_EXPORT size_t      writeUInt28(ID3_Writer&, uint32);
  };
};

#endif /* _ID3LIB_IO_HELPERS_H_ */