vint.h

Go to the documentation of this file.

/* Tide
 *
 * Variable-length integer header file.
 *
 * Copyright 2011 Geoffrey Biggs geoffrey.biggs@aist.go.jp
 *     RT-Synthesis Research Group
 *     Intelligent Systems Research Institute,
 *     National Institute of Advanced Industrial Science and Technology (AIST),
 *     Japan
 *     All rights reserved.
 *
 * This file is part of Tide.
 *
 * Tide 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.
 *
 * Tide 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 Tide. If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined(TIDE_VINT_H_)
#define TIDE_VINT_H_

#include <cstddef>
#include <istream>
#include <ostream>
#include <stdint.h>
#include <utility>
#include <vector>


namespace tide
{
    namespace vint
    {
        std::streamsize size(uint64_t integer);

        typedef std::pair<uint64_t, std::streamsize> OffsetInt;
        OffsetInt s_to_u(int64_t integer);

        int64_t u_to_s(OffsetInt integer);

        std::vector<char> encode(uint64_t integer, std::streamsize req_size=0);

        typedef std::pair<uint64_t, std::vector<char>::const_iterator> DecodeResult;

        DecodeResult decode(std::vector<char> const& buffer);

        std::streamsize write(uint64_t integer, std::ostream& output,
                std::streamsize req_size=0);

        typedef std::pair<uint64_t, std::streamsize> ReadResult;

        ReadResult read(std::istream& input);
    }; // namespace vint
}; // namespace tide

// group utilities

#endif // TIDE_VINT_H_