ubinary.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2011, Gostai S.A.S.
 *
 * This software is provided "as is" without warranty of any kind,
 * either expressed or implied, including but not limited to the
 * implied warranties of fitness for a particular purpose.
 *
 * See the LICENSE file for more information.
 */

#ifndef URBI_UBINARY_HH
# define URBI_UBINARY_HH

# include <libport/cstring>
# include <iosfwd>
# include <list>
# include <string>

# include <urbi/export.hh>
# include <urbi/uimage.hh>
# include <urbi/usound.hh>

namespace urbi
{

  /*--------------.
  | UBinaryData.  |
  `--------------*/

  // Internal use: unparsed binary data.
  class URBI_SDK_API BinaryData
  {
  public:
    BinaryData();
    BinaryData(void *d, size_t s);
    void clear();
    void* data;
    size_t size;
  };

  typedef std::list<BinaryData> binaries_type;


  /*----------.
  | UBinary.  |
  `----------*/

  enum UBinaryType
  {
    BINARY_NONE,
    BINARY_UNKNOWN,
    BINARY_IMAGE,
    BINARY_SOUND,
  };

  class URBI_SDK_API UBinary
  {
  public:
    UBinary();
    UBinary(const UBinary &b, bool copy = true, bool temp = false);
    explicit UBinary(const UImage&, bool copy = true);
    explicit UBinary(const USound&, bool copy = true);

    UBinary& operator= (const UBinary &b);

    void buildMessage();
    std::string getMessage() const;

    void clear();

    ~UBinary();
    bool parse(std::istringstream& is,
               const binaries_type& bins,
               binaries_type::const_iterator& binpos, bool copy = true);
    int parse(const char* message, int pos,
              const binaries_type& bins,
              binaries_type::const_iterator& binpos, bool copy = true);

    std::ostream& print(std::ostream& o, int kernelMajor = 2) const;

    UBinaryType type;
    union
    {
      struct
      {
        void* data;             
        size_t size;
      } common;
      UImage image;
      USound sound;
    };
    std::string message;

    bool allocated_;
    bool temporary_;
  };

  URBI_SDK_API
  std::ostream& operator<< (std::ostream& o, const UBinary& t);

} // end namespace urbi

# include <urbi/ubinary.hxx>

#endif // ! URBI_UBINARY_HH